blob: ff9dac2789aa143a7cbc862289f8eb278f1762de [file] [log] [blame]
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02001*eval.txt* For Vim version 8.0. Last change: 2017 Aug 03
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
Bram Moolenaar446cb832008-06-24 21:56:24 +00004 VIM REFERENCE MANUAL by Bram Moolenaar
Bram Moolenaar071d4272004-06-13 20:20:40 +00005
6
7Expression evaluation *expression* *expr* *E15* *eval*
8
9Using expressions is introduced in chapter 41 of the user manual |usr_41.txt|.
10
11Note: Expression evaluation can be disabled at compile time. If this has been
Bram Moolenaar58b85342016-08-14 19:54:54 +020012done, the features in this document are not available. See |+eval| and
Bram Moolenaard8b02732005-01-14 21:48:43 +000013|no-eval-feature|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
Bram Moolenaar13065c42005-01-08 16:08:21 +0000151. Variables |variables|
16 1.1 Variable types
Bram Moolenaar9588a0f2005-01-08 21:45:39 +000017 1.2 Function references |Funcref|
Bram Moolenaar7c626922005-02-07 22:01:03 +000018 1.3 Lists |Lists|
Bram Moolenaard8b02732005-01-14 21:48:43 +000019 1.4 Dictionaries |Dictionaries|
20 1.5 More about variables |more-variables|
Bram Moolenaar13065c42005-01-08 16:08:21 +0000212. Expression syntax |expression-syntax|
223. Internal variable |internal-variables|
234. Builtin Functions |functions|
245. Defining functions |user-functions|
256. Curly braces names |curly-braces-names|
267. Commands |expression-commands|
278. Exception handling |exception-handling|
289. Examples |eval-examples|
2910. No +eval feature |no-eval-feature|
3011. The sandbox |eval-sandbox|
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003112. Textlock |textlock|
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003213. Testing |testing|
Bram Moolenaar071d4272004-06-13 20:20:40 +000033
34{Vi does not have any of these commands}
35
36==============================================================================
371. Variables *variables*
38
Bram Moolenaar13065c42005-01-08 16:08:21 +0000391.1 Variable types ~
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000040 *E712*
Bram Moolenaar38a55632016-02-15 22:07:32 +010041There are nine types of variables:
Bram Moolenaar071d4272004-06-13 20:20:40 +000042
Bram Moolenaar5302d9e2011-09-14 17:55:08 +020043Number A 32 or 64 bit signed number. |expr-number| *Number*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +020044 64-bit Numbers are available only when compiled with the
Bram Moolenaar22fcfad2016-07-01 18:17:26 +020045 |+num64| feature.
Bram Moolenaar7571d552016-08-18 22:54:46 +020046 Examples: -123 0x10 0177 0b1011
Bram Moolenaard8b02732005-01-14 21:48:43 +000047
Bram Moolenaar446cb832008-06-24 21:56:24 +000048Float A floating point number. |floating-point-format| *Float*
49 {only when compiled with the |+float| feature}
50 Examples: 123.456 1.15e-6 -1.1e3
51
Bram Moolenaar06481422016-04-30 15:13:38 +020052 *E928*
Bram Moolenaard8b02732005-01-14 21:48:43 +000053String A NUL terminated string of 8-bit unsigned characters (bytes).
Bram Moolenaar446cb832008-06-24 21:56:24 +000054 |expr-string| Examples: "ab\txx\"--" 'x-z''a,c'
Bram Moolenaard8b02732005-01-14 21:48:43 +000055
Bram Moolenaard8b02732005-01-14 21:48:43 +000056List An ordered sequence of items |List|.
57 Example: [1, 2, ['a', 'b']]
Bram Moolenaar071d4272004-06-13 20:20:40 +000058
Bram Moolenaar39a58ca2005-06-27 22:42:44 +000059Dictionary An associative, unordered array: Each entry has a key and a
60 value. |Dictionary|
61 Example: {'blue': "#0000ff", 'red': "#ff0000"}
62
Bram Moolenaar835dc632016-02-07 14:27:38 +010063Funcref A reference to a function |Funcref|.
64 Example: function("strlen")
Bram Moolenaar1d429612016-05-24 15:44:17 +020065 It can be bound to a dictionary and arguments, it then works
66 like a Partial.
67 Example: function("Callback", [arg], myDict)
Bram Moolenaar835dc632016-02-07 14:27:38 +010068
Bram Moolenaar02e83b42016-02-21 20:10:26 +010069Special |v:false|, |v:true|, |v:none| and |v:null|. *Special*
Bram Moolenaar835dc632016-02-07 14:27:38 +010070
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +020071Job Used for a job, see |job_start()|. *Job* *Jobs*
Bram Moolenaar38a55632016-02-15 22:07:32 +010072
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +020073Channel Used for a channel, see |ch_open()|. *Channel* *Channels*
Bram Moolenaar835dc632016-02-07 14:27:38 +010074
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +000075The Number and String types are converted automatically, depending on how they
76are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +000077
78Conversion from a Number to a String is by making the ASCII representation of
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +020079the Number. Examples:
80 Number 123 --> String "123" ~
81 Number 0 --> String "0" ~
82 Number -1 --> String "-1" ~
Bram Moolenaar00a927d2010-05-14 23:24:24 +020083 *octal*
Bram Moolenaarfa735342016-01-03 22:14:44 +010084Conversion from a String to a Number is done by converting the first digits to
85a number. Hexadecimal "0xf9", Octal "017", and Binary "0b10" numbers are
86recognized. If the String doesn't start with digits, the result is zero.
87Examples:
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +020088 String "456" --> Number 456 ~
89 String "6bar" --> Number 6 ~
90 String "foo" --> Number 0 ~
91 String "0xf1" --> Number 241 ~
92 String "0100" --> Number 64 ~
Bram Moolenaarfa735342016-01-03 22:14:44 +010093 String "0b101" --> Number 5 ~
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +020094 String "-8" --> Number -8 ~
95 String "+8" --> Number 0 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +000096
97To force conversion from String to Number, add zero to it: >
98 :echo "0100" + 0
Bram Moolenaar97b2ad32006-03-18 21:40:56 +000099< 64 ~
100
101To avoid a leading zero to cause octal conversion, or for using a different
102base, use |str2nr()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200104 *TRUE* *FALSE*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE.
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200106You can also use |v:false| and |v:true|. When TRUE is returned from a
107function it is the Number one, FALSE is the number zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200109Note that in the command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000110 :if "foo"
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200111 :" NOT executed
112"foo" is converted to 0, which means FALSE. If the string starts with a
113non-zero number it means TRUE: >
114 :if "8foo"
115 :" executed
116To test for a non-empty string, use empty(): >
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200117 :if !empty("foo")
Bram Moolenaar835dc632016-02-07 14:27:38 +0100118<
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200119 *non-zero-arg*
120Function arguments often behave slightly different from |TRUE|: If the
121argument is present and it evaluates to a non-zero Number, |v:true| or a
Bram Moolenaar64d8e252016-09-06 22:12:34 +0200122non-empty String, then the value is considered to be TRUE.
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200123Note that " " and "0" are also non-empty strings, thus cause the mode to be
124cleared. A List, Dictionary or Float is not a Number or String, thus
125evaluates to FALSE.
126
Bram Moolenaar38a55632016-02-15 22:07:32 +0100127 *E745* *E728* *E703* *E729* *E730* *E731* *E908* *E910* *E913*
Bram Moolenaar50ba5262016-09-22 22:33:02 +0200128List, Dictionary, Funcref, Job and Channel types are not automatically
129converted.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000130
Bram Moolenaar446cb832008-06-24 21:56:24 +0000131 *E805* *E806* *E808*
Bram Moolenaar58b85342016-08-14 19:54:54 +0200132When mixing Number and Float the Number is converted to Float. Otherwise
Bram Moolenaar446cb832008-06-24 21:56:24 +0000133there is no automatic conversion of Float. You can use str2float() for String
134to Float, printf() for Float to String and float2nr() for Float to Number.
135
Bram Moolenaar38a55632016-02-15 22:07:32 +0100136 *E891* *E892* *E893* *E894* *E907* *E911* *E914*
Bram Moolenaar13d5aee2016-01-21 23:36:05 +0100137When expecting a Float a Number can also be used, but nothing else.
138
Bram Moolenaarf6f32c32016-03-12 19:03:59 +0100139 *no-type-checking*
140You will not get an error if you try to change the type of a variable.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000141
Bram Moolenaar13065c42005-01-08 16:08:21 +0000142
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00001431.2 Function references ~
Bram Moolenaar748bf032005-02-02 23:04:36 +0000144 *Funcref* *E695* *E718*
Bram Moolenaar58b85342016-08-14 19:54:54 +0200145A Funcref variable is obtained with the |function()| function, the |funcref()|
146function or created with the lambda expression |expr-lambda|. It can be used
147in an expression in the place of a function name, before the parenthesis
148around the arguments, to invoke the function it refers to. Example: >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000149
150 :let Fn = function("MyFunc")
151 :echo Fn()
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000152< *E704* *E705* *E707*
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000153A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200154can use "g:" but the following name must still start with a capital. You
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000155cannot have both a Funcref variable and a function with the same name.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000156
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000157A special case is defining a function and directly assigning its Funcref to a
158Dictionary entry. Example: >
159 :function dict.init() dict
160 : let self.val = 0
161 :endfunction
162
163The key of the Dictionary can start with a lower case letter. The actual
164function name is not used here. Also see |numbered-function|.
165
166A Funcref can also be used with the |:call| command: >
167 :call Fn()
168 :call dict.init()
Bram Moolenaar13065c42005-01-08 16:08:21 +0000169
170The name of the referenced function can be obtained with |string()|. >
Bram Moolenaar383f9bc2005-01-19 22:18:32 +0000171 :let func = string(Fn)
Bram Moolenaar13065c42005-01-08 16:08:21 +0000172
173You can use |call()| to invoke a Funcref and use a list variable for the
174arguments: >
Bram Moolenaar383f9bc2005-01-19 22:18:32 +0000175 :let r = call(Fn, mylist)
Bram Moolenaar1d429612016-05-24 15:44:17 +0200176<
177 *Partial*
178A Funcref optionally binds a Dictionary and/or arguments. This is also called
179a Partial. This is created by passing the Dictionary and/or arguments to
Bram Moolenaar58b85342016-08-14 19:54:54 +0200180function() or funcref(). When calling the function the Dictionary and/or
181arguments will be passed to the function. Example: >
Bram Moolenaar1d429612016-05-24 15:44:17 +0200182
183 let Cb = function('Callback', ['foo'], myDict)
184 call Cb()
185
186This will invoke the function as if using: >
187 call myDict.Callback('foo')
188
189This is very useful when passing a function around, e.g. in the arguments of
190|ch_open()|.
191
192Note that binding a function to a Dictionary also happens when the function is
193a member of the Dictionary: >
194
195 let myDict.myFunction = MyFunction
196 call myDict.myFunction()
197
198Here MyFunction() will get myDict passed as "self". This happens when the
199"myFunction" member is accessed. When making assigning "myFunction" to
200otherDict and calling it, it will be bound to otherDict: >
201
202 let otherDict.myFunction = myDict.myFunction
203 call otherDict.myFunction()
204
205Now "self" will be "otherDict". But when the dictionary was bound explicitly
206this won't happen: >
207
208 let myDict.myFunction = function(MyFunction, myDict)
209 let otherDict.myFunction = myDict.myFunction
210 call otherDict.myFunction()
211
Bram Moolenaard823fa92016-08-12 16:29:27 +0200212Here "self" will be "myDict", because it was bound explicitly.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000213
214
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00002151.3 Lists ~
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200216 *list* *List* *Lists* *E686*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000217A List is an ordered sequence of items. An item can be of any type. Items
Bram Moolenaar58b85342016-08-14 19:54:54 +0200218can be accessed by their index number. Items can be added and removed at any
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000219position in the sequence.
220
Bram Moolenaar13065c42005-01-08 16:08:21 +0000221
222List creation ~
223 *E696* *E697*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000224A List is created with a comma separated list of items in square brackets.
Bram Moolenaar13065c42005-01-08 16:08:21 +0000225Examples: >
226 :let mylist = [1, two, 3, "four"]
227 :let emptylist = []
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000228
Bram Moolenaar58b85342016-08-14 19:54:54 +0200229An item can be any expression. Using a List for an item creates a
Bram Moolenaarf9393ef2006-04-24 19:47:27 +0000230List of Lists: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000231 :let nestlist = [[11, 12], [21, 22], [31, 32]]
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000232
233An extra comma after the last item is ignored.
234
Bram Moolenaar13065c42005-01-08 16:08:21 +0000235
236List index ~
237 *list-index* *E684*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000238An item in the List can be accessed by putting the index in square brackets
Bram Moolenaar13065c42005-01-08 16:08:21 +0000239after the List. Indexes are zero-based, thus the first item has index zero. >
240 :let item = mylist[0] " get the first item: 1
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000241 :let item = mylist[2] " get the third item: 3
Bram Moolenaar13065c42005-01-08 16:08:21 +0000242
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000243When the resulting item is a list this can be repeated: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000244 :let item = nestlist[0][1] " get the first list, second item: 12
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000245<
Bram Moolenaar13065c42005-01-08 16:08:21 +0000246A negative index is counted from the end. Index -1 refers to the last item in
247the List, -2 to the last but one item, etc. >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000248 :let last = mylist[-1] " get the last item: "four"
249
Bram Moolenaar13065c42005-01-08 16:08:21 +0000250To avoid an error for an invalid index use the |get()| function. When an item
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000251is not available it returns zero or the default value you specify: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000252 :echo get(mylist, idx)
253 :echo get(mylist, idx, "NONE")
254
255
256List concatenation ~
257
258Two lists can be concatenated with the "+" operator: >
259 :let longlist = mylist + [5, 6]
Bram Moolenaar383f9bc2005-01-19 22:18:32 +0000260 :let mylist += [7, 8]
Bram Moolenaar13065c42005-01-08 16:08:21 +0000261
262To prepend or append an item turn the item into a list by putting [] around
263it. To change a list in-place see |list-modification| below.
264
265
266Sublist ~
Bram Moolenaarbc8801c2016-08-02 21:04:33 +0200267 *sublist*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000268A part of the List can be obtained by specifying the first and last index,
269separated by a colon in square brackets: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000270 :let shortlist = mylist[2:-1] " get List [3, "four"]
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000271
272Omitting the first index is similar to zero. Omitting the last index is
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000273similar to -1. >
Bram Moolenaar540d6e32005-01-09 21:20:18 +0000274 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"]
275 :let shortlist = mylist[2:2] " List with one item: [3]
276 :let otherlist = mylist[:] " make a copy of the List
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000277
Bram Moolenaarf9393ef2006-04-24 19:47:27 +0000278If the first index is beyond the last item of the List or the second item is
279before the first item, the result is an empty list. There is no error
280message.
281
282If the second index is equal to or greater than the length of the list the
283length minus one is used: >
Bram Moolenaar9e54a0e2006-04-14 20:42:25 +0000284 :let mylist = [0, 1, 2, 3]
285 :echo mylist[2:8] " result: [2, 3]
286
Bram Moolenaara7fc0102005-05-18 22:17:12 +0000287NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for
Bram Moolenaar58b85342016-08-14 19:54:54 +0200288using a single letter variable before the ":". Insert a space when needed:
Bram Moolenaara7fc0102005-05-18 22:17:12 +0000289mylist[s : e].
290
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000291
Bram Moolenaar13065c42005-01-08 16:08:21 +0000292List identity ~
Bram Moolenaard8b02732005-01-14 21:48:43 +0000293 *list-identity*
Bram Moolenaar13065c42005-01-08 16:08:21 +0000294When variable "aa" is a list and you assign it to another variable "bb", both
295variables refer to the same list. Thus changing the list "aa" will also
296change "bb": >
297 :let aa = [1, 2, 3]
298 :let bb = aa
299 :call add(aa, 4)
300 :echo bb
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000301< [1, 2, 3, 4]
Bram Moolenaar13065c42005-01-08 16:08:21 +0000302
303Making a copy of a list is done with the |copy()| function. Using [:] also
304works, as explained above. This creates a shallow copy of the list: Changing
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000305a list item in the list will also change the item in the copied list: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000306 :let aa = [[1, 'a'], 2, 3]
307 :let bb = copy(aa)
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000308 :call add(aa, 4)
Bram Moolenaar13065c42005-01-08 16:08:21 +0000309 :let aa[0][1] = 'aaa'
310 :echo aa
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000311< [[1, aaa], 2, 3, 4] >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000312 :echo bb
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000313< [[1, aaa], 2, 3]
Bram Moolenaar13065c42005-01-08 16:08:21 +0000314
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000315To make a completely independent list use |deepcopy()|. This also makes a
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000316copy of the values in the list, recursively. Up to a hundred levels deep.
Bram Moolenaar13065c42005-01-08 16:08:21 +0000317
318The operator "is" can be used to check if two variables refer to the same
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000319List. "isnot" does the opposite. In contrast "==" compares if two lists have
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000320the same value. >
321 :let alist = [1, 2, 3]
322 :let blist = [1, 2, 3]
323 :echo alist is blist
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000324< 0 >
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000325 :echo alist == blist
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000326< 1
Bram Moolenaar13065c42005-01-08 16:08:21 +0000327
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +0000328Note about comparing lists: Two lists are considered equal if they have the
329same length and all items compare equal, as with using "==". There is one
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000330exception: When comparing a number with a string they are considered
331different. There is no automatic type conversion, as with using "==" on
332variables. Example: >
333 echo 4 == "4"
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +0000334< 1 >
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000335 echo [4] == ["4"]
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +0000336< 0
337
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000338Thus comparing Lists is more strict than comparing numbers and strings. You
Bram Moolenaar446cb832008-06-24 21:56:24 +0000339can compare simple values this way too by putting them in a list: >
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000340
341 :let a = 5
342 :let b = "5"
Bram Moolenaar446cb832008-06-24 21:56:24 +0000343 :echo a == b
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000344< 1 >
Bram Moolenaar446cb832008-06-24 21:56:24 +0000345 :echo [a] == [b]
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000346< 0
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +0000347
Bram Moolenaar13065c42005-01-08 16:08:21 +0000348
349List unpack ~
350
351To unpack the items in a list to individual variables, put the variables in
352square brackets, like list items: >
353 :let [var1, var2] = mylist
354
355When the number of variables does not match the number of items in the list
356this produces an error. To handle any extra items from the list append ";"
357and a variable name: >
358 :let [var1, var2; rest] = mylist
359
360This works like: >
361 :let var1 = mylist[0]
362 :let var2 = mylist[1]
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +0000363 :let rest = mylist[2:]
Bram Moolenaar13065c42005-01-08 16:08:21 +0000364
365Except that there is no error if there are only two items. "rest" will be an
366empty list then.
367
368
369List modification ~
370 *list-modification*
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000371To change a specific item of a list use |:let| this way: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000372 :let list[4] = "four"
373 :let listlist[0][3] = item
374
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000375To change part of a list you can specify the first and last item to be
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000376modified. The value must at least have the number of items in the range: >
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000377 :let list[3:5] = [3, 4, 5]
378
Bram Moolenaar13065c42005-01-08 16:08:21 +0000379Adding and removing items from a list is done with functions. Here are a few
380examples: >
381 :call insert(list, 'a') " prepend item 'a'
382 :call insert(list, 'a', 3) " insert item 'a' before list[3]
383 :call add(list, "new") " append String item
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000384 :call add(list, [1, 2]) " append a List as one new item
Bram Moolenaar13065c42005-01-08 16:08:21 +0000385 :call extend(list, [1, 2]) " extend the list with two more items
386 :let i = remove(list, 3) " remove item 3
Bram Moolenaar9cd15162005-01-16 22:02:49 +0000387 :unlet list[3] " idem
Bram Moolenaar13065c42005-01-08 16:08:21 +0000388 :let l = remove(list, 3, -1) " remove items 3 to last item
Bram Moolenaar9cd15162005-01-16 22:02:49 +0000389 :unlet list[3 : ] " idem
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000390 :call filter(list, 'v:val !~ "x"') " remove items with an 'x'
Bram Moolenaar13065c42005-01-08 16:08:21 +0000391
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000392Changing the order of items in a list: >
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000393 :call sort(list) " sort a list alphabetically
394 :call reverse(list) " reverse the order of items
Bram Moolenaar327aa022014-03-25 18:24:23 +0100395 :call uniq(sort(list)) " sort and remove duplicates
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000396
Bram Moolenaar13065c42005-01-08 16:08:21 +0000397
398For loop ~
399
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000400The |:for| loop executes commands for each item in a list. A variable is set
401to each item in the list in sequence. Example: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000402 :for item in mylist
403 : call Doit(item)
Bram Moolenaar13065c42005-01-08 16:08:21 +0000404 :endfor
405
406This works like: >
407 :let index = 0
408 :while index < len(mylist)
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000409 : let item = mylist[index]
410 : :call Doit(item)
Bram Moolenaar13065c42005-01-08 16:08:21 +0000411 : let index = index + 1
412 :endwhile
413
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +0000414If all you want to do is modify each item in the list then the |map()|
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000415function will be a simpler method than a for loop.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +0000416
Bram Moolenaar58b85342016-08-14 19:54:54 +0200417Just like the |:let| command, |:for| also accepts a list of variables. This
Bram Moolenaar13065c42005-01-08 16:08:21 +0000418requires the argument to be a list of lists. >
419 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]]
420 : call Doit(lnum, col)
421 :endfor
422
423This works like a |:let| command is done for each list item. Again, the types
424must remain the same to avoid an error.
425
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000426It is also possible to put remaining items in a List variable: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000427 :for [i, j; rest] in listlist
428 : call Doit(i, j)
429 : if !empty(rest)
430 : echo "remainder: " . string(rest)
431 : endif
432 :endfor
433
434
435List functions ~
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000436 *E714*
Bram Moolenaar13065c42005-01-08 16:08:21 +0000437Functions that are useful with a List: >
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000438 :let r = call(funcname, list) " call a function with an argument list
Bram Moolenaar13065c42005-01-08 16:08:21 +0000439 :if empty(list) " check if list is empty
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000440 :let l = len(list) " number of items in list
441 :let big = max(list) " maximum value in list
442 :let small = min(list) " minimum value in list
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000443 :let xs = count(list, 'x') " count nr of times 'x' appears in list
444 :let i = index(list, 'x') " index of first 'x' in list
Bram Moolenaar13065c42005-01-08 16:08:21 +0000445 :let lines = getline(1, 10) " get ten text lines from buffer
446 :call append('$', lines) " append text lines in buffer
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +0000447 :let list = split("a b c") " create list from items in a string
448 :let string = join(list, ', ') " create string from list items
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000449 :let s = string(list) " String representation of list
450 :call map(list, '">> " . v:val') " prepend ">> " to each item
Bram Moolenaar13065c42005-01-08 16:08:21 +0000451
Bram Moolenaar0cb032e2005-04-23 20:52:00 +0000452Don't forget that a combination of features can make things simple. For
453example, to add up all the numbers in a list: >
454 :exe 'let sum = ' . join(nrlist, '+')
455
Bram Moolenaar13065c42005-01-08 16:08:21 +0000456
Bram Moolenaard8b02732005-01-14 21:48:43 +00004571.4 Dictionaries ~
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200458 *dict* *Dictionaries* *Dictionary*
Bram Moolenaard8b02732005-01-14 21:48:43 +0000459A Dictionary is an associative array: Each entry has a key and a value. The
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000460entry can be located with the key. The entries are stored without a specific
461ordering.
Bram Moolenaard8b02732005-01-14 21:48:43 +0000462
463
464Dictionary creation ~
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000465 *E720* *E721* *E722* *E723*
Bram Moolenaard8b02732005-01-14 21:48:43 +0000466A Dictionary is created with a comma separated list of entries in curly
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000467braces. Each entry has a key and a value, separated by a colon. Each key can
468only appear once. Examples: >
Bram Moolenaard8b02732005-01-14 21:48:43 +0000469 :let mydict = {1: 'one', 2: 'two', 3: 'three'}
470 :let emptydict = {}
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000471< *E713* *E716* *E717*
Bram Moolenaard8b02732005-01-14 21:48:43 +0000472A key is always a String. You can use a Number, it will be converted to a
473String automatically. Thus the String '4' and the number 4 will find the same
Bram Moolenaar58b85342016-08-14 19:54:54 +0200474entry. Note that the String '04' and the Number 04 are different, since the
Bram Moolenaar03413f42016-04-12 21:07:15 +0200475Number will be converted to the String '4'. The empty string can be used as a
476key.
Bram Moolenaard8b02732005-01-14 21:48:43 +0000477
Bram Moolenaar58b85342016-08-14 19:54:54 +0200478A value can be any expression. Using a Dictionary for a value creates a
Bram Moolenaard8b02732005-01-14 21:48:43 +0000479nested Dictionary: >
480 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}}
481
482An extra comma after the last entry is ignored.
483
484
485Accessing entries ~
486
487The normal way to access an entry is by putting the key in square brackets: >
488 :let val = mydict["one"]
489 :let mydict["four"] = 4
490
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000491You can add new entries to an existing Dictionary this way, unlike Lists.
Bram Moolenaard8b02732005-01-14 21:48:43 +0000492
493For keys that consist entirely of letters, digits and underscore the following
494form can be used |expr-entry|: >
495 :let val = mydict.one
496 :let mydict.four = 4
497
498Since an entry can be any type, also a List and a Dictionary, the indexing and
499key lookup can be repeated: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000500 :echo dict.key[idx].key
Bram Moolenaard8b02732005-01-14 21:48:43 +0000501
502
503Dictionary to List conversion ~
504
Bram Moolenaar58b85342016-08-14 19:54:54 +0200505You may want to loop over the entries in a dictionary. For this you need to
Bram Moolenaard8b02732005-01-14 21:48:43 +0000506turn the Dictionary into a List and pass it to |:for|.
507
508Most often you want to loop over the keys, using the |keys()| function: >
509 :for key in keys(mydict)
510 : echo key . ': ' . mydict[key]
511 :endfor
512
513The List of keys is unsorted. You may want to sort them first: >
514 :for key in sort(keys(mydict))
515
516To loop over the values use the |values()| function: >
517 :for v in values(mydict)
518 : echo "value: " . v
519 :endfor
520
521If you want both the key and the value use the |items()| function. It returns
Bram Moolenaar446cb832008-06-24 21:56:24 +0000522a List in which each item is a List with two items, the key and the value: >
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000523 :for [key, value] in items(mydict)
524 : echo key . ': ' . value
Bram Moolenaard8b02732005-01-14 21:48:43 +0000525 :endfor
526
527
528Dictionary identity ~
Bram Moolenaar7c626922005-02-07 22:01:03 +0000529 *dict-identity*
Bram Moolenaard8b02732005-01-14 21:48:43 +0000530Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a
531Dictionary. Otherwise, assignment results in referring to the same
532Dictionary: >
533 :let onedict = {'a': 1, 'b': 2}
534 :let adict = onedict
535 :let adict['a'] = 11
536 :echo onedict['a']
537 11
538
Bram Moolenaarf3bd51a2005-06-14 22:11:18 +0000539Two Dictionaries compare equal if all the key-value pairs compare equal. For
540more info see |list-identity|.
Bram Moolenaard8b02732005-01-14 21:48:43 +0000541
542
543Dictionary modification ~
544 *dict-modification*
545To change an already existing entry of a Dictionary, or to add a new entry,
546use |:let| this way: >
547 :let dict[4] = "four"
548 :let dict['one'] = item
549
Bram Moolenaar9cd15162005-01-16 22:02:49 +0000550Removing an entry from a Dictionary is done with |remove()| or |:unlet|.
551Three ways to remove the entry with key "aaa" from dict: >
552 :let i = remove(dict, 'aaa')
553 :unlet dict.aaa
554 :unlet dict['aaa']
Bram Moolenaard8b02732005-01-14 21:48:43 +0000555
556Merging a Dictionary with another is done with |extend()|: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000557 :call extend(adict, bdict)
558This extends adict with all entries from bdict. Duplicate keys cause entries
559in adict to be overwritten. An optional third argument can change this.
Bram Moolenaar383f9bc2005-01-19 22:18:32 +0000560Note that the order of entries in a Dictionary is irrelevant, thus don't
561expect ":echo adict" to show the items from bdict after the older entries in
562adict.
Bram Moolenaard8b02732005-01-14 21:48:43 +0000563
564Weeding out entries from a Dictionary can be done with |filter()|: >
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000565 :call filter(dict, 'v:val =~ "x"')
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000566This removes all entries from "dict" with a value not matching 'x'.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000567
568
569Dictionary function ~
Bram Moolenaar26402cb2013-02-20 21:26:00 +0100570 *Dictionary-function* *self* *E725* *E862*
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000571When a function is defined with the "dict" attribute it can be used in a
Bram Moolenaar58b85342016-08-14 19:54:54 +0200572special way with a dictionary. Example: >
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000573 :function Mylen() dict
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000574 : return len(self.data)
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000575 :endfunction
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000576 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")}
577 :echo mydict.len()
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000578
579This is like a method in object oriented programming. The entry in the
580Dictionary is a |Funcref|. The local variable "self" refers to the dictionary
581the function was invoked from.
582
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000583It is also possible to add a function without the "dict" attribute as a
584Funcref to a Dictionary, but the "self" variable is not available then.
585
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000586 *numbered-function* *anonymous-function*
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000587To avoid the extra name for the function it can be defined and directly
588assigned to a Dictionary in this way: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000589 :let mydict = {'data': [0, 1, 2, 3]}
Bram Moolenaar5a5f4592015-04-13 12:43:06 +0200590 :function mydict.len()
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000591 : return len(self.data)
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000592 :endfunction
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000593 :echo mydict.len()
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000594
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000595The function will then get a number and the value of dict.len is a |Funcref|
Bram Moolenaar58b85342016-08-14 19:54:54 +0200596that references this function. The function can only be used through a
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000597|Funcref|. It will automatically be deleted when there is no |Funcref|
598remaining that refers to it.
599
600It is not necessary to use the "dict" attribute for a numbered function.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000601
Bram Moolenaar1affd722010-08-04 17:49:30 +0200602If you get an error for a numbered function, you can find out what it is with
603a trick. Assuming the function is 42, the command is: >
604 :function {42}
605
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000606
607Functions for Dictionaries ~
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000608 *E715*
609Functions that can be used with a Dictionary: >
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000610 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo"
611 :if empty(dict) " TRUE if dict is empty
612 :let l = len(dict) " number of items in dict
613 :let big = max(dict) " maximum value in dict
614 :let small = min(dict) " minimum value in dict
615 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict
616 :let s = string(dict) " String representation of dict
617 :call map(dict, '">> " . v:val') " prepend ">> " to each item
Bram Moolenaard8b02732005-01-14 21:48:43 +0000618
619
6201.5 More about variables ~
Bram Moolenaar13065c42005-01-08 16:08:21 +0000621 *more-variables*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622If you need to know the type of a variable or expression, use the |type()|
623function.
624
625When the '!' flag is included in the 'viminfo' option, global variables that
626start with an uppercase letter, and don't contain a lowercase letter, are
627stored in the viminfo file |viminfo-file|.
628
629When the 'sessionoptions' option contains "global", global variables that
630start with an uppercase letter and contain at least one lowercase letter are
631stored in the session file |session-file|.
632
633variable name can be stored where ~
634my_var_6 not
635My_Var_6 session file
636MY_VAR_6 viminfo file
637
638
639It's possible to form a variable name with curly braces, see
640|curly-braces-names|.
641
642==============================================================================
6432. Expression syntax *expression-syntax*
644
645Expression syntax summary, from least to most significant:
646
Bram Moolenaar50ba5262016-09-22 22:33:02 +0200647|expr1| expr2
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200648 expr2 ? expr1 : expr1 if-then-else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200650|expr2| expr3
651 expr3 || expr3 .. logical OR
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200653|expr3| expr4
654 expr4 && expr4 .. logical AND
Bram Moolenaar071d4272004-06-13 20:20:40 +0000655
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200656|expr4| expr5
657 expr5 == expr5 equal
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658 expr5 != expr5 not equal
659 expr5 > expr5 greater than
660 expr5 >= expr5 greater than or equal
661 expr5 < expr5 smaller than
662 expr5 <= expr5 smaller than or equal
663 expr5 =~ expr5 regexp matches
664 expr5 !~ expr5 regexp doesn't match
665
666 expr5 ==? expr5 equal, ignoring case
667 expr5 ==# expr5 equal, match case
668 etc. As above, append ? for ignoring case, # for
669 matching case
670
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000671 expr5 is expr5 same |List| instance
672 expr5 isnot expr5 different |List| instance
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000673
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200674|expr5| expr6
675 expr6 + expr6 .. number addition or list concatenation
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 expr6 - expr6 .. number subtraction
677 expr6 . expr6 .. string concatenation
678
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200679|expr6| expr7
680 expr7 * expr7 .. number multiplication
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681 expr7 / expr7 .. number division
682 expr7 % expr7 .. number modulo
683
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200684|expr7| expr8
685 ! expr7 logical NOT
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686 - expr7 unary minus
687 + expr7 unary plus
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200689|expr8| expr9
690 expr8[expr1] byte of a String or item of a |List|
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000691 expr8[expr1 : expr1] substring of a String or sublist of a |List|
692 expr8.name entry in a |Dictionary|
693 expr8(expr1, ...) function call with |Funcref| variable
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000694
Bram Moolenaar50ba5262016-09-22 22:33:02 +0200695|expr9| number number constant
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000696 "string" string constant, backslash is special
Bram Moolenaard8b02732005-01-14 21:48:43 +0000697 'string' string constant, ' is doubled
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000698 [expr1, ...] |List|
699 {expr1: expr1, ...} |Dictionary|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700 &option option value
701 (expr1) nested expression
702 variable internal variable
703 va{ria}ble internal variable with curly braces
704 $VAR environment variable
705 @r contents of register 'r'
706 function(expr1, ...) function call
707 func{ti}on(expr1, ...) function call with curly braces
Bram Moolenaar069c1e72016-07-15 21:25:08 +0200708 {args -> expr1} lambda expression
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709
710
711".." indicates that the operations in this level can be concatenated.
712Example: >
713 &nu || &list && &shell == "csh"
714
715All expressions within one level are parsed from left to right.
716
717
718expr1 *expr1* *E109*
719-----
720
721expr2 ? expr1 : expr1
722
723The expression before the '?' is evaluated to a number. If it evaluates to
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200724|TRUE|, the result is the value of the expression between the '?' and ':',
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725otherwise the result is the value of the expression after the ':'.
726Example: >
727 :echo lnum == 1 ? "top" : lnum
728
729Since the first expression is an "expr2", it cannot contain another ?:. The
730other two expressions can, thus allow for recursive use of ?:.
731Example: >
732 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum
733
734To keep this readable, using |line-continuation| is suggested: >
735 :echo lnum == 1
736 :\ ? "top"
737 :\ : lnum == 1000
738 :\ ? "last"
739 :\ : lnum
740
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000741You should always put a space before the ':', otherwise it can be mistaken for
742use in a variable such as "a:1".
743
Bram Moolenaar071d4272004-06-13 20:20:40 +0000744
745expr2 and expr3 *expr2* *expr3*
746---------------
747
Bram Moolenaar04186092016-08-29 21:55:35 +0200748expr3 || expr3 .. logical OR *expr-barbar*
749expr4 && expr4 .. logical AND *expr-&&*
750
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751The "||" and "&&" operators take one argument on each side. The arguments
752are (converted to) Numbers. The result is:
753
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200754 input output ~
755n1 n2 n1 || n2 n1 && n2 ~
756|FALSE| |FALSE| |FALSE| |FALSE|
757|FALSE| |TRUE| |TRUE| |FALSE|
758|TRUE| |FALSE| |TRUE| |FALSE|
759|TRUE| |TRUE| |TRUE| |TRUE|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760
761The operators can be concatenated, for example: >
762
763 &nu || &list && &shell == "csh"
764
765Note that "&&" takes precedence over "||", so this has the meaning of: >
766
767 &nu || (&list && &shell == "csh")
768
769Once the result is known, the expression "short-circuits", that is, further
770arguments are not evaluated. This is like what happens in C. For example: >
771
772 let a = 1
773 echo a || b
774
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200775This is valid even if there is no variable called "b" because "a" is |TRUE|,
776so the result must be |TRUE|. Similarly below: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777
778 echo exists("b") && b == "yes"
779
780This is valid whether "b" has been defined or not. The second clause will
781only be evaluated if "b" has been defined.
782
783
784expr4 *expr4*
785-----
786
787expr5 {cmp} expr5
788
789Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1
790if it evaluates to true.
791
Bram Moolenaar446cb832008-06-24 21:56:24 +0000792 *expr-==* *expr-!=* *expr->* *expr->=*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793 *expr-<* *expr-<=* *expr-=~* *expr-!~*
794 *expr-==#* *expr-!=#* *expr->#* *expr->=#*
795 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#*
796 *expr-==?* *expr-!=?* *expr->?* *expr->=?*
797 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?*
Bram Moolenaar251e1912011-06-19 05:09:16 +0200798 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#*
799 *expr-is?* *expr-isnot?*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800 use 'ignorecase' match case ignore case ~
801equal == ==# ==?
802not equal != !=# !=?
803greater than > ># >?
804greater than or equal >= >=# >=?
805smaller than < <# <?
806smaller than or equal <= <=# <=?
807regexp matches =~ =~# =~?
808regexp doesn't match !~ !~# !~?
Bram Moolenaar251e1912011-06-19 05:09:16 +0200809same instance is is# is?
810different instance isnot isnot# isnot?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811
812Examples:
813"abc" ==# "Abc" evaluates to 0
814"abc" ==? "Abc" evaluates to 1
815"abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise
816
Bram Moolenaar13065c42005-01-08 16:08:21 +0000817 *E691* *E692*
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000818A |List| can only be compared with a |List| and only "equal", "not equal" and
819"is" can be used. This compares the values of the list, recursively.
820Ignoring case means case is ignored when comparing item values.
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000821
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000822 *E735* *E736*
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000823A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not
824equal" and "is" can be used. This compares the key/values of the |Dictionary|
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000825recursively. Ignoring case means case is ignored when comparing item values.
826
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +0200827 *E694*
Bram Moolenaare18dbe82016-07-02 21:42:23 +0200828A |Funcref| can only be compared with a |Funcref| and only "equal", "not
829equal", "is" and "isnot" can be used. Case is never ignored. Whether
830arguments or a Dictionary are bound (with a partial) matters. The
831Dictionaries must also be equal (or the same, in case of "is") and the
832arguments must be equal (or the same).
833
834To compare Funcrefs to see if they refer to the same function, ignoring bound
835Dictionary and arguments, use |get()| to get the function name: >
836 if get(Part1, 'name') == get(Part2, 'name')
837 " Part1 and Part2 refer to the same function
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000838
Bram Moolenaar251e1912011-06-19 05:09:16 +0200839When using "is" or "isnot" with a |List| or a |Dictionary| this checks if the
840expressions are referring to the same |List| or |Dictionary| instance. A copy
841of a |List| is different from the original |List|. When using "is" without
842a |List| or a |Dictionary| it is equivalent to using "equal", using "isnot"
843equivalent to using "not equal". Except that a different type means the
Bram Moolenaar86edef62016-03-13 18:07:30 +0100844values are different: >
845 echo 4 == '4'
846 1
847 echo 4 is '4'
848 0
849 echo 0 is []
850 0
851"is#"/"isnot#" and "is?"/"isnot?" can be used to match and ignore case.
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000852
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853When comparing a String with a Number, the String is converted to a Number,
Bram Moolenaar58b85342016-08-14 19:54:54 +0200854and the comparison is done on Numbers. This means that: >
Bram Moolenaar86edef62016-03-13 18:07:30 +0100855 echo 0 == 'x'
856 1
857because 'x' converted to a Number is zero. However: >
858 echo [0] == ['x']
859 0
860Inside a List or Dictionary this conversion is not used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861
862When comparing two Strings, this is done with strcmp() or stricmp(). This
863results in the mathematical difference (comparing byte values), not
864necessarily the alphabetical difference in the local language.
865
Bram Moolenaar446cb832008-06-24 21:56:24 +0000866When using the operators with a trailing '#', or the short version and
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000867'ignorecase' is off, the comparing is done with strcmp(): case matters.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000868
869When using the operators with a trailing '?', or the short version and
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000870'ignorecase' is set, the comparing is done with stricmp(): case is ignored.
871
872'smartcase' is not used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873
874The "=~" and "!~" operators match the lefthand argument with the righthand
875argument, which is used as a pattern. See |pattern| for what a pattern is.
876This matching is always done like 'magic' was set and 'cpoptions' is empty, no
877matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts
878portable. To avoid backslashes in the regexp pattern to be doubled, use a
879single-quote string, see |literal-string|.
880Since a string is considered to be a single line, a multi-line pattern
881(containing \n, backslash-n) will not match. However, a literal NL character
882can be matched like an ordinary character. Examples:
883 "foo\nbar" =~ "\n" evaluates to 1
884 "foo\nbar" =~ "\\n" evaluates to 0
885
886
887expr5 and expr6 *expr5* *expr6*
888---------------
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000889expr6 + expr6 .. Number addition or |List| concatenation *expr-+*
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000890expr6 - expr6 .. Number subtraction *expr--*
891expr6 . expr6 .. String concatenation *expr-.*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892
Bram Moolenaara23ccb82006-02-27 00:08:02 +0000893For |Lists| only "+" is possible and then both expr6 must be a list. The
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000894result is a new list with the two lists Concatenated.
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000895
Bram Moolenaard6e256c2011-12-14 15:32:50 +0100896expr7 * expr7 .. Number multiplication *expr-star*
897expr7 / expr7 .. Number division *expr-/*
898expr7 % expr7 .. Number modulo *expr-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899
900For all, except ".", Strings are converted to Numbers.
Bram Moolenaard6e256c2011-12-14 15:32:50 +0100901For bitwise operators see |and()|, |or()| and |xor()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902
903Note the difference between "+" and ".":
904 "123" + "456" = 579
905 "123" . "456" = "123456"
906
Bram Moolenaar446cb832008-06-24 21:56:24 +0000907Since '.' has the same precedence as '+' and '-', you need to read: >
908 1 . 90 + 90.0
909As: >
910 (1 . 90) + 90.0
911That works, since the String "190" is automatically converted to the Number
912190, which can be added to the Float 90.0. However: >
913 1 . 90 * 90.0
914Should be read as: >
915 1 . (90 * 90.0)
916Since '.' has lower precedence than '*'. This does NOT work, since this
917attempts to concatenate a Float and a String.
918
919When dividing a Number by zero the result depends on the value:
920 0 / 0 = -0x80000000 (like NaN for Float)
921 >0 / 0 = 0x7fffffff (like positive infinity)
922 <0 / 0 = -0x7fffffff (like negative infinity)
923 (before Vim 7.2 it was always 0x7fffffff)
924
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200925When 64-bit Number support is enabled:
926 0 / 0 = -0x8000000000000000 (like NaN for Float)
927 >0 / 0 = 0x7fffffffffffffff (like positive infinity)
928 <0 / 0 = -0x7fffffffffffffff (like negative infinity)
929
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930When the righthand side of '%' is zero, the result is 0.
931
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000932None of these work for |Funcref|s.
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000933
Bram Moolenaar446cb832008-06-24 21:56:24 +0000934. and % do not work for Float. *E804*
935
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936
937expr7 *expr7*
938-----
939! expr7 logical NOT *expr-!*
940- expr7 unary minus *expr-unary--*
941+ expr7 unary plus *expr-unary-+*
942
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200943For '!' |TRUE| becomes |FALSE|, |FALSE| becomes |TRUE| (one).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944For '-' the sign of the number is changed.
945For '+' the number is unchanged.
946
947A String will be converted to a Number first.
948
Bram Moolenaar58b85342016-08-14 19:54:54 +0200949These three can be repeated and mixed. Examples:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000950 !-1 == 0
951 !!8 == 1
952 --9 == 9
953
954
955expr8 *expr8*
956-----
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000957expr8[expr1] item of String or |List| *expr-[]* *E111*
Bram Moolenaar03413f42016-04-12 21:07:15 +0200958 *E909* *subscript*
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000959If expr8 is a Number or String this results in a String that contains the
960expr1'th single byte from expr8. expr8 is used as a String, expr1 as a
Bram Moolenaar50ba5262016-09-22 22:33:02 +0200961Number. This doesn't recognize multi-byte encodings, see `byteidx()` for
Bram Moolenaar03413f42016-04-12 21:07:15 +0200962an alternative, or use `split()` to turn the string into a list of characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963
Bram Moolenaar256972a2015-12-29 19:10:25 +0100964Index zero gives the first byte. This is like it works in C. Careful:
965text column numbers start with one! Example, to get the byte under the
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000966cursor: >
Bram Moolenaar61660ea2006-04-07 21:40:07 +0000967 :let c = getline(".")[col(".") - 1]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968
969If the length of the String is less than the index, the result is an empty
Bram Moolenaar85084ef2016-01-17 22:26:33 +0100970String. A negative index always results in an empty string (reason: backward
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000971compatibility). Use [-1:] to get the last byte.
972
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000973If expr8 is a |List| then it results the item at index expr1. See |list-index|
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000974for possible index values. If the index is out of range this results in an
Bram Moolenaar58b85342016-08-14 19:54:54 +0200975error. Example: >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000976 :let item = mylist[-1] " get last item
977
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000978Generally, if a |List| index is equal to or higher than the length of the
979|List|, or more negative than the length of the |List|, this results in an
980error.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000981
Bram Moolenaard8b02732005-01-14 21:48:43 +0000982
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000983expr8[expr1a : expr1b] substring or sublist *expr-[:]*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000984
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000985If expr8 is a Number or String this results in the substring with the bytes
986from expr1a to and including expr1b. expr8 is used as a String, expr1a and
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100987expr1b are used as a Number. This doesn't recognize multi-byte encodings, see
988|byteidx()| for computing the indexes.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000989
990If expr1a is omitted zero is used. If expr1b is omitted the length of the
991string minus one is used.
992
993A negative number can be used to measure from the end of the string. -1 is
994the last character, -2 the last but one, etc.
995
996If an index goes out of range for the string characters are omitted. If
997expr1b is smaller than expr1a the result is an empty string.
998
999Examples: >
1000 :let c = name[-1:] " last byte of a string
1001 :let c = name[-2:-2] " last but one byte of a string
1002 :let s = line(".")[4:] " from the fifth byte to the end
1003 :let s = s[:-3] " remove last two bytes
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001004<
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02001005 *slice*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001006If expr8 is a |List| this results in a new |List| with the items indicated by
Bram Moolenaar58b85342016-08-14 19:54:54 +02001007the indexes expr1a and expr1b. This works like with a String, as explained
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02001008just above. Also see |sublist| below. Examples: >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001009 :let l = mylist[:3] " first four items
1010 :let l = mylist[4:4] " List with one item
1011 :let l = mylist[:] " shallow copy of a List
1012
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001013Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an
1014error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015
Bram Moolenaarda440d22016-01-16 21:27:23 +01001016Watch out for confusion between a namespace and a variable followed by a colon
1017for a sublist: >
1018 mylist[n:] " uses variable n
1019 mylist[s:] " uses namespace s:, error!
1020
Bram Moolenaard8b02732005-01-14 21:48:43 +00001021
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001022expr8.name entry in a |Dictionary| *expr-entry*
Bram Moolenaard8b02732005-01-14 21:48:43 +00001023
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001024If expr8 is a |Dictionary| and it is followed by a dot, then the following
1025name will be used as a key in the |Dictionary|. This is just like:
1026expr8[name].
Bram Moolenaard8b02732005-01-14 21:48:43 +00001027
1028The name must consist of alphanumeric characters, just like a variable name,
1029but it may start with a number. Curly braces cannot be used.
1030
1031There must not be white space before or after the dot.
1032
1033Examples: >
1034 :let dict = {"one": 1, 2: "two"}
1035 :echo dict.one
1036 :echo dict .2
1037
1038Note that the dot is also used for String concatenation. To avoid confusion
1039always put spaces around the dot for String concatenation.
1040
1041
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001042expr8(expr1, ...) |Funcref| function call
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001043
1044When expr8 is a |Funcref| type variable, invoke the function it refers to.
1045
1046
1047
1048 *expr9*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049number
1050------
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001051number number constant *expr-number*
Bram Moolenaar7571d552016-08-18 22:54:46 +02001052 *hex-number* *octal-number* *binary-number*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053
Bram Moolenaar7571d552016-08-18 22:54:46 +02001054Decimal, Hexadecimal (starting with 0x or 0X), Binary (starting with 0b or 0B)
1055and Octal (starting with 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056
Bram Moolenaar446cb832008-06-24 21:56:24 +00001057 *floating-point-format*
1058Floating point numbers can be written in two forms:
1059
1060 [-+]{N}.{M}
Bram Moolenaar8a94d872015-01-25 13:02:57 +01001061 [-+]{N}.{M}[eE][-+]{exp}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001062
1063{N} and {M} are numbers. Both {N} and {M} must be present and can only
1064contain digits.
1065[-+] means there is an optional plus or minus sign.
1066{exp} is the exponent, power of 10.
Bram Moolenaar58b85342016-08-14 19:54:54 +02001067Only a decimal point is accepted, not a comma. No matter what the current
Bram Moolenaar446cb832008-06-24 21:56:24 +00001068locale is.
1069{only when compiled with the |+float| feature}
1070
1071Examples:
1072 123.456
1073 +0.0001
1074 55.0
1075 -0.123
1076 1.234e03
1077 1.0E-6
1078 -3.1416e+88
1079
1080These are INVALID:
1081 3. empty {M}
1082 1e40 missing .{M}
1083
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001084 *float-pi* *float-e*
1085A few useful values to copy&paste: >
1086 :let pi = 3.14159265359
1087 :let e = 2.71828182846
1088
Bram Moolenaar446cb832008-06-24 21:56:24 +00001089Rationale:
1090Before floating point was introduced, the text "123.456" was interpreted as
1091the two numbers "123" and "456", both converted to a string and concatenated,
1092resulting in the string "123456". Since this was considered pointless, and we
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001093could not find it intentionally being used in Vim scripts, this backwards
Bram Moolenaar446cb832008-06-24 21:56:24 +00001094incompatibility was accepted in favor of being able to use the normal notation
1095for floating point numbers.
1096
1097 *floating-point-precision*
1098The precision and range of floating points numbers depends on what "double"
1099means in the library Vim was compiled with. There is no way to change this at
1100runtime.
1101
1102The default for displaying a |Float| is to use 6 decimal places, like using
1103printf("%g", f). You can select something else when using the |printf()|
1104function. Example: >
1105 :echo printf('%.15e', atan(1))
1106< 7.853981633974483e-01
1107
1108
Bram Moolenaar071d4272004-06-13 20:20:40 +00001109
Bram Moolenaar979243b2015-06-26 19:35:49 +02001110string *string* *String* *expr-string* *E114*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111------
1112"string" string constant *expr-quote*
1113
1114Note that double quotes are used.
1115
1116A string constant accepts these special characters:
1117\... three-digit octal number (e.g., "\316")
1118\.. two-digit octal number (must be followed by non-digit)
1119\. one-digit octal number (must be followed by non-digit)
1120\x.. byte specified with two hex numbers (e.g., "\x1f")
1121\x. byte specified with one hex number (must be followed by non-hex char)
1122\X.. same as \x..
1123\X. same as \x.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001124\u.... character specified with up to 4 hex numbers, stored according to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125 current value of 'encoding' (e.g., "\u02a4")
Bram Moolenaar541f92d2015-06-19 13:27:23 +02001126\U.... same as \u but allows up to 8 hex numbers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127\b backspace <BS>
1128\e escape <Esc>
1129\f formfeed <FF>
1130\n newline <NL>
1131\r return <CR>
1132\t tab <Tab>
1133\\ backslash
1134\" double quote
Bram Moolenaar00a927d2010-05-14 23:24:24 +02001135\<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use
Bram Moolenaar58b85342016-08-14 19:54:54 +02001136 in mappings, the 0x80 byte is escaped.
1137 To use the double quote character it must be escaped: "<M-\">".
1138 Don't use <Char-xxxx> to get a utf-8 character, use \uxxxx as
1139 mentioned above.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140
Bram Moolenaaref2f6562007-05-06 13:32:59 +00001141Note that "\xff" is stored as the byte 255, which may be invalid in some
1142encodings. Use "\u00ff" to store character 255 according to the current value
1143of 'encoding'.
1144
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145Note that "\000" and "\x00" force the end of the string.
1146
1147
1148literal-string *literal-string* *E115*
1149---------------
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001150'string' string constant *expr-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001151
1152Note that single quotes are used.
1153
Bram Moolenaar58b85342016-08-14 19:54:54 +02001154This string is taken as it is. No backslashes are removed or have a special
Bram Moolenaard8b02732005-01-14 21:48:43 +00001155meaning. The only exception is that two quotes stand for one quote.
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001156
1157Single quoted strings are useful for patterns, so that backslashes do not need
Bram Moolenaar58b85342016-08-14 19:54:54 +02001158to be doubled. These two commands are equivalent: >
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001159 if a =~ "\\s*"
1160 if a =~ '\s*'
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161
1162
1163option *expr-option* *E112* *E113*
1164------
1165&option option value, local value if possible
1166&g:option global option value
1167&l:option local option value
1168
1169Examples: >
1170 echo "tabstop is " . &tabstop
1171 if &insertmode
1172
1173Any option name can be used here. See |options|. When using the local value
1174and there is no buffer-local or window-local value, the global value is used
1175anyway.
1176
1177
Bram Moolenaaref2f6562007-05-06 13:32:59 +00001178register *expr-register* *@r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179--------
1180@r contents of register 'r'
1181
1182The result is the contents of the named register, as a single string.
1183Newlines are inserted where required. To get the contents of the unnamed
Bram Moolenaar58b85342016-08-14 19:54:54 +02001184register use @" or @@. See |registers| for an explanation of the available
Bram Moolenaare7566042005-06-17 22:00:15 +00001185registers.
1186
1187When using the '=' register you get the expression itself, not what it
1188evaluates to. Use |eval()| to evaluate it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001189
1190
1191nesting *expr-nesting* *E110*
1192-------
1193(expr1) nested expression
1194
1195
1196environment variable *expr-env*
1197--------------------
1198$VAR environment variable
1199
1200The String value of any environment variable. When it is not defined, the
1201result is an empty string.
1202 *expr-env-expand*
1203Note that there is a difference between using $VAR directly and using
1204expand("$VAR"). Using it directly will only expand environment variables that
1205are known inside the current Vim session. Using expand() will first try using
1206the environment variables known inside the current Vim session. If that
1207fails, a shell will be used to expand the variable. This can be slow, but it
1208does expand all variables that the shell knows about. Example: >
Bram Moolenaar34401cc2014-08-29 15:12:19 +02001209 :echo $shell
1210 :echo expand("$shell")
1211The first one probably doesn't echo anything, the second echoes the $shell
Bram Moolenaar071d4272004-06-13 20:20:40 +00001212variable (if your shell supports it).
1213
1214
1215internal variable *expr-variable*
1216-----------------
1217variable internal variable
1218See below |internal-variables|.
1219
1220
Bram Moolenaar05159a02005-02-26 23:04:13 +00001221function call *expr-function* *E116* *E118* *E119* *E120*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001222-------------
1223function(expr1, ...) function call
1224See below |functions|.
1225
1226
Bram Moolenaar069c1e72016-07-15 21:25:08 +02001227lambda expression *expr-lambda* *lambda*
1228-----------------
1229{args -> expr1} lambda expression
1230
1231A lambda expression creates a new unnamed function which returns the result of
Bram Moolenaar42ebd062016-07-17 13:35:14 +02001232evaluating |expr1|. Lambda expressions differ from |user-functions| in
Bram Moolenaar069c1e72016-07-15 21:25:08 +02001233the following ways:
1234
12351. The body of the lambda expression is an |expr1| and not a sequence of |Ex|
1236 commands.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +020012372. The prefix "a:" should not be used for arguments. E.g.: >
Bram Moolenaar069c1e72016-07-15 21:25:08 +02001238 :let F = {arg1, arg2 -> arg1 - arg2}
1239 :echo F(5, 2)
1240< 3
1241
1242The arguments are optional. Example: >
1243 :let F = {-> 'error function'}
1244 :echo F()
1245< error function
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001246 *closure*
1247Lambda expressions can access outer scope variables and arguments. This is
Bram Moolenaar50ba5262016-09-22 22:33:02 +02001248often called a closure. Example where "i" and "a:arg" are used in a lambda
Bram Moolenaardc1f1642016-08-16 18:33:43 +02001249while they exist in the function scope. They remain valid even after the
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001250function returns: >
1251 :function Foo(arg)
1252 : let i = 3
1253 : return {x -> x + i - a:arg}
1254 :endfunction
1255 :let Bar = Foo(4)
1256 :echo Bar(6)
1257< 5
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001258
1259See also |:func-closure|. Lambda and closure support can be checked with: >
1260 if has('lambda')
Bram Moolenaar069c1e72016-07-15 21:25:08 +02001261
1262Examples for using a lambda expression with |sort()|, |map()| and |filter()|: >
1263 :echo map([1, 2, 3], {idx, val -> val + 1})
1264< [2, 3, 4] >
1265 :echo sort([3,7,2,1,4], {a, b -> a - b})
1266< [1, 2, 3, 4, 7]
1267
1268The lambda expression is also useful for Channel, Job and timer: >
1269 :let timer = timer_start(500,
1270 \ {-> execute("echo 'Handler called'", "")},
1271 \ {'repeat': 3})
1272< Handler called
1273 Handler called
1274 Handler called
1275
1276Note how execute() is used to execute an Ex command. That's ugly though.
1277
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001278
1279Lambda expressions have internal names like '<lambda>42'. If you get an error
1280for a lambda expression, you can find what it is with the following command: >
1281 :function {'<lambda>42'}
1282See also: |numbered-function|
1283
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284==============================================================================
Bram Moolenaar4a748032010-09-30 21:47:56 +020012853. Internal variable *internal-variables* *E461*
1286
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287An internal variable name can be made up of letters, digits and '_'. But it
1288cannot start with a digit. It's also possible to use curly braces, see
1289|curly-braces-names|.
1290
1291An internal variable is created with the ":let" command |:let|.
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00001292An internal variable is explicitly destroyed with the ":unlet" command
1293|:unlet|.
1294Using a name that is not an internal variable or refers to a variable that has
1295been destroyed results in an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296
1297There are several name spaces for variables. Which one is to be used is
1298specified by what is prepended:
1299
1300 (nothing) In a function: local to a function; otherwise: global
1301|buffer-variable| b: Local to the current buffer.
1302|window-variable| w: Local to the current window.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001303|tabpage-variable| t: Local to the current tab page.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304|global-variable| g: Global.
1305|local-variable| l: Local to a function.
1306|script-variable| s: Local to a |:source|'ed Vim script.
1307|function-argument| a: Function argument (only inside a function).
Bram Moolenaar75b81562014-04-06 14:09:13 +02001308|vim-variable| v: Global, predefined by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001309
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001310The scope name by itself can be used as a |Dictionary|. For example, to
1311delete all script-local variables: >
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001312 :for k in keys(s:)
1313 : unlet s:[k]
1314 :endfor
1315<
Bram Moolenaar531da592013-05-06 05:58:55 +02001316 *buffer-variable* *b:var* *b:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317A variable name that is preceded with "b:" is local to the current buffer.
1318Thus you can have several "b:foo" variables, one for each buffer.
1319This kind of variable is deleted when the buffer is wiped out or deleted with
1320|:bdelete|.
1321
1322One local buffer variable is predefined:
Bram Moolenaarbf884932013-04-05 22:26:15 +02001323 *b:changedtick* *changetick*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324b:changedtick The total number of changes to the current buffer. It is
1325 incremented for each change. An undo command is also a change
1326 in this case. This can be used to perform an action only when
1327 the buffer has changed. Example: >
1328 :if my_changedtick != b:changedtick
Bram Moolenaar446cb832008-06-24 21:56:24 +00001329 : let my_changedtick = b:changedtick
1330 : call My_Update()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331 :endif
Bram Moolenaar3df01732017-02-17 22:47:16 +01001332< You cannot change or delete the b:changedtick variable.
1333
Bram Moolenaar531da592013-05-06 05:58:55 +02001334 *window-variable* *w:var* *w:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335A variable name that is preceded with "w:" is local to the current window. It
1336is deleted when the window is closed.
1337
Bram Moolenaarad3b3662013-05-17 18:14:19 +02001338 *tabpage-variable* *t:var* *t:*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001339A variable name that is preceded with "t:" is local to the current tab page,
1340It is deleted when the tab page is closed. {not available when compiled
Bram Moolenaardb84e452010-08-15 13:50:43 +02001341without the |+windows| feature}
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001342
Bram Moolenaar531da592013-05-06 05:58:55 +02001343 *global-variable* *g:var* *g:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344Inside functions global variables are accessed with "g:". Omitting this will
Bram Moolenaar58b85342016-08-14 19:54:54 +02001345access a variable local to a function. But "g:" can also be used in any other
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346place if you like.
1347
Bram Moolenaar531da592013-05-06 05:58:55 +02001348 *local-variable* *l:var* *l:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001349Inside functions local variables are accessed without prepending anything.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00001350But you can also prepend "l:" if you like. However, without prepending "l:"
1351you may run into reserved variable names. For example "count". By itself it
1352refers to "v:count". Using "l:count" you can have a local variable with the
1353same name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354
1355 *script-variable* *s:var*
1356In a Vim script variables starting with "s:" can be used. They cannot be
1357accessed from outside of the scripts, thus are local to the script.
1358
1359They can be used in:
1360- commands executed while the script is sourced
1361- functions defined in the script
1362- autocommands defined in the script
1363- functions and autocommands defined in functions and autocommands which were
1364 defined in the script (recursively)
1365- user defined commands defined in the script
1366Thus not in:
1367- other scripts sourced from this one
1368- mappings
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001369- menus
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370- etc.
1371
Bram Moolenaaref2f6562007-05-06 13:32:59 +00001372Script variables can be used to avoid conflicts with global variable names.
1373Take this example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001374
1375 let s:counter = 0
1376 function MyCounter()
1377 let s:counter = s:counter + 1
1378 echo s:counter
1379 endfunction
1380 command Tick call MyCounter()
1381
1382You can now invoke "Tick" from any script, and the "s:counter" variable in
1383that script will not be changed, only the "s:counter" in the script where
1384"Tick" was defined is used.
1385
1386Another example that does the same: >
1387
1388 let s:counter = 0
1389 command Tick let s:counter = s:counter + 1 | echo s:counter
1390
1391When calling a function and invoking a user-defined command, the context for
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001392script variables is set to the script where the function or command was
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393defined.
1394
1395The script variables are also available when a function is defined inside a
1396function that is defined in a script. Example: >
1397
1398 let s:counter = 0
1399 function StartCounting(incr)
1400 if a:incr
1401 function MyCounter()
1402 let s:counter = s:counter + 1
1403 endfunction
1404 else
1405 function MyCounter()
1406 let s:counter = s:counter - 1
1407 endfunction
1408 endif
1409 endfunction
1410
1411This defines the MyCounter() function either for counting up or counting down
1412when calling StartCounting(). It doesn't matter from where StartCounting() is
1413called, the s:counter variable will be accessible in MyCounter().
1414
1415When the same script is sourced again it will use the same script variables.
1416They will remain valid as long as Vim is running. This can be used to
1417maintain a counter: >
1418
1419 if !exists("s:counter")
1420 let s:counter = 1
1421 echo "script executed for the first time"
1422 else
1423 let s:counter = s:counter + 1
1424 echo "script executed " . s:counter . " times now"
1425 endif
1426
1427Note that this means that filetype plugins don't get a different set of script
1428variables for each buffer. Use local buffer variables instead |b:var|.
1429
1430
Bram Moolenaar531da592013-05-06 05:58:55 +02001431Predefined Vim variables: *vim-variable* *v:var* *v:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001432
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001433 *v:beval_col* *beval_col-variable*
1434v:beval_col The number of the column, over which the mouse pointer is.
1435 This is the byte index in the |v:beval_lnum| line.
1436 Only valid while evaluating the 'balloonexpr' option.
1437
1438 *v:beval_bufnr* *beval_bufnr-variable*
1439v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only
1440 valid while evaluating the 'balloonexpr' option.
1441
1442 *v:beval_lnum* *beval_lnum-variable*
1443v:beval_lnum The number of the line, over which the mouse pointer is. Only
1444 valid while evaluating the 'balloonexpr' option.
1445
1446 *v:beval_text* *beval_text-variable*
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001447v:beval_text The text under or after the mouse pointer. Usually a word as
1448 it is useful for debugging a C program. 'iskeyword' applies,
1449 but a dot and "->" before the position is included. When on a
1450 ']' the text before it is used, including the matching '[' and
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001451 word before it. When on a Visual area within one line the
1452 highlighted text is used.
1453 Only valid while evaluating the 'balloonexpr' option.
1454
1455 *v:beval_winnr* *beval_winnr-variable*
1456v:beval_winnr The number of the window, over which the mouse pointer is. Only
Bram Moolenaar00654022011-02-25 14:42:19 +01001457 valid while evaluating the 'balloonexpr' option. The first
1458 window has number zero (unlike most other places where a
1459 window gets a number).
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001460
Bram Moolenaar511972d2016-06-04 18:09:59 +02001461 *v:beval_winid* *beval_winid-variable*
Bram Moolenaar7571d552016-08-18 22:54:46 +02001462v:beval_winid The |window-ID| of the window, over which the mouse pointer
1463 is. Otherwise like v:beval_winnr.
Bram Moolenaar511972d2016-06-04 18:09:59 +02001464
Bram Moolenaarf193fff2006-04-27 00:02:13 +00001465 *v:char* *char-variable*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001466v:char Argument for evaluating 'formatexpr' and used for the typed
Bram Moolenaar945e2db2010-06-05 17:43:32 +02001467 character when using <expr> in an abbreviation |:map-<expr>|.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02001468 It is also used by the |InsertCharPre| and |InsertEnter| events.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00001469
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470 *v:charconvert_from* *charconvert_from-variable*
1471v:charconvert_from
1472 The name of the character encoding of a file to be converted.
1473 Only valid while evaluating the 'charconvert' option.
1474
1475 *v:charconvert_to* *charconvert_to-variable*
1476v:charconvert_to
1477 The name of the character encoding of a file after conversion.
1478 Only valid while evaluating the 'charconvert' option.
1479
1480 *v:cmdarg* *cmdarg-variable*
1481v:cmdarg This variable is used for two purposes:
1482 1. The extra arguments given to a file read/write command.
1483 Currently these are "++enc=" and "++ff=". This variable is
1484 set before an autocommand event for a file read/write
1485 command is triggered. There is a leading space to make it
1486 possible to append this variable directly after the
Bram Moolenaar58b85342016-08-14 19:54:54 +02001487 read/write command. Note: The "+cmd" argument isn't
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488 included here, because it will be executed anyway.
1489 2. When printing a PostScript file with ":hardcopy" this is
1490 the argument for the ":hardcopy" command. This can be used
1491 in 'printexpr'.
1492
1493 *v:cmdbang* *cmdbang-variable*
1494v:cmdbang Set like v:cmdarg for a file read/write command. When a "!"
1495 was used the value is 1, otherwise it is 0. Note that this
1496 can only be used in autocommands. For user commands |<bang>|
1497 can be used.
1498
Bram Moolenaar42a45122015-07-10 17:56:23 +02001499 *v:completed_item* *completed_item-variable*
1500v:completed_item
1501 |Dictionary| containing the |complete-items| for the most
1502 recently completed word after |CompleteDone|. The
1503 |Dictionary| is empty if the completion failed.
1504
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 *v:count* *count-variable*
1506v:count The count given for the last Normal mode command. Can be used
Bram Moolenaar58b85342016-08-14 19:54:54 +02001507 to get the count before a mapping. Read-only. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508 :map _x :<C-U>echo "the count is " . v:count<CR>
1509< Note: The <C-U> is required to remove the line range that you
1510 get when typing ':' after a count.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001511 When there are two counts, as in "3d2w", they are multiplied,
1512 just like what happens in the command, "d6w" for the example.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001513 Also used for evaluating the 'formatexpr' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001514 "count" also works, for backwards compatibility.
1515
1516 *v:count1* *count1-variable*
1517v:count1 Just like "v:count", but defaults to one when no count is
1518 used.
1519
1520 *v:ctype* *ctype-variable*
1521v:ctype The current locale setting for characters of the runtime
1522 environment. This allows Vim scripts to be aware of the
1523 current locale encoding. Technical: it's the value of
1524 LC_CTYPE. When not using a locale the value is "C".
1525 This variable can not be set directly, use the |:language|
1526 command.
1527 See |multi-lang|.
1528
1529 *v:dying* *dying-variable*
Bram Moolenaar58b85342016-08-14 19:54:54 +02001530v:dying Normally zero. When a deadly signal is caught it's set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531 one. When multiple signals are caught the number increases.
1532 Can be used in an autocommand to check if Vim didn't
1533 terminate normally. {only works on Unix}
1534 Example: >
1535 :au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endif
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +02001536< Note: if another deadly signal is caught when v:dying is one,
1537 VimLeave autocommands will not be executed.
1538
Bram Moolenaar071d4272004-06-13 20:20:40 +00001539 *v:errmsg* *errmsg-variable*
1540v:errmsg Last given error message. It's allowed to set this variable.
1541 Example: >
1542 :let v:errmsg = ""
1543 :silent! next
1544 :if v:errmsg != ""
1545 : ... handle error
1546< "errmsg" also works, for backwards compatibility.
1547
Bram Moolenaar43345542015-11-29 17:35:35 +01001548 *v:errors* *errors-variable*
Bram Moolenaar683fa182015-11-30 21:38:24 +01001549v:errors Errors found by assert functions, such as |assert_true()|.
Bram Moolenaar43345542015-11-29 17:35:35 +01001550 This is a list of strings.
1551 The assert functions append an item when an assert fails.
1552 To remove old results make it empty: >
1553 :let v:errors = []
1554< If v:errors is set to anything but a list it is made an empty
1555 list by the assert function.
1556
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 *v:exception* *exception-variable*
1558v:exception The value of the exception most recently caught and not
1559 finished. See also |v:throwpoint| and |throw-variables|.
1560 Example: >
1561 :try
1562 : throw "oops"
1563 :catch /.*/
1564 : echo "caught" v:exception
1565 :endtry
1566< Output: "caught oops".
1567
Bram Moolenaar520e1e42016-01-23 19:46:28 +01001568 *v:false* *false-variable*
1569v:false A Number with value zero. Used to put "false" in JSON. See
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001570 |json_encode()|.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001571 When used as a string this evaluates to "v:false". >
Bram Moolenaar705ada12016-01-24 17:56:50 +01001572 echo v:false
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001573< v:false ~
1574 That is so that eval() can parse the string back to the same
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001575 value. Read-only.
Bram Moolenaar520e1e42016-01-23 19:46:28 +01001576
Bram Moolenaar19a09a12005-03-04 23:39:37 +00001577 *v:fcs_reason* *fcs_reason-variable*
1578v:fcs_reason The reason why the |FileChangedShell| event was triggered.
1579 Can be used in an autocommand to decide what to do and/or what
1580 to set v:fcs_choice to. Possible values:
1581 deleted file no longer exists
1582 conflict file contents, mode or timestamp was
1583 changed and buffer is modified
1584 changed file contents has changed
1585 mode mode of file changed
1586 time only file timestamp changed
1587
1588 *v:fcs_choice* *fcs_choice-variable*
1589v:fcs_choice What should happen after a |FileChangedShell| event was
1590 triggered. Can be used in an autocommand to tell Vim what to
1591 do with the affected buffer:
1592 reload Reload the buffer (does not work if
1593 the file was deleted).
1594 ask Ask the user what to do, as if there
1595 was no autocommand. Except that when
1596 only the timestamp changed nothing
1597 will happen.
1598 <empty> Nothing, the autocommand should do
1599 everything that needs to be done.
1600 The default is empty. If another (invalid) value is used then
1601 Vim behaves like it is empty, there is no warning message.
1602
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603 *v:fname_in* *fname_in-variable*
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001604v:fname_in The name of the input file. Valid while evaluating:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 option used for ~
1606 'charconvert' file to be converted
1607 'diffexpr' original file
1608 'patchexpr' original file
1609 'printexpr' file to be printed
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00001610 And set to the swap file name for |SwapExists|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611
1612 *v:fname_out* *fname_out-variable*
1613v:fname_out The name of the output file. Only valid while
1614 evaluating:
1615 option used for ~
1616 'charconvert' resulting converted file (*)
1617 'diffexpr' output of diff
1618 'patchexpr' resulting patched file
1619 (*) When doing conversion for a write command (e.g., ":w
Bram Moolenaar58b85342016-08-14 19:54:54 +02001620 file") it will be equal to v:fname_in. When doing conversion
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621 for a read command (e.g., ":e file") it will be a temporary
1622 file and different from v:fname_in.
1623
1624 *v:fname_new* *fname_new-variable*
1625v:fname_new The name of the new version of the file. Only valid while
1626 evaluating 'diffexpr'.
1627
1628 *v:fname_diff* *fname_diff-variable*
1629v:fname_diff The name of the diff (patch) file. Only valid while
1630 evaluating 'patchexpr'.
1631
1632 *v:folddashes* *folddashes-variable*
1633v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed
1634 fold.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001635 Read-only in the |sandbox|. |fold-foldtext|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636
1637 *v:foldlevel* *foldlevel-variable*
1638v:foldlevel Used for 'foldtext': foldlevel of closed fold.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001639 Read-only in the |sandbox|. |fold-foldtext|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640
1641 *v:foldend* *foldend-variable*
1642v:foldend Used for 'foldtext': last line of closed fold.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001643 Read-only in the |sandbox|. |fold-foldtext|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644
1645 *v:foldstart* *foldstart-variable*
1646v:foldstart Used for 'foldtext': first line of closed fold.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001647 Read-only in the |sandbox|. |fold-foldtext|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001648
Bram Moolenaar817a8802013-11-09 01:44:43 +01001649 *v:hlsearch* *hlsearch-variable*
Bram Moolenaar76440e22014-11-27 19:14:49 +01001650v:hlsearch Variable that indicates whether search highlighting is on.
1651 Setting it makes sense only if 'hlsearch' is enabled which
1652 requires |+extra_search|. Setting this variable to zero acts
Bram Moolenaar705ada12016-01-24 17:56:50 +01001653 like the |:nohlsearch| command, setting it to one acts like >
Bram Moolenaar817a8802013-11-09 01:44:43 +01001654 let &hlsearch = &hlsearch
Bram Moolenaar86ae7202015-07-10 19:31:35 +02001655< Note that the value is restored when returning from a
1656 function. |function-search-undo|.
1657
Bram Moolenaar843ee412004-06-30 16:16:41 +00001658 *v:insertmode* *insertmode-variable*
1659v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand
1660 events. Values:
1661 i Insert mode
1662 r Replace mode
1663 v Virtual Replace mode
1664
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001665 *v:key* *key-variable*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001666v:key Key of the current item of a |Dictionary|. Only valid while
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001667 evaluating the expression used with |map()| and |filter()|.
1668 Read-only.
1669
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 *v:lang* *lang-variable*
1671v:lang The current locale setting for messages of the runtime
1672 environment. This allows Vim scripts to be aware of the
1673 current language. Technical: it's the value of LC_MESSAGES.
1674 The value is system dependent.
1675 This variable can not be set directly, use the |:language|
1676 command.
1677 It can be different from |v:ctype| when messages are desired
1678 in a different language than what is used for character
1679 encoding. See |multi-lang|.
1680
1681 *v:lc_time* *lc_time-variable*
1682v:lc_time The current locale setting for time messages of the runtime
1683 environment. This allows Vim scripts to be aware of the
1684 current language. Technical: it's the value of LC_TIME.
1685 This variable can not be set directly, use the |:language|
1686 command. See |multi-lang|.
1687
1688 *v:lnum* *lnum-variable*
Bram Moolenaar368373e2010-07-19 20:46:22 +02001689v:lnum Line number for the 'foldexpr' |fold-expr|, 'formatexpr' and
1690 'indentexpr' expressions, tab page number for 'guitablabel'
1691 and 'guitabtooltip'. Only valid while one of these
1692 expressions is being evaluated. Read-only when in the
1693 |sandbox|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694
Bram Moolenaar219b8702006-11-01 14:32:36 +00001695 *v:mouse_win* *mouse_win-variable*
1696v:mouse_win Window number for a mouse click obtained with |getchar()|.
1697 First window has number 1, like with |winnr()|. The value is
1698 zero when there was no mouse button click.
1699
Bram Moolenaar511972d2016-06-04 18:09:59 +02001700 *v:mouse_winid* *mouse_winid-variable*
1701v:mouse_winid Window ID for a mouse click obtained with |getchar()|.
1702 The value is zero when there was no mouse button click.
1703
Bram Moolenaar219b8702006-11-01 14:32:36 +00001704 *v:mouse_lnum* *mouse_lnum-variable*
1705v:mouse_lnum Line number for a mouse click obtained with |getchar()|.
1706 This is the text line number, not the screen line number. The
1707 value is zero when there was no mouse button click.
1708
1709 *v:mouse_col* *mouse_col-variable*
1710v:mouse_col Column number for a mouse click obtained with |getchar()|.
1711 This is the screen column number, like with |virtcol()|. The
1712 value is zero when there was no mouse button click.
1713
Bram Moolenaar520e1e42016-01-23 19:46:28 +01001714 *v:none* *none-variable*
1715v:none An empty String. Used to put an empty item in JSON. See
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001716 |json_encode()|.
Bram Moolenaar705ada12016-01-24 17:56:50 +01001717 When used as a number this evaluates to zero.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001718 When used as a string this evaluates to "v:none". >
Bram Moolenaar705ada12016-01-24 17:56:50 +01001719 echo v:none
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001720< v:none ~
1721 That is so that eval() can parse the string back to the same
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001722 value. Read-only.
Bram Moolenaar520e1e42016-01-23 19:46:28 +01001723
1724 *v:null* *null-variable*
1725v:null An empty String. Used to put "null" in JSON. See
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001726 |json_encode()|.
Bram Moolenaar705ada12016-01-24 17:56:50 +01001727 When used as a number this evaluates to zero.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001728 When used as a string this evaluates to "v:null". >
Bram Moolenaar705ada12016-01-24 17:56:50 +01001729 echo v:null
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001730< v:null ~
1731 That is so that eval() can parse the string back to the same
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001732 value. Read-only.
Bram Moolenaar520e1e42016-01-23 19:46:28 +01001733
Bram Moolenaard812df62008-11-09 12:46:09 +00001734 *v:oldfiles* *oldfiles-variable*
1735v:oldfiles List of file names that is loaded from the |viminfo| file on
1736 startup. These are the files that Vim remembers marks for.
1737 The length of the List is limited by the ' argument of the
1738 'viminfo' option (default is 100).
Bram Moolenaar8d043172014-01-23 14:24:41 +01001739 When the |viminfo| file is not used the List is empty.
Bram Moolenaard812df62008-11-09 12:46:09 +00001740 Also see |:oldfiles| and |c_#<|.
1741 The List can be modified, but this has no effect on what is
1742 stored in the |viminfo| file later. If you use values other
1743 than String this will cause trouble.
Bram Moolenaardb84e452010-08-15 13:50:43 +02001744 {only when compiled with the |+viminfo| feature}
Bram Moolenaard812df62008-11-09 12:46:09 +00001745
Bram Moolenaar53744302015-07-17 17:38:22 +02001746 *v:option_new*
1747v:option_new New value of the option. Valid while executing an |OptionSet|
1748 autocommand.
1749 *v:option_old*
1750v:option_old Old value of the option. Valid while executing an |OptionSet|
1751 autocommand.
1752 *v:option_type*
1753v:option_type Scope of the set command. Valid while executing an
1754 |OptionSet| autocommand. Can be either "global" or "local"
Bram Moolenaar8af1fbf2008-01-05 12:35:21 +00001755 *v:operator* *operator-variable*
1756v:operator The last operator given in Normal mode. This is a single
1757 character except for commands starting with <g> or <z>,
1758 in which case it is two characters. Best used alongside
1759 |v:prevcount| and |v:register|. Useful if you want to cancel
1760 Operator-pending mode and then use the operator, e.g.: >
1761 :omap O <Esc>:call MyMotion(v:operator)<CR>
1762< The value remains set until another operator is entered, thus
1763 don't expect it to be empty.
1764 v:operator is not set for |:delete|, |:yank| or other Ex
1765 commands.
1766 Read-only.
1767
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768 *v:prevcount* *prevcount-variable*
1769v:prevcount The count given for the last but one Normal mode command.
1770 This is the v:count value of the previous command. Useful if
Bram Moolenaar8af1fbf2008-01-05 12:35:21 +00001771 you want to cancel Visual or Operator-pending mode and then
1772 use the count, e.g.: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 :vmap % <Esc>:call MyFilter(v:prevcount)<CR>
1774< Read-only.
1775
Bram Moolenaar05159a02005-02-26 23:04:13 +00001776 *v:profiling* *profiling-variable*
Bram Moolenaar58b85342016-08-14 19:54:54 +02001777v:profiling Normally zero. Set to one after using ":profile start".
Bram Moolenaar05159a02005-02-26 23:04:13 +00001778 See |profiling|.
1779
Bram Moolenaar071d4272004-06-13 20:20:40 +00001780 *v:progname* *progname-variable*
1781v:progname Contains the name (with path removed) with which Vim was
Bram Moolenaard38b0552012-04-25 19:07:41 +02001782 invoked. Allows you to do special initialisations for |view|,
1783 |evim| etc., or any other name you might symlink to Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 Read-only.
1785
Bram Moolenaara1706c92014-04-01 19:55:49 +02001786 *v:progpath* *progpath-variable*
1787v:progpath Contains the command with which Vim was invoked, including the
1788 path. Useful if you want to message a Vim server using a
1789 |--remote-expr|.
Bram Moolenaarc7f02552014-04-01 21:00:59 +02001790 To get the full path use: >
1791 echo exepath(v:progpath)
Bram Moolenaar08cab962017-03-04 14:37:18 +01001792< If the path is relative it will be expanded to the full path,
1793 so that it still works after `:cd`. Thus starting "./vim"
1794 results in "/home/user/path/to/vim/src/vim".
1795 On MS-Windows the executable may be called "vim.exe", but the
1796 ".exe" is not added to v:progpath.
Bram Moolenaara1706c92014-04-01 19:55:49 +02001797 Read-only.
1798
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 *v:register* *register-variable*
Bram Moolenaard58e9292011-02-09 17:07:58 +01001800v:register The name of the register in effect for the current normal mode
Bram Moolenaard38b0552012-04-25 19:07:41 +02001801 command (regardless of whether that command actually used a
1802 register). Or for the currently executing normal mode mapping
1803 (use this in custom commands that take a register).
1804 If none is supplied it is the default register '"', unless
1805 'clipboard' contains "unnamed" or "unnamedplus", then it is
1806 '*' or '+'.
Bram Moolenaard58e9292011-02-09 17:07:58 +01001807 Also see |getreg()| and |setreg()|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001809 *v:scrollstart* *scrollstart-variable*
1810v:scrollstart String describing the script or function that caused the
1811 screen to scroll up. It's only set when it is empty, thus the
1812 first reason is remembered. It is set to "Unknown" for a
1813 typed command.
1814 This can be used to find out why your script causes the
1815 hit-enter prompt.
1816
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817 *v:servername* *servername-variable*
Bram Moolenaarc2ce52c2017-08-01 18:35:38 +02001818v:servername The resulting registered |client-server-name| if any.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 Read-only.
1820
Bram Moolenaar446cb832008-06-24 21:56:24 +00001821
1822v:searchforward *v:searchforward* *searchforward-variable*
1823 Search direction: 1 after a forward search, 0 after a
1824 backward search. It is reset to forward when directly setting
1825 the last search pattern, see |quote/|.
1826 Note that the value is restored when returning from a
1827 function. |function-search-undo|.
1828 Read-write.
1829
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 *v:shell_error* *shell_error-variable*
1831v:shell_error Result of the last shell command. When non-zero, the last
1832 shell command had an error. When zero, there was no problem.
1833 This only works when the shell returns the error code to Vim.
1834 The value -1 is often used when the command could not be
1835 executed. Read-only.
1836 Example: >
1837 :!mv foo bar
1838 :if v:shell_error
1839 : echo 'could not rename "foo" to "bar"!'
1840 :endif
1841< "shell_error" also works, for backwards compatibility.
1842
1843 *v:statusmsg* *statusmsg-variable*
1844v:statusmsg Last given status message. It's allowed to set this variable.
1845
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001846 *v:swapname* *swapname-variable*
1847v:swapname Only valid when executing |SwapExists| autocommands: Name of
1848 the swap file found. Read-only.
1849
1850 *v:swapchoice* *swapchoice-variable*
1851v:swapchoice |SwapExists| autocommands can set this to the selected choice
1852 for handling an existing swap file:
1853 'o' Open read-only
1854 'e' Edit anyway
1855 'r' Recover
1856 'd' Delete swapfile
1857 'q' Quit
1858 'a' Abort
Bram Moolenaar58b85342016-08-14 19:54:54 +02001859 The value should be a single-character string. An empty value
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001860 results in the user being asked, as would happen when there is
1861 no SwapExists autocommand. The default is empty.
1862
Bram Moolenaarb3480382005-12-11 21:33:32 +00001863 *v:swapcommand* *swapcommand-variable*
Bram Moolenaar4770d092006-01-12 23:22:24 +00001864v:swapcommand Normal mode command to be executed after a file has been
Bram Moolenaarb3480382005-12-11 21:33:32 +00001865 opened. Can be used for a |SwapExists| autocommand to have
Bram Moolenaar58b85342016-08-14 19:54:54 +02001866 another Vim open the file and jump to the right place. For
Bram Moolenaarb3480382005-12-11 21:33:32 +00001867 example, when jumping to a tag the value is ":tag tagname\r".
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00001868 For ":edit +cmd file" the value is ":cmd\r".
Bram Moolenaarb3480382005-12-11 21:33:32 +00001869
Bram Moolenaard823fa92016-08-12 16:29:27 +02001870 *v:t_TYPE* *v:t_bool* *t_bool-variable*
Bram Moolenaarf562e722016-07-19 17:25:25 +02001871v:t_bool Value of Boolean type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02001872 *v:t_channel* *t_channel-variable*
Bram Moolenaarf562e722016-07-19 17:25:25 +02001873v:t_channel Value of Channel type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02001874 *v:t_dict* *t_dict-variable*
Bram Moolenaarf562e722016-07-19 17:25:25 +02001875v:t_dict Value of Dictionary type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02001876 *v:t_float* *t_float-variable*
Bram Moolenaarf562e722016-07-19 17:25:25 +02001877v:t_float Value of Float type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02001878 *v:t_func* *t_func-variable*
Bram Moolenaarf562e722016-07-19 17:25:25 +02001879v:t_func Value of Funcref type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02001880 *v:t_job* *t_job-variable*
Bram Moolenaarf562e722016-07-19 17:25:25 +02001881v:t_job Value of Job type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02001882 *v:t_list* *t_list-variable*
Bram Moolenaarf562e722016-07-19 17:25:25 +02001883v:t_list Value of List type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02001884 *v:t_none* *t_none-variable*
Bram Moolenaarf562e722016-07-19 17:25:25 +02001885v:t_none Value of None type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02001886 *v:t_number* *t_number-variable*
Bram Moolenaarf562e722016-07-19 17:25:25 +02001887v:t_number Value of Number type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02001888 *v:t_string* *t_string-variable*
Bram Moolenaarf562e722016-07-19 17:25:25 +02001889v:t_string Value of String type. Read-only. See: |type()|
1890
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 *v:termresponse* *termresponse-variable*
1892v:termresponse The escape sequence returned by the terminal for the |t_RV|
Bram Moolenaar58b85342016-08-14 19:54:54 +02001893 termcap entry. It is set when Vim receives an escape sequence
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 that starts with ESC [ or CSI and ends in a 'c', with only
1895 digits, ';' and '.' in between.
1896 When this option is set, the TermResponse autocommand event is
1897 fired, so that you can react to the response from the
1898 terminal.
1899 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp
1900 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the
1901 patch level (since this was introduced in patch 95, it's
1902 always 95 or bigger). Pc is always zero.
1903 {only when compiled with |+termresponse| feature}
1904
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02001905 *v:testing* *testing-variable*
Bram Moolenaar8e8df252016-05-25 21:23:21 +02001906v:testing Must be set before using `test_garbagecollect_now()`.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001907 Also, when set certain error messages won't be shown for 2
1908 seconds. (e.g. "'dictionary' option is empty")
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02001909
Bram Moolenaar071d4272004-06-13 20:20:40 +00001910 *v:this_session* *this_session-variable*
1911v:this_session Full filename of the last loaded or saved session file. See
1912 |:mksession|. It is allowed to set this variable. When no
1913 session file has been saved, this variable is empty.
1914 "this_session" also works, for backwards compatibility.
1915
1916 *v:throwpoint* *throwpoint-variable*
1917v:throwpoint The point where the exception most recently caught and not
Bram Moolenaar58b85342016-08-14 19:54:54 +02001918 finished was thrown. Not set when commands are typed. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 also |v:exception| and |throw-variables|.
1920 Example: >
1921 :try
1922 : throw "oops"
1923 :catch /.*/
1924 : echo "Exception from" v:throwpoint
1925 :endtry
1926< Output: "Exception from test.vim, line 2"
1927
Bram Moolenaar520e1e42016-01-23 19:46:28 +01001928 *v:true* *true-variable*
1929v:true A Number with value one. Used to put "true" in JSON. See
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001930 |json_encode()|.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001931 When used as a string this evaluates to "v:true". >
Bram Moolenaar705ada12016-01-24 17:56:50 +01001932 echo v:true
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001933< v:true ~
1934 That is so that eval() can parse the string back to the same
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001935 value. Read-only.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001936 *v:val* *val-variable*
Bram Moolenaar58b85342016-08-14 19:54:54 +02001937v:val Value of the current item of a |List| or |Dictionary|. Only
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001938 valid while evaluating the expression used with |map()| and
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001939 |filter()|. Read-only.
1940
Bram Moolenaar071d4272004-06-13 20:20:40 +00001941 *v:version* *version-variable*
1942v:version Version number of Vim: Major version number times 100 plus
1943 minor version number. Version 5.0 is 500. Version 5.1 (5.01)
1944 is 501. Read-only. "version" also works, for backwards
1945 compatibility.
1946 Use |has()| to check if a certain patch was included, e.g.: >
Bram Moolenaar6716d9a2014-04-02 12:12:08 +02001947 if has("patch-7.4.123")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001948< Note that patch numbers are specific to the version, thus both
1949 version 5.0 and 5.1 may have a patch 123, but these are
1950 completely different.
1951
Bram Moolenaar14735512016-03-26 21:00:08 +01001952 *v:vim_did_enter* *vim_did_enter-variable*
1953v:vim_did_enter Zero until most of startup is done. It is set to one just
1954 before |VimEnter| autocommands are triggered.
1955
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956 *v:warningmsg* *warningmsg-variable*
1957v:warningmsg Last given warning message. It's allowed to set this variable.
1958
Bram Moolenaar727c8762010-10-20 19:17:48 +02001959 *v:windowid* *windowid-variable*
1960v:windowid When any X11 based GUI is running or when running in a
1961 terminal and Vim connects to the X server (|-X|) this will be
Bram Moolenaar264e9fd2010-10-27 12:33:17 +02001962 set to the window ID.
1963 When an MS-Windows GUI is running this will be set to the
1964 window handle.
1965 Otherwise the value is zero.
Bram Moolenaar7571d552016-08-18 22:54:46 +02001966 Note: for windows inside Vim use |winnr()| or |win_getid()|,
1967 see |window-ID|.
Bram Moolenaar727c8762010-10-20 19:17:48 +02001968
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969==============================================================================
19704. Builtin Functions *functions*
1971
1972See |function-list| for a list grouped by what the function is used for.
1973
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001974(Use CTRL-] on the function name to jump to the full explanation.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001975
1976USAGE RESULT DESCRIPTION ~
1977
Bram Moolenaar81edd172016-04-14 13:51:37 +02001978abs({expr}) Float or Number absolute value of {expr}
1979acos({expr}) Float arc cosine of {expr}
1980add({list}, {item}) List append {item} to |List| {list}
Bram Moolenaara06ecab2016-07-16 14:47:36 +02001981and({expr}, {expr}) Number bitwise AND
Bram Moolenaar81edd172016-04-14 13:51:37 +02001982append({lnum}, {string}) Number append {string} below line {lnum}
1983append({lnum}, {list}) Number append lines {list} below line {lnum}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984argc() Number number of files in the argument list
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001985argidx() Number current index in the argument list
Bram Moolenaar81edd172016-04-14 13:51:37 +02001986arglistid([{winnr} [, {tabnr}]]) Number argument list id
1987argv({nr}) String {nr} entry of the argument list
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001988argv() List the argument list
Bram Moolenaar42205552017-03-18 19:42:22 +01001989assert_equal({exp}, {act} [, {msg}])
1990 none assert {exp} is equal to {act}
1991assert_exception({error} [, {msg}])
1992 none assert {error} is in v:exception
1993assert_fails({cmd} [, {error}]) none assert {cmd} fails
1994assert_false({actual} [, {msg}])
1995 none assert {actual} is false
Bram Moolenaar61c04492016-07-23 15:35:35 +02001996assert_inrange({lower}, {upper}, {actual} [, {msg}])
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001997 none assert {actual} is inside the range
Bram Moolenaar42205552017-03-18 19:42:22 +01001998assert_match({pat}, {text} [, {msg}])
1999 none assert {pat} matches {text}
2000assert_notequal({exp}, {act} [, {msg}])
2001 none assert {exp} is not equal {act}
2002assert_notmatch({pat}, {text} [, {msg}])
2003 none assert {pat} not matches {text}
2004assert_report({msg}) none report a test failure
2005assert_true({actual} [, {msg}]) none assert {actual} is true
Bram Moolenaar81edd172016-04-14 13:51:37 +02002006asin({expr}) Float arc sine of {expr}
2007atan({expr}) Float arc tangent of {expr}
Bram Moolenaar04186092016-08-29 21:55:35 +02002008atan2({expr1}, {expr2}) Float arc tangent of {expr1} / {expr2}
Bram Moolenaar59716a22017-03-01 20:32:44 +01002009balloon_show({msg}) none show {msg} inside the balloon
Bram Moolenaar81edd172016-04-14 13:51:37 +02002010browse({save}, {title}, {initdir}, {default})
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 String put up a file requester
Bram Moolenaar81edd172016-04-14 13:51:37 +02002012browsedir({title}, {initdir}) String put up a directory requester
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002013bufexists({expr}) Number |TRUE| if buffer {expr} exists
2014buflisted({expr}) Number |TRUE| if buffer {expr} is listed
2015bufloaded({expr}) Number |TRUE| if buffer {expr} is loaded
Bram Moolenaar81edd172016-04-14 13:51:37 +02002016bufname({expr}) String Name of the buffer {expr}
2017bufnr({expr} [, {create}]) Number Number of the buffer {expr}
Bram Moolenaarb3619a92016-06-04 17:58:52 +02002018bufwinid({expr}) Number window ID of buffer {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002019bufwinnr({expr}) Number window number of buffer {expr}
2020byte2line({byte}) Number line number at byte count {byte}
2021byteidx({expr}, {nr}) Number byte index of {nr}'th char in {expr}
2022byteidxcomp({expr}, {nr}) Number byte index of {nr}'th char in {expr}
2023call({func}, {arglist} [, {dict}])
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002024 any call {func} with arguments {arglist}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002025ceil({expr}) Float round {expr} up
Bram Moolenaar4b785f62016-11-29 21:54:44 +01002026ch_canread({handle}) Number check if there is something to read
Bram Moolenaar81edd172016-04-14 13:51:37 +02002027ch_close({handle}) none close {handle}
Bram Moolenaar0874a832016-09-01 15:11:51 +02002028ch_close_in({handle}) none close in part of {handle}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002029ch_evalexpr({handle}, {expr} [, {options}])
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01002030 any evaluate {expr} on JSON {handle}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002031ch_evalraw({handle}, {string} [, {options}])
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01002032 any evaluate {string} on raw {handle}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002033ch_getbufnr({handle}, {what}) Number get buffer number for {handle}/{what}
2034ch_getjob({channel}) Job get the Job of {channel}
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002035ch_info({handle}) String info about channel {handle}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002036ch_log({msg} [, {handle}]) none write {msg} in the channel log file
2037ch_logfile({fname} [, {mode}]) none start logging channel activity
2038ch_open({address} [, {options}])
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002039 Channel open a channel to {address}
2040ch_read({handle} [, {options}]) String read from {handle}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002041ch_readraw({handle} [, {options}])
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002042 String read raw from {handle}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002043ch_sendexpr({handle}, {expr} [, {options}])
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01002044 any send {expr} over JSON {handle}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002045ch_sendraw({handle}, {string} [, {options}])
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01002046 any send {string} over raw {handle}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002047ch_setoptions({handle}, {options})
2048 none set options for {handle}
Bram Moolenaar7ef38102016-09-26 22:36:58 +02002049ch_status({handle} [, {options}])
2050 String status of channel {handle}
Bram Moolenaar446cb832008-06-24 21:56:24 +00002051changenr() Number current change number
Bram Moolenaar81edd172016-04-14 13:51:37 +02002052char2nr({expr}[, {utf8}]) Number ASCII/UTF8 value of first char in {expr}
2053cindent({lnum}) Number C indent for line {lnum}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002054clearmatches() none clear all matches
Bram Moolenaar81edd172016-04-14 13:51:37 +02002055col({expr}) Number column nr of cursor or mark
2056complete({startcol}, {matches}) none set Insert mode completion
2057complete_add({expr}) Number add completion match
Bram Moolenaar446cb832008-06-24 21:56:24 +00002058complete_check() Number check for key typed during completion
Bram Moolenaar81edd172016-04-14 13:51:37 +02002059confirm({msg} [, {choices} [, {default} [, {type}]]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 Number number of choice picked by user
Bram Moolenaar81edd172016-04-14 13:51:37 +02002061copy({expr}) any make a shallow copy of {expr}
2062cos({expr}) Float cosine of {expr}
2063cosh({expr}) Float hyperbolic cosine of {expr}
2064count({list}, {expr} [, {ic} [, {start}]])
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002065 Number count how many {expr} are in {list}
Bram Moolenaardc1f1642016-08-16 18:33:43 +02002066cscope_connection([{num}, {dbpath} [, {prepend}]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 Number checks existence of cscope connection
Bram Moolenaar81edd172016-04-14 13:51:37 +02002068cursor({lnum}, {col} [, {off}])
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01002069 Number move cursor to {lnum}, {col}, {off}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002070cursor({list}) Number move cursor to position in {list}
2071deepcopy({expr} [, {noref}]) any make a full copy of {expr}
2072delete({fname} [, {flags}]) Number delete the file or directory {fname}
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002073did_filetype() Number |TRUE| if FileType autocmd event used
Bram Moolenaar81edd172016-04-14 13:51:37 +02002074diff_filler({lnum}) Number diff filler lines about {lnum}
2075diff_hlID({lnum}, {col}) Number diff highlighting at {lnum}/{col}
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002076empty({expr}) Number |TRUE| if {expr} is empty
Bram Moolenaar81edd172016-04-14 13:51:37 +02002077escape({string}, {chars}) String escape {chars} in {string} with '\'
2078eval({string}) any evaluate {string} into its value
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002079eventhandler() Number |TRUE| if inside an event handler
Bram Moolenaar81edd172016-04-14 13:51:37 +02002080executable({expr}) Number 1 if executable {expr} exists
Bram Moolenaar79815f12016-07-09 17:07:29 +02002081execute({command}) String execute {command} and get the output
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002082exepath({expr}) String full path of the command {expr}
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002083exists({expr}) Number |TRUE| if {expr} exists
Bram Moolenaar81edd172016-04-14 13:51:37 +02002084extend({expr1}, {expr2} [, {expr3}])
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00002085 List/Dict insert items of {expr2} into {expr1}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002086exp({expr}) Float exponential of {expr}
2087expand({expr} [, {nosuf} [, {list}]])
Bram Moolenaar146e9c32012-03-07 19:18:23 +01002088 any expand special keywords in {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002089feedkeys({string} [, {mode}]) Number add key sequence to typeahead buffer
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002090filereadable({file}) Number |TRUE| if {file} is a readable file
2091filewritable({file}) Number |TRUE| if {file} is a writable file
Bram Moolenaar50ba5262016-09-22 22:33:02 +02002092filter({expr1}, {expr2}) List/Dict remove items from {expr1} where
2093 {expr2} is 0
Bram Moolenaar81edd172016-04-14 13:51:37 +02002094finddir({name}[, {path}[, {count}]])
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00002095 String find directory {name} in {path}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002096findfile({name}[, {path}[, {count}]])
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00002097 String find file {name} in {path}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002098float2nr({expr}) Number convert Float {expr} to a Number
2099floor({expr}) Float round {expr} down
2100fmod({expr1}, {expr2}) Float remainder of {expr1} / {expr2}
2101fnameescape({fname}) String escape special characters in {fname}
2102fnamemodify({fname}, {mods}) String modify file name
2103foldclosed({lnum}) Number first line of fold at {lnum} if closed
2104foldclosedend({lnum}) Number last line of fold at {lnum} if closed
2105foldlevel({lnum}) Number fold level at {lnum}
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002106foldtext() String line displayed for closed fold
Bram Moolenaar81edd172016-04-14 13:51:37 +02002107foldtextresult({lnum}) String text for closed fold at {lnum}
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002108foreground() Number bring the Vim window to the foreground
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002109funcref({name} [, {arglist}] [, {dict}])
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002110 Funcref reference to function {name}
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002111function({name} [, {arglist}] [, {dict}])
2112 Funcref named reference to function {name}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002113garbagecollect([{atexit}]) none free memory, breaking cyclic references
Bram Moolenaar81edd172016-04-14 13:51:37 +02002114get({list}, {idx} [, {def}]) any get item {idx} from {list} or {def}
2115get({dict}, {key} [, {def}]) any get item {key} from {dict} or {def}
Bram Moolenaar03e19a02016-05-24 22:29:49 +02002116get({func}, {what}) any get property of funcref/partial {func}
Bram Moolenaar50ba5262016-09-22 22:33:02 +02002117getbufinfo([{expr}]) List information about buffers
Bram Moolenaar81edd172016-04-14 13:51:37 +02002118getbufline({expr}, {lnum} [, {end}])
Bram Moolenaar45360022005-07-21 21:08:21 +00002119 List lines {lnum} to {end} of buffer {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002120getbufvar({expr}, {varname} [, {def}])
Bram Moolenaar63dbda12013-02-20 21:12:10 +01002121 any variable {varname} in buffer {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002122getchar([expr]) Number get one character from the user
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002123getcharmod() Number modifiers for the last typed character
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02002124getcharsearch() Dict last character search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125getcmdline() String return the current command-line
2126getcmdpos() Number return cursor position in command-line
Bram Moolenaarfb539272014-08-22 19:21:47 +02002127getcmdtype() String return current command-line type
2128getcmdwintype() String return current command-line window type
Bram Moolenaare9d58a62016-08-13 15:07:41 +02002129getcompletion({pat}, {type} [, {filtered}])
2130 List list of cmdline completion matches
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02002131getcurpos() List position of the cursor
Bram Moolenaar81edd172016-04-14 13:51:37 +02002132getcwd([{winnr} [, {tabnr}]]) String get the current working directory
2133getfontname([{name}]) String name of font being used
2134getfperm({fname}) String file permissions of file {fname}
2135getfsize({fname}) Number size in bytes of file {fname}
2136getftime({fname}) Number last modification time of file
2137getftype({fname}) String description of type of file {fname}
2138getline({lnum}) String line {lnum} of current buffer
2139getline({lnum}, {end}) List lines {lnum} to {end} of current buffer
Bram Moolenaard823fa92016-08-12 16:29:27 +02002140getloclist({nr}[, {what}]) List list of location list items
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002141getmatches() List list of current matches
Bram Moolenaar18081e32008-02-20 19:11:07 +00002142getpid() Number process ID of Vim
Bram Moolenaar81edd172016-04-14 13:51:37 +02002143getpos({expr}) List position of cursor, mark, etc.
Bram Moolenaard823fa92016-08-12 16:29:27 +02002144getqflist([{what}]) List list of quickfix items
Bram Moolenaar81edd172016-04-14 13:51:37 +02002145getreg([{regname} [, 1 [, {list}]]])
Bram Moolenaarb7cb42b2014-04-02 19:55:10 +02002146 String or List contents of register
Bram Moolenaar81edd172016-04-14 13:51:37 +02002147getregtype([{regname}]) String type of register
Bram Moolenaar50ba5262016-09-22 22:33:02 +02002148gettabinfo([{expr}]) List list of tab pages
Bram Moolenaar81edd172016-04-14 13:51:37 +02002149gettabvar({nr}, {varname} [, {def}])
Bram Moolenaar63dbda12013-02-20 21:12:10 +01002150 any variable {varname} in tab {nr} or {def}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002151gettabwinvar({tabnr}, {winnr}, {name} [, {def}])
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00002152 any {name} in {winnr} in tab page {tabnr}
Bram Moolenaar50ba5262016-09-22 22:33:02 +02002153getwininfo([{winid}]) List list of windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00002154getwinposx() Number X coord in pixels of GUI Vim window
2155getwinposy() Number Y coord in pixels of GUI Vim window
Bram Moolenaar81edd172016-04-14 13:51:37 +02002156getwinvar({nr}, {varname} [, {def}])
Bram Moolenaar63dbda12013-02-20 21:12:10 +01002157 any variable {varname} in window {nr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002158glob({expr} [, {nosuf} [, {list} [, {alllinks}]]])
Bram Moolenaar146e9c32012-03-07 19:18:23 +01002159 any expand file wildcards in {expr}
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002160glob2regpat({expr}) String convert a glob pat into a search pat
Bram Moolenaar81edd172016-04-14 13:51:37 +02002161globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00002162 String do glob({expr}) for all dirs in {path}
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002163has({feature}) Number |TRUE| if feature {feature} supported
2164has_key({dict}, {key}) Number |TRUE| if {dict} has entry {key}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002165haslocaldir([{winnr} [, {tabnr}]])
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002166 Number |TRUE| if the window executed |:lcd|
Bram Moolenaar81edd172016-04-14 13:51:37 +02002167hasmapto({what} [, {mode} [, {abbr}]])
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002168 Number |TRUE| if mapping to {what} exists
Bram Moolenaar81edd172016-04-14 13:51:37 +02002169histadd({history}, {item}) String add an item to a history
2170histdel({history} [, {item}]) String remove an item from a history
2171histget({history} [, {index}]) String get the item {index} from a history
2172histnr({history}) Number highest index of a history
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002173hlexists({name}) Number |TRUE| if highlight group {name} exists
Bram Moolenaar81edd172016-04-14 13:51:37 +02002174hlID({name}) Number syntax ID of highlight group {name}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175hostname() String name of the machine Vim is running on
Bram Moolenaar81edd172016-04-14 13:51:37 +02002176iconv({expr}, {from}, {to}) String convert encoding of {expr}
2177indent({lnum}) Number indent of line {lnum}
2178index({list}, {expr} [, {start} [, {ic}]])
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00002179 Number index in {list} where {expr} appears
Bram Moolenaar81edd172016-04-14 13:51:37 +02002180input({prompt} [, {text} [, {completion}]])
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00002181 String get input from the user
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +02002182inputdialog({prompt} [, {text} [, {completion}]])
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002183 String like input() but in a GUI dialog
Bram Moolenaar81edd172016-04-14 13:51:37 +02002184inputlist({textlist}) Number let the user pick from a choice list
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002185inputrestore() Number restore typeahead
2186inputsave() Number save and clear typeahead
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002187inputsecret({prompt} [, {text}]) String like input() but hiding the text
Bram Moolenaar81edd172016-04-14 13:51:37 +02002188insert({list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}]
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002189invert({expr}) Number bitwise invert
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002190isdirectory({directory}) Number |TRUE| if {directory} is a directory
2191islocked({expr}) Number |TRUE| if {expr} is locked
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002192isnan({expr}) Number |TRUE| if {expr} is NaN
Bram Moolenaar81edd172016-04-14 13:51:37 +02002193items({dict}) List key-value pairs in {dict}
2194job_getchannel({job}) Channel get the channel handle for {job}
2195job_info({job}) Dict get information about {job}
2196job_setoptions({job}, {options}) none set options for {job}
2197job_start({command} [, {options}])
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002198 Job start a job
Bram Moolenaar81edd172016-04-14 13:51:37 +02002199job_status({job}) String get the status of {job}
2200job_stop({job} [, {how}]) Number stop {job}
2201join({list} [, {sep}]) String join {list} items into one String
2202js_decode({string}) any decode JS style JSON
2203js_encode({expr}) String encode JS style JSON
2204json_decode({string}) any decode JSON
2205json_encode({expr}) String encode JSON
2206keys({dict}) List keys in {dict}
2207len({expr}) Number the length of {expr}
2208libcall({lib}, {func}, {arg}) String call {func} in library {lib} with {arg}
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002209libcallnr({lib}, {func}, {arg}) Number idem, but return a Number
Bram Moolenaar81edd172016-04-14 13:51:37 +02002210line({expr}) Number line nr of cursor, last line or mark
2211line2byte({lnum}) Number byte count of line {lnum}
2212lispindent({lnum}) Number Lisp indent for line {lnum}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213localtime() Number current time
Bram Moolenaar81edd172016-04-14 13:51:37 +02002214log({expr}) Float natural logarithm (base e) of {expr}
2215log10({expr}) Float logarithm of Float {expr} to base 10
2216luaeval({expr}[, {expr}]) any evaluate |Lua| expression
Bram Moolenaar50ba5262016-09-22 22:33:02 +02002217map({expr1}, {expr2}) List/Dict change each item in {expr1} to {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002218maparg({name}[, {mode} [, {abbr} [, {dict}]]])
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01002219 String or Dict
2220 rhs of mapping {name} in mode {mode}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002221mapcheck({name}[, {mode} [, {abbr}]])
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002222 String check for mappings matching {name}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002223match({expr}, {pat}[, {start}[, {count}]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224 Number position where {pat} matches in {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002225matchadd({group}, {pattern}[, {priority}[, {id} [, {dict}]]])
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002226 Number highlight {pattern} with {group}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002227matchaddpos({group}, {pos}[, {priority}[, {id}[, {dict}]]])
Bram Moolenaarb3414592014-06-17 17:48:32 +02002228 Number highlight positions with {group}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002229matcharg({nr}) List arguments of |:match|
2230matchdelete({id}) Number delete match identified by {id}
2231matchend({expr}, {pat}[, {start}[, {count}]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232 Number position where {pat} ends in {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002233matchlist({expr}, {pat}[, {start}[, {count}]])
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002234 List match and submatches of {pat} in {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002235matchstr({expr}, {pat}[, {start}[, {count}]])
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00002236 String {count}'th match of {pat} in {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002237matchstrpos({expr}, {pat}[, {start}[, {count}]])
Bram Moolenaar7fed5c12016-03-29 23:10:31 +02002238 List {count}'th match of {pat} in {expr}
Bram Moolenaar690afe12017-01-28 18:34:47 +01002239max({expr}) Number maximum value of items in {expr}
2240min({expr}) Number minimum value of items in {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002241mkdir({name} [, {path} [, {prot}]])
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002242 Number create directory {name}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002243mode([expr]) String current editing mode
2244mzeval({expr}) any evaluate |MzScheme| expression
2245nextnonblank({lnum}) Number line nr of non-blank line >= {lnum}
2246nr2char({expr}[, {utf8}]) String single char with ASCII/UTF8 value {expr}
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002247or({expr}, {expr}) Number bitwise OR
Bram Moolenaar81edd172016-04-14 13:51:37 +02002248pathshorten({expr}) String shorten directory names in a path
2249perleval({expr}) any evaluate |Perl| expression
2250pow({x}, {y}) Float {x} to the power of {y}
2251prevnonblank({lnum}) Number line nr of non-blank line <= {lnum}
2252printf({fmt}, {expr1}...) String format text
Bram Moolenaar446cb832008-06-24 21:56:24 +00002253pumvisible() Number whether popup menu is visible
Bram Moolenaar81edd172016-04-14 13:51:37 +02002254pyeval({expr}) any evaluate |Python| expression
2255py3eval({expr}) any evaluate |python3| expression
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01002256pyxeval({expr}) any evaluate |python_x| expression
Bram Moolenaar81edd172016-04-14 13:51:37 +02002257range({expr} [, {max} [, {stride}]])
Bram Moolenaard8b02732005-01-14 21:48:43 +00002258 List items from {expr} to {max}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002259readfile({fname} [, {binary} [, {max}]])
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002260 List get list of lines from file {fname}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002261reltime([{start} [, {end}]]) List get time value
2262reltimefloat({time}) Float turn the time value into a Float
2263reltimestr({time}) String turn time value into a String
Bram Moolenaar3c2881d2017-03-21 19:18:29 +01002264remote_expr({server}, {string} [, {idvar} [, {timeout}]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 String send expression
Bram Moolenaar81edd172016-04-14 13:51:37 +02002266remote_foreground({server}) Number bring Vim server to the foreground
2267remote_peek({serverid} [, {retvar}])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 Number check for reply string
Bram Moolenaar3c2881d2017-03-21 19:18:29 +01002269remote_read({serverid} [, {timeout}])
2270 String read reply string
Bram Moolenaar81edd172016-04-14 13:51:37 +02002271remote_send({server}, {string} [, {idvar}])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002272 String send key sequence
Bram Moolenaar7416f3e2017-03-18 18:10:13 +01002273remote_startserver({name}) none become server {name}
2274 String send key sequence
Bram Moolenaar802a0d92016-06-26 16:17:58 +02002275remove({list}, {idx} [, {end}]) any remove items {idx}-{end} from {list}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002276remove({dict}, {key}) any remove entry {key} from {dict}
2277rename({from}, {to}) Number rename (move) file from {from} to {to}
2278repeat({expr}, {count}) String repeat {expr} {count} times
2279resolve({filename}) String get filename a shortcut points to
2280reverse({list}) List reverse {list} in-place
2281round({expr}) Float round off {expr}
2282screenattr({row}, {col}) Number attribute at screen position
2283screenchar({row}, {col}) Number character at screen position
Bram Moolenaar9750bb12012-12-05 16:10:42 +01002284screencol() Number current cursor column
2285screenrow() Number current cursor row
Bram Moolenaar81edd172016-04-14 13:51:37 +02002286search({pattern} [, {flags} [, {stopline} [, {timeout}]]])
Bram Moolenaar76929292008-01-06 19:07:36 +00002287 Number search for {pattern}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002288searchdecl({name} [, {global} [, {thisblock}]])
Bram Moolenaar446cb832008-06-24 21:56:24 +00002289 Number search for variable declaration
Bram Moolenaar81edd172016-04-14 13:51:37 +02002290searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002291 Number search for other end of start/end pair
Bram Moolenaar81edd172016-04-14 13:51:37 +02002292searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002293 List search for other end of start/end pair
Bram Moolenaar81edd172016-04-14 13:51:37 +02002294searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]])
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002295 List search for {pattern}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002296server2client({clientid}, {string})
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297 Number send reply string
2298serverlist() String get a list of available servers
Bram Moolenaar81edd172016-04-14 13:51:37 +02002299setbufvar({expr}, {varname}, {val})
2300 none set {varname} in buffer {expr} to {val}
2301setcharsearch({dict}) Dict set character search from {dict}
2302setcmdpos({pos}) Number set cursor position in command-line
2303setfperm({fname}, {mode}) Number set {fname} file permissions to {mode}
2304setline({lnum}, {line}) Number set line {lnum} to {line}
Bram Moolenaard823fa92016-08-12 16:29:27 +02002305setloclist({nr}, {list}[, {action}[, {what}]])
Bram Moolenaar17c7c012006-01-26 22:25:15 +00002306 Number modify location list using {list}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002307setmatches({list}) Number restore a list of matches
2308setpos({expr}, {list}) Number set the {expr} position to {list}
Bram Moolenaard823fa92016-08-12 16:29:27 +02002309setqflist({list}[, {action}[, {what}]])
2310 Number modify quickfix list using {list}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002311setreg({n}, {v}[, {opt}]) Number set register to value and type
2312settabvar({nr}, {varname}, {val}) none set {varname} in tab page {nr} to {val}
2313settabwinvar({tabnr}, {winnr}, {varname}, {val})
2314 none set {varname} in window {winnr} in tab
2315 page {tabnr} to {val}
2316setwinvar({nr}, {varname}, {val}) none set {varname} in window {nr} to {val}
2317sha256({string}) String SHA256 checksum of {string}
2318shellescape({string} [, {special}])
Bram Moolenaar05bb9532008-07-04 09:44:11 +00002319 String escape {string} for use as shell
Bram Moolenaar60a495f2006-10-03 12:44:42 +00002320 command argument
Bram Moolenaar2d17fa32012-10-21 00:45:18 +02002321shiftwidth() Number effective value of 'shiftwidth'
Bram Moolenaar81edd172016-04-14 13:51:37 +02002322simplify({filename}) String simplify filename as much as possible
2323sin({expr}) Float sine of {expr}
2324sinh({expr}) Float hyperbolic sine of {expr}
2325sort({list} [, {func} [, {dict}]])
Bram Moolenaar5f894962011-06-19 02:55:37 +02002326 List sort {list}, using {func} to compare
Bram Moolenaar81edd172016-04-14 13:51:37 +02002327soundfold({word}) String sound-fold {word}
Bram Moolenaard857f0e2005-06-21 22:37:39 +00002328spellbadword() String badly spelled word at cursor
Bram Moolenaar81edd172016-04-14 13:51:37 +02002329spellsuggest({word} [, {max} [, {capital}]])
Bram Moolenaarc54b8a72005-09-30 21:20:29 +00002330 List spelling suggestions
Bram Moolenaar81edd172016-04-14 13:51:37 +02002331split({expr} [, {pat} [, {keepempty}]])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002332 List make |List| from {pat} separated {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002333sqrt({expr}) Float square root of {expr}
2334str2float({expr}) Float convert String to Float
2335str2nr({expr} [, {base}]) Number convert String to Number
2336strchars({expr} [, {skipcc}]) Number character length of the String {expr}
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02002337strcharpart({str}, {start}[, {len}])
2338 String {len} characters of {str} at {start}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002339strdisplaywidth({expr} [, {col}]) Number display length of the String {expr}
2340strftime({format}[, {time}]) String time in specified format
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02002341strgetchar({str}, {index}) Number get char {index} from {str}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002342stridx({haystack}, {needle}[, {start}])
Bram Moolenaar8f999f12005-01-25 22:12:55 +00002343 Number index of {needle} in {haystack}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002344string({expr}) String String representation of {expr} value
2345strlen({expr}) Number length of the String {expr}
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02002346strpart({str}, {start}[, {len}])
2347 String {len} characters of {str} at {start}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002348strridx({haystack}, {needle} [, {start}])
Bram Moolenaar677ee682005-01-27 14:41:15 +00002349 Number last index of {needle} in {haystack}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002350strtrans({expr}) String translate string to make it printable
2351strwidth({expr}) Number display cell length of the String {expr}
2352submatch({nr}[, {list}]) String or List
Bram Moolenaar41571762014-04-02 19:00:58 +02002353 specific match in ":s" or substitute()
Bram Moolenaar81edd172016-04-14 13:51:37 +02002354substitute({expr}, {pat}, {sub}, {flags})
Bram Moolenaar071d4272004-06-13 20:20:40 +00002355 String all {pat} in {expr} replaced with {sub}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002356synID({lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col}
2357synIDattr({synID}, {what} [, {mode}])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358 String attribute {what} of syntax ID {synID}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002359synIDtrans({synID}) Number translated syntax ID of {synID}
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002360synconcealed({lnum}, {col}) List info about concealing
Bram Moolenaar81edd172016-04-14 13:51:37 +02002361synstack({lnum}, {col}) List stack of syntax IDs at {lnum} and {col}
2362system({expr} [, {input}]) String output of shell command/filter {expr}
2363systemlist({expr} [, {input}]) List output of shell command/filter {expr}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02002364tabpagebuflist([{arg}]) List list of buffer numbers in tab page
Bram Moolenaar81edd172016-04-14 13:51:37 +02002365tabpagenr([{arg}]) Number number of current or last tab page
2366tabpagewinnr({tabarg}[, {arg}]) Number number of current window in tab page
Bram Moolenaarc6aafba2017-03-21 17:09:10 +01002367taglist({expr}[, {filename}]) List list of tags matching {expr}
Bram Moolenaar446cb832008-06-24 21:56:24 +00002368tagfiles() List tags files used
Bram Moolenaar81edd172016-04-14 13:51:37 +02002369tan({expr}) Float tangent of {expr}
2370tanh({expr}) Float hyperbolic tangent of {expr}
Bram Moolenaar975b5272016-03-15 23:10:59 +01002371tempname() String name for a temporary file
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02002372term_getattr({attr}, {what} Number get the value of attribute {what}
Bram Moolenaar97870002017-07-30 18:28:38 +02002373term_getcursor({buf}) List get the cursor position of a terminal
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02002374term_getjob({buf}) Job get the job associated with a terminal
Bram Moolenaarc2ce52c2017-08-01 18:35:38 +02002375term_getline({buf}, {row}) String get a line of text from a terminal
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02002376term_getsize({buf}) List get the size of a terminal
Bram Moolenaarb000e322017-07-30 19:38:21 +02002377term_getstatus({buf}) String get the status of a terminal
2378term_gettitle({buf}) String get the title of a terminal
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02002379term_gettty({buf}) String get the tty name of a terminal
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02002380term_list() List get the list of terminal buffers
Bram Moolenaarc2ce52c2017-08-01 18:35:38 +02002381term_scrape({buf}, {row}) List get row of a terminal screen
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02002382term_sendkeys({buf}, {keys}) none send keystrokes to a terminal
2383term_start({cmd}, {options}) Job open a terminal window and run a job
2384term_wait({buf}) Number wait for screen to be updated
Bram Moolenaar8e8df252016-05-25 21:23:21 +02002385test_alloc_fail({id}, {countdown}, {repeat})
2386 none make memory allocation fail
Bram Moolenaar6f1d9a02016-07-24 14:12:38 +02002387test_autochdir() none enable 'autochdir' during startup
Bram Moolenaar574860b2016-05-24 17:33:34 +02002388test_garbagecollect_now() none free memory right now for testing
Bram Moolenaare0c31f62017-03-01 15:07:05 +01002389test_ignore_error({expr}) none ignore a specific error
Bram Moolenaar574860b2016-05-24 17:33:34 +02002390test_null_channel() Channel null value for testing
2391test_null_dict() Dict null value for testing
2392test_null_job() Job null value for testing
2393test_null_list() List null value for testing
2394test_null_partial() Funcref null value for testing
2395test_null_string() String null value for testing
Bram Moolenaareb992cb2017-03-09 18:20:16 +01002396test_override({expr}, {val}) none test with Vim internal overrides
Bram Moolenaarc95a3022016-06-12 23:01:46 +02002397test_settime({expr}) none set current time for testing
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02002398timer_info([{id}]) List information about timers
Bram Moolenaarb73598e2016-08-07 18:22:53 +02002399timer_pause({id}, {pause}) none pause or unpause a timer
Bram Moolenaar81edd172016-04-14 13:51:37 +02002400timer_start({time}, {callback} [, {options}])
Bram Moolenaar975b5272016-03-15 23:10:59 +01002401 Number create a timer
Bram Moolenaar81edd172016-04-14 13:51:37 +02002402timer_stop({timer}) none stop a timer
Bram Moolenaarb73598e2016-08-07 18:22:53 +02002403timer_stopall() none stop all timers
Bram Moolenaar81edd172016-04-14 13:51:37 +02002404tolower({expr}) String the String {expr} switched to lowercase
2405toupper({expr}) String the String {expr} switched to uppercase
2406tr({src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr}
Bram Moolenaar8299df92004-07-10 09:47:34 +00002407 to chars in {tostr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002408trunc({expr}) Float truncate Float {expr}
2409type({name}) Number type of variable {name}
2410undofile({name}) String undo file name for {name}
Bram Moolenaara800b422010-06-27 01:15:55 +02002411undotree() List undo file tree
Bram Moolenaar81edd172016-04-14 13:51:37 +02002412uniq({list} [, {func} [, {dict}]])
Bram Moolenaar327aa022014-03-25 18:24:23 +01002413 List remove adjacent duplicates from a list
Bram Moolenaar81edd172016-04-14 13:51:37 +02002414values({dict}) List values in {dict}
2415virtcol({expr}) Number screen column of cursor or mark
2416visualmode([expr]) String last visual mode used
Bram Moolenaar8738fc12013-02-20 17:59:11 +01002417wildmenumode() Number whether 'wildmenu' mode is active
Bram Moolenaar81edd172016-04-14 13:51:37 +02002418win_findbuf({bufnr}) List find windows containing {bufnr}
2419win_getid([{win} [, {tab}]]) Number get window ID for {win} in {tab}
2420win_gotoid({expr}) Number go to window with ID {expr}
2421win_id2tabwin({expr}) List get tab and window nr from window ID
2422win_id2win({expr}) Number get window nr from window ID
2423winbufnr({nr}) Number buffer number of window {nr}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002424wincol() Number window column of the cursor
Bram Moolenaar81edd172016-04-14 13:51:37 +02002425winheight({nr}) Number height of window {nr}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426winline() Number window line of the cursor
Bram Moolenaar81edd172016-04-14 13:51:37 +02002427winnr([{expr}]) Number number of current window
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002428winrestcmd() String returns command to restore window sizes
Bram Moolenaar81edd172016-04-14 13:51:37 +02002429winrestview({dict}) none restore view of current window
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00002430winsaveview() Dict save view of current window
Bram Moolenaar81edd172016-04-14 13:51:37 +02002431winwidth({nr}) Number width of window {nr}
Bram Moolenaared767a22016-01-03 22:49:16 +01002432wordcount() Dict get byte/char/word statistics
Bram Moolenaar81edd172016-04-14 13:51:37 +02002433writefile({list}, {fname} [, {flags}])
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002434 Number write list of lines to file {fname}
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002435xor({expr}, {expr}) Number bitwise XOR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002436
Bram Moolenaar03413f42016-04-12 21:07:15 +02002437
Bram Moolenaar446cb832008-06-24 21:56:24 +00002438abs({expr}) *abs()*
2439 Return the absolute value of {expr}. When {expr} evaluates to
2440 a |Float| abs() returns a |Float|. When {expr} can be
2441 converted to a |Number| abs() returns a |Number|. Otherwise
2442 abs() gives an error message and returns -1.
2443 Examples: >
2444 echo abs(1.456)
2445< 1.456 >
2446 echo abs(-5.456)
2447< 5.456 >
2448 echo abs(-4)
2449< 4
2450 {only available when compiled with the |+float| feature}
2451
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002452
2453acos({expr}) *acos()*
2454 Return the arc cosine of {expr} measured in radians, as a
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02002455 |Float| in the range of [0, pi].
2456 {expr} must evaluate to a |Float| or a |Number| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002457 [-1, 1].
2458 Examples: >
2459 :echo acos(0)
2460< 1.570796 >
2461 :echo acos(-0.5)
2462< 2.094395
Bram Moolenaardb84e452010-08-15 13:50:43 +02002463 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002464
2465
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002466add({list}, {expr}) *add()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002467 Append the item {expr} to |List| {list}. Returns the
2468 resulting |List|. Examples: >
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002469 :let alist = add([1, 2, 3], item)
2470 :call add(mylist, "woodstock")
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002471< Note that when {expr} is a |List| it is appended as a single
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002472 item. Use |extend()| to concatenate |Lists|.
Bram Moolenaar13065c42005-01-08 16:08:21 +00002473 Use |insert()| to add an item at another position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002475
Bram Moolenaard6e256c2011-12-14 15:32:50 +01002476and({expr}, {expr}) *and()*
2477 Bitwise AND on the two arguments. The arguments are converted
2478 to a number. A List, Dict or Float argument causes an error.
2479 Example: >
2480 :let flag = and(bits, 0x80)
2481
2482
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002483append({lnum}, {expr}) *append()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002484 When {expr} is a |List|: Append each item of the |List| as a
2485 text line below line {lnum} in the current buffer.
Bram Moolenaar748bf032005-02-02 23:04:36 +00002486 Otherwise append {expr} as one text line below line {lnum} in
2487 the current buffer.
2488 {lnum} can be zero to insert a line before the first one.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002489 Returns 1 for failure ({lnum} out of range or out of memory),
Bram Moolenaar58b85342016-08-14 19:54:54 +02002490 0 for success. Example: >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002491 :let failed = append(line('$'), "# THE END")
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002492 :let failed = append(0, ["Chapter 1", "the beginning"])
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002493<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002494 *argc()*
2495argc() The result is the number of files in the argument list of the
2496 current window. See |arglist|.
2497
2498 *argidx()*
2499argidx() The result is the current index in the argument list. 0 is
2500 the first file. argc() - 1 is the last one. See |arglist|.
2501
Bram Moolenaar2d1fe052014-05-28 18:22:57 +02002502 *arglistid()*
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002503arglistid([{winnr} [, {tabnr}]])
Bram Moolenaar2d1fe052014-05-28 18:22:57 +02002504 Return the argument list ID. This is a number which
2505 identifies the argument list being used. Zero is used for the
Bram Moolenaarfb539272014-08-22 19:21:47 +02002506 global argument list. See |arglist|.
2507 Return -1 if the arguments are invalid.
Bram Moolenaar2d1fe052014-05-28 18:22:57 +02002508
2509 Without arguments use the current window.
2510 With {winnr} only use this window in the current tab page.
2511 With {winnr} and {tabnr} use the window in the specified tab
2512 page.
Bram Moolenaar7571d552016-08-18 22:54:46 +02002513 {winnr} can be the window number or the |window-ID|.
Bram Moolenaar2d1fe052014-05-28 18:22:57 +02002514
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 *argv()*
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002516argv([{nr}]) The result is the {nr}th file in the argument list of the
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517 current window. See |arglist|. "argv(0)" is the first one.
2518 Example: >
2519 :let i = 0
2520 :while i < argc()
Bram Moolenaar446cb832008-06-24 21:56:24 +00002521 : let f = escape(fnameescape(argv(i)), '.')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>'
2523 : let i = i + 1
2524 :endwhile
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002525< Without the {nr} argument a |List| with the whole |arglist| is
2526 returned.
2527
Bram Moolenaar683fa182015-11-30 21:38:24 +01002528 *assert_equal()*
Bram Moolenaara803c7f2016-01-15 15:31:39 +01002529assert_equal({expected}, {actual} [, {msg}])
Bram Moolenaar43345542015-11-29 17:35:35 +01002530 When {expected} and {actual} are not equal an error message is
2531 added to |v:errors|.
2532 There is no automatic conversion, the String "4" is different
2533 from the Number 4. And the number 4 is different from the
2534 Float 4.0. The value of 'ignorecase' is not used here, case
2535 always matters.
Bram Moolenaar683fa182015-11-30 21:38:24 +01002536 When {msg} is omitted an error in the form "Expected
2537 {expected} but got {actual}" is produced.
Bram Moolenaar43345542015-11-29 17:35:35 +01002538 Example: >
Bram Moolenaar683fa182015-11-30 21:38:24 +01002539 assert_equal('foo', 'bar')
Bram Moolenaar43345542015-11-29 17:35:35 +01002540< Will result in a string to be added to |v:errors|:
2541 test.vim line 12: Expected 'foo' but got 'bar' ~
2542
Bram Moolenaara803c7f2016-01-15 15:31:39 +01002543assert_exception({error} [, {msg}]) *assert_exception()*
2544 When v:exception does not contain the string {error} an error
2545 message is added to |v:errors|.
2546 This can be used to assert that a command throws an exception.
2547 Using the error number, followed by a colon, avoids problems
2548 with translations: >
2549 try
2550 commandthatfails
2551 call assert_false(1, 'command should have failed')
2552 catch
2553 call assert_exception('E492:')
2554 endtry
2555
Bram Moolenaara260b872016-01-15 20:48:22 +01002556assert_fails({cmd} [, {error}]) *assert_fails()*
2557 Run {cmd} and add an error message to |v:errors| if it does
2558 NOT produce an error.
Bram Moolenaar25de4c22016-11-06 14:48:06 +01002559 When {error} is given it must match in |v:errmsg|.
Bram Moolenaara260b872016-01-15 20:48:22 +01002560
Bram Moolenaara803c7f2016-01-15 15:31:39 +01002561assert_false({actual} [, {msg}]) *assert_false()*
Bram Moolenaar43345542015-11-29 17:35:35 +01002562 When {actual} is not false an error message is added to
Bram Moolenaara803c7f2016-01-15 15:31:39 +01002563 |v:errors|, like with |assert_equal()|.
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002564 A value is false when it is zero. When {actual} is not a
Bram Moolenaar43345542015-11-29 17:35:35 +01002565 number the assert fails.
Bram Moolenaar61c04492016-07-23 15:35:35 +02002566 When {msg} is omitted an error in the form
2567 "Expected False but got {actual}" is produced.
2568
2569assert_inrange({lower}, {upper}, {actual} [, {msg}]) *assert_inrange()*
2570 This asserts number values. When {actual} is lower than
2571 {lower} or higher than {upper} an error message is added to
2572 |v:errors|.
2573 When {msg} is omitted an error in the form
2574 "Expected range {lower} - {upper}, but got {actual}" is
2575 produced.
Bram Moolenaar43345542015-11-29 17:35:35 +01002576
Bram Moolenaarea6553b2016-03-27 15:13:38 +02002577 *assert_match()*
2578assert_match({pattern}, {actual} [, {msg}])
2579 When {pattern} does not match {actual} an error message is
2580 added to |v:errors|.
2581
2582 {pattern} is used as with |=~|: The matching is always done
2583 like 'magic' was set and 'cpoptions' is empty, no matter what
2584 the actual value of 'magic' or 'cpoptions' is.
2585
2586 {actual} is used as a string, automatic conversion applies.
2587 Use "^" and "$" to match with the start and end of the text.
2588 Use both to match the whole text.
2589
Bram Moolenaar61c04492016-07-23 15:35:35 +02002590 When {msg} is omitted an error in the form
2591 "Pattern {pattern} does not match {actual}" is produced.
Bram Moolenaarea6553b2016-03-27 15:13:38 +02002592 Example: >
2593 assert_match('^f.*o$', 'foobar')
2594< Will result in a string to be added to |v:errors|:
2595 test.vim line 12: Pattern '^f.*o$' does not match 'foobar' ~
2596
Bram Moolenaarb50e5f52016-04-03 20:57:20 +02002597 *assert_notequal()*
2598assert_notequal({expected}, {actual} [, {msg}])
2599 The opposite of `assert_equal()`: add an error message to
2600 |v:errors| when {expected} and {actual} are equal.
2601
2602 *assert_notmatch()*
2603assert_notmatch({pattern}, {actual} [, {msg}])
2604 The opposite of `assert_match()`: add an error message to
2605 |v:errors| when {pattern} matches {actual}.
2606
Bram Moolenaar42205552017-03-18 19:42:22 +01002607assert_report({msg}) *assert_report()*
2608 Report a test failure directly, using {msg}.
2609
2610assert_true({actual} [, {msg}]) *assert_true()*
Bram Moolenaar43345542015-11-29 17:35:35 +01002611 When {actual} is not true an error message is added to
Bram Moolenaara803c7f2016-01-15 15:31:39 +01002612 |v:errors|, like with |assert_equal()|.
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002613 A value is TRUE when it is a non-zero number. When {actual}
Bram Moolenaar43345542015-11-29 17:35:35 +01002614 is not a number the assert fails.
Bram Moolenaar683fa182015-11-30 21:38:24 +01002615 When {msg} is omitted an error in the form "Expected True but
2616 got {actual}" is produced.
Bram Moolenaar43345542015-11-29 17:35:35 +01002617
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002618asin({expr}) *asin()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02002619 Return the arc sine of {expr} measured in radians, as a |Float|
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002620 in the range of [-pi/2, pi/2].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02002621 {expr} must evaluate to a |Float| or a |Number| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002622 [-1, 1].
2623 Examples: >
2624 :echo asin(0.8)
2625< 0.927295 >
2626 :echo asin(-0.5)
2627< -0.523599
Bram Moolenaardb84e452010-08-15 13:50:43 +02002628 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002629
2630
Bram Moolenaar446cb832008-06-24 21:56:24 +00002631atan({expr}) *atan()*
2632 Return the principal value of the arc tangent of {expr}, in
2633 the range [-pi/2, +pi/2] radians, as a |Float|.
2634 {expr} must evaluate to a |Float| or a |Number|.
2635 Examples: >
2636 :echo atan(100)
2637< 1.560797 >
2638 :echo atan(-4.01)
2639< -1.326405
2640 {only available when compiled with the |+float| feature}
2641
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002642
2643atan2({expr1}, {expr2}) *atan2()*
2644 Return the arc tangent of {expr1} / {expr2}, measured in
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02002645 radians, as a |Float| in the range [-pi, pi].
2646 {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002647 Examples: >
2648 :echo atan2(-1, 1)
2649< -0.785398 >
2650 :echo atan2(1, -1)
2651< 2.356194
Bram Moolenaardb84e452010-08-15 13:50:43 +02002652 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002653
Bram Moolenaar214641f2017-03-05 17:04:09 +01002654balloon_show({msg}) *balloon_show()*
2655 Show {msg} inside the balloon.
2656 Example: >
Bram Moolenaar59716a22017-03-01 20:32:44 +01002657 func GetBalloonContent()
2658 " initiate getting the content
2659 return ''
2660 endfunc
2661 set balloonexpr=GetBalloonContent()
2662
2663 func BalloonCallback(result)
Bram Moolenaar214641f2017-03-05 17:04:09 +01002664 call balloon_show(a:result)
Bram Moolenaar59716a22017-03-01 20:32:44 +01002665 endfunc
2666<
2667 The intended use is that fetching the content of the balloon
2668 is initiated from 'balloonexpr'. It will invoke an
2669 asynchronous method, in which a callback invokes
2670 balloon_show(). The 'balloonexpr' itself can return an
2671 empty string or a placeholder.
Bram Moolenaar214641f2017-03-05 17:04:09 +01002672
2673 When showing a balloon is not possible nothing happens, no
2674 error message.
2675 {only available when compiled with the +balloon_eval feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002676
Bram Moolenaar071d4272004-06-13 20:20:40 +00002677 *browse()*
2678browse({save}, {title}, {initdir}, {default})
2679 Put up a file requester. This only works when "has("browse")"
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002680 returns |TRUE| (only in some GUI versions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 The input fields are:
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002682 {save} when |TRUE|, select file to write
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 {title} title for the requester
2684 {initdir} directory to start browsing in
2685 {default} default file name
2686 When the "Cancel" button is hit, something went wrong, or
2687 browsing is not possible, an empty string is returned.
2688
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002689 *browsedir()*
2690browsedir({title}, {initdir})
2691 Put up a directory requester. This only works when
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002692 "has("browse")" returns |TRUE| (only in some GUI versions).
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002693 On systems where a directory browser is not supported a file
2694 browser is used. In that case: select a file in the directory
2695 to be used.
2696 The input fields are:
2697 {title} title for the requester
2698 {initdir} directory to start browsing in
2699 When the "Cancel" button is hit, something went wrong, or
2700 browsing is not possible, an empty string is returned.
2701
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702bufexists({expr}) *bufexists()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002703 The result is a Number, which is |TRUE| if a buffer called
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 {expr} exists.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002705 If the {expr} argument is a number, buffer numbers are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706 If the {expr} argument is a string it must match a buffer name
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002707 exactly. The name can be:
2708 - Relative to the current directory.
2709 - A full path.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002710 - The name of a buffer with 'buftype' set to "nofile".
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002711 - A URL name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 Unlisted buffers will be found.
2713 Note that help files are listed by their short name in the
2714 output of |:buffers|, but bufexists() requires using their
2715 long name to be able to find them.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002716 bufexists() may report a buffer exists, but to use the name
2717 with a |:buffer| command you may need to use |expand()|. Esp
2718 for MS-Windows 8.3 names in the form "c:\DOCUME~1"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002719 Use "bufexists(0)" to test for the existence of an alternate
2720 file name.
2721 *buffer_exists()*
2722 Obsolete name: buffer_exists().
2723
2724buflisted({expr}) *buflisted()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002725 The result is a Number, which is |TRUE| if a buffer called
Bram Moolenaar071d4272004-06-13 20:20:40 +00002726 {expr} exists and is listed (has the 'buflisted' option set).
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002727 The {expr} argument is used like with |bufexists()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728
2729bufloaded({expr}) *bufloaded()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002730 The result is a Number, which is |TRUE| if a buffer called
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731 {expr} exists and is loaded (shown in a window or hidden).
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002732 The {expr} argument is used like with |bufexists()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733
2734bufname({expr}) *bufname()*
2735 The result is the name of a buffer, as it is displayed by the
2736 ":ls" command.
2737 If {expr} is a Number, that buffer number's name is given.
2738 Number zero is the alternate buffer for the current window.
2739 If {expr} is a String, it is used as a |file-pattern| to match
Bram Moolenaar58b85342016-08-14 19:54:54 +02002740 with the buffer names. This is always done like 'magic' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741 set and 'cpoptions' is empty. When there is more than one
2742 match an empty string is returned.
2743 "" or "%" can be used for the current buffer, "#" for the
2744 alternate buffer.
2745 A full match is preferred, otherwise a match at the start, end
Bram Moolenaaref2f6562007-05-06 13:32:59 +00002746 or middle of the buffer name is accepted. If you only want a
2747 full match then put "^" at the start and "$" at the end of the
2748 pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 Listed buffers are found first. If there is a single match
2750 with a listed buffer, that one is returned. Next unlisted
2751 buffers are searched for.
2752 If the {expr} is a String, but you want to use it as a buffer
2753 number, force it to be a Number by adding zero to it: >
2754 :echo bufname("3" + 0)
2755< If the buffer doesn't exist, or doesn't have a name, an empty
2756 string is returned. >
2757 bufname("#") alternate buffer name
2758 bufname(3) name of buffer 3
2759 bufname("%") name of current buffer
2760 bufname("file2") name of buffer where "file2" matches.
2761< *buffer_name()*
2762 Obsolete name: buffer_name().
2763
2764 *bufnr()*
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002765bufnr({expr} [, {create}])
2766 The result is the number of a buffer, as it is displayed by
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767 the ":ls" command. For the use of {expr}, see |bufname()|
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002768 above.
2769 If the buffer doesn't exist, -1 is returned. Or, if the
2770 {create} argument is present and not zero, a new, unlisted,
2771 buffer is created and its number is returned.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 bufnr("$") is the last buffer: >
2773 :let last_buffer = bufnr("$")
2774< The result is a Number, which is the highest buffer number
2775 of existing buffers. Note that not all buffers with a smaller
2776 number necessarily exist, because ":bwipeout" may have removed
2777 them. Use bufexists() to test for the existence of a buffer.
2778 *buffer_number()*
2779 Obsolete name: buffer_number().
2780 *last_buffer_nr()*
2781 Obsolete name for bufnr("$"): last_buffer_nr().
2782
Bram Moolenaarb3619a92016-06-04 17:58:52 +02002783bufwinid({expr}) *bufwinid()*
Bram Moolenaar7571d552016-08-18 22:54:46 +02002784 The result is a Number, which is the |window-ID| of the first
Bram Moolenaarb3619a92016-06-04 17:58:52 +02002785 window associated with buffer {expr}. For the use of {expr},
Bram Moolenaar58b85342016-08-14 19:54:54 +02002786 see |bufname()| above. If buffer {expr} doesn't exist or
Bram Moolenaarb3619a92016-06-04 17:58:52 +02002787 there is no such window, -1 is returned. Example: >
2788
2789 echo "A window containing buffer 1 is " . (bufwinid(1))
2790<
2791 Only deals with the current tab page.
2792
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793bufwinnr({expr}) *bufwinnr()*
2794 The result is a Number, which is the number of the first
2795 window associated with buffer {expr}. For the use of {expr},
Bram Moolenaar58b85342016-08-14 19:54:54 +02002796 see |bufname()| above. If buffer {expr} doesn't exist or
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 there is no such window, -1 is returned. Example: >
2798
2799 echo "A window containing buffer 1 is " . (bufwinnr(1))
2800
2801< The number can be used with |CTRL-W_w| and ":wincmd w"
2802 |:wincmd|.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00002803 Only deals with the current tab page.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805byte2line({byte}) *byte2line()*
2806 Return the line number that contains the character at byte
2807 count {byte} in the current buffer. This includes the
2808 end-of-line character, depending on the 'fileformat' option
2809 for the current buffer. The first character has byte count
2810 one.
2811 Also see |line2byte()|, |go| and |:goto|.
2812 {not available when compiled without the |+byte_offset|
2813 feature}
2814
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00002815byteidx({expr}, {nr}) *byteidx()*
2816 Return byte index of the {nr}'th character in the string
2817 {expr}. Use zero for the first character, it returns zero.
2818 This function is only useful when there are multibyte
2819 characters, otherwise the returned value is equal to {nr}.
Bram Moolenaar0ffbbf92013-11-02 23:29:26 +01002820 Composing characters are not counted separately, their byte
2821 length is added to the preceding base character. See
2822 |byteidxcomp()| below for counting composing characters
2823 separately.
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00002824 Example : >
2825 echo matchstr(str, ".", byteidx(str, 3))
2826< will display the fourth character. Another way to do the
2827 same: >
2828 let s = strpart(str, byteidx(str, 3))
2829 echo strpart(s, 0, byteidx(s, 1))
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02002830< Also see |strgetchar()| and |strcharpart()|.
2831
2832 If there are less than {nr} characters -1 is returned.
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00002833 If there are exactly {nr} characters the length of the string
Bram Moolenaar0ffbbf92013-11-02 23:29:26 +01002834 in bytes is returned.
2835
2836byteidxcomp({expr}, {nr}) *byteidxcomp()*
2837 Like byteidx(), except that a composing character is counted
2838 as a separate character. Example: >
2839 let s = 'e' . nr2char(0x301)
2840 echo byteidx(s, 1)
2841 echo byteidxcomp(s, 1)
2842 echo byteidxcomp(s, 2)
2843< The first and third echo result in 3 ('e' plus composing
2844 character is 3 bytes), the second echo results in 1 ('e' is
2845 one byte).
2846 Only works different from byteidx() when 'encoding' is set to
2847 a Unicode encoding.
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00002848
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002849call({func}, {arglist} [, {dict}]) *call()* *E699*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002850 Call function {func} with the items in |List| {arglist} as
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002851 arguments.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002852 {func} can either be a |Funcref| or the name of a function.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002853 a:firstline and a:lastline are set to the cursor line.
2854 Returns the return value of the called function.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002855 {dict} is for functions with the "dict" attribute. It will be
2856 used to set the local variable "self". |Dictionary-function|
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002857
Bram Moolenaar446cb832008-06-24 21:56:24 +00002858ceil({expr}) *ceil()*
2859 Return the smallest integral value greater than or equal to
2860 {expr} as a |Float| (round up).
2861 {expr} must evaluate to a |Float| or a |Number|.
2862 Examples: >
2863 echo ceil(1.456)
2864< 2.0 >
2865 echo ceil(-5.456)
2866< -5.0 >
2867 echo ceil(4.0)
2868< 4.0
2869 {only available when compiled with the |+float| feature}
2870
Bram Moolenaar4b785f62016-11-29 21:54:44 +01002871ch_canread({handle}) *ch_canread()*
2872 Return non-zero when there is something to read from {handle}.
2873 {handle} can be a Channel or a Job that has a Channel.
2874
2875 This is useful to read from a channel at a convenient time,
2876 e.g. from a timer.
2877
2878 Note that messages are dropped when the channel does not have
2879 a callback. Add a close callback to avoid that.
2880
2881 {only available when compiled with the |+channel| feature}
2882
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01002883ch_close({handle}) *ch_close()*
2884 Close {handle}. See |channel-close|.
Bram Moolenaar4b785f62016-11-29 21:54:44 +01002885 {handle} can be a Channel or a Job that has a Channel.
Bram Moolenaar0874a832016-09-01 15:11:51 +02002886 A close callback is not invoked.
2887
2888 {only available when compiled with the |+channel| feature}
2889
2890ch_close_in({handle}) *ch_close_in()*
2891 Close the "in" part of {handle}. See |channel-close-in|.
Bram Moolenaar4b785f62016-11-29 21:54:44 +01002892 {handle} can be a Channel or a Job that has a Channel.
Bram Moolenaar0874a832016-09-01 15:11:51 +02002893 A close callback is not invoked.
Bram Moolenaar328da0d2016-03-04 22:22:32 +01002894
Bram Moolenaar835dc632016-02-07 14:27:38 +01002895 {only available when compiled with the |+channel| feature}
Bram Moolenaarf57969a2016-02-02 20:47:49 +01002896
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01002897ch_evalexpr({handle}, {expr} [, {options}]) *ch_evalexpr()*
2898 Send {expr} over {handle}. The {expr} is encoded
Bram Moolenaar8b1862a2016-02-27 19:21:24 +01002899 according to the type of channel. The function cannot be used
Bram Moolenaardae8d212016-02-27 22:40:16 +01002900 with a raw channel. See |channel-use|.
Bram Moolenaar4b785f62016-11-29 21:54:44 +01002901 {handle} can be a Channel or a Job that has a Channel.
Bram Moolenaar8b1862a2016-02-27 19:21:24 +01002902 *E917*
2903 {options} must be a Dictionary. It must not have a "callback"
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002904 entry. It can have a "timeout" entry to specify the timeout
2905 for this specific request.
Bram Moolenaar8b1862a2016-02-27 19:21:24 +01002906
2907 ch_evalexpr() waits for a response and returns the decoded
2908 expression. When there is an error or timeout it returns an
2909 empty string.
2910
2911 {only available when compiled with the |+channel| feature}
2912
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01002913ch_evalraw({handle}, {string} [, {options}]) *ch_evalraw()*
2914 Send {string} over {handle}.
Bram Moolenaar4b785f62016-11-29 21:54:44 +01002915 {handle} can be a Channel or a Job that has a Channel.
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01002916
Bram Moolenaar8b1862a2016-02-27 19:21:24 +01002917 Works like |ch_evalexpr()|, but does not encode the request or
2918 decode the response. The caller is responsible for the
2919 correct contents. Also does not add a newline for a channel
2920 in NL mode, the caller must do that. The NL in the response
2921 is removed.
2922 See |channel-use|.
2923
2924 {only available when compiled with the |+channel| feature}
2925
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01002926ch_getbufnr({handle}, {what}) *ch_getbufnr()*
2927 Get the buffer number that {handle} is using for {what}.
Bram Moolenaar4b785f62016-11-29 21:54:44 +01002928 {handle} can be a Channel or a Job that has a Channel.
Bram Moolenaarc7f0ebc2016-02-27 21:10:09 +01002929 {what} can be "err" for stderr, "out" for stdout or empty for
2930 socket output.
2931 Returns -1 when there is no buffer.
2932 {only available when compiled with the |+channel| feature}
2933
Bram Moolenaar02e83b42016-02-21 20:10:26 +01002934ch_getjob({channel}) *ch_getjob()*
2935 Get the Job associated with {channel}.
2936 If there is no job calling |job_status()| on the returned Job
2937 will result in "fail".
2938
2939 {only available when compiled with the |+channel| and
2940 |+job| features}
2941
Bram Moolenaar03602ec2016-03-20 20:57:45 +01002942ch_info({handle}) *ch_info()*
2943 Returns a Dictionary with information about {handle}. The
2944 items are:
2945 "id" number of the channel
Bram Moolenaar7ef38102016-09-26 22:36:58 +02002946 "status" "open", "buffered" or "closed", like
2947 ch_status()
Bram Moolenaar03602ec2016-03-20 20:57:45 +01002948 When opened with ch_open():
2949 "hostname" the hostname of the address
2950 "port" the port of the address
2951 "sock_status" "open" or "closed"
2952 "sock_mode" "NL", "RAW", "JSON" or "JS"
2953 "sock_io" "socket"
2954 "sock_timeout" timeout in msec
2955 When opened with job_start():
Bram Moolenaar7ef38102016-09-26 22:36:58 +02002956 "out_status" "open", "buffered" or "closed"
Bram Moolenaar03602ec2016-03-20 20:57:45 +01002957 "out_mode" "NL", "RAW", "JSON" or "JS"
2958 "out_io" "null", "pipe", "file" or "buffer"
2959 "out_timeout" timeout in msec
Bram Moolenaar7ef38102016-09-26 22:36:58 +02002960 "err_status" "open", "buffered" or "closed"
Bram Moolenaar03602ec2016-03-20 20:57:45 +01002961 "err_mode" "NL", "RAW", "JSON" or "JS"
2962 "err_io" "out", "null", "pipe", "file" or "buffer"
2963 "err_timeout" timeout in msec
2964 "in_status" "open" or "closed"
2965 "in_mode" "NL", "RAW", "JSON" or "JS"
2966 "in_io" "null", "pipe", "file" or "buffer"
2967 "in_timeout" timeout in msec
2968
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01002969ch_log({msg} [, {handle}]) *ch_log()*
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002970 Write {msg} in the channel log file, if it was opened with
2971 |ch_logfile()|.
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01002972 When {handle} is passed the channel number is used for the
2973 message.
Bram Moolenaar51628222016-12-01 23:03:28 +01002974 {handle} can be a Channel or a Job that has a Channel. The
Bram Moolenaar2ec618c2016-10-01 14:47:05 +02002975 Channel must be open for the channel number to be used.
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002976
2977ch_logfile({fname} [, {mode}]) *ch_logfile()*
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002978 Start logging channel activity to {fname}.
Bram Moolenaar38a55632016-02-15 22:07:32 +01002979 When {fname} is an empty string: stop logging.
2980
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002981 When {mode} is omitted or "a" append to the file.
2982 When {mode} is "w" start with an empty file.
Bram Moolenaar38a55632016-02-15 22:07:32 +01002983
2984 The file is flushed after every message, on Unix you can use
2985 "tail -f" to see what is going on in real time.
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002986
Bram Moolenaar328da0d2016-03-04 22:22:32 +01002987
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002988ch_open({address} [, {options}]) *ch_open()*
Bram Moolenaar3b5f9292016-01-28 22:37:01 +01002989 Open a channel to {address}. See |channel|.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002990 Returns a Channel. Use |ch_status()| to check for failure.
Bram Moolenaar3b5f9292016-01-28 22:37:01 +01002991
2992 {address} has the form "hostname:port", e.g.,
2993 "localhost:8765".
2994
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002995 If {options} is given it must be a |Dictionary|.
2996 See |channel-open-options|.
2997
Bram Moolenaar835dc632016-02-07 14:27:38 +01002998 {only available when compiled with the |+channel| feature}
Bram Moolenaar3b5f9292016-01-28 22:37:01 +01002999
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01003000ch_read({handle} [, {options}]) *ch_read()*
3001 Read from {handle} and return the received message.
Bram Moolenaar4b785f62016-11-29 21:54:44 +01003002 {handle} can be a Channel or a Job that has a Channel.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003003 See |channel-more|.
3004 {only available when compiled with the |+channel| feature}
Bram Moolenaar02e83b42016-02-21 20:10:26 +01003005
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01003006ch_readraw({handle} [, {options}]) *ch_readraw()*
Bram Moolenaar02e83b42016-02-21 20:10:26 +01003007 Like ch_read() but for a JS and JSON channel does not decode
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003008 the message. See |channel-more|.
3009 {only available when compiled with the |+channel| feature}
Bram Moolenaar02e83b42016-02-21 20:10:26 +01003010
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01003011ch_sendexpr({handle}, {expr} [, {options}]) *ch_sendexpr()*
3012 Send {expr} over {handle}. The {expr} is encoded
Bram Moolenaarcbebd482016-02-07 23:02:56 +01003013 according to the type of channel. The function cannot be used
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003014 with a raw channel.
3015 See |channel-use|. *E912*
Bram Moolenaar4b785f62016-11-29 21:54:44 +01003016 {handle} can be a Channel or a Job that has a Channel.
Bram Moolenaarf57969a2016-02-02 20:47:49 +01003017
Bram Moolenaar835dc632016-02-07 14:27:38 +01003018 {only available when compiled with the |+channel| feature}
3019
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01003020ch_sendraw({handle}, {string} [, {options}]) *ch_sendraw()*
3021 Send {string} over {handle}.
Bram Moolenaarcbebd482016-02-07 23:02:56 +01003022 Works like |ch_sendexpr()|, but does not encode the request or
3023 decode the response. The caller is responsible for the
Bram Moolenaar910b8aa2016-02-16 21:03:07 +01003024 correct contents. Also does not add a newline for a channel
3025 in NL mode, the caller must do that. The NL in the response
3026 is removed.
3027 See |channel-use|.
Bram Moolenaarf57969a2016-02-02 20:47:49 +01003028
Bram Moolenaar835dc632016-02-07 14:27:38 +01003029 {only available when compiled with the |+channel| feature}
3030
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01003031ch_setoptions({handle}, {options}) *ch_setoptions()*
3032 Set options on {handle}:
Bram Moolenaare0fa3742016-02-20 15:47:01 +01003033 "callback" the channel callback
3034 "timeout" default read timeout in msec
Bram Moolenaar02e83b42016-02-21 20:10:26 +01003035 "mode" mode for the whole channel
Bram Moolenaare0fa3742016-02-20 15:47:01 +01003036 See |ch_open()| for more explanation.
Bram Moolenaar4b785f62016-11-29 21:54:44 +01003037 {handle} can be a Channel or a Job that has a Channel.
Bram Moolenaare0fa3742016-02-20 15:47:01 +01003038
Bram Moolenaar02e83b42016-02-21 20:10:26 +01003039 Note that changing the mode may cause queued messages to be
3040 lost.
3041
Bram Moolenaare0fa3742016-02-20 15:47:01 +01003042 These options cannot be changed:
Bram Moolenaar7571d552016-08-18 22:54:46 +02003043 "waittime" only applies to |ch_open()|
Bram Moolenaare0fa3742016-02-20 15:47:01 +01003044
Bram Moolenaar7ef38102016-09-26 22:36:58 +02003045ch_status({handle} [, {options}]) *ch_status()*
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01003046 Return the status of {handle}:
Bram Moolenaar38a55632016-02-15 22:07:32 +01003047 "fail" failed to open the channel
3048 "open" channel can be used
Bram Moolenaar06481422016-04-30 15:13:38 +02003049 "buffered" channel can be read, not written to
Bram Moolenaar38a55632016-02-15 22:07:32 +01003050 "closed" channel can not be used
Bram Moolenaar4b785f62016-11-29 21:54:44 +01003051 {handle} can be a Channel or a Job that has a Channel.
Bram Moolenaar06481422016-04-30 15:13:38 +02003052 "buffered" is used when the channel was closed but there is
3053 still data that can be obtained with |ch_read()|.
Bram Moolenaar38a55632016-02-15 22:07:32 +01003054
Bram Moolenaar7ef38102016-09-26 22:36:58 +02003055 If {options} is given it can contain a "part" entry to specify
3056 the part of the channel to return the status for: "out" or
3057 "err". For example, to get the error status: >
3058 ch_status(job, {"part": "err"})
3059<
Bram Moolenaar214641f2017-03-05 17:04:09 +01003060changenr() *changenr()*
3061 Return the number of the most recent change. This is the same
3062 number as what is displayed with |:undolist| and can be used
3063 with the |:undo| command.
3064 When a change was made it is the number of that change. After
3065 redo it is the number of the redone change. After undo it is
3066 one less than the number of the undone change.
3067
3068char2nr({expr}[, {utf8}]) *char2nr()*
3069 Return number value of the first char in {expr}. Examples: >
3070 char2nr(" ") returns 32
3071 char2nr("ABC") returns 65
3072< When {utf8} is omitted or zero, the current 'encoding' is used.
3073 Example for "utf-8": >
3074 char2nr("á") returns 225
3075 char2nr("á"[0]) returns 195
3076< With {utf8} set to 1, always treat as utf-8 characters.
3077 A combining character is a separate character.
3078 |nr2char()| does the opposite.
3079
3080cindent({lnum}) *cindent()*
3081 Get the amount of indent for line {lnum} according the C
3082 indenting rules, as with 'cindent'.
3083 The indent is counted in spaces, the value of 'tabstop' is
3084 relevant. {lnum} is used just like in |getline()|.
3085 When {lnum} is invalid or Vim was not compiled the |+cindent|
3086 feature, -1 is returned.
3087 See |C-indenting|.
3088
3089clearmatches() *clearmatches()*
3090 Clears all matches previously defined by |matchadd()| and the
3091 |:match| commands.
3092
3093 *col()*
3094col({expr}) The result is a Number, which is the byte index of the column
3095 position given with {expr}. The accepted positions are:
3096 . the cursor position
3097 $ the end of the cursor line (the result is the
3098 number of bytes in the cursor line plus one)
3099 'x position of mark x (if the mark is not set, 0 is
3100 returned)
3101 v In Visual mode: the start of the Visual area (the
3102 cursor is the end). When not in Visual mode
3103 returns the cursor position. Differs from |'<| in
3104 that it's updated right away.
3105 Additionally {expr} can be [lnum, col]: a |List| with the line
3106 and column number. Most useful when the column is "$", to get
3107 the last column of a specific line. When "lnum" or "col" is
3108 out of range then col() returns zero.
3109 To get the line number use |line()|. To get both use
3110 |getpos()|.
3111 For the screen column position use |virtcol()|.
3112 Note that only marks in the current file can be used.
3113 Examples: >
3114 col(".") column of cursor
3115 col("$") length of cursor line plus one
3116 col("'t") column of mark t
3117 col("'" . markname) column of mark markname
3118< The first column is 1. 0 is returned for an error.
3119 For an uppercase mark the column may actually be in another
3120 buffer.
3121 For the cursor position, when 'virtualedit' is active, the
3122 column is one higher if the cursor is after the end of the
3123 line. This can be used to obtain the column in Insert mode: >
3124 :imap <F2> <C-O>:let save_ve = &ve<CR>
3125 \<C-O>:set ve=all<CR>
3126 \<C-O>:echo col(".") . "\n" <Bar>
3127 \let &ve = save_ve<CR>
3128<
3129
3130complete({startcol}, {matches}) *complete()* *E785*
3131 Set the matches for Insert mode completion.
3132 Can only be used in Insert mode. You need to use a mapping
3133 with CTRL-R = (see |i_CTRL-R|). It does not work after CTRL-O
3134 or with an expression mapping.
3135 {startcol} is the byte offset in the line where the completed
3136 text start. The text up to the cursor is the original text
3137 that will be replaced by the matches. Use col('.') for an
3138 empty string. "col('.') - 1" will replace one character by a
3139 match.
3140 {matches} must be a |List|. Each |List| item is one match.
3141 See |complete-items| for the kind of items that are possible.
3142 Note that the after calling this function you need to avoid
3143 inserting anything that would cause completion to stop.
3144 The match can be selected with CTRL-N and CTRL-P as usual with
3145 Insert mode completion. The popup menu will appear if
3146 specified, see |ins-completion-menu|.
3147 Example: >
3148 inoremap <F5> <C-R>=ListMonths()<CR>
3149
3150 func! ListMonths()
3151 call complete(col('.'), ['January', 'February', 'March',
3152 \ 'April', 'May', 'June', 'July', 'August', 'September',
3153 \ 'October', 'November', 'December'])
3154 return ''
3155 endfunc
3156< This isn't very useful, but it shows how it works. Note that
3157 an empty string is returned to avoid a zero being inserted.
3158
3159complete_add({expr}) *complete_add()*
3160 Add {expr} to the list of matches. Only to be used by the
3161 function specified with the 'completefunc' option.
3162 Returns 0 for failure (empty string or out of memory),
3163 1 when the match was added, 2 when the match was already in
3164 the list.
3165 See |complete-functions| for an explanation of {expr}. It is
3166 the same as one item in the list that 'omnifunc' would return.
3167
3168complete_check() *complete_check()*
3169 Check for a key typed while looking for completion matches.
3170 This is to be used when looking for matches takes some time.
3171 Returns |TRUE| when searching for matches is to be aborted,
3172 zero otherwise.
3173 Only to be used by the function specified with the
3174 'completefunc' option.
3175
3176 *confirm()*
3177confirm({msg} [, {choices} [, {default} [, {type}]]])
3178 Confirm() offers the user a dialog, from which a choice can be
3179 made. It returns the number of the choice. For the first
3180 choice this is 1.
3181 Note: confirm() is only supported when compiled with dialog
3182 support, see |+dialog_con| and |+dialog_gui|.
3183
3184 {msg} is displayed in a |dialog| with {choices} as the
3185 alternatives. When {choices} is missing or empty, "&OK" is
3186 used (and translated).
3187 {msg} is a String, use '\n' to include a newline. Only on
3188 some systems the string is wrapped when it doesn't fit.
3189
3190 {choices} is a String, with the individual choices separated
3191 by '\n', e.g. >
3192 confirm("Save changes?", "&Yes\n&No\n&Cancel")
3193< The letter after the '&' is the shortcut key for that choice.
3194 Thus you can type 'c' to select "Cancel". The shortcut does
3195 not need to be the first letter: >
3196 confirm("file has been modified", "&Save\nSave &All")
3197< For the console, the first letter of each choice is used as
3198 the default shortcut key.
3199
3200 The optional {default} argument is the number of the choice
3201 that is made if the user hits <CR>. Use 1 to make the first
3202 choice the default one. Use 0 to not set a default. If
3203 {default} is omitted, 1 is used.
3204
3205 The optional {type} argument gives the type of dialog. This
3206 is only used for the icon of the GTK, Mac, Motif and Win32
3207 GUI. It can be one of these values: "Error", "Question",
3208 "Info", "Warning" or "Generic". Only the first character is
3209 relevant. When {type} is omitted, "Generic" is used.
3210
3211 If the user aborts the dialog by pressing <Esc>, CTRL-C,
3212 or another valid interrupt key, confirm() returns 0.
3213
3214 An example: >
3215 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2)
3216 :if choice == 0
3217 : echo "make up your mind!"
3218 :elseif choice == 3
3219 : echo "tasteful"
3220 :else
3221 : echo "I prefer bananas myself."
3222 :endif
3223< In a GUI dialog, buttons are used. The layout of the buttons
3224 depends on the 'v' flag in 'guioptions'. If it is included,
3225 the buttons are always put vertically. Otherwise, confirm()
3226 tries to put the buttons in one horizontal line. If they
3227 don't fit, a vertical layout is used anyway. For some systems
3228 the horizontal layout is always used.
3229
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00003230 *copy()*
Bram Moolenaar58b85342016-08-14 19:54:54 +02003231copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00003232 different from using {expr} directly.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003233 When {expr} is a |List| a shallow copy is created. This means
3234 that the original |List| can be changed without changing the
Bram Moolenaar446cb832008-06-24 21:56:24 +00003235 copy, and vice versa. But the items are identical, thus
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01003236 changing an item changes the contents of both |Lists|.
3237 A |Dictionary| is copied in a similar way as a |List|.
3238 Also see |deepcopy()|.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00003239
Bram Moolenaar446cb832008-06-24 21:56:24 +00003240cos({expr}) *cos()*
3241 Return the cosine of {expr}, measured in radians, as a |Float|.
3242 {expr} must evaluate to a |Float| or a |Number|.
3243 Examples: >
3244 :echo cos(100)
3245< 0.862319 >
3246 :echo cos(-4.01)
3247< -0.646043
3248 {only available when compiled with the |+float| feature}
3249
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003250
3251cosh({expr}) *cosh()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003252 Return the hyperbolic cosine of {expr} as a |Float| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003253 [1, inf].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003254 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003255 Examples: >
3256 :echo cosh(0.5)
3257< 1.127626 >
3258 :echo cosh(-0.5)
3259< -1.127626
Bram Moolenaardb84e452010-08-15 13:50:43 +02003260 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003261
Bram Moolenaar446cb832008-06-24 21:56:24 +00003262
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003263count({comp}, {expr} [, {ic} [, {start}]]) *count()*
Bram Moolenaarde8866b2005-01-06 23:24:37 +00003264 Return the number of times an item with value {expr} appears
Bram Moolenaar9966b212017-07-28 16:46:57 +02003265 in |String|, |List| or |Dictionary| {comp}.
3266
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003267 If {start} is given then start with the item with this index.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003268 {start} can only be used with a |List|.
Bram Moolenaar9966b212017-07-28 16:46:57 +02003269
Bram Moolenaare381d3d2016-07-07 14:50:41 +02003270 When {ic} is given and it's |TRUE| then case is ignored.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00003271
Bram Moolenaar9966b212017-07-28 16:46:57 +02003272 When {comp} is a string then the number of not overlapping
3273 occurences of {expr} is returned.
3274
Bram Moolenaarde8866b2005-01-06 23:24:37 +00003275
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 *cscope_connection()*
3277cscope_connection([{num} , {dbpath} [, {prepend}]])
3278 Checks for the existence of a |cscope| connection. If no
3279 parameters are specified, then the function returns:
3280 0, if cscope was not available (not compiled in), or
3281 if there are no cscope connections;
3282 1, if there is at least one cscope connection.
3283
3284 If parameters are specified, then the value of {num}
3285 determines how existence of a cscope connection is checked:
3286
3287 {num} Description of existence check
3288 ----- ------------------------------
3289 0 Same as no parameters (e.g., "cscope_connection()").
3290 1 Ignore {prepend}, and use partial string matches for
3291 {dbpath}.
3292 2 Ignore {prepend}, and use exact string matches for
3293 {dbpath}.
3294 3 Use {prepend}, use partial string matches for both
3295 {dbpath} and {prepend}.
3296 4 Use {prepend}, use exact string matches for both
3297 {dbpath} and {prepend}.
3298
3299 Note: All string comparisons are case sensitive!
3300
3301 Examples. Suppose we had the following (from ":cs show"): >
3302
3303 # pid database name prepend path
3304 0 27664 cscope.out /usr/local
3305<
3306 Invocation Return Val ~
3307 ---------- ---------- >
3308 cscope_connection() 1
3309 cscope_connection(1, "out") 1
3310 cscope_connection(2, "out") 0
3311 cscope_connection(3, "out") 0
3312 cscope_connection(3, "out", "local") 1
3313 cscope_connection(4, "out") 0
3314 cscope_connection(4, "out", "local") 0
3315 cscope_connection(4, "cscope.out", "/usr/local") 1
3316<
Bram Moolenaar0b238792006-03-02 22:49:12 +00003317cursor({lnum}, {col} [, {off}]) *cursor()*
3318cursor({list})
Bram Moolenaaref2f6562007-05-06 13:32:59 +00003319 Positions the cursor at the column (byte count) {col} in the
3320 line {lnum}. The first column is one.
Bram Moolenaar493c1782014-05-28 14:34:46 +02003321
Bram Moolenaar0b238792006-03-02 22:49:12 +00003322 When there is one argument {list} this is used as a |List|
Bram Moolenaar493c1782014-05-28 14:34:46 +02003323 with two, three or four item:
Bram Moolenaar03413f42016-04-12 21:07:15 +02003324 [{lnum}, {col}]
Bram Moolenaar493c1782014-05-28 14:34:46 +02003325 [{lnum}, {col}, {off}]
3326 [{lnum}, {col}, {off}, {curswant}]
Bram Moolenaar946e27a2014-06-25 18:50:27 +02003327 This is like the return value of |getpos()| or |getcurpos()|,
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02003328 but without the first item.
Bram Moolenaar493c1782014-05-28 14:34:46 +02003329
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 Does not change the jumplist.
3331 If {lnum} is greater than the number of lines in the buffer,
3332 the cursor will be positioned at the last line in the buffer.
3333 If {lnum} is zero, the cursor will stay in the current line.
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00003334 If {col} is greater than the number of bytes in the line,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 the cursor will be positioned at the last character in the
3336 line.
3337 If {col} is zero, the cursor will stay in the current column.
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02003338 If {curswant} is given it is used to set the preferred column
Bram Moolenaar34401cc2014-08-29 15:12:19 +02003339 for vertical movement. Otherwise {col} is used.
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01003340
Bram Moolenaar0b238792006-03-02 22:49:12 +00003341 When 'virtualedit' is used {off} specifies the offset in
3342 screen columns from the start of the character. E.g., a
Bram Moolenaard46bbc72007-05-12 14:38:41 +00003343 position within a <Tab> or after the last character.
Bram Moolenaar798b30b2009-04-22 10:56:16 +00003344 Returns 0 when the position could be set, -1 otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00003346
Bram Moolenaar4399ef42005-02-12 14:29:27 +00003347deepcopy({expr}[, {noref}]) *deepcopy()* *E698*
Bram Moolenaar58b85342016-08-14 19:54:54 +02003348 Make a copy of {expr}. For Numbers and Strings this isn't
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00003349 different from using {expr} directly.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003350 When {expr} is a |List| a full copy is created. This means
3351 that the original |List| can be changed without changing the
Bram Moolenaar6463ca22016-02-13 17:04:46 +01003352 copy, and vice versa. When an item is a |List| or
3353 |Dictionary|, a copy for it is made, recursively. Thus
3354 changing an item in the copy does not change the contents of
3355 the original |List|.
3356 A |Dictionary| is copied in a similar way as a |List|.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003357 When {noref} is omitted or zero a contained |List| or
3358 |Dictionary| is only copied once. All references point to
3359 this single copy. With {noref} set to 1 every occurrence of a
3360 |List| or |Dictionary| results in a new copy. This also means
3361 that a cyclic reference causes deepcopy() to fail.
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00003362 *E724*
3363 Nesting is possible up to 100 levels. When there is an item
Bram Moolenaar4399ef42005-02-12 14:29:27 +00003364 that refers back to a higher level making a deep copy with
3365 {noref} set to 1 will fail.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00003366 Also see |copy()|.
3367
Bram Moolenaarda440d22016-01-16 21:27:23 +01003368delete({fname} [, {flags}]) *delete()*
3369 Without {flags} or with {flags} empty: Deletes the file by the
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003370 name {fname}. This also works when {fname} is a symbolic link.
Bram Moolenaarda440d22016-01-16 21:27:23 +01003371
3372 When {flags} is "d": Deletes the directory by the name
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003373 {fname}. This fails when directory {fname} is not empty.
Bram Moolenaarda440d22016-01-16 21:27:23 +01003374
3375 When {flags} is "rf": Deletes the directory by the name
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003376 {fname} and everything in it, recursively. BE CAREFUL!
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003377 Note: on MS-Windows it is not possible to delete a directory
3378 that is being used.
Bram Moolenaar818078d2016-08-27 21:58:42 +02003379
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003380 A symbolic link itself is deleted, not what it points to.
Bram Moolenaarda440d22016-01-16 21:27:23 +01003381
3382 The result is a Number, which is 0 if the delete operation was
3383 successful and -1 when the deletion failed or partly failed.
3384
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003385 Use |remove()| to delete an item from a |List|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +01003386 To delete a line from the buffer use |:delete|. Use |:exe|
3387 when the line number is in a variable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388
3389 *did_filetype()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02003390did_filetype() Returns |TRUE| when autocommands are being executed and the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 FileType event has been triggered at least once. Can be used
3392 to avoid triggering the FileType event again in the scripts
3393 that detect the file type. |FileType|
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02003394 Returns |FALSE| when `:setf FALLBACK` was used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 When editing another file, the counter is reset, thus this
3396 really checks if the FileType event has been triggered for the
3397 current buffer. This allows an autocommand that starts
3398 editing another buffer to set 'filetype' and load a syntax
3399 file.
3400
Bram Moolenaar47136d72004-10-12 20:02:24 +00003401diff_filler({lnum}) *diff_filler()*
3402 Returns the number of filler lines above line {lnum}.
3403 These are the lines that were inserted at this point in
3404 another diff'ed window. These filler lines are shown in the
3405 display but don't exist in the buffer.
3406 {lnum} is used like with |getline()|. Thus "." is the current
3407 line, "'m" mark m, etc.
3408 Returns 0 if the current window is not in diff mode.
3409
3410diff_hlID({lnum}, {col}) *diff_hlID()*
3411 Returns the highlight ID for diff mode at line {lnum} column
3412 {col} (byte index). When the current line does not have a
3413 diff change zero is returned.
3414 {lnum} is used like with |getline()|. Thus "." is the current
3415 line, "'m" mark m, etc.
3416 {col} is 1 for the leftmost column, {lnum} is 1 for the first
3417 line.
3418 The highlight ID can be used with |synIDattr()| to obtain
3419 syntax information about the highlighting.
3420
Bram Moolenaar13065c42005-01-08 16:08:21 +00003421empty({expr}) *empty()*
3422 Return the Number 1 if {expr} is empty, zero otherwise.
Bram Moolenaar835dc632016-02-07 14:27:38 +01003423 - A |List| or |Dictionary| is empty when it does not have any
3424 items.
3425 - A Number and Float is empty when its value is zero.
3426 - |v:false|, |v:none| and |v:null| are empty, |v:true| is not.
3427 - A Job is empty when it failed to start.
Bram Moolenaar38a55632016-02-15 22:07:32 +01003428 - A Channel is empty when it is closed.
Bram Moolenaar835dc632016-02-07 14:27:38 +01003429
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003430 For a long |List| this is much faster than comparing the
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003431 length with zero.
Bram Moolenaar13065c42005-01-08 16:08:21 +00003432
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433escape({string}, {chars}) *escape()*
3434 Escape the characters in {chars} that occur in {string} with a
3435 backslash. Example: >
3436 :echo escape('c:\program files\vim', ' \')
3437< results in: >
3438 c:\\program\ files\\vim
Bram Moolenaar446cb832008-06-24 21:56:24 +00003439< Also see |shellescape()|.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00003440
Bram Moolenaar446cb832008-06-24 21:56:24 +00003441 *eval()*
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00003442eval({string}) Evaluate {string} and return the result. Especially useful to
3443 turn the result of |string()| back into the original value.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003444 This works for Numbers, Floats, Strings and composites of
3445 them. Also works for |Funcref|s that refer to existing
3446 functions.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00003447
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448eventhandler() *eventhandler()*
3449 Returns 1 when inside an event handler. That is that Vim got
3450 interrupted while waiting for the user to type a character,
3451 e.g., when dropping a file on Vim. This means interactive
3452 commands cannot be used. Otherwise zero is returned.
3453
3454executable({expr}) *executable()*
3455 This function checks if an executable with the name {expr}
3456 exists. {expr} must be the name of the program without any
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003457 arguments.
3458 executable() uses the value of $PATH and/or the normal
3459 searchpath for programs. *PATHEXT*
3460 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can
3461 optionally be included. Then the extensions in $PATHEXT are
Bram Moolenaar58b85342016-08-14 19:54:54 +02003462 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be
3463 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003464 used. A dot by itself can be used in $PATHEXT to try using
Bram Moolenaar58b85342016-08-14 19:54:54 +02003465 the name without an extension. When 'shell' looks like a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003466 Unix shell, then the name is also tried without adding an
3467 extension.
3468 On MS-DOS and MS-Windows it only checks if the file exists and
3469 is not a directory, not if it's really executable.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003470 On MS-Windows an executable in the same directory as Vim is
3471 always found. Since this directory is added to $PATH it
3472 should also work to execute it |win32-PATH|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 The result is a Number:
3474 1 exists
3475 0 does not exist
3476 -1 not implemented on this system
3477
Bram Moolenaar79815f12016-07-09 17:07:29 +02003478execute({command} [, {silent}]) *execute()*
3479 Execute an Ex command or commands and return the output as a
3480 string.
3481 {command} can be a string or a List. In case of a List the
3482 lines are executed one by one.
3483 This is equivalent to: >
3484 redir => var
3485 {command}
3486 redir END
3487<
3488 The optional {silent} argument can have these values:
3489 "" no `:silent` used
3490 "silent" `:silent` used
3491 "silent!" `:silent!` used
Bram Moolenaar214641f2017-03-05 17:04:09 +01003492 The default is "silent". Note that with "silent!", unlike
Bram Moolenaar069c1e72016-07-15 21:25:08 +02003493 `:redir`, error messages are dropped. When using an external
3494 command the screen may be messed up, use `system()` instead.
Bram Moolenaar79815f12016-07-09 17:07:29 +02003495 *E930*
3496 It is not possible to use `:redir` anywhere in {command}.
3497
3498 To get a list of lines use |split()| on the result: >
Bram Moolenaar063b9d12016-07-09 20:21:48 +02003499 split(execute('args'), "\n")
Bram Moolenaar79815f12016-07-09 17:07:29 +02003500
3501< When used recursively the output of the recursive call is not
3502 included in the output of the higher level call.
3503
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003504exepath({expr}) *exepath()*
3505 If {expr} is an executable and is either an absolute path, a
3506 relative path or found in $PATH, return the full path.
3507 Note that the current directory is used when {expr} starts
3508 with "./", which may be a problem for Vim: >
3509 echo exepath(v:progpath)
Bram Moolenaar7e38ea22014-04-05 22:55:53 +02003510< If {expr} cannot be found in $PATH or is not executable then
Bram Moolenaarc7f02552014-04-01 21:00:59 +02003511 an empty string is returned.
3512
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 *exists()*
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02003514exists({expr}) The result is a Number, which is |TRUE| if {expr} is defined,
3515 zero otherwise.
3516
3517 For checking for a supported feature use |has()|.
3518 For checking if a file exists use |filereadable()|.
3519
3520 The {expr} argument is a string, which contains one of these:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 &option-name Vim option (only checks if it exists,
3522 not if it really works)
3523 +option-name Vim option that works.
3524 $ENVNAME environment variable (could also be
3525 done by comparing with an empty
3526 string)
3527 *funcname built-in function (see |functions|)
3528 or user defined function (see
Bram Moolenaarbcb98982014-05-01 14:08:19 +02003529 |user-functions|). Also works for a
3530 variable that is a Funcref.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531 varname internal variable (see
Bram Moolenaar58b85342016-08-14 19:54:54 +02003532 |internal-variables|). Also works
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003533 for |curly-braces-names|, |Dictionary|
3534 entries, |List| items, etc. Beware
Bram Moolenaarc236c162008-07-13 17:41:49 +00003535 that evaluating an index may cause an
3536 error message for an invalid
3537 expression. E.g.: >
3538 :let l = [1, 2, 3]
3539 :echo exists("l[5]")
3540< 0 >
3541 :echo exists("l[xx]")
3542< E121: Undefined variable: xx
3543 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 :cmdname Ex command: built-in command, user
3545 command or command modifier |:command|.
3546 Returns:
3547 1 for match with start of a command
3548 2 full match with a command
3549 3 matches several user commands
3550 To check for a supported command
3551 always check the return value to be 2.
Bram Moolenaar14716812006-05-04 21:54:08 +00003552 :2match The |:2match| command.
3553 :3match The |:3match| command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554 #event autocommand defined for this event
3555 #event#pattern autocommand defined for this event and
3556 pattern (the pattern is taken
3557 literally and compared to the
3558 autocommand patterns character by
3559 character)
Bram Moolenaara9b1e742005-12-19 22:14:58 +00003560 #group autocommand group exists
3561 #group#event autocommand defined for this group and
3562 event.
3563 #group#event#pattern
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003564 autocommand defined for this group,
Bram Moolenaara9b1e742005-12-19 22:14:58 +00003565 event and pattern.
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +00003566 ##event autocommand for this event is
3567 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568
3569 Examples: >
3570 exists("&shortname")
3571 exists("$HOSTNAME")
3572 exists("*strftime")
3573 exists("*s:MyFunc")
3574 exists("bufcount")
3575 exists(":Make")
Bram Moolenaara9b1e742005-12-19 22:14:58 +00003576 exists("#CursorHold")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 exists("#BufReadPre#*.gz")
Bram Moolenaara9b1e742005-12-19 22:14:58 +00003578 exists("#filetypeindent")
3579 exists("#filetypeindent#FileType")
3580 exists("#filetypeindent#FileType#*")
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +00003581 exists("##ColorScheme")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582< There must be no space between the symbol (&/$/*/#) and the
3583 name.
Bram Moolenaar91170f82006-05-05 21:15:17 +00003584 There must be no extra characters after the name, although in
3585 a few cases this is ignored. That may become more strict in
3586 the future, thus don't count on it!
3587 Working example: >
3588 exists(":make")
3589< NOT working example: >
3590 exists(":make install")
Bram Moolenaar9c102382006-05-03 21:26:49 +00003591
3592< Note that the argument must be a string, not the name of the
3593 variable itself. For example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 exists(bufcount)
3595< This doesn't check for existence of the "bufcount" variable,
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003596 but gets the value of "bufcount", and checks if that exists.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003598exp({expr}) *exp()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003599 Return the exponential of {expr} as a |Float| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003600 [0, inf].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003601 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003602 Examples: >
3603 :echo exp(2)
3604< 7.389056 >
3605 :echo exp(-1)
3606< 0.367879
Bram Moolenaardb84e452010-08-15 13:50:43 +02003607 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003608
3609
Bram Moolenaar84f72352012-03-11 15:57:40 +01003610expand({expr} [, {nosuf} [, {list}]]) *expand()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 Expand wildcards and the following special keywords in {expr}.
Bram Moolenaar84f72352012-03-11 15:57:40 +01003612 'wildignorecase' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613
Bram Moolenaare381d3d2016-07-07 14:50:41 +02003614 If {list} is given and it is |TRUE|, a List will be returned.
Bram Moolenaar84f72352012-03-11 15:57:40 +01003615 Otherwise the result is a String and when there are several
3616 matches, they are separated by <NL> characters. [Note: in
3617 version 5.0 a space was used, which caused problems when a
3618 file name contains a space]
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619
Bram Moolenaar58b85342016-08-14 19:54:54 +02003620 If the expansion fails, the result is an empty string. A name
Bram Moolenaarec7944a2013-06-12 21:29:15 +02003621 for a non-existing file is not included, unless {expr} does
3622 not start with '%', '#' or '<', see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003623
3624 When {expr} starts with '%', '#' or '<', the expansion is done
3625 like for the |cmdline-special| variables with their associated
3626 modifiers. Here is a short overview:
3627
3628 % current file name
3629 # alternate file name
3630 #n alternate file name n
3631 <cfile> file name under the cursor
3632 <afile> autocmd file name
3633 <abuf> autocmd buffer number (as a String!)
3634 <amatch> autocmd matched name
Bram Moolenaara6878372014-03-22 21:02:50 +01003635 <sfile> sourced script file or function name
Bram Moolenaar81af9252010-12-10 20:35:50 +01003636 <slnum> sourced script file line number
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 <cword> word under the cursor
3638 <cWORD> WORD under the cursor
3639 <client> the {clientid} of the last received
3640 message |server2client()|
3641 Modifiers:
3642 :p expand to full path
3643 :h head (last path component removed)
3644 :t tail (last path component only)
3645 :r root (one extension removed)
3646 :e extension only
3647
3648 Example: >
3649 :let &tags = expand("%:p:h") . "/tags"
3650< Note that when expanding a string that starts with '%', '#' or
3651 '<', any following text is ignored. This does NOT work: >
3652 :let doesntwork = expand("%:h.bak")
3653< Use this: >
3654 :let doeswork = expand("%:h") . ".bak"
3655< Also note that expanding "<cfile>" and others only returns the
3656 referenced file name without further expansion. If "<cfile>"
3657 is "~/.cshrc", you need to do another expand() to have the
3658 "~/" expanded into the path of the home directory: >
3659 :echo expand(expand("<cfile>"))
3660<
3661 There cannot be white space between the variables and the
3662 following modifier. The |fnamemodify()| function can be used
3663 to modify normal file names.
3664
3665 When using '%' or '#', and the current or alternate file name
3666 is not defined, an empty string is used. Using "%:p" in a
3667 buffer with no name, results in the current directory, with a
3668 '/' added.
3669
3670 When {expr} does not start with '%', '#' or '<', it is
3671 expanded like a file name is expanded on the command line.
3672 'suffixes' and 'wildignore' are used, unless the optional
Bram Moolenaare381d3d2016-07-07 14:50:41 +02003673 {nosuf} argument is given and it is |TRUE|.
Bram Moolenaar146e9c32012-03-07 19:18:23 +01003674 Names for non-existing files are included. The "**" item can
3675 be used to search in a directory tree. For example, to find
3676 all "README" files in the current directory and below: >
Bram Moolenaar02743632005-07-25 20:42:36 +00003677 :echo expand("**/README")
3678<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679 Expand() can also be used to expand variables and environment
3680 variables that are only known in a shell. But this can be
Bram Moolenaar34401cc2014-08-29 15:12:19 +02003681 slow, because a shell may be used to do the expansion. See
3682 |expr-env-expand|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 The expanded variable is still handled like a list of file
Bram Moolenaar58b85342016-08-14 19:54:54 +02003684 names. When an environment variable cannot be expanded, it is
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 left unchanged. Thus ":echo expand('$FOOBAR')" results in
3686 "$FOOBAR".
3687
3688 See |glob()| for finding existing files. See |system()| for
3689 getting the raw output of an external command.
3690
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003691extend({expr1}, {expr2} [, {expr3}]) *extend()*
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003692 {expr1} and {expr2} must be both |Lists| or both
3693 |Dictionaries|.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003694
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003695 If they are |Lists|: Append {expr2} to {expr1}.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003696 If {expr3} is given insert the items of {expr2} before item
3697 {expr3} in {expr1}. When {expr3} is zero insert before the
3698 first item. When {expr3} is equal to len({expr1}) then
3699 {expr2} is appended.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00003700 Examples: >
3701 :echo sort(extend(mylist, [7, 5]))
3702 :call extend(mylist, [2, 3], 1)
Bram Moolenaardc9cf9c2008-08-08 10:36:31 +00003703< When {expr1} is the same List as {expr2} then the number of
3704 items copied is equal to the original length of the List.
3705 E.g., when {expr3} is 1 you get N new copies of the first item
3706 (where N is the original length of the List).
Bram Moolenaar58b85342016-08-14 19:54:54 +02003707 Use |add()| to concatenate one item to a list. To concatenate
Bram Moolenaara14de3d2005-01-07 21:48:26 +00003708 two lists into a new list use the + operator: >
Bram Moolenaarde8866b2005-01-06 23:24:37 +00003709 :let newlist = [1, 2, 3] + [4, 5]
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003710<
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003711 If they are |Dictionaries|:
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003712 Add all entries from {expr2} to {expr1}.
3713 If a key exists in both {expr1} and {expr2} then {expr3} is
3714 used to decide what to do:
3715 {expr3} = "keep": keep the value of {expr1}
3716 {expr3} = "force": use the value of {expr2}
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003717 {expr3} = "error": give an error message *E737*
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003718 When {expr3} is omitted then "force" is assumed.
3719
3720 {expr1} is changed when {expr2} is not empty. If necessary
3721 make a copy of {expr1} first.
3722 {expr2} remains unchanged.
Bram Moolenaarf2571c62015-06-09 19:44:55 +02003723 When {expr1} is locked and {expr2} is not empty the operation
3724 fails.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003725 Returns {expr1}.
3726
Bram Moolenaarde8866b2005-01-06 23:24:37 +00003727
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00003728feedkeys({string} [, {mode}]) *feedkeys()*
3729 Characters in {string} are queued for processing as if they
Bram Moolenaar0a988df2015-01-27 15:19:24 +01003730 come from a mapping or were typed by the user.
3731 By default the string is added to the end of the typeahead
3732 buffer, thus if a mapping is still being executed the
3733 characters come after them. Use the 'i' flag to insert before
3734 other characters, they will be executed next, before any
3735 characters from a mapping.
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00003736 The function does not wait for processing of keys contained in
3737 {string}.
3738 To include special keys into {string}, use double-quotes
3739 and "\..." notation |expr-quote|. For example,
Bram Moolenaar79166c42007-05-10 18:29:51 +00003740 feedkeys("\<CR>") simulates pressing of the <Enter> key. But
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00003741 feedkeys('\<CR>') pushes 5 characters.
3742 If {mode} is absent, keys are remapped.
3743 {mode} is a String, which can contain these character flags:
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00003744 'm' Remap keys. This is default.
3745 'n' Do not remap keys.
3746 't' Handle keys as if typed; otherwise they are handled as
3747 if coming from a mapping. This matters for undo,
3748 opening folds, etc.
Bram Moolenaar0a988df2015-01-27 15:19:24 +01003749 'i' Insert the string instead of appending (see above).
Bram Moolenaar25281632016-01-21 23:32:32 +01003750 'x' Execute commands until typeahead is empty. This is
3751 similar to using ":normal!". You can call feedkeys()
3752 several times without 'x' and then one time with 'x'
3753 (possibly with an empty {string}) to execute all the
Bram Moolenaar03413f42016-04-12 21:07:15 +02003754 typeahead. Note that when Vim ends in Insert mode it
3755 will behave as if <Esc> is typed, to avoid getting
3756 stuck, waiting for a character to be typed before the
3757 script continues.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02003758 '!' When used with 'x' will not end Insert mode. Can be
3759 used in a test when a timer is set to exit Insert mode
3760 a little later. Useful for testing CursorHoldI.
3761
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00003762 Return value is always 0.
3763
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764filereadable({file}) *filereadable()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02003765 The result is a Number, which is |TRUE| when a file with the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 name {file} exists, and can be read. If {file} doesn't exist,
Bram Moolenaare381d3d2016-07-07 14:50:41 +02003767 or is a directory, the result is |FALSE|. {file} is any
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 expression, which is used as a String.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00003769 If you don't care about the file being readable you can use
3770 |glob()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 *file_readable()*
3772 Obsolete name: file_readable().
3773
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00003774
Bram Moolenaaref2f6562007-05-06 13:32:59 +00003775filewritable({file}) *filewritable()*
3776 The result is a Number, which is 1 when a file with the
3777 name {file} exists, and can be written. If {file} doesn't
Bram Moolenaar446cb832008-06-24 21:56:24 +00003778 exist, or is not writable, the result is 0. If {file} is a
Bram Moolenaaref2f6562007-05-06 13:32:59 +00003779 directory, and we can write to it, the result is 2.
3780
3781
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02003782filter({expr1}, {expr2}) *filter()*
3783 {expr1} must be a |List| or a |Dictionary|.
3784 For each item in {expr1} evaluate {expr2} and when the result
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003785 is zero remove the item from the |List| or |Dictionary|.
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02003786 {expr2} must be a |string| or |Funcref|.
3787
Bram Moolenaar50ba5262016-09-22 22:33:02 +02003788 If {expr2} is a |string|, inside {expr2} |v:val| has the value
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02003789 of the current item. For a |Dictionary| |v:key| has the key
Bram Moolenaar50ba5262016-09-22 22:33:02 +02003790 of the current item and for a |List| |v:key| has the index of
3791 the current item.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003792 Examples: >
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02003793 call filter(mylist, 'v:val !~ "OLD"')
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003794< Removes the items where "OLD" appears. >
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02003795 call filter(mydict, 'v:key >= 8')
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003796< Removes the items with a key below 8. >
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02003797 call filter(var, 0)
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003798< Removes all the items, thus clears the |List| or |Dictionary|.
Bram Moolenaard8b02732005-01-14 21:48:43 +00003799
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02003800 Note that {expr2} is the result of expression and is then
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003801 used as an expression again. Often it is good to use a
3802 |literal-string| to avoid having to double backslashes.
3803
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02003804 If {expr2} is a |Funcref| it must take two arguments:
3805 1. the key or the index of the current item.
3806 2. the value of the current item.
Bram Moolenaare381d3d2016-07-07 14:50:41 +02003807 The function must return |TRUE| if the item should be kept.
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02003808 Example that keeps the odd items of a list: >
3809 func Odd(idx, val)
3810 return a:idx % 2 == 1
3811 endfunc
3812 call filter(mylist, function('Odd'))
Bram Moolenaar50ba5262016-09-22 22:33:02 +02003813< It is shorter when using a |lambda|: >
3814 call filter(myList, {idx, val -> idx * val <= 42})
3815< If you do not use "val" you can leave it out: >
3816 call filter(myList, {idx -> idx % 2 == 1})
Bram Moolenaar2ec618c2016-10-01 14:47:05 +02003817<
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003818 The operation is done in-place. If you want a |List| or
3819 |Dictionary| to remain unmodified make a copy first: >
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00003820 :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003821
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02003822< Returns {expr1}, the |List| or |Dictionary| that was filtered.
3823 When an error is encountered while evaluating {expr2} no
3824 further items in {expr1} are processed. When {expr2} is a
3825 Funcref errors inside a function are ignored, unless it was
3826 defined with the "abort" flag.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00003827
3828
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00003829finddir({name}[, {path}[, {count}]]) *finddir()*
Bram Moolenaar5b6b1ca2007-03-27 08:19:43 +00003830 Find directory {name} in {path}. Supports both downwards and
3831 upwards recursive directory searches. See |file-searching|
3832 for the syntax of {path}.
3833 Returns the path of the first found match. When the found
3834 directory is below the current directory a relative path is
3835 returned. Otherwise a full path is returned.
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00003836 If {path} is omitted or empty then 'path' is used.
3837 If the optional {count} is given, find {count}'s occurrence of
Bram Moolenaar433f7c82006-03-21 21:29:36 +00003838 {name} in {path} instead of the first one.
Bram Moolenaar899dddf2006-03-26 21:06:50 +00003839 When {count} is negative return all the matches in a |List|.
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00003840 This is quite similar to the ex-command |:find|.
Bram Moolenaardb84e452010-08-15 13:50:43 +02003841 {only available when compiled with the |+file_in_path|
3842 feature}
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00003843
3844findfile({name}[, {path}[, {count}]]) *findfile()*
3845 Just like |finddir()|, but find a file instead of a directory.
Bram Moolenaar433f7c82006-03-21 21:29:36 +00003846 Uses 'suffixesadd'.
3847 Example: >
3848 :echo findfile("tags.vim", ".;")
Bram Moolenaaref2f6562007-05-06 13:32:59 +00003849< Searches from the directory of the current file upwards until
3850 it finds the file "tags.vim".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851
Bram Moolenaar446cb832008-06-24 21:56:24 +00003852float2nr({expr}) *float2nr()*
3853 Convert {expr} to a Number by omitting the part after the
3854 decimal point.
3855 {expr} must evaluate to a |Float| or a Number.
3856 When the value of {expr} is out of range for a |Number| the
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02003857 result is truncated to 0x7fffffff or -0x7fffffff (or when
3858 64-bit Number support is enabled, 0x7fffffffffffffff or
3859 -0x7fffffffffffffff. NaN results in -0x80000000 (or when
3860 64-bit Number support is enabled, -0x8000000000000000).
Bram Moolenaar446cb832008-06-24 21:56:24 +00003861 Examples: >
3862 echo float2nr(3.95)
3863< 3 >
3864 echo float2nr(-23.45)
3865< -23 >
3866 echo float2nr(1.0e100)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02003867< 2147483647 (or 9223372036854775807) >
Bram Moolenaar446cb832008-06-24 21:56:24 +00003868 echo float2nr(-1.0e150)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02003869< -2147483647 (or -9223372036854775807) >
Bram Moolenaar446cb832008-06-24 21:56:24 +00003870 echo float2nr(1.0e-100)
3871< 0
3872 {only available when compiled with the |+float| feature}
3873
3874
3875floor({expr}) *floor()*
3876 Return the largest integral value less than or equal to
3877 {expr} as a |Float| (round down).
3878 {expr} must evaluate to a |Float| or a |Number|.
3879 Examples: >
3880 echo floor(1.856)
3881< 1.0 >
3882 echo floor(-5.456)
3883< -6.0 >
3884 echo floor(4.0)
3885< 4.0
3886 {only available when compiled with the |+float| feature}
3887
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003888
3889fmod({expr1}, {expr2}) *fmod()*
3890 Return the remainder of {expr1} / {expr2}, even if the
3891 division is not representable. Returns {expr1} - i * {expr2}
3892 for some integer i such that if {expr2} is non-zero, the
3893 result has the same sign as {expr1} and magnitude less than
3894 the magnitude of {expr2}. If {expr2} is zero, the value
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003895 returned is zero. The value returned is a |Float|.
3896 {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003897 Examples: >
3898 :echo fmod(12.33, 1.22)
3899< 0.13 >
3900 :echo fmod(-12.33, 1.22)
3901< -0.13
Bram Moolenaardb84e452010-08-15 13:50:43 +02003902 {only available when compiled with |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003903
3904
Bram Moolenaaraebaf892008-05-28 14:49:58 +00003905fnameescape({string}) *fnameescape()*
Bram Moolenaar58b85342016-08-14 19:54:54 +02003906 Escape {string} for use as file name command argument. All
Bram Moolenaaraebaf892008-05-28 14:49:58 +00003907 characters that have a special meaning, such as '%' and '|'
3908 are escaped with a backslash.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003909 For most systems the characters escaped are
3910 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash
3911 appears in a filename, it depends on the value of 'isfname'.
Bram Moolenaar1b24e4b2008-08-08 10:59:17 +00003912 A leading '+' and '>' is also escaped (special after |:edit|
3913 and |:write|). And a "-" by itself (special after |:cd|).
Bram Moolenaaraebaf892008-05-28 14:49:58 +00003914 Example: >
Bram Moolenaar1b24e4b2008-08-08 10:59:17 +00003915 :let fname = '+some str%nge|name'
Bram Moolenaaraebaf892008-05-28 14:49:58 +00003916 :exe "edit " . fnameescape(fname)
3917< results in executing: >
Bram Moolenaar1b24e4b2008-08-08 10:59:17 +00003918 edit \+some\ str\%nge\|name
Bram Moolenaaraebaf892008-05-28 14:49:58 +00003919
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920fnamemodify({fname}, {mods}) *fnamemodify()*
3921 Modify file name {fname} according to {mods}. {mods} is a
3922 string of characters like it is used for file names on the
3923 command line. See |filename-modifiers|.
3924 Example: >
3925 :echo fnamemodify("main.c", ":p:h")
3926< results in: >
3927 /home/mool/vim/vim/src
Bram Moolenaar446cb832008-06-24 21:56:24 +00003928< Note: Environment variables don't work in {fname}, use
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 |expand()| first then.
3930
3931foldclosed({lnum}) *foldclosed()*
3932 The result is a Number. If the line {lnum} is in a closed
3933 fold, the result is the number of the first line in that fold.
3934 If the line {lnum} is not in a closed fold, -1 is returned.
3935
3936foldclosedend({lnum}) *foldclosedend()*
3937 The result is a Number. If the line {lnum} is in a closed
3938 fold, the result is the number of the last line in that fold.
3939 If the line {lnum} is not in a closed fold, -1 is returned.
3940
3941foldlevel({lnum}) *foldlevel()*
3942 The result is a Number, which is the foldlevel of line {lnum}
Bram Moolenaar58b85342016-08-14 19:54:54 +02003943 in the current buffer. For nested folds the deepest level is
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 returned. If there is no fold at line {lnum}, zero is
3945 returned. It doesn't matter if the folds are open or closed.
3946 When used while updating folds (from 'foldexpr') -1 is
3947 returned for lines where folds are still to be updated and the
3948 foldlevel is unknown. As a special case the level of the
3949 previous line is usually available.
3950
3951 *foldtext()*
3952foldtext() Returns a String, to be displayed for a closed fold. This is
3953 the default function used for the 'foldtext' option and should
3954 only be called from evaluating 'foldtext'. It uses the
3955 |v:foldstart|, |v:foldend| and |v:folddashes| variables.
3956 The returned string looks like this: >
3957 +-- 45 lines: abcdef
Bram Moolenaar42205552017-03-18 19:42:22 +01003958< The number of leading dashes depends on the foldlevel. The
3959 "45" is the number of lines in the fold. "abcdef" is the text
3960 in the first non-blank line of the fold. Leading white space,
3961 "//" or "/*" and the text from the 'foldmarker' and
3962 'commentstring' options is removed.
3963 When used to draw the actual foldtext, the rest of the line
3964 will be filled with the fold char from the 'fillchars'
3965 setting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 {not available when compiled without the |+folding| feature}
3967
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003968foldtextresult({lnum}) *foldtextresult()*
3969 Returns the text that is displayed for the closed fold at line
3970 {lnum}. Evaluates 'foldtext' in the appropriate context.
3971 When there is no closed fold at {lnum} an empty string is
3972 returned.
3973 {lnum} is used like with |getline()|. Thus "." is the current
3974 line, "'m" mark m, etc.
3975 Useful when exporting folded text, e.g., to HTML.
3976 {not available when compiled without the |+folding| feature}
3977
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 *foreground()*
Bram Moolenaar58b85342016-08-14 19:54:54 +02003979foreground() Move the Vim window to the foreground. Useful when sent from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 a client to a Vim server. |remote_send()|
3981 On Win32 systems this might not work, the OS does not always
3982 allow a window to bring itself to the foreground. Use
3983 |remote_foreground()| instead.
3984 {only in the Win32, Athena, Motif and GTK GUI versions and the
3985 Win32 console version}
3986
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003987 *funcref()*
3988funcref({name} [, {arglist}] [, {dict}])
3989 Just like |function()|, but the returned Funcref will lookup
3990 the function by reference, not by name. This matters when the
3991 function {name} is redefined later.
3992
3993 Unlike |function()|, {name} must be an existing user function.
3994 Also for autoloaded functions. {name} cannot be a builtin
3995 function.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00003996
Bram Moolenaar1735bc92016-03-14 23:05:14 +01003997 *function()* *E700* *E922* *E923*
3998function({name} [, {arglist}] [, {dict}])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003999 Return a |Funcref| variable that refers to function {name}.
Bram Moolenaar975b5272016-03-15 23:10:59 +01004000 {name} can be the name of a user defined function or an
4001 internal function.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00004002
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004003 {name} can also be a Funcref or a partial. When it is a
Bram Moolenaar975b5272016-03-15 23:10:59 +01004004 partial the dict stored in it will be used and the {dict}
4005 argument is not allowed. E.g.: >
4006 let FuncWithArg = function(dict.Func, [arg])
4007 let Broken = function(dict.Func, [arg], dict)
4008<
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004009 When using the Funcref the function will be found by {name},
4010 also when it was redefined later. Use |funcref()| to keep the
4011 same function.
4012
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004013 When {arglist} or {dict} is present this creates a partial.
Bram Moolenaar06d2d382016-05-20 17:24:11 +02004014 That means the argument list and/or the dictionary is stored in
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004015 the Funcref and will be used when the Funcref is called.
4016
4017 The arguments are passed to the function in front of other
4018 arguments. Example: >
4019 func Callback(arg1, arg2, name)
4020 ...
4021 let Func = function('Callback', ['one', 'two'])
4022 ...
4023 call Func('name')
4024< Invokes the function as with: >
4025 call Callback('one', 'two', 'name')
4026
Bram Moolenaar03602ec2016-03-20 20:57:45 +01004027< The function() call can be nested to add more arguments to the
4028 Funcref. The extra arguments are appended to the list of
4029 arguments. Example: >
4030 func Callback(arg1, arg2, name)
4031 ...
4032 let Func = function('Callback', ['one'])
4033 let Func2 = function(Func, ['two'])
4034 ...
4035 call Func2('name')
4036< Invokes the function as with: >
4037 call Callback('one', 'two', 'name')
4038
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004039< The Dictionary is only useful when calling a "dict" function.
4040 In that case the {dict} is passed in as "self". Example: >
4041 function Callback() dict
4042 echo "called for " . self.name
4043 endfunction
4044 ...
4045 let context = {"name": "example"}
4046 let Func = function('Callback', context)
4047 ...
4048 call Func() " will echo: called for example
Bram Moolenaar975b5272016-03-15 23:10:59 +01004049< The use of function() is not needed when there are no extra
4050 arguments, these two are equivalent: >
4051 let Func = function('Callback', context)
4052 let Func = context.Callback
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004053
4054< The argument list and the Dictionary can be combined: >
4055 function Callback(arg1, count) dict
4056 ...
4057 let context = {"name": "example"}
4058 let Func = function('Callback', ['one'], context)
4059 ...
4060 call Func(500)
4061< Invokes the function as with: >
4062 call context.Callback('one', 500)
4063
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004064
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004065garbagecollect([{atexit}]) *garbagecollect()*
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02004066 Cleanup unused |Lists|, |Dictionaries|, |Channels| and |Jobs|
4067 that have circular references.
4068
4069 There is hardly ever a need to invoke this function, as it is
4070 automatically done when Vim runs out of memory or is waiting
4071 for the user to press a key after 'updatetime'. Items without
4072 circular references are always freed when they become unused.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004073 This is useful if you have deleted a very big |List| and/or
4074 |Dictionary| with circular references in a script that runs
4075 for a long time.
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02004076
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004077 When the optional {atexit} argument is one, garbage
Bram Moolenaar9d2c8c12007-09-25 16:00:00 +00004078 collection will also be done when exiting Vim, if it wasn't
4079 done before. This is useful when checking for memory leaks.
Bram Moolenaar39a58ca2005-06-27 22:42:44 +00004080
Bram Moolenaar574860b2016-05-24 17:33:34 +02004081 The garbage collection is not done immediately but only when
4082 it's safe to perform. This is when waiting for the user to
4083 type a character. To force garbage collection immediately use
4084 |test_garbagecollect_now()|.
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02004085
Bram Moolenaar677ee682005-01-27 14:41:15 +00004086get({list}, {idx} [, {default}]) *get()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004087 Get item {idx} from |List| {list}. When this item is not
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004088 available return {default}. Return zero when {default} is
4089 omitted.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004090get({dict}, {key} [, {default}])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004091 Get item with key {key} from |Dictionary| {dict}. When this
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004092 item is not available return {default}. Return zero when
4093 {default} is omitted.
Bram Moolenaar03e19a02016-05-24 22:29:49 +02004094get({func}, {what})
4095 Get an item with from Funcref {func}. Possible values for
Bram Moolenaar2bbf8ef2016-05-24 18:37:12 +02004096 {what} are:
Bram Moolenaar214641f2017-03-05 17:04:09 +01004097 "name" The function name
4098 "func" The function
4099 "dict" The dictionary
4100 "args" The list with arguments
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004101
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004102 *getbufinfo()*
4103getbufinfo([{expr}])
4104getbufinfo([{dict}])
Bram Moolenaar58b85342016-08-14 19:54:54 +02004105 Get information about buffers as a List of Dictionaries.
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004106
4107 Without an argument information about all the buffers is
4108 returned.
4109
4110 When the argument is a Dictionary only the buffers matching
4111 the specified criteria are returned. The following keys can
4112 be specified in {dict}:
4113 buflisted include only listed buffers.
4114 bufloaded include only loaded buffers.
4115
4116 Otherwise, {expr} specifies a particular buffer to return
4117 information for. For the use of {expr}, see |bufname()|
4118 above. If the buffer is found the returned List has one item.
4119 Otherwise the result is an empty list.
4120
4121 Each returned List item is a dictionary with the following
4122 entries:
Bram Moolenaar33928832016-08-18 21:22:04 +02004123 bufnr buffer number.
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004124 changed TRUE if the buffer is modified.
4125 changedtick number of changes made to the buffer.
4126 hidden TRUE if the buffer is hidden.
4127 listed TRUE if the buffer is listed.
4128 lnum current line number in buffer.
4129 loaded TRUE if the buffer is loaded.
4130 name full path to the file in the buffer.
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004131 signs list of signs placed in the buffer.
4132 Each list item is a dictionary with
4133 the following fields:
4134 id sign identifier
4135 lnum line number
4136 name sign name
Bram Moolenaar30567352016-08-27 21:25:44 +02004137 variables a reference to the dictionary with
4138 buffer-local variables.
4139 windows list of |window-ID|s that display this
4140 buffer
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004141
4142 Examples: >
4143 for buf in getbufinfo()
4144 echo buf.name
4145 endfor
4146 for buf in getbufinfo({'buflisted':1})
Bram Moolenaar30567352016-08-27 21:25:44 +02004147 if buf.changed
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004148 ....
4149 endif
4150 endfor
4151<
Bram Moolenaar30567352016-08-27 21:25:44 +02004152 To get buffer-local options use: >
4153 getbufvar({bufnr}, '&')
4154
4155<
Bram Moolenaar45360022005-07-21 21:08:21 +00004156 *getbufline()*
4157getbufline({expr}, {lnum} [, {end}])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004158 Return a |List| with the lines starting from {lnum} to {end}
4159 (inclusive) in the buffer {expr}. If {end} is omitted, a
4160 |List| with only the line {lnum} is returned.
Bram Moolenaar45360022005-07-21 21:08:21 +00004161
4162 For the use of {expr}, see |bufname()| above.
4163
Bram Moolenaar661b1822005-07-28 22:36:45 +00004164 For {lnum} and {end} "$" can be used for the last line of the
4165 buffer. Otherwise a number must be used.
Bram Moolenaar45360022005-07-21 21:08:21 +00004166
4167 When {lnum} is smaller than 1 or bigger than the number of
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004168 lines in the buffer, an empty |List| is returned.
Bram Moolenaar45360022005-07-21 21:08:21 +00004169
4170 When {end} is greater than the number of lines in the buffer,
4171 it is treated as {end} is set to the number of lines in the
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004172 buffer. When {end} is before {lnum} an empty |List| is
Bram Moolenaar45360022005-07-21 21:08:21 +00004173 returned.
4174
Bram Moolenaar661b1822005-07-28 22:36:45 +00004175 This function works only for loaded buffers. For unloaded and
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004176 non-existing buffers, an empty |List| is returned.
Bram Moolenaar45360022005-07-21 21:08:21 +00004177
4178 Example: >
4179 :let lines = getbufline(bufnr("myfile"), 1, "$")
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004180
Bram Moolenaar63dbda12013-02-20 21:12:10 +01004181getbufvar({expr}, {varname} [, {def}]) *getbufvar()*
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004182 The result is the value of option or local buffer variable
4183 {varname} in buffer {expr}. Note that the name without "b:"
4184 must be used.
Bram Moolenaarc236c162008-07-13 17:41:49 +00004185 When {varname} is empty returns a dictionary with all the
4186 buffer-local variables.
Bram Moolenaar30567352016-08-27 21:25:44 +02004187 When {varname} is equal to "&" returns a dictionary with all
4188 the buffer-local options.
4189 Otherwise, when {varname} starts with "&" returns the value of
4190 a buffer-local option.
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00004191 This also works for a global or buffer-local option, but it
4192 doesn't work for a global variable, window-local variable or
4193 window-local option.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004194 For the use of {expr}, see |bufname()| above.
Bram Moolenaar63dbda12013-02-20 21:12:10 +01004195 When the buffer or variable doesn't exist {def} or an empty
4196 string is returned, there is no error message.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004197 Examples: >
4198 :let bufmodified = getbufvar(1, "&mod")
4199 :echo "todo myvar = " . getbufvar("todo", "myvar")
4200<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201getchar([expr]) *getchar()*
Bram Moolenaar91170f82006-05-05 21:15:17 +00004202 Get a single character from the user or input stream.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 If [expr] is omitted, wait until a character is available.
4204 If [expr] is 0, only get a character when one is available.
Bram Moolenaar91170f82006-05-05 21:15:17 +00004205 Return zero otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 If [expr] is 1, only check if a character is available, it is
Bram Moolenaar91170f82006-05-05 21:15:17 +00004207 not consumed. Return zero if no character available.
4208
Bram Moolenaardfb18412013-12-11 18:53:29 +01004209 Without [expr] and when [expr] is 0 a whole character or
Bram Moolenaarc577d812017-07-08 22:37:34 +02004210 special key is returned. If it is a single character, the
Bram Moolenaar91170f82006-05-05 21:15:17 +00004211 result is a number. Use nr2char() to convert it to a String.
4212 Otherwise a String is returned with the encoded character.
Bram Moolenaarc577d812017-07-08 22:37:34 +02004213 For a special key it's a String with a sequence of bytes
4214 starting with 0x80 (decimal: 128). This is the same value as
4215 the String "\<Key>", e.g., "\<Left>". The returned value is
4216 also a String when a modifier (shift, control, alt) was used
4217 that is not included in the character.
Bram Moolenaar91170f82006-05-05 21:15:17 +00004218
Bram Moolenaar822ff862014-06-12 21:46:14 +02004219 When [expr] is 0 and Esc is typed, there will be a short delay
4220 while Vim waits to see if this is the start of an escape
4221 sequence.
4222
Bram Moolenaardfb18412013-12-11 18:53:29 +01004223 When [expr] is 1 only the first byte is returned. For a
Bram Moolenaar56a907a2006-05-06 21:44:30 +00004224 one-byte character it is the character itself as a number.
4225 Use nr2char() to convert it to a String.
Bram Moolenaar91170f82006-05-05 21:15:17 +00004226
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004227 Use getcharmod() to obtain any additional modifiers.
4228
Bram Moolenaar219b8702006-11-01 14:32:36 +00004229 When the user clicks a mouse button, the mouse event will be
4230 returned. The position can then be found in |v:mouse_col|,
Bram Moolenaar511972d2016-06-04 18:09:59 +02004231 |v:mouse_lnum|, |v:mouse_winid| and |v:mouse_win|. This
4232 example positions the mouse as it would normally happen: >
Bram Moolenaar219b8702006-11-01 14:32:36 +00004233 let c = getchar()
Bram Moolenaar446cb832008-06-24 21:56:24 +00004234 if c == "\<LeftMouse>" && v:mouse_win > 0
Bram Moolenaar219b8702006-11-01 14:32:36 +00004235 exe v:mouse_win . "wincmd w"
4236 exe v:mouse_lnum
4237 exe "normal " . v:mouse_col . "|"
4238 endif
4239<
Bram Moolenaar690afe12017-01-28 18:34:47 +01004240 When using bracketed paste only the first character is
4241 returned, the rest of the pasted text is dropped.
4242 |xterm-bracketed-paste|.
4243
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 There is no prompt, you will somehow have to make clear to the
4245 user that a character has to be typed.
4246 There is no mapping for the character.
4247 Key codes are replaced, thus when the user presses the <Del>
4248 key you get the code for the <Del> key, not the raw character
4249 sequence. Examples: >
4250 getchar() == "\<Del>"
4251 getchar() == "\<S-Left>"
4252< This example redefines "f" to ignore case: >
4253 :nmap f :call FindChar()<CR>
4254 :function FindChar()
4255 : let c = nr2char(getchar())
4256 : while col('.') < col('$') - 1
4257 : normal l
4258 : if getline('.')[col('.') - 1] ==? c
4259 : break
4260 : endif
4261 : endwhile
4262 :endfunction
Bram Moolenaared32d942014-12-06 23:33:00 +01004263<
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01004264 You may also receive synthetic characters, such as
Bram Moolenaared32d942014-12-06 23:33:00 +01004265 |<CursorHold>|. Often you will want to ignore this and get
4266 another character: >
4267 :function GetKey()
4268 : let c = getchar()
4269 : while c == "\<CursorHold>"
4270 : let c = getchar()
4271 : endwhile
4272 : return c
4273 :endfunction
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274
4275getcharmod() *getcharmod()*
4276 The result is a Number which is the state of the modifiers for
4277 the last obtained character with getchar() or in another way.
4278 These values are added together:
4279 2 shift
4280 4 control
4281 8 alt (meta)
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004282 16 meta (when it's different from ALT)
4283 32 mouse double click
4284 64 mouse triple click
4285 96 mouse quadruple click (== 32 + 64)
4286 128 command (Macintosh only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 Only the modifiers that have not been included in the
Bram Moolenaar58b85342016-08-14 19:54:54 +02004288 character itself are obtained. Thus Shift-a results in "A"
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004289 without a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290
Bram Moolenaardbd24b52015-08-11 14:26:19 +02004291getcharsearch() *getcharsearch()*
4292 Return the current character search information as a {dict}
4293 with the following entries:
4294
4295 char character previously used for a character
4296 search (|t|, |f|, |T|, or |F|); empty string
4297 if no character search has been performed
4298 forward direction of character search; 1 for forward,
4299 0 for backward
4300 until type of character search; 1 for a |t| or |T|
4301 character search, 0 for an |f| or |F|
4302 character search
4303
4304 This can be useful to always have |;| and |,| search
4305 forward/backward regardless of the direction of the previous
4306 character search: >
4307 :nnoremap <expr> ; getcharsearch().forward ? ';' : ','
4308 :nnoremap <expr> , getcharsearch().forward ? ',' : ';'
4309< Also see |setcharsearch()|.
4310
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311getcmdline() *getcmdline()*
4312 Return the current command-line. Only works when the command
4313 line is being edited, thus requires use of |c_CTRL-\_e| or
4314 |c_CTRL-R_=|.
4315 Example: >
4316 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00004317< Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004319getcmdpos() *getcmdpos()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 Return the position of the cursor in the command line as a
4321 byte count. The first column is 1.
4322 Only works when editing the command line, thus requires use of
Bram Moolenaar5b435d62012-04-05 17:33:26 +02004323 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
4324 Returns 0 otherwise.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00004325 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|.
4326
4327getcmdtype() *getcmdtype()*
4328 Return the current command-line type. Possible return values
4329 are:
Bram Moolenaar1e015462005-09-25 22:16:38 +00004330 : normal Ex command
4331 > debug mode command |debug-mode|
4332 / forward search command
4333 ? backward search command
4334 @ |input()| command
4335 - |:insert| or |:append| command
Bram Moolenaar6e932462014-09-09 18:48:09 +02004336 = |i_CTRL-R_=|
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00004337 Only works when editing the command line, thus requires use of
Bram Moolenaar5b435d62012-04-05 17:33:26 +02004338 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
4339 Returns an empty string otherwise.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00004340 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341
Bram Moolenaarfb539272014-08-22 19:21:47 +02004342getcmdwintype() *getcmdwintype()*
4343 Return the current |command-line-window| type. Possible return
4344 values are the same as |getcmdtype()|. Returns an empty string
4345 when not in the command-line window.
4346
Bram Moolenaare9d58a62016-08-13 15:07:41 +02004347getcompletion({pat}, {type} [, {filtered}]) *getcompletion()*
Bram Moolenaaraa4d7322016-07-09 18:50:29 +02004348 Return a list of command-line completion matches. {type}
4349 specifies what for. The following completion types are
4350 supported:
4351
4352 augroup autocmd groups
4353 buffer buffer names
4354 behave :behave suboptions
4355 color color schemes
4356 command Ex command (and arguments)
4357 compiler compilers
4358 cscope |:cscope| suboptions
4359 dir directory names
4360 environment environment variable names
4361 event autocommand events
4362 expression Vim expression
4363 file file and directory names
4364 file_in_path file and directory names in |'path'|
4365 filetype filetype names |'filetype'|
4366 function function name
4367 help help subjects
4368 highlight highlight groups
4369 history :history suboptions
4370 locale locale names (as output of locale -a)
4371 mapping mapping name
4372 menu menus
Bram Moolenaar9e507ca2016-10-15 15:39:39 +02004373 messages |:messages| suboptions
Bram Moolenaaraa4d7322016-07-09 18:50:29 +02004374 option options
Bram Moolenaar9e507ca2016-10-15 15:39:39 +02004375 packadd optional package |pack-add| names
Bram Moolenaaraa4d7322016-07-09 18:50:29 +02004376 shellcmd Shell command
4377 sign |:sign| suboptions
4378 syntax syntax file names |'syntax'|
4379 syntime |:syntime| suboptions
4380 tag tags
4381 tag_listfiles tags, file names
4382 user user names
4383 var user variables
4384
4385 If {pat} is an empty string, then all the matches are returned.
4386 Otherwise only items matching {pat} are returned. See
4387 |wildcards| for the use of special characters in {pat}.
4388
Bram Moolenaare9d58a62016-08-13 15:07:41 +02004389 If the optional {filtered} flag is set to 1, then 'wildignore'
4390 is applied to filter the results. Otherwise all the matches
4391 are returned. The 'wildignorecase' option always applies.
4392
Bram Moolenaaraa4d7322016-07-09 18:50:29 +02004393 If there are no matches, an empty list is returned. An
4394 invalid value for {type} produces an error.
4395
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02004396 *getcurpos()*
4397getcurpos() Get the position of the cursor. This is like getpos('.'), but
4398 includes an extra item in the list:
Bram Moolenaar345efa02016-01-15 20:57:49 +01004399 [bufnum, lnum, col, off, curswant] ~
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02004400 The "curswant" number is the preferred column when moving the
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02004401 cursor vertically. Also see |getpos()|.
4402
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02004403 This can be used to save and restore the cursor position: >
4404 let save_cursor = getcurpos()
4405 MoveTheCursorAround
4406 call setpos('.', save_cursor)
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02004407< Note that this only works within the window. See
4408 |winrestview()| for restoring more state.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409 *getcwd()*
Bram Moolenaarc9703302016-01-17 21:49:33 +01004410getcwd([{winnr} [, {tabnr}]])
4411 The result is a String, which is the name of the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412 working directory.
Bram Moolenaarc9703302016-01-17 21:49:33 +01004413 Without arguments, for the current window.
4414
4415 With {winnr} return the local current directory of this window
4416 in the current tab page.
4417 With {winnr} and {tabnr} return the local current directory of
4418 the window in the specified tab page.
Bram Moolenaar7571d552016-08-18 22:54:46 +02004419 {winnr} can be the window number or the |window-ID|.
Bram Moolenaarc9703302016-01-17 21:49:33 +01004420 Return an empty string if the arguments are invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421
4422getfsize({fname}) *getfsize()*
4423 The result is a Number, which is the size in bytes of the
4424 given file {fname}.
4425 If {fname} is a directory, 0 is returned.
4426 If the file {fname} can't be found, -1 is returned.
Bram Moolenaard827ada2007-06-19 15:19:55 +00004427 If the size of {fname} is too big to fit in a Number then -2
4428 is returned.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004429
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00004430getfontname([{name}]) *getfontname()*
4431 Without an argument returns the name of the normal font being
4432 used. Like what is used for the Normal highlight group
4433 |hl-Normal|.
4434 With an argument a check is done whether {name} is a valid
4435 font name. If not then an empty string is returned.
4436 Otherwise the actual font name is returned, or {name} if the
4437 GUI does not support obtaining the real name.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00004438 Only works when the GUI is running, thus not in your vimrc or
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00004439 gvimrc file. Use the |GUIEnter| autocommand to use this
4440 function just after the GUI has started.
Bram Moolenaar3df01732017-02-17 22:47:16 +01004441 Note that the GTK GUI accepts any font name, thus checking for
4442 a valid name does not work.
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00004443
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004444getfperm({fname}) *getfperm()*
4445 The result is a String, which is the read, write, and execute
4446 permissions of the given file {fname}.
4447 If {fname} does not exist or its directory cannot be read, an
4448 empty string is returned.
4449 The result is of the form "rwxrwxrwx", where each group of
4450 "rwx" flags represent, in turn, the permissions of the owner
4451 of the file, the group the file belongs to, and other users.
4452 If a user does not have a given permission the flag for this
Bram Moolenaar9b451252012-08-15 17:43:31 +02004453 is replaced with the string "-". Examples: >
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004454 :echo getfperm("/etc/passwd")
Bram Moolenaar9b451252012-08-15 17:43:31 +02004455 :echo getfperm(expand("~/.vimrc"))
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004456< This will hopefully (from a security point of view) display
4457 the string "rw-r--r--" or even "rw-------".
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004458
Bram Moolenaar2ec618c2016-10-01 14:47:05 +02004459 For setting permissions use |setfperm()|.
Bram Moolenaar80492532016-03-08 17:08:53 +01004460
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461getftime({fname}) *getftime()*
4462 The result is a Number, which is the last modification time of
4463 the given file {fname}. The value is measured as seconds
4464 since 1st Jan 1970, and may be passed to strftime(). See also
4465 |localtime()| and |strftime()|.
4466 If the file {fname} can't be found -1 is returned.
4467
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004468getftype({fname}) *getftype()*
4469 The result is a String, which is a description of the kind of
4470 file of the given file {fname}.
4471 If {fname} does not exist an empty string is returned.
4472 Here is a table over different kinds of files and their
4473 results:
4474 Normal file "file"
4475 Directory "dir"
4476 Symbolic link "link"
4477 Block device "bdev"
4478 Character device "cdev"
4479 Socket "socket"
4480 FIFO "fifo"
4481 All other "other"
4482 Example: >
4483 getftype("/home")
4484< Note that a type such as "link" will only be returned on
4485 systems that support it. On some systems only "dir" and
Bram Moolenaar13d5aee2016-01-21 23:36:05 +01004486 "file" are returned. On MS-Windows a symbolic link to a
4487 directory returns "dir" instead of "link".
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004488
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 *getline()*
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004490getline({lnum} [, {end}])
4491 Without {end} the result is a String, which is line {lnum}
4492 from the current buffer. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493 getline(1)
4494< When {lnum} is a String that doesn't start with a
4495 digit, line() is called to translate the String into a Number.
4496 To get the line under the cursor: >
4497 getline(".")
4498< When {lnum} is smaller than 1 or bigger than the number of
4499 lines in the buffer, an empty string is returned.
4500
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004501 When {end} is given the result is a |List| where each item is
4502 a line from the current buffer in the range {lnum} to {end},
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004503 including line {end}.
4504 {end} is used in the same way as {lnum}.
4505 Non-existing lines are silently omitted.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004506 When {end} is before {lnum} an empty |List| is returned.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004507 Example: >
4508 :let start = line('.')
4509 :let end = search("^$") - 1
4510 :let lines = getline(start, end)
4511
Bram Moolenaaref2f6562007-05-06 13:32:59 +00004512< To get lines from another buffer see |getbufline()|
4513
Bram Moolenaar58b85342016-08-14 19:54:54 +02004514getloclist({nr}[, {what}]) *getloclist()*
Bram Moolenaar17c7c012006-01-26 22:25:15 +00004515 Returns a list with all the entries in the location list for
Bram Moolenaar7571d552016-08-18 22:54:46 +02004516 window {nr}. {nr} can be the window number or the |window-ID|.
Bram Moolenaar888ccac2016-06-04 18:49:36 +02004517 When {nr} is zero the current window is used.
4518
Bram Moolenaar17c7c012006-01-26 22:25:15 +00004519 For a location list window, the displayed location list is
Bram Moolenaar280f1262006-01-30 00:14:18 +00004520 returned. For an invalid window number {nr}, an empty list is
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004521 returned. Otherwise, same as |getqflist()|.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004522
Bram Moolenaard823fa92016-08-12 16:29:27 +02004523 If the optional {what} dictionary argument is supplied, then
4524 returns the items listed in {what} as a dictionary. Refer to
4525 |getqflist()| for the supported items in {what}.
4526
Bram Moolenaar6ee10162007-07-26 20:58:42 +00004527getmatches() *getmatches()*
4528 Returns a |List| with all matches previously defined by
4529 |matchadd()| and the |:match| commands. |getmatches()| is
4530 useful in combination with |setmatches()|, as |setmatches()|
4531 can restore a list of matches saved by |getmatches()|.
4532 Example: >
4533 :echo getmatches()
4534< [{'group': 'MyGroup1', 'pattern': 'TODO',
4535 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
4536 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
4537 :let m = getmatches()
4538 :call clearmatches()
4539 :echo getmatches()
4540< [] >
4541 :call setmatches(m)
4542 :echo getmatches()
4543< [{'group': 'MyGroup1', 'pattern': 'TODO',
4544 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
4545 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
4546 :unlet m
4547<
Bram Moolenaar822ff862014-06-12 21:46:14 +02004548 *getpid()*
4549getpid() Return a Number which is the process ID of the Vim process.
4550 On Unix and MS-Windows this is a unique number, until Vim
Bram Moolenaar58b85342016-08-14 19:54:54 +02004551 exits. On MS-DOS it's always zero.
Bram Moolenaar822ff862014-06-12 21:46:14 +02004552
4553 *getpos()*
4554getpos({expr}) Get the position for {expr}. For possible values of {expr}
4555 see |line()|. For getting the cursor position see
4556 |getcurpos()|.
4557 The result is a |List| with four numbers:
4558 [bufnum, lnum, col, off]
4559 "bufnum" is zero, unless a mark like '0 or 'A is used, then it
4560 is the buffer number of the mark.
4561 "lnum" and "col" are the position in the buffer. The first
4562 column is 1.
4563 The "off" number is zero, unless 'virtualedit' is used. Then
4564 it is the offset in screen columns from the start of the
4565 character. E.g., a position within a <Tab> or after the last
4566 character.
4567 Note that for '< and '> Visual mode matters: when it is "V"
4568 (visual line mode) the column of '< is zero and the column of
4569 '> is a large number.
4570 This can be used to save and restore the position of a mark: >
4571 let save_a_mark = getpos("'a")
4572 ...
Bram Moolenaared32d942014-12-06 23:33:00 +01004573 call setpos("'a", save_a_mark)
Bram Moolenaar822ff862014-06-12 21:46:14 +02004574< Also see |getcurpos()| and |setpos()|.
4575
Bram Moolenaar6ee10162007-07-26 20:58:42 +00004576
Bram Moolenaard823fa92016-08-12 16:29:27 +02004577getqflist([{what}]) *getqflist()*
Bram Moolenaar68b76a62005-03-25 21:53:48 +00004578 Returns a list with all the current quickfix errors. Each
4579 list item is a dictionary with these entries:
4580 bufnr number of buffer that has the file name, use
4581 bufname() to get the name
4582 lnum line number in the buffer (first line is 1)
4583 col column number (first column is 1)
Bram Moolenaare381d3d2016-07-07 14:50:41 +02004584 vcol |TRUE|: "col" is visual column
4585 |FALSE|: "col" is byte index
Bram Moolenaar68b76a62005-03-25 21:53:48 +00004586 nr error number
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00004587 pattern search pattern used to locate the error
Bram Moolenaar68b76a62005-03-25 21:53:48 +00004588 text description of the error
4589 type type of the error, 'E', '1', etc.
Bram Moolenaare381d3d2016-07-07 14:50:41 +02004590 valid |TRUE|: recognized error message
Bram Moolenaar68b76a62005-03-25 21:53:48 +00004591
Bram Moolenaar7571d552016-08-18 22:54:46 +02004592 When there is no error list or it's empty, an empty list is
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00004593 returned. Quickfix list entries with non-existing buffer
4594 number are returned with "bufnr" set to zero.
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00004595
Bram Moolenaar68b76a62005-03-25 21:53:48 +00004596 Useful application: Find pattern matches in multiple files and
4597 do something with them: >
4598 :vimgrep /theword/jg *.c
4599 :for d in getqflist()
4600 : echo bufname(d.bufnr) ':' d.lnum '=' d.text
4601 :endfor
Bram Moolenaard823fa92016-08-12 16:29:27 +02004602<
4603 If the optional {what} dictionary argument is supplied, then
4604 returns only the items listed in {what} as a dictionary. The
4605 following string items are supported in {what}:
Bram Moolenaar45d2cca2017-04-30 16:36:05 +02004606 context get the context stored with |setqflist()|
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02004607 items quickfix list entries
Bram Moolenaar890680c2016-09-27 21:28:56 +02004608 nr get information for this quickfix list; zero
Bram Moolenaar875feea2017-06-11 16:07:51 +02004609 means the current quickfix list and '$' means
4610 the last quickfix list
Bram Moolenaar7571d552016-08-18 22:54:46 +02004611 title get the list title
4612 winid get the |window-ID| (if opened)
Bram Moolenaard823fa92016-08-12 16:29:27 +02004613 all all of the above quickfix properties
4614 Non-string items in {what} are ignored.
4615 If "nr" is not present then the current quickfix list is used.
Bram Moolenaar875feea2017-06-11 16:07:51 +02004616 To get the number of lists in the quickfix stack, set 'nr' to
4617 '$' in {what}. The 'nr' value in the returned dictionary
4618 contains the quickfix stack size.
Bram Moolenaard823fa92016-08-12 16:29:27 +02004619 In case of error processing {what}, an empty dictionary is
4620 returned.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00004621
Bram Moolenaard823fa92016-08-12 16:29:27 +02004622 The returned dictionary contains the following entries:
Bram Moolenaar45d2cca2017-04-30 16:36:05 +02004623 context context information stored with |setqflist()|
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02004624 items quickfix list entries
Bram Moolenaard823fa92016-08-12 16:29:27 +02004625 nr quickfix list number
4626 title quickfix list title text
Bram Moolenaar7571d552016-08-18 22:54:46 +02004627 winid quickfix |window-ID| (if opened)
Bram Moolenaard823fa92016-08-12 16:29:27 +02004628
4629 Examples: >
4630 :echo getqflist({'all': 1})
4631 :echo getqflist({'nr': 2, 'title': 1})
4632<
Bram Moolenaar68b76a62005-03-25 21:53:48 +00004633
Bram Moolenaarb7cb42b2014-04-02 19:55:10 +02004634getreg([{regname} [, 1 [, {list}]]]) *getreg()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 The result is a String, which is the contents of register
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00004636 {regname}. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637 :let cliptext = getreg('*')
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004638< When {regname} was not set the result is an empty string.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004639
4640 getreg('=') returns the last evaluated value of the expression
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00004641 register. (For use in maps.)
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00004642 getreg('=', 1) returns the expression itself, so that it can
4643 be restored with |setreg()|. For other registers the extra
4644 argument is ignored, thus you can always give it.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004645
Bram Moolenaare381d3d2016-07-07 14:50:41 +02004646 If {list} is present and |TRUE|, the result type is changed
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004647 to |List|. Each list item is one text line. Use it if you care
Bram Moolenaarb7cb42b2014-04-02 19:55:10 +02004648 about zero bytes possibly present inside register: without
4649 third argument both NLs and zero bytes are represented as NLs
4650 (see |NL-used-for-Nul|).
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004651 When the register was not set an empty list is returned.
4652
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 If {regname} is not specified, |v:register| is used.
4654
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004655
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656getregtype([{regname}]) *getregtype()*
4657 The result is a String, which is type of register {regname}.
4658 The value will be one of:
4659 "v" for |characterwise| text
4660 "V" for |linewise| text
4661 "<CTRL-V>{width}" for |blockwise-visual| text
Bram Moolenaar32b92012014-01-14 12:33:36 +01004662 "" for an empty or unknown register
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 <CTRL-V> is one character with value 0x16.
4664 If {regname} is not specified, |v:register| is used.
4665
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004666gettabinfo([{arg}]) *gettabinfo()*
4667 If {arg} is not specified, then information about all the tab
4668 pages is returned as a List. Each List item is a Dictionary.
4669 Otherwise, {arg} specifies the tab page number and information
4670 about that one is returned. If the tab page does not exist an
4671 empty List is returned.
4672
4673 Each List item is a Dictionary with the following entries:
Bram Moolenaar7571d552016-08-18 22:54:46 +02004674 tabnr tab page number.
Bram Moolenaar30567352016-08-27 21:25:44 +02004675 variables a reference to the dictionary with
4676 tabpage-local variables
Bram Moolenaar7571d552016-08-18 22:54:46 +02004677 windows List of |window-ID|s in the tag page.
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004678
Bram Moolenaar63dbda12013-02-20 21:12:10 +01004679gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()*
Bram Moolenaar06b5d512010-05-22 15:37:44 +02004680 Get the value of a tab-local variable {varname} in tab page
4681 {tabnr}. |t:var|
4682 Tabs are numbered starting with one.
Bram Moolenaar0e2ea1b2014-09-09 16:13:08 +02004683 When {varname} is empty a dictionary with all tab-local
4684 variables is returned.
Bram Moolenaar06b5d512010-05-22 15:37:44 +02004685 Note that the name without "t:" must be used.
Bram Moolenaar63dbda12013-02-20 21:12:10 +01004686 When the tab or variable doesn't exist {def} or an empty
4687 string is returned, there is no error message.
Bram Moolenaar06b5d512010-05-22 15:37:44 +02004688
Bram Moolenaar63dbda12013-02-20 21:12:10 +01004689gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()*
Bram Moolenaaref2f6562007-05-06 13:32:59 +00004690 Get the value of window-local variable {varname} in window
4691 {winnr} in tab page {tabnr}.
Bram Moolenaar63dbda12013-02-20 21:12:10 +01004692 When {varname} is empty a dictionary with all window-local
4693 variables is returned.
Bram Moolenaar30567352016-08-27 21:25:44 +02004694 When {varname} is equal to "&" get the values of all
4695 window-local options in a Dictionary.
4696 Otherwise, when {varname} starts with "&" get the value of a
4697 window-local option.
Bram Moolenaar63dbda12013-02-20 21:12:10 +01004698 Note that {varname} must be the name without "w:".
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00004699 Tabs are numbered starting with one. For the current tabpage
4700 use |getwinvar()|.
Bram Moolenaar7571d552016-08-18 22:54:46 +02004701 {winnr} can be the window number or the |window-ID|.
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00004702 When {winnr} is zero the current window is used.
4703 This also works for a global option, buffer-local option and
4704 window-local option, but it doesn't work for a global variable
4705 or buffer-local variable.
Bram Moolenaar63dbda12013-02-20 21:12:10 +01004706 When the tab, window or variable doesn't exist {def} or an
4707 empty string is returned, there is no error message.
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00004708 Examples: >
4709 :let list_is_on = gettabwinvar(1, 2, '&list')
4710 :echo "myvar = " . gettabwinvar(3, 1, 'myvar')
Bram Moolenaard46bbc72007-05-12 14:38:41 +00004711<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 *getwinposx()*
4713getwinposx() The result is a Number, which is the X coordinate in pixels of
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02004714 the left hand side of the GUI Vim window. Also works for an
4715 xterm.
4716 The result will be -1 if the information is not available.
4717 The value can be used with `:winpos`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718
4719 *getwinposy()*
4720getwinposy() The result is a Number, which is the Y coordinate in pixels of
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02004721 the top of the GUI Vim window. Also works for an xterm.
4722 The result will be -1 if the information is not available.
4723 The value can be used with `:winpos`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004725getwininfo([{winid}]) *getwininfo()*
4726 Returns information about windows as a List with Dictionaries.
4727
4728 If {winid} is given Information about the window with that ID
4729 is returned. If the window does not exist the result is an
4730 empty list.
4731
Bram Moolenaar7571d552016-08-18 22:54:46 +02004732 Without {winid} information about all the windows in all the
4733 tab pages is returned.
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004734
4735 Each List item is a Dictionary with the following entries:
Bram Moolenaar7571d552016-08-18 22:54:46 +02004736 bufnr number of buffer in the window
Bram Moolenaar386600f2016-08-15 22:16:25 +02004737 height window height
4738 loclist 1 if showing a location list
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004739 {only with the +quickfix feature}
Bram Moolenaar386600f2016-08-15 22:16:25 +02004740 quickfix 1 if quickfix or location list window
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004741 {only with the +quickfix feature}
Bram Moolenaar7571d552016-08-18 22:54:46 +02004742 tabnr tab page number
Bram Moolenaar30567352016-08-27 21:25:44 +02004743 variables a reference to the dictionary with
4744 window-local variables
Bram Moolenaar386600f2016-08-15 22:16:25 +02004745 width window width
Bram Moolenaar7571d552016-08-18 22:54:46 +02004746 winid |window-ID|
4747 winnr window number
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004748
Bram Moolenaar30567352016-08-27 21:25:44 +02004749 To obtain all window-local variables use: >
4750 gettabwinvar({tabnr}, {winnr}, '&')
4751
Bram Moolenaar63dbda12013-02-20 21:12:10 +01004752getwinvar({winnr}, {varname} [, {def}]) *getwinvar()*
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00004753 Like |gettabwinvar()| for the current tabpage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 Examples: >
4755 :let list_is_on = getwinvar(2, '&list')
4756 :echo "myvar = " . getwinvar(1, 'myvar')
4757<
Bram Moolenaard8b77f72015-03-05 21:21:19 +01004758glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()*
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00004759 Expand the file wildcards in {expr}. See |wildcards| for the
Bram Moolenaaref2f6562007-05-06 13:32:59 +00004760 use of special characters.
Bram Moolenaar84f72352012-03-11 15:57:40 +01004761
Bram Moolenaare381d3d2016-07-07 14:50:41 +02004762 Unless the optional {nosuf} argument is given and is |TRUE|,
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00004763 the 'suffixes' and 'wildignore' options apply: Names matching
4764 one of the patterns in 'wildignore' will be skipped and
4765 'suffixes' affect the ordering of matches.
Bram Moolenaar81af9252010-12-10 20:35:50 +01004766 'wildignorecase' always applies.
Bram Moolenaar84f72352012-03-11 15:57:40 +01004767
Bram Moolenaare381d3d2016-07-07 14:50:41 +02004768 When {list} is present and it is |TRUE| the result is a List
Bram Moolenaar84f72352012-03-11 15:57:40 +01004769 with all matching files. The advantage of using a List is,
4770 you also get filenames containing newlines correctly.
4771 Otherwise the result is a String and when there are several
4772 matches, they are separated by <NL> characters.
4773
4774 If the expansion fails, the result is an empty String or List.
Bram Moolenaard8b77f72015-03-05 21:21:19 +01004775
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02004776 A name for a non-existing file is not included. A symbolic
4777 link is only included if it points to an existing file.
Bram Moolenaard8b77f72015-03-05 21:21:19 +01004778 However, when the {alllinks} argument is present and it is
Bram Moolenaare381d3d2016-07-07 14:50:41 +02004779 |TRUE| then all symbolic links are included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004780
4781 For most systems backticks can be used to get files names from
4782 any external command. Example: >
4783 :let tagfiles = glob("`find . -name tags -print`")
4784 :let &tags = substitute(tagfiles, "\n", ",", "g")
4785< The result of the program inside the backticks should be one
Bram Moolenaar58b85342016-08-14 19:54:54 +02004786 item per line. Spaces inside an item are allowed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787
4788 See |expand()| for expanding special Vim variables. See
4789 |system()| for getting the raw output of an external command.
4790
Bram Moolenaar5837f1f2015-03-21 18:06:14 +01004791glob2regpat({expr}) *glob2regpat()*
4792 Convert a file pattern, as used by glob(), into a search
4793 pattern. The result can be used to match with a string that
4794 is a file name. E.g. >
4795 if filename =~ glob2regpat('Make*.mak')
4796< This is equivalent to: >
4797 if filename =~ '^Make.*\.mak$'
Bram Moolenaar3b5f9292016-01-28 22:37:01 +01004798< When {expr} is an empty string the result is "^$", match an
4799 empty string.
Bram Moolenaard823fa92016-08-12 16:29:27 +02004800 Note that the result depends on the system. On MS-Windows
Bram Moolenaar58b85342016-08-14 19:54:54 +02004801 a backslash usually means a path separator.
Bram Moolenaar3b5f9292016-01-28 22:37:01 +01004802
Bram Moolenaard8b77f72015-03-05 21:21:19 +01004803 *globpath()*
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004804globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 Perform glob() on all directories in {path} and concatenate
4806 the results. Example: >
4807 :echo globpath(&rtp, "syntax/c.vim")
Bram Moolenaar1b1063a2014-05-07 18:35:30 +02004808<
4809 {path} is a comma-separated list of directory names. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 directory name is prepended to {expr} and expanded like with
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00004811 |glob()|. A path separator is inserted when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 To add a comma inside a directory name escape it with a
4813 backslash. Note that on MS-Windows a directory may have a
4814 trailing backslash, remove it if you put a comma after it.
4815 If the expansion fails for one of the directories, there is no
4816 error message.
Bram Moolenaar1b1063a2014-05-07 18:35:30 +02004817
Bram Moolenaare381d3d2016-07-07 14:50:41 +02004818 Unless the optional {nosuf} argument is given and is |TRUE|,
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00004819 the 'suffixes' and 'wildignore' options apply: Names matching
4820 one of the patterns in 'wildignore' will be skipped and
4821 'suffixes' affect the ordering of matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822
Bram Moolenaare381d3d2016-07-07 14:50:41 +02004823 When {list} is present and it is |TRUE| the result is a List
Bram Moolenaar1b1063a2014-05-07 18:35:30 +02004824 with all matching files. The advantage of using a List is, you
4825 also get filenames containing newlines correctly. Otherwise
4826 the result is a String and when there are several matches,
4827 they are separated by <NL> characters. Example: >
4828 :echo globpath(&rtp, "syntax/c.vim", 0, 1)
4829<
Bram Moolenaar6463ca22016-02-13 17:04:46 +01004830 {alllinks} is used as with |glob()|.
Bram Moolenaard8b77f72015-03-05 21:21:19 +01004831
Bram Moolenaar02743632005-07-25 20:42:36 +00004832 The "**" item can be used to search in a directory tree.
4833 For example, to find all "README.txt" files in the directories
4834 in 'runtimepath' and below: >
4835 :echo globpath(&rtp, "**/README.txt")
Bram Moolenaarc236c162008-07-13 17:41:49 +00004836< Upwards search and limiting the depth of "**" is not
4837 supported, thus using 'path' will not always work properly.
4838
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839 *has()*
4840has({feature}) The result is a Number, which is 1 if the feature {feature} is
4841 supported, zero otherwise. The {feature} argument is a
4842 string. See |feature-list| below.
4843 Also see |exists()|.
4844
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004845
4846has_key({dict}, {key}) *has_key()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004847 The result is a Number, which is 1 if |Dictionary| {dict} has
4848 an entry with key {key}. Zero otherwise.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004849
Bram Moolenaarc9703302016-01-17 21:49:33 +01004850haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()*
4851 The result is a Number, which is 1 when the window has set a
4852 local path via |:lcd|, and 0 otherwise.
4853
4854 Without arguments use the current window.
4855 With {winnr} use this window in the current tab page.
4856 With {winnr} and {tabnr} use the window in the specified tab
4857 page.
Bram Moolenaar7571d552016-08-18 22:54:46 +02004858 {winnr} can be the window number or the |window-ID|.
Bram Moolenaarc9703302016-01-17 21:49:33 +01004859 Return 0 if the arguments are invalid.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004860
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00004861hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862 The result is a Number, which is 1 if there is a mapping that
4863 contains {what} in somewhere in the rhs (what it is mapped to)
4864 and this mapping exists in one of the modes indicated by
4865 {mode}.
Bram Moolenaare381d3d2016-07-07 14:50:41 +02004866 When {abbr} is there and it is |TRUE| use abbreviations
Bram Moolenaar39f05632006-03-19 22:15:26 +00004867 instead of mappings. Don't forget to specify Insert and/or
4868 Command-line mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 Both the global mappings and the mappings local to the current
4870 buffer are checked for a match.
4871 If no matching mapping is found 0 is returned.
4872 The following characters are recognized in {mode}:
4873 n Normal mode
4874 v Visual mode
4875 o Operator-pending mode
4876 i Insert mode
4877 l Language-Argument ("r", "f", "t", etc.)
4878 c Command-line mode
4879 When {mode} is omitted, "nvo" is used.
4880
4881 This function is useful to check if a mapping already exists
Bram Moolenaar58b85342016-08-14 19:54:54 +02004882 to a function in a Vim script. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883 :if !hasmapto('\ABCdoit')
4884 : map <Leader>d \ABCdoit
4885 :endif
4886< This installs the mapping to "\ABCdoit" only if there isn't
4887 already a mapping to "\ABCdoit".
4888
4889histadd({history}, {item}) *histadd()*
4890 Add the String {item} to the history {history} which can be
4891 one of: *hist-names*
4892 "cmd" or ":" command line history
4893 "search" or "/" search pattern history
Bram Moolenaar446cb832008-06-24 21:56:24 +00004894 "expr" or "=" typed expression history
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895 "input" or "@" input line history
Bram Moolenaar30b65812012-07-12 22:01:11 +02004896 "debug" or ">" debug command history
Bram Moolenaar3e496b02016-09-25 22:11:48 +02004897 empty the current or last used history
Bram Moolenaar30b65812012-07-12 22:01:11 +02004898 The {history} string does not need to be the whole name, one
4899 character is sufficient.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 If {item} does already exist in the history, it will be
4901 shifted to become the newest entry.
4902 The result is a Number: 1 if the operation was successful,
4903 otherwise 0 is returned.
4904
4905 Example: >
4906 :call histadd("input", strftime("%Y %b %d"))
4907 :let date=input("Enter date: ")
4908< This function is not available in the |sandbox|.
4909
4910histdel({history} [, {item}]) *histdel()*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00004911 Clear {history}, i.e. delete all its entries. See |hist-names|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912 for the possible values of {history}.
4913
Bram Moolenaarc236c162008-07-13 17:41:49 +00004914 If the parameter {item} evaluates to a String, it is used as a
4915 regular expression. All entries matching that expression will
4916 be removed from the history (if there are any).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917 Upper/lowercase must match, unless "\c" is used |/\c|.
Bram Moolenaarc236c162008-07-13 17:41:49 +00004918 If {item} evaluates to a Number, it will be interpreted as
4919 an index, see |:history-indexing|. The respective entry will
4920 be removed if it exists.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921
4922 The result is a Number: 1 for a successful operation,
4923 otherwise 0 is returned.
4924
4925 Examples:
4926 Clear expression register history: >
4927 :call histdel("expr")
4928<
4929 Remove all entries starting with "*" from the search history: >
4930 :call histdel("/", '^\*')
4931<
4932 The following three are equivalent: >
4933 :call histdel("search", histnr("search"))
4934 :call histdel("search", -1)
4935 :call histdel("search", '^'.histget("search", -1).'$')
4936<
4937 To delete the last search pattern and use the last-but-one for
4938 the "n" command and 'hlsearch': >
4939 :call histdel("search", -1)
4940 :let @/ = histget("search", -1)
4941
4942histget({history} [, {index}]) *histget()*
4943 The result is a String, the entry with Number {index} from
4944 {history}. See |hist-names| for the possible values of
4945 {history}, and |:history-indexing| for {index}. If there is
4946 no such entry, an empty String is returned. When {index} is
4947 omitted, the most recent item from the history is used.
4948
4949 Examples:
4950 Redo the second last search from history. >
4951 :execute '/' . histget("search", -2)
4952
4953< Define an Ex command ":H {num}" that supports re-execution of
4954 the {num}th entry from the output of |:history|. >
4955 :command -nargs=1 H execute histget("cmd", 0+<args>)
4956<
4957histnr({history}) *histnr()*
4958 The result is the Number of the current entry in {history}.
4959 See |hist-names| for the possible values of {history}.
4960 If an error occurred, -1 is returned.
4961
4962 Example: >
4963 :let inp_index = histnr("expr")
4964<
4965hlexists({name}) *hlexists()*
4966 The result is a Number, which is non-zero if a highlight group
4967 called {name} exists. This is when the group has been
4968 defined in some way. Not necessarily when highlighting has
4969 been defined for it, it may also have been used for a syntax
4970 item.
4971 *highlight_exists()*
4972 Obsolete name: highlight_exists().
4973
4974 *hlID()*
4975hlID({name}) The result is a Number, which is the ID of the highlight group
4976 with name {name}. When the highlight group doesn't exist,
4977 zero is returned.
4978 This can be used to retrieve information about the highlight
Bram Moolenaar58b85342016-08-14 19:54:54 +02004979 group. For example, to get the background color of the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 "Comment" group: >
4981 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
4982< *highlightID()*
4983 Obsolete name: highlightID().
4984
4985hostname() *hostname()*
4986 The result is a String, which is the name of the machine on
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00004987 which Vim is currently running. Machine names greater than
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 256 characters long are truncated.
4989
4990iconv({expr}, {from}, {to}) *iconv()*
4991 The result is a String, which is the text {expr} converted
4992 from encoding {from} to encoding {to}.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004993 When the conversion completely fails an empty string is
4994 returned. When some characters could not be converted they
4995 are replaced with "?".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 The encoding names are whatever the iconv() library function
4997 can accept, see ":!man 3 iconv".
4998 Most conversions require Vim to be compiled with the |+iconv|
4999 feature. Otherwise only UTF-8 to latin1 conversion and back
5000 can be done.
5001 This can be used to display messages with special characters,
5002 no matter what 'encoding' is set to. Write the message in
5003 UTF-8 and use: >
5004 echo iconv(utf8_str, "utf-8", &enc)
5005< Note that Vim uses UTF-8 for all Unicode encodings, conversion
5006 from/to UCS-2 is automatically changed to use UTF-8. You
5007 cannot use UCS-2 in a string anyway, because of the NUL bytes.
Bram Moolenaardb84e452010-08-15 13:50:43 +02005008 {only available when compiled with the |+multi_byte| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009
5010 *indent()*
5011indent({lnum}) The result is a Number, which is indent of line {lnum} in the
5012 current buffer. The indent is counted in spaces, the value
5013 of 'tabstop' is relevant. {lnum} is used just like in
5014 |getline()|.
5015 When {lnum} is invalid -1 is returned.
5016
Bram Moolenaarde8866b2005-01-06 23:24:37 +00005017
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005018index({list}, {expr} [, {start} [, {ic}]]) *index()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005019 Return the lowest index in |List| {list} where the item has a
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005020 value equal to {expr}. There is no automatic conversion, so
5021 the String "4" is different from the Number 4. And the number
5022 4 is different from the Float 4.0. The value of 'ignorecase'
5023 is not used here, case always matters.
Bram Moolenaar748bf032005-02-02 23:04:36 +00005024 If {start} is given then start looking at the item with index
5025 {start} (may be negative for an item relative to the end).
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005026 When {ic} is given and it is |TRUE|, ignore case. Otherwise
Bram Moolenaarde8866b2005-01-06 23:24:37 +00005027 case must match.
5028 -1 is returned when {expr} is not found in {list}.
5029 Example: >
5030 :let idx = index(words, "the")
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00005031 :if index(numbers, 123) >= 0
Bram Moolenaarde8866b2005-01-06 23:24:37 +00005032
5033
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00005034input({prompt} [, {text} [, {completion}]]) *input()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035 The result is a String, which is whatever the user typed on
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005036 the command-line. The {prompt} argument is either a prompt
5037 string, or a blank string (for no prompt). A '\n' can be used
5038 in the prompt to start a new line.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00005039 The highlighting set with |:echohl| is used for the prompt.
5040 The input is entered just like a command-line, with the same
Bram Moolenaar58b85342016-08-14 19:54:54 +02005041 editing commands and mappings. There is a separate history
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00005042 for lines typed for input().
5043 Example: >
5044 :if input("Coffee or beer? ") == "beer"
5045 : echo "Cheers!"
5046 :endif
5047<
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005048 If the optional {text} argument is present and not empty, this
5049 is used for the default reply, as if the user typed this.
5050 Example: >
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00005051 :let color = input("Color? ", "white")
5052
5053< The optional {completion} argument specifies the type of
5054 completion supported for the input. Without it completion is
Bram Moolenaar58b85342016-08-14 19:54:54 +02005055 not performed. The supported completion types are the same as
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00005056 that can be supplied to a user-defined command using the
Bram Moolenaar58b85342016-08-14 19:54:54 +02005057 "-complete=" argument. Refer to |:command-completion| for
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00005058 more information. Example: >
5059 let fname = input("File: ", "", "file")
5060<
5061 NOTE: This function must not be used in a startup file, for
5062 the versions that only run in GUI mode (e.g., the Win32 GUI).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063 Note: When input() is called from within a mapping it will
5064 consume remaining characters from that mapping, because a
5065 mapping is handled like the characters were typed.
5066 Use |inputsave()| before input() and |inputrestore()|
5067 after input() to avoid that. Another solution is to avoid
5068 that further characters follow in the mapping, e.g., by using
5069 |:execute| or |:normal|.
5070
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00005071 Example with a mapping: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR>
5073 :function GetFoo()
5074 : call inputsave()
5075 : let g:Foo = input("enter search pattern: ")
5076 : call inputrestore()
5077 :endfunction
5078
5079inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005080 Like |input()|, but when the GUI is running and text dialogs
5081 are supported, a dialog window pops up to input the text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 Example: >
Bram Moolenaar2d17fa32012-10-21 00:45:18 +02005083 :let n = inputdialog("value for shiftwidth", shiftwidth())
5084 :if n != ""
5085 : let &sw = n
5086 :endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005087< When the dialog is cancelled {cancelreturn} is returned. When
5088 omitted an empty string is returned.
5089 Hitting <Enter> works like pressing the OK button. Hitting
5090 <Esc> works like pressing the Cancel button.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00005091 NOTE: Command-line completion is not supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092
Bram Moolenaar578b49e2005-09-10 19:22:57 +00005093inputlist({textlist}) *inputlist()*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005094 {textlist} must be a |List| of strings. This |List| is
5095 displayed, one string per line. The user will be prompted to
5096 enter a number, which is returned.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00005097 The user can also select an item by clicking on it with the
Bram Moolenaar58b85342016-08-14 19:54:54 +02005098 mouse. For the first string 0 is returned. When clicking
Bram Moolenaar578b49e2005-09-10 19:22:57 +00005099 above the first item a negative number is returned. When
5100 clicking on the prompt one more than the length of {textlist}
5101 is returned.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005102 Make sure {textlist} has less than 'lines' entries, otherwise
Bram Moolenaar58b85342016-08-14 19:54:54 +02005103 it won't work. It's a good idea to put the entry number at
Bram Moolenaaref2f6562007-05-06 13:32:59 +00005104 the start of the string. And put a prompt in the first item.
5105 Example: >
Bram Moolenaar578b49e2005-09-10 19:22:57 +00005106 let color = inputlist(['Select color:', '1. red',
5107 \ '2. green', '3. blue'])
5108
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109inputrestore() *inputrestore()*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005110 Restore typeahead that was saved with a previous |inputsave()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 Should be called the same number of times inputsave() is
5112 called. Calling it more often is harmless though.
5113 Returns 1 when there is nothing to restore, 0 otherwise.
5114
5115inputsave() *inputsave()*
5116 Preserve typeahead (also from mappings) and clear it, so that
5117 a following prompt gets input from the user. Should be
5118 followed by a matching inputrestore() after the prompt. Can
5119 be used several times, in which case there must be just as
5120 many inputrestore() calls.
5121 Returns 1 when out of memory, 0 otherwise.
5122
5123inputsecret({prompt} [, {text}]) *inputsecret()*
5124 This function acts much like the |input()| function with but
5125 two exceptions:
5126 a) the user's response will be displayed as a sequence of
5127 asterisks ("*") thereby keeping the entry secret, and
5128 b) the user's response will not be recorded on the input
5129 |history| stack.
5130 The result is a String, which is whatever the user actually
5131 typed on the command-line in response to the issued prompt.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00005132 NOTE: Command-line completion is not supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00005134insert({list}, {item} [, {idx}]) *insert()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005135 Insert {item} at the start of |List| {list}.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00005136 If {idx} is specified insert {item} before the item with index
Bram Moolenaar58b85342016-08-14 19:54:54 +02005137 {idx}. If {idx} is zero it goes before the first item, just
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00005138 like omitting {idx}. A negative {idx} is also possible, see
5139 |list-index|. -1 inserts just before the last item.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005140 Returns the resulting |List|. Examples: >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00005141 :let mylist = insert([2, 3, 5], 1)
5142 :call insert(mylist, 4, -1)
5143 :call insert(mylist, 6, len(mylist))
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005144< The last example can be done simpler with |add()|.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005145 Note that when {item} is a |List| it is inserted as a single
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005146 item. Use |extend()| to concatenate |Lists|.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00005147
Bram Moolenaard6e256c2011-12-14 15:32:50 +01005148invert({expr}) *invert()*
5149 Bitwise invert. The argument is converted to a number. A
5150 List, Dict or Float argument causes an error. Example: >
5151 :let bits = invert(bits)
5152
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153isdirectory({directory}) *isdirectory()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005154 The result is a Number, which is |TRUE| when a directory
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 with the name {directory} exists. If {directory} doesn't
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005156 exist, or isn't a directory, the result is |FALSE|. {directory}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 is any expression, which is used as a String.
5158
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005159islocked({expr}) *islocked()* *E786*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005160 The result is a Number, which is |TRUE| when {expr} is the
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005161 name of a locked variable.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005162 {expr} must be the name of a variable, |List| item or
5163 |Dictionary| entry, not the variable itself! Example: >
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005164 :let alist = [0, ['a', 'b'], 2, 3]
5165 :lockvar 1 alist
5166 :echo islocked('alist') " 1
5167 :echo islocked('alist[1]') " 0
5168
5169< When {expr} is a variable that does not exist you get an error
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00005170 message. Use |exists()| to check for existence.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005171
Bram Moolenaarf3913272016-02-25 00:00:01 +01005172isnan({expr}) *isnan()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005173 Return |TRUE| if {expr} is a float with value NaN. >
Bram Moolenaarf3913272016-02-25 00:00:01 +01005174 echo isnan(0.0 / 0.0)
5175< 1 ~
5176
5177 {only available when compiled with the |+float| feature}
5178
Bram Moolenaar677ee682005-01-27 14:41:15 +00005179items({dict}) *items()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005180 Return a |List| with all the key-value pairs of {dict}. Each
5181 |List| item is a list with two items: the key of a {dict}
5182 entry and the value of this entry. The |List| is in arbitrary
5183 order.
Bram Moolenaar677ee682005-01-27 14:41:15 +00005184
Bram Moolenaar38a55632016-02-15 22:07:32 +01005185job_getchannel({job}) *job_getchannel()*
5186 Get the channel handle that {job} is using.
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01005187 To check if the job has no channel: >
5188 if string(job_getchannel()) == 'channel fail'
5189<
Bram Moolenaar38a55632016-02-15 22:07:32 +01005190 {only available when compiled with the |+job| feature}
5191
Bram Moolenaarf6f32c32016-03-12 19:03:59 +01005192job_info({job}) *job_info()*
5193 Returns a Dictionary with information about {job}:
5194 "status" what |job_status()| returns
5195 "channel" what |job_getchannel()| returns
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02005196 "process" process ID
5197 "tty" controlling terminal name, empty when none
Bram Moolenaarf6f32c32016-03-12 19:03:59 +01005198 "exitval" only valid when "status" is "dead"
Bram Moolenaar975b5272016-03-15 23:10:59 +01005199 "exit_cb" function to be called on exit
Bram Moolenaarf6f32c32016-03-12 19:03:59 +01005200 "stoponexit" |job-stoponexit|
5201
Bram Moolenaar02e83b42016-02-21 20:10:26 +01005202job_setoptions({job}, {options}) *job_setoptions()*
5203 Change options for {job}. Supported are:
Bram Moolenaarf6f32c32016-03-12 19:03:59 +01005204 "stoponexit" |job-stoponexit|
Bram Moolenaar975b5272016-03-15 23:10:59 +01005205 "exit_cb" |job-exit_cb|
Bram Moolenaar02e83b42016-02-21 20:10:26 +01005206
Bram Moolenaar38a55632016-02-15 22:07:32 +01005207job_start({command} [, {options}]) *job_start()*
Bram Moolenaar835dc632016-02-07 14:27:38 +01005208 Start a job and return a Job object. Unlike |system()| and
5209 |:!cmd| this does not wait for the job to finish.
5210
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005211 {command} can be a String. This works best on MS-Windows. On
Bram Moolenaar835dc632016-02-07 14:27:38 +01005212 Unix it is split up in white-separated parts to be passed to
5213 execvp(). Arguments in double quotes can contain white space.
5214
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005215 {command} can be a List, where the first item is the executable
Bram Moolenaar835dc632016-02-07 14:27:38 +01005216 and further items are the arguments. All items are converted
5217 to String. This works best on Unix.
5218
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005219 On MS-Windows, job_start() makes a GUI application hidden. If
5220 want to show it, Use |:!start| instead.
5221
Bram Moolenaar835dc632016-02-07 14:27:38 +01005222 The command is executed directly, not through a shell, the
5223 'shell' option is not used. To use the shell: >
5224 let job = job_start(["/bin/sh", "-c", "echo hello"])
5225< Or: >
5226 let job = job_start('/bin/sh -c "echo hello"')
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005227< Note that this will start two processes, the shell and the
5228 command it executes. If you don't want this use the "exec"
5229 shell command.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005230
5231 On Unix $PATH is used to search for the executable only when
5232 the command does not contain a slash.
5233
5234 The job will use the same terminal as Vim. If it reads from
5235 stdin the job and Vim will be fighting over input, that
5236 doesn't work. Redirect stdin and stdout to avoid problems: >
5237 let job = job_start(['sh', '-c', "myserver </dev/null >/dev/null"])
5238<
5239 The returned Job object can be used to get the status with
5240 |job_status()| and stop the job with |job_stop()|.
5241
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005242 {options} must be a Dictionary. It can contain many optional
5243 items, see |job-options|.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005244
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005245 {only available when compiled with the |+job| feature}
Bram Moolenaar835dc632016-02-07 14:27:38 +01005246
Bram Moolenaar02e83b42016-02-21 20:10:26 +01005247job_status({job}) *job_status()* *E916*
Bram Moolenaar835dc632016-02-07 14:27:38 +01005248 Returns a String with the status of {job}:
5249 "run" job is running
5250 "fail" job failed to start
5251 "dead" job died or was stopped after running
Bram Moolenaar02e83b42016-02-21 20:10:26 +01005252
Bram Moolenaar511972d2016-06-04 18:09:59 +02005253 On Unix a non-existing command results in "dead" instead of
5254 "fail", because a fork happens before the failure can be
5255 detected.
5256
Bram Moolenaar03413f42016-04-12 21:07:15 +02005257 If an exit callback was set with the "exit_cb" option and the
Bram Moolenaar02e83b42016-02-21 20:10:26 +01005258 job is now detected to be "dead" the callback will be invoked.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005259
Bram Moolenaar8950a562016-03-12 15:22:55 +01005260 For more information see |job_info()|.
5261
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005262 {only available when compiled with the |+job| feature}
Bram Moolenaar835dc632016-02-07 14:27:38 +01005263
5264job_stop({job} [, {how}]) *job_stop()*
5265 Stop the {job}. This can also be used to signal the job.
5266
Bram Moolenaar923d9262016-02-25 20:56:01 +01005267 When {how} is omitted or is "term" the job will be terminated.
5268 For Unix SIGTERM is sent. On MS-Windows the job will be
5269 terminated forcedly (there is no "gentle" way).
5270 This goes to the process group, thus children may also be
5271 affected.
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005272
Bram Moolenaar923d9262016-02-25 20:56:01 +01005273 Effect for Unix:
5274 "term" SIGTERM (default)
5275 "hup" SIGHUP
5276 "quit" SIGQUIT
5277 "int" SIGINT
5278 "kill" SIGKILL (strongest way to stop)
5279 number signal with that number
Bram Moolenaar835dc632016-02-07 14:27:38 +01005280
Bram Moolenaar923d9262016-02-25 20:56:01 +01005281 Effect for MS-Windows:
5282 "term" terminate process forcedly (default)
5283 "hup" CTRL_BREAK
5284 "quit" CTRL_BREAK
5285 "int" CTRL_C
5286 "kill" terminate process forcedly
5287 Others CTRL_BREAK
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005288
5289 On Unix the signal is sent to the process group. This means
5290 that when the job is "sh -c command" it affects both the shell
5291 and the command.
5292
Bram Moolenaar835dc632016-02-07 14:27:38 +01005293 The result is a Number: 1 if the operation could be executed,
5294 0 if "how" is not supported on the system.
5295 Note that even when the operation was executed, whether the
5296 job was actually stopped needs to be checked with
Bram Moolenaar45d2cca2017-04-30 16:36:05 +02005297 |job_status()|.
5298
5299 If the status of the job is "dead", the signal will not be
5300 sent. This is to avoid to stop the wrong job (esp. on Unix,
5301 where process numbers are recycled).
5302
5303 When using "kill" Vim will assume the job will die and close
5304 the channel.
Bram Moolenaar835dc632016-02-07 14:27:38 +01005305
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005306 {only available when compiled with the |+job| feature}
Bram Moolenaar835dc632016-02-07 14:27:38 +01005307
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005308join({list} [, {sep}]) *join()*
5309 Join the items in {list} together into one String.
5310 When {sep} is specified it is put in between the items. If
5311 {sep} is omitted a single space is used.
5312 Note that {sep} is not added at the end. You might want to
5313 add it there too: >
5314 let lines = join(mylist, "\n") . "\n"
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005315< String items are used as-is. |Lists| and |Dictionaries| are
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005316 converted into a string like with |string()|.
5317 The opposite function is |split()|.
5318
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01005319js_decode({string}) *js_decode()*
5320 This is similar to |json_decode()| with these differences:
Bram Moolenaar595e64e2016-02-07 19:19:53 +01005321 - Object key names do not have to be in quotes.
Bram Moolenaaree142ad2017-01-11 21:50:08 +01005322 - Strings can be in single quotes.
Bram Moolenaar595e64e2016-02-07 19:19:53 +01005323 - Empty items in an array (between two commas) are allowed and
5324 result in v:none items.
5325
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01005326js_encode({expr}) *js_encode()*
5327 This is similar to |json_encode()| with these differences:
Bram Moolenaar595e64e2016-02-07 19:19:53 +01005328 - Object key names are not in quotes.
5329 - v:none items in an array result in an empty item between
5330 commas.
5331 For example, the Vim object:
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01005332 [1,v:none,{"one":1},v:none] ~
Bram Moolenaar595e64e2016-02-07 19:19:53 +01005333 Will be encoded as:
5334 [1,,{one:1},,] ~
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01005335 While json_encode() would produce:
Bram Moolenaar595e64e2016-02-07 19:19:53 +01005336 [1,null,{"one":1},null] ~
5337 This encoding is valid for JavaScript. It is more efficient
5338 than JSON, especially when using an array with optional items.
5339
5340
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01005341json_decode({string}) *json_decode()*
Bram Moolenaar705ada12016-01-24 17:56:50 +01005342 This parses a JSON formatted string and returns the equivalent
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01005343 in Vim values. See |json_encode()| for the relation between
Bram Moolenaar705ada12016-01-24 17:56:50 +01005344 JSON and Vim values.
5345 The decoding is permissive:
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02005346 - A trailing comma in an array and object is ignored, e.g.
5347 "[1, 2, ]" is the same as "[1, 2]".
Bram Moolenaar705ada12016-01-24 17:56:50 +01005348 - More floating point numbers are recognized, e.g. "1." for
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02005349 "1.0", or "001.2" for "1.2". Special floating point values
5350 "Infinity" and "NaN" (capitalization ignored) are accepted.
5351 - Leading zeroes in integer numbers are ignored, e.g. "012"
5352 for "12" or "-012" for "-12".
5353 - Capitalization is ignored in literal names null, true or
5354 false, e.g. "NULL" for "null", "True" for "true".
5355 - Control characters U+0000 through U+001F which are not
5356 escaped in strings are accepted, e.g. " " (tab
5357 character in string) for "\t".
5358 - Backslash in an invalid 2-character sequence escape is
5359 ignored, e.g. "\a" is decoded as "a".
5360 - A correct surrogate pair in JSON strings should normally be
5361 a 12 character sequence such as "\uD834\uDD1E", but
5362 json_decode() silently accepts truncated surrogate pairs
5363 such as "\uD834" or "\uD834\u"
5364 *E938*
5365 A duplicate key in an object, valid in rfc7159, is not
5366 accepted by json_decode() as the result must be a valid Vim
5367 type, e.g. this fails: {"a":"b", "a":"c"}
5368
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005369
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01005370json_encode({expr}) *json_encode()*
Bram Moolenaar705ada12016-01-24 17:56:50 +01005371 Encode {expr} as JSON and return this as a string.
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005372 The encoding is specified in:
Bram Moolenaar009d84a2016-01-28 14:12:00 +01005373 https://tools.ietf.org/html/rfc7159.html
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005374 Vim values are converted as follows:
5375 Number decimal number
5376 Float floating point number
Bram Moolenaar7ce686c2016-02-27 16:33:22 +01005377 Float nan "NaN"
5378 Float inf "Infinity"
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005379 String in double quotes (possibly null)
Bram Moolenaar705ada12016-01-24 17:56:50 +01005380 Funcref not possible, error
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005381 List as an array (possibly null); when
Bram Moolenaar81edd172016-04-14 13:51:37 +02005382 used recursively: []
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005383 Dict as an object (possibly null); when
Bram Moolenaar81edd172016-04-14 13:51:37 +02005384 used recursively: {}
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005385 v:false "false"
5386 v:true "true"
Bram Moolenaar595e64e2016-02-07 19:19:53 +01005387 v:none "null"
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005388 v:null "null"
Bram Moolenaar7ce686c2016-02-27 16:33:22 +01005389 Note that NaN and Infinity are passed on as values. This is
5390 missing in the JSON standard, but several implementations do
5391 allow it. If not then you will get an error.
Bram Moolenaar520e1e42016-01-23 19:46:28 +01005392
Bram Moolenaard8b02732005-01-14 21:48:43 +00005393keys({dict}) *keys()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005394 Return a |List| with all the keys of {dict}. The |List| is in
Bram Moolenaard8b02732005-01-14 21:48:43 +00005395 arbitrary order.
5396
Bram Moolenaar13065c42005-01-08 16:08:21 +00005397 *len()* *E701*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00005398len({expr}) The result is a Number, which is the length of the argument.
5399 When {expr} is a String or a Number the length in bytes is
5400 used, as with |strlen()|.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005401 When {expr} is a |List| the number of items in the |List| is
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00005402 returned.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005403 When {expr} is a |Dictionary| the number of entries in the
5404 |Dictionary| is returned.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00005405 Otherwise an error is given.
5406
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407 *libcall()* *E364* *E368*
5408libcall({libname}, {funcname}, {argument})
5409 Call function {funcname} in the run-time library {libname}
5410 with single argument {argument}.
5411 This is useful to call functions in a library that you
5412 especially made to be used with Vim. Since only one argument
5413 is possible, calling standard library functions is rather
5414 limited.
5415 The result is the String returned by the function. If the
5416 function returns NULL, this will appear as an empty string ""
5417 to Vim.
5418 If the function returns a number, use libcallnr()!
5419 If {argument} is a number, it is passed to the function as an
5420 int; if {argument} is a string, it is passed as a
5421 null-terminated string.
5422 This function will fail in |restricted-mode|.
5423
5424 libcall() allows you to write your own 'plug-in' extensions to
5425 Vim without having to recompile the program. It is NOT a
5426 means to call system functions! If you try to do so Vim will
5427 very probably crash.
5428
5429 For Win32, the functions you write must be placed in a DLL
5430 and use the normal C calling convention (NOT Pascal which is
5431 used in Windows System DLLs). The function must take exactly
5432 one parameter, either a character pointer or a long integer,
5433 and must return a character pointer or NULL. The character
5434 pointer returned must point to memory that will remain valid
5435 after the function has returned (e.g. in static data in the
5436 DLL). If it points to allocated memory, that memory will
5437 leak away. Using a static buffer in the function should work,
5438 it's then freed when the DLL is unloaded.
5439
5440 WARNING: If the function returns a non-valid pointer, Vim may
Bram Moolenaar446cb832008-06-24 21:56:24 +00005441 crash! This also happens if the function returns a number,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 because Vim thinks it's a pointer.
5443 For Win32 systems, {libname} should be the filename of the DLL
5444 without the ".DLL" suffix. A full path is only required if
5445 the DLL is not in the usual places.
5446 For Unix: When compiling your own plugins, remember that the
5447 object code must be compiled as position-independent ('PIC').
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005448 {only in Win32 and some Unix versions, when the |+libcall|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449 feature is present}
5450 Examples: >
5451 :echo libcall("libc.so", "getenv", "HOME")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452<
5453 *libcallnr()*
5454libcallnr({libname}, {funcname}, {argument})
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005455 Just like |libcall()|, but used for a function that returns an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456 int instead of a string.
5457 {only in Win32 on some Unix versions, when the |+libcall|
5458 feature is present}
Bram Moolenaar446cb832008-06-24 21:56:24 +00005459 Examples: >
5460 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 :call libcallnr("libc.so", "printf", "Hello World!\n")
5462 :call libcallnr("libc.so", "sleep", 10)
5463<
5464 *line()*
5465line({expr}) The result is a Number, which is the line number of the file
5466 position given with {expr}. The accepted positions are:
5467 . the cursor position
5468 $ the last line in the current buffer
5469 'x position of mark x (if the mark is not set, 0 is
5470 returned)
Bram Moolenaara1d5fa62017-04-03 22:02:55 +02005471 w0 first line visible in current window (one if the
5472 display isn't updated, e.g. in silent Ex mode)
5473 w$ last line visible in current window (this is one
5474 less than "w0" if no lines are visible)
Bram Moolenaar9ecd0232008-06-20 15:31:51 +00005475 v In Visual mode: the start of the Visual area (the
5476 cursor is the end). When not in Visual mode
5477 returns the cursor position. Differs from |'<| in
5478 that it's updated right away.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00005479 Note that a mark in another file can be used. The line number
5480 then applies to another buffer.
Bram Moolenaar0b238792006-03-02 22:49:12 +00005481 To get the column number use |col()|. To get both use
5482 |getpos()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 Examples: >
5484 line(".") line number of the cursor
5485 line("'t") line number of mark t
5486 line("'" . marker) line number of mark marker
5487< *last-position-jump*
5488 This autocommand jumps to the last known position in a file
5489 just after opening it, if the '" mark is set: >
Bram Moolenaar3ec574f2017-06-13 18:12:01 +02005490 :au BufReadPost *
Bram Moolenaarf8be4612017-06-23 20:52:40 +02005491 \ if line("'\"") > 1 && line("'\"") <= line("$") && &ft !~# 'commit'
5492 \ | exe "normal! g`\""
5493 \ | endif
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005494
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495line2byte({lnum}) *line2byte()*
5496 Return the byte count from the start of the buffer for line
5497 {lnum}. This includes the end-of-line character, depending on
5498 the 'fileformat' option for the current buffer. The first
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005499 line returns 1. 'encoding' matters, 'fileencoding' is ignored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005500 This can also be used to get the byte count for the line just
5501 below the last line: >
5502 line2byte(line("$") + 1)
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005503< This is the buffer size plus one. If 'fileencoding' is empty
5504 it is the file size plus one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 When {lnum} is invalid, or the |+byte_offset| feature has been
5506 disabled at compile time, -1 is returned.
5507 Also see |byte2line()|, |go| and |:goto|.
5508
5509lispindent({lnum}) *lispindent()*
5510 Get the amount of indent for line {lnum} according the lisp
5511 indenting rules, as with 'lisp'.
5512 The indent is counted in spaces, the value of 'tabstop' is
5513 relevant. {lnum} is used just like in |getline()|.
5514 When {lnum} is invalid or Vim was not compiled the
5515 |+lispindent| feature, -1 is returned.
5516
5517localtime() *localtime()*
5518 Return the current time, measured as seconds since 1st Jan
5519 1970. See also |strftime()| and |getftime()|.
5520
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005521
Bram Moolenaardb7c6862010-05-21 16:33:48 +02005522log({expr}) *log()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02005523 Return the natural logarithm (base e) of {expr} as a |Float|.
5524 {expr} must evaluate to a |Float| or a |Number| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02005525 (0, inf].
5526 Examples: >
5527 :echo log(10)
5528< 2.302585 >
5529 :echo log(exp(5))
5530< 5.0
Bram Moolenaardb84e452010-08-15 13:50:43 +02005531 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02005532
5533
Bram Moolenaar446cb832008-06-24 21:56:24 +00005534log10({expr}) *log10()*
5535 Return the logarithm of Float {expr} to base 10 as a |Float|.
5536 {expr} must evaluate to a |Float| or a |Number|.
5537 Examples: >
5538 :echo log10(1000)
5539< 3.0 >
5540 :echo log10(0.01)
5541< -2.0
5542 {only available when compiled with the |+float| feature}
5543
Bram Moolenaard38b0552012-04-25 19:07:41 +02005544luaeval({expr}[, {expr}]) *luaeval()*
5545 Evaluate Lua expression {expr} and return its result converted
5546 to Vim data structures. Second {expr} may hold additional
5547 argument accessible as _A inside first {expr}.
5548 Strings are returned as they are.
5549 Boolean objects are converted to numbers.
5550 Numbers are converted to |Float| values if vim was compiled
5551 with |+float| and to numbers otherwise.
5552 Dictionaries and lists obtained by vim.eval() are returned
5553 as-is.
5554 Other objects are returned as zero without any errors.
5555 See |lua-luaeval| for more details.
5556 {only available when compiled with the |+lua| feature}
5557
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02005558map({expr1}, {expr2}) *map()*
5559 {expr1} must be a |List| or a |Dictionary|.
5560 Replace each item in {expr1} with the result of evaluating
5561 {expr2}. {expr2} must be a |string| or |Funcref|.
5562
5563 If {expr2} is a |string|, inside {expr2} |v:val| has the value
5564 of the current item. For a |Dictionary| |v:key| has the key
5565 of the current item and for a |List| |v:key| has the index of
5566 the current item.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00005567 Example: >
5568 :call map(mylist, '"> " . v:val . " <"')
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005569< This puts "> " before and " <" after each item in "mylist".
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00005570
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02005571 Note that {expr2} is the result of an expression and is then
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00005572 used as an expression again. Often it is good to use a
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00005573 |literal-string| to avoid having to double backslashes. You
5574 still have to double ' quotes
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00005575
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02005576 If {expr2} is a |Funcref| it is called with two arguments:
5577 1. The key or the index of the current item.
5578 2. the value of the current item.
5579 The function must return the new value of the item. Example
5580 that changes each value by "key-value": >
5581 func KeyValue(key, val)
5582 return a:key . '-' . a:val
5583 endfunc
5584 call map(myDict, function('KeyValue'))
Bram Moolenaar50ba5262016-09-22 22:33:02 +02005585< It is shorter when using a |lambda|: >
5586 call map(myDict, {key, val -> key . '-' . val})
5587< If you do not use "val" you can leave it out: >
5588 call map(myDict, {key -> 'item: ' . key})
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02005589<
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005590 The operation is done in-place. If you want a |List| or
5591 |Dictionary| to remain unmodified make a copy first: >
Bram Moolenaar30b65812012-07-12 22:01:11 +02005592 :let tlist = map(copy(mylist), ' v:val . "\t"')
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00005593
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02005594< Returns {expr1}, the |List| or |Dictionary| that was filtered.
5595 When an error is encountered while evaluating {expr2} no
5596 further items in {expr1} are processed. When {expr2} is a
5597 Funcref errors inside a function are ignored, unless it was
5598 defined with the "abort" flag.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005599
5600
Bram Moolenaarbd743252010-10-20 21:23:33 +02005601maparg({name}[, {mode} [, {abbr} [, {dict}]]]) *maparg()*
5602 When {dict} is omitted or zero: Return the rhs of mapping
5603 {name} in mode {mode}. The returned String has special
5604 characters translated like in the output of the ":map" command
5605 listing.
5606
5607 When there is no mapping for {name}, an empty String is
5608 returned.
5609
5610 The {name} can have special key names, like in the ":map"
5611 command.
5612
Bram Moolenaard12f5c12006-01-25 22:10:52 +00005613 {mode} can be one of these strings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614 "n" Normal
Bram Moolenaarbd743252010-10-20 21:23:33 +02005615 "v" Visual (including Select)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616 "o" Operator-pending
5617 "i" Insert
5618 "c" Cmd-line
Bram Moolenaarbd743252010-10-20 21:23:33 +02005619 "s" Select
5620 "x" Visual
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621 "l" langmap |language-mapping|
5622 "" Normal, Visual and Operator-pending
Bram Moolenaard12f5c12006-01-25 22:10:52 +00005623 When {mode} is omitted, the modes for "" are used.
Bram Moolenaarbd743252010-10-20 21:23:33 +02005624
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005625 When {abbr} is there and it is |TRUE| use abbreviations
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00005626 instead of mappings.
Bram Moolenaarbd743252010-10-20 21:23:33 +02005627
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005628 When {dict} is there and it is |TRUE| return a dictionary
Bram Moolenaarbd743252010-10-20 21:23:33 +02005629 containing all the information of the mapping with the
5630 following items:
5631 "lhs" The {lhs} of the mapping.
5632 "rhs" The {rhs} of the mapping as typed.
5633 "silent" 1 for a |:map-silent| mapping, else 0.
Bram Moolenaar05365702010-10-27 18:34:44 +02005634 "noremap" 1 if the {rhs} of the mapping is not remappable.
Bram Moolenaarbd743252010-10-20 21:23:33 +02005635 "expr" 1 for an expression mapping (|:map-<expr>|).
5636 "buffer" 1 for a buffer local mapping (|:map-local|).
5637 "mode" Modes for which the mapping is defined. In
5638 addition to the modes mentioned above, these
5639 characters will be used:
5640 " " Normal, Visual and Operator-pending
5641 "!" Insert and Commandline mode
Bram Moolenaar166af9b2010-11-16 20:34:40 +01005642 (|mapmode-ic|)
Bram Moolenaar05365702010-10-27 18:34:44 +02005643 "sid" The script local ID, used for <sid> mappings
5644 (|<SID>|).
Bram Moolenaardfb18412013-12-11 18:53:29 +01005645 "nowait" Do not wait for other, longer mappings.
5646 (|:map-<nowait>|).
Bram Moolenaarbd743252010-10-20 21:23:33 +02005647
Bram Moolenaar071d4272004-06-13 20:20:40 +00005648 The mappings local to the current buffer are checked first,
5649 then the global mappings.
Bram Moolenaara40ceaf2006-01-13 22:35:40 +00005650 This function can be used to map a key even when it's already
5651 mapped, and have it do the original mapping too. Sketch: >
5652 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n')
5653
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00005655mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005656 Check if there is a mapping that matches with {name} in mode
5657 {mode}. See |maparg()| for {mode} and special names in
5658 {name}.
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005659 When {abbr} is there and it is |TRUE| use abbreviations
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00005660 instead of mappings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661 A match happens with a mapping that starts with {name} and
5662 with a mapping which is equal to the start of {name}.
5663
Bram Moolenaar446cb832008-06-24 21:56:24 +00005664 matches mapping "a" "ab" "abc" ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665 mapcheck("a") yes yes yes
5666 mapcheck("abc") yes yes yes
5667 mapcheck("ax") yes no no
5668 mapcheck("b") no no no
5669
5670 The difference with maparg() is that mapcheck() finds a
5671 mapping that matches with {name}, while maparg() only finds a
5672 mapping for {name} exactly.
5673 When there is no mapping that starts with {name}, an empty
5674 String is returned. If there is one, the rhs of that mapping
5675 is returned. If there are several mappings that start with
5676 {name}, the rhs of one of them is returned.
5677 The mappings local to the current buffer are checked first,
5678 then the global mappings.
5679 This function can be used to check if a mapping can be added
5680 without being ambiguous. Example: >
5681 :if mapcheck("_vv") == ""
5682 : map _vv :set guifont=7x13<CR>
5683 :endif
5684< This avoids adding the "_vv" mapping when there already is a
5685 mapping for "_v" or for "_vvv".
5686
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00005687match({expr}, {pat}[, {start}[, {count}]]) *match()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005688 When {expr} is a |List| then this returns the index of the
5689 first item where {pat} matches. Each item is used as a
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005690 String, |Lists| and |Dictionaries| are used as echoed.
Bram Moolenaar58b85342016-08-14 19:54:54 +02005691 Otherwise, {expr} is used as a String. The result is a
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005692 Number, which gives the index (byte offset) in {expr} where
5693 {pat} matches.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005694 A match at the first character or |List| item returns zero.
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00005695 If there is no match -1 is returned.
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02005696 For getting submatches see |matchlist()|.
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00005697 Example: >
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005698 :echo match("testing", "ing") " results in 4
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005699 :echo match([1, 'x'], '\a') " results in 1
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005700< See |string-match| for how {pat} is used.
Bram Moolenaar05159a02005-02-26 23:04:13 +00005701 *strpbrk()*
Bram Moolenaar58b85342016-08-14 19:54:54 +02005702 Vim doesn't have a strpbrk() function. But you can do: >
Bram Moolenaar05159a02005-02-26 23:04:13 +00005703 :let sepidx = match(line, '[.,;: \t]')
5704< *strcasestr()*
5705 Vim doesn't have a strcasestr() function. But you can add
5706 "\c" to the pattern to ignore case: >
5707 :let idx = match(haystack, '\cneedle')
5708<
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005709 If {start} is given, the search starts from byte index
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005710 {start} in a String or item {start} in a |List|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005711 The result, however, is still the index counted from the
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005712 first character/item. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005713 :echo match("testing", "ing", 2)
5714< result is again "4". >
5715 :echo match("testing", "ing", 4)
5716< result is again "4". >
5717 :echo match("testing", "t", 2)
5718< result is "3".
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00005719 For a String, if {start} > 0 then it is like the string starts
Bram Moolenaar0b238792006-03-02 22:49:12 +00005720 {start} bytes later, thus "^" will match at {start}. Except
5721 when {count} is given, then it's like matches before the
5722 {start} byte are ignored (this is a bit complicated to keep it
5723 backwards compatible).
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005724 For a String, if {start} < 0, it will be set to 0. For a list
5725 the index is counted from the end.
Bram Moolenaare224ffa2006-03-01 00:01:28 +00005726 If {start} is out of range ({start} > strlen({expr}) for a
5727 String or {start} > len({expr}) for a |List|) -1 is returned.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005728
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00005729 When {count} is given use the {count}'th match. When a match
Bram Moolenaare224ffa2006-03-01 00:01:28 +00005730 is found in a String the search for the next one starts one
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00005731 character further. Thus this example results in 1: >
5732 echo match("testing", "..", 0, 2)
5733< In a |List| the search continues in the next item.
Bram Moolenaar0b238792006-03-02 22:49:12 +00005734 Note that when {count} is added the way {start} works changes,
5735 see above.
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00005736
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737 See |pattern| for the patterns that are accepted.
5738 The 'ignorecase' option is used to set the ignore-caseness of
Bram Moolenaar58b85342016-08-14 19:54:54 +02005739 the pattern. 'smartcase' is NOT used. The matching is always
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 done like 'magic' is set and 'cpoptions' is empty.
5741
Bram Moolenaar6ee10162007-07-26 20:58:42 +00005742 *matchadd()* *E798* *E799* *E801*
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005743matchadd({group}, {pattern}[, {priority}[, {id}[, {dict}]]])
Bram Moolenaar6ee10162007-07-26 20:58:42 +00005744 Defines a pattern to be highlighted in the current window (a
5745 "match"). It will be highlighted with {group}. Returns an
5746 identification number (ID), which can be used to delete the
5747 match using |matchdelete()|.
Bram Moolenaar8e69b4a2013-11-09 03:41:58 +01005748 Matching is case sensitive and magic, unless case sensitivity
5749 or magicness are explicitly overridden in {pattern}. The
5750 'magic', 'smartcase' and 'ignorecase' options are not used.
Bram Moolenaarf9132812015-07-21 19:19:13 +02005751 The "Conceal" value is special, it causes the match to be
5752 concealed.
Bram Moolenaar6ee10162007-07-26 20:58:42 +00005753
5754 The optional {priority} argument assigns a priority to the
Bram Moolenaar58b85342016-08-14 19:54:54 +02005755 match. A match with a high priority will have its
Bram Moolenaar6ee10162007-07-26 20:58:42 +00005756 highlighting overrule that of a match with a lower priority.
5757 A priority is specified as an integer (negative numbers are no
5758 exception). If the {priority} argument is not specified, the
5759 default priority is 10. The priority of 'hlsearch' is zero,
5760 hence all matches with a priority greater than zero will
5761 overrule it. Syntax highlighting (see 'syntax') is a separate
5762 mechanism, and regardless of the chosen priority a match will
5763 always overrule syntax highlighting.
5764
5765 The optional {id} argument allows the request for a specific
5766 match ID. If a specified ID is already taken, an error
5767 message will appear and the match will not be added. An ID
5768 is specified as a positive integer (zero excluded). IDs 1, 2
5769 and 3 are reserved for |:match|, |:2match| and |:3match|,
Bram Moolenaar6561d522015-07-21 15:48:27 +02005770 respectively. If the {id} argument is not specified or -1,
Bram Moolenaar6ee10162007-07-26 20:58:42 +00005771 |matchadd()| automatically chooses a free ID.
5772
Bram Moolenaar85084ef2016-01-17 22:26:33 +01005773 The optional {dict} argument allows for further custom
5774 values. Currently this is used to specify a match specific
Bram Moolenaar6561d522015-07-21 15:48:27 +02005775 conceal character that will be shown for |hl-Conceal|
5776 highlighted matches. The dict can have the following members:
5777
5778 conceal Special character to show instead of the
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005779 match (only for |hl-Conceal| highlighted
Bram Moolenaar6561d522015-07-21 15:48:27 +02005780 matches, see |:syn-cchar|)
5781
Bram Moolenaar6ee10162007-07-26 20:58:42 +00005782 The number of matches is not limited, as it is the case with
5783 the |:match| commands.
5784
5785 Example: >
5786 :highlight MyGroup ctermbg=green guibg=green
5787 :let m = matchadd("MyGroup", "TODO")
5788< Deletion of the pattern: >
5789 :call matchdelete(m)
5790
5791< A list of matches defined by |matchadd()| and |:match| are
Bram Moolenaar58b85342016-08-14 19:54:54 +02005792 available from |getmatches()|. All matches can be deleted in
Bram Moolenaar6ee10162007-07-26 20:58:42 +00005793 one operation by |clearmatches()|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005794
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02005795 *matchaddpos()*
5796matchaddpos({group}, {pos}[, {priority}[, {id}[, {dict}]]])
Bram Moolenaarb3414592014-06-17 17:48:32 +02005797 Same as |matchadd()|, but requires a list of positions {pos}
5798 instead of a pattern. This command is faster than |matchadd()|
5799 because it does not require to handle regular expressions and
5800 sets buffer line boundaries to redraw screen. It is supposed
5801 to be used when fast match additions and deletions are
5802 required, for example to highlight matching parentheses.
5803
5804 The list {pos} can contain one of these items:
Bram Moolenaarb6da44a2014-06-25 18:15:22 +02005805 - A number. This whole line will be highlighted. The first
Bram Moolenaarb3414592014-06-17 17:48:32 +02005806 line has number 1.
5807 - A list with one number, e.g., [23]. The whole line with this
5808 number will be highlighted.
5809 - A list with two numbers, e.g., [23, 11]. The first number is
Bram Moolenaarb6da44a2014-06-25 18:15:22 +02005810 the line number, the second one is the column number (first
5811 column is 1, the value must correspond to the byte index as
5812 |col()| would return). The character at this position will
5813 be highlighted.
Bram Moolenaarb3414592014-06-17 17:48:32 +02005814 - A list with three numbers, e.g., [23, 11, 3]. As above, but
Bram Moolenaarb6da44a2014-06-25 18:15:22 +02005815 the third number gives the length of the highlight in bytes.
Bram Moolenaarb3414592014-06-17 17:48:32 +02005816
5817 The maximum number of positions is 8.
5818
5819 Example: >
5820 :highlight MyGroup ctermbg=green guibg=green
5821 :let m = matchaddpos("MyGroup", [[23, 24], 34])
5822< Deletion of the pattern: >
5823 :call matchdelete(m)
5824
5825< Matches added by |matchaddpos()| are returned by
5826 |getmatches()| with an entry "pos1", "pos2", etc., with the
5827 value a list like the {pos} item.
5828 These matches cannot be set via |setmatches()|, however they
5829 can still be deleted by |clearmatches()|.
5830
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005831matcharg({nr}) *matcharg()*
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005832 Selects the {nr} match item, as set with a |:match|,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005833 |:2match| or |:3match| command.
5834 Return a |List| with two elements:
5835 The name of the highlight group used
5836 The pattern used.
5837 When {nr} is not 1, 2 or 3 returns an empty |List|.
5838 When there is no match item set returns ['', ''].
Bram Moolenaar6ee10162007-07-26 20:58:42 +00005839 This is useful to save and restore a |:match|.
5840 Highlighting matches using the |:match| commands are limited
5841 to three matches. |matchadd()| does not have this limitation.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005842
Bram Moolenaar6ee10162007-07-26 20:58:42 +00005843matchdelete({id}) *matchdelete()* *E802* *E803*
5844 Deletes a match with ID {id} previously defined by |matchadd()|
Bram Moolenaar446cb832008-06-24 21:56:24 +00005845 or one of the |:match| commands. Returns 0 if successful,
Bram Moolenaar6ee10162007-07-26 20:58:42 +00005846 otherwise -1. See example for |matchadd()|. All matches can
5847 be deleted in one operation by |clearmatches()|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005848
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00005849matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005850 Same as |match()|, but return the index of first character
5851 after the match. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005852 :echo matchend("testing", "ing")
5853< results in "7".
Bram Moolenaar05159a02005-02-26 23:04:13 +00005854 *strspn()* *strcspn()*
5855 Vim doesn't have a strspn() or strcspn() function, but you can
5856 do it with matchend(): >
5857 :let span = matchend(line, '[a-zA-Z]')
5858 :let span = matchend(line, '[^a-zA-Z]')
5859< Except that -1 is returned when there are no matches.
5860
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005861 The {start}, if given, has the same meaning as for |match()|. >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005862 :echo matchend("testing", "ing", 2)
5863< results in "7". >
5864 :echo matchend("testing", "ing", 5)
5865< result is "-1".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005866 When {expr} is a |List| the result is equal to |match()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005867
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00005868matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005869 Same as |match()|, but return a |List|. The first item in the
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00005870 list is the matched string, same as what matchstr() would
5871 return. Following items are submatches, like "\1", "\2", etc.
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005872 in |:substitute|. When an optional submatch didn't match an
5873 empty string is used. Example: >
5874 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')
5875< Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00005876 When there is no match an empty list is returned.
5877
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00005878matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()*
Bram Moolenaar446cb832008-06-24 21:56:24 +00005879 Same as |match()|, but return the matched string. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 :echo matchstr("testing", "ing")
5881< results in "ing".
5882 When there is no match "" is returned.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005883 The {start}, if given, has the same meaning as for |match()|. >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884 :echo matchstr("testing", "ing", 2)
5885< results in "ing". >
5886 :echo matchstr("testing", "ing", 5)
5887< result is "".
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005888 When {expr} is a |List| then the matching item is returned.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005889 The type isn't changed, it's not necessarily a String.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890
Bram Moolenaar7fed5c12016-03-29 23:10:31 +02005891matchstrpos({expr}, {pat}[, {start}[, {count}]]) *matchstrpos()*
5892 Same as |matchstr()|, but return the matched string, the start
5893 position and the end position of the match. Example: >
5894 :echo matchstrpos("testing", "ing")
5895< results in ["ing", 4, 7].
5896 When there is no match ["", -1, -1] is returned.
5897 The {start}, if given, has the same meaning as for |match()|. >
5898 :echo matchstrpos("testing", "ing", 2)
5899< results in ["ing", 4, 7]. >
5900 :echo matchstrpos("testing", "ing", 5)
5901< result is ["", -1, -1].
5902 When {expr} is a |List| then the matching item, the index
5903 of first item where {pat} matches, the start position and the
5904 end position of the match are returned. >
5905 :echo matchstrpos([1, '__x'], '\a')
5906< result is ["x", 1, 2, 3].
5907 The type isn't changed, it's not necessarily a String.
5908
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00005909 *max()*
Bram Moolenaar690afe12017-01-28 18:34:47 +01005910max({expr}) Return the maximum value of all items in {expr}.
5911 {expr} can be a list or a dictionary. For a dictionary,
5912 it returns the maximum of all values in the dictionary.
5913 If {expr} is neither a list nor a dictionary, or one of the
5914 items in {expr} cannot be used as a Number this results in
Bram Moolenaarf8be4612017-06-23 20:52:40 +02005915 an error. An empty |List| or |Dictionary| results in zero.
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00005916
5917 *min()*
Bram Moolenaar690afe12017-01-28 18:34:47 +01005918min({expr}) Return the minimum value of all items in {expr}.
5919 {expr} can be a list or a dictionary. For a dictionary,
5920 it returns the minimum of all values in the dictionary.
5921 If {expr} is neither a list nor a dictionary, or one of the
5922 items in {expr} cannot be used as a Number this results in
Bram Moolenaarf8be4612017-06-23 20:52:40 +02005923 an error. An empty |List| or |Dictionary| results in zero.
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00005924
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00005925 *mkdir()* *E739*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005926mkdir({name} [, {path} [, {prot}]])
5927 Create directory {name}.
5928 If {path} is "p" then intermediate directories are created as
5929 necessary. Otherwise it must be "".
5930 If {prot} is given it is used to set the protection bits of
5931 the new directory. The default is 0755 (rwxr-xr-x: r/w for
Bram Moolenaar58b85342016-08-14 19:54:54 +02005932 the user readable for others). Use 0700 to make it unreadable
Bram Moolenaared39e1d2008-08-09 17:55:22 +00005933 for others. This is only used for the last part of {name}.
5934 Thus if you create /tmp/foo/bar then /tmp/foo will be created
5935 with 0755.
5936 Example: >
5937 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700)
5938< This function is not available in the |sandbox|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005939 Not available on all systems. To check use: >
5940 :if exists("*mkdir")
5941<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005942 *mode()*
Bram Moolenaar446cb832008-06-24 21:56:24 +00005943mode([expr]) Return a string that indicates the current mode.
Bram Moolenaar05bb9532008-07-04 09:44:11 +00005944 If [expr] is supplied and it evaluates to a non-zero Number or
5945 a non-empty String (|non-zero-arg|), then the full mode is
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005946 returned, otherwise only the first letter is returned.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005947
Bram Moolenaar071d4272004-06-13 20:20:40 +00005948 n Normal
Bram Moolenaar446cb832008-06-24 21:56:24 +00005949 no Operator-pending
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 v Visual by character
5951 V Visual by line
5952 CTRL-V Visual blockwise
5953 s Select by character
5954 S Select by line
5955 CTRL-S Select blockwise
5956 i Insert
Bram Moolenaare90858d2017-02-01 17:24:34 +01005957 ic Insert mode completion |compl-generic|
5958 ix Insert mode |i_CTRL-X| completion
Bram Moolenaar446cb832008-06-24 21:56:24 +00005959 R Replace |R|
Bram Moolenaare90858d2017-02-01 17:24:34 +01005960 Rc Replace mode completion |compl-generic|
Bram Moolenaar446cb832008-06-24 21:56:24 +00005961 Rv Virtual Replace |gR|
Bram Moolenaare90858d2017-02-01 17:24:34 +01005962 Rx Replace mode |i_CTRL-X| completion
5963 c Command-line editing
Bram Moolenaar446cb832008-06-24 21:56:24 +00005964 cv Vim Ex mode |gQ|
5965 ce Normal Ex mode |Q|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005966 r Hit-enter prompt
Bram Moolenaar446cb832008-06-24 21:56:24 +00005967 rm The -- more -- prompt
5968 r? A |:confirm| query of some sort
5969 ! Shell or external command is executing
5970 This is useful in the 'statusline' option or when used
5971 with |remote_expr()| In most other places it always returns
5972 "c" or "n".
5973 Also see |visualmode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974
Bram Moolenaar7e506b62010-01-19 15:55:06 +01005975mzeval({expr}) *mzeval()*
5976 Evaluate MzScheme expression {expr} and return its result
Bram Moolenaard38b0552012-04-25 19:07:41 +02005977 converted to Vim data structures.
Bram Moolenaar7e506b62010-01-19 15:55:06 +01005978 Numbers and strings are returned as they are.
5979 Pairs (including lists and improper lists) and vectors are
5980 returned as Vim |Lists|.
5981 Hash tables are represented as Vim |Dictionary| type with keys
5982 converted to strings.
5983 All other types are converted to string with display function.
5984 Examples: >
5985 :mz (define l (list 1 2 3))
5986 :mz (define h (make-hash)) (hash-set! h "list" l)
5987 :echo mzeval("l")
5988 :echo mzeval("h")
5989<
5990 {only available when compiled with the |+mzscheme| feature}
5991
Bram Moolenaar071d4272004-06-13 20:20:40 +00005992nextnonblank({lnum}) *nextnonblank()*
5993 Return the line number of the first line at or below {lnum}
5994 that is not blank. Example: >
5995 if getline(nextnonblank(1)) =~ "Java"
5996< When {lnum} is invalid or there is no non-blank line at or
5997 below it, zero is returned.
5998 See also |prevnonblank()|.
5999
Bram Moolenaard35d7842013-01-23 17:17:10 +01006000nr2char({expr}[, {utf8}]) *nr2char()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 Return a string with a single character, which has the number
6002 value {expr}. Examples: >
6003 nr2char(64) returns "@"
6004 nr2char(32) returns " "
Bram Moolenaard35d7842013-01-23 17:17:10 +01006005< When {utf8} is omitted or zero, the current 'encoding' is used.
6006 Example for "utf-8": >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007 nr2char(300) returns I with bow character
Bram Moolenaard35d7842013-01-23 17:17:10 +01006008< With {utf8} set to 1, always return utf-8 characters.
6009 Note that a NUL character in the file is specified with
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 nr2char(10), because NULs are represented with newline
6011 characters. nr2char(0) is a real NUL and terminates the
Bram Moolenaar383f9bc2005-01-19 22:18:32 +00006012 string, thus results in an empty string.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013
Bram Moolenaard6e256c2011-12-14 15:32:50 +01006014or({expr}, {expr}) *or()*
6015 Bitwise OR on the two arguments. The arguments are converted
6016 to a number. A List, Dict or Float argument causes an error.
6017 Example: >
6018 :let bits = or(bits, 0x80)
6019
6020
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006021pathshorten({expr}) *pathshorten()*
6022 Shorten directory names in the path {expr} and return the
6023 result. The tail, the file name, is kept as-is. The other
6024 components in the path are reduced to single letters. Leading
6025 '~' and '.' characters are kept. Example: >
6026 :echo pathshorten('~/.vim/autoload/myfile.vim')
6027< ~/.v/a/myfile.vim ~
6028 It doesn't matter if the path exists or not.
6029
Bram Moolenaare9b892e2016-01-17 21:15:58 +01006030perleval({expr}) *perleval()*
6031 Evaluate Perl expression {expr} in scalar context and return
6032 its result converted to Vim data structures. If value can't be
Bram Moolenaar85084ef2016-01-17 22:26:33 +01006033 converted, it is returned as a string Perl representation.
6034 Note: If you want an array or hash, {expr} must return a
6035 reference to it.
Bram Moolenaare9b892e2016-01-17 21:15:58 +01006036 Example: >
6037 :echo perleval('[1 .. 4]')
6038< [1, 2, 3, 4]
6039 {only available when compiled with the |+perl| feature}
6040
Bram Moolenaar446cb832008-06-24 21:56:24 +00006041pow({x}, {y}) *pow()*
6042 Return the power of {x} to the exponent {y} as a |Float|.
6043 {x} and {y} must evaluate to a |Float| or a |Number|.
6044 Examples: >
6045 :echo pow(3, 3)
6046< 27.0 >
6047 :echo pow(2, 16)
6048< 65536.0 >
6049 :echo pow(32, 0.20)
6050< 2.0
6051 {only available when compiled with the |+float| feature}
6052
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00006053prevnonblank({lnum}) *prevnonblank()*
6054 Return the line number of the first line at or above {lnum}
6055 that is not blank. Example: >
6056 let ind = indent(prevnonblank(v:lnum - 1))
6057< When {lnum} is invalid or there is no non-blank line at or
6058 above it, zero is returned.
6059 Also see |nextnonblank()|.
6060
6061
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006062printf({fmt}, {expr1} ...) *printf()*
6063 Return a String with {fmt}, where "%" items are replaced by
6064 the formatted form of their respective arguments. Example: >
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006065 printf("%4d: E%d %.30s", lnum, errno, msg)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006066< May result in:
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006067 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006068
6069 Often used items are:
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006070 %s string
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01006071 %6S string right-aligned in 6 display cells
Bram Moolenaar98692072006-02-04 00:57:42 +00006072 %6s string right-aligned in 6 bytes
Bram Moolenaar446cb832008-06-24 21:56:24 +00006073 %.9s string truncated to 9 bytes
6074 %c single byte
6075 %d decimal number
6076 %5d decimal number padded with spaces to 5 characters
6077 %x hex number
6078 %04x hex number padded with zeros to at least 4 characters
6079 %X hex number using upper case letters
6080 %o octal number
Bram Moolenaar91984b92016-08-16 21:58:41 +02006081 %08b binary number padded with zeros to at least 8 chars
Bram Moolenaar04186092016-08-29 21:55:35 +02006082 %f floating point number as 12.23, inf, -inf or nan
6083 %F floating point number as 12.23, INF, -INF or NAN
6084 %e floating point number as 1.23e3, inf, -inf or nan
6085 %E floating point number as 1.23E3, INF, -INF or NAN
Bram Moolenaar446cb832008-06-24 21:56:24 +00006086 %g floating point number, as %f or %e depending on value
Bram Moolenaar3df01732017-02-17 22:47:16 +01006087 %G floating point number, as %F or %E depending on value
Bram Moolenaar446cb832008-06-24 21:56:24 +00006088 %% the % character itself
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006089
6090 Conversion specifications start with '%' and end with the
6091 conversion type. All other characters are copied unchanged to
6092 the result.
6093
6094 The "%" starts a conversion specification. The following
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006095 arguments appear in sequence:
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006096
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006097 % [flags] [field-width] [.precision] type
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006098
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006099 flags
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006100 Zero or more of the following flags:
6101
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006102 # The value should be converted to an "alternate
6103 form". For c, d, and s conversions, this option
6104 has no effect. For o conversions, the precision
6105 of the number is increased to force the first
6106 character of the output string to a zero (except
6107 if a zero value is printed with an explicit
6108 precision of zero).
Bram Moolenaar91984b92016-08-16 21:58:41 +02006109 For b and B conversions, a non-zero result has
6110 the string "0b" (or "0B" for B conversions)
6111 prepended to it.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006112 For x and X conversions, a non-zero result has
6113 the string "0x" (or "0X" for X conversions)
6114 prepended to it.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006115
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006116 0 (zero) Zero padding. For all conversions the converted
6117 value is padded on the left with zeros rather
6118 than blanks. If a precision is given with a
Bram Moolenaar91984b92016-08-16 21:58:41 +02006119 numeric conversion (d, b, B, o, x, and X), the 0
6120 flag is ignored.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006121
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006122 - A negative field width flag; the converted value
6123 is to be left adjusted on the field boundary.
6124 The converted value is padded on the right with
6125 blanks, rather than on the left with blanks or
6126 zeros. A - overrides a 0 if both are given.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006127
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006128 ' ' (space) A blank should be left before a positive
6129 number produced by a signed conversion (d).
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006130
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006131 + A sign must always be placed before a number
Bram Moolenaar58b85342016-08-14 19:54:54 +02006132 produced by a signed conversion. A + overrides
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006133 a space if both are used.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006134
6135 field-width
6136 An optional decimal digit string specifying a minimum
Bram Moolenaar98692072006-02-04 00:57:42 +00006137 field width. If the converted value has fewer bytes
6138 than the field width, it will be padded with spaces on
6139 the left (or right, if the left-adjustment flag has
6140 been given) to fill out the field width.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006141
6142 .precision
6143 An optional precision, in the form of a period '.'
6144 followed by an optional digit string. If the digit
6145 string is omitted, the precision is taken as zero.
6146 This gives the minimum number of digits to appear for
6147 d, o, x, and X conversions, or the maximum number of
Bram Moolenaar98692072006-02-04 00:57:42 +00006148 bytes to be printed from a string for s conversions.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006149 For floating point it is the number of digits after
6150 the decimal point.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006151
6152 type
6153 A character that specifies the type of conversion to
6154 be applied, see below.
6155
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006156 A field width or precision, or both, may be indicated by an
6157 asterisk '*' instead of a digit string. In this case, a
Bram Moolenaar58b85342016-08-14 19:54:54 +02006158 Number argument supplies the field width or precision. A
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006159 negative field width is treated as a left adjustment flag
6160 followed by a positive field width; a negative precision is
6161 treated as though it were missing. Example: >
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006162 :echo printf("%d: %.*s", nr, width, line)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006163< This limits the length of the text used from "line" to
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006164 "width" bytes.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006165
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006166 The conversion specifiers and their meanings are:
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006167
Bram Moolenaar91984b92016-08-16 21:58:41 +02006168 *printf-d* *printf-b* *printf-B* *printf-o*
6169 *printf-x* *printf-X*
6170 dbBoxX The Number argument is converted to signed decimal
6171 (d), unsigned binary (b and B), unsigned octal (o), or
6172 unsigned hexadecimal (x and X) notation. The letters
6173 "abcdef" are used for x conversions; the letters
6174 "ABCDEF" are used for X conversions.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006175 The precision, if any, gives the minimum number of
6176 digits that must appear; if the converted value
6177 requires fewer digits, it is padded on the left with
6178 zeros.
6179 In no case does a non-existent or small field width
6180 cause truncation of a numeric field; if the result of
6181 a conversion is wider than the field width, the field
6182 is expanded to contain the conversion result.
Bram Moolenaar30567352016-08-27 21:25:44 +02006183 The 'h' modifier indicates the argument is 16 bits.
6184 The 'l' modifier indicates the argument is 32 bits.
6185 The 'L' modifier indicates the argument is 64 bits.
6186 Generally, these modifiers are not useful. They are
6187 ignored when type is known from the argument.
6188
6189 i alias for d
6190 D alias for ld
6191 U alias for lu
6192 O alias for lo
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006193
Bram Moolenaar446cb832008-06-24 21:56:24 +00006194 *printf-c*
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006195 c The Number argument is converted to a byte, and the
6196 resulting character is written.
6197
Bram Moolenaar446cb832008-06-24 21:56:24 +00006198 *printf-s*
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006199 s The text of the String argument is used. If a
6200 precision is specified, no more bytes than the number
6201 specified are used.
Bram Moolenaar7571d552016-08-18 22:54:46 +02006202 If the argument is not a String type, it is
6203 automatically converted to text with the same format
6204 as ":echo".
Bram Moolenaar0122c402015-02-03 19:13:34 +01006205 *printf-S*
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01006206 S The text of the String argument is used. If a
6207 precision is specified, no more display cells than the
6208 number specified are used. Without the |+multi_byte|
6209 feature works just like 's'.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006210
Bram Moolenaar446cb832008-06-24 21:56:24 +00006211 *printf-f* *E807*
Bram Moolenaar30567352016-08-27 21:25:44 +02006212 f F The Float argument is converted into a string of the
Bram Moolenaar446cb832008-06-24 21:56:24 +00006213 form 123.456. The precision specifies the number of
6214 digits after the decimal point. When the precision is
6215 zero the decimal point is omitted. When the precision
6216 is not specified 6 is used. A really big number
Bram Moolenaar04186092016-08-29 21:55:35 +02006217 (out of range or dividing by zero) results in "inf"
Bram Moolenaarf8be4612017-06-23 20:52:40 +02006218 or "-inf" with %f (INF or -INF with %F).
6219 "0.0 / 0.0" results in "nan" with %f (NAN with %F).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006220 Example: >
6221 echo printf("%.2f", 12.115)
6222< 12.12
6223 Note that roundoff depends on the system libraries.
6224 Use |round()| when in doubt.
6225
6226 *printf-e* *printf-E*
6227 e E The Float argument is converted into a string of the
6228 form 1.234e+03 or 1.234E+03 when using 'E'. The
6229 precision specifies the number of digits after the
6230 decimal point, like with 'f'.
6231
6232 *printf-g* *printf-G*
6233 g G The Float argument is converted like with 'f' if the
6234 value is between 0.001 (inclusive) and 10000000.0
6235 (exclusive). Otherwise 'e' is used for 'g' and 'E'
6236 for 'G'. When no precision is specified superfluous
6237 zeroes and '+' signs are removed, except for the zero
6238 immediately after the decimal point. Thus 10000000.0
6239 results in 1.0e7.
6240
6241 *printf-%*
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006242 % A '%' is written. No argument is converted. The
6243 complete conversion specification is "%%".
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006244
Bram Moolenaarc236c162008-07-13 17:41:49 +00006245 When a Number argument is expected a String argument is also
6246 accepted and automatically converted.
6247 When a Float or String argument is expected a Number argument
6248 is also accepted and automatically converted.
6249 Any other argument type results in an error message.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006250
Bram Moolenaar83bab712005-08-01 21:58:57 +00006251 *E766* *E767*
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006252 The number of {exprN} arguments must exactly match the number
6253 of "%" items. If there are not sufficient or too many
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006254 arguments an error is given. Up to 18 arguments can be used.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00006255
6256
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00006257pumvisible() *pumvisible()*
6258 Returns non-zero when the popup menu is visible, zero
6259 otherwise. See |ins-completion-menu|.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00006260 This can be used to avoid some things that would remove the
6261 popup menu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262
Bram Moolenaar30b65812012-07-12 22:01:11 +02006263py3eval({expr}) *py3eval()*
6264 Evaluate Python expression {expr} and return its result
6265 converted to Vim data structures.
6266 Numbers and strings are returned as they are (strings are
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01006267 copied though, Unicode strings are additionally converted to
Bram Moolenaar30b65812012-07-12 22:01:11 +02006268 'encoding').
6269 Lists are represented as Vim |List| type.
6270 Dictionaries are represented as Vim |Dictionary| type with
6271 keys converted to strings.
6272 {only available when compiled with the |+python3| feature}
6273
6274 *E858* *E859*
6275pyeval({expr}) *pyeval()*
6276 Evaluate Python expression {expr} and return its result
6277 converted to Vim data structures.
6278 Numbers and strings are returned as they are (strings are
6279 copied though).
6280 Lists are represented as Vim |List| type.
Bram Moolenaard09acef2012-09-21 14:54:30 +02006281 Dictionaries are represented as Vim |Dictionary| type,
6282 non-string keys result in error.
Bram Moolenaar30b65812012-07-12 22:01:11 +02006283 {only available when compiled with the |+python| feature}
6284
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006285pyxeval({expr}) *pyxeval()*
6286 Evaluate Python expression {expr} and return its result
6287 converted to Vim data structures.
6288 Uses Python 2 or 3, see |python_x| and 'pyxversion'.
6289 See also: |pyeval()|, |py3eval()|
6290 {only available when compiled with the |+python| or the
6291 |+python3| feature}
6292
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00006293 *E726* *E727*
Bram Moolenaard8b02732005-01-14 21:48:43 +00006294range({expr} [, {max} [, {stride}]]) *range()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006295 Returns a |List| with Numbers:
Bram Moolenaard8b02732005-01-14 21:48:43 +00006296 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
6297 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
6298 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
6299 {max}] (increasing {expr} with {stride} each time, not
6300 producing a value past {max}).
Bram Moolenaare7566042005-06-17 22:00:15 +00006301 When the maximum is one before the start the result is an
6302 empty list. When the maximum is more than one before the
6303 start this is an error.
Bram Moolenaard8b02732005-01-14 21:48:43 +00006304 Examples: >
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006305 range(4) " [0, 1, 2, 3]
Bram Moolenaard8b02732005-01-14 21:48:43 +00006306 range(2, 4) " [2, 3, 4]
6307 range(2, 9, 3) " [2, 5, 8]
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006308 range(2, -2, -1) " [2, 1, 0, -1, -2]
Bram Moolenaare7566042005-06-17 22:00:15 +00006309 range(0) " []
6310 range(2, 0) " error!
Bram Moolenaard8b02732005-01-14 21:48:43 +00006311<
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00006312 *readfile()*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006313readfile({fname} [, {binary} [, {max}]])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006314 Read file {fname} and return a |List|, each line of the file
Bram Moolenaar6100d022016-10-02 16:51:57 +02006315 as an item. Lines are broken at NL characters. Macintosh
6316 files separated with CR will result in a single long line
6317 (unless a NL appears somewhere).
Bram Moolenaar06583f12010-08-07 20:30:49 +02006318 All NUL characters are replaced with a NL character.
Bram Moolenaar86ae7202015-07-10 19:31:35 +02006319 When {binary} contains "b" binary mode is used:
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00006320 - When the last line ends in a NL an extra empty list item is
6321 added.
6322 - No CR characters are removed.
6323 Otherwise:
6324 - CR characters that appear before a NL are removed.
6325 - Whether the last line ends in a NL or not does not matter.
Bram Moolenaar06583f12010-08-07 20:30:49 +02006326 - When 'encoding' is Unicode any UTF-8 byte order mark is
6327 removed from the text.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006328 When {max} is given this specifies the maximum number of lines
6329 to be read. Useful if you only want to check the first ten
6330 lines of a file: >
6331 :for line in readfile(fname, '', 10)
6332 : if line =~ 'Date' | echo line | endif
6333 :endfor
Bram Moolenaar582fd852005-03-28 20:58:01 +00006334< When {max} is negative -{max} lines from the end of the file
6335 are returned, or as many as there are.
6336 When {max} is zero the result is an empty list.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006337 Note that without {max} the whole file is read into memory.
6338 Also note that there is no recognition of encoding. Read a
6339 file into a buffer if you need to.
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00006340 When the file can't be opened an error message is given and
6341 the result is an empty list.
6342 Also see |writefile()|.
6343
Bram Moolenaar433f7c82006-03-21 21:29:36 +00006344reltime([{start} [, {end}]]) *reltime()*
6345 Return an item that represents a time value. The format of
6346 the item depends on the system. It can be passed to
Bram Moolenaar03413f42016-04-12 21:07:15 +02006347 |reltimestr()| to convert it to a string or |reltimefloat()|
6348 to convert to a Float.
Bram Moolenaar433f7c82006-03-21 21:29:36 +00006349 Without an argument it returns the current time.
6350 With one argument is returns the time passed since the time
6351 specified in the argument.
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00006352 With two arguments it returns the time passed between {start}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00006353 and {end}.
6354 The {start} and {end} arguments must be values returned by
6355 reltime().
Bram Moolenaardb84e452010-08-15 13:50:43 +02006356 {only available when compiled with the |+reltime| feature}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00006357
Bram Moolenaar03413f42016-04-12 21:07:15 +02006358reltimefloat({time}) *reltimefloat()*
6359 Return a Float that represents the time value of {time}.
6360 Example: >
6361 let start = reltime()
6362 call MyFunction()
6363 let seconds = reltimefloat(reltime(start))
6364< See the note of reltimestr() about overhead.
6365 Also see |profiling|.
6366 {only available when compiled with the |+reltime| feature}
6367
Bram Moolenaar433f7c82006-03-21 21:29:36 +00006368reltimestr({time}) *reltimestr()*
6369 Return a String that represents the time value of {time}.
6370 This is the number of seconds, a dot and the number of
6371 microseconds. Example: >
6372 let start = reltime()
6373 call MyFunction()
6374 echo reltimestr(reltime(start))
6375< Note that overhead for the commands will be added to the time.
6376 The accuracy depends on the system.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00006377 Leading spaces are used to make the string align nicely. You
6378 can use split() to remove it. >
6379 echo split(reltimestr(reltime(start)))[0]
6380< Also see |profiling|.
Bram Moolenaardb84e452010-08-15 13:50:43 +02006381 {only available when compiled with the |+reltime| feature}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00006382
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383 *remote_expr()* *E449*
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +01006384remote_expr({server}, {string} [, {idvar} [, {timeout}]])
Bram Moolenaar58b85342016-08-14 19:54:54 +02006385 Send the {string} to {server}. The string is sent as an
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 expression and the result is returned after evaluation.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00006387 The result must be a String or a |List|. A |List| is turned
6388 into a String by joining the items with a line break in
6389 between (not at the end), like with join(expr, "\n").
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +01006390 If {idvar} is present and not empty, it is taken as the name
6391 of a variable and a {serverid} for later use with
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 remote_read() is stored there.
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +01006393 If {timeout} is given the read times out after this many
6394 seconds. Otherwise a timeout of 600 seconds is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 See also |clientserver| |RemoteReply|.
6396 This function is not available in the |sandbox|.
6397 {only available when compiled with the |+clientserver| feature}
6398 Note: Any errors will cause a local error message to be issued
6399 and the result will be the empty string.
6400 Examples: >
6401 :echo remote_expr("gvim", "2+2")
6402 :echo remote_expr("gvim1", "b:current_syntax")
6403<
6404
6405remote_foreground({server}) *remote_foreground()*
6406 Move the Vim server with the name {server} to the foreground.
6407 This works like: >
6408 remote_expr({server}, "foreground()")
6409< Except that on Win32 systems the client does the work, to work
6410 around the problem that the OS doesn't always allow the server
6411 to bring itself to the foreground.
Bram Moolenaar9372a112005-12-06 19:59:18 +00006412 Note: This does not restore the window if it was minimized,
6413 like foreground() does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 This function is not available in the |sandbox|.
6415 {only in the Win32, Athena, Motif and GTK GUI versions and the
6416 Win32 console version}
6417
6418
6419remote_peek({serverid} [, {retvar}]) *remote_peek()*
6420 Returns a positive number if there are available strings
6421 from {serverid}. Copies any reply string into the variable
Bram Moolenaar58b85342016-08-14 19:54:54 +02006422 {retvar} if specified. {retvar} must be a string with the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006423 name of a variable.
6424 Returns zero if none are available.
6425 Returns -1 if something is wrong.
6426 See also |clientserver|.
6427 This function is not available in the |sandbox|.
6428 {only available when compiled with the |+clientserver| feature}
6429 Examples: >
6430 :let repl = ""
6431 :echo "PEEK: ".remote_peek(id, "repl").": ".repl
6432
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +01006433remote_read({serverid}, [{timeout}]) *remote_read()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006434 Return the oldest available reply from {serverid} and consume
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +01006435 it. Unless a {timeout} in seconds is given, it blocks until a
6436 reply is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 See also |clientserver|.
6438 This function is not available in the |sandbox|.
6439 {only available when compiled with the |+clientserver| feature}
6440 Example: >
6441 :echo remote_read(id)
6442<
6443 *remote_send()* *E241*
6444remote_send({server}, {string} [, {idvar}])
Bram Moolenaar58b85342016-08-14 19:54:54 +02006445 Send the {string} to {server}. The string is sent as input
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006446 keys and the function returns immediately. At the Vim server
6447 the keys are not mapped |:map|.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00006448 If {idvar} is present, it is taken as the name of a variable
6449 and a {serverid} for later use with remote_read() is stored
6450 there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 See also |clientserver| |RemoteReply|.
6452 This function is not available in the |sandbox|.
6453 {only available when compiled with the |+clientserver| feature}
Bram Moolenaar7416f3e2017-03-18 18:10:13 +01006454
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 Note: Any errors will be reported in the server and may mess
6456 up the display.
6457 Examples: >
6458 :echo remote_send("gvim", ":DropAndReply ".file, "serverid").
6459 \ remote_read(serverid)
6460
6461 :autocmd NONE RemoteReply *
6462 \ echo remote_read(expand("<amatch>"))
6463 :echo remote_send("gvim", ":sleep 10 | echo ".
6464 \ 'server2client(expand("<client>"), "HELLO")<CR>')
Bram Moolenaara14de3d2005-01-07 21:48:26 +00006465<
Bram Moolenaar7416f3e2017-03-18 18:10:13 +01006466 *remote_startserver()* *E941* *E942*
6467remote_startserver({name})
6468 Become the server {name}. This fails if already running as a
6469 server, when |v:servername| is not empty.
6470 {only available when compiled with the |+clientserver| feature}
6471
Bram Moolenaarde8866b2005-01-06 23:24:37 +00006472remove({list}, {idx} [, {end}]) *remove()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006473 Without {end}: Remove the item at {idx} from |List| {list} and
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006474 return the item.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00006475 With {end}: Remove items from {idx} to {end} (inclusive) and
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006476 return a List with these items. When {idx} points to the same
Bram Moolenaarde8866b2005-01-06 23:24:37 +00006477 item as {end} a list with one item is returned. When {end}
6478 points to an item before {idx} this is an error.
6479 See |list-index| for possible values of {idx} and {end}.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00006480 Example: >
6481 :echo "last item: " . remove(mylist, -1)
Bram Moolenaarde8866b2005-01-06 23:24:37 +00006482 :call remove(mylist, 0, 9)
Bram Moolenaard8b02732005-01-14 21:48:43 +00006483remove({dict}, {key})
6484 Remove the entry from {dict} with key {key}. Example: >
6485 :echo "removed " . remove(dict, "one")
6486< If there is no {key} in {dict} this is an error.
6487
6488 Use |delete()| to remove a file.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00006489
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490rename({from}, {to}) *rename()*
6491 Rename the file by the name {from} to the name {to}. This
6492 should also work to move files across file systems. The
6493 result is a Number, which is 0 if the file was renamed
6494 successfully, and non-zero when the renaming failed.
Bram Moolenaar798b30b2009-04-22 10:56:16 +00006495 NOTE: If {to} exists it is overwritten without warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496 This function is not available in the |sandbox|.
6497
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00006498repeat({expr}, {count}) *repeat()*
6499 Repeat {expr} {count} times and return the concatenated
6500 result. Example: >
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00006501 :let separator = repeat('-', 80)
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00006502< When {count} is zero or negative the result is empty.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006503 When {expr} is a |List| the result is {expr} concatenated
Bram Moolenaar58b85342016-08-14 19:54:54 +02006504 {count} times. Example: >
Bram Moolenaarde8866b2005-01-06 23:24:37 +00006505 :let longlist = repeat(['a', 'b'], 3)
6506< Results in ['a', 'b', 'a', 'b', 'a', 'b'].
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00006507
Bram Moolenaara14de3d2005-01-07 21:48:26 +00006508
Bram Moolenaar071d4272004-06-13 20:20:40 +00006509resolve({filename}) *resolve()* *E655*
6510 On MS-Windows, when {filename} is a shortcut (a .lnk file),
6511 returns the path the shortcut points to in a simplified form.
6512 On Unix, repeat resolving symbolic links in all path
6513 components of {filename} and return the simplified result.
6514 To cope with link cycles, resolving of symbolic links is
6515 stopped after 100 iterations.
6516 On other systems, return the simplified {filename}.
6517 The simplification step is done as by |simplify()|.
6518 resolve() keeps a leading path component specifying the
6519 current directory (provided the result is still a relative
6520 path name) and also keeps a trailing path separator.
6521
Bram Moolenaara14de3d2005-01-07 21:48:26 +00006522 *reverse()*
Bram Moolenaar58b85342016-08-14 19:54:54 +02006523reverse({list}) Reverse the order of items in {list} in-place. Returns
Bram Moolenaara14de3d2005-01-07 21:48:26 +00006524 {list}.
6525 If you want a list to remain unmodified make a copy first: >
6526 :let revlist = reverse(copy(mylist))
6527
Bram Moolenaar446cb832008-06-24 21:56:24 +00006528round({expr}) *round()*
Bram Moolenaarc236c162008-07-13 17:41:49 +00006529 Round off {expr} to the nearest integral value and return it
Bram Moolenaar446cb832008-06-24 21:56:24 +00006530 as a |Float|. If {expr} lies halfway between two integral
6531 values, then use the larger one (away from zero).
6532 {expr} must evaluate to a |Float| or a |Number|.
6533 Examples: >
6534 echo round(0.456)
6535< 0.0 >
6536 echo round(4.5)
6537< 5.0 >
6538 echo round(-4.5)
6539< -5.0
6540 {only available when compiled with the |+float| feature}
Bram Moolenaar34feacb2012-12-05 19:01:43 +01006541
Bram Moolenaar9a773482013-06-11 18:40:13 +02006542screenattr(row, col) *screenattr()*
Bram Moolenaar36f44c22016-08-28 18:17:20 +02006543 Like |screenchar()|, but return the attribute. This is a rather
Bram Moolenaar9a773482013-06-11 18:40:13 +02006544 arbitrary number that can only be used to compare to the
6545 attribute at other positions.
6546
6547screenchar(row, col) *screenchar()*
6548 The result is a Number, which is the character at position
6549 [row, col] on the screen. This works for every possible
6550 screen position, also status lines, window separators and the
6551 command line. The top left position is row one, column one
6552 The character excludes composing characters. For double-byte
6553 encodings it may only be the first byte.
6554 This is mainly to be used for testing.
6555 Returns -1 when row or col is out of range.
6556
Bram Moolenaar34feacb2012-12-05 19:01:43 +01006557screencol() *screencol()*
6558 The result is a Number, which is the current screen column of
6559 the cursor. The leftmost column has number 1.
6560 This function is mainly used for testing.
6561
6562 Note: Always returns the current screen column, thus if used
6563 in a command (e.g. ":echo screencol()") it will return the
6564 column inside the command line, which is 1 when the command is
6565 executed. To get the cursor position in the file use one of
6566 the following mappings: >
6567 nnoremap <expr> GG ":echom ".screencol()."\n"
6568 nnoremap <silent> GG :echom screencol()<CR>
6569<
6570screenrow() *screenrow()*
6571 The result is a Number, which is the current screen row of the
6572 cursor. The top line has number one.
6573 This function is mainly used for testing.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006574 Alternatively you can use |winline()|.
Bram Moolenaar34feacb2012-12-05 19:01:43 +01006575
6576 Note: Same restrictions as with |screencol()|.
6577
Bram Moolenaar76929292008-01-06 19:07:36 +00006578search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579 Search for regexp pattern {pattern}. The search starts at the
Bram Moolenaar383f9bc2005-01-19 22:18:32 +00006580 cursor position (you can use |cursor()| to set it).
Bram Moolenaar65c923a2006-03-03 22:56:30 +00006581
Bram Moolenaar2df58b42012-11-28 18:21:11 +01006582 When a match has been found its line number is returned.
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01006583 If there is no match a 0 is returned and the cursor doesn't
6584 move. No error message is given.
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01006585
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 {flags} is a String, which can contain these character flags:
Bram Moolenaarad4d8a12015-12-28 19:20:36 +01006587 'b' search Backward instead of forward
6588 'c' accept a match at the Cursor position
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00006589 'e' move to the End of the match
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00006590 'n' do Not move the cursor
Bram Moolenaarad4d8a12015-12-28 19:20:36 +01006591 'p' return number of matching sub-Pattern (see below)
6592 's' Set the ' mark at the previous location of the cursor
6593 'w' Wrap around the end of the file
6594 'W' don't Wrap around the end of the file
6595 'z' start searching at the cursor column instead of zero
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
6597
Bram Moolenaar02743632005-07-25 20:42:36 +00006598 If the 's' flag is supplied, the ' mark is set, only if the
6599 cursor is moved. The 's' flag cannot be combined with the 'n'
6600 flag.
6601
Bram Moolenaaref2f6562007-05-06 13:32:59 +00006602 'ignorecase', 'smartcase' and 'magic' are used.
Bram Moolenaarad4d8a12015-12-28 19:20:36 +01006603
Bram Moolenaar85084ef2016-01-17 22:26:33 +01006604 When the 'z' flag is not given, searching always starts in
Bram Moolenaarad4d8a12015-12-28 19:20:36 +01006605 column zero and then matches before the cursor are skipped.
6606 When the 'c' flag is present in 'cpo' the next search starts
6607 after the match. Without the 'c' flag the next search starts
6608 one column further.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00006609
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006610 When the {stopline} argument is given then the search stops
6611 after searching this line. This is useful to restrict the
6612 search to a range of lines. Examples: >
6613 let match = search('(', 'b', line("w0"))
6614 let end = search('END', '', line("w$"))
6615< When {stopline} is used and it is not zero this also implies
6616 that the search does not wrap around the end of the file.
Bram Moolenaar76929292008-01-06 19:07:36 +00006617 A zero value is equal to not giving the argument.
6618
6619 When the {timeout} argument is given the search stops when
Bram Moolenaar58b85342016-08-14 19:54:54 +02006620 more than this many milliseconds have passed. Thus when
Bram Moolenaar76929292008-01-06 19:07:36 +00006621 {timeout} is 500 the search stops after half a second.
6622 The value must not be negative. A zero value is like not
6623 giving the argument.
Bram Moolenaardb84e452010-08-15 13:50:43 +02006624 {only available when compiled with the |+reltime| feature}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006625
Bram Moolenaar362e1a32006-03-06 23:29:24 +00006626 *search()-sub-match*
6627 With the 'p' flag the returned value is one more than the
6628 first sub-match in \(\). One if none of them matched but the
6629 whole pattern did match.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006630 To get the column number too use |searchpos()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00006632 The cursor will be positioned at the match, unless the 'n'
6633 flag is used.
6634
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 Example (goes over all files in the argument list): >
6636 :let n = 1
6637 :while n <= argc() " loop over all files in arglist
6638 : exe "argument " . n
6639 : " start at the last char in the file and wrap for the
6640 : " first search to find match at start of file
6641 : normal G$
6642 : let flags = "w"
6643 : while search("foo", flags) > 0
Bram Moolenaar446cb832008-06-24 21:56:24 +00006644 : s/foo/bar/g
Bram Moolenaar071d4272004-06-13 20:20:40 +00006645 : let flags = "W"
6646 : endwhile
6647 : update " write the file if modified
6648 : let n = n + 1
6649 :endwhile
6650<
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00006651 Example for using some flags: >
6652 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
6653< This will search for the keywords "if", "else", and "endif"
6654 under or after the cursor. Because of the 'p' flag, it
6655 returns 1, 2, or 3 depending on which keyword is found, or 0
6656 if the search fails. With the cursor on the first word of the
6657 line:
6658 if (foo == 0) | let foo = foo + 1 | endif ~
6659 the function returns 1. Without the 'c' flag, the function
6660 finds the "endif" and returns 3. The same thing happens
6661 without the 'e' flag if the cursor is on the "f" of "if".
6662 The 'n' flag tells the function not to move the cursor.
6663
Bram Moolenaar92d640f2005-09-05 22:11:52 +00006664
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006665searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()*
6666 Search for the declaration of {name}.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006667
Bram Moolenaarf75a9632005-09-13 21:20:47 +00006668 With a non-zero {global} argument it works like |gD|, find
6669 first match in the file. Otherwise it works like |gd|, find
6670 first match in the function.
6671
6672 With a non-zero {thisblock} argument matches in a {} block
6673 that ends before the cursor position are ignored. Avoids
6674 finding variable declarations only valid in another scope.
6675
Bram Moolenaar92d640f2005-09-05 22:11:52 +00006676 Moves the cursor to the found match.
6677 Returns zero for success, non-zero for failure.
6678 Example: >
6679 if searchdecl('myvar') == 0
6680 echo getline('.')
6681 endif
6682<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 *searchpair()*
Bram Moolenaar76929292008-01-06 19:07:36 +00006684searchpair({start}, {middle}, {end} [, {flags} [, {skip}
6685 [, {stopline} [, {timeout}]]]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686 Search for the match of a nested start-end pair. This can be
6687 used to find the "endif" that matches an "if", while other
6688 if/endif pairs in between are ignored.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006689 The search starts at the cursor. The default is to search
6690 forward, include 'b' in {flags} to search backward.
6691 If a match is found, the cursor is positioned at it and the
6692 line number is returned. If no match is found 0 or -1 is
6693 returned and the cursor doesn't move. No error message is
6694 given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695
6696 {start}, {middle} and {end} are patterns, see |pattern|. They
6697 must not contain \( \) pairs. Use of \%( \) is allowed. When
6698 {middle} is not empty, it is found when searching from either
6699 direction, but only when not in a nested start-end pair. A
6700 typical use is: >
6701 searchpair('\<if\>', '\<else\>', '\<endif\>')
6702< By leaving {middle} empty the "else" is skipped.
6703
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00006704 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
6705 |search()|. Additionally:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 'r' Repeat until no more matches found; will find the
Bram Moolenaar446cb832008-06-24 21:56:24 +00006707 outer pair. Implies the 'W' flag.
6708 'm' Return number of matches instead of line number with
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00006709 the match; will be > 1 when 'r' is used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006710 Note: it's nearly always a good idea to use the 'W' flag, to
6711 avoid wrapping around the end of the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712
6713 When a match for {start}, {middle} or {end} is found, the
6714 {skip} expression is evaluated with the cursor positioned on
6715 the start of the match. It should return non-zero if this
6716 match is to be skipped. E.g., because it is inside a comment
6717 or a string.
6718 When {skip} is omitted or empty, every match is accepted.
6719 When evaluating {skip} causes an error the search is aborted
6720 and -1 returned.
6721
Bram Moolenaar76929292008-01-06 19:07:36 +00006722 For {stopline} and {timeout} see |search()|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006723
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 The value of 'ignorecase' is used. 'magic' is ignored, the
6725 patterns are used like it's on.
6726
6727 The search starts exactly at the cursor. A match with
6728 {start}, {middle} or {end} at the next character, in the
6729 direction of searching, is the first one found. Example: >
6730 if 1
6731 if 2
6732 endif 2
6733 endif 1
6734< When starting at the "if 2", with the cursor on the "i", and
6735 searching forwards, the "endif 2" is found. When starting on
6736 the character just before the "if 2", the "endif 1" will be
Bram Moolenaar58b85342016-08-14 19:54:54 +02006737 found. That's because the "if 2" will be found first, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 then this is considered to be a nested if/endif from "if 2" to
6739 "endif 2".
6740 When searching backwards and {end} is more than one character,
6741 it may be useful to put "\zs" at the end of the pattern, so
6742 that when the cursor is inside a match with the end it finds
6743 the matching start.
6744
6745 Example, to find the "endif" command in a Vim script: >
6746
6747 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
6748 \ 'getline(".") =~ "^\\s*\""')
6749
6750< The cursor must be at or after the "if" for which a match is
6751 to be found. Note that single-quote strings are used to avoid
6752 having to double the backslashes. The skip expression only
6753 catches comments at the start of a line, not after a command.
6754 Also, a word "en" or "if" halfway a line is considered a
6755 match.
6756 Another example, to search for the matching "{" of a "}": >
6757
6758 :echo searchpair('{', '', '}', 'bW')
6759
6760< This works when the cursor is at or before the "}" for which a
6761 match is to be found. To reject matches that syntax
6762 highlighting recognized as strings: >
6763
6764 :echo searchpair('{', '', '}', 'bW',
6765 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
6766<
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00006767 *searchpairpos()*
Bram Moolenaar76929292008-01-06 19:07:36 +00006768searchpairpos({start}, {middle}, {end} [, {flags} [, {skip}
6769 [, {stopline} [, {timeout}]]]])
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006770 Same as |searchpair()|, but returns a |List| with the line and
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006771 column position of the match. The first element of the |List|
6772 is the line number and the second element is the byte index of
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00006773 the column position of the match. If no match is found,
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02006774 returns [0, 0]. >
6775
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00006776 :let [lnum,col] = searchpairpos('{', '', '}', 'n')
6777<
6778 See |match-parens| for a bigger and more useful example.
6779
Bram Moolenaar76929292008-01-06 19:07:36 +00006780searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()*
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006781 Same as |search()|, but returns a |List| with the line and
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006782 column position of the match. The first element of the |List|
6783 is the line number and the second element is the byte index of
6784 the column position of the match. If no match is found,
6785 returns [0, 0].
Bram Moolenaar362e1a32006-03-06 23:29:24 +00006786 Example: >
6787 :let [lnum, col] = searchpos('mypattern', 'n')
6788
6789< When the 'p' flag is given then there is an extra item with
6790 the sub-pattern match number |search()-sub-match|. Example: >
6791 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
6792< In this example "submatch" is 2 when a lowercase letter is
6793 found |/\l|, 3 when an uppercase letter is found |/\u|.
6794
Bram Moolenaar81edd172016-04-14 13:51:37 +02006795server2client({clientid}, {string}) *server2client()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796 Send a reply string to {clientid}. The most recent {clientid}
6797 that sent a string can be retrieved with expand("<client>").
6798 {only available when compiled with the |+clientserver| feature}
6799 Note:
6800 This id has to be stored before the next command can be
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006801 received. I.e. before returning from the received command and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006802 before calling any commands that waits for input.
6803 See also |clientserver|.
6804 Example: >
6805 :echo server2client(expand("<client>"), "HELLO")
6806<
6807serverlist() *serverlist()*
6808 Return a list of available server names, one per line.
6809 When there are no servers or the information is not available
6810 an empty string is returned. See also |clientserver|.
6811 {only available when compiled with the |+clientserver| feature}
6812 Example: >
6813 :echo serverlist()
6814<
6815setbufvar({expr}, {varname}, {val}) *setbufvar()*
6816 Set option or local variable {varname} in buffer {expr} to
6817 {val}.
6818 This also works for a global or local window option, but it
6819 doesn't work for a global or local window variable.
6820 For a local window option the global value is unchanged.
6821 For the use of {expr}, see |bufname()| above.
6822 Note that the variable name without "b:" must be used.
6823 Examples: >
6824 :call setbufvar(1, "&mod", 1)
6825 :call setbufvar("todo", "myvar", "foobar")
6826< This function is not available in the |sandbox|.
6827
Bram Moolenaar12969c02015-09-08 23:36:10 +02006828setcharsearch({dict}) *setcharsearch()*
Bram Moolenaardbd24b52015-08-11 14:26:19 +02006829 Set the current character search information to {dict},
6830 which contains one or more of the following entries:
6831
6832 char character which will be used for a subsequent
6833 |,| or |;| command; an empty string clears the
6834 character search
6835 forward direction of character search; 1 for forward,
6836 0 for backward
6837 until type of character search; 1 for a |t| or |T|
6838 character search, 0 for an |f| or |F|
6839 character search
6840
6841 This can be useful to save/restore a user's character search
6842 from a script: >
6843 :let prevsearch = getcharsearch()
6844 :" Perform a command which clobbers user's search
6845 :call setcharsearch(prevsearch)
6846< Also see |getcharsearch()|.
6847
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848setcmdpos({pos}) *setcmdpos()*
6849 Set the cursor position in the command line to byte position
Bram Moolenaar58b85342016-08-14 19:54:54 +02006850 {pos}. The first position is 1.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 Use |getcmdpos()| to obtain the current position.
6852 Only works while editing the command line, thus you must use
Bram Moolenaard8b02732005-01-14 21:48:43 +00006853 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For
6854 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is
6855 set after the command line is set to the expression. For
6856 |c_CTRL-R_=| it is set after evaluating the expression but
6857 before inserting the resulting text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 When the number is too big the cursor is put at the end of the
6859 line. A number smaller than one has undefined results.
6860 Returns 0 when successful, 1 when not editing the command
6861 line.
6862
Bram Moolenaar80492532016-03-08 17:08:53 +01006863setfperm({fname}, {mode}) *setfperm()* *chmod*
6864 Set the file permissions for {fname} to {mode}.
6865 {mode} must be a string with 9 characters. It is of the form
6866 "rwxrwxrwx", where each group of "rwx" flags represent, in
6867 turn, the permissions of the owner of the file, the group the
6868 file belongs to, and other users. A '-' character means the
6869 permission is off, any other character means on. Multi-byte
6870 characters are not supported.
6871
6872 For example "rw-r-----" means read-write for the user,
6873 readable by the group, not accessible by others. "xx-x-----"
6874 would do the same thing.
6875
6876 Returns non-zero for success, zero for failure.
6877
6878 To read permissions see |getfperm()|.
6879
6880
Bram Moolenaar446cb832008-06-24 21:56:24 +00006881setline({lnum}, {text}) *setline()*
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01006882 Set line {lnum} of the current buffer to {text}. To insert
6883 lines use |append()|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006884 {lnum} is used like with |getline()|.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006885 When {lnum} is just below the last line the {text} will be
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00006886 added as a new line.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006887 If this succeeds, 0 is returned. If this fails (most likely
6888 because {lnum} is invalid) 1 is returned. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 :call setline(5, strftime("%c"))
Bram Moolenaar446cb832008-06-24 21:56:24 +00006890< When {text} is a |List| then line {lnum} and following lines
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00006891 will be set to the items in the list. Example: >
6892 :call setline(5, ['aaa', 'bbb', 'ccc'])
6893< This is equivalent to: >
Bram Moolenaar53bfca22012-04-13 23:04:47 +02006894 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']]
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00006895 : call setline(n, l)
6896 :endfor
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897< Note: The '[ and '] marks are not set.
6898
Bram Moolenaar58b85342016-08-14 19:54:54 +02006899setloclist({nr}, {list}[, {action}[, {what}]]) *setloclist()*
Bram Moolenaar17c7c012006-01-26 22:25:15 +00006900 Create or replace or add to the location list for window {nr}.
Bram Moolenaar7571d552016-08-18 22:54:46 +02006901 {nr} can be the window number or the |window-ID|.
Bram Moolenaar888ccac2016-06-04 18:49:36 +02006902 When {nr} is zero the current window is used.
6903
6904 For a location list window, the displayed location list is
6905 modified. For an invalid window number {nr}, -1 is returned.
Bram Moolenaar6ee10162007-07-26 20:58:42 +00006906 Otherwise, same as |setqflist()|.
6907 Also see |location-list|.
6908
Bram Moolenaard823fa92016-08-12 16:29:27 +02006909 If the optional {what} dictionary argument is supplied, then
6910 only the items listed in {what} are set. Refer to |setqflist()|
6911 for the list of supported keys in {what}.
6912
Bram Moolenaar6ee10162007-07-26 20:58:42 +00006913setmatches({list}) *setmatches()*
6914 Restores a list of matches saved by |getmatches()|. Returns 0
Bram Moolenaar446cb832008-06-24 21:56:24 +00006915 if successful, otherwise -1. All current matches are cleared
Bram Moolenaar6ee10162007-07-26 20:58:42 +00006916 before the list is restored. See example for |getmatches()|.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00006917
Bram Moolenaar65c923a2006-03-03 22:56:30 +00006918 *setpos()*
6919setpos({expr}, {list})
6920 Set the position for {expr}. Possible values:
6921 . the cursor
6922 'x mark x
6923
Bram Moolenaar493c1782014-05-28 14:34:46 +02006924 {list} must be a |List| with four or five numbers:
Bram Moolenaar65c923a2006-03-03 22:56:30 +00006925 [bufnum, lnum, col, off]
Bram Moolenaar493c1782014-05-28 14:34:46 +02006926 [bufnum, lnum, col, off, curswant]
Bram Moolenaar65c923a2006-03-03 22:56:30 +00006927
Bram Moolenaar58b85342016-08-14 19:54:54 +02006928 "bufnum" is the buffer number. Zero can be used for the
Bram Moolenaarf13e00b2017-01-28 18:23:54 +01006929 current buffer. When setting an uppercase mark "bufnum" is
6930 used for the mark position. For other marks it specifies the
6931 buffer to set the mark in. You can use the |bufnr()| function
6932 to turn a file name into a buffer number.
6933 For setting the cursor and the ' mark "bufnum" is ignored,
6934 since these are associated with a window, not a buffer.
Bram Moolenaardb552d602006-03-23 22:59:57 +00006935 Does not change the jumplist.
Bram Moolenaar65c923a2006-03-03 22:56:30 +00006936
6937 "lnum" and "col" are the position in the buffer. The first
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006938 column is 1. Use a zero "lnum" to delete a mark. If "col" is
6939 smaller than 1 then 1 is used.
Bram Moolenaar65c923a2006-03-03 22:56:30 +00006940
6941 The "off" number is only used when 'virtualedit' is set. Then
6942 it is the offset in screen columns from the start of the
Bram Moolenaard46bbc72007-05-12 14:38:41 +00006943 character. E.g., a position within a <Tab> or after the last
Bram Moolenaar65c923a2006-03-03 22:56:30 +00006944 character.
6945
Bram Moolenaar493c1782014-05-28 14:34:46 +02006946 The "curswant" number is only used when setting the cursor
6947 position. It sets the preferred column for when moving the
6948 cursor vertically. When the "curswant" number is missing the
6949 preferred column is not set. When it is present and setting a
6950 mark position it is not used.
6951
Bram Moolenaardfb18412013-12-11 18:53:29 +01006952 Note that for '< and '> changing the line number may result in
6953 the marks to be effectively be swapped, so that '< is always
6954 before '>.
6955
Bram Moolenaar08250432008-02-13 11:42:46 +00006956 Returns 0 when the position could be set, -1 otherwise.
6957 An error message is given if {expr} is invalid.
6958
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02006959 Also see |getpos()| and |getcurpos()|.
Bram Moolenaar65c923a2006-03-03 22:56:30 +00006960
Bram Moolenaaref2f6562007-05-06 13:32:59 +00006961 This does not restore the preferred column for moving
Bram Moolenaar493c1782014-05-28 14:34:46 +02006962 vertically; if you set the cursor position with this, |j| and
6963 |k| motions will jump to previous columns! Use |cursor()| to
6964 also set the preferred column. Also see the "curswant" key in
6965 |winrestview()|.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00006966
Bram Moolenaard823fa92016-08-12 16:29:27 +02006967setqflist({list} [, {action}[, {what}]]) *setqflist()*
Bram Moolenaar17c7c012006-01-26 22:25:15 +00006968 Create or replace or add to the quickfix list using the items
6969 in {list}. Each item in {list} is a dictionary.
6970 Non-dictionary items in {list} are ignored. Each dictionary
6971 item can contain the following entries:
Bram Moolenaar68b76a62005-03-25 21:53:48 +00006972
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00006973 bufnr buffer number; must be the number of a valid
Bram Moolenaar446cb832008-06-24 21:56:24 +00006974 buffer
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00006975 filename name of a file; only used when "bufnr" is not
Bram Moolenaar446cb832008-06-24 21:56:24 +00006976 present or it is invalid.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00006977 lnum line number in the file
Bram Moolenaar68b76a62005-03-25 21:53:48 +00006978 pattern search pattern used to locate the error
Bram Moolenaar582fd852005-03-28 20:58:01 +00006979 col column number
6980 vcol when non-zero: "col" is visual column
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006981 when zero: "col" is byte index
Bram Moolenaar582fd852005-03-28 20:58:01 +00006982 nr error number
Bram Moolenaar68b76a62005-03-25 21:53:48 +00006983 text description of the error
Bram Moolenaar582fd852005-03-28 20:58:01 +00006984 type single-character error type, 'E', 'W', etc.
Bram Moolenaarf1d21c82017-04-22 21:20:46 +02006985 valid recognized error message
Bram Moolenaar68b76a62005-03-25 21:53:48 +00006986
Bram Moolenaar582fd852005-03-28 20:58:01 +00006987 The "col", "vcol", "nr", "type" and "text" entries are
6988 optional. Either "lnum" or "pattern" entry can be used to
6989 locate a matching error line.
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00006990 If the "filename" and "bufnr" entries are not present or
6991 neither the "lnum" or "pattern" entries are present, then the
6992 item will not be handled as an error line.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00006993 If both "pattern" and "lnum" are present then "pattern" will
6994 be used.
Bram Moolenaarf1d21c82017-04-22 21:20:46 +02006995 If the "valid" entry is not supplied, then the valid flag is
6996 set when "bufnr" is a valid buffer or "filename" exists.
Bram Moolenaar00a927d2010-05-14 23:24:24 +02006997 If you supply an empty {list}, the quickfix list will be
6998 cleared.
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00006999 Note that the list is not exactly the same as what
7000 |getqflist()| returns.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00007001
Bram Moolenaarb6fa30c2017-03-29 14:19:25 +02007002 {action} values: *E927*
7003 'a' The items from {list} are added to the existing
7004 quickfix list. If there is no existing list, then a
7005 new list is created.
Bram Moolenaar511972d2016-06-04 18:09:59 +02007006
Bram Moolenaarb6fa30c2017-03-29 14:19:25 +02007007 'r' The items from the current quickfix list are replaced
7008 with the items from {list}. This can also be used to
7009 clear the list: >
7010 :call setqflist([], 'r')
Bram Moolenaar511972d2016-06-04 18:09:59 +02007011<
Bram Moolenaarb6fa30c2017-03-29 14:19:25 +02007012 'f' All the quickfix lists in the quickfix stack are
7013 freed.
7014
Bram Moolenaar511972d2016-06-04 18:09:59 +02007015 If {action} is not present or is set to ' ', then a new list
7016 is created.
Bram Moolenaar35c54e52005-05-20 21:25:31 +00007017
Bram Moolenaard823fa92016-08-12 16:29:27 +02007018 If the optional {what} dictionary argument is supplied, then
7019 only the items listed in {what} are set. The first {list}
7020 argument is ignored. The following items can be specified in
7021 {what}:
Bram Moolenaar45d2cca2017-04-30 16:36:05 +02007022 context any Vim type can be stored as a context
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02007023 items list of quickfix entries. Same as the {list}
7024 argument.
Bram Moolenaar875feea2017-06-11 16:07:51 +02007025 nr list number in the quickfix stack; zero
7026 means the current quickfix list and '$' means
7027 the last quickfix list
Bram Moolenaard823fa92016-08-12 16:29:27 +02007028 title quickfix list title text
7029 Unsupported keys in {what} are ignored.
7030 If the "nr" item is not present, then the current quickfix list
Bram Moolenaar86f100dc2017-06-28 21:26:27 +02007031 is modified. When creating a new quickfix list, "nr" can be
7032 set to a value one greater than the quickfix stack size.
Bram Moolenaard823fa92016-08-12 16:29:27 +02007033
7034 Examples: >
7035 :call setqflist([], 'r', {'title': 'My search'})
7036 :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
7037<
Bram Moolenaar68b76a62005-03-25 21:53:48 +00007038 Returns zero for success, -1 for failure.
7039
7040 This function can be used to create a quickfix list
7041 independent of the 'errorformat' setting. Use a command like
Bram Moolenaar94237492017-04-23 18:40:21 +02007042 `:cc 1` to jump to the first position.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00007043
7044
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045 *setreg()*
Bram Moolenaare0fa3742016-02-20 15:47:01 +01007046setreg({regname}, {value} [, {options}])
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047 Set the register {regname} to {value}.
Bram Moolenaar5a50c222014-04-02 22:17:10 +02007048 {value} may be any value returned by |getreg()|, including
7049 a |List|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050 If {options} contains "a" or {regname} is upper case,
7051 then the value is appended.
Bram Moolenaarc6485bc2010-07-28 17:02:55 +02007052 {options} can also contain a register type specification:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 "c" or "v" |characterwise| mode
7054 "l" or "V" |linewise| mode
7055 "b" or "<CTRL-V>" |blockwise-visual| mode
7056 If a number immediately follows "b" or "<CTRL-V>" then this is
7057 used as the width of the selection - if it is not specified
7058 then the width of the block is set to the number of characters
Bram Moolenaard46bbc72007-05-12 14:38:41 +00007059 in the longest line (counting a <Tab> as 1 character).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060
7061 If {options} contains no register settings, then the default
Bram Moolenaar5a50c222014-04-02 22:17:10 +02007062 is to use character mode unless {value} ends in a <NL> for
7063 string {value} and linewise mode for list {value}. Blockwise
7064 mode is never selected automatically.
7065 Returns zero for success, non-zero for failure.
7066
7067 *E883*
Bram Moolenaar34401cc2014-08-29 15:12:19 +02007068 Note: you may not use |List| containing more than one item to
Bram Moolenaar5a50c222014-04-02 22:17:10 +02007069 set search and expression registers. Lists containing no
7070 items act like empty strings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007071
7072 Examples: >
7073 :call setreg(v:register, @*)
7074 :call setreg('*', @%, 'ac')
7075 :call setreg('a', "1\n2\n3", 'b5')
7076
7077< This example shows using the functions to save and restore a
Bram Moolenaar5a50c222014-04-02 22:17:10 +02007078 register (note: you may not reliably restore register value
7079 without using the third argument to |getreg()| as without it
7080 newlines are represented as newlines AND Nul bytes are
7081 represented as newlines as well, see |NL-used-for-Nul|). >
7082 :let var_a = getreg('a', 1, 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007083 :let var_amode = getregtype('a')
7084 ....
7085 :call setreg('a', var_a, var_amode)
7086
7087< You can also change the type of a register by appending
7088 nothing: >
7089 :call setreg('a', '', 'al')
7090
Bram Moolenaar06b5d512010-05-22 15:37:44 +02007091settabvar({tabnr}, {varname}, {val}) *settabvar()*
7092 Set tab-local variable {varname} to {val} in tab page {tabnr}.
7093 |t:var|
7094 Note that the variable name without "t:" must be used.
7095 Tabs are numbered starting with one.
Bram Moolenaar06b5d512010-05-22 15:37:44 +02007096 This function is not available in the |sandbox|.
7097
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00007098settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()*
7099 Set option or local variable {varname} in window {winnr} to
7100 {val}.
7101 Tabs are numbered starting with one. For the current tabpage
7102 use |setwinvar()|.
Bram Moolenaar7571d552016-08-18 22:54:46 +02007103 {winnr} can be the window number or the |window-ID|.
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00007104 When {winnr} is zero the current window is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 This also works for a global or local buffer option, but it
7106 doesn't work for a global or local buffer variable.
7107 For a local buffer option the global value is unchanged.
7108 Note that the variable name without "w:" must be used.
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00007109 Examples: >
7110 :call settabwinvar(1, 1, "&list", 0)
7111 :call settabwinvar(3, 2, "myvar", "foobar")
7112< This function is not available in the |sandbox|.
7113
7114setwinvar({nr}, {varname}, {val}) *setwinvar()*
7115 Like |settabwinvar()| for the current tab page.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 Examples: >
7117 :call setwinvar(1, "&list", 0)
7118 :call setwinvar(2, "myvar", "foobar")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119
Bram Moolenaaraf9aeb92013-02-13 17:35:04 +01007120sha256({string}) *sha256()*
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01007121 Returns a String with 64 hex characters, which is the SHA256
Bram Moolenaaraf9aeb92013-02-13 17:35:04 +01007122 checksum of {string}.
7123 {only available when compiled with the |+cryptv| feature}
7124
Bram Moolenaar05bb9532008-07-04 09:44:11 +00007125shellescape({string} [, {special}]) *shellescape()*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007126 Escape {string} for use as a shell command argument.
Bram Moolenaar60a495f2006-10-03 12:44:42 +00007127 On MS-Windows and MS-DOS, when 'shellslash' is not set, it
Bram Moolenaar05bb9532008-07-04 09:44:11 +00007128 will enclose {string} in double quotes and double all double
Bram Moolenaar60a495f2006-10-03 12:44:42 +00007129 quotes within {string}.
Bram Moolenaare381d3d2016-07-07 14:50:41 +02007130 Otherwise it will enclose {string} in single quotes and
7131 replace all "'" with "'\''".
Bram Moolenaar875feea2017-06-11 16:07:51 +02007132
Bram Moolenaar05bb9532008-07-04 09:44:11 +00007133 When the {special} argument is present and it's a non-zero
7134 Number or a non-empty String (|non-zero-arg|), then special
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007135 items such as "!", "%", "#" and "<cword>" will be preceded by
7136 a backslash. This backslash will be removed again by the |:!|
Bram Moolenaar05bb9532008-07-04 09:44:11 +00007137 command.
Bram Moolenaar875feea2017-06-11 16:07:51 +02007138
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007139 The "!" character will be escaped (again with a |non-zero-arg|
7140 {special}) when 'shell' contains "csh" in the tail. That is
7141 because for csh and tcsh "!" is used for history replacement
7142 even when inside single quotes.
Bram Moolenaar875feea2017-06-11 16:07:51 +02007143
7144 With a |non-zero-arg| {special} the <NL> character is also
7145 escaped. When 'shell' containing "csh" in the tail it's
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007146 escaped a second time.
Bram Moolenaar875feea2017-06-11 16:07:51 +02007147
Bram Moolenaar05bb9532008-07-04 09:44:11 +00007148 Example of use with a |:!| command: >
7149 :exe '!dir ' . shellescape(expand('<cfile>'), 1)
7150< This results in a directory listing for the file under the
7151 cursor. Example of use with |system()|: >
7152 :call system("chmod +w -- " . shellescape(expand("%")))
Bram Moolenaar26df0922014-02-23 23:39:13 +01007153< See also |::S|.
Bram Moolenaar60a495f2006-10-03 12:44:42 +00007154
7155
Bram Moolenaar2d17fa32012-10-21 00:45:18 +02007156shiftwidth() *shiftwidth()*
7157 Returns the effective value of 'shiftwidth'. This is the
7158 'shiftwidth' value unless it is zero, in which case it is the
Bram Moolenaar009d84a2016-01-28 14:12:00 +01007159 'tabstop' value. This function was introduced with patch
7160 7.3.694 in 2012, everybody should have it by now.
Bram Moolenaar2d17fa32012-10-21 00:45:18 +02007161
7162
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163simplify({filename}) *simplify()*
7164 Simplify the file name as much as possible without changing
7165 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
7166 Unix) are not resolved. If the first path component in
7167 {filename} designates the current directory, this will be
7168 valid for the result as well. A trailing path separator is
7169 not removed either.
7170 Example: >
7171 simplify("./dir/.././/file/") == "./file/"
7172< Note: The combination "dir/.." is only removed if "dir" is
7173 a searchable directory or does not exist. On Unix, it is also
7174 removed when "dir" is a symbolic link within the same
7175 directory. In order to resolve all the involved symbolic
7176 links before simplifying the path name, use |resolve()|.
7177
Bram Moolenaara14de3d2005-01-07 21:48:26 +00007178
Bram Moolenaar446cb832008-06-24 21:56:24 +00007179sin({expr}) *sin()*
7180 Return the sine of {expr}, measured in radians, as a |Float|.
7181 {expr} must evaluate to a |Float| or a |Number|.
7182 Examples: >
7183 :echo sin(100)
7184< -0.506366 >
7185 :echo sin(-4.01)
7186< 0.763301
7187 {only available when compiled with the |+float| feature}
7188
7189
Bram Moolenaardb7c6862010-05-21 16:33:48 +02007190sinh({expr}) *sinh()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02007191 Return the hyperbolic sine of {expr} as a |Float| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02007192 [-inf, inf].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02007193 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02007194 Examples: >
7195 :echo sinh(0.5)
7196< 0.521095 >
7197 :echo sinh(-0.9)
7198< -1.026517
Bram Moolenaardb84e452010-08-15 13:50:43 +02007199 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02007200
7201
Bram Moolenaar5f894962011-06-19 02:55:37 +02007202sort({list} [, {func} [, {dict}]]) *sort()* *E702*
Bram Moolenaar327aa022014-03-25 18:24:23 +01007203 Sort the items in {list} in-place. Returns {list}.
7204
7205 If you want a list to remain unmodified make a copy first: >
Bram Moolenaara14de3d2005-01-07 21:48:26 +00007206 :let sortedlist = sort(copy(mylist))
Bram Moolenaar822ff862014-06-12 21:46:14 +02007207
Bram Moolenaar946e27a2014-06-25 18:50:27 +02007208< When {func} is omitted, is empty or zero, then sort() uses the
7209 string representation of each item to sort on. Numbers sort
7210 after Strings, |Lists| after Numbers. For sorting text in the
7211 current buffer use |:sort|.
Bram Moolenaar327aa022014-03-25 18:24:23 +01007212
Bram Moolenaar34401cc2014-08-29 15:12:19 +02007213 When {func} is given and it is '1' or 'i' then case is
Bram Moolenaar946e27a2014-06-25 18:50:27 +02007214 ignored.
7215
7216 When {func} is given and it is 'n' then all items will be
7217 sorted numerical (Implementation detail: This uses the
7218 strtod() function to parse numbers, Strings, Lists, Dicts and
7219 Funcrefs will be considered as being 0).
7220
Bram Moolenaarb00da1d2015-12-03 16:33:12 +01007221 When {func} is given and it is 'N' then all items will be
7222 sorted numerical. This is like 'n' but a string containing
7223 digits will be used as the number they represent.
7224
Bram Moolenaar13d5aee2016-01-21 23:36:05 +01007225 When {func} is given and it is 'f' then all items will be
7226 sorted numerical. All values must be a Number or a Float.
7227
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007228 When {func} is a |Funcref| or a function name, this function
7229 is called to compare items. The function is invoked with two
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007230 items as argument and must return zero if they are equal, 1 or
7231 bigger if the first one sorts after the second one, -1 or
7232 smaller if the first one sorts before the second one.
Bram Moolenaar327aa022014-03-25 18:24:23 +01007233
7234 {dict} is for functions with the "dict" attribute. It will be
7235 used to set the local variable "self". |Dictionary-function|
7236
Bram Moolenaar8bb1c3e2014-07-04 16:43:17 +02007237 The sort is stable, items which compare equal (as number or as
7238 string) will keep their relative position. E.g., when sorting
Bram Moolenaardb6ea062014-07-10 22:01:47 +02007239 on numbers, text strings will sort next to each other, in the
Bram Moolenaar8bb1c3e2014-07-04 16:43:17 +02007240 same order as they were originally.
7241
Bram Moolenaar327aa022014-03-25 18:24:23 +01007242 Also see |uniq()|.
7243
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007244 Example: >
Bram Moolenaara14de3d2005-01-07 21:48:26 +00007245 func MyCompare(i1, i2)
7246 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
7247 endfunc
7248 let sortedlist = sort(mylist, "MyCompare")
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007249< A shorter compare version for this specific simple case, which
7250 ignores overflow: >
7251 func MyCompare(i1, i2)
7252 return a:i1 - a:i2
7253 endfunc
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007254<
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007255 *soundfold()*
7256soundfold({word})
7257 Return the sound-folded equivalent of {word}. Uses the first
Bram Moolenaar446cb832008-06-24 21:56:24 +00007258 language in 'spelllang' for the current window that supports
Bram Moolenaar42eeac32005-06-29 22:40:58 +00007259 soundfolding. 'spell' must be set. When no sound folding is
7260 possible the {word} is returned unmodified.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007261 This can be used for making spelling suggestions. Note that
7262 the method can be quite slow.
7263
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007264 *spellbadword()*
Bram Moolenaar1e015462005-09-25 22:16:38 +00007265spellbadword([{sentence}])
7266 Without argument: The result is the badly spelled word under
7267 or after the cursor. The cursor is moved to the start of the
7268 bad word. When no bad word is found in the cursor line the
7269 result is an empty string and the cursor doesn't move.
7270
7271 With argument: The result is the first word in {sentence} that
7272 is badly spelled. If there are no spelling mistakes the
7273 result is an empty string.
7274
7275 The return value is a list with two items:
7276 - The badly spelled word or an empty string.
7277 - The type of the spelling error:
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007278 "bad" spelling mistake
Bram Moolenaar1e015462005-09-25 22:16:38 +00007279 "rare" rare word
7280 "local" word only valid in another region
7281 "caps" word should start with Capital
7282 Example: >
7283 echo spellbadword("the quik brown fox")
7284< ['quik', 'bad'] ~
7285
7286 The spelling information for the current window is used. The
7287 'spell' option must be set and the value of 'spelllang' is
7288 used.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007289
7290 *spellsuggest()*
Bram Moolenaarc54b8a72005-09-30 21:20:29 +00007291spellsuggest({word} [, {max} [, {capital}]])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007292 Return a |List| with spelling suggestions to replace {word}.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007293 When {max} is given up to this number of suggestions are
7294 returned. Otherwise up to 25 suggestions are returned.
7295
Bram Moolenaarc54b8a72005-09-30 21:20:29 +00007296 When the {capital} argument is given and it's non-zero only
7297 suggestions with a leading capital will be given. Use this
7298 after a match with 'spellcapcheck'.
7299
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007300 {word} can be a badly spelled word followed by other text.
7301 This allows for joining two words that were split. The
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00007302 suggestions also include the following text, thus you can
7303 replace a line.
7304
7305 {word} may also be a good word. Similar words will then be
Bram Moolenaarc54b8a72005-09-30 21:20:29 +00007306 returned. {word} itself is not included in the suggestions,
7307 although it may appear capitalized.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007308
7309 The spelling information for the current window is used. The
Bram Moolenaar42eeac32005-06-29 22:40:58 +00007310 'spell' option must be set and the values of 'spelllang' and
7311 'spellsuggest' are used.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007312
Bram Moolenaara14de3d2005-01-07 21:48:26 +00007313
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00007314split({expr} [, {pattern} [, {keepempty}]]) *split()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007315 Make a |List| out of {expr}. When {pattern} is omitted or
7316 empty each white-separated sequence of characters becomes an
7317 item.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00007318 Otherwise the string is split where {pattern} matches,
Bram Moolenaar97d62492012-11-15 21:28:22 +01007319 removing the matched characters. 'ignorecase' is not used
7320 here, add \c to ignore case. |/\c|
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00007321 When the first or last item is empty it is omitted, unless the
7322 {keepempty} argument is given and it's non-zero.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007323 Other empty items are kept when {pattern} matches at least one
7324 character or when {keepempty} is non-zero.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00007325 Example: >
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00007326 :let words = split(getline('.'), '\W\+')
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00007327< To split a string in individual characters: >
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007328 :for c in split(mystring, '\zs')
Bram Moolenaar12969c02015-09-08 23:36:10 +02007329< If you want to keep the separator you can also use '\zs' at
7330 the end of the pattern: >
Bram Moolenaar0cb032e2005-04-23 20:52:00 +00007331 :echo split('abc:def:ghi', ':\zs')
7332< ['abc:', 'def:', 'ghi'] ~
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00007333 Splitting a table where the first element can be empty: >
7334 :let items = split(line, ':', 1)
7335< The opposite function is |join()|.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00007336
7337
Bram Moolenaar446cb832008-06-24 21:56:24 +00007338sqrt({expr}) *sqrt()*
7339 Return the non-negative square root of Float {expr} as a
7340 |Float|.
7341 {expr} must evaluate to a |Float| or a |Number|. When {expr}
7342 is negative the result is NaN (Not a Number).
7343 Examples: >
7344 :echo sqrt(100)
7345< 10.0 >
7346 :echo sqrt(-4.01)
7347< nan
Bram Moolenaarc236c162008-07-13 17:41:49 +00007348 "nan" may be different, it depends on system libraries.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007349 {only available when compiled with the |+float| feature}
7350
7351
Bram Moolenaar81edd172016-04-14 13:51:37 +02007352str2float({expr}) *str2float()*
Bram Moolenaar446cb832008-06-24 21:56:24 +00007353 Convert String {expr} to a Float. This mostly works the same
7354 as when using a floating point number in an expression, see
7355 |floating-point-format|. But it's a bit more permissive.
7356 E.g., "1e40" is accepted, while in an expression you need to
7357 write "1.0e40".
7358 Text after the number is silently ignored.
7359 The decimal point is always '.', no matter what the locale is
7360 set to. A comma ends the number: "12,345.67" is converted to
7361 12.0. You can strip out thousands separators with
7362 |substitute()|: >
7363 let f = str2float(substitute(text, ',', '', 'g'))
7364< {only available when compiled with the |+float| feature}
7365
7366
Bram Moolenaar81edd172016-04-14 13:51:37 +02007367str2nr({expr} [, {base}]) *str2nr()*
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007368 Convert string {expr} to a number.
Bram Moolenaarfa735342016-01-03 22:14:44 +01007369 {base} is the conversion base, it can be 2, 8, 10 or 16.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007370 When {base} is omitted base 10 is used. This also means that
7371 a leading zero doesn't cause octal conversion to be used, as
7372 with the default String to Number conversion.
7373 When {base} is 16 a leading "0x" or "0X" is ignored. With a
Bram Moolenaarfa735342016-01-03 22:14:44 +01007374 different base the result will be zero. Similarly, when
7375 {base} is 8 a leading "0" is ignored, and when {base} is 2 a
7376 leading "0b" or "0B" is ignored.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007377 Text after the number is silently ignored.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007378
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007379
Bram Moolenaar979243b2015-06-26 19:35:49 +02007380strchars({expr} [, {skipcc}]) *strchars()*
Bram Moolenaar72597a52010-07-18 15:31:08 +02007381 The result is a Number, which is the number of characters
Bram Moolenaar979243b2015-06-26 19:35:49 +02007382 in String {expr}.
7383 When {skipcc} is omitted or zero, composing characters are
7384 counted separately.
7385 When {skipcc} set to 1, Composing characters are ignored.
Bram Moolenaardc536092010-07-18 15:45:49 +02007386 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
Bram Moolenaar86ae7202015-07-10 19:31:35 +02007387
7388 {skipcc} is only available after 7.4.755. For backward
7389 compatibility, you can define a wrapper function: >
7390 if has("patch-7.4.755")
7391 function s:strchars(str, skipcc)
7392 return strchars(a:str, a:skipcc)
7393 endfunction
7394 else
7395 function s:strchars(str, skipcc)
7396 if a:skipcc
7397 return strlen(substitute(a:str, ".", "x", "g"))
7398 else
7399 return strchars(a:str)
7400 endif
7401 endfunction
7402 endif
7403<
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007404strcharpart({src}, {start}[, {len}]) *strcharpart()*
7405 Like |strpart()| but using character index and length instead
7406 of byte index and length.
7407 When a character index is used where a character does not
Bram Moolenaar369b6f52017-01-17 12:22:32 +01007408 exist it is assumed to be one character. For example: >
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007409 strcharpart('abc', -1, 2)
7410< results in 'a'.
Bram Moolenaar86ae7202015-07-10 19:31:35 +02007411
Bram Moolenaardc536092010-07-18 15:45:49 +02007412strdisplaywidth({expr}[, {col}]) *strdisplaywidth()*
7413 The result is a Number, which is the number of display cells
Bram Moolenaar979243b2015-06-26 19:35:49 +02007414 String {expr} occupies on the screen when it starts at {col}.
Bram Moolenaardc536092010-07-18 15:45:49 +02007415 When {col} is omitted zero is used. Otherwise it is the
7416 screen column where to start. This matters for Tab
7417 characters.
Bram Moolenaar4d32c2d2010-07-18 22:10:01 +02007418 The option settings of the current window are used. This
7419 matters for anything that's displayed differently, such as
7420 'tabstop' and 'display'.
Bram Moolenaardc536092010-07-18 15:45:49 +02007421 When {expr} contains characters with East Asian Width Class
7422 Ambiguous, this function's return value depends on 'ambiwidth'.
7423 Also see |strlen()|, |strwidth()| and |strchars()|.
Bram Moolenaar72597a52010-07-18 15:31:08 +02007424
Bram Moolenaar071d4272004-06-13 20:20:40 +00007425strftime({format} [, {time}]) *strftime()*
7426 The result is a String, which is a formatted date and time, as
7427 specified by the {format} string. The given {time} is used,
7428 or the current time if no time is given. The accepted
7429 {format} depends on your system, thus this is not portable!
7430 See the manual page of the C function strftime() for the
7431 format. The maximum length of the result is 80 characters.
7432 See also |localtime()| and |getftime()|.
7433 The language can be changed with the |:language| command.
7434 Examples: >
7435 :echo strftime("%c") Sun Apr 27 11:49:23 1997
7436 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
7437 :echo strftime("%y%m%d %T") 970427 11:53:55
7438 :echo strftime("%H:%M") 11:55
7439 :echo strftime("%c", getftime("file.c"))
7440 Show mod time of file.c.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00007441< Not available on all systems. To check use: >
7442 :if exists("*strftime")
7443
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007444strgetchar({str}, {index}) *strgetchar()*
7445 Get character {index} from {str}. This uses a character
7446 index, not a byte index. Composing characters are considered
7447 separate characters here.
7448 Also see |strcharpart()| and |strchars()|.
7449
Bram Moolenaar8f999f12005-01-25 22:12:55 +00007450stridx({haystack}, {needle} [, {start}]) *stridx()*
7451 The result is a Number, which gives the byte index in
7452 {haystack} of the first occurrence of the String {needle}.
Bram Moolenaar677ee682005-01-27 14:41:15 +00007453 If {start} is specified, the search starts at index {start}.
7454 This can be used to find a second match: >
Bram Moolenaar81af9252010-12-10 20:35:50 +01007455 :let colon1 = stridx(line, ":")
7456 :let colon2 = stridx(line, ":", colon1 + 1)
Bram Moolenaar677ee682005-01-27 14:41:15 +00007457< The search is done case-sensitive.
Bram Moolenaare2cc9702005-03-15 22:43:58 +00007458 For pattern searches use |match()|.
Bram Moolenaar8f999f12005-01-25 22:12:55 +00007459 -1 is returned if the {needle} does not occur in {haystack}.
Bram Moolenaar677ee682005-01-27 14:41:15 +00007460 See also |strridx()|.
7461 Examples: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 :echo stridx("An Example", "Example") 3
7463 :echo stridx("Starting point", "Start") 0
7464 :echo stridx("Starting point", "start") -1
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007465< *strstr()* *strchr()*
Bram Moolenaar05159a02005-02-26 23:04:13 +00007466 stridx() works similar to the C function strstr(). When used
7467 with a single character it works similar to strchr().
7468
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00007469 *string()*
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00007470string({expr}) Return {expr} converted to a String. If {expr} is a Number,
Bram Moolenaar446cb832008-06-24 21:56:24 +00007471 Float, String or a composition of them, then the result can be
7472 parsed back with |eval()|.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00007473 {expr} type result ~
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01007474 String 'string' (single quotes are doubled)
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00007475 Number 123
Bram Moolenaar446cb832008-06-24 21:56:24 +00007476 Float 123.123456 or 1.123456e8
Bram Moolenaard8b02732005-01-14 21:48:43 +00007477 Funcref function('name')
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00007478 List [item, item]
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00007479 Dictionary {key: value, key: value}
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01007480
7481 When a List or Dictionary has a recursive reference it is
7482 replaced by "[...]" or "{...}". Using eval() on the result
7483 will then fail.
7484
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007485 Also see |strtrans()|.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00007486
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 *strlen()*
7488strlen({expr}) The result is a Number, which is the length of the String
Bram Moolenaare344bea2005-09-01 20:46:49 +00007489 {expr} in bytes.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00007490 If the argument is a Number it is first converted to a String.
7491 For other types an error is given.
Bram Moolenaar641e48c2015-06-25 16:09:26 +02007492 If you want to count the number of multi-byte characters use
7493 |strchars()|.
7494 Also see |len()|, |strdisplaywidth()| and |strwidth()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495
7496strpart({src}, {start}[, {len}]) *strpart()*
7497 The result is a String, which is part of {src}, starting from
Bram Moolenaar9372a112005-12-06 19:59:18 +00007498 byte {start}, with the byte length {len}.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007499 To count characters instead of bytes use |strcharpart()|.
7500
7501 When bytes are selected which do not exist, this doesn't
7502 result in an error, the bytes are simply omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503 If {len} is missing, the copy continues from {start} till the
7504 end of the {src}. >
7505 strpart("abcdefg", 3, 2) == "de"
7506 strpart("abcdefg", -2, 4) == "ab"
7507 strpart("abcdefg", 5, 4) == "fg"
Bram Moolenaar446cb832008-06-24 21:56:24 +00007508 strpart("abcdefg", 3) == "defg"
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007509
Bram Moolenaar071d4272004-06-13 20:20:40 +00007510< Note: To get the first character, {start} must be 0. For
7511 example, to get three bytes under and after the cursor: >
Bram Moolenaar61660ea2006-04-07 21:40:07 +00007512 strpart(getline("."), col(".") - 1, 3)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513<
Bram Moolenaar677ee682005-01-27 14:41:15 +00007514strridx({haystack}, {needle} [, {start}]) *strridx()*
7515 The result is a Number, which gives the byte index in
7516 {haystack} of the last occurrence of the String {needle}.
7517 When {start} is specified, matches beyond this index are
7518 ignored. This can be used to find a match before a previous
7519 match: >
7520 :let lastcomma = strridx(line, ",")
7521 :let comma2 = strridx(line, ",", lastcomma - 1)
7522< The search is done case-sensitive.
Bram Moolenaar8f999f12005-01-25 22:12:55 +00007523 For pattern searches use |match()|.
7524 -1 is returned if the {needle} does not occur in {haystack}.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007525 If the {needle} is empty the length of {haystack} is returned.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007526 See also |stridx()|. Examples: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527 :echo strridx("an angry armadillo", "an") 3
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007528< *strrchr()*
Bram Moolenaar05159a02005-02-26 23:04:13 +00007529 When used with a single character it works similar to the C
7530 function strrchr().
7531
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532strtrans({expr}) *strtrans()*
7533 The result is a String, which is {expr} with all unprintable
7534 characters translated into printable characters |'isprint'|.
7535 Like they are shown in a window. Example: >
7536 echo strtrans(@a)
7537< This displays a newline in register a as "^@" instead of
7538 starting a new line.
7539
Bram Moolenaar72597a52010-07-18 15:31:08 +02007540strwidth({expr}) *strwidth()*
7541 The result is a Number, which is the number of display cells
7542 String {expr} occupies. A Tab character is counted as one
Bram Moolenaardc536092010-07-18 15:45:49 +02007543 cell, alternatively use |strdisplaywidth()|.
Bram Moolenaar72597a52010-07-18 15:31:08 +02007544 When {expr} contains characters with East Asian Width Class
7545 Ambiguous, this function's return value depends on 'ambiwidth'.
Bram Moolenaardc536092010-07-18 15:45:49 +02007546 Also see |strlen()|, |strdisplaywidth()| and |strchars()|.
Bram Moolenaar72597a52010-07-18 15:31:08 +02007547
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02007548submatch({nr}[, {list}]) *submatch()* *E935*
Bram Moolenaar251e1912011-06-19 05:09:16 +02007549 Only for an expression in a |:substitute| command or
7550 substitute() function.
7551 Returns the {nr}'th submatch of the matched text. When {nr}
7552 is 0 the whole matched text is returned.
Bram Moolenaar41571762014-04-02 19:00:58 +02007553 Note that a NL in the string can stand for a line break of a
7554 multi-line match or a NUL character in the text.
Bram Moolenaar251e1912011-06-19 05:09:16 +02007555 Also see |sub-replace-expression|.
Bram Moolenaar41571762014-04-02 19:00:58 +02007556
7557 If {list} is present and non-zero then submatch() returns
7558 a list of strings, similar to |getline()| with two arguments.
7559 NL characters in the text represent NUL characters in the
7560 text.
7561 Only returns more than one item for |:substitute|, inside
7562 |substitute()| this list will always contain one or zero
7563 items, since there are no real line breaks.
7564
Bram Moolenaar6100d022016-10-02 16:51:57 +02007565 When substitute() is used recursively only the submatches in
7566 the current (deepest) call can be obtained.
7567
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 Example: >
7569 :s/\d\+/\=submatch(0) + 1/
7570< This finds the first number in the line and adds one to it.
7571 A line break is included as a newline character.
7572
7573substitute({expr}, {pat}, {sub}, {flags}) *substitute()*
7574 The result is a String, which is a copy of {expr}, in which
Bram Moolenaar251e1912011-06-19 05:09:16 +02007575 the first match of {pat} is replaced with {sub}.
7576 When {flags} is "g", all matches of {pat} in {expr} are
7577 replaced. Otherwise {flags} should be "".
7578
7579 This works like the ":substitute" command (without any flags).
7580 But the matching with {pat} is always done like the 'magic'
7581 option is set and 'cpoptions' is empty (to make scripts
Bram Moolenaar2df58b42012-11-28 18:21:11 +01007582 portable). 'ignorecase' is still relevant, use |/\c| or |/\C|
7583 if you want to ignore or match case and ignore 'ignorecase'.
7584 'smartcase' is not used. See |string-match| for how {pat} is
7585 used.
Bram Moolenaar251e1912011-06-19 05:09:16 +02007586
7587 A "~" in {sub} is not replaced with the previous {sub}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 Note that some codes in {sub} have a special meaning
Bram Moolenaar58b85342016-08-14 19:54:54 +02007589 |sub-replace-special|. For example, to replace something with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007590 "\n" (two characters), use "\\\\n" or '\\n'.
Bram Moolenaar251e1912011-06-19 05:09:16 +02007591
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592 When {pat} does not match in {expr}, {expr} is returned
7593 unmodified.
Bram Moolenaar251e1912011-06-19 05:09:16 +02007594
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 Example: >
Bram Moolenaardf48fb42016-07-22 21:50:18 +02007596 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597< This removes the last component of the 'path' option. >
Bram Moolenaardf48fb42016-07-22 21:50:18 +02007598 :echo substitute("testing", ".*", "\\U\\0", "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599< results in "TESTING".
Bram Moolenaar251e1912011-06-19 05:09:16 +02007600
7601 When {sub} starts with "\=", the remainder is interpreted as
7602 an expression. See |sub-replace-expression|. Example: >
Bram Moolenaardf48fb42016-07-22 21:50:18 +02007603 :echo substitute(s, '%\(\x\x\)',
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02007604 \ '\=nr2char("0x" . submatch(1))', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00007605
Bram Moolenaardf48fb42016-07-22 21:50:18 +02007606< When {sub} is a Funcref that function is called, with one
7607 optional argument. Example: >
7608 :echo substitute(s, '%\(\x\x\)', SubNr, 'g')
7609< The optional argument is a list which contains the whole
Bram Moolenaar58b85342016-08-14 19:54:54 +02007610 matched string and up to nine submatches, like what
7611 |submatch()| returns. Example: >
7612 :echo substitute(s, '%\(\x\x\)', {m -> '0x' . m[1]}, 'g')
Bram Moolenaardf48fb42016-07-22 21:50:18 +02007613
Bram Moolenaar47136d72004-10-12 20:02:24 +00007614synID({lnum}, {col}, {trans}) *synID()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007615 The result is a Number, which is the syntax ID at the position
Bram Moolenaar47136d72004-10-12 20:02:24 +00007616 {lnum} and {col} in the current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007617 The syntax ID can be used with |synIDattr()| and
7618 |synIDtrans()| to obtain syntax information about text.
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007619
Bram Moolenaar47136d72004-10-12 20:02:24 +00007620 {col} is 1 for the leftmost column, {lnum} is 1 for the first
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007621 line. 'synmaxcol' applies, in a longer line zero is returned.
Bram Moolenaarca635012015-09-25 20:34:21 +02007622 Note that when the position is after the last character,
7623 that's where the cursor can be in Insert mode, synID() returns
7624 zero.
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007625
Bram Moolenaar79815f12016-07-09 17:07:29 +02007626 When {trans} is |TRUE|, transparent items are reduced to the
Bram Moolenaar58b85342016-08-14 19:54:54 +02007627 item that they reveal. This is useful when wanting to know
Bram Moolenaar79815f12016-07-09 17:07:29 +02007628 the effective color. When {trans} is |FALSE|, the transparent
Bram Moolenaar071d4272004-06-13 20:20:40 +00007629 item is returned. This is useful when wanting to know which
7630 syntax item is effective (e.g. inside parens).
7631 Warning: This function can be very slow. Best speed is
7632 obtained by going through the file in forward direction.
7633
7634 Example (echoes the name of the syntax item under the cursor): >
7635 :echo synIDattr(synID(line("."), col("."), 1), "name")
7636<
Bram Moolenaar7510fe72010-07-25 12:46:44 +02007637
Bram Moolenaar071d4272004-06-13 20:20:40 +00007638synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
7639 The result is a String, which is the {what} attribute of
7640 syntax ID {synID}. This can be used to obtain information
7641 about a syntax item.
7642 {mode} can be "gui", "cterm" or "term", to get the attributes
Bram Moolenaar58b85342016-08-14 19:54:54 +02007643 for that mode. When {mode} is omitted, or an invalid value is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 used, the attributes for the currently active highlighting are
7645 used (GUI, cterm or term).
7646 Use synIDtrans() to follow linked highlight groups.
7647 {what} result
7648 "name" the name of the syntax item
7649 "fg" foreground color (GUI: color name used to set
7650 the color, cterm: color number as a string,
7651 term: empty string)
Bram Moolenaar6f507d62008-11-28 10:16:05 +00007652 "bg" background color (as with "fg")
Bram Moolenaar12682fd2010-03-10 13:43:49 +01007653 "font" font name (only available in the GUI)
7654 |highlight-font|
Bram Moolenaar6f507d62008-11-28 10:16:05 +00007655 "sp" special color (as with "fg") |highlight-guisp|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007656 "fg#" like "fg", but for the GUI and the GUI is
7657 running the name in "#RRGGBB" form
7658 "bg#" like "fg#" for "bg"
Bram Moolenaar6f507d62008-11-28 10:16:05 +00007659 "sp#" like "fg#" for "sp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007660 "bold" "1" if bold
7661 "italic" "1" if italic
7662 "reverse" "1" if reverse
7663 "inverse" "1" if inverse (= reverse)
Bram Moolenaar12682fd2010-03-10 13:43:49 +01007664 "standout" "1" if standout
Bram Moolenaar071d4272004-06-13 20:20:40 +00007665 "underline" "1" if underlined
Bram Moolenaare2cc9702005-03-15 22:43:58 +00007666 "undercurl" "1" if undercurled
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667
7668 Example (echoes the color of the syntax item under the
7669 cursor): >
7670 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
7671<
7672synIDtrans({synID}) *synIDtrans()*
7673 The result is a Number, which is the translated syntax ID of
7674 {synID}. This is the syntax group ID of what is being used to
7675 highlight the character. Highlight links given with
7676 ":highlight link" are followed.
7677
Bram Moolenaar483c5d82010-10-20 18:45:33 +02007678synconcealed({lnum}, {col}) *synconcealed()*
Bram Moolenaar4d785892017-06-22 22:00:50 +02007679 The result is a List with currently three items:
7680 1. The first item in the list is 0 if the character at the
7681 position {lnum} and {col} is not part of a concealable
7682 region, 1 if it is.
7683 2. The second item in the list is a string. If the first item
7684 is 1, the second item contains the text which will be
7685 displayed in place of the concealed text, depending on the
7686 current setting of 'conceallevel' and 'listchars'.
Bram Moolenaarcc0750d2017-06-24 22:29:24 +02007687 3. The third and final item in the list is a number
7688 representing the specific syntax region matched in the
7689 line. When the character is not concealed the value is
7690 zero. This allows detection of the beginning of a new
7691 concealable region if there are two consecutive regions
7692 with the same replacement character. For an example, if
7693 the text is "123456" and both "23" and "45" are concealed
7694 and replace by the character "X", then:
7695 call returns ~
7696 synconcealed(lnum, 1) [0, '', 0]
7697 synconcealed(lnum, 2) [1, 'X', 1]
7698 synconcealed(lnum, 3) [1, 'X', 1]
7699 synconcealed(lnum, 4) [1, 'X', 2]
7700 synconcealed(lnum, 5) [1, 'X', 2]
7701 synconcealed(lnum, 6) [0, '', 0]
Bram Moolenaar483c5d82010-10-20 18:45:33 +02007702
7703
Bram Moolenaar9d188ab2008-01-10 21:24:39 +00007704synstack({lnum}, {col}) *synstack()*
7705 Return a |List|, which is the stack of syntax items at the
7706 position {lnum} and {col} in the current window. Each item in
7707 the List is an ID like what |synID()| returns.
Bram Moolenaar9d188ab2008-01-10 21:24:39 +00007708 The first item in the List is the outer region, following are
7709 items contained in that one. The last one is what |synID()|
7710 returns, unless not the whole item is highlighted or it is a
7711 transparent item.
7712 This function is useful for debugging a syntax file.
7713 Example that shows the syntax stack under the cursor: >
7714 for id in synstack(line("."), col("."))
7715 echo synIDattr(id, "name")
7716 endfor
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007717< When the position specified with {lnum} and {col} is invalid
7718 nothing is returned. The position just after the last
7719 character in a line and the first column in an empty line are
7720 valid positions.
Bram Moolenaar9d188ab2008-01-10 21:24:39 +00007721
Bram Moolenaarc0197e22004-09-13 20:26:32 +00007722system({expr} [, {input}]) *system()* *E677*
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02007723 Get the output of the shell command {expr} as a string. See
7724 |systemlist()| to get the output as a List.
Bram Moolenaar57ebe6e2014-04-05 18:55:46 +02007725
7726 When {input} is given and is a string this string is written
7727 to a file and passed as stdin to the command. The string is
7728 written as-is, you need to take care of using the correct line
7729 separators yourself.
7730 If {input} is given and is a |List| it is written to the file
7731 in a way |writefile()| does with {binary} set to "b" (i.e.
7732 with a newline between each list item with newlines inside
Bram Moolenaar12c44922017-01-08 13:26:03 +01007733 list items converted to NULs).
7734 When {input} is given and is a number that is a valid id for
7735 an existing buffer then the content of the buffer is written
7736 to the file line by line, each line terminated by a NL and
7737 NULs characters where the text has a NL.
Bram Moolenaar069c1e72016-07-15 21:25:08 +02007738
7739 Pipes are not used, the 'shelltemp' option is not used.
Bram Moolenaar57ebe6e2014-04-05 18:55:46 +02007740
Bram Moolenaar04186092016-08-29 21:55:35 +02007741 When prepended by |:silent| the terminal will not be set to
Bram Moolenaar52a72462014-08-29 15:53:52 +02007742 cooked mode. This is meant to be used for commands that do
7743 not need the user to type. It avoids stray characters showing
7744 up on the screen which require |CTRL-L| to remove. >
7745 :silent let f = system('ls *.vim')
7746<
Bram Moolenaar26df0922014-02-23 23:39:13 +01007747 Note: Use |shellescape()| or |::S| with |expand()| or
7748 |fnamemodify()| to escape special characters in a command
7749 argument. Newlines in {expr} may cause the command to fail.
7750 The characters in 'shellquote' and 'shellxquote' may also
7751 cause trouble.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752 This is not to be used for interactive commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753
Bram Moolenaar05bb9532008-07-04 09:44:11 +00007754 The result is a String. Example: >
7755 :let files = system("ls " . shellescape(expand('%:h')))
Bram Moolenaar26df0922014-02-23 23:39:13 +01007756 :let files = system('ls ' . expand('%:h:S'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757
7758< To make the result more system-independent, the shell output
7759 is filtered to replace <CR> with <NL> for Macintosh, and
7760 <CR><NL> with <NL> for DOS-like systems.
Bram Moolenaar9d98fe92013-08-03 18:35:36 +02007761 To avoid the string being truncated at a NUL, all NUL
7762 characters are replaced with SOH (0x01).
7763
Bram Moolenaar071d4272004-06-13 20:20:40 +00007764 The command executed is constructed using several options:
7765 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
7766 ({tmp} is an automatically generated file name).
7767 For Unix and OS/2 braces are put around {expr} to allow for
7768 concatenated commands.
7769
Bram Moolenaar433f7c82006-03-21 21:29:36 +00007770 The command will be executed in "cooked" mode, so that a
7771 CTRL-C will interrupt the command (on Unix at least).
7772
Bram Moolenaar071d4272004-06-13 20:20:40 +00007773 The resulting error code can be found in |v:shell_error|.
7774 This function will fail in |restricted-mode|.
Bram Moolenaar4770d092006-01-12 23:22:24 +00007775
7776 Note that any wrong value in the options mentioned above may
7777 make the function fail. It has also been reported to fail
7778 when using a security agent application.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779 Unlike ":!cmd" there is no automatic check for changed files.
7780 Use |:checktime| to force a check.
7781
Bram Moolenaare2cc9702005-03-15 22:43:58 +00007782
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02007783systemlist({expr} [, {input}]) *systemlist()*
7784 Same as |system()|, but returns a |List| with lines (parts of
7785 output separated by NL) with NULs transformed into NLs. Output
7786 is the same as |readfile()| will output with {binary} argument
Bram Moolenaar68563932017-01-10 13:31:15 +01007787 set to "b". Note that on MS-Windows you may get trailing CR
7788 characters.
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02007789
Bram Moolenaar975b5272016-03-15 23:10:59 +01007790 Returns an empty string on error.
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02007791
7792
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007793tabpagebuflist([{arg}]) *tabpagebuflist()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007794 The result is a |List|, where each item is the number of the
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007795 buffer associated with each window in the current tab page.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02007796 {arg} specifies the number of the tab page to be used. When
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007797 omitted the current tab page is used.
7798 When {arg} is invalid the number zero is returned.
7799 To get a list of all buffers in all tabs use this: >
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007800 let buflist = []
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007801 for i in range(tabpagenr('$'))
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007802 call extend(buflist, tabpagebuflist(i + 1))
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007803 endfor
7804< Note that a buffer may appear in more than one window.
7805
7806
7807tabpagenr([{arg}]) *tabpagenr()*
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007808 The result is a Number, which is the number of the current
7809 tab page. The first tab page has number 1.
7810 When the optional argument is "$", the number of the last tab
7811 page is returned (the tab page count).
7812 The number can be used with the |:tab| command.
7813
7814
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007815tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()*
Bram Moolenaard04f4402010-08-15 13:30:34 +02007816 Like |winnr()| but for tab page {tabarg}.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007817 {tabarg} specifies the number of tab page to be used.
7818 {arg} is used like with |winnr()|:
7819 - When omitted the current window number is returned. This is
7820 the window which will be used when going to this tab page.
7821 - When "$" the number of windows is returned.
7822 - When "#" the previous window nr is returned.
7823 Useful examples: >
7824 tabpagewinnr(1) " current window of tab page 1
7825 tabpagewinnr(4, '$') " number of windows in tab page 4
7826< When {tabarg} is invalid zero is returned.
7827
Bram Moolenaarfa1d1402006-03-25 21:59:56 +00007828 *tagfiles()*
7829tagfiles() Returns a |List| with the file names used to search for tags
7830 for the current buffer. This is the 'tags' option expanded.
7831
7832
Bram Moolenaarc6aafba2017-03-21 17:09:10 +01007833taglist({expr}[, {filename}]) *taglist()*
Bram Moolenaare2cc9702005-03-15 22:43:58 +00007834 Returns a list of tags matching the regular expression {expr}.
Bram Moolenaarc6aafba2017-03-21 17:09:10 +01007835
7836 If {filename} is passed it is used to prioritize the results
7837 in the same way that |:tselect| does. See |tag-priority|.
7838 {filename} should be the full path of the file.
7839
Bram Moolenaard8c00872005-07-22 21:52:15 +00007840 Each list item is a dictionary with at least the following
7841 entries:
Bram Moolenaar280f1262006-01-30 00:14:18 +00007842 name Name of the tag.
7843 filename Name of the file where the tag is
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007844 defined. It is either relative to the
7845 current directory or a full path.
Bram Moolenaare2cc9702005-03-15 22:43:58 +00007846 cmd Ex command used to locate the tag in
7847 the file.
Bram Moolenaar280f1262006-01-30 00:14:18 +00007848 kind Type of the tag. The value for this
Bram Moolenaare2cc9702005-03-15 22:43:58 +00007849 entry depends on the language specific
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007850 kind values. Only available when
7851 using a tags file generated by
7852 Exuberant ctags or hdrtag.
Bram Moolenaar280f1262006-01-30 00:14:18 +00007853 static A file specific tag. Refer to
Bram Moolenaare2cc9702005-03-15 22:43:58 +00007854 |static-tag| for more information.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007855 More entries may be present, depending on the content of the
7856 tags file: access, implementation, inherits and signature.
7857 Refer to the ctags documentation for information about these
7858 fields. For C code the fields "struct", "class" and "enum"
7859 may appear, they give the name of the entity the tag is
7860 contained in.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007861
Bram Moolenaar214641f2017-03-05 17:04:09 +01007862 The ex-command "cmd" can be either an ex search pattern, a
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00007863 line number or a line number followed by a byte number.
Bram Moolenaare2cc9702005-03-15 22:43:58 +00007864
7865 If there are no matching tags, then an empty list is returned.
7866
7867 To get an exact tag match, the anchors '^' and '$' should be
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01007868 used in {expr}. This also make the function work faster.
7869 Refer to |tag-regexp| for more information about the tag
7870 search regular expression pattern.
Bram Moolenaare2cc9702005-03-15 22:43:58 +00007871
7872 Refer to |'tags'| for information about how the tags file is
7873 located by Vim. Refer to |tags-file-format| for the format of
7874 the tags file generated by the different ctags tools.
7875
Bram Moolenaardb7c6862010-05-21 16:33:48 +02007876tan({expr}) *tan()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02007877 Return the tangent of {expr}, measured in radians, as a |Float|
Bram Moolenaardb7c6862010-05-21 16:33:48 +02007878 in the range [-inf, inf].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02007879 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02007880 Examples: >
7881 :echo tan(10)
7882< 0.648361 >
7883 :echo tan(-4.01)
7884< -1.181502
Bram Moolenaardb84e452010-08-15 13:50:43 +02007885 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02007886
7887
7888tanh({expr}) *tanh()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02007889 Return the hyperbolic tangent of {expr} as a |Float| in the
Bram Moolenaardb7c6862010-05-21 16:33:48 +02007890 range [-1, 1].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02007891 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02007892 Examples: >
7893 :echo tanh(0.5)
7894< 0.462117 >
7895 :echo tanh(-1)
7896< -0.761594
Bram Moolenaardb84e452010-08-15 13:50:43 +02007897 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02007898
7899
Bram Moolenaar574860b2016-05-24 17:33:34 +02007900tempname() *tempname()* *temp-file-name*
7901 The result is a String, which is the name of a file that
Bram Moolenaar58b85342016-08-14 19:54:54 +02007902 doesn't exist. It can be used for a temporary file. The name
Bram Moolenaar574860b2016-05-24 17:33:34 +02007903 is different for at least 26 consecutive calls. Example: >
7904 :let tmpfile = tempname()
7905 :exe "redir > " . tmpfile
7906< For Unix, the file will be in a private directory |tempfile|.
7907 For MS-Windows forward slashes are used when the 'shellslash'
7908 option is set or when 'shellcmdflag' starts with '-'.
7909
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02007910term_getattr({attr}, {what}) *term_getattr()*
7911 Given {attr}, a value returned by term_scrape() in the "attr"
7912 item, return whether {what} is on. {what} can be one of:
7913 bold
7914 italic
7915 underline
7916 strike
7917 reverse
Bram Moolenaar74675a62017-07-15 13:53:23 +02007918
Bram Moolenaar97870002017-07-30 18:28:38 +02007919term_getcursor({buf}) *term_getcursor()*
7920 Get the cusor position of terminal {buf}. Returns a list with
7921 three numbers: [rows, cols, visible]. "rows" and "cols" are
Bram Moolenaarc2ce52c2017-08-01 18:35:38 +02007922 one based, the first sceen cell is row 1, column 1.
7923 "visible" is one when the cursor is visible, zero when it is
7924 hidden.
Bram Moolenaar97870002017-07-30 18:28:38 +02007925
7926 This is the cursor position of the terminal itself, not of the
7927 Vim window.
7928
7929 {buf} must be the buffer number of a terminal window. If the
7930 buffer does not exist or is not a terminal window, an empty
7931 list is returned.
7932
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02007933term_getjob({buf}) *term_getjob()*
7934 Get the Job associated with terminal window {buf}.
7935 {buf} is used as with |term_getsize()|.
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02007936 Returns |v:null| when there is no job.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007937
Bram Moolenaarc2ce52c2017-08-01 18:35:38 +02007938term_getline({buf}, {row}) *term_getline()*
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02007939 Get a line of text from the terminal window of {buf}.
7940 {buf} is used as with |term_getsize()|.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007941
Bram Moolenaarc2ce52c2017-08-01 18:35:38 +02007942 The first line has {row} one. When {row} "." the cursor line
7943 is used. When {row} is invalid an empty string is returned.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007944
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02007945term_getsize({buf}) *term_getsize()*
7946 Get the size of terminal {buf}. Returns a list with two
7947 numbers: [rows, cols]. This is the size of the terminal, not
7948 the window containing the terminal.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007949
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02007950 {buf} must be the buffer number of a terminal window. Use an
7951 empty string for the current buffer. If the buffer does not
7952 exist or is not a terminal window, an empty list is returned.
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02007953
Bram Moolenaarb000e322017-07-30 19:38:21 +02007954term_getstatus({buf}) *term_getstatus()*
7955 Get the status of terminal {buf}. This returns a comma
7956 separated list of these items:
7957 running job is running
7958 finished job has finished
7959 terminal in Terminal-Normal mode
7960 One of "running" or "finished" is always present.
7961
7962 {buf} must be the buffer number of a terminal window. If the
7963 buffer does not exist or is not a terminal window, an empty
7964 string is returned.
7965
7966term_gettitle({buf}) *term_gettitle()*
7967 Get the title of terminal {buf}. This is the title that the
7968 job in the terminal has set.
7969
7970 {buf} must be the buffer number of a terminal window. If the
7971 buffer does not exist or is not a terminal window, an empty
7972 string is returned.
7973
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02007974term_gettty({buf}) *term_gettty()*
7975 Get the name of the controlling terminal associated with
7976 terminal window {buf}.
7977 {buf} is used as with |term_getsize()|.
7978
Bram Moolenaar22aad2f2017-07-30 18:19:46 +02007979term_list() *term_list()*
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02007980 Return a list with the buffer numbers of all buffers for
7981 terminal windows.
7982
Bram Moolenaarc2ce52c2017-08-01 18:35:38 +02007983term_scrape({buf}, {row}) *term_scrape()*
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02007984 Get the contents of {row} of terminal screen of {buf}.
7985 For {buf} see |term_getsize()|.
7986
Bram Moolenaarc2ce52c2017-08-01 18:35:38 +02007987 The first line has {row} one. When {row} "." the cursor line
7988 is used. When {row} is invalid an empty string is returned.
Bram Moolenaar22aad2f2017-07-30 18:19:46 +02007989
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02007990 Return a List containing a Dict for each screen cell:
7991 "chars" character(s) at the cell
7992 "fg" foreground color as #rrggbb
7993 "bg" background color as #rrggbb
Bram Moolenaar7c9aec42017-08-03 13:51:25 +02007994 "attr" attributes of the cell, use |term_getattr()|
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02007995 to get the individual flags
7996 "width" cell width: 1 or 2
7997
7998term_sendkeys({buf}, {keys}) *term_sendkeys()*
7999 Send keystrokes {keys} to terminal {buf}.
8000 {buf} is used as with |term_getsize()|.
8001
8002 {keys} are translated as key sequences. For example, "\<c-x>"
8003 means the character CTRL-X.
8004
8005term_start({cmd}, {options}) *term_start()*
8006 Open a terminal window and run {cmd} in it.
8007
8008 Returns the buffer number of the terminal window.
8009 When opening the window fails zero is returned.
8010
8011 {options} are not implemented yet.
8012
8013term_wait({buf}) *term_wait()*
8014 Wait for pending updates of {buf} to be handled.
8015 {buf} is used as with |term_getsize()|.
Bram Moolenaar574860b2016-05-24 17:33:34 +02008016
Bram Moolenaar8e8df252016-05-25 21:23:21 +02008017test_alloc_fail({id}, {countdown}, {repeat}) *test_alloc_fail()*
8018 This is for testing: If the memory allocation with {id} is
8019 called, then decrement {countdown}, and when it reaches zero
8020 let memory allocation fail {repeat} times. When {repeat} is
8021 smaller than one it fails one time.
8022
Bram Moolenaar6f1d9a02016-07-24 14:12:38 +02008023test_autochdir() *test_autochdir()*
8024 Set a flag to enable the effect of 'autochdir' before Vim
8025 startup has finished.
Bram Moolenaar8e8df252016-05-25 21:23:21 +02008026
Bram Moolenaar574860b2016-05-24 17:33:34 +02008027test_garbagecollect_now() *test_garbagecollect_now()*
8028 Like garbagecollect(), but executed right away. This must
8029 only be called directly to avoid any structure to exist
8030 internally, and |v:testing| must have been set before calling
8031 any function.
8032
Bram Moolenaare0c31f62017-03-01 15:07:05 +01008033test_ignore_error({expr}) *test_ignore_error()*
8034 Ignore any error containing {expr}. A normal message is given
8035 instead.
8036 This is only meant to be used in tests, where catching the
8037 error with try/catch cannot be used (because it skips over
8038 following code).
8039 {expr} is used literally, not as a pattern.
8040 There is currently no way to revert this.
8041
Bram Moolenaar574860b2016-05-24 17:33:34 +02008042test_null_channel() *test_null_channel()*
8043 Return a Channel that is null. Only useful for testing.
8044 {only available when compiled with the +channel feature}
8045
8046test_null_dict() *test_null_dict()*
8047 Return a Dict that is null. Only useful for testing.
8048
8049test_null_job() *test_null_job()*
8050 Return a Job that is null. Only useful for testing.
8051 {only available when compiled with the +job feature}
8052
8053test_null_list() *test_null_list()*
8054 Return a List that is null. Only useful for testing.
8055
8056test_null_partial() *test_null_partial()*
8057 Return a Partial that is null. Only useful for testing.
8058
8059test_null_string() *test_null_string()*
8060 Return a String that is null. Only useful for testing.
8061
Bram Moolenaar036986f2017-03-16 17:41:02 +01008062test_override({name}, {val}) *test_override()*
8063 Overrides certain parts of Vims internal processing to be able
8064 to run tests. Only to be used for testing Vim!
8065 The override is enabled when {val} is non-zero and removed
8066 when {val} is zero.
8067 Current supported values for name are:
8068
8069 name effect when {val} is non-zero ~
8070 redraw disable the redrawing() function
8071 char_avail disable the char_avail() function
Bram Moolenaar182a17b2017-06-25 20:57:18 +02008072 starting reset the "starting" variable, see below
Bram Moolenaar036986f2017-03-16 17:41:02 +01008073 ALL clear all overrides ({val} is not used)
8074
Bram Moolenaar182a17b2017-06-25 20:57:18 +02008075 "starting" is to be used when a test should behave like
8076 startup was done. Since the tests are run by sourcing a
8077 script the "starting" variable is non-zero. This is usually a
8078 good thing (tests run faster), but sometimes changes behavior
8079 in a way that the test doesn't work properly.
8080 When using: >
8081 call test_override('starting', 1)
8082< The value of "starting" is saved. It is restored by: >
8083 call test_override('starting', 0)
8084
Bram Moolenaarc95a3022016-06-12 23:01:46 +02008085test_settime({expr}) *test_settime()*
8086 Set the time Vim uses internally. Currently only used for
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02008087 timestamps in the history, as they are used in viminfo, and
8088 for undo.
Bram Moolenaar3df01732017-02-17 22:47:16 +01008089 Using a value of 1 makes Vim not sleep after a warning or
8090 error message.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02008091 {expr} must evaluate to a number. When the value is zero the
8092 normal behavior is restored.
Bram Moolenaar574860b2016-05-24 17:33:34 +02008093
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02008094 *timer_info()*
8095timer_info([{id}])
8096 Return a list with information about timers.
8097 When {id} is given only information about this timer is
8098 returned. When timer {id} does not exist an empty list is
8099 returned.
8100 When {id} is omitted information about all timers is returned.
8101
8102 For each timer the information is stored in a Dictionary with
8103 these items:
8104 "id" the timer ID
8105 "time" time the timer was started with
8106 "remaining" time until the timer fires
8107 "repeat" number of times the timer will still fire;
Bram Moolenaarb73598e2016-08-07 18:22:53 +02008108 -1 means forever
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02008109 "callback" the callback
Bram Moolenaarb73598e2016-08-07 18:22:53 +02008110 "paused" 1 if the timer is paused, 0 otherwise
8111
8112 {only available when compiled with the |+timers| feature}
8113
8114timer_pause({timer}, {paused}) *timer_pause()*
8115 Pause or unpause a timer. A paused timer does not invoke its
Bram Moolenaardc1f1642016-08-16 18:33:43 +02008116 callback when its time expires. Unpausing a timer may cause
8117 the callback to be invoked almost immediately if enough time
8118 has passed.
Bram Moolenaarb73598e2016-08-07 18:22:53 +02008119
8120 Pausing a timer is useful to avoid the callback to be called
8121 for a short time.
8122
8123 If {paused} evaluates to a non-zero Number or a non-empty
8124 String, then the timer is paused, otherwise it is unpaused.
8125 See |non-zero-arg|.
8126
8127 {only available when compiled with the |+timers| feature}
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02008128
Bram Moolenaardc1f1642016-08-16 18:33:43 +02008129 *timer_start()* *timer* *timers*
Bram Moolenaar975b5272016-03-15 23:10:59 +01008130timer_start({time}, {callback} [, {options}])
8131 Create a timer and return the timer ID.
8132
8133 {time} is the waiting time in milliseconds. This is the
8134 minimum time before invoking the callback. When the system is
8135 busy or Vim is not waiting for input the time will be longer.
8136
8137 {callback} is the function to call. It can be the name of a
Bram Moolenaarf37506f2016-08-31 22:22:10 +02008138 function or a |Funcref|. It is called with one argument, which
Bram Moolenaar975b5272016-03-15 23:10:59 +01008139 is the timer ID. The callback is only invoked when Vim is
8140 waiting for input.
8141
8142 {options} is a dictionary. Supported entries:
8143 "repeat" Number of times to repeat calling the
Bram Moolenaarabd468e2016-09-08 22:22:43 +02008144 callback. -1 means forever. When not present
8145 the callback will be called once.
Bram Moolenaarc577d812017-07-08 22:37:34 +02008146 If the timer causes an error three times in a
8147 row the repeat is cancelled. This avoids that
8148 Vim becomes unusable because of all the error
8149 messages.
Bram Moolenaar975b5272016-03-15 23:10:59 +01008150
8151 Example: >
8152 func MyHandler(timer)
8153 echo 'Handler called'
8154 endfunc
8155 let timer = timer_start(500, 'MyHandler',
8156 \ {'repeat': 3})
8157< This will invoke MyHandler() three times at 500 msec
8158 intervals.
Bram Moolenaarb73598e2016-08-07 18:22:53 +02008159
Bram Moolenaar975b5272016-03-15 23:10:59 +01008160 {only available when compiled with the |+timers| feature}
8161
Bram Moolenaar03602ec2016-03-20 20:57:45 +01008162timer_stop({timer}) *timer_stop()*
Bram Moolenaar06d2d382016-05-20 17:24:11 +02008163 Stop a timer. The timer callback will no longer be invoked.
8164 {timer} is an ID returned by timer_start(), thus it must be a
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02008165 Number. If {timer} does not exist there is no error.
Bram Moolenaar03602ec2016-03-20 20:57:45 +01008166
Bram Moolenaarb73598e2016-08-07 18:22:53 +02008167 {only available when compiled with the |+timers| feature}
8168
8169timer_stopall() *timer_stopall()*
8170 Stop all timers. The timer callbacks will no longer be
8171 invoked. Useful if some timers is misbehaving. If there are
8172 no timers there is no error.
8173
8174 {only available when compiled with the |+timers| feature}
8175
Bram Moolenaar071d4272004-06-13 20:20:40 +00008176tolower({expr}) *tolower()*
8177 The result is a copy of the String given, with all uppercase
8178 characters turned into lowercase (just like applying |gu| to
8179 the string).
8180
8181toupper({expr}) *toupper()*
8182 The result is a copy of the String given, with all lowercase
8183 characters turned into uppercase (just like applying |gU| to
8184 the string).
8185
Bram Moolenaar8299df92004-07-10 09:47:34 +00008186tr({src}, {fromstr}, {tostr}) *tr()*
8187 The result is a copy of the {src} string with all characters
8188 which appear in {fromstr} replaced by the character in that
8189 position in the {tostr} string. Thus the first character in
8190 {fromstr} is translated into the first character in {tostr}
8191 and so on. Exactly like the unix "tr" command.
8192 This code also deals with multibyte characters properly.
8193
8194 Examples: >
8195 echo tr("hello there", "ht", "HT")
8196< returns "Hello THere" >
8197 echo tr("<blob>", "<>", "{}")
8198< returns "{blob}"
8199
Bram Moolenaar446cb832008-06-24 21:56:24 +00008200trunc({expr}) *trunc()*
Bram Moolenaarc236c162008-07-13 17:41:49 +00008201 Return the largest integral value with magnitude less than or
Bram Moolenaar446cb832008-06-24 21:56:24 +00008202 equal to {expr} as a |Float| (truncate towards zero).
8203 {expr} must evaluate to a |Float| or a |Number|.
8204 Examples: >
8205 echo trunc(1.456)
8206< 1.0 >
8207 echo trunc(-5.456)
8208< -5.0 >
8209 echo trunc(4.0)
8210< 4.0
8211 {only available when compiled with the |+float| feature}
8212
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00008213 *type()*
Bram Moolenaardf48fb42016-07-22 21:50:18 +02008214type({expr}) The result is a Number representing the type of {expr}.
8215 Instead of using the number directly, it is better to use the
8216 v:t_ variable that has the value:
8217 Number: 0 |v:t_number|
8218 String: 1 |v:t_string|
8219 Funcref: 2 |v:t_func|
8220 List: 3 |v:t_list|
8221 Dictionary: 4 |v:t_dict|
8222 Float: 5 |v:t_float|
8223 Boolean: 6 |v:t_bool| (v:false and v:true)
8224 None 7 |v:t_none| (v:null and v:none)
8225 Job 8 |v:t_job|
8226 Channel 9 |v:t_channel|
8227 For backward compatibility, this method can be used: >
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00008228 :if type(myvar) == type(0)
8229 :if type(myvar) == type("")
8230 :if type(myvar) == type(function("tr"))
8231 :if type(myvar) == type([])
Bram Moolenaar748bf032005-02-02 23:04:36 +00008232 :if type(myvar) == type({})
Bram Moolenaar446cb832008-06-24 21:56:24 +00008233 :if type(myvar) == type(0.0)
Bram Moolenaar705ada12016-01-24 17:56:50 +01008234 :if type(myvar) == type(v:false)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01008235 :if type(myvar) == type(v:none)
Bram Moolenaardf48fb42016-07-22 21:50:18 +02008236< To check if the v:t_ variables exist use this: >
8237 :if exists('v:t_number')
Bram Moolenaar071d4272004-06-13 20:20:40 +00008238
Bram Moolenaara17d4c12010-05-30 18:30:36 +02008239undofile({name}) *undofile()*
8240 Return the name of the undo file that would be used for a file
8241 with name {name} when writing. This uses the 'undodir'
8242 option, finding directories that exist. It does not check if
Bram Moolenaar860cae12010-06-05 23:22:07 +02008243 the undo file exists.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008244 {name} is always expanded to the full path, since that is what
8245 is used internally.
Bram Moolenaar80716072012-05-01 21:14:34 +02008246 If {name} is empty undofile() returns an empty string, since a
8247 buffer without a file name will not write an undo file.
Bram Moolenaara17d4c12010-05-30 18:30:36 +02008248 Useful in combination with |:wundo| and |:rundo|.
8249 When compiled without the +persistent_undo option this always
8250 returns an empty string.
8251
Bram Moolenaara800b422010-06-27 01:15:55 +02008252undotree() *undotree()*
8253 Return the current state of the undo tree in a dictionary with
8254 the following items:
8255 "seq_last" The highest undo sequence number used.
8256 "seq_cur" The sequence number of the current position in
8257 the undo tree. This differs from "seq_last"
8258 when some changes were undone.
8259 "time_cur" Time last used for |:earlier| and related
8260 commands. Use |strftime()| to convert to
8261 something readable.
8262 "save_last" Number of the last file write. Zero when no
8263 write yet.
Bram Moolenaar730cde92010-06-27 05:18:54 +02008264 "save_cur" Number of the current position in the undo
8265 tree.
Bram Moolenaara800b422010-06-27 01:15:55 +02008266 "synced" Non-zero when the last undo block was synced.
8267 This happens when waiting from input from the
8268 user. See |undo-blocks|.
8269 "entries" A list of dictionaries with information about
8270 undo blocks.
8271
8272 The first item in the "entries" list is the oldest undo item.
8273 Each List item is a Dictionary with these items:
8274 "seq" Undo sequence number. Same as what appears in
8275 |:undolist|.
8276 "time" Timestamp when the change happened. Use
8277 |strftime()| to convert to something readable.
8278 "newhead" Only appears in the item that is the last one
8279 that was added. This marks the last change
8280 and where further changes will be added.
8281 "curhead" Only appears in the item that is the last one
8282 that was undone. This marks the current
8283 position in the undo tree, the block that will
8284 be used by a redo command. When nothing was
8285 undone after the last change this item will
8286 not appear anywhere.
8287 "save" Only appears on the last block before a file
8288 write. The number is the write count. The
8289 first write has number 1, the last one the
8290 "save_last" mentioned above.
8291 "alt" Alternate entry. This is again a List of undo
8292 blocks. Each item may again have an "alt"
8293 item.
8294
Bram Moolenaar327aa022014-03-25 18:24:23 +01008295uniq({list} [, {func} [, {dict}]]) *uniq()* *E882*
8296 Remove second and succeeding copies of repeated adjacent
8297 {list} items in-place. Returns {list}. If you want a list
8298 to remain unmodified make a copy first: >
8299 :let newlist = uniq(copy(mylist))
8300< The default compare function uses the string representation of
8301 each item. For the use of {func} and {dict} see |sort()|.
8302
Bram Moolenaar677ee682005-01-27 14:41:15 +00008303values({dict}) *values()*
Bram Moolenaar58b85342016-08-14 19:54:54 +02008304 Return a |List| with all the values of {dict}. The |List| is
Bram Moolenaar32466aa2006-02-24 23:53:04 +00008305 in arbitrary order.
Bram Moolenaar677ee682005-01-27 14:41:15 +00008306
8307
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308virtcol({expr}) *virtcol()*
8309 The result is a Number, which is the screen column of the file
8310 position given with {expr}. That is, the last screen position
8311 occupied by the character at that position, when the screen
8312 would be of unlimited width. When there is a <Tab> at the
8313 position, the returned Number will be the column at the end of
8314 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02008315 set to 8, it returns 8. |conceal| is ignored.
Bram Moolenaar477933c2007-07-17 14:32:23 +00008316 For the byte position use |col()|.
8317 For the use of {expr} see |col()|.
8318 When 'virtualedit' is used {expr} can be [lnum, col, off], where
Bram Moolenaar0b238792006-03-02 22:49:12 +00008319 "off" is the offset in screen columns from the start of the
Bram Moolenaard46bbc72007-05-12 14:38:41 +00008320 character. E.g., a position within a <Tab> or after the last
Bram Moolenaar97293012011-07-18 19:40:27 +02008321 character. When "off" is omitted zero is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322 When Virtual editing is active in the current mode, a position
8323 beyond the end of the line can be returned. |'virtualedit'|
8324 The accepted positions are:
8325 . the cursor position
8326 $ the end of the cursor line (the result is the
8327 number of displayed characters in the cursor line
8328 plus one)
8329 'x position of mark x (if the mark is not set, 0 is
8330 returned)
Bram Moolenaare3faf442014-12-14 01:27:49 +01008331 v In Visual mode: the start of the Visual area (the
8332 cursor is the end). When not in Visual mode
8333 returns the cursor position. Differs from |'<| in
8334 that it's updated right away.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 Note that only marks in the current file can be used.
8336 Examples: >
8337 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5
8338 virtcol("$") with text "foo^Lbar", returns 9
Bram Moolenaar446cb832008-06-24 21:56:24 +00008339 virtcol("'t") with text " there", with 't at 'h', returns 6
Bram Moolenaar58b85342016-08-14 19:54:54 +02008340< The first column is 1. 0 is returned for an error.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008341 A more advanced example that echoes the maximum length of
8342 all lines: >
8343 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
8344
Bram Moolenaar071d4272004-06-13 20:20:40 +00008345
8346visualmode([expr]) *visualmode()*
8347 The result is a String, which describes the last Visual mode
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008348 used in the current buffer. Initially it returns an empty
8349 string, but once Visual mode has been used, it returns "v",
8350 "V", or "<CTRL-V>" (a single CTRL-V character) for
8351 character-wise, line-wise, or block-wise Visual mode
8352 respectively.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008353 Example: >
8354 :exe "normal " . visualmode()
8355< This enters the same Visual mode as before. It is also useful
8356 in scripts if you wish to act differently depending on the
8357 Visual mode that was used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008358 If Visual mode is active, use |mode()| to get the Visual mode
8359 (e.g., in a |:vmap|).
Bram Moolenaar05bb9532008-07-04 09:44:11 +00008360 If [expr] is supplied and it evaluates to a non-zero Number or
8361 a non-empty String, then the Visual mode will be cleared and
Bram Moolenaare381d3d2016-07-07 14:50:41 +02008362 the old value is returned. See |non-zero-arg|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363
Bram Moolenaar8738fc12013-02-20 17:59:11 +01008364wildmenumode() *wildmenumode()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02008365 Returns |TRUE| when the wildmenu is active and |FALSE|
Bram Moolenaar8738fc12013-02-20 17:59:11 +01008366 otherwise. See 'wildmenu' and 'wildmode'.
8367 This can be used in mappings to handle the 'wildcharm' option
8368 gracefully. (Makes only sense with |mapmode-c| mappings).
8369
8370 For example to make <c-j> work like <down> in wildmode, use: >
8371 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
8372<
8373 (Note, this needs the 'wildcharm' option set appropriately).
8374
8375
Bram Moolenaar9cdf86b2016-03-13 19:04:51 +01008376win_findbuf({bufnr}) *win_findbuf()*
Bram Moolenaar7571d552016-08-18 22:54:46 +02008377 Returns a list with |window-ID|s for windows that contain
8378 buffer {bufnr}. When there is none the list is empty.
Bram Moolenaar9cdf86b2016-03-13 19:04:51 +01008379
Bram Moolenaar86edef62016-03-13 18:07:30 +01008380win_getid([{win} [, {tab}]]) *win_getid()*
Bram Moolenaar7571d552016-08-18 22:54:46 +02008381 Get the |window-ID| for the specified window.
Bram Moolenaar86edef62016-03-13 18:07:30 +01008382 When {win} is missing use the current window.
8383 With {win} this is the window number. The top window has
8384 number 1.
8385 Without {tab} use the current tab, otherwise the tab with
8386 number {tab}. The first tab has number one.
8387 Return zero if the window cannot be found.
8388
8389win_gotoid({expr}) *win_gotoid()*
8390 Go to window with ID {expr}. This may also change the current
8391 tabpage.
8392 Return 1 if successful, 0 if the window cannot be found.
8393
Bram Moolenaar03413f42016-04-12 21:07:15 +02008394win_id2tabwin({expr}) *win_id2tabwin()*
Bram Moolenaar86edef62016-03-13 18:07:30 +01008395 Return a list with the tab number and window number of window
8396 with ID {expr}: [tabnr, winnr].
8397 Return [0, 0] if the window cannot be found.
8398
8399win_id2win({expr}) *win_id2win()*
8400 Return the window number of window with ID {expr}.
8401 Return 0 if the window cannot be found in the current tabpage.
8402
Bram Moolenaar071d4272004-06-13 20:20:40 +00008403 *winbufnr()*
8404winbufnr({nr}) The result is a Number, which is the number of the buffer
Bram Moolenaar888ccac2016-06-04 18:49:36 +02008405 associated with window {nr}. {nr} can be the window number or
Bram Moolenaar7571d552016-08-18 22:54:46 +02008406 the |window-ID|.
Bram Moolenaar888ccac2016-06-04 18:49:36 +02008407 When {nr} is zero, the number of the buffer in the current
8408 window is returned.
8409 When window {nr} doesn't exist, -1 is returned.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008410 Example: >
8411 :echo "The file in the current window is " . bufname(winbufnr(0))
8412<
8413 *wincol()*
8414wincol() The result is a Number, which is the virtual column of the
8415 cursor in the window. This is counting screen cells from the
8416 left side of the window. The leftmost column is one.
8417
8418winheight({nr}) *winheight()*
8419 The result is a Number, which is the height of window {nr}.
Bram Moolenaar7571d552016-08-18 22:54:46 +02008420 {nr} can be the window number or the |window-ID|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008421 When {nr} is zero, the height of the current window is
8422 returned. When window {nr} doesn't exist, -1 is returned.
8423 An existing window always has a height of zero or more.
8424 Examples: >
8425 :echo "The current window has " . winheight(0) . " lines."
8426<
8427 *winline()*
8428winline() The result is a Number, which is the screen line of the cursor
Bram Moolenaar58b85342016-08-14 19:54:54 +02008429 in the window. This is counting screen lines from the top of
Bram Moolenaar071d4272004-06-13 20:20:40 +00008430 the window. The first line is one.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00008431 If the cursor was moved the view on the file will be updated
8432 first, this may cause a scroll.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008433
8434 *winnr()*
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00008435winnr([{arg}]) The result is a Number, which is the number of the current
8436 window. The top window has number 1.
8437 When the optional argument is "$", the number of the
Bram Moolenaar2df58b42012-11-28 18:21:11 +01008438 last window is returned (the window count). >
8439 let window_count = winnr('$')
8440< When the optional argument is "#", the number of the last
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00008441 accessed window is returned (where |CTRL-W_p| goes to).
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008442 If there is no previous window or it is in another tab page 0
8443 is returned.
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00008444 The number can be used with |CTRL-W_w| and ":wincmd w"
8445 |:wincmd|.
Bram Moolenaar690afe12017-01-28 18:34:47 +01008446 Also see |tabpagewinnr()| and |win_getid()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008447
8448 *winrestcmd()*
8449winrestcmd() Returns a sequence of |:resize| commands that should restore
8450 the current window sizes. Only works properly when no windows
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008451 are opened or closed and the current window and tab page is
8452 unchanged.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453 Example: >
8454 :let cmd = winrestcmd()
8455 :call MessWithWindowSizes()
8456 :exe cmd
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008457<
8458 *winrestview()*
8459winrestview({dict})
8460 Uses the |Dictionary| returned by |winsaveview()| to restore
8461 the view of the current window.
Bram Moolenaar82c25852014-05-28 16:47:16 +02008462 Note: The {dict} does not have to contain all values, that are
8463 returned by |winsaveview()|. If values are missing, those
8464 settings won't be restored. So you can use: >
8465 :call winrestview({'curswant': 4})
8466<
8467 This will only set the curswant value (the column the cursor
8468 wants to move on vertical movements) of the cursor to column 5
8469 (yes, that is 5), while all other settings will remain the
8470 same. This is useful, if you set the cursor position manually.
8471
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008472 If you have changed the values the result is unpredictable.
8473 If the window size changed the result won't be the same.
8474
8475 *winsaveview()*
8476winsaveview() Returns a |Dictionary| that contains information to restore
8477 the view of the current window. Use |winrestview()| to
8478 restore the view.
8479 This is useful if you have a mapping that jumps around in the
8480 buffer and you want to go back to the original view.
8481 This does not save fold information. Use the 'foldenable'
Bram Moolenaardb552d602006-03-23 22:59:57 +00008482 option to temporarily switch off folding, so that folds are
Bram Moolenaar07d87792014-07-19 14:04:47 +02008483 not opened when moving around. This may have side effects.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008484 The return value includes:
8485 lnum cursor line number
Bram Moolenaar82c25852014-05-28 16:47:16 +02008486 col cursor column (Note: the first column
8487 zero, as opposed to what getpos()
8488 returns)
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008489 coladd cursor column offset for 'virtualedit'
8490 curswant column for vertical movement
8491 topline first line in the window
8492 topfill filler lines, only in diff mode
8493 leftcol first column displayed
8494 skipcol columns skipped
8495 Note that no option values are saved.
8496
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497
8498winwidth({nr}) *winwidth()*
8499 The result is a Number, which is the width of window {nr}.
Bram Moolenaar7571d552016-08-18 22:54:46 +02008500 {nr} can be the window number or the |window-ID|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008501 When {nr} is zero, the width of the current window is
8502 returned. When window {nr} doesn't exist, -1 is returned.
8503 An existing window always has a width of zero or more.
8504 Examples: >
8505 :echo "The current window has " . winwidth(0) . " columns."
8506 :if winwidth(0) <= 50
8507 : exe "normal 50\<C-W>|"
8508 :endif
Bram Moolenaarf8be4612017-06-23 20:52:40 +02008509< For getting the terminal or screen size, see the 'columns'
8510 option.
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02008511
8512
Bram Moolenaared767a22016-01-03 22:49:16 +01008513wordcount() *wordcount()*
8514 The result is a dictionary of byte/chars/word statistics for
8515 the current buffer. This is the same info as provided by
8516 |g_CTRL-G|
8517 The return value includes:
8518 bytes Number of bytes in the buffer
8519 chars Number of chars in the buffer
8520 words Number of words in the buffer
8521 cursor_bytes Number of bytes before cursor position
8522 (not in Visual mode)
8523 cursor_chars Number of chars before cursor position
8524 (not in Visual mode)
8525 cursor_words Number of words before cursor position
8526 (not in Visual mode)
8527 visual_bytes Number of bytes visually selected
Bram Moolenaarf8be4612017-06-23 20:52:40 +02008528 (only in Visual mode)
Bram Moolenaared767a22016-01-03 22:49:16 +01008529 visual_chars Number of chars visually selected
Bram Moolenaarf8be4612017-06-23 20:52:40 +02008530 (only in Visual mode)
Bram Moolenaared767a22016-01-03 22:49:16 +01008531 visual_words Number of chars visually selected
Bram Moolenaarf8be4612017-06-23 20:52:40 +02008532 (only in Visual mode)
Bram Moolenaared767a22016-01-03 22:49:16 +01008533
8534
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00008535 *writefile()*
Bram Moolenaar6b2e9382014-11-05 18:06:01 +01008536writefile({list}, {fname} [, {flags}])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00008537 Write |List| {list} to file {fname}. Each list item is
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00008538 separated with a NL. Each list item must be a String or
8539 Number.
Bram Moolenaar6b2e9382014-11-05 18:06:01 +01008540 When {flags} contains "b" then binary mode is used: There will
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00008541 not be a NL after the last list item. An empty item at the
8542 end does cause the last line in the file to end in a NL.
Bram Moolenaar6b2e9382014-11-05 18:06:01 +01008543
8544 When {flags} contains "a" then append mode is used, lines are
Bram Moolenaar46fceaa2016-10-23 21:21:08 +02008545 appended to the file: >
Bram Moolenaar6b2e9382014-11-05 18:06:01 +01008546 :call writefile(["foo"], "event.log", "a")
8547 :call writefile(["bar"], "event.log", "a")
8548>
8549< All NL characters are replaced with a NUL character.
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00008550 Inserting CR characters needs to be done before passing {list}
8551 to writefile().
8552 An existing file is overwritten, if possible.
8553 When the write fails -1 is returned, otherwise 0. There is an
8554 error message if the file can't be created or when writing
8555 fails.
8556 Also see |readfile()|.
8557 To copy a file byte for byte: >
8558 :let fl = readfile("foo", "b")
8559 :call writefile(fl, "foocopy", "b")
Bram Moolenaard6e256c2011-12-14 15:32:50 +01008560
8561
8562xor({expr}, {expr}) *xor()*
8563 Bitwise XOR on the two arguments. The arguments are converted
8564 to a number. A List, Dict or Float argument causes an error.
8565 Example: >
8566 :let bits = xor(bits, 0x80)
Bram Moolenaar6ee8d892012-01-10 14:55:01 +01008567<
Bram Moolenaard6e256c2011-12-14 15:32:50 +01008568
Bram Moolenaar071d4272004-06-13 20:20:40 +00008569
8570 *feature-list*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02008571There are four types of features:
Bram Moolenaar071d4272004-06-13 20:20:40 +000085721. Features that are only supported when they have been enabled when Vim
8573 was compiled |+feature-list|. Example: >
8574 :if has("cindent")
85752. Features that are only supported when certain conditions have been met.
8576 Example: >
8577 :if has("gui_running")
8578< *has-patch*
Bram Moolenaar7e38ea22014-04-05 22:55:53 +020085793. Included patches. The "patch123" feature means that patch 123 has been
8580 included. Note that this form does not check the version of Vim, you need
8581 to inspect |v:version| for that.
8582 Example (checking version 6.2.148 or later): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008583 :if v:version > 602 || v:version == 602 && has("patch148")
Bram Moolenaar7e38ea22014-04-05 22:55:53 +02008584< Note that it's possible for patch 147 to be omitted even though 148 is
8585 included.
8586
85874. Beyond a certain version or at a certain version and including a specific
Bram Moolenaarbcb98982014-05-01 14:08:19 +02008588 patch. The "patch-7.4.237" feature means that the Vim version is 7.5 or
8589 later, or it is version 7.4 and patch 237 was included.
8590 Note that this only works for patch 7.4.237 and later, before that you
8591 need to use the example above that checks v:version. Example: >
8592 :if has("patch-7.4.248")
Bram Moolenaar7e38ea22014-04-05 22:55:53 +02008593< Note that it's possible for patch 147 to be omitted even though 148 is
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008594 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008595
Bram Moolenaard823fa92016-08-12 16:29:27 +02008596Hint: To find out if Vim supports backslashes in a file name (MS-Windows),
8597use: `if exists('+shellslash')`
8598
8599
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02008600acl Compiled with |ACL| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601all_builtin_terms Compiled with all builtin terminals enabled.
8602amiga Amiga version of Vim.
8603arabic Compiled with Arabic support |Arabic|.
8604arp Compiled with ARP support (Amiga).
Bram Moolenaara9b1e742005-12-19 22:14:58 +00008605autocmd Compiled with autocommand support. |autocommand|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606balloon_eval Compiled with |balloon-eval| support.
Bram Moolenaar45360022005-07-21 21:08:21 +00008607balloon_multiline GUI supports multiline balloons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008608beos BeOS version of Vim.
8609browse Compiled with |:browse| support, and browse() will
8610 work.
Bram Moolenaar30b65812012-07-12 22:01:11 +02008611browsefilter Compiled with support for |browsefilter|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008612builtin_terms Compiled with some builtin terminals.
8613byte_offset Compiled with support for 'o' in 'statusline'
8614cindent Compiled with 'cindent' support.
8615clientserver Compiled with remote invocation support |clientserver|.
8616clipboard Compiled with 'clipboard' support.
8617cmdline_compl Compiled with |cmdline-completion| support.
8618cmdline_hist Compiled with |cmdline-history| support.
8619cmdline_info Compiled with 'showcmd' and 'ruler' support.
8620comments Compiled with |'comments'| support.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01008621compatible Compiled to be very Vi compatible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008622cryptv Compiled with encryption support |encryption|.
8623cscope Compiled with |cscope| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008624debug Compiled with "DEBUG" defined.
8625dialog_con Compiled with console dialog support.
8626dialog_gui Compiled with GUI dialog support.
8627diff Compiled with |vimdiff| and 'diff' support.
8628digraphs Compiled with support for digraphs.
Bram Moolenaar58b85342016-08-14 19:54:54 +02008629directx Compiled with support for DirectX and 'renderoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008630dnd Compiled with support for the "~ register |quote_~|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008631ebcdic Compiled on a machine with ebcdic character set.
8632emacs_tags Compiled with support for Emacs tags.
8633eval Compiled with expression evaluation support. Always
8634 true, of course!
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01008635ex_extra |+ex_extra|, always true now
Bram Moolenaar071d4272004-06-13 20:20:40 +00008636extra_search Compiled with support for |'incsearch'| and
8637 |'hlsearch'|
8638farsi Compiled with Farsi support |farsi|.
8639file_in_path Compiled with support for |gf| and |<cfile>|
Bram Moolenaar26a60b42005-02-22 08:49:11 +00008640filterpipe When 'shelltemp' is off pipes are used for shell
8641 read/write/filter commands
Bram Moolenaar071d4272004-06-13 20:20:40 +00008642find_in_path Compiled with support for include file searches
8643 |+find_in_path|.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008644float Compiled with support for |Float|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645fname_case Case in file names matters (for Amiga, MS-DOS, and
8646 Windows this is not present).
8647folding Compiled with |folding| support.
8648footer Compiled with GUI footer support. |gui-footer|
8649fork Compiled to use fork()/exec() instead of system().
8650gettext Compiled with message translation |multi-lang|
8651gui Compiled with GUI enabled.
8652gui_athena Compiled with Athena GUI.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01008653gui_gnome Compiled with Gnome support (gui_gtk is also defined).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654gui_gtk Compiled with GTK+ GUI (any version).
8655gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
Bram Moolenaar98921892016-02-23 17:14:37 +01008656gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008657gui_mac Compiled with Macintosh GUI.
8658gui_motif Compiled with Motif GUI.
8659gui_photon Compiled with Photon GUI.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01008660gui_running Vim is running in the GUI, or it will start soon.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661gui_win32 Compiled with MS Windows Win32 GUI.
8662gui_win32s idem, and Win32s system being used (Windows 3.1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008663hangul_input Compiled with Hangul input support. |hangul|
8664iconv Can use iconv() for conversion.
8665insert_expand Compiled with support for CTRL-X expansion commands in
8666 Insert mode.
8667jumplist Compiled with |jumplist| support.
8668keymap Compiled with 'keymap' support.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02008669lambda Compiled with |lambda| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008670langmap Compiled with 'langmap' support.
8671libcall Compiled with |libcall()| support.
Bram Moolenaar597a4222014-06-25 14:39:50 +02008672linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and
8673 'breakindent' support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008674lispindent Compiled with support for lisp indenting.
8675listcmds Compiled with commands for the buffer list |:files|
8676 and the argument list |arglist|.
8677localmap Compiled with local mappings and abbr. |:map-local|
Bram Moolenaar0ba04292010-07-14 23:23:17 +02008678lua Compiled with Lua interface |Lua|.
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02008679mac Any Macintosh version of Vim, but not all OS X.
Bram Moolenaar0635ee62017-04-28 20:32:33 +02008680macunix Compiled for OS X, with |mac-darwin-feature|
8681osx Compiled for OS X, with or w/o |mac-darwin-feature|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008682menu Compiled with support for |:menu|.
8683mksession Compiled with support for |:mksession|.
8684modify_fname Compiled with file name modifiers. |filename-modifiers|
8685mouse Compiled with support mouse.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008686mouse_dec Compiled with support for Dec terminal mouse.
8687mouse_gpm Compiled with support for gpm (Linux console mouse)
8688mouse_netterm Compiled with support for netterm mouse.
8689mouse_pterm Compiled with support for qnx pterm mouse.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008690mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse)
Bram Moolenaar9b451252012-08-15 17:43:31 +02008691mouse_sgr Compiled with support for sgr mouse.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008692mouse_urxvt Compiled with support for urxvt mouse.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008693mouse_xterm Compiled with support for xterm mouse.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01008694mouseshape Compiled with support for 'mouseshape'.
Bram Moolenaar42022d52008-12-09 09:57:49 +00008695multi_byte Compiled with support for 'encoding'
8696multi_byte_encoding 'encoding' is set to a multi-byte encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697multi_byte_ime Compiled with support for IME input method.
8698multi_lang Compiled with support for multiple languages.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00008699mzscheme Compiled with MzScheme interface |mzscheme|.
Bram Moolenaarb26e6322010-05-22 21:34:09 +02008700netbeans_enabled Compiled with support for |netbeans| and connected.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01008701netbeans_intg Compiled with support for |netbeans|.
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02008702num64 Compiled with 64-bit |Number| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008703ole Compiled with OLE automation support for Win32.
Bram Moolenaar91c49372016-05-08 09:50:29 +02008704packages Compiled with |packages| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705path_extra Compiled with up/downwards search in 'path' and 'tags'
8706perl Compiled with Perl interface.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008707persistent_undo Compiled with support for persistent undo history.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008708postscript Compiled with PostScript file printing.
8709printer Compiled with |:hardcopy| support.
Bram Moolenaar05159a02005-02-26 23:04:13 +00008710profile Compiled with |:profile| support.
Bram Moolenaar446beb42011-05-10 17:18:44 +02008711python Compiled with Python 2.x interface. |has-python|
8712python3 Compiled with Python 3.x interface. |has-python|
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01008713pythonx Compiled with |python_x| interface. |has-pythonx|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008714qnx QNX version of Vim.
8715quickfix Compiled with |quickfix| support.
Bram Moolenaard68071d2006-05-02 22:08:30 +00008716reltime Compiled with |reltime()| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008717rightleft Compiled with 'rightleft' support.
8718ruby Compiled with Ruby interface |ruby|.
8719scrollbind Compiled with 'scrollbind' support.
8720showcmd Compiled with 'showcmd' support.
8721signs Compiled with |:sign| support.
8722smartindent Compiled with 'smartindent' support.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01008723spell Compiled with spell checking support |spell|.
Bram Moolenaaref94eec2009-11-11 13:22:11 +00008724startuptime Compiled with |--startuptime| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008725statusline Compiled with support for 'statusline', 'rulerformat'
8726 and special formats of 'titlestring' and 'iconstring'.
8727sun_workshop Compiled with support for Sun |workshop|.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00008728syntax Compiled with syntax highlighting support |syntax|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008729syntax_items There are active syntax highlighting items for the
8730 current buffer.
8731system Compiled to use system() instead of fork()/exec().
8732tag_binary Compiled with binary searching in tags files
8733 |tag-binary-search|.
8734tag_old_static Compiled with support for old static tags
8735 |tag-old-static|.
8736tag_any_white Compiled with support for any white characters in tags
8737 files |tag-any-white|.
8738tcl Compiled with Tcl interface.
Bram Moolenaar91c49372016-05-08 09:50:29 +02008739termguicolors Compiled with true color in terminal support.
Bram Moolenaarc2ce52c2017-08-01 18:35:38 +02008740terminal Compiled with |terminal| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008741terminfo Compiled with terminfo instead of termcap.
8742termresponse Compiled with support for |t_RV| and |v:termresponse|.
8743textobjects Compiled with support for |text-objects|.
8744tgetent Compiled with tgetent support, able to use a termcap
8745 or terminfo file.
Bram Moolenaar975b5272016-03-15 23:10:59 +01008746timers Compiled with |timer_start()| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747title Compiled with window title support |'title'|.
8748toolbar Compiled with support for |gui-toolbar|.
Bram Moolenaar2cab0e12016-11-24 15:09:07 +01008749ttyin input is a terminal (tty)
8750ttyout output is a terminal (tty)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751unix Unix version of Vim.
Bram Moolenaar3df01732017-02-17 22:47:16 +01008752unnamedplus Compiled with support for "unnamedplus" in 'clipboard'
Bram Moolenaar071d4272004-06-13 20:20:40 +00008753user_commands User-defined commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754vertsplit Compiled with vertically split windows |:vsplit|.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01008755vim_starting True while initial source'ing takes place. |startup|
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01008756 *vim_starting*
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01008757viminfo Compiled with viminfo support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008758virtualedit Compiled with 'virtualedit' option.
8759visual Compiled with Visual mode.
8760visualextra Compiled with extra Visual mode commands.
8761 |blockwise-operators|.
8762vms VMS version of Vim.
8763vreplace Compiled with |gR| and |gr| commands.
8764wildignore Compiled with 'wildignore' option.
8765wildmenu Compiled with 'wildmenu' option.
Bram Moolenaard58e9292011-02-09 17:07:58 +01008766win32 Win32 version of Vim (MS-Windows 95 and later, 32 or
8767 64 bits)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008768win32unix Win32 version of Vim, using Unix files (Cygwin)
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01008769win64 Win64 version of Vim (MS-Windows 64 bit).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008770win95 Win32 version for MS-Windows 95/98/ME.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01008771winaltkeys Compiled with 'winaltkeys' option.
8772windows Compiled with support for more than one window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008773writebackup Compiled with 'writebackup' default on.
8774xfontset Compiled with X fontset support |xfontset|.
8775xim Compiled with X input method support |xim|.
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02008776xpm Compiled with pixmap support.
8777xpm_w32 Compiled with pixmap support for Win32. (Only for
8778 backward compatibility. Use "xpm" instead.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779xsmp Compiled with X session management support.
8780xsmp_interact Compiled with interactive X session management support.
8781xterm_clipboard Compiled with support for xterm clipboard.
8782xterm_save Compiled with support for saving and restoring the
8783 xterm screen.
8784x11 Compiled with X11 support.
8785
8786 *string-match*
8787Matching a pattern in a String
8788
8789A regexp pattern as explained at |pattern| is normally used to find a match in
8790the buffer lines. When a pattern is used to find a match in a String, almost
8791everything works in the same way. The difference is that a String is handled
8792like it is one line. When it contains a "\n" character, this is not seen as a
8793line break for the pattern. It can be matched with a "\n" in the pattern, or
8794with ".". Example: >
8795 :let a = "aaaa\nxxxx"
8796 :echo matchstr(a, "..\n..")
8797 aa
8798 xx
8799 :echo matchstr(a, "a.x")
8800 a
8801 x
8802
8803Don't forget that "^" will only match at the first character of the String and
8804"$" at the last character of the string. They don't match after or before a
8805"\n".
8806
8807==============================================================================
88085. Defining functions *user-functions*
8809
8810New functions can be defined. These can be called just like builtin
8811functions. The function executes a sequence of Ex commands. Normal mode
8812commands can be executed with the |:normal| command.
8813
8814The function name must start with an uppercase letter, to avoid confusion with
8815builtin functions. To prevent from using the same name in different scripts
8816avoid obvious, short names. A good habit is to start the function name with
8817the name of the script, e.g., "HTMLcolor()".
8818
Bram Moolenaar92d640f2005-09-05 22:11:52 +00008819It's also possible to use curly braces, see |curly-braces-names|. And the
8820|autoload| facility is useful to define a function only when it's called.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008821
8822 *local-function*
8823A function local to a script must start with "s:". A local script function
8824can only be called from within the script and from functions, user commands
8825and autocommands defined in the script. It is also possible to call the
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008826function from a mapping defined in the script, but then |<SID>| must be used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008827instead of "s:" when the mapping is expanded outside of the script.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02008828There are only script-local functions, no buffer-local or window-local
8829functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008830
8831 *:fu* *:function* *E128* *E129* *E123*
8832:fu[nction] List all functions and their arguments.
8833
8834:fu[nction] {name} List function {name}.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00008835 {name} can also be a |Dictionary| entry that is a
8836 |Funcref|: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00008837 :function dict.init
Bram Moolenaar92d640f2005-09-05 22:11:52 +00008838
8839:fu[nction] /{pattern} List functions with a name matching {pattern}.
8840 Example that lists all functions ending with "File": >
8841 :function /File$
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00008842<
8843 *:function-verbose*
8844When 'verbose' is non-zero, listing a function will also display where it was
8845last defined. Example: >
8846
8847 :verbose function SetFileTypeSH
8848 function SetFileTypeSH(name)
8849 Last set from /usr/share/vim/vim-7.0/filetype.vim
8850<
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00008851See |:verbose-cmd| for more information.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00008852
Bram Moolenaarbcb98982014-05-01 14:08:19 +02008853 *E124* *E125* *E853* *E884*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02008854:fu[nction][!] {name}([arguments]) [range] [abort] [dict] [closure]
Bram Moolenaar071d4272004-06-13 20:20:40 +00008855 Define a new function by the name {name}. The name
8856 must be made of alphanumeric characters and '_', and
Bram Moolenaarbcb98982014-05-01 14:08:19 +02008857 must start with a capital or "s:" (see above). Note
8858 that using "b:" or "g:" is not allowed. (since patch
8859 7.4.260 E884 is given if the function name has a colon
8860 in the name, e.g. for "foo:bar()". Before that patch
8861 no error was given).
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00008862
Bram Moolenaar32466aa2006-02-24 23:53:04 +00008863 {name} can also be a |Dictionary| entry that is a
8864 |Funcref|: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00008865 :function dict.init(arg)
Bram Moolenaar58b85342016-08-14 19:54:54 +02008866< "dict" must be an existing dictionary. The entry
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00008867 "init" is added if it didn't exist yet. Otherwise [!]
Bram Moolenaar58b85342016-08-14 19:54:54 +02008868 is required to overwrite an existing function. The
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00008869 result is a |Funcref| to a numbered function. The
8870 function can only be used with a |Funcref| and will be
8871 deleted if there are no more references to it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008872 *E127* *E122*
8873 When a function by this name already exists and [!] is
8874 not used an error message is given. When [!] is used,
8875 an existing function is silently replaced. Unless it
8876 is currently being executed, that is an error.
Bram Moolenaarf8be4612017-06-23 20:52:40 +02008877 NOTE: Use ! wisely. If used without care it can cause
8878 an existing function to be replaced unexpectedly,
8879 which is hard to debug.
Bram Moolenaar8f999f12005-01-25 22:12:55 +00008880
8881 For the {arguments} see |function-argument|.
8882
Bram Moolenaar8d043172014-01-23 14:24:41 +01008883 *:func-range* *a:firstline* *a:lastline*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008884 When the [range] argument is added, the function is
8885 expected to take care of a range itself. The range is
8886 passed as "a:firstline" and "a:lastline". If [range]
8887 is excluded, ":{range}call" will call the function for
8888 each line in the range, with the cursor on the start
8889 of each line. See |function-range-example|.
Bram Moolenaar2df58b42012-11-28 18:21:11 +01008890 The cursor is still moved to the first line of the
8891 range, as is the case with all Ex commands.
Bram Moolenaar8d043172014-01-23 14:24:41 +01008892 *:func-abort*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008893 When the [abort] argument is added, the function will
8894 abort as soon as an error is detected.
Bram Moolenaar8d043172014-01-23 14:24:41 +01008895 *:func-dict*
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00008896 When the [dict] argument is added, the function must
Bram Moolenaar58b85342016-08-14 19:54:54 +02008897 be invoked through an entry in a |Dictionary|. The
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00008898 local variable "self" will then be set to the
8899 dictionary. See |Dictionary-function|.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02008900 *:func-closure* *E932*
8901 When the [closure] argument is added, the function
8902 can access variables and arguments from the outer
8903 scope. This is usually called a closure. In this
8904 example Bar() uses "x" from the scope of Foo(). It
8905 remains referenced even after Foo() returns: >
8906 :function! Foo()
8907 : let x = 0
8908 : function! Bar() closure
8909 : let x += 1
8910 : return x
8911 : endfunction
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02008912 : return funcref('Bar')
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02008913 :endfunction
8914
8915 :let F = Foo()
8916 :echo F()
8917< 1 >
8918 :echo F()
8919< 2 >
8920 :echo F()
8921< 3
Bram Moolenaar071d4272004-06-13 20:20:40 +00008922
Bram Moolenaar446cb832008-06-24 21:56:24 +00008923 *function-search-undo*
Bram Moolenaar98692072006-02-04 00:57:42 +00008924 The last used search pattern and the redo command "."
Bram Moolenaar446cb832008-06-24 21:56:24 +00008925 will not be changed by the function. This also
8926 implies that the effect of |:nohlsearch| is undone
8927 when the function returns.
Bram Moolenaar98692072006-02-04 00:57:42 +00008928
Bram Moolenaarf8be4612017-06-23 20:52:40 +02008929 *:endf* *:endfunction* *E126* *E193* *W22*
Bram Moolenaar663bb232017-06-22 19:12:10 +02008930:endf[unction] [argument]
8931 The end of a function definition. Best is to put it
8932 on a line by its own, without [argument].
8933
8934 [argument] can be:
8935 | command command to execute next
8936 \n command command to execute next
8937 " comment always ignored
Bram Moolenaarf8be4612017-06-23 20:52:40 +02008938 anything else ignored, warning given when
8939 'verbose' is non-zero
Bram Moolenaar663bb232017-06-22 19:12:10 +02008940 The support for a following command was added in Vim
8941 8.0.0654, before that any argument was silently
8942 ignored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008943
Bram Moolenaarf8be4612017-06-23 20:52:40 +02008944 To be able to define a function inside an `:execute`
8945 command, use line breaks instead of |:bar|: >
8946 :exe "func Foo()\necho 'foo'\nendfunc"
8947<
Bram Moolenaar437bafe2016-08-01 15:40:54 +02008948 *:delf* *:delfunction* *E130* *E131* *E933*
Bram Moolenaar663bb232017-06-22 19:12:10 +02008949:delf[unction][!] {name}
8950 Delete function {name}.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00008951 {name} can also be a |Dictionary| entry that is a
8952 |Funcref|: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00008953 :delfunc dict.init
Bram Moolenaar58b85342016-08-14 19:54:54 +02008954< This will remove the "init" entry from "dict". The
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00008955 function is deleted if there are no more references to
8956 it.
Bram Moolenaar663bb232017-06-22 19:12:10 +02008957 With the ! there is no error if the function does not
8958 exist.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008959 *:retu* *:return* *E133*
8960:retu[rn] [expr] Return from a function. When "[expr]" is given, it is
8961 evaluated and returned as the result of the function.
8962 If "[expr]" is not given, the number 0 is returned.
8963 When a function ends without an explicit ":return",
8964 the number 0 is returned.
8965 Note that there is no check for unreachable lines,
8966 thus there is no warning if commands follow ":return".
8967
8968 If the ":return" is used after a |:try| but before the
8969 matching |:finally| (if present), the commands
8970 following the ":finally" up to the matching |:endtry|
8971 are executed first. This process applies to all
8972 nested ":try"s inside the function. The function
8973 returns at the outermost ":endtry".
8974
Bram Moolenaar8f999f12005-01-25 22:12:55 +00008975 *function-argument* *a:var*
Bram Moolenaar58b85342016-08-14 19:54:54 +02008976An argument can be defined by giving its name. In the function this can then
Bram Moolenaar8f999f12005-01-25 22:12:55 +00008977be used as "a:name" ("a:" for argument).
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008978 *a:0* *a:1* *a:000* *E740* *...*
Bram Moolenaar8f999f12005-01-25 22:12:55 +00008979Up to 20 arguments can be given, separated by commas. After the named
8980arguments an argument "..." can be specified, which means that more arguments
8981may optionally be following. In the function the extra arguments can be used
8982as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which
Bram Moolenaar32466aa2006-02-24 23:53:04 +00008983can be 0). "a:000" is set to a |List| that contains these arguments. Note
8984that "a:1" is the same as "a:000[0]".
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00008985 *E742*
8986The a: scope and the variables in it cannot be changed, they are fixed.
Bram Moolenaar069c1e72016-07-15 21:25:08 +02008987However, if a composite type is used, such as |List| or |Dictionary| , you can
8988change their contents. Thus you can pass a |List| to a function and have the
8989function add an item to it. If you want to make sure the function cannot
8990change a |List| or |Dictionary| use |:lockvar|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008991
Bram Moolenaar8f999f12005-01-25 22:12:55 +00008992When not using "...", the number of arguments in a function call must be equal
8993to the number of named arguments. When using "...", the number of arguments
8994may be larger.
8995
8996It is also possible to define a function without any arguments. You must
8997still supply the () then. The body of the function follows in the next lines,
8998until the matching |:endfunction|. It is allowed to define another function
8999inside a function body.
9000
9001 *local-variables*
Bram Moolenaar069c1e72016-07-15 21:25:08 +02009002Inside a function local variables can be used. These will disappear when the
9003function returns. Global variables need to be accessed with "g:".
Bram Moolenaar071d4272004-06-13 20:20:40 +00009004
9005Example: >
9006 :function Table(title, ...)
9007 : echohl Title
9008 : echo a:title
9009 : echohl None
Bram Moolenaar677ee682005-01-27 14:41:15 +00009010 : echo a:0 . " items:"
9011 : for s in a:000
9012 : echon ' ' . s
9013 : endfor
Bram Moolenaar071d4272004-06-13 20:20:40 +00009014 :endfunction
9015
9016This function can then be called with: >
Bram Moolenaar677ee682005-01-27 14:41:15 +00009017 call Table("Table", "line1", "line2")
9018 call Table("Empty Table")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019
Bram Moolenaaref2f6562007-05-06 13:32:59 +00009020To return more than one value, return a |List|: >
9021 :function Compute(n1, n2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009022 : if a:n2 == 0
Bram Moolenaaref2f6562007-05-06 13:32:59 +00009023 : return ["fail", 0]
Bram Moolenaar071d4272004-06-13 20:20:40 +00009024 : endif
Bram Moolenaaref2f6562007-05-06 13:32:59 +00009025 : return ["ok", a:n1 / a:n2]
Bram Moolenaar071d4272004-06-13 20:20:40 +00009026 :endfunction
9027
9028This function can then be called with: >
Bram Moolenaaref2f6562007-05-06 13:32:59 +00009029 :let [success, div] = Compute(102, 6)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009030 :if success == "ok"
9031 : echo div
9032 :endif
Bram Moolenaaref2f6562007-05-06 13:32:59 +00009033<
Bram Moolenaar39f05632006-03-19 22:15:26 +00009034 *:cal* *:call* *E107* *E117*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009035:[range]cal[l] {name}([arguments])
9036 Call a function. The name of the function and its arguments
9037 are as specified with |:function|. Up to 20 arguments can be
Bram Moolenaaref2f6562007-05-06 13:32:59 +00009038 used. The returned value is discarded.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009039 Without a range and for functions that accept a range, the
9040 function is called once. When a range is given the cursor is
9041 positioned at the start of the first line before executing the
9042 function.
9043 When a range is given and the function doesn't handle it
9044 itself, the function is executed for each line in the range,
9045 with the cursor in the first column of that line. The cursor
9046 is left at the last line (possibly moved by the last function
Bram Moolenaar58b85342016-08-14 19:54:54 +02009047 call). The arguments are re-evaluated for each line. Thus
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048 this works:
9049 *function-range-example* >
9050 :function Mynumber(arg)
9051 : echo line(".") . " " . a:arg
9052 :endfunction
9053 :1,5call Mynumber(getline("."))
9054<
9055 The "a:firstline" and "a:lastline" are defined anyway, they
9056 can be used to do something different at the start or end of
9057 the range.
9058
9059 Example of a function that handles the range itself: >
9060
9061 :function Cont() range
9062 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ '
9063 :endfunction
9064 :4,8call Cont()
9065<
9066 This function inserts the continuation character "\" in front
9067 of all the lines in the range, except the first one.
9068
Bram Moolenaaref2f6562007-05-06 13:32:59 +00009069 When the function returns a composite value it can be further
9070 dereferenced, but the range will not be used then. Example: >
9071 :4,8call GetDict().method()
9072< Here GetDict() gets the range but method() does not.
9073
Bram Moolenaar071d4272004-06-13 20:20:40 +00009074 *E132*
9075The recursiveness of user functions is restricted with the |'maxfuncdepth'|
9076option.
9077
Bram Moolenaar7c626922005-02-07 22:01:03 +00009078
9079AUTOMATICALLY LOADING FUNCTIONS ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 *autoload-functions*
9081When using many or large functions, it's possible to automatically define them
Bram Moolenaar7c626922005-02-07 22:01:03 +00009082only when they are used. There are two methods: with an autocommand and with
9083the "autoload" directory in 'runtimepath'.
9084
9085
9086Using an autocommand ~
9087
Bram Moolenaar05159a02005-02-26 23:04:13 +00009088This is introduced in the user manual, section |41.14|.
9089
Bram Moolenaar7c626922005-02-07 22:01:03 +00009090The autocommand is useful if you have a plugin that is a long Vim script file.
9091You can define the autocommand and quickly quit the script with |:finish|.
Bram Moolenaar58b85342016-08-14 19:54:54 +02009092That makes Vim startup faster. The autocommand should then load the same file
Bram Moolenaar7c626922005-02-07 22:01:03 +00009093again, setting a variable to skip the |:finish| command.
9094
9095Use the FuncUndefined autocommand event with a pattern that matches the
9096function(s) to be defined. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097
9098 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim
9099
9100The file "~/vim/bufnetfuncs.vim" should then define functions that start with
9101"BufNet". Also see |FuncUndefined|.
9102
Bram Moolenaar7c626922005-02-07 22:01:03 +00009103
9104Using an autoload script ~
Bram Moolenaar26a60b42005-02-22 08:49:11 +00009105 *autoload* *E746*
Bram Moolenaar05159a02005-02-26 23:04:13 +00009106This is introduced in the user manual, section |41.15|.
9107
Bram Moolenaar7c626922005-02-07 22:01:03 +00009108Using a script in the "autoload" directory is simpler, but requires using
9109exactly the right file name. A function that can be autoloaded has a name
9110like this: >
9111
Bram Moolenaara7fc0102005-05-18 22:17:12 +00009112 :call filename#funcname()
Bram Moolenaar7c626922005-02-07 22:01:03 +00009113
9114When such a function is called, and it is not defined yet, Vim will search the
9115"autoload" directories in 'runtimepath' for a script file called
9116"filename.vim". For example "~/.vim/autoload/filename.vim". That file should
9117then define the function like this: >
9118
Bram Moolenaara7fc0102005-05-18 22:17:12 +00009119 function filename#funcname()
Bram Moolenaar7c626922005-02-07 22:01:03 +00009120 echo "Done!"
9121 endfunction
9122
Bram Moolenaar60a795a2005-09-16 21:55:43 +00009123The file name and the name used before the # in the function must match
Bram Moolenaar7c626922005-02-07 22:01:03 +00009124exactly, and the defined function must have the name exactly as it will be
9125called.
9126
Bram Moolenaara7fc0102005-05-18 22:17:12 +00009127It is possible to use subdirectories. Every # in the function name works like
9128a path separator. Thus when calling a function: >
Bram Moolenaar7c626922005-02-07 22:01:03 +00009129
Bram Moolenaara7fc0102005-05-18 22:17:12 +00009130 :call foo#bar#func()
Bram Moolenaar7c626922005-02-07 22:01:03 +00009131
9132Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'.
9133
Bram Moolenaar26a60b42005-02-22 08:49:11 +00009134This also works when reading a variable that has not been set yet: >
9135
Bram Moolenaara7fc0102005-05-18 22:17:12 +00009136 :let l = foo#bar#lvar
Bram Moolenaar26a60b42005-02-22 08:49:11 +00009137
Bram Moolenaara5792f52005-11-23 21:25:05 +00009138However, when the autoload script was already loaded it won't be loaded again
9139for an unknown variable.
9140
Bram Moolenaar26a60b42005-02-22 08:49:11 +00009141When assigning a value to such a variable nothing special happens. This can
9142be used to pass settings to the autoload script before it's loaded: >
9143
Bram Moolenaara7fc0102005-05-18 22:17:12 +00009144 :let foo#bar#toggle = 1
9145 :call foo#bar#func()
Bram Moolenaar26a60b42005-02-22 08:49:11 +00009146
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009147Note that when you make a mistake and call a function that is supposed to be
9148defined in an autoload script, but the script doesn't actually define the
9149function, the script will be sourced every time you try to call the function.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00009150And you will get an error message every time.
9151
9152Also note that if you have two script files, and one calls a function in the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009153other and vice versa, before the used function is defined, it won't work.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00009154Avoid using the autoload functionality at the toplevel.
Bram Moolenaar7c626922005-02-07 22:01:03 +00009155
Bram Moolenaar433f7c82006-03-21 21:29:36 +00009156Hint: If you distribute a bunch of scripts you can pack them together with the
9157|vimball| utility. Also read the user manual |distribute-script|.
9158
Bram Moolenaar071d4272004-06-13 20:20:40 +00009159==============================================================================
91606. Curly braces names *curly-braces-names*
9161
Bram Moolenaar84f72352012-03-11 15:57:40 +01009162In most places where you can use a variable, you can use a "curly braces name"
9163variable. This is a regular variable name with one or more expressions
9164wrapped in braces {} like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009165 my_{adjective}_variable
9166
9167When Vim encounters this, it evaluates the expression inside the braces, puts
9168that in place of the expression, and re-interprets the whole as a variable
9169name. So in the above example, if the variable "adjective" was set to
9170"noisy", then the reference would be to "my_noisy_variable", whereas if
9171"adjective" was set to "quiet", then it would be to "my_quiet_variable".
9172
9173One application for this is to create a set of variables governed by an option
Bram Moolenaar58b85342016-08-14 19:54:54 +02009174value. For example, the statement >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009175 echo my_{&background}_message
9176
9177would output the contents of "my_dark_message" or "my_light_message" depending
9178on the current value of 'background'.
9179
9180You can use multiple brace pairs: >
9181 echo my_{adverb}_{adjective}_message
9182..or even nest them: >
9183 echo my_{ad{end_of_word}}_message
9184where "end_of_word" is either "verb" or "jective".
9185
9186However, the expression inside the braces must evaluate to a valid single
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00009187variable name, e.g. this is invalid: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009188 :let foo='a + b'
9189 :echo c{foo}d
9190.. since the result of expansion is "ca + bd", which is not a variable name.
9191
9192 *curly-braces-function-names*
9193You can call and define functions by an evaluated name in a similar way.
9194Example: >
9195 :let func_end='whizz'
9196 :call my_func_{func_end}(parameter)
9197
9198This would call the function "my_func_whizz(parameter)".
9199
Bram Moolenaar84f72352012-03-11 15:57:40 +01009200This does NOT work: >
9201 :let i = 3
9202 :let @{i} = '' " error
9203 :echo @{i} " error
9204
Bram Moolenaar071d4272004-06-13 20:20:40 +00009205==============================================================================
92067. Commands *expression-commands*
9207
9208:let {var-name} = {expr1} *:let* *E18*
9209 Set internal variable {var-name} to the result of the
9210 expression {expr1}. The variable will get the type
9211 from the {expr}. If {var-name} didn't exist yet, it
9212 is created.
9213
Bram Moolenaar13065c42005-01-08 16:08:21 +00009214:let {var-name}[{idx}] = {expr1} *E689*
9215 Set a list item to the result of the expression
9216 {expr1}. {var-name} must refer to a list and {idx}
9217 must be a valid index in that list. For nested list
9218 the index can be repeated.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009219 This cannot be used to add an item to a |List|.
Bram Moolenaar58b85342016-08-14 19:54:54 +02009220 This cannot be used to set a byte in a String. You
Bram Moolenaar446cb832008-06-24 21:56:24 +00009221 can do that like this: >
9222 :let var = var[0:2] . 'X' . var[4:]
9223<
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00009224 *E711* *E719*
9225:let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00009226 Set a sequence of items in a |List| to the result of
9227 the expression {expr1}, which must be a list with the
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00009228 correct number of items.
9229 {idx1} can be omitted, zero is used instead.
9230 {idx2} can be omitted, meaning the end of the list.
9231 When the selected range of items is partly past the
9232 end of the list, items will be added.
9233
Bram Moolenaar748bf032005-02-02 23:04:36 +00009234 *:let+=* *:let-=* *:let.=* *E734*
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00009235:let {var} += {expr1} Like ":let {var} = {var} + {expr1}".
9236:let {var} -= {expr1} Like ":let {var} = {var} - {expr1}".
9237:let {var} .= {expr1} Like ":let {var} = {var} . {expr1}".
9238 These fail if {var} was not set yet and when the type
9239 of {var} and {expr1} don't fit the operator.
9240
9241
Bram Moolenaar071d4272004-06-13 20:20:40 +00009242:let ${env-name} = {expr1} *:let-environment* *:let-$*
9243 Set environment variable {env-name} to the result of
9244 the expression {expr1}. The type is always String.
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00009245:let ${env-name} .= {expr1}
9246 Append {expr1} to the environment variable {env-name}.
9247 If the environment variable didn't exist yet this
9248 works like "=".
Bram Moolenaar071d4272004-06-13 20:20:40 +00009249
9250:let @{reg-name} = {expr1} *:let-register* *:let-@*
9251 Write the result of the expression {expr1} in register
9252 {reg-name}. {reg-name} must be a single letter, and
9253 must be the name of a writable register (see
9254 |registers|). "@@" can be used for the unnamed
9255 register, "@/" for the search pattern.
9256 If the result of {expr1} ends in a <CR> or <NL>, the
9257 register will be linewise, otherwise it will be set to
9258 characterwise.
9259 This can be used to clear the last search pattern: >
9260 :let @/ = ""
9261< This is different from searching for an empty string,
9262 that would match everywhere.
9263
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00009264:let @{reg-name} .= {expr1}
Bram Moolenaar58b85342016-08-14 19:54:54 +02009265 Append {expr1} to register {reg-name}. If the
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00009266 register was empty it's like setting it to {expr1}.
9267
Bram Moolenaaref2f6562007-05-06 13:32:59 +00009268:let &{option-name} = {expr1} *:let-option* *:let-&*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009269 Set option {option-name} to the result of the
Bram Moolenaarfca34d62005-01-04 21:38:36 +00009270 expression {expr1}. A String or Number value is
9271 always converted to the type of the option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009272 For an option local to a window or buffer the effect
9273 is just like using the |:set| command: both the local
Bram Moolenaara5fac542005-10-12 20:58:49 +00009274 value and the global value are changed.
Bram Moolenaarfca34d62005-01-04 21:38:36 +00009275 Example: >
9276 :let &path = &path . ',/usr/local/include'
Bram Moolenaar3df01732017-02-17 22:47:16 +01009277< This also works for terminal codes in the form t_xx.
9278 But only for alphanumerical names. Example: >
9279 :let &t_k1 = "\<Esc>[234;"
9280< When the code does not exist yet it will be created as
9281 a terminal key code, there is no error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009282
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00009283:let &{option-name} .= {expr1}
9284 For a string option: Append {expr1} to the value.
9285 Does not insert a comma like |:set+=|.
9286
9287:let &{option-name} += {expr1}
9288:let &{option-name} -= {expr1}
9289 For a number or boolean option: Add or subtract
9290 {expr1}.
9291
Bram Moolenaar071d4272004-06-13 20:20:40 +00009292:let &l:{option-name} = {expr1}
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00009293:let &l:{option-name} .= {expr1}
9294:let &l:{option-name} += {expr1}
9295:let &l:{option-name} -= {expr1}
Bram Moolenaar071d4272004-06-13 20:20:40 +00009296 Like above, but only set the local value of an option
9297 (if there is one). Works like |:setlocal|.
9298
9299:let &g:{option-name} = {expr1}
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00009300:let &g:{option-name} .= {expr1}
9301:let &g:{option-name} += {expr1}
9302:let &g:{option-name} -= {expr1}
Bram Moolenaar071d4272004-06-13 20:20:40 +00009303 Like above, but only set the global value of an option
9304 (if there is one). Works like |:setglobal|.
9305
Bram Moolenaar13065c42005-01-08 16:08:21 +00009306:let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00009307 {expr1} must evaluate to a |List|. The first item in
Bram Moolenaarfca34d62005-01-04 21:38:36 +00009308 the list is assigned to {name1}, the second item to
9309 {name2}, etc.
9310 The number of names must match the number of items in
Bram Moolenaar32466aa2006-02-24 23:53:04 +00009311 the |List|.
Bram Moolenaarfca34d62005-01-04 21:38:36 +00009312 Each name can be one of the items of the ":let"
9313 command as mentioned above.
9314 Example: >
9315 :let [s, item] = GetItem(s)
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00009316< Detail: {expr1} is evaluated first, then the
9317 assignments are done in sequence. This matters if
9318 {name2} depends on {name1}. Example: >
9319 :let x = [0, 1]
9320 :let i = 0
9321 :let [i, x[i]] = [1, 2]
9322 :echo x
9323< The result is [0, 2].
9324
9325:let [{name1}, {name2}, ...] .= {expr1}
9326:let [{name1}, {name2}, ...] += {expr1}
9327:let [{name1}, {name2}, ...] -= {expr1}
9328 Like above, but append/add/subtract the value for each
Bram Moolenaar32466aa2006-02-24 23:53:04 +00009329 |List| item.
Bram Moolenaarfca34d62005-01-04 21:38:36 +00009330
9331:let [{name}, ..., ; {lastname}] = {expr1}
Bram Moolenaar32466aa2006-02-24 23:53:04 +00009332 Like |:let-unpack| above, but the |List| may have more
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00009333 items than there are names. A list of the remaining
9334 items is assigned to {lastname}. If there are no
9335 remaining items {lastname} is set to an empty list.
Bram Moolenaarfca34d62005-01-04 21:38:36 +00009336 Example: >
9337 :let [a, b; rest] = ["aval", "bval", 3, 4]
9338<
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00009339:let [{name}, ..., ; {lastname}] .= {expr1}
9340:let [{name}, ..., ; {lastname}] += {expr1}
9341:let [{name}, ..., ; {lastname}] -= {expr1}
9342 Like above, but append/add/subtract the value for each
Bram Moolenaar32466aa2006-02-24 23:53:04 +00009343 |List| item.
Bram Moolenaar4a748032010-09-30 21:47:56 +02009344
9345 *E121*
Bram Moolenaar58b85342016-08-14 19:54:54 +02009346:let {var-name} .. List the value of variable {var-name}. Multiple
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00009347 variable names may be given. Special names recognized
9348 here: *E738*
Bram Moolenaarca003e12006-03-17 23:19:38 +00009349 g: global variables
9350 b: local buffer variables
9351 w: local window variables
Bram Moolenaar910f66f2006-04-05 20:41:53 +00009352 t: local tab page variables
Bram Moolenaarca003e12006-03-17 23:19:38 +00009353 s: script-local variables
9354 l: local function variables
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00009355 v: Vim variables.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009356
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00009357:let List the values of all variables. The type of the
9358 variable is indicated before the value:
9359 <nothing> String
9360 # Number
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009361 * Funcref
Bram Moolenaar071d4272004-06-13 20:20:40 +00009362
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00009363
Bram Moolenaaref2f6562007-05-06 13:32:59 +00009364:unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795*
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00009365 Remove the internal variable {name}. Several variable
9366 names can be given, they are all removed. The name
Bram Moolenaar32466aa2006-02-24 23:53:04 +00009367 may also be a |List| or |Dictionary| item.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009368 With [!] no error message is given for non-existing
9369 variables.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00009370 One or more items from a |List| can be removed: >
Bram Moolenaar9cd15162005-01-16 22:02:49 +00009371 :unlet list[3] " remove fourth item
9372 :unlet list[3:] " remove fourth item to last
Bram Moolenaar32466aa2006-02-24 23:53:04 +00009373< One item from a |Dictionary| can be removed at a time: >
Bram Moolenaar9cd15162005-01-16 22:02:49 +00009374 :unlet dict['two']
9375 :unlet dict.two
Bram Moolenaarc236c162008-07-13 17:41:49 +00009376< This is especially useful to clean up used global
9377 variables and script-local variables (these are not
9378 deleted when the script ends). Function-local
9379 variables are automatically deleted when the function
9380 ends.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009381
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00009382:lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv*
9383 Lock the internal variable {name}. Locking means that
9384 it can no longer be changed (until it is unlocked).
9385 A locked variable can be deleted: >
9386 :lockvar v
9387 :let v = 'asdf' " fails!
9388 :unlet v
Bram Moolenaare7877fe2017-02-20 22:35:33 +01009389< *E741* *E940*
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00009390 If you try to change a locked variable you get an
Bram Moolenaare7877fe2017-02-20 22:35:33 +01009391 error message: "E741: Value is locked: {name}".
9392 If you try to lock or unlock a built-in variable you
9393 get an error message: "E940: Cannot lock or unlock
9394 variable {name}".
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00009395
Bram Moolenaar32466aa2006-02-24 23:53:04 +00009396 [depth] is relevant when locking a |List| or
9397 |Dictionary|. It specifies how deep the locking goes:
9398 1 Lock the |List| or |Dictionary| itself,
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00009399 cannot add or remove items, but can
9400 still change their values.
9401 2 Also lock the values, cannot change
Bram Moolenaar32466aa2006-02-24 23:53:04 +00009402 the items. If an item is a |List| or
9403 |Dictionary|, cannot add or remove
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00009404 items, but can still change the
9405 values.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00009406 3 Like 2 but for the |List| /
9407 |Dictionary| in the |List| /
9408 |Dictionary|, one level deeper.
9409 The default [depth] is 2, thus when {name} is a |List|
9410 or |Dictionary| the values cannot be changed.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00009411 *E743*
9412 For unlimited depth use [!] and omit [depth].
9413 However, there is a maximum depth of 100 to catch
9414 loops.
9415
Bram Moolenaar32466aa2006-02-24 23:53:04 +00009416 Note that when two variables refer to the same |List|
9417 and you lock one of them, the |List| will also be
Bram Moolenaar910f66f2006-04-05 20:41:53 +00009418 locked when used through the other variable.
9419 Example: >
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00009420 :let l = [0, 1, 2, 3]
9421 :let cl = l
9422 :lockvar l
9423 :let cl[1] = 99 " won't work!
9424< You may want to make a copy of a list to avoid this.
9425 See |deepcopy()|.
9426
9427
9428:unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo*
9429 Unlock the internal variable {name}. Does the
9430 opposite of |:lockvar|.
9431
9432
Bram Moolenaar071d4272004-06-13 20:20:40 +00009433:if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580*
9434:en[dif] Execute the commands until the next matching ":else"
9435 or ":endif" if {expr1} evaluates to non-zero.
9436
9437 From Vim version 4.5 until 5.0, every Ex command in
9438 between the ":if" and ":endif" is ignored. These two
9439 commands were just to allow for future expansions in a
Bram Moolenaar85084ef2016-01-17 22:26:33 +01009440 backward compatible way. Nesting was allowed. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00009441 that any ":else" or ":elseif" was ignored, the "else"
9442 part was not executed either.
9443
9444 You can use this to remain compatible with older
9445 versions: >
9446 :if version >= 500
9447 : version-5-specific-commands
9448 :endif
9449< The commands still need to be parsed to find the
9450 "endif". Sometimes an older Vim has a problem with a
9451 new command. For example, ":silent" is recognized as
9452 a ":substitute" command. In that case ":execute" can
9453 avoid problems: >
9454 :if version >= 600
9455 : execute "silent 1,$delete"
9456 :endif
9457<
9458 NOTE: The ":append" and ":insert" commands don't work
9459 properly in between ":if" and ":endif".
9460
9461 *:else* *:el* *E581* *E583*
9462:el[se] Execute the commands until the next matching ":else"
9463 or ":endif" if they previously were not being
9464 executed.
9465
9466 *:elseif* *:elsei* *E582* *E584*
9467:elsei[f] {expr1} Short for ":else" ":if", with the addition that there
9468 is no extra ":endif".
9469
9470:wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw*
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00009471 *E170* *E585* *E588* *E733*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009472:endw[hile] Repeat the commands between ":while" and ":endwhile",
9473 as long as {expr1} evaluates to non-zero.
9474 When an error is detected from a command inside the
9475 loop, execution continues after the "endwhile".
Bram Moolenaar12805862005-01-05 22:16:17 +00009476 Example: >
9477 :let lnum = 1
9478 :while lnum <= line("$")
9479 :call FixLine(lnum)
9480 :let lnum = lnum + 1
9481 :endwhile
9482<
Bram Moolenaar071d4272004-06-13 20:20:40 +00009483 NOTE: The ":append" and ":insert" commands don't work
Bram Moolenaard8b02732005-01-14 21:48:43 +00009484 properly inside a ":while" and ":for" loop.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009485
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00009486:for {var} in {list} *:for* *E690* *E732*
Bram Moolenaar12805862005-01-05 22:16:17 +00009487:endfo[r] *:endfo* *:endfor*
9488 Repeat the commands between ":for" and ":endfor" for
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00009489 each item in {list}. Variable {var} is set to the
Bram Moolenaarde8866b2005-01-06 23:24:37 +00009490 value of each item.
9491 When an error is detected for a command inside the
Bram Moolenaar12805862005-01-05 22:16:17 +00009492 loop, execution continues after the "endfor".
Bram Moolenaar572cb562005-08-05 21:35:02 +00009493 Changing {list} inside the loop affects what items are
9494 used. Make a copy if this is unwanted: >
Bram Moolenaarde8866b2005-01-06 23:24:37 +00009495 :for item in copy(mylist)
9496< When not making a copy, Vim stores a reference to the
9497 next item in the list, before executing the commands
Bram Moolenaar58b85342016-08-14 19:54:54 +02009498 with the current item. Thus the current item can be
Bram Moolenaarde8866b2005-01-06 23:24:37 +00009499 removed without effect. Removing any later item means
9500 it will not be found. Thus the following example
9501 works (an inefficient way to make a list empty): >
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009502 for item in mylist
9503 call remove(mylist, 0)
9504 endfor
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00009505< Note that reordering the list (e.g., with sort() or
9506 reverse()) may have unexpected effects.
Bram Moolenaar12805862005-01-05 22:16:17 +00009507
Bram Moolenaar12805862005-01-05 22:16:17 +00009508:for [{var1}, {var2}, ...] in {listlist}
9509:endfo[r]
9510 Like ":for" above, but each item in {listlist} must be
9511 a list, of which each item is assigned to {var1},
9512 {var2}, etc. Example: >
9513 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]]
9514 :echo getline(lnum)[col]
9515 :endfor
9516<
Bram Moolenaar071d4272004-06-13 20:20:40 +00009517 *:continue* *:con* *E586*
Bram Moolenaar12805862005-01-05 22:16:17 +00009518:con[tinue] When used inside a ":while" or ":for" loop, jumps back
9519 to the start of the loop.
9520 If it is used after a |:try| inside the loop but
9521 before the matching |:finally| (if present), the
9522 commands following the ":finally" up to the matching
9523 |:endtry| are executed first. This process applies to
9524 all nested ":try"s inside the loop. The outermost
9525 ":endtry" then jumps back to the start of the loop.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009526
9527 *:break* *:brea* *E587*
Bram Moolenaar12805862005-01-05 22:16:17 +00009528:brea[k] When used inside a ":while" or ":for" loop, skips to
9529 the command after the matching ":endwhile" or
9530 ":endfor".
9531 If it is used after a |:try| inside the loop but
9532 before the matching |:finally| (if present), the
9533 commands following the ":finally" up to the matching
9534 |:endtry| are executed first. This process applies to
9535 all nested ":try"s inside the loop. The outermost
9536 ":endtry" then jumps to the command after the loop.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009537
9538:try *:try* *:endt* *:endtry* *E600* *E601* *E602*
9539:endt[ry] Change the error handling for the commands between
9540 ":try" and ":endtry" including everything being
9541 executed across ":source" commands, function calls,
9542 or autocommand invocations.
9543
9544 When an error or interrupt is detected and there is
9545 a |:finally| command following, execution continues
9546 after the ":finally". Otherwise, or when the
9547 ":endtry" is reached thereafter, the next
9548 (dynamically) surrounding ":try" is checked for
9549 a corresponding ":finally" etc. Then the script
9550 processing is terminated. (Whether a function
9551 definition has an "abort" argument does not matter.)
9552 Example: >
9553 :try | edit too much | finally | echo "cleanup" | endtry
9554 :echo "impossible" " not reached, script terminated above
9555<
9556 Moreover, an error or interrupt (dynamically) inside
9557 ":try" and ":endtry" is converted to an exception. It
9558 can be caught as if it were thrown by a |:throw|
9559 command (see |:catch|). In this case, the script
9560 processing is not terminated.
9561
9562 The value "Vim:Interrupt" is used for an interrupt
9563 exception. An error in a Vim command is converted
9564 to a value of the form "Vim({command}):{errmsg}",
9565 other errors are converted to a value of the form
9566 "Vim:{errmsg}". {command} is the full command name,
9567 and {errmsg} is the message that is displayed if the
9568 error exception is not caught, always beginning with
9569 the error number.
9570 Examples: >
9571 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry
9572 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry
9573<
9574 *:cat* *:catch* *E603* *E604* *E605*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009575:cat[ch] /{pattern}/ The following commands until the next |:catch|,
Bram Moolenaar071d4272004-06-13 20:20:40 +00009576 |:finally|, or |:endtry| that belongs to the same
9577 |:try| as the ":catch" are executed when an exception
9578 matching {pattern} is being thrown and has not yet
9579 been caught by a previous ":catch". Otherwise, these
9580 commands are skipped.
9581 When {pattern} is omitted all errors are caught.
9582 Examples: >
9583 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C)
9584 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors
9585 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts
9586 :catch /^Vim(write):/ " catch all errors in :write
9587 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123
9588 :catch /my-exception/ " catch user exception
9589 :catch /.*/ " catch everything
9590 :catch " same as /.*/
9591<
9592 Another character can be used instead of / around the
9593 {pattern}, so long as it does not have a special
9594 meaning (e.g., '|' or '"') and doesn't occur inside
9595 {pattern}.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +02009596 Information about the exception is available in
9597 |v:exception|. Also see |throw-variables|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009598 NOTE: It is not reliable to ":catch" the TEXT of
9599 an error message because it may vary in different
9600 locales.
9601
9602 *:fina* *:finally* *E606* *E607*
9603:fina[lly] The following commands until the matching |:endtry|
9604 are executed whenever the part between the matching
9605 |:try| and the ":finally" is left: either by falling
9606 through to the ":finally" or by a |:continue|,
9607 |:break|, |:finish|, or |:return|, or by an error or
9608 interrupt or exception (see |:throw|).
9609
9610 *:th* *:throw* *E608*
9611:th[row] {expr1} The {expr1} is evaluated and thrown as an exception.
9612 If the ":throw" is used after a |:try| but before the
9613 first corresponding |:catch|, commands are skipped
9614 until the first ":catch" matching {expr1} is reached.
9615 If there is no such ":catch" or if the ":throw" is
9616 used after a ":catch" but before the |:finally|, the
9617 commands following the ":finally" (if present) up to
9618 the matching |:endtry| are executed. If the ":throw"
9619 is after the ":finally", commands up to the ":endtry"
9620 are skipped. At the ":endtry", this process applies
9621 again for the next dynamically surrounding ":try"
9622 (which may be found in a calling function or sourcing
9623 script), until a matching ":catch" has been found.
9624 If the exception is not caught, the command processing
9625 is terminated.
9626 Example: >
9627 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry
Bram Moolenaar662db672011-03-22 14:05:35 +01009628< Note that "catch" may need to be on a separate line
9629 for when an error causes the parsing to skip the whole
9630 line and not see the "|" that separates the commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009631
9632 *:ec* *:echo*
9633:ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The
9634 first {expr1} starts on a new line.
9635 Also see |:comment|.
9636 Use "\n" to start a new line. Use "\r" to move the
9637 cursor to the first column.
9638 Uses the highlighting set by the |:echohl| command.
9639 Cannot be followed by a comment.
9640 Example: >
9641 :echo "the value of 'shell' is" &shell
Bram Moolenaaref2f6562007-05-06 13:32:59 +00009642< *:echo-redraw*
9643 A later redraw may make the message disappear again.
9644 And since Vim mostly postpones redrawing until it's
9645 finished with a sequence of commands this happens
9646 quite often. To avoid that a command from before the
9647 ":echo" causes a redraw afterwards (redraws are often
9648 postponed until you type something), force a redraw
9649 with the |:redraw| command. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009650 :new | redraw | echo "there is a new window"
9651<
9652 *:echon*
9653:echon {expr1} .. Echoes each {expr1}, without anything added. Also see
9654 |:comment|.
9655 Uses the highlighting set by the |:echohl| command.
9656 Cannot be followed by a comment.
9657 Example: >
9658 :echon "the value of 'shell' is " &shell
9659<
9660 Note the difference between using ":echo", which is a
9661 Vim command, and ":!echo", which is an external shell
9662 command: >
9663 :!echo % --> filename
9664< The arguments of ":!" are expanded, see |:_%|. >
9665 :!echo "%" --> filename or "filename"
9666< Like the previous example. Whether you see the double
9667 quotes or not depends on your 'shell'. >
9668 :echo % --> nothing
9669< The '%' is an illegal character in an expression. >
9670 :echo "%" --> %
9671< This just echoes the '%' character. >
9672 :echo expand("%") --> filename
9673< This calls the expand() function to expand the '%'.
9674
9675 *:echoh* *:echohl*
9676:echoh[l] {name} Use the highlight group {name} for the following
9677 |:echo|, |:echon| and |:echomsg| commands. Also used
9678 for the |input()| prompt. Example: >
9679 :echohl WarningMsg | echo "Don't panic!" | echohl None
9680< Don't forget to set the group back to "None",
9681 otherwise all following echo's will be highlighted.
9682
9683 *:echom* *:echomsg*
9684:echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the
9685 message in the |message-history|.
9686 Spaces are placed between the arguments as with the
9687 |:echo| command. But unprintable characters are
9688 displayed, not interpreted.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00009689 The parsing works slightly different from |:echo|,
9690 more like |:execute|. All the expressions are first
9691 evaluated and concatenated before echoing anything.
9692 The expressions must evaluate to a Number or String, a
9693 Dictionary or List causes an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009694 Uses the highlighting set by the |:echohl| command.
9695 Example: >
9696 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see."
Bram Moolenaaref2f6562007-05-06 13:32:59 +00009697< See |:echo-redraw| to avoid the message disappearing
9698 when the screen is redrawn.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009699 *:echoe* *:echoerr*
9700:echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the
9701 message in the |message-history|. When used in a
9702 script or function the line number will be added.
9703 Spaces are placed between the arguments as with the
Bram Moolenaar58b85342016-08-14 19:54:54 +02009704 :echo command. When used inside a try conditional,
Bram Moolenaar071d4272004-06-13 20:20:40 +00009705 the message is raised as an error exception instead
9706 (see |try-echoerr|).
9707 Example: >
9708 :echoerr "This script just failed!"
9709< If you just want a highlighted message use |:echohl|.
9710 And to get a beep: >
9711 :exe "normal \<Esc>"
9712<
9713 *:exe* *:execute*
9714:exe[cute] {expr1} .. Executes the string that results from the evaluation
Bram Moolenaar00a927d2010-05-14 23:24:24 +02009715 of {expr1} as an Ex command.
9716 Multiple arguments are concatenated, with a space in
9717 between. To avoid the extra space use the "."
9718 operator to concatenate strings into one argument.
9719 {expr1} is used as the processed command, command line
9720 editing keys are not recognized.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009721 Cannot be followed by a comment.
9722 Examples: >
Bram Moolenaar00a927d2010-05-14 23:24:24 +02009723 :execute "buffer" nextbuf
9724 :execute "normal" count . "w"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009725<
9726 ":execute" can be used to append a command to commands
9727 that don't accept a '|'. Example: >
9728 :execute '!ls' | echo "theend"
9729
9730< ":execute" is also a nice way to avoid having to type
9731 control characters in a Vim script for a ":normal"
9732 command: >
9733 :execute "normal ixxx\<Esc>"
9734< This has an <Esc> character, see |expr-string|.
9735
Bram Moolenaar446cb832008-06-24 21:56:24 +00009736 Be careful to correctly escape special characters in
9737 file names. The |fnameescape()| function can be used
Bram Moolenaar05bb9532008-07-04 09:44:11 +00009738 for Vim commands, |shellescape()| for |:!| commands.
9739 Examples: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00009740 :execute "e " . fnameescape(filename)
Bram Moolenaar251835e2014-02-24 02:51:51 +01009741 :execute "!ls " . shellescape(filename, 1)
Bram Moolenaar446cb832008-06-24 21:56:24 +00009742<
Bram Moolenaar071d4272004-06-13 20:20:40 +00009743 Note: The executed string may be any command-line, but
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01009744 starting or ending "if", "while" and "for" does not
9745 always work, because when commands are skipped the
9746 ":execute" is not evaluated and Vim loses track of
9747 where blocks start and end. Also "break" and
9748 "continue" should not be inside ":execute".
9749 This example does not work, because the ":execute" is
9750 not evaluated and Vim does not see the "while", and
9751 gives an error for finding an ":endwhile": >
9752 :if 0
9753 : execute 'while i > 5'
9754 : echo "test"
9755 : endwhile
9756 :endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00009757<
9758 It is allowed to have a "while" or "if" command
9759 completely in the executed string: >
9760 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile'
9761<
9762
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009763 *:exe-comment*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009764 ":execute", ":echo" and ":echon" cannot be followed by
9765 a comment directly, because they see the '"' as the
9766 start of a string. But, you can use '|' followed by a
9767 comment. Example: >
9768 :echo "foo" | "this is a comment
9769
9770==============================================================================
97718. Exception handling *exception-handling*
9772
9773The Vim script language comprises an exception handling feature. This section
9774explains how it can be used in a Vim script.
9775
9776Exceptions may be raised by Vim on an error or on interrupt, see
9777|catch-errors| and |catch-interrupt|. You can also explicitly throw an
9778exception by using the ":throw" command, see |throw-catch|.
9779
9780
9781TRY CONDITIONALS *try-conditionals*
9782
9783Exceptions can be caught or can cause cleanup code to be executed. You can
9784use a try conditional to specify catch clauses (that catch exceptions) and/or
9785a finally clause (to be executed for cleanup).
9786 A try conditional begins with a |:try| command and ends at the matching
9787|:endtry| command. In between, you can use a |:catch| command to start
9788a catch clause, or a |:finally| command to start a finally clause. There may
9789be none or multiple catch clauses, but there is at most one finally clause,
9790which must not be followed by any catch clauses. The lines before the catch
9791clauses and the finally clause is called a try block. >
9792
9793 :try
Bram Moolenaar446cb832008-06-24 21:56:24 +00009794 : ...
9795 : ... TRY BLOCK
9796 : ...
Bram Moolenaar071d4272004-06-13 20:20:40 +00009797 :catch /{pattern}/
Bram Moolenaar446cb832008-06-24 21:56:24 +00009798 : ...
9799 : ... CATCH CLAUSE
9800 : ...
Bram Moolenaar071d4272004-06-13 20:20:40 +00009801 :catch /{pattern}/
Bram Moolenaar446cb832008-06-24 21:56:24 +00009802 : ...
9803 : ... CATCH CLAUSE
9804 : ...
Bram Moolenaar071d4272004-06-13 20:20:40 +00009805 :finally
Bram Moolenaar446cb832008-06-24 21:56:24 +00009806 : ...
9807 : ... FINALLY CLAUSE
9808 : ...
Bram Moolenaar071d4272004-06-13 20:20:40 +00009809 :endtry
9810
9811The try conditional allows to watch code for exceptions and to take the
9812appropriate actions. Exceptions from the try block may be caught. Exceptions
9813from the try block and also the catch clauses may cause cleanup actions.
9814 When no exception is thrown during execution of the try block, the control
9815is transferred to the finally clause, if present. After its execution, the
9816script continues with the line following the ":endtry".
9817 When an exception occurs during execution of the try block, the remaining
9818lines in the try block are skipped. The exception is matched against the
9819patterns specified as arguments to the ":catch" commands. The catch clause
9820after the first matching ":catch" is taken, other catch clauses are not
9821executed. The catch clause ends when the next ":catch", ":finally", or
9822":endtry" command is reached - whatever is first. Then, the finally clause
9823(if present) is executed. When the ":endtry" is reached, the script execution
9824continues in the following line as usual.
9825 When an exception that does not match any of the patterns specified by the
9826":catch" commands is thrown in the try block, the exception is not caught by
9827that try conditional and none of the catch clauses is executed. Only the
9828finally clause, if present, is taken. The exception pends during execution of
9829the finally clause. It is resumed at the ":endtry", so that commands after
9830the ":endtry" are not executed and the exception might be caught elsewhere,
9831see |try-nesting|.
9832 When during execution of a catch clause another exception is thrown, the
Bram Moolenaar58b85342016-08-14 19:54:54 +02009833remaining lines in that catch clause are not executed. The new exception is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009834not matched against the patterns in any of the ":catch" commands of the same
9835try conditional and none of its catch clauses is taken. If there is, however,
9836a finally clause, it is executed, and the exception pends during its
9837execution. The commands following the ":endtry" are not executed. The new
9838exception might, however, be caught elsewhere, see |try-nesting|.
9839 When during execution of the finally clause (if present) an exception is
Bram Moolenaar58b85342016-08-14 19:54:54 +02009840thrown, the remaining lines in the finally clause are skipped. If the finally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009841clause has been taken because of an exception from the try block or one of the
9842catch clauses, the original (pending) exception is discarded. The commands
9843following the ":endtry" are not executed, and the exception from the finally
9844clause is propagated and can be caught elsewhere, see |try-nesting|.
9845
9846The finally clause is also executed, when a ":break" or ":continue" for
9847a ":while" loop enclosing the complete try conditional is executed from the
9848try block or a catch clause. Or when a ":return" or ":finish" is executed
9849from the try block or a catch clause of a try conditional in a function or
9850sourced script, respectively. The ":break", ":continue", ":return", or
9851":finish" pends during execution of the finally clause and is resumed when the
9852":endtry" is reached. It is, however, discarded when an exception is thrown
9853from the finally clause.
9854 When a ":break" or ":continue" for a ":while" loop enclosing the complete
9855try conditional or when a ":return" or ":finish" is encountered in the finally
9856clause, the rest of the finally clause is skipped, and the ":break",
9857":continue", ":return" or ":finish" is executed as usual. If the finally
9858clause has been taken because of an exception or an earlier ":break",
9859":continue", ":return", or ":finish" from the try block or a catch clause,
9860this pending exception or command is discarded.
9861
9862For examples see |throw-catch| and |try-finally|.
9863
9864
9865NESTING OF TRY CONDITIONALS *try-nesting*
9866
9867Try conditionals can be nested arbitrarily. That is, a complete try
9868conditional can be put into the try block, a catch clause, or the finally
9869clause of another try conditional. If the inner try conditional does not
9870catch an exception thrown in its try block or throws a new exception from one
9871of its catch clauses or its finally clause, the outer try conditional is
9872checked according to the rules above. If the inner try conditional is in the
9873try block of the outer try conditional, its catch clauses are checked, but
Bram Moolenaar58b85342016-08-14 19:54:54 +02009874otherwise only the finally clause is executed. It does not matter for
Bram Moolenaar071d4272004-06-13 20:20:40 +00009875nesting, whether the inner try conditional is directly contained in the outer
9876one, or whether the outer one sources a script or calls a function containing
9877the inner try conditional.
9878
9879When none of the active try conditionals catches an exception, just their
9880finally clauses are executed. Thereafter, the script processing terminates.
9881An error message is displayed in case of an uncaught exception explicitly
9882thrown by a ":throw" command. For uncaught error and interrupt exceptions
9883implicitly raised by Vim, the error message(s) or interrupt message are shown
9884as usual.
9885
9886For examples see |throw-catch|.
9887
9888
9889EXAMINING EXCEPTION HANDLING CODE *except-examine*
9890
9891Exception handling code can get tricky. If you are in doubt what happens, set
9892'verbose' to 13 or use the ":13verbose" command modifier when sourcing your
9893script file. Then you see when an exception is thrown, discarded, caught, or
9894finished. When using a verbosity level of at least 14, things pending in
9895a finally clause are also shown. This information is also given in debug mode
9896(see |debug-scripts|).
9897
9898
9899THROWING AND CATCHING EXCEPTIONS *throw-catch*
9900
9901You can throw any number or string as an exception. Use the |:throw| command
9902and pass the value to be thrown as argument: >
9903 :throw 4711
9904 :throw "string"
9905< *throw-expression*
9906You can also specify an expression argument. The expression is then evaluated
9907first, and the result is thrown: >
9908 :throw 4705 + strlen("string")
9909 :throw strpart("strings", 0, 6)
9910
9911An exception might be thrown during evaluation of the argument of the ":throw"
9912command. Unless it is caught there, the expression evaluation is abandoned.
9913The ":throw" command then does not throw a new exception.
9914 Example: >
9915
9916 :function! Foo(arg)
9917 : try
9918 : throw a:arg
9919 : catch /foo/
9920 : endtry
9921 : return 1
9922 :endfunction
9923 :
9924 :function! Bar()
9925 : echo "in Bar"
9926 : return 4710
9927 :endfunction
9928 :
9929 :throw Foo("arrgh") + Bar()
9930
9931This throws "arrgh", and "in Bar" is not displayed since Bar() is not
9932executed. >
9933 :throw Foo("foo") + Bar()
9934however displays "in Bar" and throws 4711.
9935
9936Any other command that takes an expression as argument might also be
Bram Moolenaar58b85342016-08-14 19:54:54 +02009937abandoned by an (uncaught) exception during the expression evaluation. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009938exception is then propagated to the caller of the command.
9939 Example: >
9940
9941 :if Foo("arrgh")
9942 : echo "then"
9943 :else
9944 : echo "else"
9945 :endif
9946
9947Here neither of "then" or "else" is displayed.
9948
9949 *catch-order*
9950Exceptions can be caught by a try conditional with one or more |:catch|
9951commands, see |try-conditionals|. The values to be caught by each ":catch"
9952command can be specified as a pattern argument. The subsequent catch clause
9953gets executed when a matching exception is caught.
9954 Example: >
9955
9956 :function! Foo(value)
9957 : try
9958 : throw a:value
9959 : catch /^\d\+$/
9960 : echo "Number thrown"
9961 : catch /.*/
9962 : echo "String thrown"
9963 : endtry
9964 :endfunction
9965 :
9966 :call Foo(0x1267)
9967 :call Foo('string')
9968
9969The first call to Foo() displays "Number thrown", the second "String thrown".
9970An exception is matched against the ":catch" commands in the order they are
9971specified. Only the first match counts. So you should place the more
9972specific ":catch" first. The following order does not make sense: >
9973
9974 : catch /.*/
9975 : echo "String thrown"
9976 : catch /^\d\+$/
9977 : echo "Number thrown"
9978
9979The first ":catch" here matches always, so that the second catch clause is
9980never taken.
9981
9982 *throw-variables*
9983If you catch an exception by a general pattern, you may access the exact value
9984in the variable |v:exception|: >
9985
9986 : catch /^\d\+$/
9987 : echo "Number thrown. Value is" v:exception
9988
9989You may also be interested where an exception was thrown. This is stored in
9990|v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the
9991exception most recently caught as long it is not finished.
9992 Example: >
9993
9994 :function! Caught()
9995 : if v:exception != ""
9996 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint
9997 : else
9998 : echo 'Nothing caught'
9999 : endif
10000 :endfunction
10001 :
10002 :function! Foo()
10003 : try
10004 : try
10005 : try
10006 : throw 4711
10007 : finally
10008 : call Caught()
10009 : endtry
10010 : catch /.*/
10011 : call Caught()
10012 : throw "oops"
10013 : endtry
10014 : catch /.*/
10015 : call Caught()
10016 : finally
10017 : call Caught()
10018 : endtry
10019 :endfunction
10020 :
10021 :call Foo()
10022
10023This displays >
10024
10025 Nothing caught
10026 Caught "4711" in function Foo, line 4
10027 Caught "oops" in function Foo, line 10
10028 Nothing caught
10029
10030A practical example: The following command ":LineNumber" displays the line
10031number in the script or function where it has been used: >
10032
10033 :function! LineNumber()
10034 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "")
10035 :endfunction
10036 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry
10037<
10038 *try-nested*
10039An exception that is not caught by a try conditional can be caught by
10040a surrounding try conditional: >
10041
10042 :try
10043 : try
10044 : throw "foo"
10045 : catch /foobar/
10046 : echo "foobar"
10047 : finally
10048 : echo "inner finally"
10049 : endtry
10050 :catch /foo/
10051 : echo "foo"
10052 :endtry
10053
10054The inner try conditional does not catch the exception, just its finally
10055clause is executed. The exception is then caught by the outer try
10056conditional. The example displays "inner finally" and then "foo".
10057
10058 *throw-from-catch*
10059You can catch an exception and throw a new one to be caught elsewhere from the
10060catch clause: >
10061
10062 :function! Foo()
10063 : throw "foo"
10064 :endfunction
10065 :
10066 :function! Bar()
10067 : try
10068 : call Foo()
10069 : catch /foo/
10070 : echo "Caught foo, throw bar"
10071 : throw "bar"
10072 : endtry
10073 :endfunction
10074 :
10075 :try
10076 : call Bar()
10077 :catch /.*/
10078 : echo "Caught" v:exception
10079 :endtry
10080
10081This displays "Caught foo, throw bar" and then "Caught bar".
10082
10083 *rethrow*
10084There is no real rethrow in the Vim script language, but you may throw
10085"v:exception" instead: >
10086
10087 :function! Bar()
10088 : try
10089 : call Foo()
10090 : catch /.*/
10091 : echo "Rethrow" v:exception
10092 : throw v:exception
10093 : endtry
10094 :endfunction
10095< *try-echoerr*
10096Note that this method cannot be used to "rethrow" Vim error or interrupt
10097exceptions, because it is not possible to fake Vim internal exceptions.
10098Trying so causes an error exception. You should throw your own exception
10099denoting the situation. If you want to cause a Vim error exception containing
10100the original error exception value, you can use the |:echoerr| command: >
10101
10102 :try
10103 : try
10104 : asdf
10105 : catch /.*/
10106 : echoerr v:exception
10107 : endtry
10108 :catch /.*/
10109 : echo v:exception
10110 :endtry
10111
10112This code displays
10113
Bram Moolenaar446cb832008-06-24 21:56:24 +000010114 Vim(echoerr):Vim:E492: Not an editor command: asdf ~
Bram Moolenaar071d4272004-06-13 20:20:40 +000010115
10116
10117CLEANUP CODE *try-finally*
10118
10119Scripts often change global settings and restore them at their end. If the
10120user however interrupts the script by pressing CTRL-C, the settings remain in
Bram Moolenaar58b85342016-08-14 19:54:54 +020010121an inconsistent state. The same may happen to you in the development phase of
Bram Moolenaar071d4272004-06-13 20:20:40 +000010122a script when an error occurs or you explicitly throw an exception without
10123catching it. You can solve these problems by using a try conditional with
10124a finally clause for restoring the settings. Its execution is guaranteed on
10125normal control flow, on error, on an explicit ":throw", and on interrupt.
10126(Note that errors and interrupts from inside the try conditional are converted
Bram Moolenaar58b85342016-08-14 19:54:54 +020010127to exceptions. When not caught, they terminate the script after the finally
Bram Moolenaar071d4272004-06-13 20:20:40 +000010128clause has been executed.)
10129Example: >
10130
10131 :try
10132 : let s:saved_ts = &ts
10133 : set ts=17
10134 :
10135 : " Do the hard work here.
10136 :
10137 :finally
10138 : let &ts = s:saved_ts
10139 : unlet s:saved_ts
10140 :endtry
10141
10142This method should be used locally whenever a function or part of a script
10143changes global settings which need to be restored on failure or normal exit of
10144that function or script part.
10145
10146 *break-finally*
10147Cleanup code works also when the try block or a catch clause is left by
10148a ":continue", ":break", ":return", or ":finish".
10149 Example: >
10150
10151 :let first = 1
10152 :while 1
10153 : try
10154 : if first
10155 : echo "first"
10156 : let first = 0
10157 : continue
10158 : else
10159 : throw "second"
10160 : endif
10161 : catch /.*/
10162 : echo v:exception
10163 : break
10164 : finally
10165 : echo "cleanup"
10166 : endtry
10167 : echo "still in while"
10168 :endwhile
10169 :echo "end"
10170
10171This displays "first", "cleanup", "second", "cleanup", and "end". >
10172
10173 :function! Foo()
10174 : try
10175 : return 4711
10176 : finally
10177 : echo "cleanup\n"
10178 : endtry
10179 : echo "Foo still active"
10180 :endfunction
10181 :
10182 :echo Foo() "returned by Foo"
10183
10184This displays "cleanup" and "4711 returned by Foo". You don't need to add an
Bram Moolenaar58b85342016-08-14 19:54:54 +020010185extra ":return" in the finally clause. (Above all, this would override the
Bram Moolenaar071d4272004-06-13 20:20:40 +000010186return value.)
10187
10188 *except-from-finally*
10189Using either of ":continue", ":break", ":return", ":finish", or ":throw" in
10190a finally clause is possible, but not recommended since it abandons the
10191cleanup actions for the try conditional. But, of course, interrupt and error
10192exceptions might get raised from a finally clause.
10193 Example where an error in the finally clause stops an interrupt from
10194working correctly: >
10195
10196 :try
10197 : try
10198 : echo "Press CTRL-C for interrupt"
10199 : while 1
10200 : endwhile
10201 : finally
10202 : unlet novar
10203 : endtry
10204 :catch /novar/
10205 :endtry
10206 :echo "Script still running"
10207 :sleep 1
10208
10209If you need to put commands that could fail into a finally clause, you should
10210think about catching or ignoring the errors in these commands, see
10211|catch-errors| and |ignore-errors|.
10212
10213
10214CATCHING ERRORS *catch-errors*
10215
10216If you want to catch specific errors, you just have to put the code to be
10217watched in a try block and add a catch clause for the error message. The
10218presence of the try conditional causes all errors to be converted to an
10219exception. No message is displayed and |v:errmsg| is not set then. To find
10220the right pattern for the ":catch" command, you have to know how the format of
10221the error exception is.
10222 Error exceptions have the following format: >
10223
10224 Vim({cmdname}):{errmsg}
10225or >
10226 Vim:{errmsg}
10227
10228{cmdname} is the name of the command that failed; the second form is used when
Bram Moolenaar58b85342016-08-14 19:54:54 +020010229the command name is not known. {errmsg} is the error message usually produced
Bram Moolenaar071d4272004-06-13 20:20:40 +000010230when the error occurs outside try conditionals. It always begins with
10231a capital "E", followed by a two or three-digit error number, a colon, and
10232a space.
10233
10234Examples:
10235
10236The command >
10237 :unlet novar
10238normally produces the error message >
10239 E108: No such variable: "novar"
10240which is converted inside try conditionals to an exception >
10241 Vim(unlet):E108: No such variable: "novar"
10242
10243The command >
10244 :dwim
10245normally produces the error message >
10246 E492: Not an editor command: dwim
10247which is converted inside try conditionals to an exception >
10248 Vim:E492: Not an editor command: dwim
10249
10250You can catch all ":unlet" errors by a >
10251 :catch /^Vim(unlet):/
10252or all errors for misspelled command names by a >
10253 :catch /^Vim:E492:/
10254
10255Some error messages may be produced by different commands: >
10256 :function nofunc
10257and >
10258 :delfunction nofunc
10259both produce the error message >
10260 E128: Function name must start with a capital: nofunc
10261which is converted inside try conditionals to an exception >
10262 Vim(function):E128: Function name must start with a capital: nofunc
10263or >
10264 Vim(delfunction):E128: Function name must start with a capital: nofunc
10265respectively. You can catch the error by its number independently on the
10266command that caused it if you use the following pattern: >
10267 :catch /^Vim(\a\+):E128:/
10268
10269Some commands like >
10270 :let x = novar
10271produce multiple error messages, here: >
10272 E121: Undefined variable: novar
10273 E15: Invalid expression: novar
10274Only the first is used for the exception value, since it is the most specific
10275one (see |except-several-errors|). So you can catch it by >
10276 :catch /^Vim(\a\+):E121:/
10277
10278You can catch all errors related to the name "nofunc" by >
10279 :catch /\<nofunc\>/
10280
10281You can catch all Vim errors in the ":write" and ":read" commands by >
10282 :catch /^Vim(\(write\|read\)):E\d\+:/
10283
10284You can catch all Vim errors by the pattern >
10285 :catch /^Vim\((\a\+)\)\=:E\d\+:/
10286<
10287 *catch-text*
10288NOTE: You should never catch the error message text itself: >
10289 :catch /No such variable/
Bram Moolenaar2b8388b2015-02-28 13:11:45 +010010290only works in the English locale, but not when the user has selected
Bram Moolenaar071d4272004-06-13 20:20:40 +000010291a different language by the |:language| command. It is however helpful to
10292cite the message text in a comment: >
10293 :catch /^Vim(\a\+):E108:/ " No such variable
10294
10295
10296IGNORING ERRORS *ignore-errors*
10297
10298You can ignore errors in a specific Vim command by catching them locally: >
10299
10300 :try
10301 : write
10302 :catch
10303 :endtry
10304
10305But you are strongly recommended NOT to use this simple form, since it could
10306catch more than you want. With the ":write" command, some autocommands could
10307be executed and cause errors not related to writing, for instance: >
10308
10309 :au BufWritePre * unlet novar
10310
10311There could even be such errors you are not responsible for as a script
10312writer: a user of your script might have defined such autocommands. You would
10313then hide the error from the user.
10314 It is much better to use >
10315
10316 :try
10317 : write
10318 :catch /^Vim(write):/
10319 :endtry
10320
10321which only catches real write errors. So catch only what you'd like to ignore
10322intentionally.
10323
10324For a single command that does not cause execution of autocommands, you could
10325even suppress the conversion of errors to exceptions by the ":silent!"
10326command: >
10327 :silent! nunmap k
10328This works also when a try conditional is active.
10329
10330
10331CATCHING INTERRUPTS *catch-interrupt*
10332
10333When there are active try conditionals, an interrupt (CTRL-C) is converted to
Bram Moolenaar58b85342016-08-14 19:54:54 +020010334the exception "Vim:Interrupt". You can catch it like every exception. The
Bram Moolenaar071d4272004-06-13 20:20:40 +000010335script is not terminated, then.
10336 Example: >
10337
10338 :function! TASK1()
10339 : sleep 10
10340 :endfunction
10341
10342 :function! TASK2()
10343 : sleep 20
10344 :endfunction
10345
10346 :while 1
10347 : let command = input("Type a command: ")
10348 : try
10349 : if command == ""
10350 : continue
10351 : elseif command == "END"
10352 : break
10353 : elseif command == "TASK1"
10354 : call TASK1()
10355 : elseif command == "TASK2"
10356 : call TASK2()
10357 : else
10358 : echo "\nIllegal command:" command
10359 : continue
10360 : endif
10361 : catch /^Vim:Interrupt$/
10362 : echo "\nCommand interrupted"
10363 : " Caught the interrupt. Continue with next prompt.
10364 : endtry
10365 :endwhile
10366
10367You can interrupt a task here by pressing CTRL-C; the script then asks for
Bram Moolenaar58b85342016-08-14 19:54:54 +020010368a new command. If you press CTRL-C at the prompt, the script is terminated.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010369
10370For testing what happens when CTRL-C would be pressed on a specific line in
10371your script, use the debug mode and execute the |>quit| or |>interrupt|
10372command on that line. See |debug-scripts|.
10373
10374
10375CATCHING ALL *catch-all*
10376
10377The commands >
10378
10379 :catch /.*/
10380 :catch //
10381 :catch
10382
10383catch everything, error exceptions, interrupt exceptions and exceptions
10384explicitly thrown by the |:throw| command. This is useful at the top level of
10385a script in order to catch unexpected things.
10386 Example: >
10387
10388 :try
10389 :
10390 : " do the hard work here
10391 :
10392 :catch /MyException/
10393 :
10394 : " handle known problem
10395 :
10396 :catch /^Vim:Interrupt$/
10397 : echo "Script interrupted"
10398 :catch /.*/
10399 : echo "Internal error (" . v:exception . ")"
10400 : echo " - occurred at " . v:throwpoint
10401 :endtry
10402 :" end of script
10403
10404Note: Catching all might catch more things than you want. Thus, you are
10405strongly encouraged to catch only for problems that you can really handle by
10406specifying a pattern argument to the ":catch".
10407 Example: Catching all could make it nearly impossible to interrupt a script
10408by pressing CTRL-C: >
10409
10410 :while 1
10411 : try
10412 : sleep 1
10413 : catch
10414 : endtry
10415 :endwhile
10416
10417
10418EXCEPTIONS AND AUTOCOMMANDS *except-autocmd*
10419
10420Exceptions may be used during execution of autocommands. Example: >
10421
10422 :autocmd User x try
10423 :autocmd User x throw "Oops!"
10424 :autocmd User x catch
10425 :autocmd User x echo v:exception
10426 :autocmd User x endtry
10427 :autocmd User x throw "Arrgh!"
10428 :autocmd User x echo "Should not be displayed"
10429 :
10430 :try
10431 : doautocmd User x
10432 :catch
10433 : echo v:exception
10434 :endtry
10435
10436This displays "Oops!" and "Arrgh!".
10437
10438 *except-autocmd-Pre*
10439For some commands, autocommands get executed before the main action of the
10440command takes place. If an exception is thrown and not caught in the sequence
10441of autocommands, the sequence and the command that caused its execution are
10442abandoned and the exception is propagated to the caller of the command.
10443 Example: >
10444
10445 :autocmd BufWritePre * throw "FAIL"
10446 :autocmd BufWritePre * echo "Should not be displayed"
10447 :
10448 :try
10449 : write
10450 :catch
10451 : echo "Caught:" v:exception "from" v:throwpoint
10452 :endtry
10453
10454Here, the ":write" command does not write the file currently being edited (as
10455you can see by checking 'modified'), since the exception from the BufWritePre
10456autocommand abandons the ":write". The exception is then caught and the
10457script displays: >
10458
10459 Caught: FAIL from BufWrite Auto commands for "*"
10460<
10461 *except-autocmd-Post*
10462For some commands, autocommands get executed after the main action of the
10463command has taken place. If this main action fails and the command is inside
10464an active try conditional, the autocommands are skipped and an error exception
10465is thrown that can be caught by the caller of the command.
10466 Example: >
10467
10468 :autocmd BufWritePost * echo "File successfully written!"
10469 :
10470 :try
10471 : write /i/m/p/o/s/s/i/b/l/e
10472 :catch
10473 : echo v:exception
10474 :endtry
10475
10476This just displays: >
10477
10478 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e)
10479
10480If you really need to execute the autocommands even when the main action
10481fails, trigger the event from the catch clause.
10482 Example: >
10483
10484 :autocmd BufWritePre * set noreadonly
10485 :autocmd BufWritePost * set readonly
10486 :
10487 :try
10488 : write /i/m/p/o/s/s/i/b/l/e
10489 :catch
10490 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e
10491 :endtry
10492<
10493You can also use ":silent!": >
10494
10495 :let x = "ok"
10496 :let v:errmsg = ""
10497 :autocmd BufWritePost * if v:errmsg != ""
10498 :autocmd BufWritePost * let x = "after fail"
10499 :autocmd BufWritePost * endif
10500 :try
10501 : silent! write /i/m/p/o/s/s/i/b/l/e
10502 :catch
10503 :endtry
10504 :echo x
10505
10506This displays "after fail".
10507
10508If the main action of the command does not fail, exceptions from the
10509autocommands will be catchable by the caller of the command: >
10510
10511 :autocmd BufWritePost * throw ":-("
10512 :autocmd BufWritePost * echo "Should not be displayed"
10513 :
10514 :try
10515 : write
10516 :catch
10517 : echo v:exception
10518 :endtry
10519<
10520 *except-autocmd-Cmd*
10521For some commands, the normal action can be replaced by a sequence of
10522autocommands. Exceptions from that sequence will be catchable by the caller
10523of the command.
10524 Example: For the ":write" command, the caller cannot know whether the file
Bram Moolenaar58b85342016-08-14 19:54:54 +020010525had actually been written when the exception occurred. You need to tell it in
Bram Moolenaar071d4272004-06-13 20:20:40 +000010526some way. >
10527
10528 :if !exists("cnt")
10529 : let cnt = 0
10530 :
10531 : autocmd BufWriteCmd * if &modified
10532 : autocmd BufWriteCmd * let cnt = cnt + 1
10533 : autocmd BufWriteCmd * if cnt % 3 == 2
10534 : autocmd BufWriteCmd * throw "BufWriteCmdError"
10535 : autocmd BufWriteCmd * endif
10536 : autocmd BufWriteCmd * write | set nomodified
10537 : autocmd BufWriteCmd * if cnt % 3 == 0
10538 : autocmd BufWriteCmd * throw "BufWriteCmdError"
10539 : autocmd BufWriteCmd * endif
10540 : autocmd BufWriteCmd * echo "File successfully written!"
10541 : autocmd BufWriteCmd * endif
10542 :endif
10543 :
10544 :try
10545 : write
10546 :catch /^BufWriteCmdError$/
10547 : if &modified
10548 : echo "Error on writing (file contents not changed)"
10549 : else
10550 : echo "Error after writing"
10551 : endif
10552 :catch /^Vim(write):/
10553 : echo "Error on writing"
10554 :endtry
10555
10556When this script is sourced several times after making changes, it displays
10557first >
10558 File successfully written!
10559then >
10560 Error on writing (file contents not changed)
10561then >
10562 Error after writing
10563etc.
10564
10565 *except-autocmd-ill*
10566You cannot spread a try conditional over autocommands for different events.
10567The following code is ill-formed: >
10568
10569 :autocmd BufWritePre * try
10570 :
10571 :autocmd BufWritePost * catch
10572 :autocmd BufWritePost * echo v:exception
10573 :autocmd BufWritePost * endtry
10574 :
10575 :write
10576
10577
10578EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param*
10579
10580Some programming languages allow to use hierarchies of exception classes or to
10581pass additional information with the object of an exception class. You can do
10582similar things in Vim.
10583 In order to throw an exception from a hierarchy, just throw the complete
10584class name with the components separated by a colon, for instance throw the
10585string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library.
10586 When you want to pass additional information with your exception class, add
10587it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)"
10588for an error when writing "myfile".
10589 With the appropriate patterns in the ":catch" command, you can catch for
10590base classes or derived classes of your hierarchy. Additional information in
10591parentheses can be cut out from |v:exception| with the ":substitute" command.
10592 Example: >
10593
10594 :function! CheckRange(a, func)
10595 : if a:a < 0
10596 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")"
10597 : endif
10598 :endfunction
10599 :
10600 :function! Add(a, b)
10601 : call CheckRange(a:a, "Add")
10602 : call CheckRange(a:b, "Add")
10603 : let c = a:a + a:b
10604 : if c < 0
10605 : throw "EXCEPT:MATHERR:OVERFLOW"
10606 : endif
10607 : return c
10608 :endfunction
10609 :
10610 :function! Div(a, b)
10611 : call CheckRange(a:a, "Div")
10612 : call CheckRange(a:b, "Div")
10613 : if (a:b == 0)
10614 : throw "EXCEPT:MATHERR:ZERODIV"
10615 : endif
10616 : return a:a / a:b
10617 :endfunction
10618 :
10619 :function! Write(file)
10620 : try
Bram Moolenaar446cb832008-06-24 21:56:24 +000010621 : execute "write" fnameescape(a:file)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010622 : catch /^Vim(write):/
10623 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR"
10624 : endtry
10625 :endfunction
10626 :
10627 :try
10628 :
10629 : " something with arithmetics and I/O
10630 :
10631 :catch /^EXCEPT:MATHERR:RANGE/
10632 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "")
10633 : echo "Range error in" function
10634 :
10635 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV
10636 : echo "Math error"
10637 :
10638 :catch /^EXCEPT:IO/
10639 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "")
10640 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "")
10641 : if file !~ '^/'
10642 : let file = dir . "/" . file
10643 : endif
10644 : echo 'I/O error for "' . file . '"'
10645 :
10646 :catch /^EXCEPT/
10647 : echo "Unspecified error"
10648 :
10649 :endtry
10650
10651The exceptions raised by Vim itself (on error or when pressing CTRL-C) use
10652a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself
10653exceptions with the "Vim" prefix; they are reserved for Vim.
10654 Vim error exceptions are parameterized with the name of the command that
10655failed, if known. See |catch-errors|.
10656
10657
10658PECULIARITIES
10659 *except-compat*
10660The exception handling concept requires that the command sequence causing the
10661exception is aborted immediately and control is transferred to finally clauses
10662and/or a catch clause.
10663
10664In the Vim script language there are cases where scripts and functions
10665continue after an error: in functions without the "abort" flag or in a command
10666after ":silent!", control flow goes to the following line, and outside
10667functions, control flow goes to the line following the outermost ":endwhile"
10668or ":endif". On the other hand, errors should be catchable as exceptions
10669(thus, requiring the immediate abortion).
10670
10671This problem has been solved by converting errors to exceptions and using
10672immediate abortion (if not suppressed by ":silent!") only when a try
Bram Moolenaar58b85342016-08-14 19:54:54 +020010673conditional is active. This is no restriction since an (error) exception can
10674be caught only from an active try conditional. If you want an immediate
Bram Moolenaar071d4272004-06-13 20:20:40 +000010675termination without catching the error, just use a try conditional without
10676catch clause. (You can cause cleanup code being executed before termination
10677by specifying a finally clause.)
10678
10679When no try conditional is active, the usual abortion and continuation
10680behavior is used instead of immediate abortion. This ensures compatibility of
10681scripts written for Vim 6.1 and earlier.
10682
10683However, when sourcing an existing script that does not use exception handling
10684commands (or when calling one of its functions) from inside an active try
10685conditional of a new script, you might change the control flow of the existing
10686script on error. You get the immediate abortion on error and can catch the
10687error in the new script. If however the sourced script suppresses error
10688messages by using the ":silent!" command (checking for errors by testing
Bram Moolenaar58b85342016-08-14 19:54:54 +020010689|v:errmsg| if appropriate), its execution path is not changed. The error is
10690not converted to an exception. (See |:silent|.) So the only remaining cause
Bram Moolenaar071d4272004-06-13 20:20:40 +000010691where this happens is for scripts that don't care about errors and produce
10692error messages. You probably won't want to use such code from your new
10693scripts.
10694
10695 *except-syntax-err*
10696Syntax errors in the exception handling commands are never caught by any of
10697the ":catch" commands of the try conditional they belong to. Its finally
10698clauses, however, is executed.
10699 Example: >
10700
10701 :try
10702 : try
10703 : throw 4711
10704 : catch /\(/
10705 : echo "in catch with syntax error"
10706 : catch
10707 : echo "inner catch-all"
10708 : finally
10709 : echo "inner finally"
10710 : endtry
10711 :catch
10712 : echo 'outer catch-all caught "' . v:exception . '"'
10713 : finally
10714 : echo "outer finally"
10715 :endtry
10716
10717This displays: >
10718 inner finally
10719 outer catch-all caught "Vim(catch):E54: Unmatched \("
10720 outer finally
10721The original exception is discarded and an error exception is raised, instead.
10722
10723 *except-single-line*
10724The ":try", ":catch", ":finally", and ":endtry" commands can be put on
10725a single line, but then syntax errors may make it difficult to recognize the
10726"catch" line, thus you better avoid this.
10727 Example: >
10728 :try | unlet! foo # | catch | endtry
10729raises an error exception for the trailing characters after the ":unlet!"
10730argument, but does not see the ":catch" and ":endtry" commands, so that the
10731error exception is discarded and the "E488: Trailing characters" message gets
10732displayed.
10733
10734 *except-several-errors*
10735When several errors appear in a single command, the first error message is
10736usually the most specific one and therefor converted to the error exception.
10737 Example: >
10738 echo novar
10739causes >
10740 E121: Undefined variable: novar
10741 E15: Invalid expression: novar
10742The value of the error exception inside try conditionals is: >
10743 Vim(echo):E121: Undefined variable: novar
10744< *except-syntax-error*
10745But when a syntax error is detected after a normal error in the same command,
10746the syntax error is used for the exception being thrown.
10747 Example: >
10748 unlet novar #
10749causes >
10750 E108: No such variable: "novar"
10751 E488: Trailing characters
10752The value of the error exception inside try conditionals is: >
10753 Vim(unlet):E488: Trailing characters
10754This is done because the syntax error might change the execution path in a way
10755not intended by the user. Example: >
10756 try
10757 try | unlet novar # | catch | echo v:exception | endtry
10758 catch /.*/
10759 echo "outer catch:" v:exception
10760 endtry
10761This displays "outer catch: Vim(unlet):E488: Trailing characters", and then
10762a "E600: Missing :endtry" error message is given, see |except-single-line|.
10763
10764==============================================================================
107659. Examples *eval-examples*
10766
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010767Printing in Binary ~
Bram Moolenaar071d4272004-06-13 20:20:40 +000010768>
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010010769 :" The function Nr2Bin() returns the binary string representation of a number.
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010770 :func Nr2Bin(nr)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010771 : let n = a:nr
10772 : let r = ""
10773 : while n
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010774 : let r = '01'[n % 2] . r
10775 : let n = n / 2
Bram Moolenaar071d4272004-06-13 20:20:40 +000010776 : endwhile
10777 : return r
10778 :endfunc
10779
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010780 :" The function String2Bin() converts each character in a string to a
10781 :" binary string, separated with dashes.
10782 :func String2Bin(str)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010783 : let out = ''
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010784 : for ix in range(strlen(a:str))
10785 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix]))
10786 : endfor
10787 : return out[1:]
Bram Moolenaar071d4272004-06-13 20:20:40 +000010788 :endfunc
10789
10790Example of its use: >
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010791 :echo Nr2Bin(32)
10792result: "100000" >
10793 :echo String2Bin("32")
10794result: "110011-110010"
Bram Moolenaar071d4272004-06-13 20:20:40 +000010795
10796
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010797Sorting lines ~
Bram Moolenaar071d4272004-06-13 20:20:40 +000010798
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010799This example sorts lines with a specific compare function. >
10800
10801 :func SortBuffer()
10802 : let lines = getline(1, '$')
10803 : call sort(lines, function("Strcmp"))
10804 : call setline(1, lines)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010805 :endfunction
10806
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010807As a one-liner: >
10808 :call setline(1, sort(getline(1, '$'), function("Strcmp")))
Bram Moolenaar071d4272004-06-13 20:20:40 +000010809
Bram Moolenaar071d4272004-06-13 20:20:40 +000010810
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010811scanf() replacement ~
Bram Moolenaar071d4272004-06-13 20:20:40 +000010812 *sscanf*
10813There is no sscanf() function in Vim. If you need to extract parts from a
10814line, you can use matchstr() and substitute() to do it. This example shows
10815how to get the file name, line number and column number out of a line like
10816"foobar.txt, 123, 45". >
10817 :" Set up the match bit
10818 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)'
10819 :"get the part matching the whole expression
10820 :let l = matchstr(line, mx)
10821 :"get each item out of the match
10822 :let file = substitute(l, mx, '\1', '')
10823 :let lnum = substitute(l, mx, '\2', '')
10824 :let col = substitute(l, mx, '\3', '')
10825
10826The input is in the variable "line", the results in the variables "file",
10827"lnum" and "col". (idea from Michael Geddes)
10828
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010829
10830getting the scriptnames in a Dictionary ~
10831 *scriptnames-dictionary*
10832The |:scriptnames| command can be used to get a list of all script files that
10833have been sourced. There is no equivalent function or variable for this
10834(because it's rarely needed). In case you need to manipulate the list this
10835code can be used: >
10836 " Get the output of ":scriptnames" in the scriptnames_output variable.
10837 let scriptnames_output = ''
10838 redir => scriptnames_output
10839 silent scriptnames
10840 redir END
10841
Bram Moolenaar446cb832008-06-24 21:56:24 +000010842 " Split the output into lines and parse each line. Add an entry to the
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010843 " "scripts" dictionary.
10844 let scripts = {}
10845 for line in split(scriptnames_output, "\n")
10846 " Only do non-blank lines.
10847 if line =~ '\S'
10848 " Get the first number in the line.
Bram Moolenaar446cb832008-06-24 21:56:24 +000010849 let nr = matchstr(line, '\d\+')
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010850 " Get the file name, remove the script number " 123: ".
Bram Moolenaar446cb832008-06-24 21:56:24 +000010851 let name = substitute(line, '.\+:\s*', '', '')
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010852 " Add an item to the Dictionary
Bram Moolenaar446cb832008-06-24 21:56:24 +000010853 let scripts[nr] = name
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010854 endif
10855 endfor
10856 unlet scriptnames_output
10857
Bram Moolenaar071d4272004-06-13 20:20:40 +000010858==============================================================================
1085910. No +eval feature *no-eval-feature*
10860
10861When the |+eval| feature was disabled at compile time, none of the expression
10862evaluation commands are available. To prevent this from causing Vim scripts
10863to generate all kinds of errors, the ":if" and ":endif" commands are still
10864recognized, though the argument of the ":if" and everything between the ":if"
10865and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but
10866only if the commands are at the start of the line. The ":else" command is not
10867recognized.
10868
10869Example of how to avoid executing commands when the |+eval| feature is
10870missing: >
10871
10872 :if 1
10873 : echo "Expression evaluation is compiled in"
10874 :else
10875 : echo "You will _never_ see this message"
10876 :endif
10877
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +020010878To execute a command only when the |+eval| feature is disabled requires a trick,
10879as this example shows: >
Bram Moolenaar45d2cca2017-04-30 16:36:05 +020010880
10881 silent! while 0
10882 set history=111
10883 silent! endwhile
10884
10885When the |+eval| feature is available the command is skipped because of the
10886"while 0". Without the |+eval| feature the "while 0" is an error, which is
10887silently ignored, and the command is executed.
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +020010888
Bram Moolenaar071d4272004-06-13 20:20:40 +000010889==============================================================================
1089011. The sandbox *eval-sandbox* *sandbox* *E48*
10891
Bram Moolenaar368373e2010-07-19 20:46:22 +020010892The 'foldexpr', 'formatexpr', 'includeexpr', 'indentexpr', 'statusline' and
10893'foldtext' options may be evaluated in a sandbox. This means that you are
10894protected from these expressions having nasty side effects. This gives some
10895safety for when these options are set from a modeline. It is also used when
10896the command from a tags file is executed and for CTRL-R = in the command line.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +000010897The sandbox is also used for the |:sandbox| command.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010898
10899These items are not allowed in the sandbox:
10900 - changing the buffer text
10901 - defining or changing mapping, autocommands, functions, user commands
10902 - setting certain options (see |option-summary|)
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010903 - setting certain v: variables (see |v:var|) *E794*
Bram Moolenaar071d4272004-06-13 20:20:40 +000010904 - executing a shell command
10905 - reading or writing a file
10906 - jumping to another buffer or editing a file
Bram Moolenaar4770d092006-01-12 23:22:24 +000010907 - executing Python, Perl, etc. commands
Bram Moolenaar7b0294c2004-10-11 10:16:09 +000010908This is not guaranteed 100% secure, but it should block most attacks.
10909
10910 *:san* *:sandbox*
Bram Moolenaar045e82d2005-07-08 22:25:33 +000010911:san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an
Bram Moolenaar7b0294c2004-10-11 10:16:09 +000010912 option that may have been set from a modeline, e.g.
10913 'foldexpr'.
10914
Bram Moolenaarb71eaae2006-01-20 23:10:18 +000010915 *sandbox-option*
10916A few options contain an expression. When this expression is evaluated it may
Bram Moolenaar9b2200a2006-03-20 21:55:45 +000010917have to be done in the sandbox to avoid a security risk. But the sandbox is
Bram Moolenaarb71eaae2006-01-20 23:10:18 +000010918restrictive, thus this only happens when the option was set from an insecure
10919location. Insecure in this context are:
Bram Moolenaar551dbcc2006-04-25 22:13:59 +000010920- sourcing a .vimrc or .exrc in the current directory
Bram Moolenaarb71eaae2006-01-20 23:10:18 +000010921- while executing in the sandbox
10922- value coming from a modeline
10923
10924Note that when in the sandbox and saving an option value and restoring it, the
10925option will still be marked as it was set in the sandbox.
10926
10927==============================================================================
1092812. Textlock *textlock*
10929
10930In a few situations it is not allowed to change the text in the buffer, jump
10931to another window and some other things that might confuse or break what Vim
10932is currently doing. This mostly applies to things that happen when Vim is
Bram Moolenaar58b85342016-08-14 19:54:54 +020010933actually doing something else. For example, evaluating the 'balloonexpr' may
Bram Moolenaarb71eaae2006-01-20 23:10:18 +000010934happen any moment the mouse cursor is resting at some position.
10935
10936This is not allowed when the textlock is active:
10937 - changing the buffer text
10938 - jumping to another buffer or window
10939 - editing another file
10940 - closing a window or quitting Vim
10941 - etc.
10942
Bram Moolenaardc1f1642016-08-16 18:33:43 +020010943==============================================================================
1094413. Testing *testing*
10945
10946Vim can be tested after building it, usually with "make test".
10947The tests are located in the directory "src/testdir".
10948
10949There are several types of tests added over time:
10950 test33.in oldest, don't add any more
10951 test_something.in old style tests
10952 test_something.vim new style tests
10953
10954 *new-style-testing*
10955New tests should be added as new style tests. These use functions such as
10956|assert_equal()| to keep the test commands and the expected result in one
10957place.
10958 *old-style-testing*
10959In some cases an old style test needs to be used. E.g. when testing Vim
10960without the |+eval| feature.
10961
10962Find more information in the file src/testdir/README.txt.
10963
Bram Moolenaar071d4272004-06-13 20:20:40 +000010964
10965 vim:tw=78:ts=8:ft=help:norl: