blob: adf21f17d15bda9a9f5b74169f5f1ace0eb2b289 [file] [log] [blame]
Bram Moolenaard8b77f72015-03-05 21:21:19 +01001*eval.txt* For Vim version 7.4. Last change: 2015 Mar 05
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 Moolenaar446cb832008-06-24 21:56:24 +000012done, 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 Moolenaar071d4272004-06-13 20:20:40 +000032
33{Vi does not have any of these commands}
34
35==============================================================================
361. Variables *variables*
37
Bram Moolenaar13065c42005-01-08 16:08:21 +0000381.1 Variable types ~
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000039 *E712*
Bram Moolenaar446cb832008-06-24 21:56:24 +000040There are six types of variables:
Bram Moolenaar071d4272004-06-13 20:20:40 +000041
Bram Moolenaar5302d9e2011-09-14 17:55:08 +020042Number A 32 or 64 bit signed number. |expr-number| *Number*
Bram Moolenaard8b02732005-01-14 21:48:43 +000043 Examples: -123 0x10 0177
44
Bram Moolenaar446cb832008-06-24 21:56:24 +000045Float A floating point number. |floating-point-format| *Float*
46 {only when compiled with the |+float| feature}
47 Examples: 123.456 1.15e-6 -1.1e3
48
Bram Moolenaard8b02732005-01-14 21:48:43 +000049String A NUL terminated string of 8-bit unsigned characters (bytes).
Bram Moolenaar446cb832008-06-24 21:56:24 +000050 |expr-string| Examples: "ab\txx\"--" 'x-z''a,c'
Bram Moolenaard8b02732005-01-14 21:48:43 +000051
52Funcref A reference to a function |Funcref|.
53 Example: function("strlen")
54
55List An ordered sequence of items |List|.
56 Example: [1, 2, ['a', 'b']]
Bram Moolenaar071d4272004-06-13 20:20:40 +000057
Bram Moolenaar39a58ca2005-06-27 22:42:44 +000058Dictionary An associative, unordered array: Each entry has a key and a
59 value. |Dictionary|
60 Example: {'blue': "#0000ff", 'red': "#ff0000"}
61
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +000062The Number and String types are converted automatically, depending on how they
63are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +000064
65Conversion from a Number to a String is by making the ASCII representation of
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +020066the Number. Examples:
67 Number 123 --> String "123" ~
68 Number 0 --> String "0" ~
69 Number -1 --> String "-1" ~
Bram Moolenaar00a927d2010-05-14 23:24:24 +020070 *octal*
Bram Moolenaar071d4272004-06-13 20:20:40 +000071Conversion from a String to a Number is done by converting the first digits
72to a number. Hexadecimal "0xf9" and Octal "017" numbers are recognized. If
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +020073the String doesn't start with digits, the result is zero. Examples:
74 String "456" --> Number 456 ~
75 String "6bar" --> Number 6 ~
76 String "foo" --> Number 0 ~
77 String "0xf1" --> Number 241 ~
78 String "0100" --> Number 64 ~
79 String "-8" --> Number -8 ~
80 String "+8" --> Number 0 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +000081
82To force conversion from String to Number, add zero to it: >
83 :echo "0100" + 0
Bram Moolenaar97b2ad32006-03-18 21:40:56 +000084< 64 ~
85
86To avoid a leading zero to cause octal conversion, or for using a different
87base, use |str2nr()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000088
89For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE.
90
91Note that in the command >
92 :if "foo"
93"foo" is converted to 0, which means FALSE. To test for a non-empty string,
Bram Moolenaar3a0d8092012-10-21 03:02:54 +020094use empty(): >
95 :if !empty("foo")
Bram Moolenaar748bf032005-02-02 23:04:36 +000096< *E745* *E728* *E703* *E729* *E730* *E731*
97List, Dictionary and Funcref types are not automatically converted.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +000098
Bram Moolenaar446cb832008-06-24 21:56:24 +000099 *E805* *E806* *E808*
100When mixing Number and Float the Number is converted to Float. Otherwise
101there is no automatic conversion of Float. You can use str2float() for String
102to Float, printf() for Float to String and float2nr() for Float to Number.
103
104 *E706* *sticky-type-checking*
Bram Moolenaar13065c42005-01-08 16:08:21 +0000105You will get an error if you try to change the type of a variable. You need
106to |:unlet| it first to avoid this error. String and Number are considered
Bram Moolenaar446cb832008-06-24 21:56:24 +0000107equivalent though, as well are Float and Number. Consider this sequence of
108commands: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000109 :let l = "string"
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000110 :let l = 44 " changes type from String to Number
Bram Moolenaar446cb832008-06-24 21:56:24 +0000111 :let l = [1, 2, 3] " error! l is still a Number
112 :let l = 4.4 " changes type from Number to Float
113 :let l = "string" " error!
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000114
Bram Moolenaar13065c42005-01-08 16:08:21 +0000115
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00001161.2 Function references ~
Bram Moolenaar748bf032005-02-02 23:04:36 +0000117 *Funcref* *E695* *E718*
Bram Moolenaar446cb832008-06-24 21:56:24 +0000118A Funcref variable is obtained with the |function()| function. It can be used
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000119in an expression in the place of a function name, before the parenthesis
120around the arguments, to invoke the function it refers to. Example: >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000121
122 :let Fn = function("MyFunc")
123 :echo Fn()
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000124< *E704* *E705* *E707*
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000125A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200126can use "g:" but the following name must still start with a capital. You
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000127cannot have both a Funcref variable and a function with the same name.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000128
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000129A special case is defining a function and directly assigning its Funcref to a
130Dictionary entry. Example: >
131 :function dict.init() dict
132 : let self.val = 0
133 :endfunction
134
135The key of the Dictionary can start with a lower case letter. The actual
136function name is not used here. Also see |numbered-function|.
137
138A Funcref can also be used with the |:call| command: >
139 :call Fn()
140 :call dict.init()
Bram Moolenaar13065c42005-01-08 16:08:21 +0000141
142The name of the referenced function can be obtained with |string()|. >
Bram Moolenaar383f9bc2005-01-19 22:18:32 +0000143 :let func = string(Fn)
Bram Moolenaar13065c42005-01-08 16:08:21 +0000144
145You can use |call()| to invoke a Funcref and use a list variable for the
146arguments: >
Bram Moolenaar383f9bc2005-01-19 22:18:32 +0000147 :let r = call(Fn, mylist)
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000148
149
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00001501.3 Lists ~
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200151 *list* *List* *Lists* *E686*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000152A List is an ordered sequence of items. An item can be of any type. Items
Bram Moolenaar446cb832008-06-24 21:56:24 +0000153can be accessed by their index number. Items can be added and removed at any
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000154position in the sequence.
155
Bram Moolenaar13065c42005-01-08 16:08:21 +0000156
157List creation ~
158 *E696* *E697*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000159A List is created with a comma separated list of items in square brackets.
Bram Moolenaar13065c42005-01-08 16:08:21 +0000160Examples: >
161 :let mylist = [1, two, 3, "four"]
162 :let emptylist = []
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000163
Bram Moolenaar446cb832008-06-24 21:56:24 +0000164An item can be any expression. Using a List for an item creates a
Bram Moolenaarf9393ef2006-04-24 19:47:27 +0000165List of Lists: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000166 :let nestlist = [[11, 12], [21, 22], [31, 32]]
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000167
168An extra comma after the last item is ignored.
169
Bram Moolenaar13065c42005-01-08 16:08:21 +0000170
171List index ~
172 *list-index* *E684*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000173An item in the List can be accessed by putting the index in square brackets
Bram Moolenaar13065c42005-01-08 16:08:21 +0000174after the List. Indexes are zero-based, thus the first item has index zero. >
175 :let item = mylist[0] " get the first item: 1
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000176 :let item = mylist[2] " get the third item: 3
Bram Moolenaar13065c42005-01-08 16:08:21 +0000177
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000178When the resulting item is a list this can be repeated: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000179 :let item = nestlist[0][1] " get the first list, second item: 12
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000180<
Bram Moolenaar13065c42005-01-08 16:08:21 +0000181A negative index is counted from the end. Index -1 refers to the last item in
182the List, -2 to the last but one item, etc. >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000183 :let last = mylist[-1] " get the last item: "four"
184
Bram Moolenaar13065c42005-01-08 16:08:21 +0000185To avoid an error for an invalid index use the |get()| function. When an item
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000186is not available it returns zero or the default value you specify: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000187 :echo get(mylist, idx)
188 :echo get(mylist, idx, "NONE")
189
190
191List concatenation ~
192
193Two lists can be concatenated with the "+" operator: >
194 :let longlist = mylist + [5, 6]
Bram Moolenaar383f9bc2005-01-19 22:18:32 +0000195 :let mylist += [7, 8]
Bram Moolenaar13065c42005-01-08 16:08:21 +0000196
197To prepend or append an item turn the item into a list by putting [] around
198it. To change a list in-place see |list-modification| below.
199
200
201Sublist ~
202
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000203A part of the List can be obtained by specifying the first and last index,
204separated by a colon in square brackets: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000205 :let shortlist = mylist[2:-1] " get List [3, "four"]
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000206
207Omitting the first index is similar to zero. Omitting the last index is
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000208similar to -1. >
Bram Moolenaar540d6e32005-01-09 21:20:18 +0000209 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"]
210 :let shortlist = mylist[2:2] " List with one item: [3]
211 :let otherlist = mylist[:] " make a copy of the List
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000212
Bram Moolenaarf9393ef2006-04-24 19:47:27 +0000213If the first index is beyond the last item of the List or the second item is
214before the first item, the result is an empty list. There is no error
215message.
216
217If the second index is equal to or greater than the length of the list the
218length minus one is used: >
Bram Moolenaar9e54a0e2006-04-14 20:42:25 +0000219 :let mylist = [0, 1, 2, 3]
220 :echo mylist[2:8] " result: [2, 3]
221
Bram Moolenaara7fc0102005-05-18 22:17:12 +0000222NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for
Bram Moolenaar446cb832008-06-24 21:56:24 +0000223using a single letter variable before the ":". Insert a space when needed:
Bram Moolenaara7fc0102005-05-18 22:17:12 +0000224mylist[s : e].
225
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000226
Bram Moolenaar13065c42005-01-08 16:08:21 +0000227List identity ~
Bram Moolenaard8b02732005-01-14 21:48:43 +0000228 *list-identity*
Bram Moolenaar13065c42005-01-08 16:08:21 +0000229When variable "aa" is a list and you assign it to another variable "bb", both
230variables refer to the same list. Thus changing the list "aa" will also
231change "bb": >
232 :let aa = [1, 2, 3]
233 :let bb = aa
234 :call add(aa, 4)
235 :echo bb
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000236< [1, 2, 3, 4]
Bram Moolenaar13065c42005-01-08 16:08:21 +0000237
238Making a copy of a list is done with the |copy()| function. Using [:] also
239works, as explained above. This creates a shallow copy of the list: Changing
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000240a list item in the list will also change the item in the copied list: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000241 :let aa = [[1, 'a'], 2, 3]
242 :let bb = copy(aa)
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000243 :call add(aa, 4)
Bram Moolenaar13065c42005-01-08 16:08:21 +0000244 :let aa[0][1] = 'aaa'
245 :echo aa
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000246< [[1, aaa], 2, 3, 4] >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000247 :echo bb
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000248< [[1, aaa], 2, 3]
Bram Moolenaar13065c42005-01-08 16:08:21 +0000249
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000250To make a completely independent list use |deepcopy()|. This also makes a
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000251copy of the values in the list, recursively. Up to a hundred levels deep.
Bram Moolenaar13065c42005-01-08 16:08:21 +0000252
253The operator "is" can be used to check if two variables refer to the same
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000254List. "isnot" does the opposite. In contrast "==" compares if two lists have
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000255the same value. >
256 :let alist = [1, 2, 3]
257 :let blist = [1, 2, 3]
258 :echo alist is blist
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000259< 0 >
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000260 :echo alist == blist
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000261< 1
Bram Moolenaar13065c42005-01-08 16:08:21 +0000262
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +0000263Note about comparing lists: Two lists are considered equal if they have the
264same length and all items compare equal, as with using "==". There is one
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000265exception: When comparing a number with a string they are considered
266different. There is no automatic type conversion, as with using "==" on
267variables. Example: >
268 echo 4 == "4"
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +0000269< 1 >
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000270 echo [4] == ["4"]
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +0000271< 0
272
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000273Thus comparing Lists is more strict than comparing numbers and strings. You
Bram Moolenaar446cb832008-06-24 21:56:24 +0000274can compare simple values this way too by putting them in a list: >
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000275
276 :let a = 5
277 :let b = "5"
Bram Moolenaar446cb832008-06-24 21:56:24 +0000278 :echo a == b
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000279< 1 >
Bram Moolenaar446cb832008-06-24 21:56:24 +0000280 :echo [a] == [b]
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000281< 0
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +0000282
Bram Moolenaar13065c42005-01-08 16:08:21 +0000283
284List unpack ~
285
286To unpack the items in a list to individual variables, put the variables in
287square brackets, like list items: >
288 :let [var1, var2] = mylist
289
290When the number of variables does not match the number of items in the list
291this produces an error. To handle any extra items from the list append ";"
292and a variable name: >
293 :let [var1, var2; rest] = mylist
294
295This works like: >
296 :let var1 = mylist[0]
297 :let var2 = mylist[1]
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +0000298 :let rest = mylist[2:]
Bram Moolenaar13065c42005-01-08 16:08:21 +0000299
300Except that there is no error if there are only two items. "rest" will be an
301empty list then.
302
303
304List modification ~
305 *list-modification*
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000306To change a specific item of a list use |:let| this way: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000307 :let list[4] = "four"
308 :let listlist[0][3] = item
309
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000310To change part of a list you can specify the first and last item to be
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000311modified. The value must at least have the number of items in the range: >
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000312 :let list[3:5] = [3, 4, 5]
313
Bram Moolenaar13065c42005-01-08 16:08:21 +0000314Adding and removing items from a list is done with functions. Here are a few
315examples: >
316 :call insert(list, 'a') " prepend item 'a'
317 :call insert(list, 'a', 3) " insert item 'a' before list[3]
318 :call add(list, "new") " append String item
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000319 :call add(list, [1, 2]) " append a List as one new item
Bram Moolenaar13065c42005-01-08 16:08:21 +0000320 :call extend(list, [1, 2]) " extend the list with two more items
321 :let i = remove(list, 3) " remove item 3
Bram Moolenaar9cd15162005-01-16 22:02:49 +0000322 :unlet list[3] " idem
Bram Moolenaar13065c42005-01-08 16:08:21 +0000323 :let l = remove(list, 3, -1) " remove items 3 to last item
Bram Moolenaar9cd15162005-01-16 22:02:49 +0000324 :unlet list[3 : ] " idem
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000325 :call filter(list, 'v:val !~ "x"') " remove items with an 'x'
Bram Moolenaar13065c42005-01-08 16:08:21 +0000326
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000327Changing the order of items in a list: >
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000328 :call sort(list) " sort a list alphabetically
329 :call reverse(list) " reverse the order of items
Bram Moolenaar327aa022014-03-25 18:24:23 +0100330 :call uniq(sort(list)) " sort and remove duplicates
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000331
Bram Moolenaar13065c42005-01-08 16:08:21 +0000332
333For loop ~
334
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000335The |:for| loop executes commands for each item in a list. A variable is set
336to each item in the list in sequence. Example: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000337 :for item in mylist
338 : call Doit(item)
Bram Moolenaar13065c42005-01-08 16:08:21 +0000339 :endfor
340
341This works like: >
342 :let index = 0
343 :while index < len(mylist)
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000344 : let item = mylist[index]
345 : :call Doit(item)
Bram Moolenaar13065c42005-01-08 16:08:21 +0000346 : let index = index + 1
347 :endwhile
348
349Note that all items in the list should be of the same type, otherwise this
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000350results in error |E706|. To avoid this |:unlet| the variable at the end of
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000351the loop.
Bram Moolenaar13065c42005-01-08 16:08:21 +0000352
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +0000353If all you want to do is modify each item in the list then the |map()|
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000354function will be a simpler method than a for loop.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +0000355
Bram Moolenaar446cb832008-06-24 21:56:24 +0000356Just like the |:let| command, |:for| also accepts a list of variables. This
Bram Moolenaar13065c42005-01-08 16:08:21 +0000357requires the argument to be a list of lists. >
358 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]]
359 : call Doit(lnum, col)
360 :endfor
361
362This works like a |:let| command is done for each list item. Again, the types
363must remain the same to avoid an error.
364
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000365It is also possible to put remaining items in a List variable: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000366 :for [i, j; rest] in listlist
367 : call Doit(i, j)
368 : if !empty(rest)
369 : echo "remainder: " . string(rest)
370 : endif
371 :endfor
372
373
374List functions ~
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000375 *E714*
Bram Moolenaar13065c42005-01-08 16:08:21 +0000376Functions that are useful with a List: >
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000377 :let r = call(funcname, list) " call a function with an argument list
Bram Moolenaar13065c42005-01-08 16:08:21 +0000378 :if empty(list) " check if list is empty
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000379 :let l = len(list) " number of items in list
380 :let big = max(list) " maximum value in list
381 :let small = min(list) " minimum value in list
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000382 :let xs = count(list, 'x') " count nr of times 'x' appears in list
383 :let i = index(list, 'x') " index of first 'x' in list
Bram Moolenaar13065c42005-01-08 16:08:21 +0000384 :let lines = getline(1, 10) " get ten text lines from buffer
385 :call append('$', lines) " append text lines in buffer
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +0000386 :let list = split("a b c") " create list from items in a string
387 :let string = join(list, ', ') " create string from list items
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000388 :let s = string(list) " String representation of list
389 :call map(list, '">> " . v:val') " prepend ">> " to each item
Bram Moolenaar13065c42005-01-08 16:08:21 +0000390
Bram Moolenaar0cb032e2005-04-23 20:52:00 +0000391Don't forget that a combination of features can make things simple. For
392example, to add up all the numbers in a list: >
393 :exe 'let sum = ' . join(nrlist, '+')
394
Bram Moolenaar13065c42005-01-08 16:08:21 +0000395
Bram Moolenaard8b02732005-01-14 21:48:43 +00003961.4 Dictionaries ~
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200397 *dict* *Dictionaries* *Dictionary*
Bram Moolenaard8b02732005-01-14 21:48:43 +0000398A Dictionary is an associative array: Each entry has a key and a value. The
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000399entry can be located with the key. The entries are stored without a specific
400ordering.
Bram Moolenaard8b02732005-01-14 21:48:43 +0000401
402
403Dictionary creation ~
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000404 *E720* *E721* *E722* *E723*
Bram Moolenaard8b02732005-01-14 21:48:43 +0000405A Dictionary is created with a comma separated list of entries in curly
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000406braces. Each entry has a key and a value, separated by a colon. Each key can
407only appear once. Examples: >
Bram Moolenaard8b02732005-01-14 21:48:43 +0000408 :let mydict = {1: 'one', 2: 'two', 3: 'three'}
409 :let emptydict = {}
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000410< *E713* *E716* *E717*
Bram Moolenaard8b02732005-01-14 21:48:43 +0000411A key is always a String. You can use a Number, it will be converted to a
412String automatically. Thus the String '4' and the number 4 will find the same
Bram Moolenaar446cb832008-06-24 21:56:24 +0000413entry. Note that the String '04' and the Number 04 are different, since the
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000414Number will be converted to the String '4'.
Bram Moolenaard8b02732005-01-14 21:48:43 +0000415
Bram Moolenaar446cb832008-06-24 21:56:24 +0000416A value can be any expression. Using a Dictionary for a value creates a
Bram Moolenaard8b02732005-01-14 21:48:43 +0000417nested Dictionary: >
418 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}}
419
420An extra comma after the last entry is ignored.
421
422
423Accessing entries ~
424
425The normal way to access an entry is by putting the key in square brackets: >
426 :let val = mydict["one"]
427 :let mydict["four"] = 4
428
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000429You can add new entries to an existing Dictionary this way, unlike Lists.
Bram Moolenaard8b02732005-01-14 21:48:43 +0000430
431For keys that consist entirely of letters, digits and underscore the following
432form can be used |expr-entry|: >
433 :let val = mydict.one
434 :let mydict.four = 4
435
436Since an entry can be any type, also a List and a Dictionary, the indexing and
437key lookup can be repeated: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000438 :echo dict.key[idx].key
Bram Moolenaard8b02732005-01-14 21:48:43 +0000439
440
441Dictionary to List conversion ~
442
Bram Moolenaar446cb832008-06-24 21:56:24 +0000443You may want to loop over the entries in a dictionary. For this you need to
Bram Moolenaard8b02732005-01-14 21:48:43 +0000444turn the Dictionary into a List and pass it to |:for|.
445
446Most often you want to loop over the keys, using the |keys()| function: >
447 :for key in keys(mydict)
448 : echo key . ': ' . mydict[key]
449 :endfor
450
451The List of keys is unsorted. You may want to sort them first: >
452 :for key in sort(keys(mydict))
453
454To loop over the values use the |values()| function: >
455 :for v in values(mydict)
456 : echo "value: " . v
457 :endfor
458
459If you want both the key and the value use the |items()| function. It returns
Bram Moolenaar446cb832008-06-24 21:56:24 +0000460a List in which each item is a List with two items, the key and the value: >
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000461 :for [key, value] in items(mydict)
462 : echo key . ': ' . value
Bram Moolenaard8b02732005-01-14 21:48:43 +0000463 :endfor
464
465
466Dictionary identity ~
Bram Moolenaar7c626922005-02-07 22:01:03 +0000467 *dict-identity*
Bram Moolenaard8b02732005-01-14 21:48:43 +0000468Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a
469Dictionary. Otherwise, assignment results in referring to the same
470Dictionary: >
471 :let onedict = {'a': 1, 'b': 2}
472 :let adict = onedict
473 :let adict['a'] = 11
474 :echo onedict['a']
475 11
476
Bram Moolenaarf3bd51a2005-06-14 22:11:18 +0000477Two Dictionaries compare equal if all the key-value pairs compare equal. For
478more info see |list-identity|.
Bram Moolenaard8b02732005-01-14 21:48:43 +0000479
480
481Dictionary modification ~
482 *dict-modification*
483To change an already existing entry of a Dictionary, or to add a new entry,
484use |:let| this way: >
485 :let dict[4] = "four"
486 :let dict['one'] = item
487
Bram Moolenaar9cd15162005-01-16 22:02:49 +0000488Removing an entry from a Dictionary is done with |remove()| or |:unlet|.
489Three ways to remove the entry with key "aaa" from dict: >
490 :let i = remove(dict, 'aaa')
491 :unlet dict.aaa
492 :unlet dict['aaa']
Bram Moolenaard8b02732005-01-14 21:48:43 +0000493
494Merging a Dictionary with another is done with |extend()|: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000495 :call extend(adict, bdict)
496This extends adict with all entries from bdict. Duplicate keys cause entries
497in adict to be overwritten. An optional third argument can change this.
Bram Moolenaar383f9bc2005-01-19 22:18:32 +0000498Note that the order of entries in a Dictionary is irrelevant, thus don't
499expect ":echo adict" to show the items from bdict after the older entries in
500adict.
Bram Moolenaard8b02732005-01-14 21:48:43 +0000501
502Weeding out entries from a Dictionary can be done with |filter()|: >
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000503 :call filter(dict, 'v:val =~ "x"')
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000504This removes all entries from "dict" with a value not matching 'x'.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000505
506
507Dictionary function ~
Bram Moolenaar26402cb2013-02-20 21:26:00 +0100508 *Dictionary-function* *self* *E725* *E862*
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000509When a function is defined with the "dict" attribute it can be used in a
Bram Moolenaar446cb832008-06-24 21:56:24 +0000510special way with a dictionary. Example: >
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000511 :function Mylen() dict
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000512 : return len(self.data)
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000513 :endfunction
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000514 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")}
515 :echo mydict.len()
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000516
517This is like a method in object oriented programming. The entry in the
518Dictionary is a |Funcref|. The local variable "self" refers to the dictionary
519the function was invoked from.
520
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000521It is also possible to add a function without the "dict" attribute as a
522Funcref to a Dictionary, but the "self" variable is not available then.
523
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000524 *numbered-function* *anonymous-function*
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000525To avoid the extra name for the function it can be defined and directly
526assigned to a Dictionary in this way: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000527 :let mydict = {'data': [0, 1, 2, 3]}
528 :function mydict.len() dict
529 : return len(self.data)
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000530 :endfunction
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000531 :echo mydict.len()
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000532
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000533The function will then get a number and the value of dict.len is a |Funcref|
Bram Moolenaar446cb832008-06-24 21:56:24 +0000534that references this function. The function can only be used through a
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000535|Funcref|. It will automatically be deleted when there is no |Funcref|
536remaining that refers to it.
537
538It is not necessary to use the "dict" attribute for a numbered function.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000539
Bram Moolenaar1affd722010-08-04 17:49:30 +0200540If you get an error for a numbered function, you can find out what it is with
541a trick. Assuming the function is 42, the command is: >
542 :function {42}
543
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000544
545Functions for Dictionaries ~
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000546 *E715*
547Functions that can be used with a Dictionary: >
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000548 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo"
549 :if empty(dict) " TRUE if dict is empty
550 :let l = len(dict) " number of items in dict
551 :let big = max(dict) " maximum value in dict
552 :let small = min(dict) " minimum value in dict
553 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict
554 :let s = string(dict) " String representation of dict
555 :call map(dict, '">> " . v:val') " prepend ">> " to each item
Bram Moolenaard8b02732005-01-14 21:48:43 +0000556
557
5581.5 More about variables ~
Bram Moolenaar13065c42005-01-08 16:08:21 +0000559 *more-variables*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560If you need to know the type of a variable or expression, use the |type()|
561function.
562
563When the '!' flag is included in the 'viminfo' option, global variables that
564start with an uppercase letter, and don't contain a lowercase letter, are
565stored in the viminfo file |viminfo-file|.
566
567When the 'sessionoptions' option contains "global", global variables that
568start with an uppercase letter and contain at least one lowercase letter are
569stored in the session file |session-file|.
570
571variable name can be stored where ~
572my_var_6 not
573My_Var_6 session file
574MY_VAR_6 viminfo file
575
576
577It's possible to form a variable name with curly braces, see
578|curly-braces-names|.
579
580==============================================================================
5812. Expression syntax *expression-syntax*
582
583Expression syntax summary, from least to most significant:
584
585|expr1| expr2 ? expr1 : expr1 if-then-else
586
587|expr2| expr3 || expr3 .. logical OR
588
589|expr3| expr4 && expr4 .. logical AND
590
591|expr4| expr5 == expr5 equal
592 expr5 != expr5 not equal
593 expr5 > expr5 greater than
594 expr5 >= expr5 greater than or equal
595 expr5 < expr5 smaller than
596 expr5 <= expr5 smaller than or equal
597 expr5 =~ expr5 regexp matches
598 expr5 !~ expr5 regexp doesn't match
599
600 expr5 ==? expr5 equal, ignoring case
601 expr5 ==# expr5 equal, match case
602 etc. As above, append ? for ignoring case, # for
603 matching case
604
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000605 expr5 is expr5 same |List| instance
606 expr5 isnot expr5 different |List| instance
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000607
608|expr5| expr6 + expr6 .. number addition or list concatenation
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609 expr6 - expr6 .. number subtraction
610 expr6 . expr6 .. string concatenation
611
612|expr6| expr7 * expr7 .. number multiplication
613 expr7 / expr7 .. number division
614 expr7 % expr7 .. number modulo
615
616|expr7| ! expr7 logical NOT
617 - expr7 unary minus
618 + expr7 unary plus
Bram Moolenaar071d4272004-06-13 20:20:40 +0000619
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000620|expr8| expr8[expr1] byte of a String or item of a |List|
621 expr8[expr1 : expr1] substring of a String or sublist of a |List|
622 expr8.name entry in a |Dictionary|
623 expr8(expr1, ...) function call with |Funcref| variable
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000624
625|expr9| number number constant
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000626 "string" string constant, backslash is special
Bram Moolenaard8b02732005-01-14 21:48:43 +0000627 'string' string constant, ' is doubled
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000628 [expr1, ...] |List|
629 {expr1: expr1, ...} |Dictionary|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630 &option option value
631 (expr1) nested expression
632 variable internal variable
633 va{ria}ble internal variable with curly braces
634 $VAR environment variable
635 @r contents of register 'r'
636 function(expr1, ...) function call
637 func{ti}on(expr1, ...) function call with curly braces
638
639
640".." indicates that the operations in this level can be concatenated.
641Example: >
642 &nu || &list && &shell == "csh"
643
644All expressions within one level are parsed from left to right.
645
646
647expr1 *expr1* *E109*
648-----
649
650expr2 ? expr1 : expr1
651
652The expression before the '?' is evaluated to a number. If it evaluates to
653non-zero, the result is the value of the expression between the '?' and ':',
654otherwise the result is the value of the expression after the ':'.
655Example: >
656 :echo lnum == 1 ? "top" : lnum
657
658Since the first expression is an "expr2", it cannot contain another ?:. The
659other two expressions can, thus allow for recursive use of ?:.
660Example: >
661 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum
662
663To keep this readable, using |line-continuation| is suggested: >
664 :echo lnum == 1
665 :\ ? "top"
666 :\ : lnum == 1000
667 :\ ? "last"
668 :\ : lnum
669
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000670You should always put a space before the ':', otherwise it can be mistaken for
671use in a variable such as "a:1".
672
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673
674expr2 and expr3 *expr2* *expr3*
675---------------
676
677 *expr-barbar* *expr-&&*
678The "||" and "&&" operators take one argument on each side. The arguments
679are (converted to) Numbers. The result is:
680
681 input output ~
682n1 n2 n1 || n2 n1 && n2 ~
683zero zero zero zero
684zero non-zero non-zero zero
685non-zero zero non-zero zero
686non-zero non-zero non-zero non-zero
687
688The operators can be concatenated, for example: >
689
690 &nu || &list && &shell == "csh"
691
692Note that "&&" takes precedence over "||", so this has the meaning of: >
693
694 &nu || (&list && &shell == "csh")
695
696Once the result is known, the expression "short-circuits", that is, further
697arguments are not evaluated. This is like what happens in C. For example: >
698
699 let a = 1
700 echo a || b
701
702This is valid even if there is no variable called "b" because "a" is non-zero,
703so the result must be non-zero. Similarly below: >
704
705 echo exists("b") && b == "yes"
706
707This is valid whether "b" has been defined or not. The second clause will
708only be evaluated if "b" has been defined.
709
710
711expr4 *expr4*
712-----
713
714expr5 {cmp} expr5
715
716Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1
717if it evaluates to true.
718
Bram Moolenaar446cb832008-06-24 21:56:24 +0000719 *expr-==* *expr-!=* *expr->* *expr->=*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 *expr-<* *expr-<=* *expr-=~* *expr-!~*
721 *expr-==#* *expr-!=#* *expr->#* *expr->=#*
722 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#*
723 *expr-==?* *expr-!=?* *expr->?* *expr->=?*
724 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?*
Bram Moolenaar251e1912011-06-19 05:09:16 +0200725 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#*
726 *expr-is?* *expr-isnot?*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727 use 'ignorecase' match case ignore case ~
728equal == ==# ==?
729not equal != !=# !=?
730greater than > ># >?
731greater than or equal >= >=# >=?
732smaller than < <# <?
733smaller than or equal <= <=# <=?
734regexp matches =~ =~# =~?
735regexp doesn't match !~ !~# !~?
Bram Moolenaar251e1912011-06-19 05:09:16 +0200736same instance is is# is?
737different instance isnot isnot# isnot?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738
739Examples:
740"abc" ==# "Abc" evaluates to 0
741"abc" ==? "Abc" evaluates to 1
742"abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise
743
Bram Moolenaar13065c42005-01-08 16:08:21 +0000744 *E691* *E692*
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000745A |List| can only be compared with a |List| and only "equal", "not equal" and
746"is" can be used. This compares the values of the list, recursively.
747Ignoring case means case is ignored when comparing item values.
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000748
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000749 *E735* *E736*
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000750A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not
751equal" and "is" can be used. This compares the key/values of the |Dictionary|
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000752recursively. Ignoring case means case is ignored when comparing item values.
753
Bram Moolenaar13065c42005-01-08 16:08:21 +0000754 *E693* *E694*
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000755A |Funcref| can only be compared with a |Funcref| and only "equal" and "not
756equal" can be used. Case is never ignored.
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000757
Bram Moolenaar251e1912011-06-19 05:09:16 +0200758When using "is" or "isnot" with a |List| or a |Dictionary| this checks if the
759expressions are referring to the same |List| or |Dictionary| instance. A copy
760of a |List| is different from the original |List|. When using "is" without
761a |List| or a |Dictionary| it is equivalent to using "equal", using "isnot"
762equivalent to using "not equal". Except that a different type means the
763values are different: "4 == '4'" is true, "4 is '4'" is false and "0 is []" is
Bram Moolenaard09acef2012-09-21 14:54:30 +0200764false and not an error. "is#"/"isnot#" and "is?"/"isnot?" can be used to match
Bram Moolenaar251e1912011-06-19 05:09:16 +0200765and ignore case.
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000766
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767When comparing a String with a Number, the String is converted to a Number,
Bram Moolenaar446cb832008-06-24 21:56:24 +0000768and the comparison is done on Numbers. This means that "0 == 'x'" is TRUE,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769because 'x' converted to a Number is zero.
770
771When comparing two Strings, this is done with strcmp() or stricmp(). This
772results in the mathematical difference (comparing byte values), not
773necessarily the alphabetical difference in the local language.
774
Bram Moolenaar446cb832008-06-24 21:56:24 +0000775When using the operators with a trailing '#', or the short version and
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000776'ignorecase' is off, the comparing is done with strcmp(): case matters.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777
778When using the operators with a trailing '?', or the short version and
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000779'ignorecase' is set, the comparing is done with stricmp(): case is ignored.
780
781'smartcase' is not used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782
783The "=~" and "!~" operators match the lefthand argument with the righthand
784argument, which is used as a pattern. See |pattern| for what a pattern is.
785This matching is always done like 'magic' was set and 'cpoptions' is empty, no
786matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts
787portable. To avoid backslashes in the regexp pattern to be doubled, use a
788single-quote string, see |literal-string|.
789Since a string is considered to be a single line, a multi-line pattern
790(containing \n, backslash-n) will not match. However, a literal NL character
791can be matched like an ordinary character. Examples:
792 "foo\nbar" =~ "\n" evaluates to 1
793 "foo\nbar" =~ "\\n" evaluates to 0
794
795
796expr5 and expr6 *expr5* *expr6*
797---------------
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000798expr6 + expr6 .. Number addition or |List| concatenation *expr-+*
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000799expr6 - expr6 .. Number subtraction *expr--*
800expr6 . expr6 .. String concatenation *expr-.*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801
Bram Moolenaara23ccb82006-02-27 00:08:02 +0000802For |Lists| only "+" is possible and then both expr6 must be a list. The
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000803result is a new list with the two lists Concatenated.
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000804
Bram Moolenaard6e256c2011-12-14 15:32:50 +0100805expr7 * expr7 .. Number multiplication *expr-star*
806expr7 / expr7 .. Number division *expr-/*
807expr7 % expr7 .. Number modulo *expr-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808
809For all, except ".", Strings are converted to Numbers.
Bram Moolenaard6e256c2011-12-14 15:32:50 +0100810For bitwise operators see |and()|, |or()| and |xor()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811
812Note the difference between "+" and ".":
813 "123" + "456" = 579
814 "123" . "456" = "123456"
815
Bram Moolenaar446cb832008-06-24 21:56:24 +0000816Since '.' has the same precedence as '+' and '-', you need to read: >
817 1 . 90 + 90.0
818As: >
819 (1 . 90) + 90.0
820That works, since the String "190" is automatically converted to the Number
821190, which can be added to the Float 90.0. However: >
822 1 . 90 * 90.0
823Should be read as: >
824 1 . (90 * 90.0)
825Since '.' has lower precedence than '*'. This does NOT work, since this
826attempts to concatenate a Float and a String.
827
828When dividing a Number by zero the result depends on the value:
829 0 / 0 = -0x80000000 (like NaN for Float)
830 >0 / 0 = 0x7fffffff (like positive infinity)
831 <0 / 0 = -0x7fffffff (like negative infinity)
832 (before Vim 7.2 it was always 0x7fffffff)
833
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834When the righthand side of '%' is zero, the result is 0.
835
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000836None of these work for |Funcref|s.
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000837
Bram Moolenaar446cb832008-06-24 21:56:24 +0000838. and % do not work for Float. *E804*
839
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840
841expr7 *expr7*
842-----
843! expr7 logical NOT *expr-!*
844- expr7 unary minus *expr-unary--*
845+ expr7 unary plus *expr-unary-+*
846
847For '!' non-zero becomes zero, zero becomes one.
848For '-' the sign of the number is changed.
849For '+' the number is unchanged.
850
851A String will be converted to a Number first.
852
Bram Moolenaar446cb832008-06-24 21:56:24 +0000853These three can be repeated and mixed. Examples:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854 !-1 == 0
855 !!8 == 1
856 --9 == 9
857
858
859expr8 *expr8*
860-----
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000861expr8[expr1] item of String or |List| *expr-[]* *E111*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000863If expr8 is a Number or String this results in a String that contains the
864expr1'th single byte from expr8. expr8 is used as a String, expr1 as a
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100865Number. This doesn't recognize multi-byte encodings, see |byteidx()| for
866an alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000868Index zero gives the first character. This is like it works in C. Careful:
869text column numbers start with one! Example, to get the character under the
870cursor: >
Bram Moolenaar61660ea2006-04-07 21:40:07 +0000871 :let c = getline(".")[col(".") - 1]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872
873If the length of the String is less than the index, the result is an empty
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000874String. A negative index always results in an empty string (reason: backwards
875compatibility). Use [-1:] to get the last byte.
876
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000877If expr8 is a |List| then it results the item at index expr1. See |list-index|
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000878for possible index values. If the index is out of range this results in an
Bram Moolenaar446cb832008-06-24 21:56:24 +0000879error. Example: >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000880 :let item = mylist[-1] " get last item
881
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000882Generally, if a |List| index is equal to or higher than the length of the
883|List|, or more negative than the length of the |List|, this results in an
884error.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000885
Bram Moolenaard8b02732005-01-14 21:48:43 +0000886
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000887expr8[expr1a : expr1b] substring or sublist *expr-[:]*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000888
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000889If expr8 is a Number or String this results in the substring with the bytes
890from expr1a to and including expr1b. expr8 is used as a String, expr1a and
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100891expr1b are used as a Number. This doesn't recognize multi-byte encodings, see
892|byteidx()| for computing the indexes.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000893
894If expr1a is omitted zero is used. If expr1b is omitted the length of the
895string minus one is used.
896
897A negative number can be used to measure from the end of the string. -1 is
898the last character, -2 the last but one, etc.
899
900If an index goes out of range for the string characters are omitted. If
901expr1b is smaller than expr1a the result is an empty string.
902
903Examples: >
904 :let c = name[-1:] " last byte of a string
905 :let c = name[-2:-2] " last but one byte of a string
906 :let s = line(".")[4:] " from the fifth byte to the end
907 :let s = s[:-3] " remove last two bytes
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100908<
909 *sublist* *slice*
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000910If expr8 is a |List| this results in a new |List| with the items indicated by
Bram Moolenaar446cb832008-06-24 21:56:24 +0000911the indexes expr1a and expr1b. This works like with a String, as explained
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000912just above, except that indexes out of range cause an error. Examples: >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000913 :let l = mylist[:3] " first four items
914 :let l = mylist[4:4] " List with one item
915 :let l = mylist[:] " shallow copy of a List
916
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000917Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an
918error.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000919
Bram Moolenaard8b02732005-01-14 21:48:43 +0000920
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000921expr8.name entry in a |Dictionary| *expr-entry*
Bram Moolenaard8b02732005-01-14 21:48:43 +0000922
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000923If expr8 is a |Dictionary| and it is followed by a dot, then the following
924name will be used as a key in the |Dictionary|. This is just like:
925expr8[name].
Bram Moolenaard8b02732005-01-14 21:48:43 +0000926
927The name must consist of alphanumeric characters, just like a variable name,
928but it may start with a number. Curly braces cannot be used.
929
930There must not be white space before or after the dot.
931
932Examples: >
933 :let dict = {"one": 1, 2: "two"}
934 :echo dict.one
935 :echo dict .2
936
937Note that the dot is also used for String concatenation. To avoid confusion
938always put spaces around the dot for String concatenation.
939
940
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000941expr8(expr1, ...) |Funcref| function call
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000942
943When expr8 is a |Funcref| type variable, invoke the function it refers to.
944
945
946
947 *expr9*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948number
949------
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100950number number constant *expr-number*
951 *hex-number* *octal-number*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000952
953Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0).
954
Bram Moolenaar446cb832008-06-24 21:56:24 +0000955 *floating-point-format*
956Floating point numbers can be written in two forms:
957
958 [-+]{N}.{M}
Bram Moolenaar8a94d872015-01-25 13:02:57 +0100959 [-+]{N}.{M}[eE][-+]{exp}
Bram Moolenaar446cb832008-06-24 21:56:24 +0000960
961{N} and {M} are numbers. Both {N} and {M} must be present and can only
962contain digits.
963[-+] means there is an optional plus or minus sign.
964{exp} is the exponent, power of 10.
965Only a decimal point is accepted, not a comma. No matter what the current
966locale is.
967{only when compiled with the |+float| feature}
968
969Examples:
970 123.456
971 +0.0001
972 55.0
973 -0.123
974 1.234e03
975 1.0E-6
976 -3.1416e+88
977
978These are INVALID:
979 3. empty {M}
980 1e40 missing .{M}
981
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000982 *float-pi* *float-e*
983A few useful values to copy&paste: >
984 :let pi = 3.14159265359
985 :let e = 2.71828182846
986
Bram Moolenaar446cb832008-06-24 21:56:24 +0000987Rationale:
988Before floating point was introduced, the text "123.456" was interpreted as
989the two numbers "123" and "456", both converted to a string and concatenated,
990resulting in the string "123456". Since this was considered pointless, and we
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000991could not find it intentionally being used in Vim scripts, this backwards
Bram Moolenaar446cb832008-06-24 21:56:24 +0000992incompatibility was accepted in favor of being able to use the normal notation
993for floating point numbers.
994
995 *floating-point-precision*
996The precision and range of floating points numbers depends on what "double"
997means in the library Vim was compiled with. There is no way to change this at
998runtime.
999
1000The default for displaying a |Float| is to use 6 decimal places, like using
1001printf("%g", f). You can select something else when using the |printf()|
1002function. Example: >
1003 :echo printf('%.15e', atan(1))
1004< 7.853981633974483e-01
1005
1006
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007
Bram Moolenaar7e38ea22014-04-05 22:55:53 +02001008string *string* *expr-string* *E114*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009------
1010"string" string constant *expr-quote*
1011
1012Note that double quotes are used.
1013
1014A string constant accepts these special characters:
1015\... three-digit octal number (e.g., "\316")
1016\.. two-digit octal number (must be followed by non-digit)
1017\. one-digit octal number (must be followed by non-digit)
1018\x.. byte specified with two hex numbers (e.g., "\x1f")
1019\x. byte specified with one hex number (must be followed by non-hex char)
1020\X.. same as \x..
1021\X. same as \x.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001022\u.... character specified with up to 4 hex numbers, stored according to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023 current value of 'encoding' (e.g., "\u02a4")
1024\U.... same as \u....
1025\b backspace <BS>
1026\e escape <Esc>
1027\f formfeed <FF>
1028\n newline <NL>
1029\r return <CR>
1030\t tab <Tab>
1031\\ backslash
1032\" double quote
Bram Moolenaar00a927d2010-05-14 23:24:24 +02001033\<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use
1034 in mappings, the 0x80 byte is escaped. Don't use <Char-xxxx> to get a
1035 utf-8 character, use \uxxxx as mentioned above.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036
Bram Moolenaaref2f6562007-05-06 13:32:59 +00001037Note that "\xff" is stored as the byte 255, which may be invalid in some
1038encodings. Use "\u00ff" to store character 255 according to the current value
1039of 'encoding'.
1040
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041Note that "\000" and "\x00" force the end of the string.
1042
1043
1044literal-string *literal-string* *E115*
1045---------------
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001046'string' string constant *expr-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047
1048Note that single quotes are used.
1049
Bram Moolenaar446cb832008-06-24 21:56:24 +00001050This string is taken as it is. No backslashes are removed or have a special
Bram Moolenaard8b02732005-01-14 21:48:43 +00001051meaning. The only exception is that two quotes stand for one quote.
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001052
1053Single quoted strings are useful for patterns, so that backslashes do not need
Bram Moolenaar446cb832008-06-24 21:56:24 +00001054to be doubled. These two commands are equivalent: >
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001055 if a =~ "\\s*"
1056 if a =~ '\s*'
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057
1058
1059option *expr-option* *E112* *E113*
1060------
1061&option option value, local value if possible
1062&g:option global option value
1063&l:option local option value
1064
1065Examples: >
1066 echo "tabstop is " . &tabstop
1067 if &insertmode
1068
1069Any option name can be used here. See |options|. When using the local value
1070and there is no buffer-local or window-local value, the global value is used
1071anyway.
1072
1073
Bram Moolenaaref2f6562007-05-06 13:32:59 +00001074register *expr-register* *@r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075--------
1076@r contents of register 'r'
1077
1078The result is the contents of the named register, as a single string.
1079Newlines are inserted where required. To get the contents of the unnamed
Bram Moolenaar446cb832008-06-24 21:56:24 +00001080register use @" or @@. See |registers| for an explanation of the available
Bram Moolenaare7566042005-06-17 22:00:15 +00001081registers.
1082
1083When using the '=' register you get the expression itself, not what it
1084evaluates to. Use |eval()| to evaluate it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085
1086
1087nesting *expr-nesting* *E110*
1088-------
1089(expr1) nested expression
1090
1091
1092environment variable *expr-env*
1093--------------------
1094$VAR environment variable
1095
1096The String value of any environment variable. When it is not defined, the
1097result is an empty string.
1098 *expr-env-expand*
1099Note that there is a difference between using $VAR directly and using
1100expand("$VAR"). Using it directly will only expand environment variables that
1101are known inside the current Vim session. Using expand() will first try using
1102the environment variables known inside the current Vim session. If that
1103fails, a shell will be used to expand the variable. This can be slow, but it
1104does expand all variables that the shell knows about. Example: >
Bram Moolenaar34401cc2014-08-29 15:12:19 +02001105 :echo $shell
1106 :echo expand("$shell")
1107The first one probably doesn't echo anything, the second echoes the $shell
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108variable (if your shell supports it).
1109
1110
1111internal variable *expr-variable*
1112-----------------
1113variable internal variable
1114See below |internal-variables|.
1115
1116
Bram Moolenaar05159a02005-02-26 23:04:13 +00001117function call *expr-function* *E116* *E118* *E119* *E120*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118-------------
1119function(expr1, ...) function call
1120See below |functions|.
1121
1122
1123==============================================================================
Bram Moolenaar4a748032010-09-30 21:47:56 +020011243. Internal variable *internal-variables* *E461*
1125
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126An internal variable name can be made up of letters, digits and '_'. But it
1127cannot start with a digit. It's also possible to use curly braces, see
1128|curly-braces-names|.
1129
1130An internal variable is created with the ":let" command |:let|.
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00001131An internal variable is explicitly destroyed with the ":unlet" command
1132|:unlet|.
1133Using a name that is not an internal variable or refers to a variable that has
1134been destroyed results in an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001135
1136There are several name spaces for variables. Which one is to be used is
1137specified by what is prepended:
1138
1139 (nothing) In a function: local to a function; otherwise: global
1140|buffer-variable| b: Local to the current buffer.
1141|window-variable| w: Local to the current window.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001142|tabpage-variable| t: Local to the current tab page.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001143|global-variable| g: Global.
1144|local-variable| l: Local to a function.
1145|script-variable| s: Local to a |:source|'ed Vim script.
1146|function-argument| a: Function argument (only inside a function).
Bram Moolenaar75b81562014-04-06 14:09:13 +02001147|vim-variable| v: Global, predefined by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001149The scope name by itself can be used as a |Dictionary|. For example, to
1150delete all script-local variables: >
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001151 :for k in keys(s:)
1152 : unlet s:[k]
1153 :endfor
1154<
Bram Moolenaar531da592013-05-06 05:58:55 +02001155 *buffer-variable* *b:var* *b:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156A variable name that is preceded with "b:" is local to the current buffer.
1157Thus you can have several "b:foo" variables, one for each buffer.
1158This kind of variable is deleted when the buffer is wiped out or deleted with
1159|:bdelete|.
1160
1161One local buffer variable is predefined:
Bram Moolenaarbf884932013-04-05 22:26:15 +02001162 *b:changedtick* *changetick*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163b:changedtick The total number of changes to the current buffer. It is
1164 incremented for each change. An undo command is also a change
1165 in this case. This can be used to perform an action only when
1166 the buffer has changed. Example: >
1167 :if my_changedtick != b:changedtick
Bram Moolenaar446cb832008-06-24 21:56:24 +00001168 : let my_changedtick = b:changedtick
1169 : call My_Update()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 :endif
1171<
Bram Moolenaar531da592013-05-06 05:58:55 +02001172 *window-variable* *w:var* *w:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173A variable name that is preceded with "w:" is local to the current window. It
1174is deleted when the window is closed.
1175
Bram Moolenaarad3b3662013-05-17 18:14:19 +02001176 *tabpage-variable* *t:var* *t:*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001177A variable name that is preceded with "t:" is local to the current tab page,
1178It is deleted when the tab page is closed. {not available when compiled
Bram Moolenaardb84e452010-08-15 13:50:43 +02001179without the |+windows| feature}
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001180
Bram Moolenaar531da592013-05-06 05:58:55 +02001181 *global-variable* *g:var* *g:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182Inside functions global variables are accessed with "g:". Omitting this will
Bram Moolenaar446cb832008-06-24 21:56:24 +00001183access a variable local to a function. But "g:" can also be used in any other
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184place if you like.
1185
Bram Moolenaar531da592013-05-06 05:58:55 +02001186 *local-variable* *l:var* *l:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187Inside functions local variables are accessed without prepending anything.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00001188But you can also prepend "l:" if you like. However, without prepending "l:"
1189you may run into reserved variable names. For example "count". By itself it
1190refers to "v:count". Using "l:count" you can have a local variable with the
1191same name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001192
1193 *script-variable* *s:var*
1194In a Vim script variables starting with "s:" can be used. They cannot be
1195accessed from outside of the scripts, thus are local to the script.
1196
1197They can be used in:
1198- commands executed while the script is sourced
1199- functions defined in the script
1200- autocommands defined in the script
1201- functions and autocommands defined in functions and autocommands which were
1202 defined in the script (recursively)
1203- user defined commands defined in the script
1204Thus not in:
1205- other scripts sourced from this one
1206- mappings
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001207- menus
Bram Moolenaar071d4272004-06-13 20:20:40 +00001208- etc.
1209
Bram Moolenaaref2f6562007-05-06 13:32:59 +00001210Script variables can be used to avoid conflicts with global variable names.
1211Take this example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001212
1213 let s:counter = 0
1214 function MyCounter()
1215 let s:counter = s:counter + 1
1216 echo s:counter
1217 endfunction
1218 command Tick call MyCounter()
1219
1220You can now invoke "Tick" from any script, and the "s:counter" variable in
1221that script will not be changed, only the "s:counter" in the script where
1222"Tick" was defined is used.
1223
1224Another example that does the same: >
1225
1226 let s:counter = 0
1227 command Tick let s:counter = s:counter + 1 | echo s:counter
1228
1229When calling a function and invoking a user-defined command, the context for
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001230script variables is set to the script where the function or command was
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231defined.
1232
1233The script variables are also available when a function is defined inside a
1234function that is defined in a script. Example: >
1235
1236 let s:counter = 0
1237 function StartCounting(incr)
1238 if a:incr
1239 function MyCounter()
1240 let s:counter = s:counter + 1
1241 endfunction
1242 else
1243 function MyCounter()
1244 let s:counter = s:counter - 1
1245 endfunction
1246 endif
1247 endfunction
1248
1249This defines the MyCounter() function either for counting up or counting down
1250when calling StartCounting(). It doesn't matter from where StartCounting() is
1251called, the s:counter variable will be accessible in MyCounter().
1252
1253When the same script is sourced again it will use the same script variables.
1254They will remain valid as long as Vim is running. This can be used to
1255maintain a counter: >
1256
1257 if !exists("s:counter")
1258 let s:counter = 1
1259 echo "script executed for the first time"
1260 else
1261 let s:counter = s:counter + 1
1262 echo "script executed " . s:counter . " times now"
1263 endif
1264
1265Note that this means that filetype plugins don't get a different set of script
1266variables for each buffer. Use local buffer variables instead |b:var|.
1267
1268
Bram Moolenaar531da592013-05-06 05:58:55 +02001269Predefined Vim variables: *vim-variable* *v:var* *v:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001271 *v:beval_col* *beval_col-variable*
1272v:beval_col The number of the column, over which the mouse pointer is.
1273 This is the byte index in the |v:beval_lnum| line.
1274 Only valid while evaluating the 'balloonexpr' option.
1275
1276 *v:beval_bufnr* *beval_bufnr-variable*
1277v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only
1278 valid while evaluating the 'balloonexpr' option.
1279
1280 *v:beval_lnum* *beval_lnum-variable*
1281v:beval_lnum The number of the line, over which the mouse pointer is. Only
1282 valid while evaluating the 'balloonexpr' option.
1283
1284 *v:beval_text* *beval_text-variable*
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001285v:beval_text The text under or after the mouse pointer. Usually a word as
1286 it is useful for debugging a C program. 'iskeyword' applies,
1287 but a dot and "->" before the position is included. When on a
1288 ']' the text before it is used, including the matching '[' and
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001289 word before it. When on a Visual area within one line the
1290 highlighted text is used.
1291 Only valid while evaluating the 'balloonexpr' option.
1292
1293 *v:beval_winnr* *beval_winnr-variable*
1294v:beval_winnr The number of the window, over which the mouse pointer is. Only
Bram Moolenaar00654022011-02-25 14:42:19 +01001295 valid while evaluating the 'balloonexpr' option. The first
1296 window has number zero (unlike most other places where a
1297 window gets a number).
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001298
Bram Moolenaarf193fff2006-04-27 00:02:13 +00001299 *v:char* *char-variable*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001300v:char Argument for evaluating 'formatexpr' and used for the typed
Bram Moolenaar945e2db2010-06-05 17:43:32 +02001301 character when using <expr> in an abbreviation |:map-<expr>|.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02001302 It is also used by the |InsertCharPre| and |InsertEnter| events.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00001303
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304 *v:charconvert_from* *charconvert_from-variable*
1305v:charconvert_from
1306 The name of the character encoding of a file to be converted.
1307 Only valid while evaluating the 'charconvert' option.
1308
1309 *v:charconvert_to* *charconvert_to-variable*
1310v:charconvert_to
1311 The name of the character encoding of a file after conversion.
1312 Only valid while evaluating the 'charconvert' option.
1313
1314 *v:cmdarg* *cmdarg-variable*
1315v:cmdarg This variable is used for two purposes:
1316 1. The extra arguments given to a file read/write command.
1317 Currently these are "++enc=" and "++ff=". This variable is
1318 set before an autocommand event for a file read/write
1319 command is triggered. There is a leading space to make it
1320 possible to append this variable directly after the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001321 read/write command. Note: The "+cmd" argument isn't
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322 included here, because it will be executed anyway.
1323 2. When printing a PostScript file with ":hardcopy" this is
1324 the argument for the ":hardcopy" command. This can be used
1325 in 'printexpr'.
1326
1327 *v:cmdbang* *cmdbang-variable*
1328v:cmdbang Set like v:cmdarg for a file read/write command. When a "!"
1329 was used the value is 1, otherwise it is 0. Note that this
1330 can only be used in autocommands. For user commands |<bang>|
1331 can be used.
1332
1333 *v:count* *count-variable*
1334v:count The count given for the last Normal mode command. Can be used
Bram Moolenaar446cb832008-06-24 21:56:24 +00001335 to get the count before a mapping. Read-only. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 :map _x :<C-U>echo "the count is " . v:count<CR>
1337< Note: The <C-U> is required to remove the line range that you
1338 get when typing ':' after a count.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001339 When there are two counts, as in "3d2w", they are multiplied,
1340 just like what happens in the command, "d6w" for the example.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001341 Also used for evaluating the 'formatexpr' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 "count" also works, for backwards compatibility.
1343
1344 *v:count1* *count1-variable*
1345v:count1 Just like "v:count", but defaults to one when no count is
1346 used.
1347
1348 *v:ctype* *ctype-variable*
1349v:ctype The current locale setting for characters of the runtime
1350 environment. This allows Vim scripts to be aware of the
1351 current locale encoding. Technical: it's the value of
1352 LC_CTYPE. When not using a locale the value is "C".
1353 This variable can not be set directly, use the |:language|
1354 command.
1355 See |multi-lang|.
1356
1357 *v:dying* *dying-variable*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001358v:dying Normally zero. When a deadly signal is caught it's set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001359 one. When multiple signals are caught the number increases.
1360 Can be used in an autocommand to check if Vim didn't
1361 terminate normally. {only works on Unix}
1362 Example: >
1363 :au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endif
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +02001364< Note: if another deadly signal is caught when v:dying is one,
1365 VimLeave autocommands will not be executed.
1366
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 *v:errmsg* *errmsg-variable*
1368v:errmsg Last given error message. It's allowed to set this variable.
1369 Example: >
1370 :let v:errmsg = ""
1371 :silent! next
1372 :if v:errmsg != ""
1373 : ... handle error
1374< "errmsg" also works, for backwards compatibility.
1375
1376 *v:exception* *exception-variable*
1377v:exception The value of the exception most recently caught and not
1378 finished. See also |v:throwpoint| and |throw-variables|.
1379 Example: >
1380 :try
1381 : throw "oops"
1382 :catch /.*/
1383 : echo "caught" v:exception
1384 :endtry
1385< Output: "caught oops".
1386
Bram Moolenaar19a09a12005-03-04 23:39:37 +00001387 *v:fcs_reason* *fcs_reason-variable*
1388v:fcs_reason The reason why the |FileChangedShell| event was triggered.
1389 Can be used in an autocommand to decide what to do and/or what
1390 to set v:fcs_choice to. Possible values:
1391 deleted file no longer exists
1392 conflict file contents, mode or timestamp was
1393 changed and buffer is modified
1394 changed file contents has changed
1395 mode mode of file changed
1396 time only file timestamp changed
1397
1398 *v:fcs_choice* *fcs_choice-variable*
1399v:fcs_choice What should happen after a |FileChangedShell| event was
1400 triggered. Can be used in an autocommand to tell Vim what to
1401 do with the affected buffer:
1402 reload Reload the buffer (does not work if
1403 the file was deleted).
1404 ask Ask the user what to do, as if there
1405 was no autocommand. Except that when
1406 only the timestamp changed nothing
1407 will happen.
1408 <empty> Nothing, the autocommand should do
1409 everything that needs to be done.
1410 The default is empty. If another (invalid) value is used then
1411 Vim behaves like it is empty, there is no warning message.
1412
Bram Moolenaar071d4272004-06-13 20:20:40 +00001413 *v:fname_in* *fname_in-variable*
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001414v:fname_in The name of the input file. Valid while evaluating:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415 option used for ~
1416 'charconvert' file to be converted
1417 'diffexpr' original file
1418 'patchexpr' original file
1419 'printexpr' file to be printed
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00001420 And set to the swap file name for |SwapExists|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421
1422 *v:fname_out* *fname_out-variable*
1423v:fname_out The name of the output file. Only valid while
1424 evaluating:
1425 option used for ~
1426 'charconvert' resulting converted file (*)
1427 'diffexpr' output of diff
1428 'patchexpr' resulting patched file
1429 (*) When doing conversion for a write command (e.g., ":w
Bram Moolenaar446cb832008-06-24 21:56:24 +00001430 file") it will be equal to v:fname_in. When doing conversion
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431 for a read command (e.g., ":e file") it will be a temporary
1432 file and different from v:fname_in.
1433
1434 *v:fname_new* *fname_new-variable*
1435v:fname_new The name of the new version of the file. Only valid while
1436 evaluating 'diffexpr'.
1437
1438 *v:fname_diff* *fname_diff-variable*
1439v:fname_diff The name of the diff (patch) file. Only valid while
1440 evaluating 'patchexpr'.
1441
1442 *v:folddashes* *folddashes-variable*
1443v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed
1444 fold.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001445 Read-only in the |sandbox|. |fold-foldtext|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446
1447 *v:foldlevel* *foldlevel-variable*
1448v:foldlevel Used for 'foldtext': foldlevel of closed fold.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001449 Read-only in the |sandbox|. |fold-foldtext|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450
1451 *v:foldend* *foldend-variable*
1452v:foldend Used for 'foldtext': last line of closed fold.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001453 Read-only in the |sandbox|. |fold-foldtext|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454
1455 *v:foldstart* *foldstart-variable*
1456v:foldstart Used for 'foldtext': first line of closed fold.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001457 Read-only in the |sandbox|. |fold-foldtext|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458
Bram Moolenaar817a8802013-11-09 01:44:43 +01001459 *v:hlsearch* *hlsearch-variable*
Bram Moolenaar76440e22014-11-27 19:14:49 +01001460v:hlsearch Variable that indicates whether search highlighting is on.
1461 Setting it makes sense only if 'hlsearch' is enabled which
1462 requires |+extra_search|. Setting this variable to zero acts
1463 the like |:nohlsearch| command, setting it to one acts like >
Bram Moolenaar817a8802013-11-09 01:44:43 +01001464 let &hlsearch = &hlsearch
1465<
Bram Moolenaar843ee412004-06-30 16:16:41 +00001466 *v:insertmode* *insertmode-variable*
1467v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand
1468 events. Values:
1469 i Insert mode
1470 r Replace mode
1471 v Virtual Replace mode
1472
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001473 *v:key* *key-variable*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001474v:key Key of the current item of a |Dictionary|. Only valid while
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001475 evaluating the expression used with |map()| and |filter()|.
1476 Read-only.
1477
Bram Moolenaar071d4272004-06-13 20:20:40 +00001478 *v:lang* *lang-variable*
1479v:lang The current locale setting for messages of the runtime
1480 environment. This allows Vim scripts to be aware of the
1481 current language. Technical: it's the value of LC_MESSAGES.
1482 The value is system dependent.
1483 This variable can not be set directly, use the |:language|
1484 command.
1485 It can be different from |v:ctype| when messages are desired
1486 in a different language than what is used for character
1487 encoding. See |multi-lang|.
1488
1489 *v:lc_time* *lc_time-variable*
1490v:lc_time The current locale setting for time messages of the runtime
1491 environment. This allows Vim scripts to be aware of the
1492 current language. Technical: it's the value of LC_TIME.
1493 This variable can not be set directly, use the |:language|
1494 command. See |multi-lang|.
1495
1496 *v:lnum* *lnum-variable*
Bram Moolenaar368373e2010-07-19 20:46:22 +02001497v:lnum Line number for the 'foldexpr' |fold-expr|, 'formatexpr' and
1498 'indentexpr' expressions, tab page number for 'guitablabel'
1499 and 'guitabtooltip'. Only valid while one of these
1500 expressions is being evaluated. Read-only when in the
1501 |sandbox|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502
Bram Moolenaar219b8702006-11-01 14:32:36 +00001503 *v:mouse_win* *mouse_win-variable*
1504v:mouse_win Window number for a mouse click obtained with |getchar()|.
1505 First window has number 1, like with |winnr()|. The value is
1506 zero when there was no mouse button click.
1507
1508 *v:mouse_lnum* *mouse_lnum-variable*
1509v:mouse_lnum Line number for a mouse click obtained with |getchar()|.
1510 This is the text line number, not the screen line number. The
1511 value is zero when there was no mouse button click.
1512
1513 *v:mouse_col* *mouse_col-variable*
1514v:mouse_col Column number for a mouse click obtained with |getchar()|.
1515 This is the screen column number, like with |virtcol()|. The
1516 value is zero when there was no mouse button click.
1517
Bram Moolenaard812df62008-11-09 12:46:09 +00001518 *v:oldfiles* *oldfiles-variable*
1519v:oldfiles List of file names that is loaded from the |viminfo| file on
1520 startup. These are the files that Vim remembers marks for.
1521 The length of the List is limited by the ' argument of the
1522 'viminfo' option (default is 100).
Bram Moolenaar8d043172014-01-23 14:24:41 +01001523 When the |viminfo| file is not used the List is empty.
Bram Moolenaard812df62008-11-09 12:46:09 +00001524 Also see |:oldfiles| and |c_#<|.
1525 The List can be modified, but this has no effect on what is
1526 stored in the |viminfo| file later. If you use values other
1527 than String this will cause trouble.
Bram Moolenaardb84e452010-08-15 13:50:43 +02001528 {only when compiled with the |+viminfo| feature}
Bram Moolenaard812df62008-11-09 12:46:09 +00001529
Bram Moolenaar8af1fbf2008-01-05 12:35:21 +00001530 *v:operator* *operator-variable*
1531v:operator The last operator given in Normal mode. This is a single
1532 character except for commands starting with <g> or <z>,
1533 in which case it is two characters. Best used alongside
1534 |v:prevcount| and |v:register|. Useful if you want to cancel
1535 Operator-pending mode and then use the operator, e.g.: >
1536 :omap O <Esc>:call MyMotion(v:operator)<CR>
1537< The value remains set until another operator is entered, thus
1538 don't expect it to be empty.
1539 v:operator is not set for |:delete|, |:yank| or other Ex
1540 commands.
1541 Read-only.
1542
Bram Moolenaar071d4272004-06-13 20:20:40 +00001543 *v:prevcount* *prevcount-variable*
1544v:prevcount The count given for the last but one Normal mode command.
1545 This is the v:count value of the previous command. Useful if
Bram Moolenaar8af1fbf2008-01-05 12:35:21 +00001546 you want to cancel Visual or Operator-pending mode and then
1547 use the count, e.g.: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548 :vmap % <Esc>:call MyFilter(v:prevcount)<CR>
1549< Read-only.
1550
Bram Moolenaar05159a02005-02-26 23:04:13 +00001551 *v:profiling* *profiling-variable*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001552v:profiling Normally zero. Set to one after using ":profile start".
Bram Moolenaar05159a02005-02-26 23:04:13 +00001553 See |profiling|.
1554
Bram Moolenaar071d4272004-06-13 20:20:40 +00001555 *v:progname* *progname-variable*
1556v:progname Contains the name (with path removed) with which Vim was
Bram Moolenaard38b0552012-04-25 19:07:41 +02001557 invoked. Allows you to do special initialisations for |view|,
1558 |evim| etc., or any other name you might symlink to Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 Read-only.
1560
Bram Moolenaara1706c92014-04-01 19:55:49 +02001561 *v:progpath* *progpath-variable*
1562v:progpath Contains the command with which Vim was invoked, including the
1563 path. Useful if you want to message a Vim server using a
1564 |--remote-expr|.
Bram Moolenaarc7f02552014-04-01 21:00:59 +02001565 To get the full path use: >
1566 echo exepath(v:progpath)
1567< NOTE: This does not work when the command is a relative path
1568 and the current directory has changed.
Bram Moolenaara1706c92014-04-01 19:55:49 +02001569 Read-only.
1570
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 *v:register* *register-variable*
Bram Moolenaard58e9292011-02-09 17:07:58 +01001572v:register The name of the register in effect for the current normal mode
Bram Moolenaard38b0552012-04-25 19:07:41 +02001573 command (regardless of whether that command actually used a
1574 register). Or for the currently executing normal mode mapping
1575 (use this in custom commands that take a register).
1576 If none is supplied it is the default register '"', unless
1577 'clipboard' contains "unnamed" or "unnamedplus", then it is
1578 '*' or '+'.
Bram Moolenaard58e9292011-02-09 17:07:58 +01001579 Also see |getreg()| and |setreg()|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001581 *v:scrollstart* *scrollstart-variable*
1582v:scrollstart String describing the script or function that caused the
1583 screen to scroll up. It's only set when it is empty, thus the
1584 first reason is remembered. It is set to "Unknown" for a
1585 typed command.
1586 This can be used to find out why your script causes the
1587 hit-enter prompt.
1588
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589 *v:servername* *servername-variable*
1590v:servername The resulting registered |x11-clientserver| name if any.
1591 Read-only.
1592
Bram Moolenaar446cb832008-06-24 21:56:24 +00001593
1594v:searchforward *v:searchforward* *searchforward-variable*
1595 Search direction: 1 after a forward search, 0 after a
1596 backward search. It is reset to forward when directly setting
1597 the last search pattern, see |quote/|.
1598 Note that the value is restored when returning from a
1599 function. |function-search-undo|.
1600 Read-write.
1601
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602 *v:shell_error* *shell_error-variable*
1603v:shell_error Result of the last shell command. When non-zero, the last
1604 shell command had an error. When zero, there was no problem.
1605 This only works when the shell returns the error code to Vim.
1606 The value -1 is often used when the command could not be
1607 executed. Read-only.
1608 Example: >
1609 :!mv foo bar
1610 :if v:shell_error
1611 : echo 'could not rename "foo" to "bar"!'
1612 :endif
1613< "shell_error" also works, for backwards compatibility.
1614
1615 *v:statusmsg* *statusmsg-variable*
1616v:statusmsg Last given status message. It's allowed to set this variable.
1617
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001618 *v:swapname* *swapname-variable*
1619v:swapname Only valid when executing |SwapExists| autocommands: Name of
1620 the swap file found. Read-only.
1621
1622 *v:swapchoice* *swapchoice-variable*
1623v:swapchoice |SwapExists| autocommands can set this to the selected choice
1624 for handling an existing swap file:
1625 'o' Open read-only
1626 'e' Edit anyway
1627 'r' Recover
1628 'd' Delete swapfile
1629 'q' Quit
1630 'a' Abort
Bram Moolenaar446cb832008-06-24 21:56:24 +00001631 The value should be a single-character string. An empty value
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001632 results in the user being asked, as would happen when there is
1633 no SwapExists autocommand. The default is empty.
1634
Bram Moolenaarb3480382005-12-11 21:33:32 +00001635 *v:swapcommand* *swapcommand-variable*
Bram Moolenaar4770d092006-01-12 23:22:24 +00001636v:swapcommand Normal mode command to be executed after a file has been
Bram Moolenaarb3480382005-12-11 21:33:32 +00001637 opened. Can be used for a |SwapExists| autocommand to have
Bram Moolenaar446cb832008-06-24 21:56:24 +00001638 another Vim open the file and jump to the right place. For
Bram Moolenaarb3480382005-12-11 21:33:32 +00001639 example, when jumping to a tag the value is ":tag tagname\r".
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00001640 For ":edit +cmd file" the value is ":cmd\r".
Bram Moolenaarb3480382005-12-11 21:33:32 +00001641
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642 *v:termresponse* *termresponse-variable*
1643v:termresponse The escape sequence returned by the terminal for the |t_RV|
Bram Moolenaar446cb832008-06-24 21:56:24 +00001644 termcap entry. It is set when Vim receives an escape sequence
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645 that starts with ESC [ or CSI and ends in a 'c', with only
1646 digits, ';' and '.' in between.
1647 When this option is set, the TermResponse autocommand event is
1648 fired, so that you can react to the response from the
1649 terminal.
1650 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp
1651 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the
1652 patch level (since this was introduced in patch 95, it's
1653 always 95 or bigger). Pc is always zero.
1654 {only when compiled with |+termresponse| feature}
1655
1656 *v:this_session* *this_session-variable*
1657v:this_session Full filename of the last loaded or saved session file. See
1658 |:mksession|. It is allowed to set this variable. When no
1659 session file has been saved, this variable is empty.
1660 "this_session" also works, for backwards compatibility.
1661
1662 *v:throwpoint* *throwpoint-variable*
1663v:throwpoint The point where the exception most recently caught and not
Bram Moolenaar446cb832008-06-24 21:56:24 +00001664 finished was thrown. Not set when commands are typed. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 also |v:exception| and |throw-variables|.
1666 Example: >
1667 :try
1668 : throw "oops"
1669 :catch /.*/
1670 : echo "Exception from" v:throwpoint
1671 :endtry
1672< Output: "Exception from test.vim, line 2"
1673
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001674 *v:val* *val-variable*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001675v:val Value of the current item of a |List| or |Dictionary|. Only
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001676 valid while evaluating the expression used with |map()| and
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001677 |filter()|. Read-only.
1678
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 *v:version* *version-variable*
1680v:version Version number of Vim: Major version number times 100 plus
1681 minor version number. Version 5.0 is 500. Version 5.1 (5.01)
1682 is 501. Read-only. "version" also works, for backwards
1683 compatibility.
1684 Use |has()| to check if a certain patch was included, e.g.: >
Bram Moolenaar6716d9a2014-04-02 12:12:08 +02001685 if has("patch-7.4.123")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686< Note that patch numbers are specific to the version, thus both
1687 version 5.0 and 5.1 may have a patch 123, but these are
1688 completely different.
1689
1690 *v:warningmsg* *warningmsg-variable*
1691v:warningmsg Last given warning message. It's allowed to set this variable.
1692
Bram Moolenaar727c8762010-10-20 19:17:48 +02001693 *v:windowid* *windowid-variable*
1694v:windowid When any X11 based GUI is running or when running in a
1695 terminal and Vim connects to the X server (|-X|) this will be
Bram Moolenaar264e9fd2010-10-27 12:33:17 +02001696 set to the window ID.
1697 When an MS-Windows GUI is running this will be set to the
1698 window handle.
1699 Otherwise the value is zero.
1700 Note: for windows inside Vim use |winnr()|.
Bram Moolenaar727c8762010-10-20 19:17:48 +02001701
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702==============================================================================
17034. Builtin Functions *functions*
1704
1705See |function-list| for a list grouped by what the function is used for.
1706
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001707(Use CTRL-] on the function name to jump to the full explanation.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708
1709USAGE RESULT DESCRIPTION ~
1710
Bram Moolenaar446cb832008-06-24 21:56:24 +00001711abs( {expr}) Float or Number absolute value of {expr}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02001712acos( {expr}) Float arc cosine of {expr}
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001713add( {list}, {item}) List append {item} to |List| {list}
Bram Moolenaard6e256c2011-12-14 15:32:50 +01001714and( {expr}, {expr}) Number bitwise AND
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001715append( {lnum}, {string}) Number append {string} below line {lnum}
Bram Moolenaar7c626922005-02-07 22:01:03 +00001716append( {lnum}, {list}) Number append lines {list} below line {lnum}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717argc() Number number of files in the argument list
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001718argidx() Number current index in the argument list
Bram Moolenaar2d1fe052014-05-28 18:22:57 +02001719arglistid( [{winnr}, [ {tabnr}]])
1720 Number argument list id
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721argv( {nr}) String {nr} entry of the argument list
Bram Moolenaare2f98b92006-03-29 21:18:24 +00001722argv( ) List the argument list
Bram Moolenaardb7c6862010-05-21 16:33:48 +02001723asin( {expr}) Float arc sine of {expr}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001724atan( {expr}) Float arc tangent of {expr}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02001725atan2( {expr}, {expr}) Float arc tangent of {expr1} / {expr2}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726browse( {save}, {title}, {initdir}, {default})
1727 String put up a file requester
Bram Moolenaar446cb832008-06-24 21:56:24 +00001728browsedir( {title}, {initdir}) String put up a directory requester
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729bufexists( {expr}) Number TRUE if buffer {expr} exists
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001730buflisted( {expr}) Number TRUE if buffer {expr} is listed
1731bufloaded( {expr}) Number TRUE if buffer {expr} is loaded
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732bufname( {expr}) String Name of the buffer {expr}
1733bufnr( {expr}) Number Number of the buffer {expr}
1734bufwinnr( {expr}) Number window number of buffer {expr}
1735byte2line( {byte}) Number line number at byte count {byte}
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001736byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr}
Bram Moolenaar0ffbbf92013-11-02 23:29:26 +01001737byteidxcomp( {expr}, {nr}) Number byte index of {nr}'th char in {expr}
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001738call( {func}, {arglist} [, {dict}])
1739 any call {func} with arguments {arglist}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001740ceil( {expr}) Float round {expr} up
1741changenr() Number current change number
Bram Moolenaard35d7842013-01-23 17:17:10 +01001742char2nr( {expr}[, {utf8}]) Number ASCII/UTF8 value of first char in {expr}
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001743cindent( {lnum}) Number C indent for line {lnum}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001744clearmatches() none clear all matches
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745col( {expr}) Number column nr of cursor or mark
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001746complete( {startcol}, {matches}) none set Insert mode completion
Bram Moolenaar572cb562005-08-05 21:35:02 +00001747complete_add( {expr}) Number add completion match
Bram Moolenaar446cb832008-06-24 21:56:24 +00001748complete_check() Number check for key typed during completion
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749confirm( {msg} [, {choices} [, {default} [, {type}]]])
1750 Number number of choice picked by user
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001751copy( {expr}) any make a shallow copy of {expr}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001752cos( {expr}) Float cosine of {expr}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02001753cosh( {expr}) Float hyperbolic cosine of {expr}
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02001754count( {list}, {expr} [, {ic} [, {start}]])
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00001755 Number count how many {expr} are in {list}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756cscope_connection( [{num} , {dbpath} [, {prepend}]])
1757 Number checks existence of cscope connection
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01001758cursor( {lnum}, {col} [, {off}])
1759 Number move cursor to {lnum}, {col}, {off}
Bram Moolenaar0b238792006-03-02 22:49:12 +00001760cursor( {list}) Number move cursor to position in {list}
Bram Moolenaar92dff182014-02-11 19:15:50 +01001761deepcopy( {expr} [, {noref}]) any make a full copy of {expr}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762delete( {fname}) Number delete file {fname}
1763did_filetype() Number TRUE if FileType autocommand event used
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001764diff_filler( {lnum}) Number diff filler lines about {lnum}
1765diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col}
Bram Moolenaar13065c42005-01-08 16:08:21 +00001766empty( {expr}) Number TRUE if {expr} is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767escape( {string}, {chars}) String escape {chars} in {string} with '\'
Bram Moolenaare2cc9702005-03-15 22:43:58 +00001768eval( {string}) any evaluate {string} into its value
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001769eventhandler( ) Number TRUE if inside an event handler
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770executable( {expr}) Number 1 if executable {expr} exists
Bram Moolenaarc7f02552014-04-01 21:00:59 +02001771exepath( {expr}) String full path of the command {expr}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772exists( {expr}) Number TRUE if {expr} exists
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001773extend( {expr1}, {expr2} [, {expr3}])
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001774 List/Dict insert items of {expr2} into {expr1}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02001775exp( {expr}) Float exponential of {expr}
Bram Moolenaar146e9c32012-03-07 19:18:23 +01001776expand( {expr} [, {nosuf} [, {list}]])
1777 any expand special keywords in {expr}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001778feedkeys( {string} [, {mode}]) Number add key sequence to typeahead buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779filereadable( {file}) Number TRUE if {file} is a readable file
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001780filewritable( {file}) Number TRUE if {file} is a writable file
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001781filter( {expr}, {string}) List/Dict remove items from {expr} where
1782 {string} is 0
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00001783finddir( {name}[, {path}[, {count}]])
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001784 String find directory {name} in {path}
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00001785findfile( {name}[, {path}[, {count}]])
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001786 String find file {name} in {path}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001787float2nr( {expr}) Number convert Float {expr} to a Number
1788floor( {expr}) Float round {expr} down
Bram Moolenaardb7c6862010-05-21 16:33:48 +02001789fmod( {expr1}, {expr2}) Float remainder of {expr1} / {expr2}
Bram Moolenaaraebaf892008-05-28 14:49:58 +00001790fnameescape( {fname}) String escape special characters in {fname}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791fnamemodify( {fname}, {mods}) String modify file name
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001792foldclosed( {lnum}) Number first line of fold at {lnum} if closed
1793foldclosedend( {lnum}) Number last line of fold at {lnum} if closed
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794foldlevel( {lnum}) Number fold level at {lnum}
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001795foldtext( ) String line displayed for closed fold
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001796foldtextresult( {lnum}) String text for closed fold at {lnum}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797foreground( ) Number bring the Vim window to the foreground
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001798function( {name}) Funcref reference to function {name}
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001799garbagecollect( [{atexit}]) none free memory, breaking cyclic references
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001800get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def}
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001801get( {dict}, {key} [, {def}]) any get item {key} from {dict} or {def}
Bram Moolenaar45360022005-07-21 21:08:21 +00001802getbufline( {expr}, {lnum} [, {end}])
1803 List lines {lnum} to {end} of buffer {expr}
Bram Moolenaar63dbda12013-02-20 21:12:10 +01001804getbufvar( {expr}, {varname} [, {def}])
1805 any variable {varname} in buffer {expr}
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001806getchar( [expr]) Number get one character from the user
1807getcharmod( ) Number modifiers for the last typed character
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808getcmdline() String return the current command-line
1809getcmdpos() Number return cursor position in command-line
Bram Moolenaarfb539272014-08-22 19:21:47 +02001810getcmdtype() String return current command-line type
1811getcmdwintype() String return current command-line window type
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02001812getcurpos() List position of the cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813getcwd() String the current working directory
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02001814getfontname( [{name}]) String name of font being used
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00001815getfperm( {fname}) String file permissions of file {fname}
1816getfsize( {fname}) Number size in bytes of file {fname}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817getftime( {fname}) Number last modification time of file
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00001818getftype( {fname}) String description of type of file {fname}
Bram Moolenaar7c626922005-02-07 22:01:03 +00001819getline( {lnum}) String line {lnum} of current buffer
1820getline( {lnum}, {end}) List lines {lnum} to {end} of current buffer
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001821getloclist( {nr}) List list of location list items
Bram Moolenaar6ee10162007-07-26 20:58:42 +00001822getmatches() List list of current matches
Bram Moolenaar18081e32008-02-20 19:11:07 +00001823getpid() Number process ID of Vim
Bram Moolenaar0b238792006-03-02 22:49:12 +00001824getpos( {expr}) List position of cursor, mark, etc.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00001825getqflist() List list of quickfix items
Bram Moolenaarb7cb42b2014-04-02 19:55:10 +02001826getreg( [{regname} [, 1 [, {list}]]])
1827 String or List contents of register
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001828getregtype( [{regname}]) String type of register
Bram Moolenaar63dbda12013-02-20 21:12:10 +01001829gettabvar( {nr}, {varname} [, {def}])
1830 any variable {varname} in tab {nr} or {def}
1831gettabwinvar( {tabnr}, {winnr}, {name} [, {def}])
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00001832 any {name} in {winnr} in tab page {tabnr}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833getwinposx() Number X coord in pixels of GUI Vim window
1834getwinposy() Number Y coord in pixels of GUI Vim window
Bram Moolenaar63dbda12013-02-20 21:12:10 +01001835getwinvar( {nr}, {varname} [, {def}])
1836 any variable {varname} in window {nr}
Bram Moolenaard8b77f72015-03-05 21:21:19 +01001837glob( {expr} [, {nosuf} [, {list} [, {alllinks}]]])
Bram Moolenaar146e9c32012-03-07 19:18:23 +01001838 any expand file wildcards in {expr}
Bram Moolenaard8b77f72015-03-05 21:21:19 +01001839globpath( {path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00001840 String do glob({expr}) for all dirs in {path}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841has( {feature}) Number TRUE if feature {feature} supported
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001842has_key( {dict}, {key}) Number TRUE if {dict} has entry {key}
Bram Moolenaard267b9c2007-04-26 15:06:45 +00001843haslocaldir() Number TRUE if current window executed |:lcd|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001844hasmapto( {what} [, {mode} [, {abbr}]])
1845 Number TRUE if mapping to {what} exists
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846histadd( {history},{item}) String add an item to a history
1847histdel( {history} [, {item}]) String remove an item from a history
1848histget( {history} [, {index}]) String get the item {index} from a history
1849histnr( {history}) Number highest index of a history
1850hlexists( {name}) Number TRUE if highlight group {name} exists
1851hlID( {name}) Number syntax ID of highlight group {name}
1852hostname() String name of the machine Vim is running on
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001853iconv( {expr}, {from}, {to}) String convert encoding of {expr}
1854indent( {lnum}) Number indent of line {lnum}
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00001855index( {list}, {expr} [, {start} [, {ic}]])
1856 Number index in {list} where {expr} appears
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001857input( {prompt} [, {text} [, {completion}]])
1858 String get input from the user
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001860inputlist( {textlist}) Number let the user pick from a choice list
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001861inputrestore() Number restore typeahead
1862inputsave() Number save and clear typeahead
Bram Moolenaar071d4272004-06-13 20:20:40 +00001863inputsecret( {prompt} [, {text}]) String like input() but hiding the text
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001864insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}]
Bram Moolenaard6e256c2011-12-14 15:32:50 +01001865invert( {expr}) Number bitwise invert
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866isdirectory( {directory}) Number TRUE if {directory} is a directory
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00001867islocked( {expr}) Number TRUE if {expr} is locked
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001868items( {dict}) List key-value pairs in {dict}
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00001869join( {list} [, {sep}]) String join {list} items into one String
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001870keys( {dict}) List keys in {dict}
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001871len( {expr}) Number the length of {expr}
1872libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001873libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number
1874line( {expr}) Number line nr of cursor, last line or mark
1875line2byte( {lnum}) Number byte count of line {lnum}
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001876lispindent( {lnum}) Number Lisp indent for line {lnum}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001877localtime() Number current time
Bram Moolenaardb7c6862010-05-21 16:33:48 +02001878log( {expr}) Float natural logarithm (base e) of {expr}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001879log10( {expr}) Float logarithm of Float {expr} to base 10
Bram Moolenaard38b0552012-04-25 19:07:41 +02001880luaeval( {expr}[, {expr}]) any evaluate |Lua| expression
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001881map( {expr}, {string}) List/Dict change each item in {expr} to {expr}
Bram Moolenaarbd743252010-10-20 21:23:33 +02001882maparg( {name}[, {mode} [, {abbr} [, {dict}]]])
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001883 String or Dict
1884 rhs of mapping {name} in mode {mode}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001885mapcheck( {name}[, {mode} [, {abbr}]])
1886 String check for mappings matching {name}
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00001887match( {expr}, {pat}[, {start}[, {count}]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888 Number position where {pat} matches in {expr}
Bram Moolenaar6ee10162007-07-26 20:58:42 +00001889matchadd( {group}, {pattern}[, {priority}[, {id}]])
1890 Number highlight {pattern} with {group}
Bram Moolenaarb3414592014-06-17 17:48:32 +02001891matchaddpos( {group}, {list}[, {priority}[, {id}]])
1892 Number highlight positions with {group}
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001893matcharg( {nr}) List arguments of |:match|
Bram Moolenaar6ee10162007-07-26 20:58:42 +00001894matchdelete( {id}) Number delete match identified by {id}
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00001895matchend( {expr}, {pat}[, {start}[, {count}]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 Number position where {pat} ends in {expr}
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00001897matchlist( {expr}, {pat}[, {start}[, {count}]])
1898 List match and submatches of {pat} in {expr}
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00001899matchstr( {expr}, {pat}[, {start}[, {count}]])
1900 String {count}'th match of {pat} in {expr}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001901max( {list}) Number maximum value of items in {list}
1902min( {list}) Number minimum value of items in {list}
1903mkdir( {name} [, {path} [, {prot}]])
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001904 Number create directory {name}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001905mode( [expr]) String current editing mode
Bram Moolenaar7e506b62010-01-19 15:55:06 +01001906mzeval( {expr}) any evaluate |MzScheme| expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum}
Bram Moolenaard35d7842013-01-23 17:17:10 +01001908nr2char( {expr}[, {utf8}]) String single char with ASCII/UTF8 value {expr}
Bram Moolenaard6e256c2011-12-14 15:32:50 +01001909or( {expr}, {expr}) Number bitwise OR
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001910pathshorten( {expr}) String shorten directory names in a path
Bram Moolenaar446cb832008-06-24 21:56:24 +00001911pow( {x}, {y}) Float {x} to the power of {y}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001913printf( {fmt}, {expr1}...) String format text
1914pumvisible() Number whether popup menu is visible
Bram Moolenaar30b65812012-07-12 22:01:11 +02001915pyeval( {expr}) any evaluate |Python| expression
1916py3eval( {expr}) any evaluate |python3| expression
Bram Moolenaard8b02732005-01-14 21:48:43 +00001917range( {expr} [, {max} [, {stride}]])
1918 List items from {expr} to {max}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001919readfile( {fname} [, {binary} [, {max}]])
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001920 List get list of lines from file {fname}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001921reltime( [{start} [, {end}]]) List get time value
1922reltimestr( {time}) String turn time value into a String
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923remote_expr( {server}, {string} [, {idvar}])
1924 String send expression
1925remote_foreground( {server}) Number bring Vim server to the foreground
1926remote_peek( {serverid} [, {retvar}])
1927 Number check for reply string
1928remote_read( {serverid}) String read reply string
1929remote_send( {server}, {string} [, {idvar}])
1930 String send key sequence
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001931remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list}
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001932remove( {dict}, {key}) any remove entry {key} from {dict}
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001933rename( {from}, {to}) Number rename (move) file from {from} to {to}
1934repeat( {expr}, {count}) String repeat {expr} {count} times
1935resolve( {filename}) String get filename a shortcut points to
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001936reverse( {list}) List reverse {list} in-place
Bram Moolenaar446cb832008-06-24 21:56:24 +00001937round( {expr}) Float round off {expr}
Bram Moolenaar9a773482013-06-11 18:40:13 +02001938screenattr( {row}, {col}) Number attribute at screen position
1939screenchar( {row}, {col}) Number character at screen position
Bram Moolenaar9750bb12012-12-05 16:10:42 +01001940screencol() Number current cursor column
1941screenrow() Number current cursor row
Bram Moolenaar76929292008-01-06 19:07:36 +00001942search( {pattern} [, {flags} [, {stopline} [, {timeout}]]])
1943 Number search for {pattern}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001944searchdecl( {name} [, {global} [, {thisblock}]])
Bram Moolenaar446cb832008-06-24 21:56:24 +00001945 Number search for variable declaration
Bram Moolenaar76929292008-01-06 19:07:36 +00001946searchpair( {start}, {middle}, {end} [, {flags} [, {skip} [...]]])
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001947 Number search for other end of start/end pair
Bram Moolenaar76929292008-01-06 19:07:36 +00001948searchpairpos( {start}, {middle}, {end} [, {flags} [, {skip} [...]]])
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001949 List search for other end of start/end pair
Bram Moolenaar76929292008-01-06 19:07:36 +00001950searchpos( {pattern} [, {flags} [, {stopline} [, {timeout}]]])
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001951 List search for {pattern}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952server2client( {clientid}, {string})
1953 Number send reply string
1954serverlist() String get a list of available servers
1955setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val}
1956setcmdpos( {pos}) Number set cursor position in command-line
1957setline( {lnum}, {line}) Number set line {lnum} to {line}
Bram Moolenaar17c7c012006-01-26 22:25:15 +00001958setloclist( {nr}, {list}[, {action}])
1959 Number modify location list using {list}
Bram Moolenaar6ee10162007-07-26 20:58:42 +00001960setmatches( {list}) Number restore a list of matches
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001961setpos( {expr}, {list}) Number set the {expr} position to {list}
Bram Moolenaar17c7c012006-01-26 22:25:15 +00001962setqflist( {list}[, {action}]) Number modify quickfix list using {list}
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001963setreg( {n}, {v}[, {opt}]) Number set register to value and type
Bram Moolenaar06b5d512010-05-22 15:37:44 +02001964settabvar( {nr}, {varname}, {val}) set {varname} in tab page {nr} to {val}
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00001965settabwinvar( {tabnr}, {winnr}, {varname}, {val}) set {varname} in window
1966 {winnr} in tab page {tabnr} to {val}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val}
Bram Moolenaaraf9aeb92013-02-13 17:35:04 +01001968sha256( {string}) String SHA256 checksum of {string}
Bram Moolenaar05bb9532008-07-04 09:44:11 +00001969shellescape( {string} [, {special}])
1970 String escape {string} for use as shell
Bram Moolenaar60a495f2006-10-03 12:44:42 +00001971 command argument
Bram Moolenaar2d17fa32012-10-21 00:45:18 +02001972shiftwidth() Number effective value of 'shiftwidth'
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001973simplify( {filename}) String simplify filename as much as possible
Bram Moolenaar446cb832008-06-24 21:56:24 +00001974sin( {expr}) Float sine of {expr}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02001975sinh( {expr}) Float hyperbolic sine of {expr}
Bram Moolenaar5f894962011-06-19 02:55:37 +02001976sort( {list} [, {func} [, {dict}]])
1977 List sort {list}, using {func} to compare
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001978soundfold( {word}) String sound-fold {word}
Bram Moolenaard857f0e2005-06-21 22:37:39 +00001979spellbadword() String badly spelled word at cursor
Bram Moolenaarc54b8a72005-09-30 21:20:29 +00001980spellsuggest( {word} [, {max} [, {capital}]])
1981 List spelling suggestions
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001982split( {expr} [, {pat} [, {keepempty}]])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001983 List make |List| from {pat} separated {expr}
Bram Moolenaard58e9292011-02-09 17:07:58 +01001984sqrt( {expr}) Float square root of {expr}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001985str2float( {expr}) Float convert String to Float
1986str2nr( {expr} [, {base}]) Number convert String to Number
Bram Moolenaar72597a52010-07-18 15:31:08 +02001987strchars( {expr}) Number character length of the String {expr}
Bram Moolenaardc536092010-07-18 15:45:49 +02001988strdisplaywidth( {expr} [, {col}]) Number display length of the String {expr}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001989strftime( {format}[, {time}]) String time in specified format
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001990stridx( {haystack}, {needle}[, {start}])
1991 Number index of {needle} in {haystack}
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00001992string( {expr}) String String representation of {expr} value
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993strlen( {expr}) Number length of the String {expr}
1994strpart( {src}, {start}[, {len}])
1995 String {len} characters of {src} at {start}
Bram Moolenaar677ee682005-01-27 14:41:15 +00001996strridx( {haystack}, {needle} [, {start}])
1997 Number last index of {needle} in {haystack}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001998strtrans( {expr}) String translate string to make it printable
Bram Moolenaar72597a52010-07-18 15:31:08 +02001999strwidth( {expr}) Number display cell length of the String {expr}
Bram Moolenaar41571762014-04-02 19:00:58 +02002000submatch( {nr}[, {list}]) String or List
2001 specific match in ":s" or substitute()
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002substitute( {expr}, {pat}, {sub}, {flags})
2003 String all {pat} in {expr} replaced with {sub}
Bram Moolenaar47136d72004-10-12 20:02:24 +00002004synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005synIDattr( {synID}, {what} [, {mode}])
2006 String attribute {what} of syntax ID {synID}
2007synIDtrans( {synID}) Number translated syntax ID of {synID}
Bram Moolenaar483c5d82010-10-20 18:45:33 +02002008synconcealed( {lnum}, {col}) List info about concealing
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002009synstack( {lnum}, {col}) List stack of syntax IDs at {lnum} and {col}
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002010system( {expr} [, {input}]) String output of shell command/filter {expr}
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02002011systemlist( {expr} [, {input}]) List output of shell command/filter {expr}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00002012tabpagebuflist( [{arg}]) List list of buffer numbers in tab page
2013tabpagenr( [{arg}]) Number number of current or last tab page
2014tabpagewinnr( {tabarg}[, {arg}])
2015 Number number of current window in tab page
2016taglist( {expr}) List list of tags matching {expr}
Bram Moolenaar446cb832008-06-24 21:56:24 +00002017tagfiles() List tags files used
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018tempname() String name for a temporary file
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002019tan( {expr}) Float tangent of {expr}
2020tanh( {expr}) Float hyperbolic tangent of {expr}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021tolower( {expr}) String the String {expr} switched to lowercase
2022toupper( {expr}) String the String {expr} switched to uppercase
Bram Moolenaar8299df92004-07-10 09:47:34 +00002023tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr}
2024 to chars in {tostr}
Bram Moolenaard58e9292011-02-09 17:07:58 +01002025trunc( {expr}) Float truncate Float {expr}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026type( {name}) Number type of variable {name}
Bram Moolenaara17d4c12010-05-30 18:30:36 +02002027undofile( {name}) String undo file name for {name}
Bram Moolenaara800b422010-06-27 01:15:55 +02002028undotree() List undo file tree
Bram Moolenaar327aa022014-03-25 18:24:23 +01002029uniq( {list} [, {func} [, {dict}]])
2030 List remove adjacent duplicates from a list
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002031values( {dict}) List values in {dict}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002032virtcol( {expr}) Number screen column of cursor or mark
2033visualmode( [expr]) String last visual mode used
Bram Moolenaar8738fc12013-02-20 17:59:11 +01002034wildmenumode() Number whether 'wildmenu' mode is active
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035winbufnr( {nr}) Number buffer number of window {nr}
2036wincol() Number window column of the cursor
2037winheight( {nr}) Number height of window {nr}
2038winline() Number window line of the cursor
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00002039winnr( [{expr}]) Number number of current window
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002040winrestcmd() String returns command to restore window sizes
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002041winrestview( {dict}) none restore view of current window
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00002042winsaveview() Dict save view of current window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043winwidth( {nr}) Number width of window {nr}
Bram Moolenaar6b2e9382014-11-05 18:06:01 +01002044writefile( {list}, {fname} [, {flags}])
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002045 Number write list of lines to file {fname}
Bram Moolenaard6e256c2011-12-14 15:32:50 +01002046xor( {expr}, {expr}) Number bitwise XOR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047
Bram Moolenaar446cb832008-06-24 21:56:24 +00002048abs({expr}) *abs()*
2049 Return the absolute value of {expr}. When {expr} evaluates to
2050 a |Float| abs() returns a |Float|. When {expr} can be
2051 converted to a |Number| abs() returns a |Number|. Otherwise
2052 abs() gives an error message and returns -1.
2053 Examples: >
2054 echo abs(1.456)
2055< 1.456 >
2056 echo abs(-5.456)
2057< 5.456 >
2058 echo abs(-4)
2059< 4
2060 {only available when compiled with the |+float| feature}
2061
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002062
2063acos({expr}) *acos()*
2064 Return the arc cosine of {expr} measured in radians, as a
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02002065 |Float| in the range of [0, pi].
2066 {expr} must evaluate to a |Float| or a |Number| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002067 [-1, 1].
2068 Examples: >
2069 :echo acos(0)
2070< 1.570796 >
2071 :echo acos(-0.5)
2072< 2.094395
Bram Moolenaardb84e452010-08-15 13:50:43 +02002073 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002074
2075
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002076add({list}, {expr}) *add()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002077 Append the item {expr} to |List| {list}. Returns the
2078 resulting |List|. Examples: >
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002079 :let alist = add([1, 2, 3], item)
2080 :call add(mylist, "woodstock")
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002081< Note that when {expr} is a |List| it is appended as a single
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002082 item. Use |extend()| to concatenate |Lists|.
Bram Moolenaar13065c42005-01-08 16:08:21 +00002083 Use |insert()| to add an item at another position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002084
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002085
Bram Moolenaard6e256c2011-12-14 15:32:50 +01002086and({expr}, {expr}) *and()*
2087 Bitwise AND on the two arguments. The arguments are converted
2088 to a number. A List, Dict or Float argument causes an error.
2089 Example: >
2090 :let flag = and(bits, 0x80)
2091
2092
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002093append({lnum}, {expr}) *append()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002094 When {expr} is a |List|: Append each item of the |List| as a
2095 text line below line {lnum} in the current buffer.
Bram Moolenaar748bf032005-02-02 23:04:36 +00002096 Otherwise append {expr} as one text line below line {lnum} in
2097 the current buffer.
2098 {lnum} can be zero to insert a line before the first one.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002099 Returns 1 for failure ({lnum} out of range or out of memory),
Bram Moolenaar446cb832008-06-24 21:56:24 +00002100 0 for success. Example: >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002101 :let failed = append(line('$'), "# THE END")
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002102 :let failed = append(0, ["Chapter 1", "the beginning"])
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002103<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 *argc()*
2105argc() The result is the number of files in the argument list of the
2106 current window. See |arglist|.
2107
2108 *argidx()*
2109argidx() The result is the current index in the argument list. 0 is
2110 the first file. argc() - 1 is the last one. See |arglist|.
2111
Bram Moolenaar2d1fe052014-05-28 18:22:57 +02002112 *arglistid()*
2113arglistid([{winnr}, [ {tabnr} ]])
2114 Return the argument list ID. This is a number which
2115 identifies the argument list being used. Zero is used for the
Bram Moolenaarfb539272014-08-22 19:21:47 +02002116 global argument list. See |arglist|.
2117 Return -1 if the arguments are invalid.
Bram Moolenaar2d1fe052014-05-28 18:22:57 +02002118
2119 Without arguments use the current window.
2120 With {winnr} only use this window in the current tab page.
2121 With {winnr} and {tabnr} use the window in the specified tab
2122 page.
2123
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124 *argv()*
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002125argv([{nr}]) The result is the {nr}th file in the argument list of the
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 current window. See |arglist|. "argv(0)" is the first one.
2127 Example: >
2128 :let i = 0
2129 :while i < argc()
Bram Moolenaar446cb832008-06-24 21:56:24 +00002130 : let f = escape(fnameescape(argv(i)), '.')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>'
2132 : let i = i + 1
2133 :endwhile
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002134< Without the {nr} argument a |List| with the whole |arglist| is
2135 returned.
2136
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002137asin({expr}) *asin()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02002138 Return the arc sine of {expr} measured in radians, as a |Float|
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002139 in the range of [-pi/2, pi/2].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02002140 {expr} must evaluate to a |Float| or a |Number| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002141 [-1, 1].
2142 Examples: >
2143 :echo asin(0.8)
2144< 0.927295 >
2145 :echo asin(-0.5)
2146< -0.523599
Bram Moolenaardb84e452010-08-15 13:50:43 +02002147 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002148
2149
Bram Moolenaar446cb832008-06-24 21:56:24 +00002150atan({expr}) *atan()*
2151 Return the principal value of the arc tangent of {expr}, in
2152 the range [-pi/2, +pi/2] radians, as a |Float|.
2153 {expr} must evaluate to a |Float| or a |Number|.
2154 Examples: >
2155 :echo atan(100)
2156< 1.560797 >
2157 :echo atan(-4.01)
2158< -1.326405
2159 {only available when compiled with the |+float| feature}
2160
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002161
2162atan2({expr1}, {expr2}) *atan2()*
2163 Return the arc tangent of {expr1} / {expr2}, measured in
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02002164 radians, as a |Float| in the range [-pi, pi].
2165 {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002166 Examples: >
2167 :echo atan2(-1, 1)
2168< -0.785398 >
2169 :echo atan2(1, -1)
2170< 2.356194
Bram Moolenaardb84e452010-08-15 13:50:43 +02002171 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002172
2173
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174 *browse()*
2175browse({save}, {title}, {initdir}, {default})
2176 Put up a file requester. This only works when "has("browse")"
2177 returns non-zero (only in some GUI versions).
2178 The input fields are:
2179 {save} when non-zero, select file to write
2180 {title} title for the requester
2181 {initdir} directory to start browsing in
2182 {default} default file name
2183 When the "Cancel" button is hit, something went wrong, or
2184 browsing is not possible, an empty string is returned.
2185
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002186 *browsedir()*
2187browsedir({title}, {initdir})
2188 Put up a directory requester. This only works when
2189 "has("browse")" returns non-zero (only in some GUI versions).
2190 On systems where a directory browser is not supported a file
2191 browser is used. In that case: select a file in the directory
2192 to be used.
2193 The input fields are:
2194 {title} title for the requester
2195 {initdir} directory to start browsing in
2196 When the "Cancel" button is hit, something went wrong, or
2197 browsing is not possible, an empty string is returned.
2198
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199bufexists({expr}) *bufexists()*
2200 The result is a Number, which is non-zero if a buffer called
2201 {expr} exists.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002202 If the {expr} argument is a number, buffer numbers are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203 If the {expr} argument is a string it must match a buffer name
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002204 exactly. The name can be:
2205 - Relative to the current directory.
2206 - A full path.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002207 - The name of a buffer with 'buftype' set to "nofile".
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002208 - A URL name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 Unlisted buffers will be found.
2210 Note that help files are listed by their short name in the
2211 output of |:buffers|, but bufexists() requires using their
2212 long name to be able to find them.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002213 bufexists() may report a buffer exists, but to use the name
2214 with a |:buffer| command you may need to use |expand()|. Esp
2215 for MS-Windows 8.3 names in the form "c:\DOCUME~1"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002216 Use "bufexists(0)" to test for the existence of an alternate
2217 file name.
2218 *buffer_exists()*
2219 Obsolete name: buffer_exists().
2220
2221buflisted({expr}) *buflisted()*
2222 The result is a Number, which is non-zero if a buffer called
2223 {expr} exists and is listed (has the 'buflisted' option set).
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002224 The {expr} argument is used like with |bufexists()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225
2226bufloaded({expr}) *bufloaded()*
2227 The result is a Number, which is non-zero if a buffer called
2228 {expr} exists and is loaded (shown in a window or hidden).
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00002229 The {expr} argument is used like with |bufexists()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230
2231bufname({expr}) *bufname()*
2232 The result is the name of a buffer, as it is displayed by the
2233 ":ls" command.
2234 If {expr} is a Number, that buffer number's name is given.
2235 Number zero is the alternate buffer for the current window.
2236 If {expr} is a String, it is used as a |file-pattern| to match
Bram Moolenaar446cb832008-06-24 21:56:24 +00002237 with the buffer names. This is always done like 'magic' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00002238 set and 'cpoptions' is empty. When there is more than one
2239 match an empty string is returned.
2240 "" or "%" can be used for the current buffer, "#" for the
2241 alternate buffer.
2242 A full match is preferred, otherwise a match at the start, end
Bram Moolenaaref2f6562007-05-06 13:32:59 +00002243 or middle of the buffer name is accepted. If you only want a
2244 full match then put "^" at the start and "$" at the end of the
2245 pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 Listed buffers are found first. If there is a single match
2247 with a listed buffer, that one is returned. Next unlisted
2248 buffers are searched for.
2249 If the {expr} is a String, but you want to use it as a buffer
2250 number, force it to be a Number by adding zero to it: >
2251 :echo bufname("3" + 0)
2252< If the buffer doesn't exist, or doesn't have a name, an empty
2253 string is returned. >
2254 bufname("#") alternate buffer name
2255 bufname(3) name of buffer 3
2256 bufname("%") name of current buffer
2257 bufname("file2") name of buffer where "file2" matches.
2258< *buffer_name()*
2259 Obsolete name: buffer_name().
2260
2261 *bufnr()*
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002262bufnr({expr} [, {create}])
2263 The result is the number of a buffer, as it is displayed by
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 the ":ls" command. For the use of {expr}, see |bufname()|
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002265 above.
2266 If the buffer doesn't exist, -1 is returned. Or, if the
2267 {create} argument is present and not zero, a new, unlisted,
2268 buffer is created and its number is returned.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002269 bufnr("$") is the last buffer: >
2270 :let last_buffer = bufnr("$")
2271< The result is a Number, which is the highest buffer number
2272 of existing buffers. Note that not all buffers with a smaller
2273 number necessarily exist, because ":bwipeout" may have removed
2274 them. Use bufexists() to test for the existence of a buffer.
2275 *buffer_number()*
2276 Obsolete name: buffer_number().
2277 *last_buffer_nr()*
2278 Obsolete name for bufnr("$"): last_buffer_nr().
2279
2280bufwinnr({expr}) *bufwinnr()*
2281 The result is a Number, which is the number of the first
2282 window associated with buffer {expr}. For the use of {expr},
Bram Moolenaar446cb832008-06-24 21:56:24 +00002283 see |bufname()| above. If buffer {expr} doesn't exist or
Bram Moolenaar071d4272004-06-13 20:20:40 +00002284 there is no such window, -1 is returned. Example: >
2285
2286 echo "A window containing buffer 1 is " . (bufwinnr(1))
2287
2288< The number can be used with |CTRL-W_w| and ":wincmd w"
2289 |:wincmd|.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00002290 Only deals with the current tab page.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291
2292
2293byte2line({byte}) *byte2line()*
2294 Return the line number that contains the character at byte
2295 count {byte} in the current buffer. This includes the
2296 end-of-line character, depending on the 'fileformat' option
2297 for the current buffer. The first character has byte count
2298 one.
2299 Also see |line2byte()|, |go| and |:goto|.
2300 {not available when compiled without the |+byte_offset|
2301 feature}
2302
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00002303byteidx({expr}, {nr}) *byteidx()*
2304 Return byte index of the {nr}'th character in the string
2305 {expr}. Use zero for the first character, it returns zero.
2306 This function is only useful when there are multibyte
2307 characters, otherwise the returned value is equal to {nr}.
Bram Moolenaar0ffbbf92013-11-02 23:29:26 +01002308 Composing characters are not counted separately, their byte
2309 length is added to the preceding base character. See
2310 |byteidxcomp()| below for counting composing characters
2311 separately.
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00002312 Example : >
2313 echo matchstr(str, ".", byteidx(str, 3))
2314< will display the fourth character. Another way to do the
2315 same: >
2316 let s = strpart(str, byteidx(str, 3))
2317 echo strpart(s, 0, byteidx(s, 1))
2318< If there are less than {nr} characters -1 is returned.
2319 If there are exactly {nr} characters the length of the string
Bram Moolenaar0ffbbf92013-11-02 23:29:26 +01002320 in bytes is returned.
2321
2322byteidxcomp({expr}, {nr}) *byteidxcomp()*
2323 Like byteidx(), except that a composing character is counted
2324 as a separate character. Example: >
2325 let s = 'e' . nr2char(0x301)
2326 echo byteidx(s, 1)
2327 echo byteidxcomp(s, 1)
2328 echo byteidxcomp(s, 2)
2329< The first and third echo result in 3 ('e' plus composing
2330 character is 3 bytes), the second echo results in 1 ('e' is
2331 one byte).
2332 Only works different from byteidx() when 'encoding' is set to
2333 a Unicode encoding.
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00002334
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002335call({func}, {arglist} [, {dict}]) *call()* *E699*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002336 Call function {func} with the items in |List| {arglist} as
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002337 arguments.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002338 {func} can either be a |Funcref| or the name of a function.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002339 a:firstline and a:lastline are set to the cursor line.
2340 Returns the return value of the called function.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002341 {dict} is for functions with the "dict" attribute. It will be
2342 used to set the local variable "self". |Dictionary-function|
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002343
Bram Moolenaar446cb832008-06-24 21:56:24 +00002344ceil({expr}) *ceil()*
2345 Return the smallest integral value greater than or equal to
2346 {expr} as a |Float| (round up).
2347 {expr} must evaluate to a |Float| or a |Number|.
2348 Examples: >
2349 echo ceil(1.456)
2350< 2.0 >
2351 echo ceil(-5.456)
2352< -5.0 >
2353 echo ceil(4.0)
2354< 4.0
2355 {only available when compiled with the |+float| feature}
2356
Bram Moolenaarca003e12006-03-17 23:19:38 +00002357changenr() *changenr()*
2358 Return the number of the most recent change. This is the same
2359 number as what is displayed with |:undolist| and can be used
2360 with the |:undo| command.
2361 When a change was made it is the number of that change. After
2362 redo it is the number of the redone change. After undo it is
2363 one less than the number of the undone change.
2364
Bram Moolenaard35d7842013-01-23 17:17:10 +01002365char2nr({expr}[, {utf8}]) *char2nr()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366 Return number value of the first char in {expr}. Examples: >
2367 char2nr(" ") returns 32
2368 char2nr("ABC") returns 65
Bram Moolenaard35d7842013-01-23 17:17:10 +01002369< When {utf8} is omitted or zero, the current 'encoding' is used.
2370 Example for "utf-8": >
Bram Moolenaaref2f6562007-05-06 13:32:59 +00002371 char2nr("á") returns 225
2372 char2nr("á"[0]) returns 195
Bram Moolenaard35d7842013-01-23 17:17:10 +01002373< With {utf8} set to 1, always treat as utf-8 characters.
2374 A combining character is a separate character.
Bram Moolenaar97293012011-07-18 19:40:27 +02002375 |nr2char()| does the opposite.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376
2377cindent({lnum}) *cindent()*
2378 Get the amount of indent for line {lnum} according the C
2379 indenting rules, as with 'cindent'.
2380 The indent is counted in spaces, the value of 'tabstop' is
2381 relevant. {lnum} is used just like in |getline()|.
2382 When {lnum} is invalid or Vim was not compiled the |+cindent|
2383 feature, -1 is returned.
Bram Moolenaard5cdbeb2005-10-10 20:59:28 +00002384 See |C-indenting|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002386clearmatches() *clearmatches()*
2387 Clears all matches previously defined by |matchadd()| and the
2388 |:match| commands.
2389
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 *col()*
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002391col({expr}) The result is a Number, which is the byte index of the column
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 position given with {expr}. The accepted positions are:
2393 . the cursor position
2394 $ the end of the cursor line (the result is the
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02002395 number of bytes in the cursor line plus one)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396 'x position of mark x (if the mark is not set, 0 is
2397 returned)
Bram Moolenaare3faf442014-12-14 01:27:49 +01002398 v In Visual mode: the start of the Visual area (the
2399 cursor is the end). When not in Visual mode
2400 returns the cursor position. Differs from |'<| in
2401 that it's updated right away.
Bram Moolenaar477933c2007-07-17 14:32:23 +00002402 Additionally {expr} can be [lnum, col]: a |List| with the line
2403 and column number. Most useful when the column is "$", to get
Bram Moolenaar446cb832008-06-24 21:56:24 +00002404 the last column of a specific line. When "lnum" or "col" is
Bram Moolenaar477933c2007-07-17 14:32:23 +00002405 out of range then col() returns zero.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00002406 To get the line number use |line()|. To get both use
Bram Moolenaar0b238792006-03-02 22:49:12 +00002407 |getpos()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002408 For the screen column position use |virtcol()|.
2409 Note that only marks in the current file can be used.
2410 Examples: >
2411 col(".") column of cursor
2412 col("$") length of cursor line plus one
2413 col("'t") column of mark t
2414 col("'" . markname) column of mark markname
Bram Moolenaar446cb832008-06-24 21:56:24 +00002415< The first column is 1. 0 is returned for an error.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00002416 For an uppercase mark the column may actually be in another
2417 buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002418 For the cursor position, when 'virtualedit' is active, the
2419 column is one higher if the cursor is after the end of the
2420 line. This can be used to obtain the column in Insert mode: >
2421 :imap <F2> <C-O>:let save_ve = &ve<CR>
2422 \<C-O>:set ve=all<CR>
2423 \<C-O>:echo col(".") . "\n" <Bar>
2424 \let &ve = save_ve<CR>
2425<
Bram Moolenaar572cb562005-08-05 21:35:02 +00002426
Bram Moolenaara94bc432006-03-10 21:42:59 +00002427complete({startcol}, {matches}) *complete()* *E785*
2428 Set the matches for Insert mode completion.
2429 Can only be used in Insert mode. You need to use a mapping
Bram Moolenaaref2f6562007-05-06 13:32:59 +00002430 with CTRL-R = |i_CTRL-R|. It does not work after CTRL-O or
2431 with an expression mapping.
Bram Moolenaara94bc432006-03-10 21:42:59 +00002432 {startcol} is the byte offset in the line where the completed
2433 text start. The text up to the cursor is the original text
2434 that will be replaced by the matches. Use col('.') for an
2435 empty string. "col('.') - 1" will replace one character by a
2436 match.
2437 {matches} must be a |List|. Each |List| item is one match.
2438 See |complete-items| for the kind of items that are possible.
2439 Note that the after calling this function you need to avoid
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002440 inserting anything that would cause completion to stop.
Bram Moolenaara94bc432006-03-10 21:42:59 +00002441 The match can be selected with CTRL-N and CTRL-P as usual with
2442 Insert mode completion. The popup menu will appear if
2443 specified, see |ins-completion-menu|.
2444 Example: >
Bram Moolenaaref2f6562007-05-06 13:32:59 +00002445 inoremap <F5> <C-R>=ListMonths()<CR>
Bram Moolenaara94bc432006-03-10 21:42:59 +00002446
2447 func! ListMonths()
2448 call complete(col('.'), ['January', 'February', 'March',
2449 \ 'April', 'May', 'June', 'July', 'August', 'September',
2450 \ 'October', 'November', 'December'])
2451 return ''
2452 endfunc
2453< This isn't very useful, but it shows how it works. Note that
2454 an empty string is returned to avoid a zero being inserted.
2455
Bram Moolenaar572cb562005-08-05 21:35:02 +00002456complete_add({expr}) *complete_add()*
2457 Add {expr} to the list of matches. Only to be used by the
2458 function specified with the 'completefunc' option.
2459 Returns 0 for failure (empty string or out of memory),
2460 1 when the match was added, 2 when the match was already in
2461 the list.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002462 See |complete-functions| for an explanation of {expr}. It is
Bram Moolenaar39f05632006-03-19 22:15:26 +00002463 the same as one item in the list that 'omnifunc' would return.
Bram Moolenaar572cb562005-08-05 21:35:02 +00002464
2465complete_check() *complete_check()*
2466 Check for a key typed while looking for completion matches.
2467 This is to be used when looking for matches takes some time.
2468 Returns non-zero when searching for matches is to be aborted,
2469 zero otherwise.
2470 Only to be used by the function specified with the
2471 'completefunc' option.
2472
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473 *confirm()*
2474confirm({msg} [, {choices} [, {default} [, {type}]]])
2475 Confirm() offers the user a dialog, from which a choice can be
2476 made. It returns the number of the choice. For the first
2477 choice this is 1.
2478 Note: confirm() is only supported when compiled with dialog
2479 support, see |+dialog_con| and |+dialog_gui|.
Bram Moolenaara800b422010-06-27 01:15:55 +02002480
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481 {msg} is displayed in a |dialog| with {choices} as the
2482 alternatives. When {choices} is missing or empty, "&OK" is
2483 used (and translated).
2484 {msg} is a String, use '\n' to include a newline. Only on
2485 some systems the string is wrapped when it doesn't fit.
Bram Moolenaara800b422010-06-27 01:15:55 +02002486
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 {choices} is a String, with the individual choices separated
2488 by '\n', e.g. >
2489 confirm("Save changes?", "&Yes\n&No\n&Cancel")
2490< The letter after the '&' is the shortcut key for that choice.
2491 Thus you can type 'c' to select "Cancel". The shortcut does
2492 not need to be the first letter: >
2493 confirm("file has been modified", "&Save\nSave &All")
2494< For the console, the first letter of each choice is used as
2495 the default shortcut key.
Bram Moolenaara800b422010-06-27 01:15:55 +02002496
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497 The optional {default} argument is the number of the choice
2498 that is made if the user hits <CR>. Use 1 to make the first
2499 choice the default one. Use 0 to not set a default. If
2500 {default} is omitted, 1 is used.
Bram Moolenaara800b422010-06-27 01:15:55 +02002501
2502 The optional {type} argument gives the type of dialog. This
2503 is only used for the icon of the GTK, Mac, Motif and Win32
2504 GUI. It can be one of these values: "Error", "Question",
2505 "Info", "Warning" or "Generic". Only the first character is
2506 relevant. When {type} is omitted, "Generic" is used.
2507
Bram Moolenaar071d4272004-06-13 20:20:40 +00002508 If the user aborts the dialog by pressing <Esc>, CTRL-C,
2509 or another valid interrupt key, confirm() returns 0.
2510
2511 An example: >
2512 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2)
2513 :if choice == 0
2514 : echo "make up your mind!"
2515 :elseif choice == 3
2516 : echo "tasteful"
2517 :else
2518 : echo "I prefer bananas myself."
2519 :endif
2520< In a GUI dialog, buttons are used. The layout of the buttons
2521 depends on the 'v' flag in 'guioptions'. If it is included,
Bram Moolenaar446cb832008-06-24 21:56:24 +00002522 the buttons are always put vertically. Otherwise, confirm()
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523 tries to put the buttons in one horizontal line. If they
2524 don't fit, a vertical layout is used anyway. For some systems
2525 the horizontal layout is always used.
2526
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002527 *copy()*
Bram Moolenaar446cb832008-06-24 21:56:24 +00002528copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002529 different from using {expr} directly.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002530 When {expr} is a |List| a shallow copy is created. This means
2531 that the original |List| can be changed without changing the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002532 copy, and vice versa. But the items are identical, thus
2533 changing an item changes the contents of both |Lists|. Also
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002534 see |deepcopy()|.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002535
Bram Moolenaar446cb832008-06-24 21:56:24 +00002536cos({expr}) *cos()*
2537 Return the cosine of {expr}, measured in radians, as a |Float|.
2538 {expr} must evaluate to a |Float| or a |Number|.
2539 Examples: >
2540 :echo cos(100)
2541< 0.862319 >
2542 :echo cos(-4.01)
2543< -0.646043
2544 {only available when compiled with the |+float| feature}
2545
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002546
2547cosh({expr}) *cosh()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02002548 Return the hyperbolic cosine of {expr} as a |Float| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002549 [1, inf].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02002550 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002551 Examples: >
2552 :echo cosh(0.5)
2553< 1.127626 >
2554 :echo cosh(-0.5)
2555< -1.127626
Bram Moolenaardb84e452010-08-15 13:50:43 +02002556 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002557
Bram Moolenaar446cb832008-06-24 21:56:24 +00002558
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002559count({comp}, {expr} [, {ic} [, {start}]]) *count()*
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002560 Return the number of times an item with value {expr} appears
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002561 in |List| or |Dictionary| {comp}.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002562 If {start} is given then start with the item with this index.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002563 {start} can only be used with a |List|.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002564 When {ic} is given and it's non-zero then case is ignored.
2565
2566
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567 *cscope_connection()*
2568cscope_connection([{num} , {dbpath} [, {prepend}]])
2569 Checks for the existence of a |cscope| connection. If no
2570 parameters are specified, then the function returns:
2571 0, if cscope was not available (not compiled in), or
2572 if there are no cscope connections;
2573 1, if there is at least one cscope connection.
2574
2575 If parameters are specified, then the value of {num}
2576 determines how existence of a cscope connection is checked:
2577
2578 {num} Description of existence check
2579 ----- ------------------------------
2580 0 Same as no parameters (e.g., "cscope_connection()").
2581 1 Ignore {prepend}, and use partial string matches for
2582 {dbpath}.
2583 2 Ignore {prepend}, and use exact string matches for
2584 {dbpath}.
2585 3 Use {prepend}, use partial string matches for both
2586 {dbpath} and {prepend}.
2587 4 Use {prepend}, use exact string matches for both
2588 {dbpath} and {prepend}.
2589
2590 Note: All string comparisons are case sensitive!
2591
2592 Examples. Suppose we had the following (from ":cs show"): >
2593
2594 # pid database name prepend path
2595 0 27664 cscope.out /usr/local
2596<
2597 Invocation Return Val ~
2598 ---------- ---------- >
2599 cscope_connection() 1
2600 cscope_connection(1, "out") 1
2601 cscope_connection(2, "out") 0
2602 cscope_connection(3, "out") 0
2603 cscope_connection(3, "out", "local") 1
2604 cscope_connection(4, "out") 0
2605 cscope_connection(4, "out", "local") 0
2606 cscope_connection(4, "cscope.out", "/usr/local") 1
2607<
Bram Moolenaar0b238792006-03-02 22:49:12 +00002608cursor({lnum}, {col} [, {off}]) *cursor()*
2609cursor({list})
Bram Moolenaaref2f6562007-05-06 13:32:59 +00002610 Positions the cursor at the column (byte count) {col} in the
2611 line {lnum}. The first column is one.
Bram Moolenaar493c1782014-05-28 14:34:46 +02002612
Bram Moolenaar0b238792006-03-02 22:49:12 +00002613 When there is one argument {list} this is used as a |List|
Bram Moolenaar493c1782014-05-28 14:34:46 +02002614 with two, three or four item:
2615 [{lnum}, {col}, {off}]
2616 [{lnum}, {col}, {off}, {curswant}]
Bram Moolenaar946e27a2014-06-25 18:50:27 +02002617 This is like the return value of |getpos()| or |getcurpos()|,
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02002618 but without the first item.
Bram Moolenaar493c1782014-05-28 14:34:46 +02002619
Bram Moolenaar071d4272004-06-13 20:20:40 +00002620 Does not change the jumplist.
2621 If {lnum} is greater than the number of lines in the buffer,
2622 the cursor will be positioned at the last line in the buffer.
2623 If {lnum} is zero, the cursor will stay in the current line.
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00002624 If {col} is greater than the number of bytes in the line,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 the cursor will be positioned at the last character in the
2626 line.
2627 If {col} is zero, the cursor will stay in the current column.
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02002628 If {curswant} is given it is used to set the preferred column
Bram Moolenaar34401cc2014-08-29 15:12:19 +02002629 for vertical movement. Otherwise {col} is used.
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01002630
Bram Moolenaar0b238792006-03-02 22:49:12 +00002631 When 'virtualedit' is used {off} specifies the offset in
2632 screen columns from the start of the character. E.g., a
Bram Moolenaard46bbc72007-05-12 14:38:41 +00002633 position within a <Tab> or after the last character.
Bram Moolenaar798b30b2009-04-22 10:56:16 +00002634 Returns 0 when the position could be set, -1 otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002636
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002637deepcopy({expr}[, {noref}]) *deepcopy()* *E698*
Bram Moolenaar446cb832008-06-24 21:56:24 +00002638 Make a copy of {expr}. For Numbers and Strings this isn't
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002639 different from using {expr} directly.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002640 When {expr} is a |List| a full copy is created. This means
2641 that the original |List| can be changed without changing the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002642 copy, and vice versa. When an item is a |List|, a copy for it
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002643 is made, recursively. Thus changing an item in the copy does
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002644 not change the contents of the original |List|.
2645 When {noref} is omitted or zero a contained |List| or
2646 |Dictionary| is only copied once. All references point to
2647 this single copy. With {noref} set to 1 every occurrence of a
2648 |List| or |Dictionary| results in a new copy. This also means
2649 that a cyclic reference causes deepcopy() to fail.
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00002650 *E724*
2651 Nesting is possible up to 100 levels. When there is an item
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002652 that refers back to a higher level making a deep copy with
2653 {noref} set to 1 will fail.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002654 Also see |copy()|.
2655
2656delete({fname}) *delete()*
2657 Deletes the file by the name {fname}. The result is a Number,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658 which is 0 if the file was deleted successfully, and non-zero
2659 when the deletion failed.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002660 Use |remove()| to delete an item from a |List|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +01002661 To delete a line from the buffer use |:delete|. Use |:exe|
2662 when the line number is in a variable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663
2664 *did_filetype()*
2665did_filetype() Returns non-zero when autocommands are being executed and the
2666 FileType event has been triggered at least once. Can be used
2667 to avoid triggering the FileType event again in the scripts
2668 that detect the file type. |FileType|
2669 When editing another file, the counter is reset, thus this
2670 really checks if the FileType event has been triggered for the
2671 current buffer. This allows an autocommand that starts
2672 editing another buffer to set 'filetype' and load a syntax
2673 file.
2674
Bram Moolenaar47136d72004-10-12 20:02:24 +00002675diff_filler({lnum}) *diff_filler()*
2676 Returns the number of filler lines above line {lnum}.
2677 These are the lines that were inserted at this point in
2678 another diff'ed window. These filler lines are shown in the
2679 display but don't exist in the buffer.
2680 {lnum} is used like with |getline()|. Thus "." is the current
2681 line, "'m" mark m, etc.
2682 Returns 0 if the current window is not in diff mode.
2683
2684diff_hlID({lnum}, {col}) *diff_hlID()*
2685 Returns the highlight ID for diff mode at line {lnum} column
2686 {col} (byte index). When the current line does not have a
2687 diff change zero is returned.
2688 {lnum} is used like with |getline()|. Thus "." is the current
2689 line, "'m" mark m, etc.
2690 {col} is 1 for the leftmost column, {lnum} is 1 for the first
2691 line.
2692 The highlight ID can be used with |synIDattr()| to obtain
2693 syntax information about the highlighting.
2694
Bram Moolenaar13065c42005-01-08 16:08:21 +00002695empty({expr}) *empty()*
2696 Return the Number 1 if {expr} is empty, zero otherwise.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002697 A |List| or |Dictionary| is empty when it does not have any
Bram Moolenaar446cb832008-06-24 21:56:24 +00002698 items. A Number is empty when its value is zero.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002699 For a long |List| this is much faster than comparing the
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002700 length with zero.
Bram Moolenaar13065c42005-01-08 16:08:21 +00002701
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702escape({string}, {chars}) *escape()*
2703 Escape the characters in {chars} that occur in {string} with a
2704 backslash. Example: >
2705 :echo escape('c:\program files\vim', ' \')
2706< results in: >
2707 c:\\program\ files\\vim
Bram Moolenaar446cb832008-06-24 21:56:24 +00002708< Also see |shellescape()|.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00002709
Bram Moolenaar446cb832008-06-24 21:56:24 +00002710 *eval()*
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00002711eval({string}) Evaluate {string} and return the result. Especially useful to
2712 turn the result of |string()| back into the original value.
Bram Moolenaar446cb832008-06-24 21:56:24 +00002713 This works for Numbers, Floats, Strings and composites of
2714 them. Also works for |Funcref|s that refer to existing
2715 functions.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00002716
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717eventhandler() *eventhandler()*
2718 Returns 1 when inside an event handler. That is that Vim got
2719 interrupted while waiting for the user to type a character,
2720 e.g., when dropping a file on Vim. This means interactive
2721 commands cannot be used. Otherwise zero is returned.
2722
2723executable({expr}) *executable()*
2724 This function checks if an executable with the name {expr}
2725 exists. {expr} must be the name of the program without any
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002726 arguments.
2727 executable() uses the value of $PATH and/or the normal
2728 searchpath for programs. *PATHEXT*
2729 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can
2730 optionally be included. Then the extensions in $PATHEXT are
Bram Moolenaar446cb832008-06-24 21:56:24 +00002731 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be
2732 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002733 used. A dot by itself can be used in $PATHEXT to try using
Bram Moolenaar446cb832008-06-24 21:56:24 +00002734 the name without an extension. When 'shell' looks like a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002735 Unix shell, then the name is also tried without adding an
2736 extension.
2737 On MS-DOS and MS-Windows it only checks if the file exists and
2738 is not a directory, not if it's really executable.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002739 On MS-Windows an executable in the same directory as Vim is
2740 always found. Since this directory is added to $PATH it
2741 should also work to execute it |win32-PATH|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 The result is a Number:
2743 1 exists
2744 0 does not exist
2745 -1 not implemented on this system
2746
Bram Moolenaarc7f02552014-04-01 21:00:59 +02002747exepath({expr}) *exepath()*
2748 If {expr} is an executable and is either an absolute path, a
2749 relative path or found in $PATH, return the full path.
2750 Note that the current directory is used when {expr} starts
2751 with "./", which may be a problem for Vim: >
2752 echo exepath(v:progpath)
Bram Moolenaar7e38ea22014-04-05 22:55:53 +02002753< If {expr} cannot be found in $PATH or is not executable then
Bram Moolenaarc7f02552014-04-01 21:00:59 +02002754 an empty string is returned.
2755
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756 *exists()*
2757exists({expr}) The result is a Number, which is non-zero if {expr} is
2758 defined, zero otherwise. The {expr} argument is a string,
2759 which contains one of these:
2760 &option-name Vim option (only checks if it exists,
2761 not if it really works)
2762 +option-name Vim option that works.
2763 $ENVNAME environment variable (could also be
2764 done by comparing with an empty
2765 string)
2766 *funcname built-in function (see |functions|)
2767 or user defined function (see
Bram Moolenaarbcb98982014-05-01 14:08:19 +02002768 |user-functions|). Also works for a
2769 variable that is a Funcref.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 varname internal variable (see
Bram Moolenaar446cb832008-06-24 21:56:24 +00002771 |internal-variables|). Also works
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002772 for |curly-braces-names|, |Dictionary|
2773 entries, |List| items, etc. Beware
Bram Moolenaarc236c162008-07-13 17:41:49 +00002774 that evaluating an index may cause an
2775 error message for an invalid
2776 expression. E.g.: >
2777 :let l = [1, 2, 3]
2778 :echo exists("l[5]")
2779< 0 >
2780 :echo exists("l[xx]")
2781< E121: Undefined variable: xx
2782 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 :cmdname Ex command: built-in command, user
2784 command or command modifier |:command|.
2785 Returns:
2786 1 for match with start of a command
2787 2 full match with a command
2788 3 matches several user commands
2789 To check for a supported command
2790 always check the return value to be 2.
Bram Moolenaar14716812006-05-04 21:54:08 +00002791 :2match The |:2match| command.
2792 :3match The |:3match| command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793 #event autocommand defined for this event
2794 #event#pattern autocommand defined for this event and
2795 pattern (the pattern is taken
2796 literally and compared to the
2797 autocommand patterns character by
2798 character)
Bram Moolenaara9b1e742005-12-19 22:14:58 +00002799 #group autocommand group exists
2800 #group#event autocommand defined for this group and
2801 event.
2802 #group#event#pattern
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002803 autocommand defined for this group,
Bram Moolenaara9b1e742005-12-19 22:14:58 +00002804 event and pattern.
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +00002805 ##event autocommand for this event is
2806 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 For checking for a supported feature use |has()|.
2808
2809 Examples: >
2810 exists("&shortname")
2811 exists("$HOSTNAME")
2812 exists("*strftime")
2813 exists("*s:MyFunc")
2814 exists("bufcount")
2815 exists(":Make")
Bram Moolenaara9b1e742005-12-19 22:14:58 +00002816 exists("#CursorHold")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 exists("#BufReadPre#*.gz")
Bram Moolenaara9b1e742005-12-19 22:14:58 +00002818 exists("#filetypeindent")
2819 exists("#filetypeindent#FileType")
2820 exists("#filetypeindent#FileType#*")
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +00002821 exists("##ColorScheme")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822< There must be no space between the symbol (&/$/*/#) and the
2823 name.
Bram Moolenaar91170f82006-05-05 21:15:17 +00002824 There must be no extra characters after the name, although in
2825 a few cases this is ignored. That may become more strict in
2826 the future, thus don't count on it!
2827 Working example: >
2828 exists(":make")
2829< NOT working example: >
2830 exists(":make install")
Bram Moolenaar9c102382006-05-03 21:26:49 +00002831
2832< Note that the argument must be a string, not the name of the
2833 variable itself. For example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834 exists(bufcount)
2835< This doesn't check for existence of the "bufcount" variable,
Bram Moolenaar06a89a52006-04-29 22:01:03 +00002836 but gets the value of "bufcount", and checks if that exists.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002838exp({expr}) *exp()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02002839 Return the exponential of {expr} as a |Float| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002840 [0, inf].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02002841 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002842 Examples: >
2843 :echo exp(2)
2844< 7.389056 >
2845 :echo exp(-1)
2846< 0.367879
Bram Moolenaardb84e452010-08-15 13:50:43 +02002847 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002848
2849
Bram Moolenaar84f72352012-03-11 15:57:40 +01002850expand({expr} [, {nosuf} [, {list}]]) *expand()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002851 Expand wildcards and the following special keywords in {expr}.
Bram Moolenaar84f72352012-03-11 15:57:40 +01002852 'wildignorecase' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853
Bram Moolenaar84f72352012-03-11 15:57:40 +01002854 If {list} is given and it is non-zero, a List will be returned.
2855 Otherwise the result is a String and when there are several
2856 matches, they are separated by <NL> characters. [Note: in
2857 version 5.0 a space was used, which caused problems when a
2858 file name contains a space]
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859
Bram Moolenaar446cb832008-06-24 21:56:24 +00002860 If the expansion fails, the result is an empty string. A name
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002861 for a non-existing file is not included, unless {expr} does
2862 not start with '%', '#' or '<', see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002863
2864 When {expr} starts with '%', '#' or '<', the expansion is done
2865 like for the |cmdline-special| variables with their associated
2866 modifiers. Here is a short overview:
2867
2868 % current file name
2869 # alternate file name
2870 #n alternate file name n
2871 <cfile> file name under the cursor
2872 <afile> autocmd file name
2873 <abuf> autocmd buffer number (as a String!)
2874 <amatch> autocmd matched name
Bram Moolenaara6878372014-03-22 21:02:50 +01002875 <sfile> sourced script file or function name
Bram Moolenaar81af9252010-12-10 20:35:50 +01002876 <slnum> sourced script file line number
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 <cword> word under the cursor
2878 <cWORD> WORD under the cursor
2879 <client> the {clientid} of the last received
2880 message |server2client()|
2881 Modifiers:
2882 :p expand to full path
2883 :h head (last path component removed)
2884 :t tail (last path component only)
2885 :r root (one extension removed)
2886 :e extension only
2887
2888 Example: >
2889 :let &tags = expand("%:p:h") . "/tags"
2890< Note that when expanding a string that starts with '%', '#' or
2891 '<', any following text is ignored. This does NOT work: >
2892 :let doesntwork = expand("%:h.bak")
2893< Use this: >
2894 :let doeswork = expand("%:h") . ".bak"
2895< Also note that expanding "<cfile>" and others only returns the
2896 referenced file name without further expansion. If "<cfile>"
2897 is "~/.cshrc", you need to do another expand() to have the
2898 "~/" expanded into the path of the home directory: >
2899 :echo expand(expand("<cfile>"))
2900<
2901 There cannot be white space between the variables and the
2902 following modifier. The |fnamemodify()| function can be used
2903 to modify normal file names.
2904
2905 When using '%' or '#', and the current or alternate file name
2906 is not defined, an empty string is used. Using "%:p" in a
2907 buffer with no name, results in the current directory, with a
2908 '/' added.
2909
2910 When {expr} does not start with '%', '#' or '<', it is
2911 expanded like a file name is expanded on the command line.
2912 'suffixes' and 'wildignore' are used, unless the optional
Bram Moolenaar146e9c32012-03-07 19:18:23 +01002913 {nosuf} argument is given and it is non-zero.
2914 Names for non-existing files are included. The "**" item can
2915 be used to search in a directory tree. For example, to find
2916 all "README" files in the current directory and below: >
Bram Moolenaar02743632005-07-25 20:42:36 +00002917 :echo expand("**/README")
2918<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 Expand() can also be used to expand variables and environment
2920 variables that are only known in a shell. But this can be
Bram Moolenaar34401cc2014-08-29 15:12:19 +02002921 slow, because a shell may be used to do the expansion. See
2922 |expr-env-expand|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 The expanded variable is still handled like a list of file
Bram Moolenaar446cb832008-06-24 21:56:24 +00002924 names. When an environment variable cannot be expanded, it is
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 left unchanged. Thus ":echo expand('$FOOBAR')" results in
2926 "$FOOBAR".
2927
2928 See |glob()| for finding existing files. See |system()| for
2929 getting the raw output of an external command.
2930
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002931extend({expr1}, {expr2} [, {expr3}]) *extend()*
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002932 {expr1} and {expr2} must be both |Lists| or both
2933 |Dictionaries|.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002934
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002935 If they are |Lists|: Append {expr2} to {expr1}.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002936 If {expr3} is given insert the items of {expr2} before item
2937 {expr3} in {expr1}. When {expr3} is zero insert before the
2938 first item. When {expr3} is equal to len({expr1}) then
2939 {expr2} is appended.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002940 Examples: >
2941 :echo sort(extend(mylist, [7, 5]))
2942 :call extend(mylist, [2, 3], 1)
Bram Moolenaardc9cf9c2008-08-08 10:36:31 +00002943< When {expr1} is the same List as {expr2} then the number of
2944 items copied is equal to the original length of the List.
2945 E.g., when {expr3} is 1 you get N new copies of the first item
2946 (where N is the original length of the List).
2947 Use |add()| to concatenate one item to a list. To concatenate
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002948 two lists into a new list use the + operator: >
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002949 :let newlist = [1, 2, 3] + [4, 5]
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002950<
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002951 If they are |Dictionaries|:
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002952 Add all entries from {expr2} to {expr1}.
2953 If a key exists in both {expr1} and {expr2} then {expr3} is
2954 used to decide what to do:
2955 {expr3} = "keep": keep the value of {expr1}
2956 {expr3} = "force": use the value of {expr2}
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002957 {expr3} = "error": give an error message *E737*
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002958 When {expr3} is omitted then "force" is assumed.
2959
2960 {expr1} is changed when {expr2} is not empty. If necessary
2961 make a copy of {expr1} first.
2962 {expr2} remains unchanged.
2963 Returns {expr1}.
2964
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002965
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00002966feedkeys({string} [, {mode}]) *feedkeys()*
2967 Characters in {string} are queued for processing as if they
Bram Moolenaar0a988df2015-01-27 15:19:24 +01002968 come from a mapping or were typed by the user.
2969 By default the string is added to the end of the typeahead
2970 buffer, thus if a mapping is still being executed the
2971 characters come after them. Use the 'i' flag to insert before
2972 other characters, they will be executed next, before any
2973 characters from a mapping.
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00002974 The function does not wait for processing of keys contained in
2975 {string}.
2976 To include special keys into {string}, use double-quotes
2977 and "\..." notation |expr-quote|. For example,
Bram Moolenaar79166c42007-05-10 18:29:51 +00002978 feedkeys("\<CR>") simulates pressing of the <Enter> key. But
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00002979 feedkeys('\<CR>') pushes 5 characters.
2980 If {mode} is absent, keys are remapped.
2981 {mode} is a String, which can contain these character flags:
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00002982 'm' Remap keys. This is default.
2983 'n' Do not remap keys.
2984 't' Handle keys as if typed; otherwise they are handled as
2985 if coming from a mapping. This matters for undo,
2986 opening folds, etc.
Bram Moolenaar0a988df2015-01-27 15:19:24 +01002987 'i' Insert the string instead of appending (see above).
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00002988 Return value is always 0.
2989
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990filereadable({file}) *filereadable()*
2991 The result is a Number, which is TRUE when a file with the
2992 name {file} exists, and can be read. If {file} doesn't exist,
2993 or is a directory, the result is FALSE. {file} is any
2994 expression, which is used as a String.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00002995 If you don't care about the file being readable you can use
2996 |glob()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997 *file_readable()*
2998 Obsolete name: file_readable().
2999
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00003000
Bram Moolenaaref2f6562007-05-06 13:32:59 +00003001filewritable({file}) *filewritable()*
3002 The result is a Number, which is 1 when a file with the
3003 name {file} exists, and can be written. If {file} doesn't
Bram Moolenaar446cb832008-06-24 21:56:24 +00003004 exist, or is not writable, the result is 0. If {file} is a
Bram Moolenaaref2f6562007-05-06 13:32:59 +00003005 directory, and we can write to it, the result is 2.
3006
3007
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003008filter({expr}, {string}) *filter()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003009 {expr} must be a |List| or a |Dictionary|.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003010 For each item in {expr} evaluate {string} and when the result
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003011 is zero remove the item from the |List| or |Dictionary|.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003012 Inside {string} |v:val| has the value of the current item.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003013 For a |Dictionary| |v:key| has the key of the current item.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003014 Examples: >
3015 :call filter(mylist, 'v:val !~ "OLD"')
3016< Removes the items where "OLD" appears. >
3017 :call filter(mydict, 'v:key >= 8')
3018< Removes the items with a key below 8. >
3019 :call filter(var, 0)
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003020< Removes all the items, thus clears the |List| or |Dictionary|.
Bram Moolenaard8b02732005-01-14 21:48:43 +00003021
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003022 Note that {string} is the result of expression and is then
3023 used as an expression again. Often it is good to use a
3024 |literal-string| to avoid having to double backslashes.
3025
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003026 The operation is done in-place. If you want a |List| or
3027 |Dictionary| to remain unmodified make a copy first: >
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00003028 :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003029
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003030< Returns {expr}, the |List| or |Dictionary| that was filtered.
Bram Moolenaar280f1262006-01-30 00:14:18 +00003031 When an error is encountered while evaluating {string} no
3032 further items in {expr} are processed.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00003033
3034
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00003035finddir({name}[, {path}[, {count}]]) *finddir()*
Bram Moolenaar5b6b1ca2007-03-27 08:19:43 +00003036 Find directory {name} in {path}. Supports both downwards and
3037 upwards recursive directory searches. See |file-searching|
3038 for the syntax of {path}.
3039 Returns the path of the first found match. When the found
3040 directory is below the current directory a relative path is
3041 returned. Otherwise a full path is returned.
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00003042 If {path} is omitted or empty then 'path' is used.
3043 If the optional {count} is given, find {count}'s occurrence of
Bram Moolenaar433f7c82006-03-21 21:29:36 +00003044 {name} in {path} instead of the first one.
Bram Moolenaar899dddf2006-03-26 21:06:50 +00003045 When {count} is negative return all the matches in a |List|.
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00003046 This is quite similar to the ex-command |:find|.
Bram Moolenaardb84e452010-08-15 13:50:43 +02003047 {only available when compiled with the |+file_in_path|
3048 feature}
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00003049
3050findfile({name}[, {path}[, {count}]]) *findfile()*
3051 Just like |finddir()|, but find a file instead of a directory.
Bram Moolenaar433f7c82006-03-21 21:29:36 +00003052 Uses 'suffixesadd'.
3053 Example: >
3054 :echo findfile("tags.vim", ".;")
Bram Moolenaaref2f6562007-05-06 13:32:59 +00003055< Searches from the directory of the current file upwards until
3056 it finds the file "tags.vim".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057
Bram Moolenaar446cb832008-06-24 21:56:24 +00003058float2nr({expr}) *float2nr()*
3059 Convert {expr} to a Number by omitting the part after the
3060 decimal point.
3061 {expr} must evaluate to a |Float| or a Number.
3062 When the value of {expr} is out of range for a |Number| the
3063 result is truncated to 0x7fffffff or -0x7fffffff. NaN results
3064 in -0x80000000.
3065 Examples: >
3066 echo float2nr(3.95)
3067< 3 >
3068 echo float2nr(-23.45)
3069< -23 >
3070 echo float2nr(1.0e100)
3071< 2147483647 >
3072 echo float2nr(-1.0e150)
3073< -2147483647 >
3074 echo float2nr(1.0e-100)
3075< 0
3076 {only available when compiled with the |+float| feature}
3077
3078
3079floor({expr}) *floor()*
3080 Return the largest integral value less than or equal to
3081 {expr} as a |Float| (round down).
3082 {expr} must evaluate to a |Float| or a |Number|.
3083 Examples: >
3084 echo floor(1.856)
3085< 1.0 >
3086 echo floor(-5.456)
3087< -6.0 >
3088 echo floor(4.0)
3089< 4.0
3090 {only available when compiled with the |+float| feature}
3091
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003092
3093fmod({expr1}, {expr2}) *fmod()*
3094 Return the remainder of {expr1} / {expr2}, even if the
3095 division is not representable. Returns {expr1} - i * {expr2}
3096 for some integer i such that if {expr2} is non-zero, the
3097 result has the same sign as {expr1} and magnitude less than
3098 the magnitude of {expr2}. If {expr2} is zero, the value
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003099 returned is zero. The value returned is a |Float|.
3100 {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003101 Examples: >
3102 :echo fmod(12.33, 1.22)
3103< 0.13 >
3104 :echo fmod(-12.33, 1.22)
3105< -0.13
Bram Moolenaardb84e452010-08-15 13:50:43 +02003106 {only available when compiled with |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003107
3108
Bram Moolenaaraebaf892008-05-28 14:49:58 +00003109fnameescape({string}) *fnameescape()*
Bram Moolenaar446cb832008-06-24 21:56:24 +00003110 Escape {string} for use as file name command argument. All
Bram Moolenaaraebaf892008-05-28 14:49:58 +00003111 characters that have a special meaning, such as '%' and '|'
3112 are escaped with a backslash.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003113 For most systems the characters escaped are
3114 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash
3115 appears in a filename, it depends on the value of 'isfname'.
Bram Moolenaar1b24e4b2008-08-08 10:59:17 +00003116 A leading '+' and '>' is also escaped (special after |:edit|
3117 and |:write|). And a "-" by itself (special after |:cd|).
Bram Moolenaaraebaf892008-05-28 14:49:58 +00003118 Example: >
Bram Moolenaar1b24e4b2008-08-08 10:59:17 +00003119 :let fname = '+some str%nge|name'
Bram Moolenaaraebaf892008-05-28 14:49:58 +00003120 :exe "edit " . fnameescape(fname)
3121< results in executing: >
Bram Moolenaar1b24e4b2008-08-08 10:59:17 +00003122 edit \+some\ str\%nge\|name
Bram Moolenaaraebaf892008-05-28 14:49:58 +00003123
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124fnamemodify({fname}, {mods}) *fnamemodify()*
3125 Modify file name {fname} according to {mods}. {mods} is a
3126 string of characters like it is used for file names on the
3127 command line. See |filename-modifiers|.
3128 Example: >
3129 :echo fnamemodify("main.c", ":p:h")
3130< results in: >
3131 /home/mool/vim/vim/src
Bram Moolenaar446cb832008-06-24 21:56:24 +00003132< Note: Environment variables don't work in {fname}, use
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 |expand()| first then.
3134
3135foldclosed({lnum}) *foldclosed()*
3136 The result is a Number. If the line {lnum} is in a closed
3137 fold, the result is the number of the first line in that fold.
3138 If the line {lnum} is not in a closed fold, -1 is returned.
3139
3140foldclosedend({lnum}) *foldclosedend()*
3141 The result is a Number. If the line {lnum} is in a closed
3142 fold, the result is the number of the last line in that fold.
3143 If the line {lnum} is not in a closed fold, -1 is returned.
3144
3145foldlevel({lnum}) *foldlevel()*
3146 The result is a Number, which is the foldlevel of line {lnum}
Bram Moolenaar446cb832008-06-24 21:56:24 +00003147 in the current buffer. For nested folds the deepest level is
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 returned. If there is no fold at line {lnum}, zero is
3149 returned. It doesn't matter if the folds are open or closed.
3150 When used while updating folds (from 'foldexpr') -1 is
3151 returned for lines where folds are still to be updated and the
3152 foldlevel is unknown. As a special case the level of the
3153 previous line is usually available.
3154
3155 *foldtext()*
3156foldtext() Returns a String, to be displayed for a closed fold. This is
3157 the default function used for the 'foldtext' option and should
3158 only be called from evaluating 'foldtext'. It uses the
3159 |v:foldstart|, |v:foldend| and |v:folddashes| variables.
3160 The returned string looks like this: >
3161 +-- 45 lines: abcdef
Bram Moolenaar446cb832008-06-24 21:56:24 +00003162< The number of dashes depends on the foldlevel. The "45" is
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 the number of lines in the fold. "abcdef" is the text in the
3164 first non-blank line of the fold. Leading white space, "//"
3165 or "/*" and the text from the 'foldmarker' and 'commentstring'
3166 options is removed.
3167 {not available when compiled without the |+folding| feature}
3168
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003169foldtextresult({lnum}) *foldtextresult()*
3170 Returns the text that is displayed for the closed fold at line
3171 {lnum}. Evaluates 'foldtext' in the appropriate context.
3172 When there is no closed fold at {lnum} an empty string is
3173 returned.
3174 {lnum} is used like with |getline()|. Thus "." is the current
3175 line, "'m" mark m, etc.
3176 Useful when exporting folded text, e.g., to HTML.
3177 {not available when compiled without the |+folding| feature}
3178
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 *foreground()*
Bram Moolenaar446cb832008-06-24 21:56:24 +00003180foreground() Move the Vim window to the foreground. Useful when sent from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 a client to a Vim server. |remote_send()|
3182 On Win32 systems this might not work, the OS does not always
3183 allow a window to bring itself to the foreground. Use
3184 |remote_foreground()| instead.
3185 {only in the Win32, Athena, Motif and GTK GUI versions and the
3186 Win32 console version}
3187
Bram Moolenaara14de3d2005-01-07 21:48:26 +00003188
Bram Moolenaar13065c42005-01-08 16:08:21 +00003189function({name}) *function()* *E700*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003190 Return a |Funcref| variable that refers to function {name}.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00003191 {name} can be a user defined function or an internal function.
3192
Bram Moolenaara14de3d2005-01-07 21:48:26 +00003193
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003194garbagecollect([{atexit}]) *garbagecollect()*
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003195 Cleanup unused |Lists| and |Dictionaries| that have circular
Bram Moolenaar39a58ca2005-06-27 22:42:44 +00003196 references. There is hardly ever a need to invoke this
3197 function, as it is automatically done when Vim runs out of
3198 memory or is waiting for the user to press a key after
3199 'updatetime'. Items without circular references are always
3200 freed when they become unused.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003201 This is useful if you have deleted a very big |List| and/or
3202 |Dictionary| with circular references in a script that runs
3203 for a long time.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003204 When the optional {atexit} argument is one, garbage
Bram Moolenaar9d2c8c12007-09-25 16:00:00 +00003205 collection will also be done when exiting Vim, if it wasn't
3206 done before. This is useful when checking for memory leaks.
Bram Moolenaar39a58ca2005-06-27 22:42:44 +00003207
Bram Moolenaar677ee682005-01-27 14:41:15 +00003208get({list}, {idx} [, {default}]) *get()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003209 Get item {idx} from |List| {list}. When this item is not
Bram Moolenaara14de3d2005-01-07 21:48:26 +00003210 available return {default}. Return zero when {default} is
3211 omitted.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003212get({dict}, {key} [, {default}])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003213 Get item with key {key} from |Dictionary| {dict}. When this
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003214 item is not available return {default}. Return zero when
3215 {default} is omitted.
3216
Bram Moolenaar45360022005-07-21 21:08:21 +00003217 *getbufline()*
3218getbufline({expr}, {lnum} [, {end}])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003219 Return a |List| with the lines starting from {lnum} to {end}
3220 (inclusive) in the buffer {expr}. If {end} is omitted, a
3221 |List| with only the line {lnum} is returned.
Bram Moolenaar45360022005-07-21 21:08:21 +00003222
3223 For the use of {expr}, see |bufname()| above.
3224
Bram Moolenaar661b1822005-07-28 22:36:45 +00003225 For {lnum} and {end} "$" can be used for the last line of the
3226 buffer. Otherwise a number must be used.
Bram Moolenaar45360022005-07-21 21:08:21 +00003227
3228 When {lnum} is smaller than 1 or bigger than the number of
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003229 lines in the buffer, an empty |List| is returned.
Bram Moolenaar45360022005-07-21 21:08:21 +00003230
3231 When {end} is greater than the number of lines in the buffer,
3232 it is treated as {end} is set to the number of lines in the
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003233 buffer. When {end} is before {lnum} an empty |List| is
Bram Moolenaar45360022005-07-21 21:08:21 +00003234 returned.
3235
Bram Moolenaar661b1822005-07-28 22:36:45 +00003236 This function works only for loaded buffers. For unloaded and
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003237 non-existing buffers, an empty |List| is returned.
Bram Moolenaar45360022005-07-21 21:08:21 +00003238
3239 Example: >
3240 :let lines = getbufline(bufnr("myfile"), 1, "$")
Bram Moolenaara14de3d2005-01-07 21:48:26 +00003241
Bram Moolenaar63dbda12013-02-20 21:12:10 +01003242getbufvar({expr}, {varname} [, {def}]) *getbufvar()*
Bram Moolenaara14de3d2005-01-07 21:48:26 +00003243 The result is the value of option or local buffer variable
3244 {varname} in buffer {expr}. Note that the name without "b:"
3245 must be used.
Bram Moolenaarc236c162008-07-13 17:41:49 +00003246 When {varname} is empty returns a dictionary with all the
3247 buffer-local variables.
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00003248 This also works for a global or buffer-local option, but it
3249 doesn't work for a global variable, window-local variable or
3250 window-local option.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00003251 For the use of {expr}, see |bufname()| above.
Bram Moolenaar63dbda12013-02-20 21:12:10 +01003252 When the buffer or variable doesn't exist {def} or an empty
3253 string is returned, there is no error message.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00003254 Examples: >
3255 :let bufmodified = getbufvar(1, "&mod")
3256 :echo "todo myvar = " . getbufvar("todo", "myvar")
3257<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258getchar([expr]) *getchar()*
Bram Moolenaar91170f82006-05-05 21:15:17 +00003259 Get a single character from the user or input stream.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 If [expr] is omitted, wait until a character is available.
3261 If [expr] is 0, only get a character when one is available.
Bram Moolenaar91170f82006-05-05 21:15:17 +00003262 Return zero otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 If [expr] is 1, only check if a character is available, it is
Bram Moolenaar91170f82006-05-05 21:15:17 +00003264 not consumed. Return zero if no character available.
3265
Bram Moolenaardfb18412013-12-11 18:53:29 +01003266 Without [expr] and when [expr] is 0 a whole character or
Bram Moolenaar91170f82006-05-05 21:15:17 +00003267 special key is returned. If it is an 8-bit character, the
3268 result is a number. Use nr2char() to convert it to a String.
3269 Otherwise a String is returned with the encoded character.
3270 For a special key it's a sequence of bytes starting with 0x80
Bram Moolenaar56a907a2006-05-06 21:44:30 +00003271 (decimal: 128). This is the same value as the string
3272 "\<Key>", e.g., "\<Left>". The returned value is also a
3273 String when a modifier (shift, control, alt) was used that is
3274 not included in the character.
Bram Moolenaar91170f82006-05-05 21:15:17 +00003275
Bram Moolenaar822ff862014-06-12 21:46:14 +02003276 When [expr] is 0 and Esc is typed, there will be a short delay
3277 while Vim waits to see if this is the start of an escape
3278 sequence.
3279
Bram Moolenaardfb18412013-12-11 18:53:29 +01003280 When [expr] is 1 only the first byte is returned. For a
Bram Moolenaar56a907a2006-05-06 21:44:30 +00003281 one-byte character it is the character itself as a number.
3282 Use nr2char() to convert it to a String.
Bram Moolenaar91170f82006-05-05 21:15:17 +00003283
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003284 Use getcharmod() to obtain any additional modifiers.
3285
Bram Moolenaar219b8702006-11-01 14:32:36 +00003286 When the user clicks a mouse button, the mouse event will be
3287 returned. The position can then be found in |v:mouse_col|,
3288 |v:mouse_lnum| and |v:mouse_win|. This example positions the
3289 mouse as it would normally happen: >
3290 let c = getchar()
Bram Moolenaar446cb832008-06-24 21:56:24 +00003291 if c == "\<LeftMouse>" && v:mouse_win > 0
Bram Moolenaar219b8702006-11-01 14:32:36 +00003292 exe v:mouse_win . "wincmd w"
3293 exe v:mouse_lnum
3294 exe "normal " . v:mouse_col . "|"
3295 endif
3296<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 There is no prompt, you will somehow have to make clear to the
3298 user that a character has to be typed.
3299 There is no mapping for the character.
3300 Key codes are replaced, thus when the user presses the <Del>
3301 key you get the code for the <Del> key, not the raw character
3302 sequence. Examples: >
3303 getchar() == "\<Del>"
3304 getchar() == "\<S-Left>"
3305< This example redefines "f" to ignore case: >
3306 :nmap f :call FindChar()<CR>
3307 :function FindChar()
3308 : let c = nr2char(getchar())
3309 : while col('.') < col('$') - 1
3310 : normal l
3311 : if getline('.')[col('.') - 1] ==? c
3312 : break
3313 : endif
3314 : endwhile
3315 :endfunction
Bram Moolenaared32d942014-12-06 23:33:00 +01003316<
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003317 You may also receive synthetic characters, such as
Bram Moolenaared32d942014-12-06 23:33:00 +01003318 |<CursorHold>|. Often you will want to ignore this and get
3319 another character: >
3320 :function GetKey()
3321 : let c = getchar()
3322 : while c == "\<CursorHold>"
3323 : let c = getchar()
3324 : endwhile
3325 : return c
3326 :endfunction
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327
3328getcharmod() *getcharmod()*
3329 The result is a Number which is the state of the modifiers for
3330 the last obtained character with getchar() or in another way.
3331 These values are added together:
3332 2 shift
3333 4 control
3334 8 alt (meta)
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003335 16 meta (when it's different from ALT)
3336 32 mouse double click
3337 64 mouse triple click
3338 96 mouse quadruple click (== 32 + 64)
3339 128 command (Macintosh only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 Only the modifiers that have not been included in the
Bram Moolenaar446cb832008-06-24 21:56:24 +00003341 character itself are obtained. Thus Shift-a results in "A"
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003342 without a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344getcmdline() *getcmdline()*
3345 Return the current command-line. Only works when the command
3346 line is being edited, thus requires use of |c_CTRL-\_e| or
3347 |c_CTRL-R_=|.
3348 Example: >
3349 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003350< Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00003352getcmdpos() *getcmdpos()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 Return the position of the cursor in the command line as a
3354 byte count. The first column is 1.
3355 Only works when editing the command line, thus requires use of
Bram Moolenaar5b435d62012-04-05 17:33:26 +02003356 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
3357 Returns 0 otherwise.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003358 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|.
3359
3360getcmdtype() *getcmdtype()*
3361 Return the current command-line type. Possible return values
3362 are:
Bram Moolenaar1e015462005-09-25 22:16:38 +00003363 : normal Ex command
3364 > debug mode command |debug-mode|
3365 / forward search command
3366 ? backward search command
3367 @ |input()| command
3368 - |:insert| or |:append| command
Bram Moolenaar6e932462014-09-09 18:48:09 +02003369 = |i_CTRL-R_=|
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003370 Only works when editing the command line, thus requires use of
Bram Moolenaar5b435d62012-04-05 17:33:26 +02003371 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
3372 Returns an empty string otherwise.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003373 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374
Bram Moolenaarfb539272014-08-22 19:21:47 +02003375getcmdwintype() *getcmdwintype()*
3376 Return the current |command-line-window| type. Possible return
3377 values are the same as |getcmdtype()|. Returns an empty string
3378 when not in the command-line window.
3379
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02003380 *getcurpos()*
3381getcurpos() Get the position of the cursor. This is like getpos('.'), but
3382 includes an extra item in the list:
3383 [bufnum, lnum, col, off, curswant]
3384 The "curswant" number is the preferred column when moving the
3385 cursor vertically.
3386 This can be used to save and restore the cursor position: >
3387 let save_cursor = getcurpos()
3388 MoveTheCursorAround
3389 call setpos('.', save_cursor)
Bram Moolenaarfb539272014-08-22 19:21:47 +02003390<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 *getcwd()*
3392getcwd() The result is a String, which is the name of the current
3393 working directory.
3394
3395getfsize({fname}) *getfsize()*
3396 The result is a Number, which is the size in bytes of the
3397 given file {fname}.
3398 If {fname} is a directory, 0 is returned.
3399 If the file {fname} can't be found, -1 is returned.
Bram Moolenaard827ada2007-06-19 15:19:55 +00003400 If the size of {fname} is too big to fit in a Number then -2
3401 is returned.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00003403getfontname([{name}]) *getfontname()*
3404 Without an argument returns the name of the normal font being
3405 used. Like what is used for the Normal highlight group
3406 |hl-Normal|.
3407 With an argument a check is done whether {name} is a valid
3408 font name. If not then an empty string is returned.
3409 Otherwise the actual font name is returned, or {name} if the
3410 GUI does not support obtaining the real name.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00003411 Only works when the GUI is running, thus not in your vimrc or
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00003412 gvimrc file. Use the |GUIEnter| autocommand to use this
3413 function just after the GUI has started.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003414 Note that the GTK 2 GUI accepts any font name, thus checking
3415 for a valid name does not work.
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00003416
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00003417getfperm({fname}) *getfperm()*
3418 The result is a String, which is the read, write, and execute
3419 permissions of the given file {fname}.
3420 If {fname} does not exist or its directory cannot be read, an
3421 empty string is returned.
3422 The result is of the form "rwxrwxrwx", where each group of
3423 "rwx" flags represent, in turn, the permissions of the owner
3424 of the file, the group the file belongs to, and other users.
3425 If a user does not have a given permission the flag for this
Bram Moolenaar9b451252012-08-15 17:43:31 +02003426 is replaced with the string "-". Examples: >
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00003427 :echo getfperm("/etc/passwd")
Bram Moolenaar9b451252012-08-15 17:43:31 +02003428 :echo getfperm(expand("~/.vimrc"))
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00003429< This will hopefully (from a security point of view) display
3430 the string "rw-r--r--" or even "rw-------".
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003431
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432getftime({fname}) *getftime()*
3433 The result is a Number, which is the last modification time of
3434 the given file {fname}. The value is measured as seconds
3435 since 1st Jan 1970, and may be passed to strftime(). See also
3436 |localtime()| and |strftime()|.
3437 If the file {fname} can't be found -1 is returned.
3438
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00003439getftype({fname}) *getftype()*
3440 The result is a String, which is a description of the kind of
3441 file of the given file {fname}.
3442 If {fname} does not exist an empty string is returned.
3443 Here is a table over different kinds of files and their
3444 results:
3445 Normal file "file"
3446 Directory "dir"
3447 Symbolic link "link"
3448 Block device "bdev"
3449 Character device "cdev"
3450 Socket "socket"
3451 FIFO "fifo"
3452 All other "other"
3453 Example: >
3454 getftype("/home")
3455< Note that a type such as "link" will only be returned on
3456 systems that support it. On some systems only "dir" and
3457 "file" are returned.
3458
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 *getline()*
Bram Moolenaara14de3d2005-01-07 21:48:26 +00003460getline({lnum} [, {end}])
3461 Without {end} the result is a String, which is line {lnum}
3462 from the current buffer. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 getline(1)
3464< When {lnum} is a String that doesn't start with a
3465 digit, line() is called to translate the String into a Number.
3466 To get the line under the cursor: >
3467 getline(".")
3468< When {lnum} is smaller than 1 or bigger than the number of
3469 lines in the buffer, an empty string is returned.
3470
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003471 When {end} is given the result is a |List| where each item is
3472 a line from the current buffer in the range {lnum} to {end},
Bram Moolenaara14de3d2005-01-07 21:48:26 +00003473 including line {end}.
3474 {end} is used in the same way as {lnum}.
3475 Non-existing lines are silently omitted.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003476 When {end} is before {lnum} an empty |List| is returned.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00003477 Example: >
3478 :let start = line('.')
3479 :let end = search("^$") - 1
3480 :let lines = getline(start, end)
3481
Bram Moolenaaref2f6562007-05-06 13:32:59 +00003482< To get lines from another buffer see |getbufline()|
3483
Bram Moolenaar17c7c012006-01-26 22:25:15 +00003484getloclist({nr}) *getloclist()*
3485 Returns a list with all the entries in the location list for
3486 window {nr}. When {nr} is zero the current window is used.
3487 For a location list window, the displayed location list is
Bram Moolenaar280f1262006-01-30 00:14:18 +00003488 returned. For an invalid window number {nr}, an empty list is
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003489 returned. Otherwise, same as |getqflist()|.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00003490
Bram Moolenaar6ee10162007-07-26 20:58:42 +00003491getmatches() *getmatches()*
3492 Returns a |List| with all matches previously defined by
3493 |matchadd()| and the |:match| commands. |getmatches()| is
3494 useful in combination with |setmatches()|, as |setmatches()|
3495 can restore a list of matches saved by |getmatches()|.
3496 Example: >
3497 :echo getmatches()
3498< [{'group': 'MyGroup1', 'pattern': 'TODO',
3499 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
3500 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
3501 :let m = getmatches()
3502 :call clearmatches()
3503 :echo getmatches()
3504< [] >
3505 :call setmatches(m)
3506 :echo getmatches()
3507< [{'group': 'MyGroup1', 'pattern': 'TODO',
3508 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
3509 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
3510 :unlet m
3511<
Bram Moolenaar822ff862014-06-12 21:46:14 +02003512 *getpid()*
3513getpid() Return a Number which is the process ID of the Vim process.
3514 On Unix and MS-Windows this is a unique number, until Vim
3515 exits. On MS-DOS it's always zero.
3516
3517 *getpos()*
3518getpos({expr}) Get the position for {expr}. For possible values of {expr}
3519 see |line()|. For getting the cursor position see
3520 |getcurpos()|.
3521 The result is a |List| with four numbers:
3522 [bufnum, lnum, col, off]
3523 "bufnum" is zero, unless a mark like '0 or 'A is used, then it
3524 is the buffer number of the mark.
3525 "lnum" and "col" are the position in the buffer. The first
3526 column is 1.
3527 The "off" number is zero, unless 'virtualedit' is used. Then
3528 it is the offset in screen columns from the start of the
3529 character. E.g., a position within a <Tab> or after the last
3530 character.
3531 Note that for '< and '> Visual mode matters: when it is "V"
3532 (visual line mode) the column of '< is zero and the column of
3533 '> is a large number.
3534 This can be used to save and restore the position of a mark: >
3535 let save_a_mark = getpos("'a")
3536 ...
Bram Moolenaared32d942014-12-06 23:33:00 +01003537 call setpos("'a", save_a_mark)
Bram Moolenaar822ff862014-06-12 21:46:14 +02003538< Also see |getcurpos()| and |setpos()|.
3539
Bram Moolenaar6ee10162007-07-26 20:58:42 +00003540
Bram Moolenaar68b76a62005-03-25 21:53:48 +00003541getqflist() *getqflist()*
3542 Returns a list with all the current quickfix errors. Each
3543 list item is a dictionary with these entries:
3544 bufnr number of buffer that has the file name, use
3545 bufname() to get the name
3546 lnum line number in the buffer (first line is 1)
3547 col column number (first column is 1)
Bram Moolenaar582fd852005-03-28 20:58:01 +00003548 vcol non-zero: "col" is visual column
3549 zero: "col" is byte index
Bram Moolenaar68b76a62005-03-25 21:53:48 +00003550 nr error number
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00003551 pattern search pattern used to locate the error
Bram Moolenaar68b76a62005-03-25 21:53:48 +00003552 text description of the error
3553 type type of the error, 'E', '1', etc.
3554 valid non-zero: recognized error message
3555
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00003556 When there is no error list or it's empty an empty list is
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00003557 returned. Quickfix list entries with non-existing buffer
3558 number are returned with "bufnr" set to zero.
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00003559
Bram Moolenaar68b76a62005-03-25 21:53:48 +00003560 Useful application: Find pattern matches in multiple files and
3561 do something with them: >
3562 :vimgrep /theword/jg *.c
3563 :for d in getqflist()
3564 : echo bufname(d.bufnr) ':' d.lnum '=' d.text
3565 :endfor
3566
3567
Bram Moolenaarb7cb42b2014-04-02 19:55:10 +02003568getreg([{regname} [, 1 [, {list}]]]) *getreg()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 The result is a String, which is the contents of register
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003570 {regname}. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 :let cliptext = getreg('*')
3572< getreg('=') returns the last evaluated value of the expression
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003573 register. (For use in maps.)
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00003574 getreg('=', 1) returns the expression itself, so that it can
3575 be restored with |setreg()|. For other registers the extra
3576 argument is ignored, thus you can always give it.
Bram Moolenaarb7cb42b2014-04-02 19:55:10 +02003577 If {list} is present and non-zero result type is changed to
3578 |List|. Each list item is one text line. Use it if you care
3579 about zero bytes possibly present inside register: without
3580 third argument both NLs and zero bytes are represented as NLs
3581 (see |NL-used-for-Nul|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 If {regname} is not specified, |v:register| is used.
3583
Bram Moolenaara14de3d2005-01-07 21:48:26 +00003584
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585getregtype([{regname}]) *getregtype()*
3586 The result is a String, which is type of register {regname}.
3587 The value will be one of:
3588 "v" for |characterwise| text
3589 "V" for |linewise| text
3590 "<CTRL-V>{width}" for |blockwise-visual| text
Bram Moolenaar32b92012014-01-14 12:33:36 +01003591 "" for an empty or unknown register
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 <CTRL-V> is one character with value 0x16.
3593 If {regname} is not specified, |v:register| is used.
3594
Bram Moolenaar63dbda12013-02-20 21:12:10 +01003595gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()*
Bram Moolenaar06b5d512010-05-22 15:37:44 +02003596 Get the value of a tab-local variable {varname} in tab page
3597 {tabnr}. |t:var|
3598 Tabs are numbered starting with one.
Bram Moolenaar0e2ea1b2014-09-09 16:13:08 +02003599 When {varname} is empty a dictionary with all tab-local
3600 variables is returned.
Bram Moolenaar06b5d512010-05-22 15:37:44 +02003601 Note that the name without "t:" must be used.
Bram Moolenaar63dbda12013-02-20 21:12:10 +01003602 When the tab or variable doesn't exist {def} or an empty
3603 string is returned, there is no error message.
Bram Moolenaar06b5d512010-05-22 15:37:44 +02003604
Bram Moolenaar63dbda12013-02-20 21:12:10 +01003605gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()*
Bram Moolenaaref2f6562007-05-06 13:32:59 +00003606 Get the value of window-local variable {varname} in window
3607 {winnr} in tab page {tabnr}.
3608 When {varname} starts with "&" get the value of a window-local
3609 option.
Bram Moolenaar63dbda12013-02-20 21:12:10 +01003610 When {varname} is empty a dictionary with all window-local
3611 variables is returned.
3612 Note that {varname} must be the name without "w:".
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00003613 Tabs are numbered starting with one. For the current tabpage
3614 use |getwinvar()|.
3615 When {winnr} is zero the current window is used.
3616 This also works for a global option, buffer-local option and
3617 window-local option, but it doesn't work for a global variable
3618 or buffer-local variable.
Bram Moolenaar63dbda12013-02-20 21:12:10 +01003619 When the tab, window or variable doesn't exist {def} or an
3620 empty string is returned, there is no error message.
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00003621 Examples: >
3622 :let list_is_on = gettabwinvar(1, 2, '&list')
3623 :echo "myvar = " . gettabwinvar(3, 1, 'myvar')
Bram Moolenaard46bbc72007-05-12 14:38:41 +00003624<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 *getwinposx()*
3626getwinposx() The result is a Number, which is the X coordinate in pixels of
3627 the left hand side of the GUI Vim window. The result will be
3628 -1 if the information is not available.
3629
3630 *getwinposy()*
3631getwinposy() The result is a Number, which is the Y coordinate in pixels of
Bram Moolenaar446cb832008-06-24 21:56:24 +00003632 the top of the GUI Vim window. The result will be -1 if the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 information is not available.
3634
Bram Moolenaar63dbda12013-02-20 21:12:10 +01003635getwinvar({winnr}, {varname} [, {def}]) *getwinvar()*
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00003636 Like |gettabwinvar()| for the current tabpage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 Examples: >
3638 :let list_is_on = getwinvar(2, '&list')
3639 :echo "myvar = " . getwinvar(1, 'myvar')
3640<
Bram Moolenaard8b77f72015-03-05 21:21:19 +01003641glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()*
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00003642 Expand the file wildcards in {expr}. See |wildcards| for the
Bram Moolenaaref2f6562007-05-06 13:32:59 +00003643 use of special characters.
Bram Moolenaar84f72352012-03-11 15:57:40 +01003644
3645 Unless the optional {nosuf} argument is given and is non-zero,
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00003646 the 'suffixes' and 'wildignore' options apply: Names matching
3647 one of the patterns in 'wildignore' will be skipped and
3648 'suffixes' affect the ordering of matches.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003649 'wildignorecase' always applies.
Bram Moolenaar84f72352012-03-11 15:57:40 +01003650
3651 When {list} is present and it is non-zero the result is a List
3652 with all matching files. The advantage of using a List is,
3653 you also get filenames containing newlines correctly.
3654 Otherwise the result is a String and when there are several
3655 matches, they are separated by <NL> characters.
3656
3657 If the expansion fails, the result is an empty String or List.
Bram Moolenaard8b77f72015-03-05 21:21:19 +01003658
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003659 A name for a non-existing file is not included. A symbolic
3660 link is only included if it points to an existing file.
Bram Moolenaard8b77f72015-03-05 21:21:19 +01003661 However, when the {alllinks} argument is present and it is
3662 non-zero then all symbolic links are included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663
3664 For most systems backticks can be used to get files names from
3665 any external command. Example: >
3666 :let tagfiles = glob("`find . -name tags -print`")
3667 :let &tags = substitute(tagfiles, "\n", ",", "g")
3668< The result of the program inside the backticks should be one
Bram Moolenaar446cb832008-06-24 21:56:24 +00003669 item per line. Spaces inside an item are allowed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670
3671 See |expand()| for expanding special Vim variables. See
3672 |system()| for getting the raw output of an external command.
3673
Bram Moolenaard8b77f72015-03-05 21:21:19 +01003674 *globpath()*
3675globpath({path}, {expr} [, {nosuf} [, {list} [, {allinks}]]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676 Perform glob() on all directories in {path} and concatenate
3677 the results. Example: >
3678 :echo globpath(&rtp, "syntax/c.vim")
Bram Moolenaar1b1063a2014-05-07 18:35:30 +02003679<
3680 {path} is a comma-separated list of directory names. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 directory name is prepended to {expr} and expanded like with
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00003682 |glob()|. A path separator is inserted when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 To add a comma inside a directory name escape it with a
3684 backslash. Note that on MS-Windows a directory may have a
3685 trailing backslash, remove it if you put a comma after it.
3686 If the expansion fails for one of the directories, there is no
3687 error message.
Bram Moolenaar1b1063a2014-05-07 18:35:30 +02003688
3689 Unless the optional {nosuf} argument is given and is non-zero,
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00003690 the 'suffixes' and 'wildignore' options apply: Names matching
3691 one of the patterns in 'wildignore' will be skipped and
3692 'suffixes' affect the ordering of matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693
Bram Moolenaar1b1063a2014-05-07 18:35:30 +02003694 When {list} is present and it is non-zero the result is a List
3695 with all matching files. The advantage of using a List is, you
3696 also get filenames containing newlines correctly. Otherwise
3697 the result is a String and when there are several matches,
3698 they are separated by <NL> characters. Example: >
3699 :echo globpath(&rtp, "syntax/c.vim", 0, 1)
3700<
Bram Moolenaard8b77f72015-03-05 21:21:19 +01003701 {allinks} is used as with |glob()|.
3702
Bram Moolenaar02743632005-07-25 20:42:36 +00003703 The "**" item can be used to search in a directory tree.
3704 For example, to find all "README.txt" files in the directories
3705 in 'runtimepath' and below: >
3706 :echo globpath(&rtp, "**/README.txt")
Bram Moolenaarc236c162008-07-13 17:41:49 +00003707< Upwards search and limiting the depth of "**" is not
3708 supported, thus using 'path' will not always work properly.
3709
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 *has()*
3711has({feature}) The result is a Number, which is 1 if the feature {feature} is
3712 supported, zero otherwise. The {feature} argument is a
3713 string. See |feature-list| below.
3714 Also see |exists()|.
3715
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003716
3717has_key({dict}, {key}) *has_key()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003718 The result is a Number, which is 1 if |Dictionary| {dict} has
3719 an entry with key {key}. Zero otherwise.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003720
Bram Moolenaard267b9c2007-04-26 15:06:45 +00003721haslocaldir() *haslocaldir()*
3722 The result is a Number, which is 1 when the current
Bram Moolenaar446cb832008-06-24 21:56:24 +00003723 window has set a local path via |:lcd|, and 0 otherwise.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003724
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003725hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 The result is a Number, which is 1 if there is a mapping that
3727 contains {what} in somewhere in the rhs (what it is mapped to)
3728 and this mapping exists in one of the modes indicated by
3729 {mode}.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003730 When {abbr} is there and it is non-zero use abbreviations
Bram Moolenaar39f05632006-03-19 22:15:26 +00003731 instead of mappings. Don't forget to specify Insert and/or
3732 Command-line mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 Both the global mappings and the mappings local to the current
3734 buffer are checked for a match.
3735 If no matching mapping is found 0 is returned.
3736 The following characters are recognized in {mode}:
3737 n Normal mode
3738 v Visual mode
3739 o Operator-pending mode
3740 i Insert mode
3741 l Language-Argument ("r", "f", "t", etc.)
3742 c Command-line mode
3743 When {mode} is omitted, "nvo" is used.
3744
3745 This function is useful to check if a mapping already exists
Bram Moolenaar446cb832008-06-24 21:56:24 +00003746 to a function in a Vim script. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 :if !hasmapto('\ABCdoit')
3748 : map <Leader>d \ABCdoit
3749 :endif
3750< This installs the mapping to "\ABCdoit" only if there isn't
3751 already a mapping to "\ABCdoit".
3752
3753histadd({history}, {item}) *histadd()*
3754 Add the String {item} to the history {history} which can be
3755 one of: *hist-names*
3756 "cmd" or ":" command line history
3757 "search" or "/" search pattern history
Bram Moolenaar446cb832008-06-24 21:56:24 +00003758 "expr" or "=" typed expression history
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 "input" or "@" input line history
Bram Moolenaar30b65812012-07-12 22:01:11 +02003760 "debug" or ">" debug command history
3761 The {history} string does not need to be the whole name, one
3762 character is sufficient.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 If {item} does already exist in the history, it will be
3764 shifted to become the newest entry.
3765 The result is a Number: 1 if the operation was successful,
3766 otherwise 0 is returned.
3767
3768 Example: >
3769 :call histadd("input", strftime("%Y %b %d"))
3770 :let date=input("Enter date: ")
3771< This function is not available in the |sandbox|.
3772
3773histdel({history} [, {item}]) *histdel()*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003774 Clear {history}, i.e. delete all its entries. See |hist-names|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775 for the possible values of {history}.
3776
Bram Moolenaarc236c162008-07-13 17:41:49 +00003777 If the parameter {item} evaluates to a String, it is used as a
3778 regular expression. All entries matching that expression will
3779 be removed from the history (if there are any).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 Upper/lowercase must match, unless "\c" is used |/\c|.
Bram Moolenaarc236c162008-07-13 17:41:49 +00003781 If {item} evaluates to a Number, it will be interpreted as
3782 an index, see |:history-indexing|. The respective entry will
3783 be removed if it exists.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784
3785 The result is a Number: 1 for a successful operation,
3786 otherwise 0 is returned.
3787
3788 Examples:
3789 Clear expression register history: >
3790 :call histdel("expr")
3791<
3792 Remove all entries starting with "*" from the search history: >
3793 :call histdel("/", '^\*')
3794<
3795 The following three are equivalent: >
3796 :call histdel("search", histnr("search"))
3797 :call histdel("search", -1)
3798 :call histdel("search", '^'.histget("search", -1).'$')
3799<
3800 To delete the last search pattern and use the last-but-one for
3801 the "n" command and 'hlsearch': >
3802 :call histdel("search", -1)
3803 :let @/ = histget("search", -1)
3804
3805histget({history} [, {index}]) *histget()*
3806 The result is a String, the entry with Number {index} from
3807 {history}. See |hist-names| for the possible values of
3808 {history}, and |:history-indexing| for {index}. If there is
3809 no such entry, an empty String is returned. When {index} is
3810 omitted, the most recent item from the history is used.
3811
3812 Examples:
3813 Redo the second last search from history. >
3814 :execute '/' . histget("search", -2)
3815
3816< Define an Ex command ":H {num}" that supports re-execution of
3817 the {num}th entry from the output of |:history|. >
3818 :command -nargs=1 H execute histget("cmd", 0+<args>)
3819<
3820histnr({history}) *histnr()*
3821 The result is the Number of the current entry in {history}.
3822 See |hist-names| for the possible values of {history}.
3823 If an error occurred, -1 is returned.
3824
3825 Example: >
3826 :let inp_index = histnr("expr")
3827<
3828hlexists({name}) *hlexists()*
3829 The result is a Number, which is non-zero if a highlight group
3830 called {name} exists. This is when the group has been
3831 defined in some way. Not necessarily when highlighting has
3832 been defined for it, it may also have been used for a syntax
3833 item.
3834 *highlight_exists()*
3835 Obsolete name: highlight_exists().
3836
3837 *hlID()*
3838hlID({name}) The result is a Number, which is the ID of the highlight group
3839 with name {name}. When the highlight group doesn't exist,
3840 zero is returned.
3841 This can be used to retrieve information about the highlight
Bram Moolenaar446cb832008-06-24 21:56:24 +00003842 group. For example, to get the background color of the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843 "Comment" group: >
3844 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
3845< *highlightID()*
3846 Obsolete name: highlightID().
3847
3848hostname() *hostname()*
3849 The result is a String, which is the name of the machine on
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003850 which Vim is currently running. Machine names greater than
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 256 characters long are truncated.
3852
3853iconv({expr}, {from}, {to}) *iconv()*
3854 The result is a String, which is the text {expr} converted
3855 from encoding {from} to encoding {to}.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003856 When the conversion completely fails an empty string is
3857 returned. When some characters could not be converted they
3858 are replaced with "?".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 The encoding names are whatever the iconv() library function
3860 can accept, see ":!man 3 iconv".
3861 Most conversions require Vim to be compiled with the |+iconv|
3862 feature. Otherwise only UTF-8 to latin1 conversion and back
3863 can be done.
3864 This can be used to display messages with special characters,
3865 no matter what 'encoding' is set to. Write the message in
3866 UTF-8 and use: >
3867 echo iconv(utf8_str, "utf-8", &enc)
3868< Note that Vim uses UTF-8 for all Unicode encodings, conversion
3869 from/to UCS-2 is automatically changed to use UTF-8. You
3870 cannot use UCS-2 in a string anyway, because of the NUL bytes.
Bram Moolenaardb84e452010-08-15 13:50:43 +02003871 {only available when compiled with the |+multi_byte| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872
3873 *indent()*
3874indent({lnum}) The result is a Number, which is indent of line {lnum} in the
3875 current buffer. The indent is counted in spaces, the value
3876 of 'tabstop' is relevant. {lnum} is used just like in
3877 |getline()|.
3878 When {lnum} is invalid -1 is returned.
3879
Bram Moolenaarde8866b2005-01-06 23:24:37 +00003880
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00003881index({list}, {expr} [, {start} [, {ic}]]) *index()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003882 Return the lowest index in |List| {list} where the item has a
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003883 value equal to {expr}. There is no automatic conversion, so
3884 the String "4" is different from the Number 4. And the number
3885 4 is different from the Float 4.0. The value of 'ignorecase'
3886 is not used here, case always matters.
Bram Moolenaar748bf032005-02-02 23:04:36 +00003887 If {start} is given then start looking at the item with index
3888 {start} (may be negative for an item relative to the end).
Bram Moolenaarde8866b2005-01-06 23:24:37 +00003889 When {ic} is given and it is non-zero, ignore case. Otherwise
3890 case must match.
3891 -1 is returned when {expr} is not found in {list}.
3892 Example: >
3893 :let idx = index(words, "the")
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00003894 :if index(numbers, 123) >= 0
Bram Moolenaarde8866b2005-01-06 23:24:37 +00003895
3896
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003897input({prompt} [, {text} [, {completion}]]) *input()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 The result is a String, which is whatever the user typed on
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003899 the command-line. The {prompt} argument is either a prompt
3900 string, or a blank string (for no prompt). A '\n' can be used
3901 in the prompt to start a new line.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003902 The highlighting set with |:echohl| is used for the prompt.
3903 The input is entered just like a command-line, with the same
Bram Moolenaar446cb832008-06-24 21:56:24 +00003904 editing commands and mappings. There is a separate history
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003905 for lines typed for input().
3906 Example: >
3907 :if input("Coffee or beer? ") == "beer"
3908 : echo "Cheers!"
3909 :endif
3910<
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003911 If the optional {text} argument is present and not empty, this
3912 is used for the default reply, as if the user typed this.
3913 Example: >
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003914 :let color = input("Color? ", "white")
3915
3916< The optional {completion} argument specifies the type of
3917 completion supported for the input. Without it completion is
Bram Moolenaar446cb832008-06-24 21:56:24 +00003918 not performed. The supported completion types are the same as
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003919 that can be supplied to a user-defined command using the
Bram Moolenaar446cb832008-06-24 21:56:24 +00003920 "-complete=" argument. Refer to |:command-completion| for
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003921 more information. Example: >
3922 let fname = input("File: ", "", "file")
3923<
3924 NOTE: This function must not be used in a startup file, for
3925 the versions that only run in GUI mode (e.g., the Win32 GUI).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 Note: When input() is called from within a mapping it will
3927 consume remaining characters from that mapping, because a
3928 mapping is handled like the characters were typed.
3929 Use |inputsave()| before input() and |inputrestore()|
3930 after input() to avoid that. Another solution is to avoid
3931 that further characters follow in the mapping, e.g., by using
3932 |:execute| or |:normal|.
3933
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003934 Example with a mapping: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR>
3936 :function GetFoo()
3937 : call inputsave()
3938 : let g:Foo = input("enter search pattern: ")
3939 : call inputrestore()
3940 :endfunction
3941
3942inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003943 Like |input()|, but when the GUI is running and text dialogs
3944 are supported, a dialog window pops up to input the text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 Example: >
Bram Moolenaar2d17fa32012-10-21 00:45:18 +02003946 :let n = inputdialog("value for shiftwidth", shiftwidth())
3947 :if n != ""
3948 : let &sw = n
3949 :endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950< When the dialog is cancelled {cancelreturn} is returned. When
3951 omitted an empty string is returned.
3952 Hitting <Enter> works like pressing the OK button. Hitting
3953 <Esc> works like pressing the Cancel button.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003954 NOTE: Command-line completion is not supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955
Bram Moolenaar578b49e2005-09-10 19:22:57 +00003956inputlist({textlist}) *inputlist()*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003957 {textlist} must be a |List| of strings. This |List| is
3958 displayed, one string per line. The user will be prompted to
3959 enter a number, which is returned.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00003960 The user can also select an item by clicking on it with the
Bram Moolenaar446cb832008-06-24 21:56:24 +00003961 mouse. For the first string 0 is returned. When clicking
Bram Moolenaar578b49e2005-09-10 19:22:57 +00003962 above the first item a negative number is returned. When
3963 clicking on the prompt one more than the length of {textlist}
3964 is returned.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003965 Make sure {textlist} has less than 'lines' entries, otherwise
Bram Moolenaar446cb832008-06-24 21:56:24 +00003966 it won't work. It's a good idea to put the entry number at
Bram Moolenaaref2f6562007-05-06 13:32:59 +00003967 the start of the string. And put a prompt in the first item.
3968 Example: >
Bram Moolenaar578b49e2005-09-10 19:22:57 +00003969 let color = inputlist(['Select color:', '1. red',
3970 \ '2. green', '3. blue'])
3971
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972inputrestore() *inputrestore()*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003973 Restore typeahead that was saved with a previous |inputsave()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974 Should be called the same number of times inputsave() is
3975 called. Calling it more often is harmless though.
3976 Returns 1 when there is nothing to restore, 0 otherwise.
3977
3978inputsave() *inputsave()*
3979 Preserve typeahead (also from mappings) and clear it, so that
3980 a following prompt gets input from the user. Should be
3981 followed by a matching inputrestore() after the prompt. Can
3982 be used several times, in which case there must be just as
3983 many inputrestore() calls.
3984 Returns 1 when out of memory, 0 otherwise.
3985
3986inputsecret({prompt} [, {text}]) *inputsecret()*
3987 This function acts much like the |input()| function with but
3988 two exceptions:
3989 a) the user's response will be displayed as a sequence of
3990 asterisks ("*") thereby keeping the entry secret, and
3991 b) the user's response will not be recorded on the input
3992 |history| stack.
3993 The result is a String, which is whatever the user actually
3994 typed on the command-line in response to the issued prompt.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00003995 NOTE: Command-line completion is not supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00003997insert({list}, {item} [, {idx}]) *insert()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003998 Insert {item} at the start of |List| {list}.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00003999 If {idx} is specified insert {item} before the item with index
Bram Moolenaar446cb832008-06-24 21:56:24 +00004000 {idx}. If {idx} is zero it goes before the first item, just
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00004001 like omitting {idx}. A negative {idx} is also possible, see
4002 |list-index|. -1 inserts just before the last item.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004003 Returns the resulting |List|. Examples: >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00004004 :let mylist = insert([2, 3, 5], 1)
4005 :call insert(mylist, 4, -1)
4006 :call insert(mylist, 6, len(mylist))
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004007< The last example can be done simpler with |add()|.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004008 Note that when {item} is a |List| it is inserted as a single
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004009 item. Use |extend()| to concatenate |Lists|.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00004010
Bram Moolenaard6e256c2011-12-14 15:32:50 +01004011invert({expr}) *invert()*
4012 Bitwise invert. The argument is converted to a number. A
4013 List, Dict or Float argument causes an error. Example: >
4014 :let bits = invert(bits)
4015
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016isdirectory({directory}) *isdirectory()*
4017 The result is a Number, which is non-zero when a directory
4018 with the name {directory} exists. If {directory} doesn't
4019 exist, or isn't a directory, the result is FALSE. {directory}
4020 is any expression, which is used as a String.
4021
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004022islocked({expr}) *islocked()* *E786*
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004023 The result is a Number, which is non-zero when {expr} is the
4024 name of a locked variable.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004025 {expr} must be the name of a variable, |List| item or
4026 |Dictionary| entry, not the variable itself! Example: >
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004027 :let alist = [0, ['a', 'b'], 2, 3]
4028 :lockvar 1 alist
4029 :echo islocked('alist') " 1
4030 :echo islocked('alist[1]') " 0
4031
4032< When {expr} is a variable that does not exist you get an error
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00004033 message. Use |exists()| to check for existence.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004034
Bram Moolenaar677ee682005-01-27 14:41:15 +00004035items({dict}) *items()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004036 Return a |List| with all the key-value pairs of {dict}. Each
4037 |List| item is a list with two items: the key of a {dict}
4038 entry and the value of this entry. The |List| is in arbitrary
4039 order.
Bram Moolenaar677ee682005-01-27 14:41:15 +00004040
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004041
4042join({list} [, {sep}]) *join()*
4043 Join the items in {list} together into one String.
4044 When {sep} is specified it is put in between the items. If
4045 {sep} is omitted a single space is used.
4046 Note that {sep} is not added at the end. You might want to
4047 add it there too: >
4048 let lines = join(mylist, "\n") . "\n"
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004049< String items are used as-is. |Lists| and |Dictionaries| are
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004050 converted into a string like with |string()|.
4051 The opposite function is |split()|.
4052
Bram Moolenaard8b02732005-01-14 21:48:43 +00004053keys({dict}) *keys()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004054 Return a |List| with all the keys of {dict}. The |List| is in
Bram Moolenaard8b02732005-01-14 21:48:43 +00004055 arbitrary order.
4056
Bram Moolenaar13065c42005-01-08 16:08:21 +00004057 *len()* *E701*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00004058len({expr}) The result is a Number, which is the length of the argument.
4059 When {expr} is a String or a Number the length in bytes is
4060 used, as with |strlen()|.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004061 When {expr} is a |List| the number of items in the |List| is
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00004062 returned.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004063 When {expr} is a |Dictionary| the number of entries in the
4064 |Dictionary| is returned.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00004065 Otherwise an error is given.
4066
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 *libcall()* *E364* *E368*
4068libcall({libname}, {funcname}, {argument})
4069 Call function {funcname} in the run-time library {libname}
4070 with single argument {argument}.
4071 This is useful to call functions in a library that you
4072 especially made to be used with Vim. Since only one argument
4073 is possible, calling standard library functions is rather
4074 limited.
4075 The result is the String returned by the function. If the
4076 function returns NULL, this will appear as an empty string ""
4077 to Vim.
4078 If the function returns a number, use libcallnr()!
4079 If {argument} is a number, it is passed to the function as an
4080 int; if {argument} is a string, it is passed as a
4081 null-terminated string.
4082 This function will fail in |restricted-mode|.
4083
4084 libcall() allows you to write your own 'plug-in' extensions to
4085 Vim without having to recompile the program. It is NOT a
4086 means to call system functions! If you try to do so Vim will
4087 very probably crash.
4088
4089 For Win32, the functions you write must be placed in a DLL
4090 and use the normal C calling convention (NOT Pascal which is
4091 used in Windows System DLLs). The function must take exactly
4092 one parameter, either a character pointer or a long integer,
4093 and must return a character pointer or NULL. The character
4094 pointer returned must point to memory that will remain valid
4095 after the function has returned (e.g. in static data in the
4096 DLL). If it points to allocated memory, that memory will
4097 leak away. Using a static buffer in the function should work,
4098 it's then freed when the DLL is unloaded.
4099
4100 WARNING: If the function returns a non-valid pointer, Vim may
Bram Moolenaar446cb832008-06-24 21:56:24 +00004101 crash! This also happens if the function returns a number,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 because Vim thinks it's a pointer.
4103 For Win32 systems, {libname} should be the filename of the DLL
4104 without the ".DLL" suffix. A full path is only required if
4105 the DLL is not in the usual places.
4106 For Unix: When compiling your own plugins, remember that the
4107 object code must be compiled as position-independent ('PIC').
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004108 {only in Win32 and some Unix versions, when the |+libcall|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 feature is present}
4110 Examples: >
4111 :echo libcall("libc.so", "getenv", "HOME")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112<
4113 *libcallnr()*
4114libcallnr({libname}, {funcname}, {argument})
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004115 Just like |libcall()|, but used for a function that returns an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 int instead of a string.
4117 {only in Win32 on some Unix versions, when the |+libcall|
4118 feature is present}
Bram Moolenaar446cb832008-06-24 21:56:24 +00004119 Examples: >
4120 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 :call libcallnr("libc.so", "printf", "Hello World!\n")
4122 :call libcallnr("libc.so", "sleep", 10)
4123<
4124 *line()*
4125line({expr}) The result is a Number, which is the line number of the file
4126 position given with {expr}. The accepted positions are:
4127 . the cursor position
4128 $ the last line in the current buffer
4129 'x position of mark x (if the mark is not set, 0 is
4130 returned)
Bram Moolenaarc7453f52006-02-10 23:20:28 +00004131 w0 first line visible in current window
4132 w$ last line visible in current window
Bram Moolenaar9ecd0232008-06-20 15:31:51 +00004133 v In Visual mode: the start of the Visual area (the
4134 cursor is the end). When not in Visual mode
4135 returns the cursor position. Differs from |'<| in
4136 that it's updated right away.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00004137 Note that a mark in another file can be used. The line number
4138 then applies to another buffer.
Bram Moolenaar0b238792006-03-02 22:49:12 +00004139 To get the column number use |col()|. To get both use
4140 |getpos()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141 Examples: >
4142 line(".") line number of the cursor
4143 line("'t") line number of mark t
4144 line("'" . marker) line number of mark marker
4145< *last-position-jump*
4146 This autocommand jumps to the last known position in a file
4147 just after opening it, if the '" mark is set: >
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004148 :au BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g`\"" | endif
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00004149
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150line2byte({lnum}) *line2byte()*
4151 Return the byte count from the start of the buffer for line
4152 {lnum}. This includes the end-of-line character, depending on
4153 the 'fileformat' option for the current buffer. The first
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01004154 line returns 1. 'encoding' matters, 'fileencoding' is ignored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 This can also be used to get the byte count for the line just
4156 below the last line: >
4157 line2byte(line("$") + 1)
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01004158< This is the buffer size plus one. If 'fileencoding' is empty
4159 it is the file size plus one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 When {lnum} is invalid, or the |+byte_offset| feature has been
4161 disabled at compile time, -1 is returned.
4162 Also see |byte2line()|, |go| and |:goto|.
4163
4164lispindent({lnum}) *lispindent()*
4165 Get the amount of indent for line {lnum} according the lisp
4166 indenting rules, as with 'lisp'.
4167 The indent is counted in spaces, the value of 'tabstop' is
4168 relevant. {lnum} is used just like in |getline()|.
4169 When {lnum} is invalid or Vim was not compiled the
4170 |+lispindent| feature, -1 is returned.
4171
4172localtime() *localtime()*
4173 Return the current time, measured as seconds since 1st Jan
4174 1970. See also |strftime()| and |getftime()|.
4175
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004176
Bram Moolenaardb7c6862010-05-21 16:33:48 +02004177log({expr}) *log()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004178 Return the natural logarithm (base e) of {expr} as a |Float|.
4179 {expr} must evaluate to a |Float| or a |Number| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02004180 (0, inf].
4181 Examples: >
4182 :echo log(10)
4183< 2.302585 >
4184 :echo log(exp(5))
4185< 5.0
Bram Moolenaardb84e452010-08-15 13:50:43 +02004186 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02004187
4188
Bram Moolenaar446cb832008-06-24 21:56:24 +00004189log10({expr}) *log10()*
4190 Return the logarithm of Float {expr} to base 10 as a |Float|.
4191 {expr} must evaluate to a |Float| or a |Number|.
4192 Examples: >
4193 :echo log10(1000)
4194< 3.0 >
4195 :echo log10(0.01)
4196< -2.0
4197 {only available when compiled with the |+float| feature}
4198
Bram Moolenaard38b0552012-04-25 19:07:41 +02004199luaeval({expr}[, {expr}]) *luaeval()*
4200 Evaluate Lua expression {expr} and return its result converted
4201 to Vim data structures. Second {expr} may hold additional
4202 argument accessible as _A inside first {expr}.
4203 Strings are returned as they are.
4204 Boolean objects are converted to numbers.
4205 Numbers are converted to |Float| values if vim was compiled
4206 with |+float| and to numbers otherwise.
4207 Dictionaries and lists obtained by vim.eval() are returned
4208 as-is.
4209 Other objects are returned as zero without any errors.
4210 See |lua-luaeval| for more details.
4211 {only available when compiled with the |+lua| feature}
4212
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004213map({expr}, {string}) *map()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004214 {expr} must be a |List| or a |Dictionary|.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004215 Replace each item in {expr} with the result of evaluating
4216 {string}.
4217 Inside {string} |v:val| has the value of the current item.
Bram Moolenaar627b1d32009-11-17 11:20:35 +00004218 For a |Dictionary| |v:key| has the key of the current item
4219 and for a |List| |v:key| has the index of the current item.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004220 Example: >
4221 :call map(mylist, '"> " . v:val . " <"')
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004222< This puts "> " before and " <" after each item in "mylist".
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004223
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00004224 Note that {string} is the result of an expression and is then
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004225 used as an expression again. Often it is good to use a
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00004226 |literal-string| to avoid having to double backslashes. You
4227 still have to double ' quotes
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004228
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004229 The operation is done in-place. If you want a |List| or
4230 |Dictionary| to remain unmodified make a copy first: >
Bram Moolenaar30b65812012-07-12 22:01:11 +02004231 :let tlist = map(copy(mylist), ' v:val . "\t"')
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004232
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004233< Returns {expr}, the |List| or |Dictionary| that was filtered.
Bram Moolenaar280f1262006-01-30 00:14:18 +00004234 When an error is encountered while evaluating {string} no
4235 further items in {expr} are processed.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004236
4237
Bram Moolenaarbd743252010-10-20 21:23:33 +02004238maparg({name}[, {mode} [, {abbr} [, {dict}]]]) *maparg()*
4239 When {dict} is omitted or zero: Return the rhs of mapping
4240 {name} in mode {mode}. The returned String has special
4241 characters translated like in the output of the ":map" command
4242 listing.
4243
4244 When there is no mapping for {name}, an empty String is
4245 returned.
4246
4247 The {name} can have special key names, like in the ":map"
4248 command.
4249
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004250 {mode} can be one of these strings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 "n" Normal
Bram Moolenaarbd743252010-10-20 21:23:33 +02004252 "v" Visual (including Select)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 "o" Operator-pending
4254 "i" Insert
4255 "c" Cmd-line
Bram Moolenaarbd743252010-10-20 21:23:33 +02004256 "s" Select
4257 "x" Visual
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 "l" langmap |language-mapping|
4259 "" Normal, Visual and Operator-pending
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004260 When {mode} is omitted, the modes for "" are used.
Bram Moolenaarbd743252010-10-20 21:23:33 +02004261
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00004262 When {abbr} is there and it is non-zero use abbreviations
4263 instead of mappings.
Bram Moolenaarbd743252010-10-20 21:23:33 +02004264
4265 When {dict} is there and it is non-zero return a dictionary
4266 containing all the information of the mapping with the
4267 following items:
4268 "lhs" The {lhs} of the mapping.
4269 "rhs" The {rhs} of the mapping as typed.
4270 "silent" 1 for a |:map-silent| mapping, else 0.
Bram Moolenaar05365702010-10-27 18:34:44 +02004271 "noremap" 1 if the {rhs} of the mapping is not remappable.
Bram Moolenaarbd743252010-10-20 21:23:33 +02004272 "expr" 1 for an expression mapping (|:map-<expr>|).
4273 "buffer" 1 for a buffer local mapping (|:map-local|).
4274 "mode" Modes for which the mapping is defined. In
4275 addition to the modes mentioned above, these
4276 characters will be used:
4277 " " Normal, Visual and Operator-pending
4278 "!" Insert and Commandline mode
Bram Moolenaar166af9b2010-11-16 20:34:40 +01004279 (|mapmode-ic|)
Bram Moolenaar05365702010-10-27 18:34:44 +02004280 "sid" The script local ID, used for <sid> mappings
4281 (|<SID>|).
Bram Moolenaardfb18412013-12-11 18:53:29 +01004282 "nowait" Do not wait for other, longer mappings.
4283 (|:map-<nowait>|).
Bram Moolenaarbd743252010-10-20 21:23:33 +02004284
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 The mappings local to the current buffer are checked first,
4286 then the global mappings.
Bram Moolenaara40ceaf2006-01-13 22:35:40 +00004287 This function can be used to map a key even when it's already
4288 mapped, and have it do the original mapping too. Sketch: >
4289 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n')
4290
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00004292mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 Check if there is a mapping that matches with {name} in mode
4294 {mode}. See |maparg()| for {mode} and special names in
4295 {name}.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00004296 When {abbr} is there and it is non-zero use abbreviations
4297 instead of mappings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 A match happens with a mapping that starts with {name} and
4299 with a mapping which is equal to the start of {name}.
4300
Bram Moolenaar446cb832008-06-24 21:56:24 +00004301 matches mapping "a" "ab" "abc" ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 mapcheck("a") yes yes yes
4303 mapcheck("abc") yes yes yes
4304 mapcheck("ax") yes no no
4305 mapcheck("b") no no no
4306
4307 The difference with maparg() is that mapcheck() finds a
4308 mapping that matches with {name}, while maparg() only finds a
4309 mapping for {name} exactly.
4310 When there is no mapping that starts with {name}, an empty
4311 String is returned. If there is one, the rhs of that mapping
4312 is returned. If there are several mappings that start with
4313 {name}, the rhs of one of them is returned.
4314 The mappings local to the current buffer are checked first,
4315 then the global mappings.
4316 This function can be used to check if a mapping can be added
4317 without being ambiguous. Example: >
4318 :if mapcheck("_vv") == ""
4319 : map _vv :set guifont=7x13<CR>
4320 :endif
4321< This avoids adding the "_vv" mapping when there already is a
4322 mapping for "_v" or for "_vvv".
4323
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00004324match({expr}, {pat}[, {start}[, {count}]]) *match()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004325 When {expr} is a |List| then this returns the index of the
4326 first item where {pat} matches. Each item is used as a
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004327 String, |Lists| and |Dictionaries| are used as echoed.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004328 Otherwise, {expr} is used as a String. The result is a
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004329 Number, which gives the index (byte offset) in {expr} where
4330 {pat} matches.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004331 A match at the first character or |List| item returns zero.
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00004332 If there is no match -1 is returned.
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004333 For getting submatches see |matchlist()|.
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00004334 Example: >
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004335 :echo match("testing", "ing") " results in 4
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004336 :echo match([1, 'x'], '\a') " results in 1
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004337< See |string-match| for how {pat} is used.
Bram Moolenaar05159a02005-02-26 23:04:13 +00004338 *strpbrk()*
Bram Moolenaar446cb832008-06-24 21:56:24 +00004339 Vim doesn't have a strpbrk() function. But you can do: >
Bram Moolenaar05159a02005-02-26 23:04:13 +00004340 :let sepidx = match(line, '[.,;: \t]')
4341< *strcasestr()*
4342 Vim doesn't have a strcasestr() function. But you can add
4343 "\c" to the pattern to ignore case: >
4344 :let idx = match(haystack, '\cneedle')
4345<
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004346 If {start} is given, the search starts from byte index
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004347 {start} in a String or item {start} in a |List|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004348 The result, however, is still the index counted from the
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00004349 first character/item. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 :echo match("testing", "ing", 2)
4351< result is again "4". >
4352 :echo match("testing", "ing", 4)
4353< result is again "4". >
4354 :echo match("testing", "t", 2)
4355< result is "3".
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004356 For a String, if {start} > 0 then it is like the string starts
Bram Moolenaar0b238792006-03-02 22:49:12 +00004357 {start} bytes later, thus "^" will match at {start}. Except
4358 when {count} is given, then it's like matches before the
4359 {start} byte are ignored (this is a bit complicated to keep it
4360 backwards compatible).
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004361 For a String, if {start} < 0, it will be set to 0. For a list
4362 the index is counted from the end.
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004363 If {start} is out of range ({start} > strlen({expr}) for a
4364 String or {start} > len({expr}) for a |List|) -1 is returned.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004365
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004366 When {count} is given use the {count}'th match. When a match
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004367 is found in a String the search for the next one starts one
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004368 character further. Thus this example results in 1: >
4369 echo match("testing", "..", 0, 2)
4370< In a |List| the search continues in the next item.
Bram Moolenaar0b238792006-03-02 22:49:12 +00004371 Note that when {count} is added the way {start} works changes,
4372 see above.
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004373
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 See |pattern| for the patterns that are accepted.
4375 The 'ignorecase' option is used to set the ignore-caseness of
Bram Moolenaar446cb832008-06-24 21:56:24 +00004376 the pattern. 'smartcase' is NOT used. The matching is always
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 done like 'magic' is set and 'cpoptions' is empty.
4378
Bram Moolenaar6ee10162007-07-26 20:58:42 +00004379 *matchadd()* *E798* *E799* *E801*
4380matchadd({group}, {pattern}[, {priority}[, {id}]])
4381 Defines a pattern to be highlighted in the current window (a
4382 "match"). It will be highlighted with {group}. Returns an
4383 identification number (ID), which can be used to delete the
4384 match using |matchdelete()|.
Bram Moolenaar8e69b4a2013-11-09 03:41:58 +01004385 Matching is case sensitive and magic, unless case sensitivity
4386 or magicness are explicitly overridden in {pattern}. The
4387 'magic', 'smartcase' and 'ignorecase' options are not used.
Bram Moolenaar6ee10162007-07-26 20:58:42 +00004388
4389 The optional {priority} argument assigns a priority to the
Bram Moolenaar446cb832008-06-24 21:56:24 +00004390 match. A match with a high priority will have its
Bram Moolenaar6ee10162007-07-26 20:58:42 +00004391 highlighting overrule that of a match with a lower priority.
4392 A priority is specified as an integer (negative numbers are no
4393 exception). If the {priority} argument is not specified, the
4394 default priority is 10. The priority of 'hlsearch' is zero,
4395 hence all matches with a priority greater than zero will
4396 overrule it. Syntax highlighting (see 'syntax') is a separate
4397 mechanism, and regardless of the chosen priority a match will
4398 always overrule syntax highlighting.
4399
4400 The optional {id} argument allows the request for a specific
4401 match ID. If a specified ID is already taken, an error
4402 message will appear and the match will not be added. An ID
4403 is specified as a positive integer (zero excluded). IDs 1, 2
4404 and 3 are reserved for |:match|, |:2match| and |:3match|,
4405 respectively. If the {id} argument is not specified,
4406 |matchadd()| automatically chooses a free ID.
4407
4408 The number of matches is not limited, as it is the case with
4409 the |:match| commands.
4410
4411 Example: >
4412 :highlight MyGroup ctermbg=green guibg=green
4413 :let m = matchadd("MyGroup", "TODO")
4414< Deletion of the pattern: >
4415 :call matchdelete(m)
4416
4417< A list of matches defined by |matchadd()| and |:match| are
Bram Moolenaar446cb832008-06-24 21:56:24 +00004418 available from |getmatches()|. All matches can be deleted in
Bram Moolenaar6ee10162007-07-26 20:58:42 +00004419 one operation by |clearmatches()|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004420
Bram Moolenaarb3414592014-06-17 17:48:32 +02004421matchaddpos({group}, {pos}[, {priority}[, {id}]]) *matchaddpos()*
4422 Same as |matchadd()|, but requires a list of positions {pos}
4423 instead of a pattern. This command is faster than |matchadd()|
4424 because it does not require to handle regular expressions and
4425 sets buffer line boundaries to redraw screen. It is supposed
4426 to be used when fast match additions and deletions are
4427 required, for example to highlight matching parentheses.
4428
4429 The list {pos} can contain one of these items:
Bram Moolenaarb6da44a2014-06-25 18:15:22 +02004430 - A number. This whole line will be highlighted. The first
Bram Moolenaarb3414592014-06-17 17:48:32 +02004431 line has number 1.
4432 - A list with one number, e.g., [23]. The whole line with this
4433 number will be highlighted.
4434 - A list with two numbers, e.g., [23, 11]. The first number is
Bram Moolenaarb6da44a2014-06-25 18:15:22 +02004435 the line number, the second one is the column number (first
4436 column is 1, the value must correspond to the byte index as
4437 |col()| would return). The character at this position will
4438 be highlighted.
Bram Moolenaarb3414592014-06-17 17:48:32 +02004439 - A list with three numbers, e.g., [23, 11, 3]. As above, but
Bram Moolenaarb6da44a2014-06-25 18:15:22 +02004440 the third number gives the length of the highlight in bytes.
Bram Moolenaarb3414592014-06-17 17:48:32 +02004441
4442 The maximum number of positions is 8.
4443
4444 Example: >
4445 :highlight MyGroup ctermbg=green guibg=green
4446 :let m = matchaddpos("MyGroup", [[23, 24], 34])
4447< Deletion of the pattern: >
4448 :call matchdelete(m)
4449
4450< Matches added by |matchaddpos()| are returned by
4451 |getmatches()| with an entry "pos1", "pos2", etc., with the
4452 value a list like the {pos} item.
4453 These matches cannot be set via |setmatches()|, however they
4454 can still be deleted by |clearmatches()|.
4455
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004456matcharg({nr}) *matcharg()*
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004457 Selects the {nr} match item, as set with a |:match|,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004458 |:2match| or |:3match| command.
4459 Return a |List| with two elements:
4460 The name of the highlight group used
4461 The pattern used.
4462 When {nr} is not 1, 2 or 3 returns an empty |List|.
4463 When there is no match item set returns ['', ''].
Bram Moolenaar6ee10162007-07-26 20:58:42 +00004464 This is useful to save and restore a |:match|.
4465 Highlighting matches using the |:match| commands are limited
4466 to three matches. |matchadd()| does not have this limitation.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004467
Bram Moolenaar6ee10162007-07-26 20:58:42 +00004468matchdelete({id}) *matchdelete()* *E802* *E803*
4469 Deletes a match with ID {id} previously defined by |matchadd()|
Bram Moolenaar446cb832008-06-24 21:56:24 +00004470 or one of the |:match| commands. Returns 0 if successful,
Bram Moolenaar6ee10162007-07-26 20:58:42 +00004471 otherwise -1. See example for |matchadd()|. All matches can
4472 be deleted in one operation by |clearmatches()|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004473
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00004474matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004475 Same as |match()|, but return the index of first character
4476 after the match. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 :echo matchend("testing", "ing")
4478< results in "7".
Bram Moolenaar05159a02005-02-26 23:04:13 +00004479 *strspn()* *strcspn()*
4480 Vim doesn't have a strspn() or strcspn() function, but you can
4481 do it with matchend(): >
4482 :let span = matchend(line, '[a-zA-Z]')
4483 :let span = matchend(line, '[^a-zA-Z]')
4484< Except that -1 is returned when there are no matches.
4485
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004486 The {start}, if given, has the same meaning as for |match()|. >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 :echo matchend("testing", "ing", 2)
4488< results in "7". >
4489 :echo matchend("testing", "ing", 5)
4490< result is "-1".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004491 When {expr} is a |List| the result is equal to |match()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00004493matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004494 Same as |match()|, but return a |List|. The first item in the
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00004495 list is the matched string, same as what matchstr() would
4496 return. Following items are submatches, like "\1", "\2", etc.
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004497 in |:substitute|. When an optional submatch didn't match an
4498 empty string is used. Example: >
4499 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')
4500< Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00004501 When there is no match an empty list is returned.
4502
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00004503matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()*
Bram Moolenaar446cb832008-06-24 21:56:24 +00004504 Same as |match()|, but return the matched string. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 :echo matchstr("testing", "ing")
4506< results in "ing".
4507 When there is no match "" is returned.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004508 The {start}, if given, has the same meaning as for |match()|. >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 :echo matchstr("testing", "ing", 2)
4510< results in "ing". >
4511 :echo matchstr("testing", "ing", 5)
4512< result is "".
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004513 When {expr} is a |List| then the matching item is returned.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004514 The type isn't changed, it's not necessarily a String.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00004516 *max()*
4517max({list}) Return the maximum value of all items in {list}.
4518 If {list} is not a list or one of the items in {list} cannot
4519 be used as a Number this results in an error.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004520 An empty |List| results in zero.
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00004521
4522 *min()*
Bram Moolenaar79166c42007-05-10 18:29:51 +00004523min({list}) Return the minimum value of all items in {list}.
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00004524 If {list} is not a list or one of the items in {list} cannot
4525 be used as a Number this results in an error.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004526 An empty |List| results in zero.
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00004527
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00004528 *mkdir()* *E739*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004529mkdir({name} [, {path} [, {prot}]])
4530 Create directory {name}.
4531 If {path} is "p" then intermediate directories are created as
4532 necessary. Otherwise it must be "".
4533 If {prot} is given it is used to set the protection bits of
4534 the new directory. The default is 0755 (rwxr-xr-x: r/w for
Bram Moolenaar446cb832008-06-24 21:56:24 +00004535 the user readable for others). Use 0700 to make it unreadable
Bram Moolenaared39e1d2008-08-09 17:55:22 +00004536 for others. This is only used for the last part of {name}.
4537 Thus if you create /tmp/foo/bar then /tmp/foo will be created
4538 with 0755.
4539 Example: >
4540 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700)
4541< This function is not available in the |sandbox|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004542 Not available on all systems. To check use: >
4543 :if exists("*mkdir")
4544<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545 *mode()*
Bram Moolenaar446cb832008-06-24 21:56:24 +00004546mode([expr]) Return a string that indicates the current mode.
Bram Moolenaar05bb9532008-07-04 09:44:11 +00004547 If [expr] is supplied and it evaluates to a non-zero Number or
4548 a non-empty String (|non-zero-arg|), then the full mode is
4549 returned, otherwise only the first letter is returned. Note
4550 that " " and "0" are also non-empty strings.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004551
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 n Normal
Bram Moolenaar446cb832008-06-24 21:56:24 +00004553 no Operator-pending
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 v Visual by character
4555 V Visual by line
4556 CTRL-V Visual blockwise
4557 s Select by character
4558 S Select by line
4559 CTRL-S Select blockwise
4560 i Insert
Bram Moolenaar446cb832008-06-24 21:56:24 +00004561 R Replace |R|
4562 Rv Virtual Replace |gR|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563 c Command-line
Bram Moolenaar446cb832008-06-24 21:56:24 +00004564 cv Vim Ex mode |gQ|
4565 ce Normal Ex mode |Q|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566 r Hit-enter prompt
Bram Moolenaar446cb832008-06-24 21:56:24 +00004567 rm The -- more -- prompt
4568 r? A |:confirm| query of some sort
4569 ! Shell or external command is executing
4570 This is useful in the 'statusline' option or when used
4571 with |remote_expr()| In most other places it always returns
4572 "c" or "n".
4573 Also see |visualmode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574
Bram Moolenaar7e506b62010-01-19 15:55:06 +01004575mzeval({expr}) *mzeval()*
4576 Evaluate MzScheme expression {expr} and return its result
Bram Moolenaard38b0552012-04-25 19:07:41 +02004577 converted to Vim data structures.
Bram Moolenaar7e506b62010-01-19 15:55:06 +01004578 Numbers and strings are returned as they are.
4579 Pairs (including lists and improper lists) and vectors are
4580 returned as Vim |Lists|.
4581 Hash tables are represented as Vim |Dictionary| type with keys
4582 converted to strings.
4583 All other types are converted to string with display function.
4584 Examples: >
4585 :mz (define l (list 1 2 3))
4586 :mz (define h (make-hash)) (hash-set! h "list" l)
4587 :echo mzeval("l")
4588 :echo mzeval("h")
4589<
4590 {only available when compiled with the |+mzscheme| feature}
4591
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592nextnonblank({lnum}) *nextnonblank()*
4593 Return the line number of the first line at or below {lnum}
4594 that is not blank. Example: >
4595 if getline(nextnonblank(1)) =~ "Java"
4596< When {lnum} is invalid or there is no non-blank line at or
4597 below it, zero is returned.
4598 See also |prevnonblank()|.
4599
Bram Moolenaard35d7842013-01-23 17:17:10 +01004600nr2char({expr}[, {utf8}]) *nr2char()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 Return a string with a single character, which has the number
4602 value {expr}. Examples: >
4603 nr2char(64) returns "@"
4604 nr2char(32) returns " "
Bram Moolenaard35d7842013-01-23 17:17:10 +01004605< When {utf8} is omitted or zero, the current 'encoding' is used.
4606 Example for "utf-8": >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 nr2char(300) returns I with bow character
Bram Moolenaard35d7842013-01-23 17:17:10 +01004608< With {utf8} set to 1, always return utf-8 characters.
4609 Note that a NUL character in the file is specified with
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610 nr2char(10), because NULs are represented with newline
4611 characters. nr2char(0) is a real NUL and terminates the
Bram Moolenaar383f9bc2005-01-19 22:18:32 +00004612 string, thus results in an empty string.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613
Bram Moolenaard6e256c2011-12-14 15:32:50 +01004614or({expr}, {expr}) *or()*
4615 Bitwise OR on the two arguments. The arguments are converted
4616 to a number. A List, Dict or Float argument causes an error.
4617 Example: >
4618 :let bits = or(bits, 0x80)
4619
4620
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004621pathshorten({expr}) *pathshorten()*
4622 Shorten directory names in the path {expr} and return the
4623 result. The tail, the file name, is kept as-is. The other
4624 components in the path are reduced to single letters. Leading
4625 '~' and '.' characters are kept. Example: >
4626 :echo pathshorten('~/.vim/autoload/myfile.vim')
4627< ~/.v/a/myfile.vim ~
4628 It doesn't matter if the path exists or not.
4629
Bram Moolenaar446cb832008-06-24 21:56:24 +00004630pow({x}, {y}) *pow()*
4631 Return the power of {x} to the exponent {y} as a |Float|.
4632 {x} and {y} must evaluate to a |Float| or a |Number|.
4633 Examples: >
4634 :echo pow(3, 3)
4635< 27.0 >
4636 :echo pow(2, 16)
4637< 65536.0 >
4638 :echo pow(32, 0.20)
4639< 2.0
4640 {only available when compiled with the |+float| feature}
4641
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00004642prevnonblank({lnum}) *prevnonblank()*
4643 Return the line number of the first line at or above {lnum}
4644 that is not blank. Example: >
4645 let ind = indent(prevnonblank(v:lnum - 1))
4646< When {lnum} is invalid or there is no non-blank line at or
4647 above it, zero is returned.
4648 Also see |nextnonblank()|.
4649
4650
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004651printf({fmt}, {expr1} ...) *printf()*
4652 Return a String with {fmt}, where "%" items are replaced by
4653 the formatted form of their respective arguments. Example: >
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004654 printf("%4d: E%d %.30s", lnum, errno, msg)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004655< May result in:
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004656 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004657
4658 Often used items are:
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004659 %s string
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004660 %6S string right-aligned in 6 display cells
Bram Moolenaar98692072006-02-04 00:57:42 +00004661 %6s string right-aligned in 6 bytes
Bram Moolenaar446cb832008-06-24 21:56:24 +00004662 %.9s string truncated to 9 bytes
4663 %c single byte
4664 %d decimal number
4665 %5d decimal number padded with spaces to 5 characters
4666 %x hex number
4667 %04x hex number padded with zeros to at least 4 characters
4668 %X hex number using upper case letters
4669 %o octal number
4670 %f floating point number in the form 123.456
4671 %e floating point number in the form 1.234e3
4672 %E floating point number in the form 1.234E3
4673 %g floating point number, as %f or %e depending on value
4674 %G floating point number, as %f or %E depending on value
4675 %% the % character itself
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004676
4677 Conversion specifications start with '%' and end with the
4678 conversion type. All other characters are copied unchanged to
4679 the result.
4680
4681 The "%" starts a conversion specification. The following
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004682 arguments appear in sequence:
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004683
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004684 % [flags] [field-width] [.precision] type
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004685
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004686 flags
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004687 Zero or more of the following flags:
4688
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004689 # The value should be converted to an "alternate
4690 form". For c, d, and s conversions, this option
4691 has no effect. For o conversions, the precision
4692 of the number is increased to force the first
4693 character of the output string to a zero (except
4694 if a zero value is printed with an explicit
4695 precision of zero).
4696 For x and X conversions, a non-zero result has
4697 the string "0x" (or "0X" for X conversions)
4698 prepended to it.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004699
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004700 0 (zero) Zero padding. For all conversions the converted
4701 value is padded on the left with zeros rather
4702 than blanks. If a precision is given with a
4703 numeric conversion (d, o, x, and X), the 0 flag
4704 is ignored.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004705
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004706 - A negative field width flag; the converted value
4707 is to be left adjusted on the field boundary.
4708 The converted value is padded on the right with
4709 blanks, rather than on the left with blanks or
4710 zeros. A - overrides a 0 if both are given.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004711
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004712 ' ' (space) A blank should be left before a positive
4713 number produced by a signed conversion (d).
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004714
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004715 + A sign must always be placed before a number
Bram Moolenaar446cb832008-06-24 21:56:24 +00004716 produced by a signed conversion. A + overrides
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004717 a space if both are used.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004718
4719 field-width
4720 An optional decimal digit string specifying a minimum
Bram Moolenaar98692072006-02-04 00:57:42 +00004721 field width. If the converted value has fewer bytes
4722 than the field width, it will be padded with spaces on
4723 the left (or right, if the left-adjustment flag has
4724 been given) to fill out the field width.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004725
4726 .precision
4727 An optional precision, in the form of a period '.'
4728 followed by an optional digit string. If the digit
4729 string is omitted, the precision is taken as zero.
4730 This gives the minimum number of digits to appear for
4731 d, o, x, and X conversions, or the maximum number of
Bram Moolenaar98692072006-02-04 00:57:42 +00004732 bytes to be printed from a string for s conversions.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004733 For floating point it is the number of digits after
4734 the decimal point.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004735
4736 type
4737 A character that specifies the type of conversion to
4738 be applied, see below.
4739
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004740 A field width or precision, or both, may be indicated by an
4741 asterisk '*' instead of a digit string. In this case, a
Bram Moolenaar446cb832008-06-24 21:56:24 +00004742 Number argument supplies the field width or precision. A
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004743 negative field width is treated as a left adjustment flag
4744 followed by a positive field width; a negative precision is
4745 treated as though it were missing. Example: >
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004746 :echo printf("%d: %.*s", nr, width, line)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004747< This limits the length of the text used from "line" to
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004748 "width" bytes.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004749
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004750 The conversion specifiers and their meanings are:
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004751
Bram Moolenaar446cb832008-06-24 21:56:24 +00004752 *printf-d* *printf-o* *printf-x* *printf-X*
4753 doxX The Number argument is converted to signed decimal
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004754 (d), unsigned octal (o), or unsigned hexadecimal (x
4755 and X) notation. The letters "abcdef" are used for
4756 x conversions; the letters "ABCDEF" are used for X
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004757 conversions.
4758 The precision, if any, gives the minimum number of
4759 digits that must appear; if the converted value
4760 requires fewer digits, it is padded on the left with
4761 zeros.
4762 In no case does a non-existent or small field width
4763 cause truncation of a numeric field; if the result of
4764 a conversion is wider than the field width, the field
4765 is expanded to contain the conversion result.
4766
Bram Moolenaar446cb832008-06-24 21:56:24 +00004767 *printf-c*
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004768 c The Number argument is converted to a byte, and the
4769 resulting character is written.
4770
Bram Moolenaar446cb832008-06-24 21:56:24 +00004771 *printf-s*
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004772 s The text of the String argument is used. If a
4773 precision is specified, no more bytes than the number
4774 specified are used.
Bram Moolenaar0122c402015-02-03 19:13:34 +01004775 *printf-S*
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01004776 S The text of the String argument is used. If a
4777 precision is specified, no more display cells than the
4778 number specified are used. Without the |+multi_byte|
4779 feature works just like 's'.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004780
Bram Moolenaar446cb832008-06-24 21:56:24 +00004781 *printf-f* *E807*
4782 f The Float argument is converted into a string of the
4783 form 123.456. The precision specifies the number of
4784 digits after the decimal point. When the precision is
4785 zero the decimal point is omitted. When the precision
4786 is not specified 6 is used. A really big number
4787 (out of range or dividing by zero) results in "inf".
4788 "0.0 / 0.0" results in "nan".
4789 Example: >
4790 echo printf("%.2f", 12.115)
4791< 12.12
4792 Note that roundoff depends on the system libraries.
4793 Use |round()| when in doubt.
4794
4795 *printf-e* *printf-E*
4796 e E The Float argument is converted into a string of the
4797 form 1.234e+03 or 1.234E+03 when using 'E'. The
4798 precision specifies the number of digits after the
4799 decimal point, like with 'f'.
4800
4801 *printf-g* *printf-G*
4802 g G The Float argument is converted like with 'f' if the
4803 value is between 0.001 (inclusive) and 10000000.0
4804 (exclusive). Otherwise 'e' is used for 'g' and 'E'
4805 for 'G'. When no precision is specified superfluous
4806 zeroes and '+' signs are removed, except for the zero
4807 immediately after the decimal point. Thus 10000000.0
4808 results in 1.0e7.
4809
4810 *printf-%*
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004811 % A '%' is written. No argument is converted. The
4812 complete conversion specification is "%%".
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004813
Bram Moolenaarc236c162008-07-13 17:41:49 +00004814 When a Number argument is expected a String argument is also
4815 accepted and automatically converted.
4816 When a Float or String argument is expected a Number argument
4817 is also accepted and automatically converted.
4818 Any other argument type results in an error message.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004819
Bram Moolenaar83bab712005-08-01 21:58:57 +00004820 *E766* *E767*
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004821 The number of {exprN} arguments must exactly match the number
4822 of "%" items. If there are not sufficient or too many
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00004823 arguments an error is given. Up to 18 arguments can be used.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00004824
4825
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00004826pumvisible() *pumvisible()*
4827 Returns non-zero when the popup menu is visible, zero
4828 otherwise. See |ins-completion-menu|.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00004829 This can be used to avoid some things that would remove the
4830 popup menu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831
Bram Moolenaare6ae6222013-05-21 21:01:10 +02004832 *E860*
Bram Moolenaar30b65812012-07-12 22:01:11 +02004833py3eval({expr}) *py3eval()*
4834 Evaluate Python expression {expr} and return its result
4835 converted to Vim data structures.
4836 Numbers and strings are returned as they are (strings are
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01004837 copied though, Unicode strings are additionally converted to
Bram Moolenaar30b65812012-07-12 22:01:11 +02004838 'encoding').
4839 Lists are represented as Vim |List| type.
4840 Dictionaries are represented as Vim |Dictionary| type with
4841 keys converted to strings.
4842 {only available when compiled with the |+python3| feature}
4843
4844 *E858* *E859*
4845pyeval({expr}) *pyeval()*
4846 Evaluate Python expression {expr} and return its result
4847 converted to Vim data structures.
4848 Numbers and strings are returned as they are (strings are
4849 copied though).
4850 Lists are represented as Vim |List| type.
Bram Moolenaard09acef2012-09-21 14:54:30 +02004851 Dictionaries are represented as Vim |Dictionary| type,
4852 non-string keys result in error.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004853 {only available when compiled with the |+python| feature}
4854
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00004855 *E726* *E727*
Bram Moolenaard8b02732005-01-14 21:48:43 +00004856range({expr} [, {max} [, {stride}]]) *range()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004857 Returns a |List| with Numbers:
Bram Moolenaard8b02732005-01-14 21:48:43 +00004858 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
4859 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
4860 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
4861 {max}] (increasing {expr} with {stride} each time, not
4862 producing a value past {max}).
Bram Moolenaare7566042005-06-17 22:00:15 +00004863 When the maximum is one before the start the result is an
4864 empty list. When the maximum is more than one before the
4865 start this is an error.
Bram Moolenaard8b02732005-01-14 21:48:43 +00004866 Examples: >
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004867 range(4) " [0, 1, 2, 3]
Bram Moolenaard8b02732005-01-14 21:48:43 +00004868 range(2, 4) " [2, 3, 4]
4869 range(2, 9, 3) " [2, 5, 8]
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004870 range(2, -2, -1) " [2, 1, 0, -1, -2]
Bram Moolenaare7566042005-06-17 22:00:15 +00004871 range(0) " []
4872 range(2, 0) " error!
Bram Moolenaard8b02732005-01-14 21:48:43 +00004873<
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00004874 *readfile()*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004875readfile({fname} [, {binary} [, {max}]])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004876 Read file {fname} and return a |List|, each line of the file
4877 as an item. Lines broken at NL characters. Macintosh files
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00004878 separated with CR will result in a single long line (unless a
4879 NL appears somewhere).
Bram Moolenaar06583f12010-08-07 20:30:49 +02004880 All NUL characters are replaced with a NL character.
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01004881 When {binary/append} contains "b" binary mode is used:
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00004882 - When the last line ends in a NL an extra empty list item is
4883 added.
4884 - No CR characters are removed.
4885 Otherwise:
4886 - CR characters that appear before a NL are removed.
4887 - Whether the last line ends in a NL or not does not matter.
Bram Moolenaar06583f12010-08-07 20:30:49 +02004888 - When 'encoding' is Unicode any UTF-8 byte order mark is
4889 removed from the text.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004890 When {max} is given this specifies the maximum number of lines
4891 to be read. Useful if you only want to check the first ten
4892 lines of a file: >
4893 :for line in readfile(fname, '', 10)
4894 : if line =~ 'Date' | echo line | endif
4895 :endfor
Bram Moolenaar582fd852005-03-28 20:58:01 +00004896< When {max} is negative -{max} lines from the end of the file
4897 are returned, or as many as there are.
4898 When {max} is zero the result is an empty list.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004899 Note that without {max} the whole file is read into memory.
4900 Also note that there is no recognition of encoding. Read a
4901 file into a buffer if you need to.
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00004902 When the file can't be opened an error message is given and
4903 the result is an empty list.
4904 Also see |writefile()|.
4905
Bram Moolenaar433f7c82006-03-21 21:29:36 +00004906reltime([{start} [, {end}]]) *reltime()*
4907 Return an item that represents a time value. The format of
4908 the item depends on the system. It can be passed to
4909 |reltimestr()| to convert it to a string.
4910 Without an argument it returns the current time.
4911 With one argument is returns the time passed since the time
4912 specified in the argument.
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00004913 With two arguments it returns the time passed between {start}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00004914 and {end}.
4915 The {start} and {end} arguments must be values returned by
4916 reltime().
Bram Moolenaardb84e452010-08-15 13:50:43 +02004917 {only available when compiled with the |+reltime| feature}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00004918
4919reltimestr({time}) *reltimestr()*
4920 Return a String that represents the time value of {time}.
4921 This is the number of seconds, a dot and the number of
4922 microseconds. Example: >
4923 let start = reltime()
4924 call MyFunction()
4925 echo reltimestr(reltime(start))
4926< Note that overhead for the commands will be added to the time.
4927 The accuracy depends on the system.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00004928 Leading spaces are used to make the string align nicely. You
4929 can use split() to remove it. >
4930 echo split(reltimestr(reltime(start)))[0]
4931< Also see |profiling|.
Bram Moolenaardb84e452010-08-15 13:50:43 +02004932 {only available when compiled with the |+reltime| feature}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00004933
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934 *remote_expr()* *E449*
4935remote_expr({server}, {string} [, {idvar}])
Bram Moolenaar446cb832008-06-24 21:56:24 +00004936 Send the {string} to {server}. The string is sent as an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937 expression and the result is returned after evaluation.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004938 The result must be a String or a |List|. A |List| is turned
4939 into a String by joining the items with a line break in
4940 between (not at the end), like with join(expr, "\n").
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941 If {idvar} is present, it is taken as the name of a
4942 variable and a {serverid} for later use with
4943 remote_read() is stored there.
4944 See also |clientserver| |RemoteReply|.
4945 This function is not available in the |sandbox|.
4946 {only available when compiled with the |+clientserver| feature}
4947 Note: Any errors will cause a local error message to be issued
4948 and the result will be the empty string.
4949 Examples: >
4950 :echo remote_expr("gvim", "2+2")
4951 :echo remote_expr("gvim1", "b:current_syntax")
4952<
4953
4954remote_foreground({server}) *remote_foreground()*
4955 Move the Vim server with the name {server} to the foreground.
4956 This works like: >
4957 remote_expr({server}, "foreground()")
4958< Except that on Win32 systems the client does the work, to work
4959 around the problem that the OS doesn't always allow the server
4960 to bring itself to the foreground.
Bram Moolenaar9372a112005-12-06 19:59:18 +00004961 Note: This does not restore the window if it was minimized,
4962 like foreground() does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004963 This function is not available in the |sandbox|.
4964 {only in the Win32, Athena, Motif and GTK GUI versions and the
4965 Win32 console version}
4966
4967
4968remote_peek({serverid} [, {retvar}]) *remote_peek()*
4969 Returns a positive number if there are available strings
4970 from {serverid}. Copies any reply string into the variable
Bram Moolenaar446cb832008-06-24 21:56:24 +00004971 {retvar} if specified. {retvar} must be a string with the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972 name of a variable.
4973 Returns zero if none are available.
4974 Returns -1 if something is wrong.
4975 See also |clientserver|.
4976 This function is not available in the |sandbox|.
4977 {only available when compiled with the |+clientserver| feature}
4978 Examples: >
4979 :let repl = ""
4980 :echo "PEEK: ".remote_peek(id, "repl").": ".repl
4981
4982remote_read({serverid}) *remote_read()*
4983 Return the oldest available reply from {serverid} and consume
4984 it. It blocks until a reply is available.
4985 See also |clientserver|.
4986 This function is not available in the |sandbox|.
4987 {only available when compiled with the |+clientserver| feature}
4988 Example: >
4989 :echo remote_read(id)
4990<
4991 *remote_send()* *E241*
4992remote_send({server}, {string} [, {idvar}])
Bram Moolenaar446cb832008-06-24 21:56:24 +00004993 Send the {string} to {server}. The string is sent as input
Bram Moolenaard4755bb2004-09-02 19:12:26 +00004994 keys and the function returns immediately. At the Vim server
4995 the keys are not mapped |:map|.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00004996 If {idvar} is present, it is taken as the name of a variable
4997 and a {serverid} for later use with remote_read() is stored
4998 there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 See also |clientserver| |RemoteReply|.
5000 This function is not available in the |sandbox|.
5001 {only available when compiled with the |+clientserver| feature}
5002 Note: Any errors will be reported in the server and may mess
5003 up the display.
5004 Examples: >
5005 :echo remote_send("gvim", ":DropAndReply ".file, "serverid").
5006 \ remote_read(serverid)
5007
5008 :autocmd NONE RemoteReply *
5009 \ echo remote_read(expand("<amatch>"))
5010 :echo remote_send("gvim", ":sleep 10 | echo ".
5011 \ 'server2client(expand("<client>"), "HELLO")<CR>')
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005012<
Bram Moolenaarde8866b2005-01-06 23:24:37 +00005013remove({list}, {idx} [, {end}]) *remove()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005014 Without {end}: Remove the item at {idx} from |List| {list} and
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005015 return the item.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00005016 With {end}: Remove items from {idx} to {end} (inclusive) and
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005017 return a List with these items. When {idx} points to the same
Bram Moolenaarde8866b2005-01-06 23:24:37 +00005018 item as {end} a list with one item is returned. When {end}
5019 points to an item before {idx} this is an error.
5020 See |list-index| for possible values of {idx} and {end}.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00005021 Example: >
5022 :echo "last item: " . remove(mylist, -1)
Bram Moolenaarde8866b2005-01-06 23:24:37 +00005023 :call remove(mylist, 0, 9)
Bram Moolenaard8b02732005-01-14 21:48:43 +00005024remove({dict}, {key})
5025 Remove the entry from {dict} with key {key}. Example: >
5026 :echo "removed " . remove(dict, "one")
5027< If there is no {key} in {dict} this is an error.
5028
5029 Use |delete()| to remove a file.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00005030
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031rename({from}, {to}) *rename()*
5032 Rename the file by the name {from} to the name {to}. This
5033 should also work to move files across file systems. The
5034 result is a Number, which is 0 if the file was renamed
5035 successfully, and non-zero when the renaming failed.
Bram Moolenaar798b30b2009-04-22 10:56:16 +00005036 NOTE: If {to} exists it is overwritten without warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005037 This function is not available in the |sandbox|.
5038
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00005039repeat({expr}, {count}) *repeat()*
5040 Repeat {expr} {count} times and return the concatenated
5041 result. Example: >
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00005042 :let separator = repeat('-', 80)
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00005043< When {count} is zero or negative the result is empty.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005044 When {expr} is a |List| the result is {expr} concatenated
Bram Moolenaar446cb832008-06-24 21:56:24 +00005045 {count} times. Example: >
Bram Moolenaarde8866b2005-01-06 23:24:37 +00005046 :let longlist = repeat(['a', 'b'], 3)
5047< Results in ['a', 'b', 'a', 'b', 'a', 'b'].
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00005048
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005049
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050resolve({filename}) *resolve()* *E655*
5051 On MS-Windows, when {filename} is a shortcut (a .lnk file),
5052 returns the path the shortcut points to in a simplified form.
5053 On Unix, repeat resolving symbolic links in all path
5054 components of {filename} and return the simplified result.
5055 To cope with link cycles, resolving of symbolic links is
5056 stopped after 100 iterations.
5057 On other systems, return the simplified {filename}.
5058 The simplification step is done as by |simplify()|.
5059 resolve() keeps a leading path component specifying the
5060 current directory (provided the result is still a relative
5061 path name) and also keeps a trailing path separator.
5062
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005063 *reverse()*
Bram Moolenaar446cb832008-06-24 21:56:24 +00005064reverse({list}) Reverse the order of items in {list} in-place. Returns
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005065 {list}.
5066 If you want a list to remain unmodified make a copy first: >
5067 :let revlist = reverse(copy(mylist))
5068
Bram Moolenaar446cb832008-06-24 21:56:24 +00005069round({expr}) *round()*
Bram Moolenaarc236c162008-07-13 17:41:49 +00005070 Round off {expr} to the nearest integral value and return it
Bram Moolenaar446cb832008-06-24 21:56:24 +00005071 as a |Float|. If {expr} lies halfway between two integral
5072 values, then use the larger one (away from zero).
5073 {expr} must evaluate to a |Float| or a |Number|.
5074 Examples: >
5075 echo round(0.456)
5076< 0.0 >
5077 echo round(4.5)
5078< 5.0 >
5079 echo round(-4.5)
5080< -5.0
5081 {only available when compiled with the |+float| feature}
Bram Moolenaar34feacb2012-12-05 19:01:43 +01005082
Bram Moolenaar9a773482013-06-11 18:40:13 +02005083screenattr(row, col) *screenattr()*
5084 Like screenchar(), but return the attribute. This is a rather
5085 arbitrary number that can only be used to compare to the
5086 attribute at other positions.
5087
5088screenchar(row, col) *screenchar()*
5089 The result is a Number, which is the character at position
5090 [row, col] on the screen. This works for every possible
5091 screen position, also status lines, window separators and the
5092 command line. The top left position is row one, column one
5093 The character excludes composing characters. For double-byte
5094 encodings it may only be the first byte.
5095 This is mainly to be used for testing.
5096 Returns -1 when row or col is out of range.
5097
Bram Moolenaar34feacb2012-12-05 19:01:43 +01005098screencol() *screencol()*
5099 The result is a Number, which is the current screen column of
5100 the cursor. The leftmost column has number 1.
5101 This function is mainly used for testing.
5102
5103 Note: Always returns the current screen column, thus if used
5104 in a command (e.g. ":echo screencol()") it will return the
5105 column inside the command line, which is 1 when the command is
5106 executed. To get the cursor position in the file use one of
5107 the following mappings: >
5108 nnoremap <expr> GG ":echom ".screencol()."\n"
5109 nnoremap <silent> GG :echom screencol()<CR>
5110<
5111screenrow() *screenrow()*
5112 The result is a Number, which is the current screen row of the
5113 cursor. The top line has number one.
5114 This function is mainly used for testing.
5115
5116 Note: Same restrictions as with |screencol()|.
5117
Bram Moolenaar76929292008-01-06 19:07:36 +00005118search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 Search for regexp pattern {pattern}. The search starts at the
Bram Moolenaar383f9bc2005-01-19 22:18:32 +00005120 cursor position (you can use |cursor()| to set it).
Bram Moolenaar65c923a2006-03-03 22:56:30 +00005121
Bram Moolenaar2df58b42012-11-28 18:21:11 +01005122 When a match has been found its line number is returned.
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01005123 If there is no match a 0 is returned and the cursor doesn't
5124 move. No error message is given.
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01005125
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126 {flags} is a String, which can contain these character flags:
5127 'b' search backward instead of forward
Bram Moolenaar446cb832008-06-24 21:56:24 +00005128 'c' accept a match at the cursor position
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00005129 'e' move to the End of the match
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005130 'n' do Not move the cursor
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00005131 'p' return number of matching sub-pattern (see below)
5132 's' set the ' mark at the previous location of the cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133 'w' wrap around the end of the file
5134 'W' don't wrap around the end of the file
5135 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
5136
Bram Moolenaar02743632005-07-25 20:42:36 +00005137 If the 's' flag is supplied, the ' mark is set, only if the
5138 cursor is moved. The 's' flag cannot be combined with the 'n'
5139 flag.
5140
Bram Moolenaaref2f6562007-05-06 13:32:59 +00005141 'ignorecase', 'smartcase' and 'magic' are used.
5142
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005143 When the {stopline} argument is given then the search stops
5144 after searching this line. This is useful to restrict the
5145 search to a range of lines. Examples: >
5146 let match = search('(', 'b', line("w0"))
5147 let end = search('END', '', line("w$"))
5148< When {stopline} is used and it is not zero this also implies
5149 that the search does not wrap around the end of the file.
Bram Moolenaar76929292008-01-06 19:07:36 +00005150 A zero value is equal to not giving the argument.
5151
5152 When the {timeout} argument is given the search stops when
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02005153 more than this many milliseconds have passed. Thus when
Bram Moolenaar76929292008-01-06 19:07:36 +00005154 {timeout} is 500 the search stops after half a second.
5155 The value must not be negative. A zero value is like not
5156 giving the argument.
Bram Moolenaardb84e452010-08-15 13:50:43 +02005157 {only available when compiled with the |+reltime| feature}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005158
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005159 *search()-sub-match*
5160 With the 'p' flag the returned value is one more than the
5161 first sub-match in \(\). One if none of them matched but the
5162 whole pattern did match.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005163 To get the column number too use |searchpos()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00005165 The cursor will be positioned at the match, unless the 'n'
5166 flag is used.
5167
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 Example (goes over all files in the argument list): >
5169 :let n = 1
5170 :while n <= argc() " loop over all files in arglist
5171 : exe "argument " . n
5172 : " start at the last char in the file and wrap for the
5173 : " first search to find match at start of file
5174 : normal G$
5175 : let flags = "w"
5176 : while search("foo", flags) > 0
Bram Moolenaar446cb832008-06-24 21:56:24 +00005177 : s/foo/bar/g
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178 : let flags = "W"
5179 : endwhile
5180 : update " write the file if modified
5181 : let n = n + 1
5182 :endwhile
5183<
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00005184 Example for using some flags: >
5185 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
5186< This will search for the keywords "if", "else", and "endif"
5187 under or after the cursor. Because of the 'p' flag, it
5188 returns 1, 2, or 3 depending on which keyword is found, or 0
5189 if the search fails. With the cursor on the first word of the
5190 line:
5191 if (foo == 0) | let foo = foo + 1 | endif ~
5192 the function returns 1. Without the 'c' flag, the function
5193 finds the "endif" and returns 3. The same thing happens
5194 without the 'e' flag if the cursor is on the "f" of "if".
5195 The 'n' flag tells the function not to move the cursor.
5196
Bram Moolenaar92d640f2005-09-05 22:11:52 +00005197
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005198searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()*
5199 Search for the declaration of {name}.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005200
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005201 With a non-zero {global} argument it works like |gD|, find
5202 first match in the file. Otherwise it works like |gd|, find
5203 first match in the function.
5204
5205 With a non-zero {thisblock} argument matches in a {} block
5206 that ends before the cursor position are ignored. Avoids
5207 finding variable declarations only valid in another scope.
5208
Bram Moolenaar92d640f2005-09-05 22:11:52 +00005209 Moves the cursor to the found match.
5210 Returns zero for success, non-zero for failure.
5211 Example: >
5212 if searchdecl('myvar') == 0
5213 echo getline('.')
5214 endif
5215<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216 *searchpair()*
Bram Moolenaar76929292008-01-06 19:07:36 +00005217searchpair({start}, {middle}, {end} [, {flags} [, {skip}
5218 [, {stopline} [, {timeout}]]]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00005219 Search for the match of a nested start-end pair. This can be
5220 used to find the "endif" that matches an "if", while other
5221 if/endif pairs in between are ignored.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005222 The search starts at the cursor. The default is to search
5223 forward, include 'b' in {flags} to search backward.
5224 If a match is found, the cursor is positioned at it and the
5225 line number is returned. If no match is found 0 or -1 is
5226 returned and the cursor doesn't move. No error message is
5227 given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228
5229 {start}, {middle} and {end} are patterns, see |pattern|. They
5230 must not contain \( \) pairs. Use of \%( \) is allowed. When
5231 {middle} is not empty, it is found when searching from either
5232 direction, but only when not in a nested start-end pair. A
5233 typical use is: >
5234 searchpair('\<if\>', '\<else\>', '\<endif\>')
5235< By leaving {middle} empty the "else" is skipped.
5236
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00005237 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
5238 |search()|. Additionally:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005239 'r' Repeat until no more matches found; will find the
Bram Moolenaar446cb832008-06-24 21:56:24 +00005240 outer pair. Implies the 'W' flag.
5241 'm' Return number of matches instead of line number with
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00005242 the match; will be > 1 when 'r' is used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005243 Note: it's nearly always a good idea to use the 'W' flag, to
5244 avoid wrapping around the end of the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245
5246 When a match for {start}, {middle} or {end} is found, the
5247 {skip} expression is evaluated with the cursor positioned on
5248 the start of the match. It should return non-zero if this
5249 match is to be skipped. E.g., because it is inside a comment
5250 or a string.
5251 When {skip} is omitted or empty, every match is accepted.
5252 When evaluating {skip} causes an error the search is aborted
5253 and -1 returned.
5254
Bram Moolenaar76929292008-01-06 19:07:36 +00005255 For {stopline} and {timeout} see |search()|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005256
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257 The value of 'ignorecase' is used. 'magic' is ignored, the
5258 patterns are used like it's on.
5259
5260 The search starts exactly at the cursor. A match with
5261 {start}, {middle} or {end} at the next character, in the
5262 direction of searching, is the first one found. Example: >
5263 if 1
5264 if 2
5265 endif 2
5266 endif 1
5267< When starting at the "if 2", with the cursor on the "i", and
5268 searching forwards, the "endif 2" is found. When starting on
5269 the character just before the "if 2", the "endif 1" will be
Bram Moolenaar446cb832008-06-24 21:56:24 +00005270 found. That's because the "if 2" will be found first, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271 then this is considered to be a nested if/endif from "if 2" to
5272 "endif 2".
5273 When searching backwards and {end} is more than one character,
5274 it may be useful to put "\zs" at the end of the pattern, so
5275 that when the cursor is inside a match with the end it finds
5276 the matching start.
5277
5278 Example, to find the "endif" command in a Vim script: >
5279
5280 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
5281 \ 'getline(".") =~ "^\\s*\""')
5282
5283< The cursor must be at or after the "if" for which a match is
5284 to be found. Note that single-quote strings are used to avoid
5285 having to double the backslashes. The skip expression only
5286 catches comments at the start of a line, not after a command.
5287 Also, a word "en" or "if" halfway a line is considered a
5288 match.
5289 Another example, to search for the matching "{" of a "}": >
5290
5291 :echo searchpair('{', '', '}', 'bW')
5292
5293< This works when the cursor is at or before the "}" for which a
5294 match is to be found. To reject matches that syntax
5295 highlighting recognized as strings: >
5296
5297 :echo searchpair('{', '', '}', 'bW',
5298 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
5299<
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00005300 *searchpairpos()*
Bram Moolenaar76929292008-01-06 19:07:36 +00005301searchpairpos({start}, {middle}, {end} [, {flags} [, {skip}
5302 [, {stopline} [, {timeout}]]]])
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005303 Same as |searchpair()|, but returns a |List| with the line and
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005304 column position of the match. The first element of the |List|
5305 is the line number and the second element is the byte index of
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00005306 the column position of the match. If no match is found,
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02005307 returns [0, 0]. >
5308
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00005309 :let [lnum,col] = searchpairpos('{', '', '}', 'n')
5310<
5311 See |match-parens| for a bigger and more useful example.
5312
Bram Moolenaar76929292008-01-06 19:07:36 +00005313searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()*
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005314 Same as |search()|, but returns a |List| with the line and
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005315 column position of the match. The first element of the |List|
5316 is the line number and the second element is the byte index of
5317 the column position of the match. If no match is found,
5318 returns [0, 0].
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005319 Example: >
5320 :let [lnum, col] = searchpos('mypattern', 'n')
5321
5322< When the 'p' flag is given then there is an extra item with
5323 the sub-pattern match number |search()-sub-match|. Example: >
5324 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
5325< In this example "submatch" is 2 when a lowercase letter is
5326 found |/\l|, 3 when an uppercase letter is found |/\u|.
5327
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328server2client( {clientid}, {string}) *server2client()*
5329 Send a reply string to {clientid}. The most recent {clientid}
5330 that sent a string can be retrieved with expand("<client>").
5331 {only available when compiled with the |+clientserver| feature}
5332 Note:
5333 This id has to be stored before the next command can be
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005334 received. I.e. before returning from the received command and
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335 before calling any commands that waits for input.
5336 See also |clientserver|.
5337 Example: >
5338 :echo server2client(expand("<client>"), "HELLO")
5339<
5340serverlist() *serverlist()*
5341 Return a list of available server names, one per line.
5342 When there are no servers or the information is not available
5343 an empty string is returned. See also |clientserver|.
5344 {only available when compiled with the |+clientserver| feature}
5345 Example: >
5346 :echo serverlist()
5347<
5348setbufvar({expr}, {varname}, {val}) *setbufvar()*
5349 Set option or local variable {varname} in buffer {expr} to
5350 {val}.
5351 This also works for a global or local window option, but it
5352 doesn't work for a global or local window variable.
5353 For a local window option the global value is unchanged.
5354 For the use of {expr}, see |bufname()| above.
5355 Note that the variable name without "b:" must be used.
5356 Examples: >
5357 :call setbufvar(1, "&mod", 1)
5358 :call setbufvar("todo", "myvar", "foobar")
5359< This function is not available in the |sandbox|.
5360
5361setcmdpos({pos}) *setcmdpos()*
5362 Set the cursor position in the command line to byte position
Bram Moolenaar446cb832008-06-24 21:56:24 +00005363 {pos}. The first position is 1.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005364 Use |getcmdpos()| to obtain the current position.
5365 Only works while editing the command line, thus you must use
Bram Moolenaard8b02732005-01-14 21:48:43 +00005366 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For
5367 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is
5368 set after the command line is set to the expression. For
5369 |c_CTRL-R_=| it is set after evaluating the expression but
5370 before inserting the resulting text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371 When the number is too big the cursor is put at the end of the
5372 line. A number smaller than one has undefined results.
5373 Returns 0 when successful, 1 when not editing the command
5374 line.
5375
Bram Moolenaar446cb832008-06-24 21:56:24 +00005376setline({lnum}, {text}) *setline()*
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01005377 Set line {lnum} of the current buffer to {text}. To insert
5378 lines use |append()|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005379 {lnum} is used like with |getline()|.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005380 When {lnum} is just below the last line the {text} will be
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00005381 added as a new line.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005382 If this succeeds, 0 is returned. If this fails (most likely
5383 because {lnum} is invalid) 1 is returned. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384 :call setline(5, strftime("%c"))
Bram Moolenaar446cb832008-06-24 21:56:24 +00005385< When {text} is a |List| then line {lnum} and following lines
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00005386 will be set to the items in the list. Example: >
5387 :call setline(5, ['aaa', 'bbb', 'ccc'])
5388< This is equivalent to: >
Bram Moolenaar53bfca22012-04-13 23:04:47 +02005389 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']]
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00005390 : call setline(n, l)
5391 :endfor
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392< Note: The '[ and '] marks are not set.
5393
Bram Moolenaar17c7c012006-01-26 22:25:15 +00005394setloclist({nr}, {list} [, {action}]) *setloclist()*
5395 Create or replace or add to the location list for window {nr}.
5396 When {nr} is zero the current window is used. For a location
Bram Moolenaar280f1262006-01-30 00:14:18 +00005397 list window, the displayed location list is modified. For an
5398 invalid window number {nr}, -1 is returned.
Bram Moolenaar6ee10162007-07-26 20:58:42 +00005399 Otherwise, same as |setqflist()|.
5400 Also see |location-list|.
5401
5402setmatches({list}) *setmatches()*
5403 Restores a list of matches saved by |getmatches()|. Returns 0
Bram Moolenaar446cb832008-06-24 21:56:24 +00005404 if successful, otherwise -1. All current matches are cleared
Bram Moolenaar6ee10162007-07-26 20:58:42 +00005405 before the list is restored. See example for |getmatches()|.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005406
Bram Moolenaar65c923a2006-03-03 22:56:30 +00005407 *setpos()*
5408setpos({expr}, {list})
5409 Set the position for {expr}. Possible values:
5410 . the cursor
5411 'x mark x
5412
Bram Moolenaar493c1782014-05-28 14:34:46 +02005413 {list} must be a |List| with four or five numbers:
Bram Moolenaar65c923a2006-03-03 22:56:30 +00005414 [bufnum, lnum, col, off]
Bram Moolenaar493c1782014-05-28 14:34:46 +02005415 [bufnum, lnum, col, off, curswant]
Bram Moolenaar65c923a2006-03-03 22:56:30 +00005416
Bram Moolenaar446cb832008-06-24 21:56:24 +00005417 "bufnum" is the buffer number. Zero can be used for the
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005418 current buffer. Setting the cursor is only possible for
Bram Moolenaar65c923a2006-03-03 22:56:30 +00005419 the current buffer. To set a mark in another buffer you can
5420 use the |bufnr()| function to turn a file name into a buffer
5421 number.
Bram Moolenaardb552d602006-03-23 22:59:57 +00005422 Does not change the jumplist.
Bram Moolenaar65c923a2006-03-03 22:56:30 +00005423
5424 "lnum" and "col" are the position in the buffer. The first
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005425 column is 1. Use a zero "lnum" to delete a mark. If "col" is
5426 smaller than 1 then 1 is used.
Bram Moolenaar65c923a2006-03-03 22:56:30 +00005427
5428 The "off" number is only used when 'virtualedit' is set. Then
5429 it is the offset in screen columns from the start of the
Bram Moolenaard46bbc72007-05-12 14:38:41 +00005430 character. E.g., a position within a <Tab> or after the last
Bram Moolenaar65c923a2006-03-03 22:56:30 +00005431 character.
5432
Bram Moolenaar493c1782014-05-28 14:34:46 +02005433 The "curswant" number is only used when setting the cursor
5434 position. It sets the preferred column for when moving the
5435 cursor vertically. When the "curswant" number is missing the
5436 preferred column is not set. When it is present and setting a
5437 mark position it is not used.
5438
Bram Moolenaardfb18412013-12-11 18:53:29 +01005439 Note that for '< and '> changing the line number may result in
5440 the marks to be effectively be swapped, so that '< is always
5441 before '>.
5442
Bram Moolenaar08250432008-02-13 11:42:46 +00005443 Returns 0 when the position could be set, -1 otherwise.
5444 An error message is given if {expr} is invalid.
5445
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02005446 Also see |getpos()| and |getcurpos()|.
Bram Moolenaar65c923a2006-03-03 22:56:30 +00005447
Bram Moolenaaref2f6562007-05-06 13:32:59 +00005448 This does not restore the preferred column for moving
Bram Moolenaar493c1782014-05-28 14:34:46 +02005449 vertically; if you set the cursor position with this, |j| and
5450 |k| motions will jump to previous columns! Use |cursor()| to
5451 also set the preferred column. Also see the "curswant" key in
5452 |winrestview()|.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00005453
Bram Moolenaar65c923a2006-03-03 22:56:30 +00005454
Bram Moolenaar35c54e52005-05-20 21:25:31 +00005455setqflist({list} [, {action}]) *setqflist()*
Bram Moolenaar17c7c012006-01-26 22:25:15 +00005456 Create or replace or add to the quickfix list using the items
5457 in {list}. Each item in {list} is a dictionary.
5458 Non-dictionary items in {list} are ignored. Each dictionary
5459 item can contain the following entries:
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005460
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00005461 bufnr buffer number; must be the number of a valid
Bram Moolenaar446cb832008-06-24 21:56:24 +00005462 buffer
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00005463 filename name of a file; only used when "bufnr" is not
Bram Moolenaar446cb832008-06-24 21:56:24 +00005464 present or it is invalid.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005465 lnum line number in the file
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005466 pattern search pattern used to locate the error
Bram Moolenaar582fd852005-03-28 20:58:01 +00005467 col column number
5468 vcol when non-zero: "col" is visual column
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005469 when zero: "col" is byte index
Bram Moolenaar582fd852005-03-28 20:58:01 +00005470 nr error number
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005471 text description of the error
Bram Moolenaar582fd852005-03-28 20:58:01 +00005472 type single-character error type, 'E', 'W', etc.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005473
Bram Moolenaar582fd852005-03-28 20:58:01 +00005474 The "col", "vcol", "nr", "type" and "text" entries are
5475 optional. Either "lnum" or "pattern" entry can be used to
5476 locate a matching error line.
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00005477 If the "filename" and "bufnr" entries are not present or
5478 neither the "lnum" or "pattern" entries are present, then the
5479 item will not be handled as an error line.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005480 If both "pattern" and "lnum" are present then "pattern" will
5481 be used.
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005482 If you supply an empty {list}, the quickfix list will be
5483 cleared.
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00005484 Note that the list is not exactly the same as what
5485 |getqflist()| returns.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005486
Bram Moolenaar35c54e52005-05-20 21:25:31 +00005487 If {action} is set to 'a', then the items from {list} are
5488 added to the existing quickfix list. If there is no existing
5489 list, then a new list is created. If {action} is set to 'r',
5490 then the items from the current quickfix list are replaced
5491 with the items from {list}. If {action} is not present or is
5492 set to ' ', then a new list is created.
5493
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005494 Returns zero for success, -1 for failure.
5495
5496 This function can be used to create a quickfix list
5497 independent of the 'errorformat' setting. Use a command like
5498 ":cc 1" to jump to the first position.
5499
5500
Bram Moolenaar071d4272004-06-13 20:20:40 +00005501 *setreg()*
5502setreg({regname}, {value} [,{options}])
5503 Set the register {regname} to {value}.
Bram Moolenaar5a50c222014-04-02 22:17:10 +02005504 {value} may be any value returned by |getreg()|, including
5505 a |List|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506 If {options} contains "a" or {regname} is upper case,
5507 then the value is appended.
Bram Moolenaarc6485bc2010-07-28 17:02:55 +02005508 {options} can also contain a register type specification:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509 "c" or "v" |characterwise| mode
5510 "l" or "V" |linewise| mode
5511 "b" or "<CTRL-V>" |blockwise-visual| mode
5512 If a number immediately follows "b" or "<CTRL-V>" then this is
5513 used as the width of the selection - if it is not specified
5514 then the width of the block is set to the number of characters
Bram Moolenaard46bbc72007-05-12 14:38:41 +00005515 in the longest line (counting a <Tab> as 1 character).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516
5517 If {options} contains no register settings, then the default
Bram Moolenaar5a50c222014-04-02 22:17:10 +02005518 is to use character mode unless {value} ends in a <NL> for
5519 string {value} and linewise mode for list {value}. Blockwise
5520 mode is never selected automatically.
5521 Returns zero for success, non-zero for failure.
5522
5523 *E883*
Bram Moolenaar34401cc2014-08-29 15:12:19 +02005524 Note: you may not use |List| containing more than one item to
Bram Moolenaar5a50c222014-04-02 22:17:10 +02005525 set search and expression registers. Lists containing no
5526 items act like empty strings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005527
5528 Examples: >
5529 :call setreg(v:register, @*)
5530 :call setreg('*', @%, 'ac')
5531 :call setreg('a', "1\n2\n3", 'b5')
5532
5533< This example shows using the functions to save and restore a
Bram Moolenaar5a50c222014-04-02 22:17:10 +02005534 register (note: you may not reliably restore register value
5535 without using the third argument to |getreg()| as without it
5536 newlines are represented as newlines AND Nul bytes are
5537 represented as newlines as well, see |NL-used-for-Nul|). >
5538 :let var_a = getreg('a', 1, 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005539 :let var_amode = getregtype('a')
5540 ....
5541 :call setreg('a', var_a, var_amode)
5542
5543< You can also change the type of a register by appending
5544 nothing: >
5545 :call setreg('a', '', 'al')
5546
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005547settabvar({tabnr}, {varname}, {val}) *settabvar()*
5548 Set tab-local variable {varname} to {val} in tab page {tabnr}.
5549 |t:var|
5550 Note that the variable name without "t:" must be used.
5551 Tabs are numbered starting with one.
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005552 This function is not available in the |sandbox|.
5553
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00005554settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()*
5555 Set option or local variable {varname} in window {winnr} to
5556 {val}.
5557 Tabs are numbered starting with one. For the current tabpage
5558 use |setwinvar()|.
5559 When {winnr} is zero the current window is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 This also works for a global or local buffer option, but it
5561 doesn't work for a global or local buffer variable.
5562 For a local buffer option the global value is unchanged.
5563 Note that the variable name without "w:" must be used.
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00005564 Examples: >
5565 :call settabwinvar(1, 1, "&list", 0)
5566 :call settabwinvar(3, 2, "myvar", "foobar")
5567< This function is not available in the |sandbox|.
5568
5569setwinvar({nr}, {varname}, {val}) *setwinvar()*
5570 Like |settabwinvar()| for the current tab page.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 Examples: >
5572 :call setwinvar(1, "&list", 0)
5573 :call setwinvar(2, "myvar", "foobar")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574
Bram Moolenaaraf9aeb92013-02-13 17:35:04 +01005575sha256({string}) *sha256()*
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01005576 Returns a String with 64 hex characters, which is the SHA256
Bram Moolenaaraf9aeb92013-02-13 17:35:04 +01005577 checksum of {string}.
5578 {only available when compiled with the |+cryptv| feature}
5579
Bram Moolenaar05bb9532008-07-04 09:44:11 +00005580shellescape({string} [, {special}]) *shellescape()*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005581 Escape {string} for use as a shell command argument.
Bram Moolenaar60a495f2006-10-03 12:44:42 +00005582 On MS-Windows and MS-DOS, when 'shellslash' is not set, it
Bram Moolenaar05bb9532008-07-04 09:44:11 +00005583 will enclose {string} in double quotes and double all double
Bram Moolenaar60a495f2006-10-03 12:44:42 +00005584 quotes within {string}.
5585 For other systems, it will enclose {string} in single quotes
5586 and replace all "'" with "'\''".
Bram Moolenaar05bb9532008-07-04 09:44:11 +00005587 When the {special} argument is present and it's a non-zero
5588 Number or a non-empty String (|non-zero-arg|), then special
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005589 items such as "!", "%", "#" and "<cword>" will be preceded by
5590 a backslash. This backslash will be removed again by the |:!|
Bram Moolenaar05bb9532008-07-04 09:44:11 +00005591 command.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005592 The "!" character will be escaped (again with a |non-zero-arg|
5593 {special}) when 'shell' contains "csh" in the tail. That is
5594 because for csh and tcsh "!" is used for history replacement
5595 even when inside single quotes.
5596 The <NL> character is also escaped. With a |non-zero-arg|
5597 {special} and 'shell' containing "csh" in the tail it's
5598 escaped a second time.
Bram Moolenaar05bb9532008-07-04 09:44:11 +00005599 Example of use with a |:!| command: >
5600 :exe '!dir ' . shellescape(expand('<cfile>'), 1)
5601< This results in a directory listing for the file under the
5602 cursor. Example of use with |system()|: >
5603 :call system("chmod +w -- " . shellescape(expand("%")))
Bram Moolenaar26df0922014-02-23 23:39:13 +01005604< See also |::S|.
Bram Moolenaar60a495f2006-10-03 12:44:42 +00005605
5606
Bram Moolenaar2d17fa32012-10-21 00:45:18 +02005607shiftwidth() *shiftwidth()*
5608 Returns the effective value of 'shiftwidth'. This is the
5609 'shiftwidth' value unless it is zero, in which case it is the
5610 'tabstop' value. To be backwards compatible in indent
5611 plugins, use this: >
5612 if exists('*shiftwidth')
5613 func s:sw()
5614 return shiftwidth()
5615 endfunc
5616 else
5617 func s:sw()
5618 return &sw
5619 endfunc
5620 endif
5621< And then use s:sw() instead of &sw.
5622
5623
Bram Moolenaar071d4272004-06-13 20:20:40 +00005624simplify({filename}) *simplify()*
5625 Simplify the file name as much as possible without changing
5626 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
5627 Unix) are not resolved. If the first path component in
5628 {filename} designates the current directory, this will be
5629 valid for the result as well. A trailing path separator is
5630 not removed either.
5631 Example: >
5632 simplify("./dir/.././/file/") == "./file/"
5633< Note: The combination "dir/.." is only removed if "dir" is
5634 a searchable directory or does not exist. On Unix, it is also
5635 removed when "dir" is a symbolic link within the same
5636 directory. In order to resolve all the involved symbolic
5637 links before simplifying the path name, use |resolve()|.
5638
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005639
Bram Moolenaar446cb832008-06-24 21:56:24 +00005640sin({expr}) *sin()*
5641 Return the sine of {expr}, measured in radians, as a |Float|.
5642 {expr} must evaluate to a |Float| or a |Number|.
5643 Examples: >
5644 :echo sin(100)
5645< -0.506366 >
5646 :echo sin(-4.01)
5647< 0.763301
5648 {only available when compiled with the |+float| feature}
5649
5650
Bram Moolenaardb7c6862010-05-21 16:33:48 +02005651sinh({expr}) *sinh()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02005652 Return the hyperbolic sine of {expr} as a |Float| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02005653 [-inf, inf].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02005654 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02005655 Examples: >
5656 :echo sinh(0.5)
5657< 0.521095 >
5658 :echo sinh(-0.9)
5659< -1.026517
Bram Moolenaardb84e452010-08-15 13:50:43 +02005660 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02005661
5662
Bram Moolenaar5f894962011-06-19 02:55:37 +02005663sort({list} [, {func} [, {dict}]]) *sort()* *E702*
Bram Moolenaar327aa022014-03-25 18:24:23 +01005664 Sort the items in {list} in-place. Returns {list}.
5665
5666 If you want a list to remain unmodified make a copy first: >
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005667 :let sortedlist = sort(copy(mylist))
Bram Moolenaar822ff862014-06-12 21:46:14 +02005668
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005669< When {func} is omitted, is empty or zero, then sort() uses the
5670 string representation of each item to sort on. Numbers sort
5671 after Strings, |Lists| after Numbers. For sorting text in the
5672 current buffer use |:sort|.
Bram Moolenaar327aa022014-03-25 18:24:23 +01005673
Bram Moolenaar34401cc2014-08-29 15:12:19 +02005674 When {func} is given and it is '1' or 'i' then case is
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005675 ignored.
5676
5677 When {func} is given and it is 'n' then all items will be
5678 sorted numerical (Implementation detail: This uses the
5679 strtod() function to parse numbers, Strings, Lists, Dicts and
5680 Funcrefs will be considered as being 0).
5681
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005682 When {func} is a |Funcref| or a function name, this function
5683 is called to compare items. The function is invoked with two
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005684 items as argument and must return zero if they are equal, 1 or
5685 bigger if the first one sorts after the second one, -1 or
5686 smaller if the first one sorts before the second one.
Bram Moolenaar327aa022014-03-25 18:24:23 +01005687
5688 {dict} is for functions with the "dict" attribute. It will be
5689 used to set the local variable "self". |Dictionary-function|
5690
Bram Moolenaar8bb1c3e2014-07-04 16:43:17 +02005691 The sort is stable, items which compare equal (as number or as
5692 string) will keep their relative position. E.g., when sorting
Bram Moolenaardb6ea062014-07-10 22:01:47 +02005693 on numbers, text strings will sort next to each other, in the
Bram Moolenaar8bb1c3e2014-07-04 16:43:17 +02005694 same order as they were originally.
5695
Bram Moolenaar327aa022014-03-25 18:24:23 +01005696 Also see |uniq()|.
5697
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005698 Example: >
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005699 func MyCompare(i1, i2)
5700 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
5701 endfunc
5702 let sortedlist = sort(mylist, "MyCompare")
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005703< A shorter compare version for this specific simple case, which
5704 ignores overflow: >
5705 func MyCompare(i1, i2)
5706 return a:i1 - a:i2
5707 endfunc
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005708<
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005709 *soundfold()*
5710soundfold({word})
5711 Return the sound-folded equivalent of {word}. Uses the first
Bram Moolenaar446cb832008-06-24 21:56:24 +00005712 language in 'spelllang' for the current window that supports
Bram Moolenaar42eeac32005-06-29 22:40:58 +00005713 soundfolding. 'spell' must be set. When no sound folding is
5714 possible the {word} is returned unmodified.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005715 This can be used for making spelling suggestions. Note that
5716 the method can be quite slow.
5717
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005718 *spellbadword()*
Bram Moolenaar1e015462005-09-25 22:16:38 +00005719spellbadword([{sentence}])
5720 Without argument: The result is the badly spelled word under
5721 or after the cursor. The cursor is moved to the start of the
5722 bad word. When no bad word is found in the cursor line the
5723 result is an empty string and the cursor doesn't move.
5724
5725 With argument: The result is the first word in {sentence} that
5726 is badly spelled. If there are no spelling mistakes the
5727 result is an empty string.
5728
5729 The return value is a list with two items:
5730 - The badly spelled word or an empty string.
5731 - The type of the spelling error:
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005732 "bad" spelling mistake
Bram Moolenaar1e015462005-09-25 22:16:38 +00005733 "rare" rare word
5734 "local" word only valid in another region
5735 "caps" word should start with Capital
5736 Example: >
5737 echo spellbadword("the quik brown fox")
5738< ['quik', 'bad'] ~
5739
5740 The spelling information for the current window is used. The
5741 'spell' option must be set and the value of 'spelllang' is
5742 used.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005743
5744 *spellsuggest()*
Bram Moolenaarc54b8a72005-09-30 21:20:29 +00005745spellsuggest({word} [, {max} [, {capital}]])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005746 Return a |List| with spelling suggestions to replace {word}.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005747 When {max} is given up to this number of suggestions are
5748 returned. Otherwise up to 25 suggestions are returned.
5749
Bram Moolenaarc54b8a72005-09-30 21:20:29 +00005750 When the {capital} argument is given and it's non-zero only
5751 suggestions with a leading capital will be given. Use this
5752 after a match with 'spellcapcheck'.
5753
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005754 {word} can be a badly spelled word followed by other text.
5755 This allows for joining two words that were split. The
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00005756 suggestions also include the following text, thus you can
5757 replace a line.
5758
5759 {word} may also be a good word. Similar words will then be
Bram Moolenaarc54b8a72005-09-30 21:20:29 +00005760 returned. {word} itself is not included in the suggestions,
5761 although it may appear capitalized.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005762
5763 The spelling information for the current window is used. The
Bram Moolenaar42eeac32005-06-29 22:40:58 +00005764 'spell' option must be set and the values of 'spelllang' and
5765 'spellsuggest' are used.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005766
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005767
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00005768split({expr} [, {pattern} [, {keepempty}]]) *split()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005769 Make a |List| out of {expr}. When {pattern} is omitted or
5770 empty each white-separated sequence of characters becomes an
5771 item.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005772 Otherwise the string is split where {pattern} matches,
Bram Moolenaar97d62492012-11-15 21:28:22 +01005773 removing the matched characters. 'ignorecase' is not used
5774 here, add \c to ignore case. |/\c|
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00005775 When the first or last item is empty it is omitted, unless the
5776 {keepempty} argument is given and it's non-zero.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00005777 Other empty items are kept when {pattern} matches at least one
5778 character or when {keepempty} is non-zero.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005779 Example: >
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005780 :let words = split(getline('.'), '\W\+')
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00005781< To split a string in individual characters: >
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005782 :for c in split(mystring, '\zs')
Bram Moolenaar0cb032e2005-04-23 20:52:00 +00005783< If you want to keep the separator you can also use '\zs': >
5784 :echo split('abc:def:ghi', ':\zs')
5785< ['abc:', 'def:', 'ghi'] ~
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00005786 Splitting a table where the first element can be empty: >
5787 :let items = split(line, ':', 1)
5788< The opposite function is |join()|.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005789
5790
Bram Moolenaar446cb832008-06-24 21:56:24 +00005791sqrt({expr}) *sqrt()*
5792 Return the non-negative square root of Float {expr} as a
5793 |Float|.
5794 {expr} must evaluate to a |Float| or a |Number|. When {expr}
5795 is negative the result is NaN (Not a Number).
5796 Examples: >
5797 :echo sqrt(100)
5798< 10.0 >
5799 :echo sqrt(-4.01)
5800< nan
Bram Moolenaarc236c162008-07-13 17:41:49 +00005801 "nan" may be different, it depends on system libraries.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005802 {only available when compiled with the |+float| feature}
5803
5804
5805str2float( {expr}) *str2float()*
5806 Convert String {expr} to a Float. This mostly works the same
5807 as when using a floating point number in an expression, see
5808 |floating-point-format|. But it's a bit more permissive.
5809 E.g., "1e40" is accepted, while in an expression you need to
5810 write "1.0e40".
5811 Text after the number is silently ignored.
5812 The decimal point is always '.', no matter what the locale is
5813 set to. A comma ends the number: "12,345.67" is converted to
5814 12.0. You can strip out thousands separators with
5815 |substitute()|: >
5816 let f = str2float(substitute(text, ',', '', 'g'))
5817< {only available when compiled with the |+float| feature}
5818
5819
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00005820str2nr( {expr} [, {base}]) *str2nr()*
5821 Convert string {expr} to a number.
5822 {base} is the conversion base, it can be 8, 10 or 16.
5823 When {base} is omitted base 10 is used. This also means that
5824 a leading zero doesn't cause octal conversion to be used, as
5825 with the default String to Number conversion.
5826 When {base} is 16 a leading "0x" or "0X" is ignored. With a
5827 different base the result will be zero.
5828 Text after the number is silently ignored.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005829
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00005830
Bram Moolenaar72597a52010-07-18 15:31:08 +02005831strchars({expr}) *strchars()*
5832 The result is a Number, which is the number of characters
5833 String {expr} occupies. Composing characters are counted
5834 separately.
Bram Moolenaardc536092010-07-18 15:45:49 +02005835 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
5836
5837strdisplaywidth({expr}[, {col}]) *strdisplaywidth()*
5838 The result is a Number, which is the number of display cells
Bram Moolenaar92dff182014-02-11 19:15:50 +01005839 String {expr} occupies on the screen when it starts a {col}.
Bram Moolenaardc536092010-07-18 15:45:49 +02005840 When {col} is omitted zero is used. Otherwise it is the
5841 screen column where to start. This matters for Tab
5842 characters.
Bram Moolenaar4d32c2d2010-07-18 22:10:01 +02005843 The option settings of the current window are used. This
5844 matters for anything that's displayed differently, such as
5845 'tabstop' and 'display'.
Bram Moolenaardc536092010-07-18 15:45:49 +02005846 When {expr} contains characters with East Asian Width Class
5847 Ambiguous, this function's return value depends on 'ambiwidth'.
5848 Also see |strlen()|, |strwidth()| and |strchars()|.
Bram Moolenaar72597a52010-07-18 15:31:08 +02005849
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850strftime({format} [, {time}]) *strftime()*
5851 The result is a String, which is a formatted date and time, as
5852 specified by the {format} string. The given {time} is used,
5853 or the current time if no time is given. The accepted
5854 {format} depends on your system, thus this is not portable!
5855 See the manual page of the C function strftime() for the
5856 format. The maximum length of the result is 80 characters.
5857 See also |localtime()| and |getftime()|.
5858 The language can be changed with the |:language| command.
5859 Examples: >
5860 :echo strftime("%c") Sun Apr 27 11:49:23 1997
5861 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
5862 :echo strftime("%y%m%d %T") 970427 11:53:55
5863 :echo strftime("%H:%M") 11:55
5864 :echo strftime("%c", getftime("file.c"))
5865 Show mod time of file.c.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005866< Not available on all systems. To check use: >
5867 :if exists("*strftime")
5868
Bram Moolenaar8f999f12005-01-25 22:12:55 +00005869stridx({haystack}, {needle} [, {start}]) *stridx()*
5870 The result is a Number, which gives the byte index in
5871 {haystack} of the first occurrence of the String {needle}.
Bram Moolenaar677ee682005-01-27 14:41:15 +00005872 If {start} is specified, the search starts at index {start}.
5873 This can be used to find a second match: >
Bram Moolenaar81af9252010-12-10 20:35:50 +01005874 :let colon1 = stridx(line, ":")
5875 :let colon2 = stridx(line, ":", colon1 + 1)
Bram Moolenaar677ee682005-01-27 14:41:15 +00005876< The search is done case-sensitive.
Bram Moolenaare2cc9702005-03-15 22:43:58 +00005877 For pattern searches use |match()|.
Bram Moolenaar8f999f12005-01-25 22:12:55 +00005878 -1 is returned if the {needle} does not occur in {haystack}.
Bram Moolenaar677ee682005-01-27 14:41:15 +00005879 See also |strridx()|.
5880 Examples: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005881 :echo stridx("An Example", "Example") 3
5882 :echo stridx("Starting point", "Start") 0
5883 :echo stridx("Starting point", "start") -1
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005884< *strstr()* *strchr()*
Bram Moolenaar05159a02005-02-26 23:04:13 +00005885 stridx() works similar to the C function strstr(). When used
5886 with a single character it works similar to strchr().
5887
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00005888 *string()*
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005889string({expr}) Return {expr} converted to a String. If {expr} is a Number,
Bram Moolenaar446cb832008-06-24 21:56:24 +00005890 Float, String or a composition of them, then the result can be
5891 parsed back with |eval()|.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00005892 {expr} type result ~
Bram Moolenaard8b02732005-01-14 21:48:43 +00005893 String 'string'
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005894 Number 123
Bram Moolenaar446cb832008-06-24 21:56:24 +00005895 Float 123.123456 or 1.123456e8
Bram Moolenaard8b02732005-01-14 21:48:43 +00005896 Funcref function('name')
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00005897 List [item, item]
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00005898 Dictionary {key: value, key: value}
Bram Moolenaard8b02732005-01-14 21:48:43 +00005899 Note that in String values the ' character is doubled.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00005900 Also see |strtrans()|.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00005901
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902 *strlen()*
5903strlen({expr}) The result is a Number, which is the length of the String
Bram Moolenaare344bea2005-09-01 20:46:49 +00005904 {expr} in bytes.
5905 If you want to count the number of multi-byte characters (not
5906 counting composing characters) use something like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907
5908 :let len = strlen(substitute(str, ".", "x", "g"))
Bram Moolenaare344bea2005-09-01 20:46:49 +00005909<
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00005910 If the argument is a Number it is first converted to a String.
5911 For other types an error is given.
Bram Moolenaardc536092010-07-18 15:45:49 +02005912 Also see |len()|, |strchars()|, |strdisplaywidth()| and
5913 |strwidth()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914
5915strpart({src}, {start}[, {len}]) *strpart()*
5916 The result is a String, which is part of {src}, starting from
Bram Moolenaar9372a112005-12-06 19:59:18 +00005917 byte {start}, with the byte length {len}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918 When non-existing bytes are included, this doesn't result in
5919 an error, the bytes are simply omitted.
5920 If {len} is missing, the copy continues from {start} till the
5921 end of the {src}. >
5922 strpart("abcdefg", 3, 2) == "de"
5923 strpart("abcdefg", -2, 4) == "ab"
5924 strpart("abcdefg", 5, 4) == "fg"
Bram Moolenaar446cb832008-06-24 21:56:24 +00005925 strpart("abcdefg", 3) == "defg"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005926< Note: To get the first character, {start} must be 0. For
5927 example, to get three bytes under and after the cursor: >
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005928 strpart(getline("."), col(".") - 1, 3)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005929<
Bram Moolenaar677ee682005-01-27 14:41:15 +00005930strridx({haystack}, {needle} [, {start}]) *strridx()*
5931 The result is a Number, which gives the byte index in
5932 {haystack} of the last occurrence of the String {needle}.
5933 When {start} is specified, matches beyond this index are
5934 ignored. This can be used to find a match before a previous
5935 match: >
5936 :let lastcomma = strridx(line, ",")
5937 :let comma2 = strridx(line, ",", lastcomma - 1)
5938< The search is done case-sensitive.
Bram Moolenaar8f999f12005-01-25 22:12:55 +00005939 For pattern searches use |match()|.
5940 -1 is returned if the {needle} does not occur in {haystack}.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005941 If the {needle} is empty the length of {haystack} is returned.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005942 See also |stridx()|. Examples: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005943 :echo strridx("an angry armadillo", "an") 3
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005944< *strrchr()*
Bram Moolenaar05159a02005-02-26 23:04:13 +00005945 When used with a single character it works similar to the C
5946 function strrchr().
5947
Bram Moolenaar071d4272004-06-13 20:20:40 +00005948strtrans({expr}) *strtrans()*
5949 The result is a String, which is {expr} with all unprintable
5950 characters translated into printable characters |'isprint'|.
5951 Like they are shown in a window. Example: >
5952 echo strtrans(@a)
5953< This displays a newline in register a as "^@" instead of
5954 starting a new line.
5955
Bram Moolenaar72597a52010-07-18 15:31:08 +02005956strwidth({expr}) *strwidth()*
5957 The result is a Number, which is the number of display cells
5958 String {expr} occupies. A Tab character is counted as one
Bram Moolenaardc536092010-07-18 15:45:49 +02005959 cell, alternatively use |strdisplaywidth()|.
Bram Moolenaar72597a52010-07-18 15:31:08 +02005960 When {expr} contains characters with East Asian Width Class
5961 Ambiguous, this function's return value depends on 'ambiwidth'.
Bram Moolenaardc536092010-07-18 15:45:49 +02005962 Also see |strlen()|, |strdisplaywidth()| and |strchars()|.
Bram Moolenaar72597a52010-07-18 15:31:08 +02005963
Bram Moolenaar41571762014-04-02 19:00:58 +02005964submatch({nr}[, {list}]) *submatch()*
Bram Moolenaar251e1912011-06-19 05:09:16 +02005965 Only for an expression in a |:substitute| command or
5966 substitute() function.
5967 Returns the {nr}'th submatch of the matched text. When {nr}
5968 is 0 the whole matched text is returned.
Bram Moolenaar41571762014-04-02 19:00:58 +02005969 Note that a NL in the string can stand for a line break of a
5970 multi-line match or a NUL character in the text.
Bram Moolenaar251e1912011-06-19 05:09:16 +02005971 Also see |sub-replace-expression|.
Bram Moolenaar41571762014-04-02 19:00:58 +02005972
5973 If {list} is present and non-zero then submatch() returns
5974 a list of strings, similar to |getline()| with two arguments.
5975 NL characters in the text represent NUL characters in the
5976 text.
5977 Only returns more than one item for |:substitute|, inside
5978 |substitute()| this list will always contain one or zero
5979 items, since there are no real line breaks.
5980
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981 Example: >
5982 :s/\d\+/\=submatch(0) + 1/
5983< This finds the first number in the line and adds one to it.
5984 A line break is included as a newline character.
5985
5986substitute({expr}, {pat}, {sub}, {flags}) *substitute()*
5987 The result is a String, which is a copy of {expr}, in which
Bram Moolenaar251e1912011-06-19 05:09:16 +02005988 the first match of {pat} is replaced with {sub}.
5989 When {flags} is "g", all matches of {pat} in {expr} are
5990 replaced. Otherwise {flags} should be "".
5991
5992 This works like the ":substitute" command (without any flags).
5993 But the matching with {pat} is always done like the 'magic'
5994 option is set and 'cpoptions' is empty (to make scripts
Bram Moolenaar2df58b42012-11-28 18:21:11 +01005995 portable). 'ignorecase' is still relevant, use |/\c| or |/\C|
5996 if you want to ignore or match case and ignore 'ignorecase'.
5997 'smartcase' is not used. See |string-match| for how {pat} is
5998 used.
Bram Moolenaar251e1912011-06-19 05:09:16 +02005999
6000 A "~" in {sub} is not replaced with the previous {sub}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 Note that some codes in {sub} have a special meaning
Bram Moolenaar446cb832008-06-24 21:56:24 +00006002 |sub-replace-special|. For example, to replace something with
Bram Moolenaar071d4272004-06-13 20:20:40 +00006003 "\n" (two characters), use "\\\\n" or '\\n'.
Bram Moolenaar251e1912011-06-19 05:09:16 +02006004
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005 When {pat} does not match in {expr}, {expr} is returned
6006 unmodified.
Bram Moolenaar251e1912011-06-19 05:09:16 +02006007
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 Example: >
6009 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
6010< This removes the last component of the 'path' option. >
6011 :echo substitute("testing", ".*", "\\U\\0", "")
6012< results in "TESTING".
Bram Moolenaar251e1912011-06-19 05:09:16 +02006013
6014 When {sub} starts with "\=", the remainder is interpreted as
6015 an expression. See |sub-replace-expression|. Example: >
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02006016 :echo substitute(s, '%\(\x\x\)',
6017 \ '\=nr2char("0x" . submatch(1))', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018
Bram Moolenaar47136d72004-10-12 20:02:24 +00006019synID({lnum}, {col}, {trans}) *synID()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 The result is a Number, which is the syntax ID at the position
Bram Moolenaar47136d72004-10-12 20:02:24 +00006021 {lnum} and {col} in the current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006022 The syntax ID can be used with |synIDattr()| and
6023 |synIDtrans()| to obtain syntax information about text.
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006024
Bram Moolenaar47136d72004-10-12 20:02:24 +00006025 {col} is 1 for the leftmost column, {lnum} is 1 for the first
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006026 line. 'synmaxcol' applies, in a longer line zero is returned.
6027
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 When {trans} is non-zero, transparent items are reduced to the
Bram Moolenaar446cb832008-06-24 21:56:24 +00006029 item that they reveal. This is useful when wanting to know
Bram Moolenaar071d4272004-06-13 20:20:40 +00006030 the effective color. When {trans} is zero, the transparent
6031 item is returned. This is useful when wanting to know which
6032 syntax item is effective (e.g. inside parens).
6033 Warning: This function can be very slow. Best speed is
6034 obtained by going through the file in forward direction.
6035
6036 Example (echoes the name of the syntax item under the cursor): >
6037 :echo synIDattr(synID(line("."), col("."), 1), "name")
6038<
Bram Moolenaar7510fe72010-07-25 12:46:44 +02006039
Bram Moolenaar071d4272004-06-13 20:20:40 +00006040synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
6041 The result is a String, which is the {what} attribute of
6042 syntax ID {synID}. This can be used to obtain information
6043 about a syntax item.
6044 {mode} can be "gui", "cterm" or "term", to get the attributes
Bram Moolenaar446cb832008-06-24 21:56:24 +00006045 for that mode. When {mode} is omitted, or an invalid value is
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 used, the attributes for the currently active highlighting are
6047 used (GUI, cterm or term).
6048 Use synIDtrans() to follow linked highlight groups.
6049 {what} result
6050 "name" the name of the syntax item
6051 "fg" foreground color (GUI: color name used to set
6052 the color, cterm: color number as a string,
6053 term: empty string)
Bram Moolenaar6f507d62008-11-28 10:16:05 +00006054 "bg" background color (as with "fg")
Bram Moolenaar12682fd2010-03-10 13:43:49 +01006055 "font" font name (only available in the GUI)
6056 |highlight-font|
Bram Moolenaar6f507d62008-11-28 10:16:05 +00006057 "sp" special color (as with "fg") |highlight-guisp|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006058 "fg#" like "fg", but for the GUI and the GUI is
6059 running the name in "#RRGGBB" form
6060 "bg#" like "fg#" for "bg"
Bram Moolenaar6f507d62008-11-28 10:16:05 +00006061 "sp#" like "fg#" for "sp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062 "bold" "1" if bold
6063 "italic" "1" if italic
6064 "reverse" "1" if reverse
6065 "inverse" "1" if inverse (= reverse)
Bram Moolenaar12682fd2010-03-10 13:43:49 +01006066 "standout" "1" if standout
Bram Moolenaar071d4272004-06-13 20:20:40 +00006067 "underline" "1" if underlined
Bram Moolenaare2cc9702005-03-15 22:43:58 +00006068 "undercurl" "1" if undercurled
Bram Moolenaar071d4272004-06-13 20:20:40 +00006069
6070 Example (echoes the color of the syntax item under the
6071 cursor): >
6072 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
6073<
6074synIDtrans({synID}) *synIDtrans()*
6075 The result is a Number, which is the translated syntax ID of
6076 {synID}. This is the syntax group ID of what is being used to
6077 highlight the character. Highlight links given with
6078 ":highlight link" are followed.
6079
Bram Moolenaar483c5d82010-10-20 18:45:33 +02006080synconcealed({lnum}, {col}) *synconcealed()*
6081 The result is a List. The first item in the list is 0 if the
6082 character at the position {lnum} and {col} is not part of a
6083 concealable region, 1 if it is. The second item in the list is
6084 a string. If the first item is 1, the second item contains the
6085 text which will be displayed in place of the concealed text,
6086 depending on the current setting of 'conceallevel'. The third
6087 and final item in the list is a unique number representing the
6088 specific syntax region matched. This allows detection of the
6089 beginning of a new concealable region if there are two
6090 consecutive regions with the same replacement character.
6091 For an example use see $VIMRUNTIME/syntax/2html.vim .
6092
6093
Bram Moolenaar9d188ab2008-01-10 21:24:39 +00006094synstack({lnum}, {col}) *synstack()*
6095 Return a |List|, which is the stack of syntax items at the
6096 position {lnum} and {col} in the current window. Each item in
6097 the List is an ID like what |synID()| returns.
Bram Moolenaar9d188ab2008-01-10 21:24:39 +00006098 The first item in the List is the outer region, following are
6099 items contained in that one. The last one is what |synID()|
6100 returns, unless not the whole item is highlighted or it is a
6101 transparent item.
6102 This function is useful for debugging a syntax file.
6103 Example that shows the syntax stack under the cursor: >
6104 for id in synstack(line("."), col("."))
6105 echo synIDattr(id, "name")
6106 endfor
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006107< When the position specified with {lnum} and {col} is invalid
6108 nothing is returned. The position just after the last
6109 character in a line and the first column in an empty line are
6110 valid positions.
Bram Moolenaar9d188ab2008-01-10 21:24:39 +00006111
Bram Moolenaarc0197e22004-09-13 20:26:32 +00006112system({expr} [, {input}]) *system()* *E677*
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02006113 Get the output of the shell command {expr} as a string. See
6114 |systemlist()| to get the output as a List.
Bram Moolenaar57ebe6e2014-04-05 18:55:46 +02006115
6116 When {input} is given and is a string this string is written
6117 to a file and passed as stdin to the command. The string is
6118 written as-is, you need to take care of using the correct line
6119 separators yourself.
6120 If {input} is given and is a |List| it is written to the file
6121 in a way |writefile()| does with {binary} set to "b" (i.e.
6122 with a newline between each list item with newlines inside
6123 list items converted to NULs).
6124 Pipes are not used.
6125
Bram Moolenaar52a72462014-08-29 15:53:52 +02006126 When prepended by |:silent| the shell will not be set to
6127 cooked mode. This is meant to be used for commands that do
6128 not need the user to type. It avoids stray characters showing
6129 up on the screen which require |CTRL-L| to remove. >
6130 :silent let f = system('ls *.vim')
6131<
Bram Moolenaar26df0922014-02-23 23:39:13 +01006132 Note: Use |shellescape()| or |::S| with |expand()| or
6133 |fnamemodify()| to escape special characters in a command
6134 argument. Newlines in {expr} may cause the command to fail.
6135 The characters in 'shellquote' and 'shellxquote' may also
6136 cause trouble.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006137 This is not to be used for interactive commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138
Bram Moolenaar05bb9532008-07-04 09:44:11 +00006139 The result is a String. Example: >
6140 :let files = system("ls " . shellescape(expand('%:h')))
Bram Moolenaar26df0922014-02-23 23:39:13 +01006141 :let files = system('ls ' . expand('%:h:S'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142
6143< To make the result more system-independent, the shell output
6144 is filtered to replace <CR> with <NL> for Macintosh, and
6145 <CR><NL> with <NL> for DOS-like systems.
Bram Moolenaar9d98fe92013-08-03 18:35:36 +02006146 To avoid the string being truncated at a NUL, all NUL
6147 characters are replaced with SOH (0x01).
6148
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 The command executed is constructed using several options:
6150 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
6151 ({tmp} is an automatically generated file name).
6152 For Unix and OS/2 braces are put around {expr} to allow for
6153 concatenated commands.
6154
Bram Moolenaar433f7c82006-03-21 21:29:36 +00006155 The command will be executed in "cooked" mode, so that a
6156 CTRL-C will interrupt the command (on Unix at least).
6157
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158 The resulting error code can be found in |v:shell_error|.
6159 This function will fail in |restricted-mode|.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006160
6161 Note that any wrong value in the options mentioned above may
6162 make the function fail. It has also been reported to fail
6163 when using a security agent application.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164 Unlike ":!cmd" there is no automatic check for changed files.
6165 Use |:checktime| to force a check.
6166
Bram Moolenaare2cc9702005-03-15 22:43:58 +00006167
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02006168systemlist({expr} [, {input}]) *systemlist()*
6169 Same as |system()|, but returns a |List| with lines (parts of
6170 output separated by NL) with NULs transformed into NLs. Output
6171 is the same as |readfile()| will output with {binary} argument
6172 set to "b".
6173
6174 Returns an empty string on error, so be careful not to run
6175 into |E706|.
6176
6177
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006178tabpagebuflist([{arg}]) *tabpagebuflist()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006179 The result is a |List|, where each item is the number of the
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006180 buffer associated with each window in the current tab page.
6181 {arg} specifies the number of tab page to be used. When
6182 omitted the current tab page is used.
6183 When {arg} is invalid the number zero is returned.
6184 To get a list of all buffers in all tabs use this: >
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006185 let buflist = []
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006186 for i in range(tabpagenr('$'))
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006187 call extend(buflist, tabpagebuflist(i + 1))
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006188 endfor
6189< Note that a buffer may appear in more than one window.
6190
6191
6192tabpagenr([{arg}]) *tabpagenr()*
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006193 The result is a Number, which is the number of the current
6194 tab page. The first tab page has number 1.
6195 When the optional argument is "$", the number of the last tab
6196 page is returned (the tab page count).
6197 The number can be used with the |:tab| command.
6198
6199
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01006200tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()*
Bram Moolenaard04f4402010-08-15 13:30:34 +02006201 Like |winnr()| but for tab page {tabarg}.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006202 {tabarg} specifies the number of tab page to be used.
6203 {arg} is used like with |winnr()|:
6204 - When omitted the current window number is returned. This is
6205 the window which will be used when going to this tab page.
6206 - When "$" the number of windows is returned.
6207 - When "#" the previous window nr is returned.
6208 Useful examples: >
6209 tabpagewinnr(1) " current window of tab page 1
6210 tabpagewinnr(4, '$') " number of windows in tab page 4
6211< When {tabarg} is invalid zero is returned.
6212
Bram Moolenaarfa1d1402006-03-25 21:59:56 +00006213 *tagfiles()*
6214tagfiles() Returns a |List| with the file names used to search for tags
6215 for the current buffer. This is the 'tags' option expanded.
6216
6217
Bram Moolenaare2cc9702005-03-15 22:43:58 +00006218taglist({expr}) *taglist()*
6219 Returns a list of tags matching the regular expression {expr}.
Bram Moolenaard8c00872005-07-22 21:52:15 +00006220 Each list item is a dictionary with at least the following
6221 entries:
Bram Moolenaar280f1262006-01-30 00:14:18 +00006222 name Name of the tag.
6223 filename Name of the file where the tag is
Bram Moolenaaref2f6562007-05-06 13:32:59 +00006224 defined. It is either relative to the
6225 current directory or a full path.
Bram Moolenaare2cc9702005-03-15 22:43:58 +00006226 cmd Ex command used to locate the tag in
6227 the file.
Bram Moolenaar280f1262006-01-30 00:14:18 +00006228 kind Type of the tag. The value for this
Bram Moolenaare2cc9702005-03-15 22:43:58 +00006229 entry depends on the language specific
Bram Moolenaaref2f6562007-05-06 13:32:59 +00006230 kind values. Only available when
6231 using a tags file generated by
6232 Exuberant ctags or hdrtag.
Bram Moolenaar280f1262006-01-30 00:14:18 +00006233 static A file specific tag. Refer to
Bram Moolenaare2cc9702005-03-15 22:43:58 +00006234 |static-tag| for more information.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00006235 More entries may be present, depending on the content of the
6236 tags file: access, implementation, inherits and signature.
6237 Refer to the ctags documentation for information about these
6238 fields. For C code the fields "struct", "class" and "enum"
6239 may appear, they give the name of the entity the tag is
6240 contained in.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00006241
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00006242 The ex-command 'cmd' can be either an ex search pattern, a
6243 line number or a line number followed by a byte number.
Bram Moolenaare2cc9702005-03-15 22:43:58 +00006244
6245 If there are no matching tags, then an empty list is returned.
6246
6247 To get an exact tag match, the anchors '^' and '$' should be
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01006248 used in {expr}. This also make the function work faster.
6249 Refer to |tag-regexp| for more information about the tag
6250 search regular expression pattern.
Bram Moolenaare2cc9702005-03-15 22:43:58 +00006251
6252 Refer to |'tags'| for information about how the tags file is
6253 located by Vim. Refer to |tags-file-format| for the format of
6254 the tags file generated by the different ctags tools.
6255
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256tempname() *tempname()* *temp-file-name*
6257 The result is a String, which is the name of a file that
Bram Moolenaar446cb832008-06-24 21:56:24 +00006258 doesn't exist. It can be used for a temporary file. The name
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259 is different for at least 26 consecutive calls. Example: >
6260 :let tmpfile = tempname()
6261 :exe "redir > " . tmpfile
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006262< For Unix, the file will be in a private directory |tempfile|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263 For MS-Windows forward slashes are used when the 'shellslash'
6264 option is set or when 'shellcmdflag' starts with '-'.
6265
Bram Moolenaardb7c6862010-05-21 16:33:48 +02006266
6267tan({expr}) *tan()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02006268 Return the tangent of {expr}, measured in radians, as a |Float|
Bram Moolenaardb7c6862010-05-21 16:33:48 +02006269 in the range [-inf, inf].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02006270 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02006271 Examples: >
6272 :echo tan(10)
6273< 0.648361 >
6274 :echo tan(-4.01)
6275< -1.181502
Bram Moolenaardb84e452010-08-15 13:50:43 +02006276 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02006277
6278
6279tanh({expr}) *tanh()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02006280 Return the hyperbolic tangent of {expr} as a |Float| in the
Bram Moolenaardb7c6862010-05-21 16:33:48 +02006281 range [-1, 1].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02006282 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02006283 Examples: >
6284 :echo tanh(0.5)
6285< 0.462117 >
6286 :echo tanh(-1)
6287< -0.761594
Bram Moolenaardb84e452010-08-15 13:50:43 +02006288 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02006289
6290
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291tolower({expr}) *tolower()*
6292 The result is a copy of the String given, with all uppercase
6293 characters turned into lowercase (just like applying |gu| to
6294 the string).
6295
6296toupper({expr}) *toupper()*
6297 The result is a copy of the String given, with all lowercase
6298 characters turned into uppercase (just like applying |gU| to
6299 the string).
6300
Bram Moolenaar8299df92004-07-10 09:47:34 +00006301tr({src}, {fromstr}, {tostr}) *tr()*
6302 The result is a copy of the {src} string with all characters
6303 which appear in {fromstr} replaced by the character in that
6304 position in the {tostr} string. Thus the first character in
6305 {fromstr} is translated into the first character in {tostr}
6306 and so on. Exactly like the unix "tr" command.
6307 This code also deals with multibyte characters properly.
6308
6309 Examples: >
6310 echo tr("hello there", "ht", "HT")
6311< returns "Hello THere" >
6312 echo tr("<blob>", "<>", "{}")
6313< returns "{blob}"
6314
Bram Moolenaar446cb832008-06-24 21:56:24 +00006315trunc({expr}) *trunc()*
Bram Moolenaarc236c162008-07-13 17:41:49 +00006316 Return the largest integral value with magnitude less than or
Bram Moolenaar446cb832008-06-24 21:56:24 +00006317 equal to {expr} as a |Float| (truncate towards zero).
6318 {expr} must evaluate to a |Float| or a |Number|.
6319 Examples: >
6320 echo trunc(1.456)
6321< 1.0 >
6322 echo trunc(-5.456)
6323< -5.0 >
6324 echo trunc(4.0)
6325< 4.0
6326 {only available when compiled with the |+float| feature}
6327
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00006328 *type()*
6329type({expr}) The result is a Number, depending on the type of {expr}:
Bram Moolenaar748bf032005-02-02 23:04:36 +00006330 Number: 0
6331 String: 1
6332 Funcref: 2
6333 List: 3
6334 Dictionary: 4
Bram Moolenaar446cb832008-06-24 21:56:24 +00006335 Float: 5
Bram Moolenaar748bf032005-02-02 23:04:36 +00006336 To avoid the magic numbers it should be used this way: >
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00006337 :if type(myvar) == type(0)
6338 :if type(myvar) == type("")
6339 :if type(myvar) == type(function("tr"))
6340 :if type(myvar) == type([])
Bram Moolenaar748bf032005-02-02 23:04:36 +00006341 :if type(myvar) == type({})
Bram Moolenaar446cb832008-06-24 21:56:24 +00006342 :if type(myvar) == type(0.0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343
Bram Moolenaara17d4c12010-05-30 18:30:36 +02006344undofile({name}) *undofile()*
6345 Return the name of the undo file that would be used for a file
6346 with name {name} when writing. This uses the 'undodir'
6347 option, finding directories that exist. It does not check if
Bram Moolenaar860cae12010-06-05 23:22:07 +02006348 the undo file exists.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02006349 {name} is always expanded to the full path, since that is what
6350 is used internally.
Bram Moolenaar80716072012-05-01 21:14:34 +02006351 If {name} is empty undofile() returns an empty string, since a
6352 buffer without a file name will not write an undo file.
Bram Moolenaara17d4c12010-05-30 18:30:36 +02006353 Useful in combination with |:wundo| and |:rundo|.
6354 When compiled without the +persistent_undo option this always
6355 returns an empty string.
6356
Bram Moolenaara800b422010-06-27 01:15:55 +02006357undotree() *undotree()*
6358 Return the current state of the undo tree in a dictionary with
6359 the following items:
6360 "seq_last" The highest undo sequence number used.
6361 "seq_cur" The sequence number of the current position in
6362 the undo tree. This differs from "seq_last"
6363 when some changes were undone.
6364 "time_cur" Time last used for |:earlier| and related
6365 commands. Use |strftime()| to convert to
6366 something readable.
6367 "save_last" Number of the last file write. Zero when no
6368 write yet.
Bram Moolenaar730cde92010-06-27 05:18:54 +02006369 "save_cur" Number of the current position in the undo
6370 tree.
Bram Moolenaara800b422010-06-27 01:15:55 +02006371 "synced" Non-zero when the last undo block was synced.
6372 This happens when waiting from input from the
6373 user. See |undo-blocks|.
6374 "entries" A list of dictionaries with information about
6375 undo blocks.
6376
6377 The first item in the "entries" list is the oldest undo item.
6378 Each List item is a Dictionary with these items:
6379 "seq" Undo sequence number. Same as what appears in
6380 |:undolist|.
6381 "time" Timestamp when the change happened. Use
6382 |strftime()| to convert to something readable.
6383 "newhead" Only appears in the item that is the last one
6384 that was added. This marks the last change
6385 and where further changes will be added.
6386 "curhead" Only appears in the item that is the last one
6387 that was undone. This marks the current
6388 position in the undo tree, the block that will
6389 be used by a redo command. When nothing was
6390 undone after the last change this item will
6391 not appear anywhere.
6392 "save" Only appears on the last block before a file
6393 write. The number is the write count. The
6394 first write has number 1, the last one the
6395 "save_last" mentioned above.
6396 "alt" Alternate entry. This is again a List of undo
6397 blocks. Each item may again have an "alt"
6398 item.
6399
Bram Moolenaar327aa022014-03-25 18:24:23 +01006400uniq({list} [, {func} [, {dict}]]) *uniq()* *E882*
6401 Remove second and succeeding copies of repeated adjacent
6402 {list} items in-place. Returns {list}. If you want a list
6403 to remain unmodified make a copy first: >
6404 :let newlist = uniq(copy(mylist))
6405< The default compare function uses the string representation of
6406 each item. For the use of {func} and {dict} see |sort()|.
6407
Bram Moolenaar677ee682005-01-27 14:41:15 +00006408values({dict}) *values()*
Bram Moolenaar446cb832008-06-24 21:56:24 +00006409 Return a |List| with all the values of {dict}. The |List| is
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006410 in arbitrary order.
Bram Moolenaar677ee682005-01-27 14:41:15 +00006411
6412
Bram Moolenaar071d4272004-06-13 20:20:40 +00006413virtcol({expr}) *virtcol()*
6414 The result is a Number, which is the screen column of the file
6415 position given with {expr}. That is, the last screen position
6416 occupied by the character at that position, when the screen
6417 would be of unlimited width. When there is a <Tab> at the
6418 position, the returned Number will be the column at the end of
6419 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006420 set to 8, it returns 8. |conceal| is ignored.
Bram Moolenaar477933c2007-07-17 14:32:23 +00006421 For the byte position use |col()|.
6422 For the use of {expr} see |col()|.
6423 When 'virtualedit' is used {expr} can be [lnum, col, off], where
Bram Moolenaar0b238792006-03-02 22:49:12 +00006424 "off" is the offset in screen columns from the start of the
Bram Moolenaard46bbc72007-05-12 14:38:41 +00006425 character. E.g., a position within a <Tab> or after the last
Bram Moolenaar97293012011-07-18 19:40:27 +02006426 character. When "off" is omitted zero is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 When Virtual editing is active in the current mode, a position
6428 beyond the end of the line can be returned. |'virtualedit'|
6429 The accepted positions are:
6430 . the cursor position
6431 $ the end of the cursor line (the result is the
6432 number of displayed characters in the cursor line
6433 plus one)
6434 'x position of mark x (if the mark is not set, 0 is
6435 returned)
Bram Moolenaare3faf442014-12-14 01:27:49 +01006436 v In Visual mode: the start of the Visual area (the
6437 cursor is the end). When not in Visual mode
6438 returns the cursor position. Differs from |'<| in
6439 that it's updated right away.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 Note that only marks in the current file can be used.
6441 Examples: >
6442 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5
6443 virtcol("$") with text "foo^Lbar", returns 9
Bram Moolenaar446cb832008-06-24 21:56:24 +00006444 virtcol("'t") with text " there", with 't at 'h', returns 6
6445< The first column is 1. 0 is returned for an error.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00006446 A more advanced example that echoes the maximum length of
6447 all lines: >
6448 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
6449
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450
6451visualmode([expr]) *visualmode()*
6452 The result is a String, which describes the last Visual mode
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006453 used in the current buffer. Initially it returns an empty
6454 string, but once Visual mode has been used, it returns "v",
6455 "V", or "<CTRL-V>" (a single CTRL-V character) for
6456 character-wise, line-wise, or block-wise Visual mode
6457 respectively.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 Example: >
6459 :exe "normal " . visualmode()
6460< This enters the same Visual mode as before. It is also useful
6461 in scripts if you wish to act differently depending on the
6462 Visual mode that was used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006463 If Visual mode is active, use |mode()| to get the Visual mode
6464 (e.g., in a |:vmap|).
Bram Moolenaar05bb9532008-07-04 09:44:11 +00006465 *non-zero-arg*
6466 If [expr] is supplied and it evaluates to a non-zero Number or
6467 a non-empty String, then the Visual mode will be cleared and
Bram Moolenaar446cb832008-06-24 21:56:24 +00006468 the old value is returned. Note that " " and "0" are also
Bram Moolenaar05bb9532008-07-04 09:44:11 +00006469 non-empty strings, thus cause the mode to be cleared. A List,
6470 Dictionary or Float is not a Number or String, thus does not
6471 cause the mode to be cleared.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006472
Bram Moolenaar8738fc12013-02-20 17:59:11 +01006473wildmenumode() *wildmenumode()*
6474 Returns non-zero when the wildmenu is active and zero
6475 otherwise. See 'wildmenu' and 'wildmode'.
6476 This can be used in mappings to handle the 'wildcharm' option
6477 gracefully. (Makes only sense with |mapmode-c| mappings).
6478
6479 For example to make <c-j> work like <down> in wildmode, use: >
6480 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
6481<
6482 (Note, this needs the 'wildcharm' option set appropriately).
6483
6484
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485 *winbufnr()*
6486winbufnr({nr}) The result is a Number, which is the number of the buffer
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006487 associated with window {nr}. When {nr} is zero, the number of
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 the buffer in the current window is returned. When window
6489 {nr} doesn't exist, -1 is returned.
6490 Example: >
6491 :echo "The file in the current window is " . bufname(winbufnr(0))
6492<
6493 *wincol()*
6494wincol() The result is a Number, which is the virtual column of the
6495 cursor in the window. This is counting screen cells from the
6496 left side of the window. The leftmost column is one.
6497
6498winheight({nr}) *winheight()*
6499 The result is a Number, which is the height of window {nr}.
6500 When {nr} is zero, the height of the current window is
6501 returned. When window {nr} doesn't exist, -1 is returned.
6502 An existing window always has a height of zero or more.
6503 Examples: >
6504 :echo "The current window has " . winheight(0) . " lines."
6505<
6506 *winline()*
6507winline() The result is a Number, which is the screen line of the cursor
Bram Moolenaar446cb832008-06-24 21:56:24 +00006508 in the window. This is counting screen lines from the top of
Bram Moolenaar071d4272004-06-13 20:20:40 +00006509 the window. The first line is one.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006510 If the cursor was moved the view on the file will be updated
6511 first, this may cause a scroll.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512
6513 *winnr()*
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00006514winnr([{arg}]) The result is a Number, which is the number of the current
6515 window. The top window has number 1.
6516 When the optional argument is "$", the number of the
Bram Moolenaar2df58b42012-11-28 18:21:11 +01006517 last window is returned (the window count). >
6518 let window_count = winnr('$')
6519< When the optional argument is "#", the number of the last
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00006520 accessed window is returned (where |CTRL-W_p| goes to).
Bram Moolenaaref2f6562007-05-06 13:32:59 +00006521 If there is no previous window or it is in another tab page 0
6522 is returned.
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00006523 The number can be used with |CTRL-W_w| and ":wincmd w"
6524 |:wincmd|.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00006525 Also see |tabpagewinnr()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526
6527 *winrestcmd()*
6528winrestcmd() Returns a sequence of |:resize| commands that should restore
6529 the current window sizes. Only works properly when no windows
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00006530 are opened or closed and the current window and tab page is
6531 unchanged.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 Example: >
6533 :let cmd = winrestcmd()
6534 :call MessWithWindowSizes()
6535 :exe cmd
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00006536<
6537 *winrestview()*
6538winrestview({dict})
6539 Uses the |Dictionary| returned by |winsaveview()| to restore
6540 the view of the current window.
Bram Moolenaar82c25852014-05-28 16:47:16 +02006541 Note: The {dict} does not have to contain all values, that are
6542 returned by |winsaveview()|. If values are missing, those
6543 settings won't be restored. So you can use: >
6544 :call winrestview({'curswant': 4})
6545<
6546 This will only set the curswant value (the column the cursor
6547 wants to move on vertical movements) of the cursor to column 5
6548 (yes, that is 5), while all other settings will remain the
6549 same. This is useful, if you set the cursor position manually.
6550
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00006551 If you have changed the values the result is unpredictable.
6552 If the window size changed the result won't be the same.
6553
6554 *winsaveview()*
6555winsaveview() Returns a |Dictionary| that contains information to restore
6556 the view of the current window. Use |winrestview()| to
6557 restore the view.
6558 This is useful if you have a mapping that jumps around in the
6559 buffer and you want to go back to the original view.
6560 This does not save fold information. Use the 'foldenable'
Bram Moolenaardb552d602006-03-23 22:59:57 +00006561 option to temporarily switch off folding, so that folds are
Bram Moolenaar07d87792014-07-19 14:04:47 +02006562 not opened when moving around. This may have side effects.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00006563 The return value includes:
6564 lnum cursor line number
Bram Moolenaar82c25852014-05-28 16:47:16 +02006565 col cursor column (Note: the first column
6566 zero, as opposed to what getpos()
6567 returns)
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00006568 coladd cursor column offset for 'virtualedit'
6569 curswant column for vertical movement
6570 topline first line in the window
6571 topfill filler lines, only in diff mode
6572 leftcol first column displayed
6573 skipcol columns skipped
6574 Note that no option values are saved.
6575
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576
6577winwidth({nr}) *winwidth()*
6578 The result is a Number, which is the width of window {nr}.
6579 When {nr} is zero, the width of the current window is
6580 returned. When window {nr} doesn't exist, -1 is returned.
6581 An existing window always has a width of zero or more.
6582 Examples: >
6583 :echo "The current window has " . winwidth(0) . " columns."
6584 :if winwidth(0) <= 50
6585 : exe "normal 50\<C-W>|"
6586 :endif
6587<
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00006588 *writefile()*
Bram Moolenaar6b2e9382014-11-05 18:06:01 +01006589writefile({list}, {fname} [, {flags}])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006590 Write |List| {list} to file {fname}. Each list item is
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00006591 separated with a NL. Each list item must be a String or
6592 Number.
Bram Moolenaar6b2e9382014-11-05 18:06:01 +01006593 When {flags} contains "b" then binary mode is used: There will
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00006594 not be a NL after the last list item. An empty item at the
6595 end does cause the last line in the file to end in a NL.
Bram Moolenaar6b2e9382014-11-05 18:06:01 +01006596
6597 When {flags} contains "a" then append mode is used, lines are
6598 append to the file: >
6599 :call writefile(["foo"], "event.log", "a")
6600 :call writefile(["bar"], "event.log", "a")
6601>
6602< All NL characters are replaced with a NUL character.
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00006603 Inserting CR characters needs to be done before passing {list}
6604 to writefile().
6605 An existing file is overwritten, if possible.
6606 When the write fails -1 is returned, otherwise 0. There is an
6607 error message if the file can't be created or when writing
6608 fails.
6609 Also see |readfile()|.
6610 To copy a file byte for byte: >
6611 :let fl = readfile("foo", "b")
6612 :call writefile(fl, "foocopy", "b")
Bram Moolenaard6e256c2011-12-14 15:32:50 +01006613
6614
6615xor({expr}, {expr}) *xor()*
6616 Bitwise XOR on the two arguments. The arguments are converted
6617 to a number. A List, Dict or Float argument causes an error.
6618 Example: >
6619 :let bits = xor(bits, 0x80)
Bram Moolenaar6ee8d892012-01-10 14:55:01 +01006620<
Bram Moolenaard6e256c2011-12-14 15:32:50 +01006621
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622
6623 *feature-list*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02006624There are four types of features:
Bram Moolenaar071d4272004-06-13 20:20:40 +000066251. Features that are only supported when they have been enabled when Vim
6626 was compiled |+feature-list|. Example: >
6627 :if has("cindent")
66282. Features that are only supported when certain conditions have been met.
6629 Example: >
6630 :if has("gui_running")
6631< *has-patch*
Bram Moolenaar7e38ea22014-04-05 22:55:53 +020066323. Included patches. The "patch123" feature means that patch 123 has been
6633 included. Note that this form does not check the version of Vim, you need
6634 to inspect |v:version| for that.
6635 Example (checking version 6.2.148 or later): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 :if v:version > 602 || v:version == 602 && has("patch148")
Bram Moolenaar7e38ea22014-04-05 22:55:53 +02006637< Note that it's possible for patch 147 to be omitted even though 148 is
6638 included.
6639
66404. Beyond a certain version or at a certain version and including a specific
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006641 patch. The "patch-7.4.237" feature means that the Vim version is 7.5 or
6642 later, or it is version 7.4 and patch 237 was included.
6643 Note that this only works for patch 7.4.237 and later, before that you
6644 need to use the example above that checks v:version. Example: >
6645 :if has("patch-7.4.248")
Bram Moolenaar7e38ea22014-04-05 22:55:53 +02006646< Note that it's possible for patch 147 to be omitted even though 148 is
Bram Moolenaaref2f6562007-05-06 13:32:59 +00006647 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02006649acl Compiled with |ACL| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006650all_builtin_terms Compiled with all builtin terminals enabled.
6651amiga Amiga version of Vim.
6652arabic Compiled with Arabic support |Arabic|.
6653arp Compiled with ARP support (Amiga).
Bram Moolenaara9b1e742005-12-19 22:14:58 +00006654autocmd Compiled with autocommand support. |autocommand|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655balloon_eval Compiled with |balloon-eval| support.
Bram Moolenaar45360022005-07-21 21:08:21 +00006656balloon_multiline GUI supports multiline balloons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657beos BeOS version of Vim.
6658browse Compiled with |:browse| support, and browse() will
6659 work.
Bram Moolenaar30b65812012-07-12 22:01:11 +02006660browsefilter Compiled with support for |browsefilter|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661builtin_terms Compiled with some builtin terminals.
6662byte_offset Compiled with support for 'o' in 'statusline'
6663cindent Compiled with 'cindent' support.
6664clientserver Compiled with remote invocation support |clientserver|.
6665clipboard Compiled with 'clipboard' support.
6666cmdline_compl Compiled with |cmdline-completion| support.
6667cmdline_hist Compiled with |cmdline-history| support.
6668cmdline_info Compiled with 'showcmd' and 'ruler' support.
6669comments Compiled with |'comments'| support.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01006670compatible Compiled to be very Vi compatible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671cryptv Compiled with encryption support |encryption|.
6672cscope Compiled with |cscope| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673debug Compiled with "DEBUG" defined.
6674dialog_con Compiled with console dialog support.
6675dialog_gui Compiled with GUI dialog support.
6676diff Compiled with |vimdiff| and 'diff' support.
6677digraphs Compiled with support for digraphs.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006678directx Compiled with support for Direct-X and 'renderoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006679dnd Compiled with support for the "~ register |quote_~|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680dos16 16 bits DOS version of Vim.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01006681dos32 32 bits DOS (DJGPP) version of Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682ebcdic Compiled on a machine with ebcdic character set.
6683emacs_tags Compiled with support for Emacs tags.
6684eval Compiled with expression evaluation support. Always
6685 true, of course!
6686ex_extra Compiled with extra Ex commands |+ex_extra|.
6687extra_search Compiled with support for |'incsearch'| and
6688 |'hlsearch'|
6689farsi Compiled with Farsi support |farsi|.
6690file_in_path Compiled with support for |gf| and |<cfile>|
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006691filterpipe When 'shelltemp' is off pipes are used for shell
6692 read/write/filter commands
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693find_in_path Compiled with support for include file searches
6694 |+find_in_path|.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006695float Compiled with support for |Float|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696fname_case Case in file names matters (for Amiga, MS-DOS, and
6697 Windows this is not present).
6698folding Compiled with |folding| support.
6699footer Compiled with GUI footer support. |gui-footer|
6700fork Compiled to use fork()/exec() instead of system().
6701gettext Compiled with message translation |multi-lang|
6702gui Compiled with GUI enabled.
6703gui_athena Compiled with Athena GUI.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01006704gui_gnome Compiled with Gnome support (gui_gtk is also defined).
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705gui_gtk Compiled with GTK+ GUI (any version).
6706gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
6707gui_mac Compiled with Macintosh GUI.
6708gui_motif Compiled with Motif GUI.
6709gui_photon Compiled with Photon GUI.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01006710gui_running Vim is running in the GUI, or it will start soon.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006711gui_win32 Compiled with MS Windows Win32 GUI.
6712gui_win32s idem, and Win32s system being used (Windows 3.1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713hangul_input Compiled with Hangul input support. |hangul|
6714iconv Can use iconv() for conversion.
6715insert_expand Compiled with support for CTRL-X expansion commands in
6716 Insert mode.
6717jumplist Compiled with |jumplist| support.
6718keymap Compiled with 'keymap' support.
6719langmap Compiled with 'langmap' support.
6720libcall Compiled with |libcall()| support.
Bram Moolenaar597a4222014-06-25 14:39:50 +02006721linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and
6722 'breakindent' support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723lispindent Compiled with support for lisp indenting.
6724listcmds Compiled with commands for the buffer list |:files|
6725 and the argument list |arglist|.
6726localmap Compiled with local mappings and abbr. |:map-local|
Bram Moolenaar0ba04292010-07-14 23:23:17 +02006727lua Compiled with Lua interface |Lua|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728mac Macintosh version of Vim.
6729macunix Macintosh version of Vim, using Unix files (OS-X).
6730menu Compiled with support for |:menu|.
6731mksession Compiled with support for |:mksession|.
6732modify_fname Compiled with file name modifiers. |filename-modifiers|
6733mouse Compiled with support mouse.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734mouse_dec Compiled with support for Dec terminal mouse.
6735mouse_gpm Compiled with support for gpm (Linux console mouse)
6736mouse_netterm Compiled with support for netterm mouse.
6737mouse_pterm Compiled with support for qnx pterm mouse.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006738mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse)
Bram Moolenaar9b451252012-08-15 17:43:31 +02006739mouse_sgr Compiled with support for sgr mouse.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006740mouse_urxvt Compiled with support for urxvt mouse.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741mouse_xterm Compiled with support for xterm mouse.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01006742mouseshape Compiled with support for 'mouseshape'.
Bram Moolenaar42022d52008-12-09 09:57:49 +00006743multi_byte Compiled with support for 'encoding'
6744multi_byte_encoding 'encoding' is set to a multi-byte encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745multi_byte_ime Compiled with support for IME input method.
6746multi_lang Compiled with support for multiple languages.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00006747mzscheme Compiled with MzScheme interface |mzscheme|.
Bram Moolenaarb26e6322010-05-22 21:34:09 +02006748netbeans_enabled Compiled with support for |netbeans| and connected.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01006749netbeans_intg Compiled with support for |netbeans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750ole Compiled with OLE automation support for Win32.
6751os2 OS/2 version of Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752path_extra Compiled with up/downwards search in 'path' and 'tags'
6753perl Compiled with Perl interface.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02006754persistent_undo Compiled with support for persistent undo history.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755postscript Compiled with PostScript file printing.
6756printer Compiled with |:hardcopy| support.
Bram Moolenaar05159a02005-02-26 23:04:13 +00006757profile Compiled with |:profile| support.
Bram Moolenaar446beb42011-05-10 17:18:44 +02006758python Compiled with Python 2.x interface. |has-python|
6759python3 Compiled with Python 3.x interface. |has-python|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760qnx QNX version of Vim.
6761quickfix Compiled with |quickfix| support.
Bram Moolenaard68071d2006-05-02 22:08:30 +00006762reltime Compiled with |reltime()| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763rightleft Compiled with 'rightleft' support.
6764ruby Compiled with Ruby interface |ruby|.
6765scrollbind Compiled with 'scrollbind' support.
6766showcmd Compiled with 'showcmd' support.
6767signs Compiled with |:sign| support.
6768smartindent Compiled with 'smartindent' support.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006769sniff Compiled with SNiFF interface support.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01006770spell Compiled with spell checking support |spell|.
Bram Moolenaaref94eec2009-11-11 13:22:11 +00006771startuptime Compiled with |--startuptime| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772statusline Compiled with support for 'statusline', 'rulerformat'
6773 and special formats of 'titlestring' and 'iconstring'.
6774sun_workshop Compiled with support for Sun |workshop|.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006775syntax Compiled with syntax highlighting support |syntax|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776syntax_items There are active syntax highlighting items for the
6777 current buffer.
6778system Compiled to use system() instead of fork()/exec().
6779tag_binary Compiled with binary searching in tags files
6780 |tag-binary-search|.
6781tag_old_static Compiled with support for old static tags
6782 |tag-old-static|.
6783tag_any_white Compiled with support for any white characters in tags
6784 files |tag-any-white|.
6785tcl Compiled with Tcl interface.
6786terminfo Compiled with terminfo instead of termcap.
6787termresponse Compiled with support for |t_RV| and |v:termresponse|.
6788textobjects Compiled with support for |text-objects|.
6789tgetent Compiled with tgetent support, able to use a termcap
6790 or terminfo file.
6791title Compiled with window title support |'title'|.
6792toolbar Compiled with support for |gui-toolbar|.
6793unix Unix version of Vim.
6794user_commands User-defined commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795vertsplit Compiled with vertically split windows |:vsplit|.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01006796vim_starting True while initial source'ing takes place. |startup|
6797viminfo Compiled with viminfo support.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798virtualedit Compiled with 'virtualedit' option.
6799visual Compiled with Visual mode.
6800visualextra Compiled with extra Visual mode commands.
6801 |blockwise-operators|.
6802vms VMS version of Vim.
6803vreplace Compiled with |gR| and |gr| commands.
6804wildignore Compiled with 'wildignore' option.
6805wildmenu Compiled with 'wildmenu' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806win16 Win16 version of Vim (MS-Windows 3.1).
Bram Moolenaard58e9292011-02-09 17:07:58 +01006807win32 Win32 version of Vim (MS-Windows 95 and later, 32 or
6808 64 bits)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809win32unix Win32 version of Vim, using Unix files (Cygwin)
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01006810win64 Win64 version of Vim (MS-Windows 64 bit).
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811win95 Win32 version for MS-Windows 95/98/ME.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01006812winaltkeys Compiled with 'winaltkeys' option.
6813windows Compiled with support for more than one window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814writebackup Compiled with 'writebackup' default on.
6815xfontset Compiled with X fontset support |xfontset|.
6816xim Compiled with X input method support |xim|.
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02006817xpm Compiled with pixmap support.
6818xpm_w32 Compiled with pixmap support for Win32. (Only for
6819 backward compatibility. Use "xpm" instead.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820xsmp Compiled with X session management support.
6821xsmp_interact Compiled with interactive X session management support.
6822xterm_clipboard Compiled with support for xterm clipboard.
6823xterm_save Compiled with support for saving and restoring the
6824 xterm screen.
6825x11 Compiled with X11 support.
6826
6827 *string-match*
6828Matching a pattern in a String
6829
6830A regexp pattern as explained at |pattern| is normally used to find a match in
6831the buffer lines. When a pattern is used to find a match in a String, almost
6832everything works in the same way. The difference is that a String is handled
6833like it is one line. When it contains a "\n" character, this is not seen as a
6834line break for the pattern. It can be matched with a "\n" in the pattern, or
6835with ".". Example: >
6836 :let a = "aaaa\nxxxx"
6837 :echo matchstr(a, "..\n..")
6838 aa
6839 xx
6840 :echo matchstr(a, "a.x")
6841 a
6842 x
6843
6844Don't forget that "^" will only match at the first character of the String and
6845"$" at the last character of the string. They don't match after or before a
6846"\n".
6847
6848==============================================================================
68495. Defining functions *user-functions*
6850
6851New functions can be defined. These can be called just like builtin
6852functions. The function executes a sequence of Ex commands. Normal mode
6853commands can be executed with the |:normal| command.
6854
6855The function name must start with an uppercase letter, to avoid confusion with
6856builtin functions. To prevent from using the same name in different scripts
6857avoid obvious, short names. A good habit is to start the function name with
6858the name of the script, e.g., "HTMLcolor()".
6859
Bram Moolenaar92d640f2005-09-05 22:11:52 +00006860It's also possible to use curly braces, see |curly-braces-names|. And the
6861|autoload| facility is useful to define a function only when it's called.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006862
6863 *local-function*
6864A function local to a script must start with "s:". A local script function
6865can only be called from within the script and from functions, user commands
6866and autocommands defined in the script. It is also possible to call the
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006867function from a mapping defined in the script, but then |<SID>| must be used
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868instead of "s:" when the mapping is expanded outside of the script.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006869There are only script-local functions, no buffer-local or window-local
6870functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871
6872 *:fu* *:function* *E128* *E129* *E123*
6873:fu[nction] List all functions and their arguments.
6874
6875:fu[nction] {name} List function {name}.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006876 {name} can also be a |Dictionary| entry that is a
6877 |Funcref|: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00006878 :function dict.init
Bram Moolenaar92d640f2005-09-05 22:11:52 +00006879
6880:fu[nction] /{pattern} List functions with a name matching {pattern}.
6881 Example that lists all functions ending with "File": >
6882 :function /File$
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00006883<
6884 *:function-verbose*
6885When 'verbose' is non-zero, listing a function will also display where it was
6886last defined. Example: >
6887
6888 :verbose function SetFileTypeSH
6889 function SetFileTypeSH(name)
6890 Last set from /usr/share/vim/vim-7.0/filetype.vim
6891<
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006892See |:verbose-cmd| for more information.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +00006893
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006894 *E124* *E125* *E853* *E884*
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00006895:fu[nction][!] {name}([arguments]) [range] [abort] [dict]
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896 Define a new function by the name {name}. The name
6897 must be made of alphanumeric characters and '_', and
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006898 must start with a capital or "s:" (see above). Note
6899 that using "b:" or "g:" is not allowed. (since patch
6900 7.4.260 E884 is given if the function name has a colon
6901 in the name, e.g. for "foo:bar()". Before that patch
6902 no error was given).
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00006903
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006904 {name} can also be a |Dictionary| entry that is a
6905 |Funcref|: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00006906 :function dict.init(arg)
Bram Moolenaar446cb832008-06-24 21:56:24 +00006907< "dict" must be an existing dictionary. The entry
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00006908 "init" is added if it didn't exist yet. Otherwise [!]
Bram Moolenaar446cb832008-06-24 21:56:24 +00006909 is required to overwrite an existing function. The
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00006910 result is a |Funcref| to a numbered function. The
6911 function can only be used with a |Funcref| and will be
6912 deleted if there are no more references to it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 *E127* *E122*
6914 When a function by this name already exists and [!] is
6915 not used an error message is given. When [!] is used,
6916 an existing function is silently replaced. Unless it
6917 is currently being executed, that is an error.
Bram Moolenaar8f999f12005-01-25 22:12:55 +00006918
6919 For the {arguments} see |function-argument|.
6920
Bram Moolenaar8d043172014-01-23 14:24:41 +01006921 *:func-range* *a:firstline* *a:lastline*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006922 When the [range] argument is added, the function is
6923 expected to take care of a range itself. The range is
6924 passed as "a:firstline" and "a:lastline". If [range]
6925 is excluded, ":{range}call" will call the function for
6926 each line in the range, with the cursor on the start
6927 of each line. See |function-range-example|.
Bram Moolenaar2df58b42012-11-28 18:21:11 +01006928 The cursor is still moved to the first line of the
6929 range, as is the case with all Ex commands.
Bram Moolenaar8d043172014-01-23 14:24:41 +01006930 *:func-abort*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 When the [abort] argument is added, the function will
6932 abort as soon as an error is detected.
Bram Moolenaar8d043172014-01-23 14:24:41 +01006933 *:func-dict*
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00006934 When the [dict] argument is added, the function must
Bram Moolenaar446cb832008-06-24 21:56:24 +00006935 be invoked through an entry in a |Dictionary|. The
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00006936 local variable "self" will then be set to the
6937 dictionary. See |Dictionary-function|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938
Bram Moolenaar446cb832008-06-24 21:56:24 +00006939 *function-search-undo*
Bram Moolenaar98692072006-02-04 00:57:42 +00006940 The last used search pattern and the redo command "."
Bram Moolenaar446cb832008-06-24 21:56:24 +00006941 will not be changed by the function. This also
6942 implies that the effect of |:nohlsearch| is undone
6943 when the function returns.
Bram Moolenaar98692072006-02-04 00:57:42 +00006944
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 *:endf* *:endfunction* *E126* *E193*
6946:endf[unction] The end of a function definition. Must be on a line
6947 by its own, without other commands.
6948
6949 *:delf* *:delfunction* *E130* *E131*
6950:delf[unction] {name} Delete function {name}.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006951 {name} can also be a |Dictionary| entry that is a
6952 |Funcref|: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00006953 :delfunc dict.init
Bram Moolenaar446cb832008-06-24 21:56:24 +00006954< This will remove the "init" entry from "dict". The
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00006955 function is deleted if there are no more references to
6956 it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 *:retu* *:return* *E133*
6958:retu[rn] [expr] Return from a function. When "[expr]" is given, it is
6959 evaluated and returned as the result of the function.
6960 If "[expr]" is not given, the number 0 is returned.
6961 When a function ends without an explicit ":return",
6962 the number 0 is returned.
6963 Note that there is no check for unreachable lines,
6964 thus there is no warning if commands follow ":return".
6965
6966 If the ":return" is used after a |:try| but before the
6967 matching |:finally| (if present), the commands
6968 following the ":finally" up to the matching |:endtry|
6969 are executed first. This process applies to all
6970 nested ":try"s inside the function. The function
6971 returns at the outermost ":endtry".
6972
Bram Moolenaar8f999f12005-01-25 22:12:55 +00006973 *function-argument* *a:var*
Bram Moolenaar446cb832008-06-24 21:56:24 +00006974An argument can be defined by giving its name. In the function this can then
Bram Moolenaar8f999f12005-01-25 22:12:55 +00006975be used as "a:name" ("a:" for argument).
Bram Moolenaaref2f6562007-05-06 13:32:59 +00006976 *a:0* *a:1* *a:000* *E740* *...*
Bram Moolenaar8f999f12005-01-25 22:12:55 +00006977Up to 20 arguments can be given, separated by commas. After the named
6978arguments an argument "..." can be specified, which means that more arguments
6979may optionally be following. In the function the extra arguments can be used
6980as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006981can be 0). "a:000" is set to a |List| that contains these arguments. Note
6982that "a:1" is the same as "a:000[0]".
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006983 *E742*
6984The a: scope and the variables in it cannot be changed, they are fixed.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006985However, if a |List| or |Dictionary| is used, you can change their contents.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006986Thus you can pass a |List| to a function and have the function add an item to
6987it. If you want to make sure the function cannot change a |List| or
6988|Dictionary| use |:lockvar|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989
Bram Moolenaar8f999f12005-01-25 22:12:55 +00006990When not using "...", the number of arguments in a function call must be equal
6991to the number of named arguments. When using "...", the number of arguments
6992may be larger.
6993
6994It is also possible to define a function without any arguments. You must
6995still supply the () then. The body of the function follows in the next lines,
6996until the matching |:endfunction|. It is allowed to define another function
6997inside a function body.
6998
6999 *local-variables*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000Inside a function variables can be used. These are local variables, which
7001will disappear when the function returns. Global variables need to be
7002accessed with "g:".
7003
7004Example: >
7005 :function Table(title, ...)
7006 : echohl Title
7007 : echo a:title
7008 : echohl None
Bram Moolenaar677ee682005-01-27 14:41:15 +00007009 : echo a:0 . " items:"
7010 : for s in a:000
7011 : echon ' ' . s
7012 : endfor
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 :endfunction
7014
7015This function can then be called with: >
Bram Moolenaar677ee682005-01-27 14:41:15 +00007016 call Table("Table", "line1", "line2")
7017 call Table("Empty Table")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007018
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007019To return more than one value, return a |List|: >
7020 :function Compute(n1, n2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 : if a:n2 == 0
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007022 : return ["fail", 0]
Bram Moolenaar071d4272004-06-13 20:20:40 +00007023 : endif
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007024 : return ["ok", a:n1 / a:n2]
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025 :endfunction
7026
7027This function can then be called with: >
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007028 :let [success, div] = Compute(102, 6)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 :if success == "ok"
7030 : echo div
7031 :endif
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007032<
Bram Moolenaar39f05632006-03-19 22:15:26 +00007033 *:cal* *:call* *E107* *E117*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034:[range]cal[l] {name}([arguments])
7035 Call a function. The name of the function and its arguments
7036 are as specified with |:function|. Up to 20 arguments can be
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007037 used. The returned value is discarded.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007038 Without a range and for functions that accept a range, the
7039 function is called once. When a range is given the cursor is
7040 positioned at the start of the first line before executing the
7041 function.
7042 When a range is given and the function doesn't handle it
7043 itself, the function is executed for each line in the range,
7044 with the cursor in the first column of that line. The cursor
7045 is left at the last line (possibly moved by the last function
Bram Moolenaar446cb832008-06-24 21:56:24 +00007046 call). The arguments are re-evaluated for each line. Thus
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047 this works:
7048 *function-range-example* >
7049 :function Mynumber(arg)
7050 : echo line(".") . " " . a:arg
7051 :endfunction
7052 :1,5call Mynumber(getline("."))
7053<
7054 The "a:firstline" and "a:lastline" are defined anyway, they
7055 can be used to do something different at the start or end of
7056 the range.
7057
7058 Example of a function that handles the range itself: >
7059
7060 :function Cont() range
7061 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ '
7062 :endfunction
7063 :4,8call Cont()
7064<
7065 This function inserts the continuation character "\" in front
7066 of all the lines in the range, except the first one.
7067
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007068 When the function returns a composite value it can be further
7069 dereferenced, but the range will not be used then. Example: >
7070 :4,8call GetDict().method()
7071< Here GetDict() gets the range but method() does not.
7072
Bram Moolenaar071d4272004-06-13 20:20:40 +00007073 *E132*
7074The recursiveness of user functions is restricted with the |'maxfuncdepth'|
7075option.
7076
Bram Moolenaar7c626922005-02-07 22:01:03 +00007077
7078AUTOMATICALLY LOADING FUNCTIONS ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 *autoload-functions*
7080When using many or large functions, it's possible to automatically define them
Bram Moolenaar7c626922005-02-07 22:01:03 +00007081only when they are used. There are two methods: with an autocommand and with
7082the "autoload" directory in 'runtimepath'.
7083
7084
7085Using an autocommand ~
7086
Bram Moolenaar05159a02005-02-26 23:04:13 +00007087This is introduced in the user manual, section |41.14|.
7088
Bram Moolenaar7c626922005-02-07 22:01:03 +00007089The autocommand is useful if you have a plugin that is a long Vim script file.
7090You can define the autocommand and quickly quit the script with |:finish|.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007091That makes Vim startup faster. The autocommand should then load the same file
Bram Moolenaar7c626922005-02-07 22:01:03 +00007092again, setting a variable to skip the |:finish| command.
7093
7094Use the FuncUndefined autocommand event with a pattern that matches the
7095function(s) to be defined. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096
7097 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim
7098
7099The file "~/vim/bufnetfuncs.vim" should then define functions that start with
7100"BufNet". Also see |FuncUndefined|.
7101
Bram Moolenaar7c626922005-02-07 22:01:03 +00007102
7103Using an autoload script ~
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007104 *autoload* *E746*
Bram Moolenaar05159a02005-02-26 23:04:13 +00007105This is introduced in the user manual, section |41.15|.
7106
Bram Moolenaar7c626922005-02-07 22:01:03 +00007107Using a script in the "autoload" directory is simpler, but requires using
7108exactly the right file name. A function that can be autoloaded has a name
7109like this: >
7110
Bram Moolenaara7fc0102005-05-18 22:17:12 +00007111 :call filename#funcname()
Bram Moolenaar7c626922005-02-07 22:01:03 +00007112
7113When such a function is called, and it is not defined yet, Vim will search the
7114"autoload" directories in 'runtimepath' for a script file called
7115"filename.vim". For example "~/.vim/autoload/filename.vim". That file should
7116then define the function like this: >
7117
Bram Moolenaara7fc0102005-05-18 22:17:12 +00007118 function filename#funcname()
Bram Moolenaar7c626922005-02-07 22:01:03 +00007119 echo "Done!"
7120 endfunction
7121
Bram Moolenaar60a795a2005-09-16 21:55:43 +00007122The file name and the name used before the # in the function must match
Bram Moolenaar7c626922005-02-07 22:01:03 +00007123exactly, and the defined function must have the name exactly as it will be
7124called.
7125
Bram Moolenaara7fc0102005-05-18 22:17:12 +00007126It is possible to use subdirectories. Every # in the function name works like
7127a path separator. Thus when calling a function: >
Bram Moolenaar7c626922005-02-07 22:01:03 +00007128
Bram Moolenaara7fc0102005-05-18 22:17:12 +00007129 :call foo#bar#func()
Bram Moolenaar7c626922005-02-07 22:01:03 +00007130
7131Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'.
7132
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007133This also works when reading a variable that has not been set yet: >
7134
Bram Moolenaara7fc0102005-05-18 22:17:12 +00007135 :let l = foo#bar#lvar
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007136
Bram Moolenaara5792f52005-11-23 21:25:05 +00007137However, when the autoload script was already loaded it won't be loaded again
7138for an unknown variable.
7139
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007140When assigning a value to such a variable nothing special happens. This can
7141be used to pass settings to the autoload script before it's loaded: >
7142
Bram Moolenaara7fc0102005-05-18 22:17:12 +00007143 :let foo#bar#toggle = 1
7144 :call foo#bar#func()
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007145
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007146Note that when you make a mistake and call a function that is supposed to be
7147defined in an autoload script, but the script doesn't actually define the
7148function, the script will be sourced every time you try to call the function.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007149And you will get an error message every time.
7150
7151Also note that if you have two script files, and one calls a function in the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007152other and vice versa, before the used function is defined, it won't work.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007153Avoid using the autoload functionality at the toplevel.
Bram Moolenaar7c626922005-02-07 22:01:03 +00007154
Bram Moolenaar433f7c82006-03-21 21:29:36 +00007155Hint: If you distribute a bunch of scripts you can pack them together with the
7156|vimball| utility. Also read the user manual |distribute-script|.
7157
Bram Moolenaar071d4272004-06-13 20:20:40 +00007158==============================================================================
71596. Curly braces names *curly-braces-names*
7160
Bram Moolenaar84f72352012-03-11 15:57:40 +01007161In most places where you can use a variable, you can use a "curly braces name"
7162variable. This is a regular variable name with one or more expressions
7163wrapped in braces {} like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 my_{adjective}_variable
7165
7166When Vim encounters this, it evaluates the expression inside the braces, puts
7167that in place of the expression, and re-interprets the whole as a variable
7168name. So in the above example, if the variable "adjective" was set to
7169"noisy", then the reference would be to "my_noisy_variable", whereas if
7170"adjective" was set to "quiet", then it would be to "my_quiet_variable".
7171
7172One application for this is to create a set of variables governed by an option
Bram Moolenaar446cb832008-06-24 21:56:24 +00007173value. For example, the statement >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174 echo my_{&background}_message
7175
7176would output the contents of "my_dark_message" or "my_light_message" depending
7177on the current value of 'background'.
7178
7179You can use multiple brace pairs: >
7180 echo my_{adverb}_{adjective}_message
7181..or even nest them: >
7182 echo my_{ad{end_of_word}}_message
7183where "end_of_word" is either "verb" or "jective".
7184
7185However, the expression inside the braces must evaluate to a valid single
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007186variable name, e.g. this is invalid: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 :let foo='a + b'
7188 :echo c{foo}d
7189.. since the result of expansion is "ca + bd", which is not a variable name.
7190
7191 *curly-braces-function-names*
7192You can call and define functions by an evaluated name in a similar way.
7193Example: >
7194 :let func_end='whizz'
7195 :call my_func_{func_end}(parameter)
7196
7197This would call the function "my_func_whizz(parameter)".
7198
Bram Moolenaar84f72352012-03-11 15:57:40 +01007199This does NOT work: >
7200 :let i = 3
7201 :let @{i} = '' " error
7202 :echo @{i} " error
7203
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204==============================================================================
72057. Commands *expression-commands*
7206
7207:let {var-name} = {expr1} *:let* *E18*
7208 Set internal variable {var-name} to the result of the
7209 expression {expr1}. The variable will get the type
7210 from the {expr}. If {var-name} didn't exist yet, it
7211 is created.
7212
Bram Moolenaar13065c42005-01-08 16:08:21 +00007213:let {var-name}[{idx}] = {expr1} *E689*
7214 Set a list item to the result of the expression
7215 {expr1}. {var-name} must refer to a list and {idx}
7216 must be a valid index in that list. For nested list
7217 the index can be repeated.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007218 This cannot be used to add an item to a |List|.
7219 This cannot be used to set a byte in a String. You
7220 can do that like this: >
7221 :let var = var[0:2] . 'X' . var[4:]
7222<
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00007223 *E711* *E719*
7224:let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007225 Set a sequence of items in a |List| to the result of
7226 the expression {expr1}, which must be a list with the
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00007227 correct number of items.
7228 {idx1} can be omitted, zero is used instead.
7229 {idx2} can be omitted, meaning the end of the list.
7230 When the selected range of items is partly past the
7231 end of the list, items will be added.
7232
Bram Moolenaar748bf032005-02-02 23:04:36 +00007233 *:let+=* *:let-=* *:let.=* *E734*
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00007234:let {var} += {expr1} Like ":let {var} = {var} + {expr1}".
7235:let {var} -= {expr1} Like ":let {var} = {var} - {expr1}".
7236:let {var} .= {expr1} Like ":let {var} = {var} . {expr1}".
7237 These fail if {var} was not set yet and when the type
7238 of {var} and {expr1} don't fit the operator.
7239
7240
Bram Moolenaar071d4272004-06-13 20:20:40 +00007241:let ${env-name} = {expr1} *:let-environment* *:let-$*
7242 Set environment variable {env-name} to the result of
7243 the expression {expr1}. The type is always String.
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00007244:let ${env-name} .= {expr1}
7245 Append {expr1} to the environment variable {env-name}.
7246 If the environment variable didn't exist yet this
7247 works like "=".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248
7249:let @{reg-name} = {expr1} *:let-register* *:let-@*
7250 Write the result of the expression {expr1} in register
7251 {reg-name}. {reg-name} must be a single letter, and
7252 must be the name of a writable register (see
7253 |registers|). "@@" can be used for the unnamed
7254 register, "@/" for the search pattern.
7255 If the result of {expr1} ends in a <CR> or <NL>, the
7256 register will be linewise, otherwise it will be set to
7257 characterwise.
7258 This can be used to clear the last search pattern: >
7259 :let @/ = ""
7260< This is different from searching for an empty string,
7261 that would match everywhere.
7262
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00007263:let @{reg-name} .= {expr1}
Bram Moolenaar446cb832008-06-24 21:56:24 +00007264 Append {expr1} to register {reg-name}. If the
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00007265 register was empty it's like setting it to {expr1}.
7266
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007267:let &{option-name} = {expr1} *:let-option* *:let-&*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 Set option {option-name} to the result of the
Bram Moolenaarfca34d62005-01-04 21:38:36 +00007269 expression {expr1}. A String or Number value is
7270 always converted to the type of the option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007271 For an option local to a window or buffer the effect
7272 is just like using the |:set| command: both the local
Bram Moolenaara5fac542005-10-12 20:58:49 +00007273 value and the global value are changed.
Bram Moolenaarfca34d62005-01-04 21:38:36 +00007274 Example: >
7275 :let &path = &path . ',/usr/local/include'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00007277:let &{option-name} .= {expr1}
7278 For a string option: Append {expr1} to the value.
7279 Does not insert a comma like |:set+=|.
7280
7281:let &{option-name} += {expr1}
7282:let &{option-name} -= {expr1}
7283 For a number or boolean option: Add or subtract
7284 {expr1}.
7285
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286:let &l:{option-name} = {expr1}
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00007287:let &l:{option-name} .= {expr1}
7288:let &l:{option-name} += {expr1}
7289:let &l:{option-name} -= {expr1}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 Like above, but only set the local value of an option
7291 (if there is one). Works like |:setlocal|.
7292
7293:let &g:{option-name} = {expr1}
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00007294:let &g:{option-name} .= {expr1}
7295:let &g:{option-name} += {expr1}
7296:let &g:{option-name} -= {expr1}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297 Like above, but only set the global value of an option
7298 (if there is one). Works like |:setglobal|.
7299
Bram Moolenaar13065c42005-01-08 16:08:21 +00007300:let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007301 {expr1} must evaluate to a |List|. The first item in
Bram Moolenaarfca34d62005-01-04 21:38:36 +00007302 the list is assigned to {name1}, the second item to
7303 {name2}, etc.
7304 The number of names must match the number of items in
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007305 the |List|.
Bram Moolenaarfca34d62005-01-04 21:38:36 +00007306 Each name can be one of the items of the ":let"
7307 command as mentioned above.
7308 Example: >
7309 :let [s, item] = GetItem(s)
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00007310< Detail: {expr1} is evaluated first, then the
7311 assignments are done in sequence. This matters if
7312 {name2} depends on {name1}. Example: >
7313 :let x = [0, 1]
7314 :let i = 0
7315 :let [i, x[i]] = [1, 2]
7316 :echo x
7317< The result is [0, 2].
7318
7319:let [{name1}, {name2}, ...] .= {expr1}
7320:let [{name1}, {name2}, ...] += {expr1}
7321:let [{name1}, {name2}, ...] -= {expr1}
7322 Like above, but append/add/subtract the value for each
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007323 |List| item.
Bram Moolenaarfca34d62005-01-04 21:38:36 +00007324
7325:let [{name}, ..., ; {lastname}] = {expr1}
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007326 Like |:let-unpack| above, but the |List| may have more
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00007327 items than there are names. A list of the remaining
7328 items is assigned to {lastname}. If there are no
7329 remaining items {lastname} is set to an empty list.
Bram Moolenaarfca34d62005-01-04 21:38:36 +00007330 Example: >
7331 :let [a, b; rest] = ["aval", "bval", 3, 4]
7332<
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00007333:let [{name}, ..., ; {lastname}] .= {expr1}
7334:let [{name}, ..., ; {lastname}] += {expr1}
7335:let [{name}, ..., ; {lastname}] -= {expr1}
7336 Like above, but append/add/subtract the value for each
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007337 |List| item.
Bram Moolenaar4a748032010-09-30 21:47:56 +02007338
7339 *E121*
Bram Moolenaar446cb832008-06-24 21:56:24 +00007340:let {var-name} .. List the value of variable {var-name}. Multiple
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00007341 variable names may be given. Special names recognized
7342 here: *E738*
Bram Moolenaarca003e12006-03-17 23:19:38 +00007343 g: global variables
7344 b: local buffer variables
7345 w: local window variables
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007346 t: local tab page variables
Bram Moolenaarca003e12006-03-17 23:19:38 +00007347 s: script-local variables
7348 l: local function variables
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00007349 v: Vim variables.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007350
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00007351:let List the values of all variables. The type of the
7352 variable is indicated before the value:
7353 <nothing> String
7354 # Number
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007355 * Funcref
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00007357
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007358:unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795*
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00007359 Remove the internal variable {name}. Several variable
7360 names can be given, they are all removed. The name
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007361 may also be a |List| or |Dictionary| item.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007362 With [!] no error message is given for non-existing
7363 variables.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007364 One or more items from a |List| can be removed: >
Bram Moolenaar9cd15162005-01-16 22:02:49 +00007365 :unlet list[3] " remove fourth item
7366 :unlet list[3:] " remove fourth item to last
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007367< One item from a |Dictionary| can be removed at a time: >
Bram Moolenaar9cd15162005-01-16 22:02:49 +00007368 :unlet dict['two']
7369 :unlet dict.two
Bram Moolenaarc236c162008-07-13 17:41:49 +00007370< This is especially useful to clean up used global
7371 variables and script-local variables (these are not
7372 deleted when the script ends). Function-local
7373 variables are automatically deleted when the function
7374 ends.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00007376:lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv*
7377 Lock the internal variable {name}. Locking means that
7378 it can no longer be changed (until it is unlocked).
7379 A locked variable can be deleted: >
7380 :lockvar v
7381 :let v = 'asdf' " fails!
7382 :unlet v
7383< *E741*
7384 If you try to change a locked variable you get an
Bram Moolenaar8a94d872015-01-25 13:02:57 +01007385 error message: "E741: Value is locked: {name}"
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00007386
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007387 [depth] is relevant when locking a |List| or
7388 |Dictionary|. It specifies how deep the locking goes:
7389 1 Lock the |List| or |Dictionary| itself,
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00007390 cannot add or remove items, but can
7391 still change their values.
7392 2 Also lock the values, cannot change
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007393 the items. If an item is a |List| or
7394 |Dictionary|, cannot add or remove
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00007395 items, but can still change the
7396 values.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007397 3 Like 2 but for the |List| /
7398 |Dictionary| in the |List| /
7399 |Dictionary|, one level deeper.
7400 The default [depth] is 2, thus when {name} is a |List|
7401 or |Dictionary| the values cannot be changed.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00007402 *E743*
7403 For unlimited depth use [!] and omit [depth].
7404 However, there is a maximum depth of 100 to catch
7405 loops.
7406
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007407 Note that when two variables refer to the same |List|
7408 and you lock one of them, the |List| will also be
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007409 locked when used through the other variable.
7410 Example: >
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00007411 :let l = [0, 1, 2, 3]
7412 :let cl = l
7413 :lockvar l
7414 :let cl[1] = 99 " won't work!
7415< You may want to make a copy of a list to avoid this.
7416 See |deepcopy()|.
7417
7418
7419:unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo*
7420 Unlock the internal variable {name}. Does the
7421 opposite of |:lockvar|.
7422
7423
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424:if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580*
7425:en[dif] Execute the commands until the next matching ":else"
7426 or ":endif" if {expr1} evaluates to non-zero.
7427
7428 From Vim version 4.5 until 5.0, every Ex command in
7429 between the ":if" and ":endif" is ignored. These two
7430 commands were just to allow for future expansions in a
7431 backwards compatible way. Nesting was allowed. Note
7432 that any ":else" or ":elseif" was ignored, the "else"
7433 part was not executed either.
7434
7435 You can use this to remain compatible with older
7436 versions: >
7437 :if version >= 500
7438 : version-5-specific-commands
7439 :endif
7440< The commands still need to be parsed to find the
7441 "endif". Sometimes an older Vim has a problem with a
7442 new command. For example, ":silent" is recognized as
7443 a ":substitute" command. In that case ":execute" can
7444 avoid problems: >
7445 :if version >= 600
7446 : execute "silent 1,$delete"
7447 :endif
7448<
7449 NOTE: The ":append" and ":insert" commands don't work
7450 properly in between ":if" and ":endif".
7451
7452 *:else* *:el* *E581* *E583*
7453:el[se] Execute the commands until the next matching ":else"
7454 or ":endif" if they previously were not being
7455 executed.
7456
7457 *:elseif* *:elsei* *E582* *E584*
7458:elsei[f] {expr1} Short for ":else" ":if", with the addition that there
7459 is no extra ":endif".
7460
7461:wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw*
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00007462 *E170* *E585* *E588* *E733*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463:endw[hile] Repeat the commands between ":while" and ":endwhile",
7464 as long as {expr1} evaluates to non-zero.
7465 When an error is detected from a command inside the
7466 loop, execution continues after the "endwhile".
Bram Moolenaar12805862005-01-05 22:16:17 +00007467 Example: >
7468 :let lnum = 1
7469 :while lnum <= line("$")
7470 :call FixLine(lnum)
7471 :let lnum = lnum + 1
7472 :endwhile
7473<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474 NOTE: The ":append" and ":insert" commands don't work
Bram Moolenaard8b02732005-01-14 21:48:43 +00007475 properly inside a ":while" and ":for" loop.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00007477:for {var} in {list} *:for* *E690* *E732*
Bram Moolenaar12805862005-01-05 22:16:17 +00007478:endfo[r] *:endfo* *:endfor*
7479 Repeat the commands between ":for" and ":endfor" for
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00007480 each item in {list}. Variable {var} is set to the
Bram Moolenaarde8866b2005-01-06 23:24:37 +00007481 value of each item.
7482 When an error is detected for a command inside the
Bram Moolenaar12805862005-01-05 22:16:17 +00007483 loop, execution continues after the "endfor".
Bram Moolenaar572cb562005-08-05 21:35:02 +00007484 Changing {list} inside the loop affects what items are
7485 used. Make a copy if this is unwanted: >
Bram Moolenaarde8866b2005-01-06 23:24:37 +00007486 :for item in copy(mylist)
7487< When not making a copy, Vim stores a reference to the
7488 next item in the list, before executing the commands
Bram Moolenaar446cb832008-06-24 21:56:24 +00007489 with the current item. Thus the current item can be
Bram Moolenaarde8866b2005-01-06 23:24:37 +00007490 removed without effect. Removing any later item means
7491 it will not be found. Thus the following example
7492 works (an inefficient way to make a list empty): >
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007493 for item in mylist
7494 call remove(mylist, 0)
7495 endfor
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00007496< Note that reordering the list (e.g., with sort() or
7497 reverse()) may have unexpected effects.
7498 Note that the type of each list item should be
Bram Moolenaar12805862005-01-05 22:16:17 +00007499 identical to avoid errors for the type of {var}
7500 changing. Unlet the variable at the end of the loop
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007501 to allow multiple item types: >
7502 for item in ["foo", ["bar"]]
7503 echo item
7504 unlet item " E706 without this
7505 endfor
Bram Moolenaar12805862005-01-05 22:16:17 +00007506
Bram Moolenaar12805862005-01-05 22:16:17 +00007507:for [{var1}, {var2}, ...] in {listlist}
7508:endfo[r]
7509 Like ":for" above, but each item in {listlist} must be
7510 a list, of which each item is assigned to {var1},
7511 {var2}, etc. Example: >
7512 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]]
7513 :echo getline(lnum)[col]
7514 :endfor
7515<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007516 *:continue* *:con* *E586*
Bram Moolenaar12805862005-01-05 22:16:17 +00007517:con[tinue] When used inside a ":while" or ":for" loop, jumps back
7518 to the start of the loop.
7519 If it is used after a |:try| inside the loop but
7520 before the matching |:finally| (if present), the
7521 commands following the ":finally" up to the matching
7522 |:endtry| are executed first. This process applies to
7523 all nested ":try"s inside the loop. The outermost
7524 ":endtry" then jumps back to the start of the loop.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525
7526 *:break* *:brea* *E587*
Bram Moolenaar12805862005-01-05 22:16:17 +00007527:brea[k] When used inside a ":while" or ":for" loop, skips to
7528 the command after the matching ":endwhile" or
7529 ":endfor".
7530 If it is used after a |:try| inside the loop but
7531 before the matching |:finally| (if present), the
7532 commands following the ":finally" up to the matching
7533 |:endtry| are executed first. This process applies to
7534 all nested ":try"s inside the loop. The outermost
7535 ":endtry" then jumps to the command after the loop.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536
7537:try *:try* *:endt* *:endtry* *E600* *E601* *E602*
7538:endt[ry] Change the error handling for the commands between
7539 ":try" and ":endtry" including everything being
7540 executed across ":source" commands, function calls,
7541 or autocommand invocations.
7542
7543 When an error or interrupt is detected and there is
7544 a |:finally| command following, execution continues
7545 after the ":finally". Otherwise, or when the
7546 ":endtry" is reached thereafter, the next
7547 (dynamically) surrounding ":try" is checked for
7548 a corresponding ":finally" etc. Then the script
7549 processing is terminated. (Whether a function
7550 definition has an "abort" argument does not matter.)
7551 Example: >
7552 :try | edit too much | finally | echo "cleanup" | endtry
7553 :echo "impossible" " not reached, script terminated above
7554<
7555 Moreover, an error or interrupt (dynamically) inside
7556 ":try" and ":endtry" is converted to an exception. It
7557 can be caught as if it were thrown by a |:throw|
7558 command (see |:catch|). In this case, the script
7559 processing is not terminated.
7560
7561 The value "Vim:Interrupt" is used for an interrupt
7562 exception. An error in a Vim command is converted
7563 to a value of the form "Vim({command}):{errmsg}",
7564 other errors are converted to a value of the form
7565 "Vim:{errmsg}". {command} is the full command name,
7566 and {errmsg} is the message that is displayed if the
7567 error exception is not caught, always beginning with
7568 the error number.
7569 Examples: >
7570 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry
7571 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry
7572<
7573 *:cat* *:catch* *E603* *E604* *E605*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007574:cat[ch] /{pattern}/ The following commands until the next |:catch|,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575 |:finally|, or |:endtry| that belongs to the same
7576 |:try| as the ":catch" are executed when an exception
7577 matching {pattern} is being thrown and has not yet
7578 been caught by a previous ":catch". Otherwise, these
7579 commands are skipped.
7580 When {pattern} is omitted all errors are caught.
7581 Examples: >
7582 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C)
7583 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors
7584 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts
7585 :catch /^Vim(write):/ " catch all errors in :write
7586 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123
7587 :catch /my-exception/ " catch user exception
7588 :catch /.*/ " catch everything
7589 :catch " same as /.*/
7590<
7591 Another character can be used instead of / around the
7592 {pattern}, so long as it does not have a special
7593 meaning (e.g., '|' or '"') and doesn't occur inside
7594 {pattern}.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +02007595 Information about the exception is available in
7596 |v:exception|. Also see |throw-variables|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597 NOTE: It is not reliable to ":catch" the TEXT of
7598 an error message because it may vary in different
7599 locales.
7600
7601 *:fina* *:finally* *E606* *E607*
7602:fina[lly] The following commands until the matching |:endtry|
7603 are executed whenever the part between the matching
7604 |:try| and the ":finally" is left: either by falling
7605 through to the ":finally" or by a |:continue|,
7606 |:break|, |:finish|, or |:return|, or by an error or
7607 interrupt or exception (see |:throw|).
7608
7609 *:th* *:throw* *E608*
7610:th[row] {expr1} The {expr1} is evaluated and thrown as an exception.
7611 If the ":throw" is used after a |:try| but before the
7612 first corresponding |:catch|, commands are skipped
7613 until the first ":catch" matching {expr1} is reached.
7614 If there is no such ":catch" or if the ":throw" is
7615 used after a ":catch" but before the |:finally|, the
7616 commands following the ":finally" (if present) up to
7617 the matching |:endtry| are executed. If the ":throw"
7618 is after the ":finally", commands up to the ":endtry"
7619 are skipped. At the ":endtry", this process applies
7620 again for the next dynamically surrounding ":try"
7621 (which may be found in a calling function or sourcing
7622 script), until a matching ":catch" has been found.
7623 If the exception is not caught, the command processing
7624 is terminated.
7625 Example: >
7626 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry
Bram Moolenaar662db672011-03-22 14:05:35 +01007627< Note that "catch" may need to be on a separate line
7628 for when an error causes the parsing to skip the whole
7629 line and not see the "|" that separates the commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007630
7631 *:ec* *:echo*
7632:ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The
7633 first {expr1} starts on a new line.
7634 Also see |:comment|.
7635 Use "\n" to start a new line. Use "\r" to move the
7636 cursor to the first column.
7637 Uses the highlighting set by the |:echohl| command.
7638 Cannot be followed by a comment.
7639 Example: >
7640 :echo "the value of 'shell' is" &shell
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007641< *:echo-redraw*
7642 A later redraw may make the message disappear again.
7643 And since Vim mostly postpones redrawing until it's
7644 finished with a sequence of commands this happens
7645 quite often. To avoid that a command from before the
7646 ":echo" causes a redraw afterwards (redraws are often
7647 postponed until you type something), force a redraw
7648 with the |:redraw| command. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 :new | redraw | echo "there is a new window"
7650<
7651 *:echon*
7652:echon {expr1} .. Echoes each {expr1}, without anything added. Also see
7653 |:comment|.
7654 Uses the highlighting set by the |:echohl| command.
7655 Cannot be followed by a comment.
7656 Example: >
7657 :echon "the value of 'shell' is " &shell
7658<
7659 Note the difference between using ":echo", which is a
7660 Vim command, and ":!echo", which is an external shell
7661 command: >
7662 :!echo % --> filename
7663< The arguments of ":!" are expanded, see |:_%|. >
7664 :!echo "%" --> filename or "filename"
7665< Like the previous example. Whether you see the double
7666 quotes or not depends on your 'shell'. >
7667 :echo % --> nothing
7668< The '%' is an illegal character in an expression. >
7669 :echo "%" --> %
7670< This just echoes the '%' character. >
7671 :echo expand("%") --> filename
7672< This calls the expand() function to expand the '%'.
7673
7674 *:echoh* *:echohl*
7675:echoh[l] {name} Use the highlight group {name} for the following
7676 |:echo|, |:echon| and |:echomsg| commands. Also used
7677 for the |input()| prompt. Example: >
7678 :echohl WarningMsg | echo "Don't panic!" | echohl None
7679< Don't forget to set the group back to "None",
7680 otherwise all following echo's will be highlighted.
7681
7682 *:echom* *:echomsg*
7683:echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the
7684 message in the |message-history|.
7685 Spaces are placed between the arguments as with the
7686 |:echo| command. But unprintable characters are
7687 displayed, not interpreted.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007688 The parsing works slightly different from |:echo|,
7689 more like |:execute|. All the expressions are first
7690 evaluated and concatenated before echoing anything.
7691 The expressions must evaluate to a Number or String, a
7692 Dictionary or List causes an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693 Uses the highlighting set by the |:echohl| command.
7694 Example: >
7695 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see."
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007696< See |:echo-redraw| to avoid the message disappearing
7697 when the screen is redrawn.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698 *:echoe* *:echoerr*
7699:echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the
7700 message in the |message-history|. When used in a
7701 script or function the line number will be added.
7702 Spaces are placed between the arguments as with the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007703 :echo command. When used inside a try conditional,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007704 the message is raised as an error exception instead
7705 (see |try-echoerr|).
7706 Example: >
7707 :echoerr "This script just failed!"
7708< If you just want a highlighted message use |:echohl|.
7709 And to get a beep: >
7710 :exe "normal \<Esc>"
7711<
7712 *:exe* *:execute*
7713:exe[cute] {expr1} .. Executes the string that results from the evaluation
Bram Moolenaar00a927d2010-05-14 23:24:24 +02007714 of {expr1} as an Ex command.
7715 Multiple arguments are concatenated, with a space in
7716 between. To avoid the extra space use the "."
7717 operator to concatenate strings into one argument.
7718 {expr1} is used as the processed command, command line
7719 editing keys are not recognized.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007720 Cannot be followed by a comment.
7721 Examples: >
Bram Moolenaar00a927d2010-05-14 23:24:24 +02007722 :execute "buffer" nextbuf
7723 :execute "normal" count . "w"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007724<
7725 ":execute" can be used to append a command to commands
7726 that don't accept a '|'. Example: >
7727 :execute '!ls' | echo "theend"
7728
7729< ":execute" is also a nice way to avoid having to type
7730 control characters in a Vim script for a ":normal"
7731 command: >
7732 :execute "normal ixxx\<Esc>"
7733< This has an <Esc> character, see |expr-string|.
7734
Bram Moolenaar446cb832008-06-24 21:56:24 +00007735 Be careful to correctly escape special characters in
7736 file names. The |fnameescape()| function can be used
Bram Moolenaar05bb9532008-07-04 09:44:11 +00007737 for Vim commands, |shellescape()| for |:!| commands.
7738 Examples: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007739 :execute "e " . fnameescape(filename)
Bram Moolenaar251835e2014-02-24 02:51:51 +01007740 :execute "!ls " . shellescape(filename, 1)
Bram Moolenaar446cb832008-06-24 21:56:24 +00007741<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742 Note: The executed string may be any command-line, but
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007743 starting or ending "if", "while" and "for" does not
7744 always work, because when commands are skipped the
7745 ":execute" is not evaluated and Vim loses track of
7746 where blocks start and end. Also "break" and
7747 "continue" should not be inside ":execute".
7748 This example does not work, because the ":execute" is
7749 not evaluated and Vim does not see the "while", and
7750 gives an error for finding an ":endwhile": >
7751 :if 0
7752 : execute 'while i > 5'
7753 : echo "test"
7754 : endwhile
7755 :endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007756<
7757 It is allowed to have a "while" or "if" command
7758 completely in the executed string: >
7759 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile'
7760<
7761
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007762 *:exe-comment*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763 ":execute", ":echo" and ":echon" cannot be followed by
7764 a comment directly, because they see the '"' as the
7765 start of a string. But, you can use '|' followed by a
7766 comment. Example: >
7767 :echo "foo" | "this is a comment
7768
7769==============================================================================
77708. Exception handling *exception-handling*
7771
7772The Vim script language comprises an exception handling feature. This section
7773explains how it can be used in a Vim script.
7774
7775Exceptions may be raised by Vim on an error or on interrupt, see
7776|catch-errors| and |catch-interrupt|. You can also explicitly throw an
7777exception by using the ":throw" command, see |throw-catch|.
7778
7779
7780TRY CONDITIONALS *try-conditionals*
7781
7782Exceptions can be caught or can cause cleanup code to be executed. You can
7783use a try conditional to specify catch clauses (that catch exceptions) and/or
7784a finally clause (to be executed for cleanup).
7785 A try conditional begins with a |:try| command and ends at the matching
7786|:endtry| command. In between, you can use a |:catch| command to start
7787a catch clause, or a |:finally| command to start a finally clause. There may
7788be none or multiple catch clauses, but there is at most one finally clause,
7789which must not be followed by any catch clauses. The lines before the catch
7790clauses and the finally clause is called a try block. >
7791
7792 :try
Bram Moolenaar446cb832008-06-24 21:56:24 +00007793 : ...
7794 : ... TRY BLOCK
7795 : ...
Bram Moolenaar071d4272004-06-13 20:20:40 +00007796 :catch /{pattern}/
Bram Moolenaar446cb832008-06-24 21:56:24 +00007797 : ...
7798 : ... CATCH CLAUSE
7799 : ...
Bram Moolenaar071d4272004-06-13 20:20:40 +00007800 :catch /{pattern}/
Bram Moolenaar446cb832008-06-24 21:56:24 +00007801 : ...
7802 : ... CATCH CLAUSE
7803 : ...
Bram Moolenaar071d4272004-06-13 20:20:40 +00007804 :finally
Bram Moolenaar446cb832008-06-24 21:56:24 +00007805 : ...
7806 : ... FINALLY CLAUSE
7807 : ...
Bram Moolenaar071d4272004-06-13 20:20:40 +00007808 :endtry
7809
7810The try conditional allows to watch code for exceptions and to take the
7811appropriate actions. Exceptions from the try block may be caught. Exceptions
7812from the try block and also the catch clauses may cause cleanup actions.
7813 When no exception is thrown during execution of the try block, the control
7814is transferred to the finally clause, if present. After its execution, the
7815script continues with the line following the ":endtry".
7816 When an exception occurs during execution of the try block, the remaining
7817lines in the try block are skipped. The exception is matched against the
7818patterns specified as arguments to the ":catch" commands. The catch clause
7819after the first matching ":catch" is taken, other catch clauses are not
7820executed. The catch clause ends when the next ":catch", ":finally", or
7821":endtry" command is reached - whatever is first. Then, the finally clause
7822(if present) is executed. When the ":endtry" is reached, the script execution
7823continues in the following line as usual.
7824 When an exception that does not match any of the patterns specified by the
7825":catch" commands is thrown in the try block, the exception is not caught by
7826that try conditional and none of the catch clauses is executed. Only the
7827finally clause, if present, is taken. The exception pends during execution of
7828the finally clause. It is resumed at the ":endtry", so that commands after
7829the ":endtry" are not executed and the exception might be caught elsewhere,
7830see |try-nesting|.
7831 When during execution of a catch clause another exception is thrown, the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007832remaining lines in that catch clause are not executed. The new exception is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007833not matched against the patterns in any of the ":catch" commands of the same
7834try conditional and none of its catch clauses is taken. If there is, however,
7835a finally clause, it is executed, and the exception pends during its
7836execution. The commands following the ":endtry" are not executed. The new
7837exception might, however, be caught elsewhere, see |try-nesting|.
7838 When during execution of the finally clause (if present) an exception is
Bram Moolenaar446cb832008-06-24 21:56:24 +00007839thrown, the remaining lines in the finally clause are skipped. If the finally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007840clause has been taken because of an exception from the try block or one of the
7841catch clauses, the original (pending) exception is discarded. The commands
7842following the ":endtry" are not executed, and the exception from the finally
7843clause is propagated and can be caught elsewhere, see |try-nesting|.
7844
7845The finally clause is also executed, when a ":break" or ":continue" for
7846a ":while" loop enclosing the complete try conditional is executed from the
7847try block or a catch clause. Or when a ":return" or ":finish" is executed
7848from the try block or a catch clause of a try conditional in a function or
7849sourced script, respectively. The ":break", ":continue", ":return", or
7850":finish" pends during execution of the finally clause and is resumed when the
7851":endtry" is reached. It is, however, discarded when an exception is thrown
7852from the finally clause.
7853 When a ":break" or ":continue" for a ":while" loop enclosing the complete
7854try conditional or when a ":return" or ":finish" is encountered in the finally
7855clause, the rest of the finally clause is skipped, and the ":break",
7856":continue", ":return" or ":finish" is executed as usual. If the finally
7857clause has been taken because of an exception or an earlier ":break",
7858":continue", ":return", or ":finish" from the try block or a catch clause,
7859this pending exception or command is discarded.
7860
7861For examples see |throw-catch| and |try-finally|.
7862
7863
7864NESTING OF TRY CONDITIONALS *try-nesting*
7865
7866Try conditionals can be nested arbitrarily. That is, a complete try
7867conditional can be put into the try block, a catch clause, or the finally
7868clause of another try conditional. If the inner try conditional does not
7869catch an exception thrown in its try block or throws a new exception from one
7870of its catch clauses or its finally clause, the outer try conditional is
7871checked according to the rules above. If the inner try conditional is in the
7872try block of the outer try conditional, its catch clauses are checked, but
Bram Moolenaar446cb832008-06-24 21:56:24 +00007873otherwise only the finally clause is executed. It does not matter for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007874nesting, whether the inner try conditional is directly contained in the outer
7875one, or whether the outer one sources a script or calls a function containing
7876the inner try conditional.
7877
7878When none of the active try conditionals catches an exception, just their
7879finally clauses are executed. Thereafter, the script processing terminates.
7880An error message is displayed in case of an uncaught exception explicitly
7881thrown by a ":throw" command. For uncaught error and interrupt exceptions
7882implicitly raised by Vim, the error message(s) or interrupt message are shown
7883as usual.
7884
7885For examples see |throw-catch|.
7886
7887
7888EXAMINING EXCEPTION HANDLING CODE *except-examine*
7889
7890Exception handling code can get tricky. If you are in doubt what happens, set
7891'verbose' to 13 or use the ":13verbose" command modifier when sourcing your
7892script file. Then you see when an exception is thrown, discarded, caught, or
7893finished. When using a verbosity level of at least 14, things pending in
7894a finally clause are also shown. This information is also given in debug mode
7895(see |debug-scripts|).
7896
7897
7898THROWING AND CATCHING EXCEPTIONS *throw-catch*
7899
7900You can throw any number or string as an exception. Use the |:throw| command
7901and pass the value to be thrown as argument: >
7902 :throw 4711
7903 :throw "string"
7904< *throw-expression*
7905You can also specify an expression argument. The expression is then evaluated
7906first, and the result is thrown: >
7907 :throw 4705 + strlen("string")
7908 :throw strpart("strings", 0, 6)
7909
7910An exception might be thrown during evaluation of the argument of the ":throw"
7911command. Unless it is caught there, the expression evaluation is abandoned.
7912The ":throw" command then does not throw a new exception.
7913 Example: >
7914
7915 :function! Foo(arg)
7916 : try
7917 : throw a:arg
7918 : catch /foo/
7919 : endtry
7920 : return 1
7921 :endfunction
7922 :
7923 :function! Bar()
7924 : echo "in Bar"
7925 : return 4710
7926 :endfunction
7927 :
7928 :throw Foo("arrgh") + Bar()
7929
7930This throws "arrgh", and "in Bar" is not displayed since Bar() is not
7931executed. >
7932 :throw Foo("foo") + Bar()
7933however displays "in Bar" and throws 4711.
7934
7935Any other command that takes an expression as argument might also be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007936abandoned by an (uncaught) exception during the expression evaluation. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937exception is then propagated to the caller of the command.
7938 Example: >
7939
7940 :if Foo("arrgh")
7941 : echo "then"
7942 :else
7943 : echo "else"
7944 :endif
7945
7946Here neither of "then" or "else" is displayed.
7947
7948 *catch-order*
7949Exceptions can be caught by a try conditional with one or more |:catch|
7950commands, see |try-conditionals|. The values to be caught by each ":catch"
7951command can be specified as a pattern argument. The subsequent catch clause
7952gets executed when a matching exception is caught.
7953 Example: >
7954
7955 :function! Foo(value)
7956 : try
7957 : throw a:value
7958 : catch /^\d\+$/
7959 : echo "Number thrown"
7960 : catch /.*/
7961 : echo "String thrown"
7962 : endtry
7963 :endfunction
7964 :
7965 :call Foo(0x1267)
7966 :call Foo('string')
7967
7968The first call to Foo() displays "Number thrown", the second "String thrown".
7969An exception is matched against the ":catch" commands in the order they are
7970specified. Only the first match counts. So you should place the more
7971specific ":catch" first. The following order does not make sense: >
7972
7973 : catch /.*/
7974 : echo "String thrown"
7975 : catch /^\d\+$/
7976 : echo "Number thrown"
7977
7978The first ":catch" here matches always, so that the second catch clause is
7979never taken.
7980
7981 *throw-variables*
7982If you catch an exception by a general pattern, you may access the exact value
7983in the variable |v:exception|: >
7984
7985 : catch /^\d\+$/
7986 : echo "Number thrown. Value is" v:exception
7987
7988You may also be interested where an exception was thrown. This is stored in
7989|v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the
7990exception most recently caught as long it is not finished.
7991 Example: >
7992
7993 :function! Caught()
7994 : if v:exception != ""
7995 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint
7996 : else
7997 : echo 'Nothing caught'
7998 : endif
7999 :endfunction
8000 :
8001 :function! Foo()
8002 : try
8003 : try
8004 : try
8005 : throw 4711
8006 : finally
8007 : call Caught()
8008 : endtry
8009 : catch /.*/
8010 : call Caught()
8011 : throw "oops"
8012 : endtry
8013 : catch /.*/
8014 : call Caught()
8015 : finally
8016 : call Caught()
8017 : endtry
8018 :endfunction
8019 :
8020 :call Foo()
8021
8022This displays >
8023
8024 Nothing caught
8025 Caught "4711" in function Foo, line 4
8026 Caught "oops" in function Foo, line 10
8027 Nothing caught
8028
8029A practical example: The following command ":LineNumber" displays the line
8030number in the script or function where it has been used: >
8031
8032 :function! LineNumber()
8033 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "")
8034 :endfunction
8035 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry
8036<
8037 *try-nested*
8038An exception that is not caught by a try conditional can be caught by
8039a surrounding try conditional: >
8040
8041 :try
8042 : try
8043 : throw "foo"
8044 : catch /foobar/
8045 : echo "foobar"
8046 : finally
8047 : echo "inner finally"
8048 : endtry
8049 :catch /foo/
8050 : echo "foo"
8051 :endtry
8052
8053The inner try conditional does not catch the exception, just its finally
8054clause is executed. The exception is then caught by the outer try
8055conditional. The example displays "inner finally" and then "foo".
8056
8057 *throw-from-catch*
8058You can catch an exception and throw a new one to be caught elsewhere from the
8059catch clause: >
8060
8061 :function! Foo()
8062 : throw "foo"
8063 :endfunction
8064 :
8065 :function! Bar()
8066 : try
8067 : call Foo()
8068 : catch /foo/
8069 : echo "Caught foo, throw bar"
8070 : throw "bar"
8071 : endtry
8072 :endfunction
8073 :
8074 :try
8075 : call Bar()
8076 :catch /.*/
8077 : echo "Caught" v:exception
8078 :endtry
8079
8080This displays "Caught foo, throw bar" and then "Caught bar".
8081
8082 *rethrow*
8083There is no real rethrow in the Vim script language, but you may throw
8084"v:exception" instead: >
8085
8086 :function! Bar()
8087 : try
8088 : call Foo()
8089 : catch /.*/
8090 : echo "Rethrow" v:exception
8091 : throw v:exception
8092 : endtry
8093 :endfunction
8094< *try-echoerr*
8095Note that this method cannot be used to "rethrow" Vim error or interrupt
8096exceptions, because it is not possible to fake Vim internal exceptions.
8097Trying so causes an error exception. You should throw your own exception
8098denoting the situation. If you want to cause a Vim error exception containing
8099the original error exception value, you can use the |:echoerr| command: >
8100
8101 :try
8102 : try
8103 : asdf
8104 : catch /.*/
8105 : echoerr v:exception
8106 : endtry
8107 :catch /.*/
8108 : echo v:exception
8109 :endtry
8110
8111This code displays
8112
Bram Moolenaar446cb832008-06-24 21:56:24 +00008113 Vim(echoerr):Vim:E492: Not an editor command: asdf ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00008114
8115
8116CLEANUP CODE *try-finally*
8117
8118Scripts often change global settings and restore them at their end. If the
8119user however interrupts the script by pressing CTRL-C, the settings remain in
Bram Moolenaar446cb832008-06-24 21:56:24 +00008120an inconsistent state. The same may happen to you in the development phase of
Bram Moolenaar071d4272004-06-13 20:20:40 +00008121a script when an error occurs or you explicitly throw an exception without
8122catching it. You can solve these problems by using a try conditional with
8123a finally clause for restoring the settings. Its execution is guaranteed on
8124normal control flow, on error, on an explicit ":throw", and on interrupt.
8125(Note that errors and interrupts from inside the try conditional are converted
Bram Moolenaar446cb832008-06-24 21:56:24 +00008126to exceptions. When not caught, they terminate the script after the finally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008127clause has been executed.)
8128Example: >
8129
8130 :try
8131 : let s:saved_ts = &ts
8132 : set ts=17
8133 :
8134 : " Do the hard work here.
8135 :
8136 :finally
8137 : let &ts = s:saved_ts
8138 : unlet s:saved_ts
8139 :endtry
8140
8141This method should be used locally whenever a function or part of a script
8142changes global settings which need to be restored on failure or normal exit of
8143that function or script part.
8144
8145 *break-finally*
8146Cleanup code works also when the try block or a catch clause is left by
8147a ":continue", ":break", ":return", or ":finish".
8148 Example: >
8149
8150 :let first = 1
8151 :while 1
8152 : try
8153 : if first
8154 : echo "first"
8155 : let first = 0
8156 : continue
8157 : else
8158 : throw "second"
8159 : endif
8160 : catch /.*/
8161 : echo v:exception
8162 : break
8163 : finally
8164 : echo "cleanup"
8165 : endtry
8166 : echo "still in while"
8167 :endwhile
8168 :echo "end"
8169
8170This displays "first", "cleanup", "second", "cleanup", and "end". >
8171
8172 :function! Foo()
8173 : try
8174 : return 4711
8175 : finally
8176 : echo "cleanup\n"
8177 : endtry
8178 : echo "Foo still active"
8179 :endfunction
8180 :
8181 :echo Foo() "returned by Foo"
8182
8183This displays "cleanup" and "4711 returned by Foo". You don't need to add an
Bram Moolenaar446cb832008-06-24 21:56:24 +00008184extra ":return" in the finally clause. (Above all, this would override the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185return value.)
8186
8187 *except-from-finally*
8188Using either of ":continue", ":break", ":return", ":finish", or ":throw" in
8189a finally clause is possible, but not recommended since it abandons the
8190cleanup actions for the try conditional. But, of course, interrupt and error
8191exceptions might get raised from a finally clause.
8192 Example where an error in the finally clause stops an interrupt from
8193working correctly: >
8194
8195 :try
8196 : try
8197 : echo "Press CTRL-C for interrupt"
8198 : while 1
8199 : endwhile
8200 : finally
8201 : unlet novar
8202 : endtry
8203 :catch /novar/
8204 :endtry
8205 :echo "Script still running"
8206 :sleep 1
8207
8208If you need to put commands that could fail into a finally clause, you should
8209think about catching or ignoring the errors in these commands, see
8210|catch-errors| and |ignore-errors|.
8211
8212
8213CATCHING ERRORS *catch-errors*
8214
8215If you want to catch specific errors, you just have to put the code to be
8216watched in a try block and add a catch clause for the error message. The
8217presence of the try conditional causes all errors to be converted to an
8218exception. No message is displayed and |v:errmsg| is not set then. To find
8219the right pattern for the ":catch" command, you have to know how the format of
8220the error exception is.
8221 Error exceptions have the following format: >
8222
8223 Vim({cmdname}):{errmsg}
8224or >
8225 Vim:{errmsg}
8226
8227{cmdname} is the name of the command that failed; the second form is used when
Bram Moolenaar446cb832008-06-24 21:56:24 +00008228the command name is not known. {errmsg} is the error message usually produced
Bram Moolenaar071d4272004-06-13 20:20:40 +00008229when the error occurs outside try conditionals. It always begins with
8230a capital "E", followed by a two or three-digit error number, a colon, and
8231a space.
8232
8233Examples:
8234
8235The command >
8236 :unlet novar
8237normally produces the error message >
8238 E108: No such variable: "novar"
8239which is converted inside try conditionals to an exception >
8240 Vim(unlet):E108: No such variable: "novar"
8241
8242The command >
8243 :dwim
8244normally produces the error message >
8245 E492: Not an editor command: dwim
8246which is converted inside try conditionals to an exception >
8247 Vim:E492: Not an editor command: dwim
8248
8249You can catch all ":unlet" errors by a >
8250 :catch /^Vim(unlet):/
8251or all errors for misspelled command names by a >
8252 :catch /^Vim:E492:/
8253
8254Some error messages may be produced by different commands: >
8255 :function nofunc
8256and >
8257 :delfunction nofunc
8258both produce the error message >
8259 E128: Function name must start with a capital: nofunc
8260which is converted inside try conditionals to an exception >
8261 Vim(function):E128: Function name must start with a capital: nofunc
8262or >
8263 Vim(delfunction):E128: Function name must start with a capital: nofunc
8264respectively. You can catch the error by its number independently on the
8265command that caused it if you use the following pattern: >
8266 :catch /^Vim(\a\+):E128:/
8267
8268Some commands like >
8269 :let x = novar
8270produce multiple error messages, here: >
8271 E121: Undefined variable: novar
8272 E15: Invalid expression: novar
8273Only the first is used for the exception value, since it is the most specific
8274one (see |except-several-errors|). So you can catch it by >
8275 :catch /^Vim(\a\+):E121:/
8276
8277You can catch all errors related to the name "nofunc" by >
8278 :catch /\<nofunc\>/
8279
8280You can catch all Vim errors in the ":write" and ":read" commands by >
8281 :catch /^Vim(\(write\|read\)):E\d\+:/
8282
8283You can catch all Vim errors by the pattern >
8284 :catch /^Vim\((\a\+)\)\=:E\d\+:/
8285<
8286 *catch-text*
8287NOTE: You should never catch the error message text itself: >
8288 :catch /No such variable/
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01008289only works in the English locale, but not when the user has selected
Bram Moolenaar071d4272004-06-13 20:20:40 +00008290a different language by the |:language| command. It is however helpful to
8291cite the message text in a comment: >
8292 :catch /^Vim(\a\+):E108:/ " No such variable
8293
8294
8295IGNORING ERRORS *ignore-errors*
8296
8297You can ignore errors in a specific Vim command by catching them locally: >
8298
8299 :try
8300 : write
8301 :catch
8302 :endtry
8303
8304But you are strongly recommended NOT to use this simple form, since it could
8305catch more than you want. With the ":write" command, some autocommands could
8306be executed and cause errors not related to writing, for instance: >
8307
8308 :au BufWritePre * unlet novar
8309
8310There could even be such errors you are not responsible for as a script
8311writer: a user of your script might have defined such autocommands. You would
8312then hide the error from the user.
8313 It is much better to use >
8314
8315 :try
8316 : write
8317 :catch /^Vim(write):/
8318 :endtry
8319
8320which only catches real write errors. So catch only what you'd like to ignore
8321intentionally.
8322
8323For a single command that does not cause execution of autocommands, you could
8324even suppress the conversion of errors to exceptions by the ":silent!"
8325command: >
8326 :silent! nunmap k
8327This works also when a try conditional is active.
8328
8329
8330CATCHING INTERRUPTS *catch-interrupt*
8331
8332When there are active try conditionals, an interrupt (CTRL-C) is converted to
Bram Moolenaar446cb832008-06-24 21:56:24 +00008333the exception "Vim:Interrupt". You can catch it like every exception. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008334script is not terminated, then.
8335 Example: >
8336
8337 :function! TASK1()
8338 : sleep 10
8339 :endfunction
8340
8341 :function! TASK2()
8342 : sleep 20
8343 :endfunction
8344
8345 :while 1
8346 : let command = input("Type a command: ")
8347 : try
8348 : if command == ""
8349 : continue
8350 : elseif command == "END"
8351 : break
8352 : elseif command == "TASK1"
8353 : call TASK1()
8354 : elseif command == "TASK2"
8355 : call TASK2()
8356 : else
8357 : echo "\nIllegal command:" command
8358 : continue
8359 : endif
8360 : catch /^Vim:Interrupt$/
8361 : echo "\nCommand interrupted"
8362 : " Caught the interrupt. Continue with next prompt.
8363 : endtry
8364 :endwhile
8365
8366You can interrupt a task here by pressing CTRL-C; the script then asks for
Bram Moolenaar446cb832008-06-24 21:56:24 +00008367a new command. If you press CTRL-C at the prompt, the script is terminated.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368
8369For testing what happens when CTRL-C would be pressed on a specific line in
8370your script, use the debug mode and execute the |>quit| or |>interrupt|
8371command on that line. See |debug-scripts|.
8372
8373
8374CATCHING ALL *catch-all*
8375
8376The commands >
8377
8378 :catch /.*/
8379 :catch //
8380 :catch
8381
8382catch everything, error exceptions, interrupt exceptions and exceptions
8383explicitly thrown by the |:throw| command. This is useful at the top level of
8384a script in order to catch unexpected things.
8385 Example: >
8386
8387 :try
8388 :
8389 : " do the hard work here
8390 :
8391 :catch /MyException/
8392 :
8393 : " handle known problem
8394 :
8395 :catch /^Vim:Interrupt$/
8396 : echo "Script interrupted"
8397 :catch /.*/
8398 : echo "Internal error (" . v:exception . ")"
8399 : echo " - occurred at " . v:throwpoint
8400 :endtry
8401 :" end of script
8402
8403Note: Catching all might catch more things than you want. Thus, you are
8404strongly encouraged to catch only for problems that you can really handle by
8405specifying a pattern argument to the ":catch".
8406 Example: Catching all could make it nearly impossible to interrupt a script
8407by pressing CTRL-C: >
8408
8409 :while 1
8410 : try
8411 : sleep 1
8412 : catch
8413 : endtry
8414 :endwhile
8415
8416
8417EXCEPTIONS AND AUTOCOMMANDS *except-autocmd*
8418
8419Exceptions may be used during execution of autocommands. Example: >
8420
8421 :autocmd User x try
8422 :autocmd User x throw "Oops!"
8423 :autocmd User x catch
8424 :autocmd User x echo v:exception
8425 :autocmd User x endtry
8426 :autocmd User x throw "Arrgh!"
8427 :autocmd User x echo "Should not be displayed"
8428 :
8429 :try
8430 : doautocmd User x
8431 :catch
8432 : echo v:exception
8433 :endtry
8434
8435This displays "Oops!" and "Arrgh!".
8436
8437 *except-autocmd-Pre*
8438For some commands, autocommands get executed before the main action of the
8439command takes place. If an exception is thrown and not caught in the sequence
8440of autocommands, the sequence and the command that caused its execution are
8441abandoned and the exception is propagated to the caller of the command.
8442 Example: >
8443
8444 :autocmd BufWritePre * throw "FAIL"
8445 :autocmd BufWritePre * echo "Should not be displayed"
8446 :
8447 :try
8448 : write
8449 :catch
8450 : echo "Caught:" v:exception "from" v:throwpoint
8451 :endtry
8452
8453Here, the ":write" command does not write the file currently being edited (as
8454you can see by checking 'modified'), since the exception from the BufWritePre
8455autocommand abandons the ":write". The exception is then caught and the
8456script displays: >
8457
8458 Caught: FAIL from BufWrite Auto commands for "*"
8459<
8460 *except-autocmd-Post*
8461For some commands, autocommands get executed after the main action of the
8462command has taken place. If this main action fails and the command is inside
8463an active try conditional, the autocommands are skipped and an error exception
8464is thrown that can be caught by the caller of the command.
8465 Example: >
8466
8467 :autocmd BufWritePost * echo "File successfully written!"
8468 :
8469 :try
8470 : write /i/m/p/o/s/s/i/b/l/e
8471 :catch
8472 : echo v:exception
8473 :endtry
8474
8475This just displays: >
8476
8477 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e)
8478
8479If you really need to execute the autocommands even when the main action
8480fails, trigger the event from the catch clause.
8481 Example: >
8482
8483 :autocmd BufWritePre * set noreadonly
8484 :autocmd BufWritePost * set readonly
8485 :
8486 :try
8487 : write /i/m/p/o/s/s/i/b/l/e
8488 :catch
8489 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e
8490 :endtry
8491<
8492You can also use ":silent!": >
8493
8494 :let x = "ok"
8495 :let v:errmsg = ""
8496 :autocmd BufWritePost * if v:errmsg != ""
8497 :autocmd BufWritePost * let x = "after fail"
8498 :autocmd BufWritePost * endif
8499 :try
8500 : silent! write /i/m/p/o/s/s/i/b/l/e
8501 :catch
8502 :endtry
8503 :echo x
8504
8505This displays "after fail".
8506
8507If the main action of the command does not fail, exceptions from the
8508autocommands will be catchable by the caller of the command: >
8509
8510 :autocmd BufWritePost * throw ":-("
8511 :autocmd BufWritePost * echo "Should not be displayed"
8512 :
8513 :try
8514 : write
8515 :catch
8516 : echo v:exception
8517 :endtry
8518<
8519 *except-autocmd-Cmd*
8520For some commands, the normal action can be replaced by a sequence of
8521autocommands. Exceptions from that sequence will be catchable by the caller
8522of the command.
8523 Example: For the ":write" command, the caller cannot know whether the file
Bram Moolenaar446cb832008-06-24 21:56:24 +00008524had actually been written when the exception occurred. You need to tell it in
Bram Moolenaar071d4272004-06-13 20:20:40 +00008525some way. >
8526
8527 :if !exists("cnt")
8528 : let cnt = 0
8529 :
8530 : autocmd BufWriteCmd * if &modified
8531 : autocmd BufWriteCmd * let cnt = cnt + 1
8532 : autocmd BufWriteCmd * if cnt % 3 == 2
8533 : autocmd BufWriteCmd * throw "BufWriteCmdError"
8534 : autocmd BufWriteCmd * endif
8535 : autocmd BufWriteCmd * write | set nomodified
8536 : autocmd BufWriteCmd * if cnt % 3 == 0
8537 : autocmd BufWriteCmd * throw "BufWriteCmdError"
8538 : autocmd BufWriteCmd * endif
8539 : autocmd BufWriteCmd * echo "File successfully written!"
8540 : autocmd BufWriteCmd * endif
8541 :endif
8542 :
8543 :try
8544 : write
8545 :catch /^BufWriteCmdError$/
8546 : if &modified
8547 : echo "Error on writing (file contents not changed)"
8548 : else
8549 : echo "Error after writing"
8550 : endif
8551 :catch /^Vim(write):/
8552 : echo "Error on writing"
8553 :endtry
8554
8555When this script is sourced several times after making changes, it displays
8556first >
8557 File successfully written!
8558then >
8559 Error on writing (file contents not changed)
8560then >
8561 Error after writing
8562etc.
8563
8564 *except-autocmd-ill*
8565You cannot spread a try conditional over autocommands for different events.
8566The following code is ill-formed: >
8567
8568 :autocmd BufWritePre * try
8569 :
8570 :autocmd BufWritePost * catch
8571 :autocmd BufWritePost * echo v:exception
8572 :autocmd BufWritePost * endtry
8573 :
8574 :write
8575
8576
8577EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param*
8578
8579Some programming languages allow to use hierarchies of exception classes or to
8580pass additional information with the object of an exception class. You can do
8581similar things in Vim.
8582 In order to throw an exception from a hierarchy, just throw the complete
8583class name with the components separated by a colon, for instance throw the
8584string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library.
8585 When you want to pass additional information with your exception class, add
8586it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)"
8587for an error when writing "myfile".
8588 With the appropriate patterns in the ":catch" command, you can catch for
8589base classes or derived classes of your hierarchy. Additional information in
8590parentheses can be cut out from |v:exception| with the ":substitute" command.
8591 Example: >
8592
8593 :function! CheckRange(a, func)
8594 : if a:a < 0
8595 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")"
8596 : endif
8597 :endfunction
8598 :
8599 :function! Add(a, b)
8600 : call CheckRange(a:a, "Add")
8601 : call CheckRange(a:b, "Add")
8602 : let c = a:a + a:b
8603 : if c < 0
8604 : throw "EXCEPT:MATHERR:OVERFLOW"
8605 : endif
8606 : return c
8607 :endfunction
8608 :
8609 :function! Div(a, b)
8610 : call CheckRange(a:a, "Div")
8611 : call CheckRange(a:b, "Div")
8612 : if (a:b == 0)
8613 : throw "EXCEPT:MATHERR:ZERODIV"
8614 : endif
8615 : return a:a / a:b
8616 :endfunction
8617 :
8618 :function! Write(file)
8619 : try
Bram Moolenaar446cb832008-06-24 21:56:24 +00008620 : execute "write" fnameescape(a:file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008621 : catch /^Vim(write):/
8622 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR"
8623 : endtry
8624 :endfunction
8625 :
8626 :try
8627 :
8628 : " something with arithmetics and I/O
8629 :
8630 :catch /^EXCEPT:MATHERR:RANGE/
8631 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "")
8632 : echo "Range error in" function
8633 :
8634 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV
8635 : echo "Math error"
8636 :
8637 :catch /^EXCEPT:IO/
8638 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "")
8639 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "")
8640 : if file !~ '^/'
8641 : let file = dir . "/" . file
8642 : endif
8643 : echo 'I/O error for "' . file . '"'
8644 :
8645 :catch /^EXCEPT/
8646 : echo "Unspecified error"
8647 :
8648 :endtry
8649
8650The exceptions raised by Vim itself (on error or when pressing CTRL-C) use
8651a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself
8652exceptions with the "Vim" prefix; they are reserved for Vim.
8653 Vim error exceptions are parameterized with the name of the command that
8654failed, if known. See |catch-errors|.
8655
8656
8657PECULIARITIES
8658 *except-compat*
8659The exception handling concept requires that the command sequence causing the
8660exception is aborted immediately and control is transferred to finally clauses
8661and/or a catch clause.
8662
8663In the Vim script language there are cases where scripts and functions
8664continue after an error: in functions without the "abort" flag or in a command
8665after ":silent!", control flow goes to the following line, and outside
8666functions, control flow goes to the line following the outermost ":endwhile"
8667or ":endif". On the other hand, errors should be catchable as exceptions
8668(thus, requiring the immediate abortion).
8669
8670This problem has been solved by converting errors to exceptions and using
8671immediate abortion (if not suppressed by ":silent!") only when a try
Bram Moolenaar446cb832008-06-24 21:56:24 +00008672conditional is active. This is no restriction since an (error) exception can
8673be caught only from an active try conditional. If you want an immediate
Bram Moolenaar071d4272004-06-13 20:20:40 +00008674termination without catching the error, just use a try conditional without
8675catch clause. (You can cause cleanup code being executed before termination
8676by specifying a finally clause.)
8677
8678When no try conditional is active, the usual abortion and continuation
8679behavior is used instead of immediate abortion. This ensures compatibility of
8680scripts written for Vim 6.1 and earlier.
8681
8682However, when sourcing an existing script that does not use exception handling
8683commands (or when calling one of its functions) from inside an active try
8684conditional of a new script, you might change the control flow of the existing
8685script on error. You get the immediate abortion on error and can catch the
8686error in the new script. If however the sourced script suppresses error
8687messages by using the ":silent!" command (checking for errors by testing
Bram Moolenaar446cb832008-06-24 21:56:24 +00008688|v:errmsg| if appropriate), its execution path is not changed. The error is
8689not converted to an exception. (See |:silent|.) So the only remaining cause
Bram Moolenaar071d4272004-06-13 20:20:40 +00008690where this happens is for scripts that don't care about errors and produce
8691error messages. You probably won't want to use such code from your new
8692scripts.
8693
8694 *except-syntax-err*
8695Syntax errors in the exception handling commands are never caught by any of
8696the ":catch" commands of the try conditional they belong to. Its finally
8697clauses, however, is executed.
8698 Example: >
8699
8700 :try
8701 : try
8702 : throw 4711
8703 : catch /\(/
8704 : echo "in catch with syntax error"
8705 : catch
8706 : echo "inner catch-all"
8707 : finally
8708 : echo "inner finally"
8709 : endtry
8710 :catch
8711 : echo 'outer catch-all caught "' . v:exception . '"'
8712 : finally
8713 : echo "outer finally"
8714 :endtry
8715
8716This displays: >
8717 inner finally
8718 outer catch-all caught "Vim(catch):E54: Unmatched \("
8719 outer finally
8720The original exception is discarded and an error exception is raised, instead.
8721
8722 *except-single-line*
8723The ":try", ":catch", ":finally", and ":endtry" commands can be put on
8724a single line, but then syntax errors may make it difficult to recognize the
8725"catch" line, thus you better avoid this.
8726 Example: >
8727 :try | unlet! foo # | catch | endtry
8728raises an error exception for the trailing characters after the ":unlet!"
8729argument, but does not see the ":catch" and ":endtry" commands, so that the
8730error exception is discarded and the "E488: Trailing characters" message gets
8731displayed.
8732
8733 *except-several-errors*
8734When several errors appear in a single command, the first error message is
8735usually the most specific one and therefor converted to the error exception.
8736 Example: >
8737 echo novar
8738causes >
8739 E121: Undefined variable: novar
8740 E15: Invalid expression: novar
8741The value of the error exception inside try conditionals is: >
8742 Vim(echo):E121: Undefined variable: novar
8743< *except-syntax-error*
8744But when a syntax error is detected after a normal error in the same command,
8745the syntax error is used for the exception being thrown.
8746 Example: >
8747 unlet novar #
8748causes >
8749 E108: No such variable: "novar"
8750 E488: Trailing characters
8751The value of the error exception inside try conditionals is: >
8752 Vim(unlet):E488: Trailing characters
8753This is done because the syntax error might change the execution path in a way
8754not intended by the user. Example: >
8755 try
8756 try | unlet novar # | catch | echo v:exception | endtry
8757 catch /.*/
8758 echo "outer catch:" v:exception
8759 endtry
8760This displays "outer catch: Vim(unlet):E488: Trailing characters", and then
8761a "E600: Missing :endtry" error message is given, see |except-single-line|.
8762
8763==============================================================================
87649. Examples *eval-examples*
8765
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008766Printing in Binary ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00008767>
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008768 :" The function Nr2Bin() returns the binary string representation of a number.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008769 :func Nr2Bin(nr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008770 : let n = a:nr
8771 : let r = ""
8772 : while n
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008773 : let r = '01'[n % 2] . r
8774 : let n = n / 2
Bram Moolenaar071d4272004-06-13 20:20:40 +00008775 : endwhile
8776 : return r
8777 :endfunc
8778
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008779 :" The function String2Bin() converts each character in a string to a
8780 :" binary string, separated with dashes.
8781 :func String2Bin(str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782 : let out = ''
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008783 : for ix in range(strlen(a:str))
8784 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix]))
8785 : endfor
8786 : return out[1:]
Bram Moolenaar071d4272004-06-13 20:20:40 +00008787 :endfunc
8788
8789Example of its use: >
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008790 :echo Nr2Bin(32)
8791result: "100000" >
8792 :echo String2Bin("32")
8793result: "110011-110010"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008794
8795
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008796Sorting lines ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00008797
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008798This example sorts lines with a specific compare function. >
8799
8800 :func SortBuffer()
8801 : let lines = getline(1, '$')
8802 : call sort(lines, function("Strcmp"))
8803 : call setline(1, lines)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008804 :endfunction
8805
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008806As a one-liner: >
8807 :call setline(1, sort(getline(1, '$'), function("Strcmp")))
Bram Moolenaar071d4272004-06-13 20:20:40 +00008808
Bram Moolenaar071d4272004-06-13 20:20:40 +00008809
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008810scanf() replacement ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00008811 *sscanf*
8812There is no sscanf() function in Vim. If you need to extract parts from a
8813line, you can use matchstr() and substitute() to do it. This example shows
8814how to get the file name, line number and column number out of a line like
8815"foobar.txt, 123, 45". >
8816 :" Set up the match bit
8817 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)'
8818 :"get the part matching the whole expression
8819 :let l = matchstr(line, mx)
8820 :"get each item out of the match
8821 :let file = substitute(l, mx, '\1', '')
8822 :let lnum = substitute(l, mx, '\2', '')
8823 :let col = substitute(l, mx, '\3', '')
8824
8825The input is in the variable "line", the results in the variables "file",
8826"lnum" and "col". (idea from Michael Geddes)
8827
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008828
8829getting the scriptnames in a Dictionary ~
8830 *scriptnames-dictionary*
8831The |:scriptnames| command can be used to get a list of all script files that
8832have been sourced. There is no equivalent function or variable for this
8833(because it's rarely needed). In case you need to manipulate the list this
8834code can be used: >
8835 " Get the output of ":scriptnames" in the scriptnames_output variable.
8836 let scriptnames_output = ''
8837 redir => scriptnames_output
8838 silent scriptnames
8839 redir END
8840
Bram Moolenaar446cb832008-06-24 21:56:24 +00008841 " Split the output into lines and parse each line. Add an entry to the
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008842 " "scripts" dictionary.
8843 let scripts = {}
8844 for line in split(scriptnames_output, "\n")
8845 " Only do non-blank lines.
8846 if line =~ '\S'
8847 " Get the first number in the line.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008848 let nr = matchstr(line, '\d\+')
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008849 " Get the file name, remove the script number " 123: ".
Bram Moolenaar446cb832008-06-24 21:56:24 +00008850 let name = substitute(line, '.\+:\s*', '', '')
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008851 " Add an item to the Dictionary
Bram Moolenaar446cb832008-06-24 21:56:24 +00008852 let scripts[nr] = name
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008853 endif
8854 endfor
8855 unlet scriptnames_output
8856
Bram Moolenaar071d4272004-06-13 20:20:40 +00008857==============================================================================
885810. No +eval feature *no-eval-feature*
8859
8860When the |+eval| feature was disabled at compile time, none of the expression
8861evaluation commands are available. To prevent this from causing Vim scripts
8862to generate all kinds of errors, the ":if" and ":endif" commands are still
8863recognized, though the argument of the ":if" and everything between the ":if"
8864and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but
8865only if the commands are at the start of the line. The ":else" command is not
8866recognized.
8867
8868Example of how to avoid executing commands when the |+eval| feature is
8869missing: >
8870
8871 :if 1
8872 : echo "Expression evaluation is compiled in"
8873 :else
8874 : echo "You will _never_ see this message"
8875 :endif
8876
8877==============================================================================
887811. The sandbox *eval-sandbox* *sandbox* *E48*
8879
Bram Moolenaar368373e2010-07-19 20:46:22 +02008880The 'foldexpr', 'formatexpr', 'includeexpr', 'indentexpr', 'statusline' and
8881'foldtext' options may be evaluated in a sandbox. This means that you are
8882protected from these expressions having nasty side effects. This gives some
8883safety for when these options are set from a modeline. It is also used when
8884the command from a tags file is executed and for CTRL-R = in the command line.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00008885The sandbox is also used for the |:sandbox| command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886
8887These items are not allowed in the sandbox:
8888 - changing the buffer text
8889 - defining or changing mapping, autocommands, functions, user commands
8890 - setting certain options (see |option-summary|)
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008891 - setting certain v: variables (see |v:var|) *E794*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008892 - executing a shell command
8893 - reading or writing a file
8894 - jumping to another buffer or editing a file
Bram Moolenaar4770d092006-01-12 23:22:24 +00008895 - executing Python, Perl, etc. commands
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00008896This is not guaranteed 100% secure, but it should block most attacks.
8897
8898 *:san* *:sandbox*
Bram Moolenaar045e82d2005-07-08 22:25:33 +00008899:san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00008900 option that may have been set from a modeline, e.g.
8901 'foldexpr'.
8902
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008903 *sandbox-option*
8904A few options contain an expression. When this expression is evaluated it may
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00008905have to be done in the sandbox to avoid a security risk. But the sandbox is
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008906restrictive, thus this only happens when the option was set from an insecure
8907location. Insecure in this context are:
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00008908- sourcing a .vimrc or .exrc in the current directory
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008909- while executing in the sandbox
8910- value coming from a modeline
8911
8912Note that when in the sandbox and saving an option value and restoring it, the
8913option will still be marked as it was set in the sandbox.
8914
8915==============================================================================
891612. Textlock *textlock*
8917
8918In a few situations it is not allowed to change the text in the buffer, jump
8919to another window and some other things that might confuse or break what Vim
8920is currently doing. This mostly applies to things that happen when Vim is
Bram Moolenaar446cb832008-06-24 21:56:24 +00008921actually doing something else. For example, evaluating the 'balloonexpr' may
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00008922happen any moment the mouse cursor is resting at some position.
8923
8924This is not allowed when the textlock is active:
8925 - changing the buffer text
8926 - jumping to another buffer or window
8927 - editing another file
8928 - closing a window or quitting Vim
8929 - etc.
8930
Bram Moolenaar071d4272004-06-13 20:20:40 +00008931
8932 vim:tw=78:ts=8:ft=help:norl: