blob: 06219666592ad82b5494d1fb80a90241474d1a5c [file] [log] [blame]
Bram Moolenaar60a8de22019-09-15 14:33:22 +02001*eval.txt* For Vim version 8.1. Last change: 2019 Sep 15
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
Bram Moolenaar446cb832008-06-24 21:56:24 +00004 VIM REFERENCE MANUAL by Bram Moolenaar
Bram Moolenaar071d4272004-06-13 20:20:40 +00005
6
7Expression evaluation *expression* *expr* *E15* *eval*
8
9Using expressions is introduced in chapter 41 of the user manual |usr_41.txt|.
10
11Note: Expression evaluation can be disabled at compile time. If this has been
Bram Moolenaar58b85342016-08-14 19:54:54 +020012done, the features in this document are not available. See |+eval| and
Bram Moolenaard8b02732005-01-14 21:48:43 +000013|no-eval-feature|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
Bram Moolenaar13065c42005-01-08 16:08:21 +0000151. Variables |variables|
16 1.1 Variable types
Bram Moolenaar9588a0f2005-01-08 21:45:39 +000017 1.2 Function references |Funcref|
Bram Moolenaar7c626922005-02-07 22:01:03 +000018 1.3 Lists |Lists|
Bram Moolenaard8b02732005-01-14 21:48:43 +000019 1.4 Dictionaries |Dictionaries|
Bram Moolenaard8968242019-01-15 22:51:57 +010020 1.5 Blobs |Blobs|
21 1.6 More about variables |more-variables|
Bram Moolenaar13065c42005-01-08 16:08:21 +0000222. Expression syntax |expression-syntax|
233. Internal variable |internal-variables|
244. Builtin Functions |functions|
255. Defining functions |user-functions|
266. Curly braces names |curly-braces-names|
277. Commands |expression-commands|
288. Exception handling |exception-handling|
299. Examples |eval-examples|
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02003010. Vim script version |vimscript-version|
3111. No +eval feature |no-eval-feature|
3212. The sandbox |eval-sandbox|
3313. Textlock |textlock|
Bram Moolenaared997ad2019-07-21 16:42:00 +020034
35Testing support is documented in |testing.txt|.
36Profiling is documented at |profiling|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000037
Bram Moolenaar071d4272004-06-13 20:20:40 +000038==============================================================================
391. Variables *variables*
40
Bram Moolenaar13065c42005-01-08 16:08:21 +0000411.1 Variable types ~
Bram Moolenaarbf821bc2019-01-23 21:15:02 +010042 *E712* *E896* *E897* *E899*
Bram Moolenaar06fe74a2019-08-31 16:20:32 +020043There are ten types of variables:
Bram Moolenaar071d4272004-06-13 20:20:40 +000044
Bram Moolenaar5302d9e2011-09-14 17:55:08 +020045Number A 32 or 64 bit signed number. |expr-number| *Number*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +020046 64-bit Numbers are available only when compiled with the
Bram Moolenaar22fcfad2016-07-01 18:17:26 +020047 |+num64| feature.
Bram Moolenaar7571d552016-08-18 22:54:46 +020048 Examples: -123 0x10 0177 0b1011
Bram Moolenaard8b02732005-01-14 21:48:43 +000049
Bram Moolenaar446cb832008-06-24 21:56:24 +000050Float A floating point number. |floating-point-format| *Float*
51 {only when compiled with the |+float| feature}
52 Examples: 123.456 1.15e-6 -1.1e3
53
Bram Moolenaar06481422016-04-30 15:13:38 +020054 *E928*
Bram Moolenaard8b02732005-01-14 21:48:43 +000055String A NUL terminated string of 8-bit unsigned characters (bytes).
Bram Moolenaar446cb832008-06-24 21:56:24 +000056 |expr-string| Examples: "ab\txx\"--" 'x-z''a,c'
Bram Moolenaard8b02732005-01-14 21:48:43 +000057
Bram Moolenaard8968242019-01-15 22:51:57 +010058List An ordered sequence of items, see |List| for details.
Bram Moolenaard8b02732005-01-14 21:48:43 +000059 Example: [1, 2, ['a', 'b']]
Bram Moolenaar071d4272004-06-13 20:20:40 +000060
Bram Moolenaar39a58ca2005-06-27 22:42:44 +000061Dictionary An associative, unordered array: Each entry has a key and a
62 value. |Dictionary|
Bram Moolenaard5abb4c2019-07-13 22:46:10 +020063 Examples:
64 {'blue': "#0000ff", 'red': "#ff0000"}
Bram Moolenaar4c6d9042019-07-16 22:04:02 +020065 #{blue: "#0000ff", red: "#ff0000"}
Bram Moolenaar39a58ca2005-06-27 22:42:44 +000066
Bram Moolenaar835dc632016-02-07 14:27:38 +010067Funcref A reference to a function |Funcref|.
68 Example: function("strlen")
Bram Moolenaar1d429612016-05-24 15:44:17 +020069 It can be bound to a dictionary and arguments, it then works
70 like a Partial.
71 Example: function("Callback", [arg], myDict)
Bram Moolenaar835dc632016-02-07 14:27:38 +010072
Bram Moolenaar02e83b42016-02-21 20:10:26 +010073Special |v:false|, |v:true|, |v:none| and |v:null|. *Special*
Bram Moolenaar835dc632016-02-07 14:27:38 +010074
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +020075Job Used for a job, see |job_start()|. *Job* *Jobs*
Bram Moolenaar38a55632016-02-15 22:07:32 +010076
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +020077Channel Used for a channel, see |ch_open()|. *Channel* *Channels*
Bram Moolenaar835dc632016-02-07 14:27:38 +010078
Bram Moolenaard8968242019-01-15 22:51:57 +010079Blob Binary Large Object. Stores any sequence of bytes. See |Blob|
80 for details
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +010081 Example: 0zFF00ED015DAF
82 0z is an empty Blob.
83
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +000084The Number and String types are converted automatically, depending on how they
85are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +000086
87Conversion from a Number to a String is by making the ASCII representation of
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +020088the Number. Examples:
89 Number 123 --> String "123" ~
90 Number 0 --> String "0" ~
91 Number -1 --> String "-1" ~
Bram Moolenaar00a927d2010-05-14 23:24:24 +020092 *octal*
Bram Moolenaarfa735342016-01-03 22:14:44 +010093Conversion from a String to a Number is done by converting the first digits to
94a number. Hexadecimal "0xf9", Octal "017", and Binary "0b10" numbers are
Bram Moolenaar60a8de22019-09-15 14:33:22 +020095recognized (NOTE: when using |scriptversion-4| octal is not recognized). If
96the String doesn't start with digits, the result is zero.
Bram Moolenaarfa735342016-01-03 22:14:44 +010097Examples:
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +020098 String "456" --> Number 456 ~
99 String "6bar" --> Number 6 ~
100 String "foo" --> Number 0 ~
101 String "0xf1" --> Number 241 ~
102 String "0100" --> Number 64 ~
Bram Moolenaarfa735342016-01-03 22:14:44 +0100103 String "0b101" --> Number 5 ~
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +0200104 String "-8" --> Number -8 ~
105 String "+8" --> Number 0 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106
107To force conversion from String to Number, add zero to it: >
108 :echo "0100" + 0
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000109< 64 ~
110
111To avoid a leading zero to cause octal conversion, or for using a different
112base, use |str2nr()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113
Bram Moolenaard09091d2019-01-17 16:07:22 +0100114 *TRUE* *FALSE* *Boolean*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE.
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200116You can also use |v:false| and |v:true|. When TRUE is returned from a
117function it is the Number one, FALSE is the number zero.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000118
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200119Note that in the command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000120 :if "foo"
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200121 :" NOT executed
122"foo" is converted to 0, which means FALSE. If the string starts with a
123non-zero number it means TRUE: >
124 :if "8foo"
125 :" executed
126To test for a non-empty string, use empty(): >
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200127 :if !empty("foo")
Bram Moolenaar835dc632016-02-07 14:27:38 +0100128<
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200129 *non-zero-arg*
130Function arguments often behave slightly different from |TRUE|: If the
131argument is present and it evaluates to a non-zero Number, |v:true| or a
Bram Moolenaar64d8e252016-09-06 22:12:34 +0200132non-empty String, then the value is considered to be TRUE.
Bram Moolenaar01164a62017-11-02 22:58:42 +0100133Note that " " and "0" are also non-empty strings, thus considered to be TRUE.
134A List, Dictionary or Float is not a Number or String, thus evaluate to FALSE.
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200135
Bram Moolenaar38a55632016-02-15 22:07:32 +0100136 *E745* *E728* *E703* *E729* *E730* *E731* *E908* *E910* *E913*
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +0100137 *E974* *E975* *E976*
Bram Moolenaard09091d2019-01-17 16:07:22 +0100138|List|, |Dictionary|, |Funcref|, |Job|, |Channel| and |Blob| types are not
139automatically converted.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000140
Bram Moolenaar446cb832008-06-24 21:56:24 +0000141 *E805* *E806* *E808*
Bram Moolenaar58b85342016-08-14 19:54:54 +0200142When mixing Number and Float the Number is converted to Float. Otherwise
Bram Moolenaar446cb832008-06-24 21:56:24 +0000143there is no automatic conversion of Float. You can use str2float() for String
144to Float, printf() for Float to String and float2nr() for Float to Number.
145
Bram Moolenaar38a55632016-02-15 22:07:32 +0100146 *E891* *E892* *E893* *E894* *E907* *E911* *E914*
Bram Moolenaar13d5aee2016-01-21 23:36:05 +0100147When expecting a Float a Number can also be used, but nothing else.
148
Bram Moolenaarf6f32c32016-03-12 19:03:59 +0100149 *no-type-checking*
150You will not get an error if you try to change the type of a variable.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000151
Bram Moolenaar13065c42005-01-08 16:08:21 +0000152
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00001531.2 Function references ~
Bram Moolenaar748bf032005-02-02 23:04:36 +0000154 *Funcref* *E695* *E718*
Bram Moolenaar58b85342016-08-14 19:54:54 +0200155A Funcref variable is obtained with the |function()| function, the |funcref()|
156function or created with the lambda expression |expr-lambda|. It can be used
157in an expression in the place of a function name, before the parenthesis
158around the arguments, to invoke the function it refers to. Example: >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000159
160 :let Fn = function("MyFunc")
161 :echo Fn()
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000162< *E704* *E705* *E707*
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000163A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200164can use "g:" but the following name must still start with a capital. You
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000165cannot have both a Funcref variable and a function with the same name.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000166
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000167A special case is defining a function and directly assigning its Funcref to a
168Dictionary entry. Example: >
169 :function dict.init() dict
170 : let self.val = 0
171 :endfunction
172
173The key of the Dictionary can start with a lower case letter. The actual
174function name is not used here. Also see |numbered-function|.
175
176A Funcref can also be used with the |:call| command: >
177 :call Fn()
178 :call dict.init()
Bram Moolenaar13065c42005-01-08 16:08:21 +0000179
180The name of the referenced function can be obtained with |string()|. >
Bram Moolenaar383f9bc2005-01-19 22:18:32 +0000181 :let func = string(Fn)
Bram Moolenaar13065c42005-01-08 16:08:21 +0000182
183You can use |call()| to invoke a Funcref and use a list variable for the
184arguments: >
Bram Moolenaar383f9bc2005-01-19 22:18:32 +0000185 :let r = call(Fn, mylist)
Bram Moolenaar1d429612016-05-24 15:44:17 +0200186<
187 *Partial*
188A Funcref optionally binds a Dictionary and/or arguments. This is also called
189a Partial. This is created by passing the Dictionary and/or arguments to
Bram Moolenaar58b85342016-08-14 19:54:54 +0200190function() or funcref(). When calling the function the Dictionary and/or
191arguments will be passed to the function. Example: >
Bram Moolenaar1d429612016-05-24 15:44:17 +0200192
193 let Cb = function('Callback', ['foo'], myDict)
Bram Moolenaarba3ff532018-11-04 14:45:49 +0100194 call Cb('bar')
Bram Moolenaar1d429612016-05-24 15:44:17 +0200195
196This will invoke the function as if using: >
Bram Moolenaarba3ff532018-11-04 14:45:49 +0100197 call myDict.Callback('foo', 'bar')
Bram Moolenaar1d429612016-05-24 15:44:17 +0200198
199This is very useful when passing a function around, e.g. in the arguments of
200|ch_open()|.
201
202Note that binding a function to a Dictionary also happens when the function is
203a member of the Dictionary: >
204
205 let myDict.myFunction = MyFunction
206 call myDict.myFunction()
207
208Here MyFunction() will get myDict passed as "self". This happens when the
209"myFunction" member is accessed. When making assigning "myFunction" to
210otherDict and calling it, it will be bound to otherDict: >
211
212 let otherDict.myFunction = myDict.myFunction
213 call otherDict.myFunction()
214
215Now "self" will be "otherDict". But when the dictionary was bound explicitly
216this won't happen: >
217
218 let myDict.myFunction = function(MyFunction, myDict)
219 let otherDict.myFunction = myDict.myFunction
220 call otherDict.myFunction()
221
Bram Moolenaard823fa92016-08-12 16:29:27 +0200222Here "self" will be "myDict", because it was bound explicitly.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000223
224
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00002251.3 Lists ~
Bram Moolenaar7e38ea22014-04-05 22:55:53 +0200226 *list* *List* *Lists* *E686*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000227A List is an ordered sequence of items. An item can be of any type. Items
Bram Moolenaar58b85342016-08-14 19:54:54 +0200228can be accessed by their index number. Items can be added and removed at any
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000229position in the sequence.
230
Bram Moolenaar13065c42005-01-08 16:08:21 +0000231
232List creation ~
233 *E696* *E697*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000234A List is created with a comma separated list of items in square brackets.
Bram Moolenaar13065c42005-01-08 16:08:21 +0000235Examples: >
236 :let mylist = [1, two, 3, "four"]
237 :let emptylist = []
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000238
Bram Moolenaar58b85342016-08-14 19:54:54 +0200239An item can be any expression. Using a List for an item creates a
Bram Moolenaarf9393ef2006-04-24 19:47:27 +0000240List of Lists: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000241 :let nestlist = [[11, 12], [21, 22], [31, 32]]
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000242
243An extra comma after the last item is ignored.
244
Bram Moolenaar13065c42005-01-08 16:08:21 +0000245
246List index ~
247 *list-index* *E684*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000248An item in the List can be accessed by putting the index in square brackets
Bram Moolenaar13065c42005-01-08 16:08:21 +0000249after the List. Indexes are zero-based, thus the first item has index zero. >
250 :let item = mylist[0] " get the first item: 1
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000251 :let item = mylist[2] " get the third item: 3
Bram Moolenaar13065c42005-01-08 16:08:21 +0000252
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000253When the resulting item is a list this can be repeated: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000254 :let item = nestlist[0][1] " get the first list, second item: 12
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000255<
Bram Moolenaar13065c42005-01-08 16:08:21 +0000256A negative index is counted from the end. Index -1 refers to the last item in
257the List, -2 to the last but one item, etc. >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000258 :let last = mylist[-1] " get the last item: "four"
259
Bram Moolenaar13065c42005-01-08 16:08:21 +0000260To avoid an error for an invalid index use the |get()| function. When an item
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000261is not available it returns zero or the default value you specify: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000262 :echo get(mylist, idx)
263 :echo get(mylist, idx, "NONE")
264
265
266List concatenation ~
267
268Two lists can be concatenated with the "+" operator: >
269 :let longlist = mylist + [5, 6]
Bram Moolenaar383f9bc2005-01-19 22:18:32 +0000270 :let mylist += [7, 8]
Bram Moolenaar13065c42005-01-08 16:08:21 +0000271
272To prepend or append an item turn the item into a list by putting [] around
273it. To change a list in-place see |list-modification| below.
274
275
276Sublist ~
Bram Moolenaarbc8801c2016-08-02 21:04:33 +0200277 *sublist*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000278A part of the List can be obtained by specifying the first and last index,
279separated by a colon in square brackets: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000280 :let shortlist = mylist[2:-1] " get List [3, "four"]
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000281
282Omitting the first index is similar to zero. Omitting the last index is
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000283similar to -1. >
Bram Moolenaar540d6e32005-01-09 21:20:18 +0000284 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"]
285 :let shortlist = mylist[2:2] " List with one item: [3]
286 :let otherlist = mylist[:] " make a copy of the List
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000287
Bram Moolenaarf9393ef2006-04-24 19:47:27 +0000288If the first index is beyond the last item of the List or the second item is
289before the first item, the result is an empty list. There is no error
290message.
291
292If the second index is equal to or greater than the length of the list the
293length minus one is used: >
Bram Moolenaar9e54a0e2006-04-14 20:42:25 +0000294 :let mylist = [0, 1, 2, 3]
295 :echo mylist[2:8] " result: [2, 3]
296
Bram Moolenaara7fc0102005-05-18 22:17:12 +0000297NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for
Bram Moolenaar58b85342016-08-14 19:54:54 +0200298using a single letter variable before the ":". Insert a space when needed:
Bram Moolenaara7fc0102005-05-18 22:17:12 +0000299mylist[s : e].
300
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +0000301
Bram Moolenaar13065c42005-01-08 16:08:21 +0000302List identity ~
Bram Moolenaard8b02732005-01-14 21:48:43 +0000303 *list-identity*
Bram Moolenaar13065c42005-01-08 16:08:21 +0000304When variable "aa" is a list and you assign it to another variable "bb", both
305variables refer to the same list. Thus changing the list "aa" will also
306change "bb": >
307 :let aa = [1, 2, 3]
308 :let bb = aa
309 :call add(aa, 4)
310 :echo bb
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000311< [1, 2, 3, 4]
Bram Moolenaar13065c42005-01-08 16:08:21 +0000312
313Making a copy of a list is done with the |copy()| function. Using [:] also
314works, as explained above. This creates a shallow copy of the list: Changing
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000315a list item in the list will also change the item in the copied list: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000316 :let aa = [[1, 'a'], 2, 3]
317 :let bb = copy(aa)
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000318 :call add(aa, 4)
Bram Moolenaar13065c42005-01-08 16:08:21 +0000319 :let aa[0][1] = 'aaa'
320 :echo aa
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000321< [[1, aaa], 2, 3, 4] >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000322 :echo bb
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000323< [[1, aaa], 2, 3]
Bram Moolenaar13065c42005-01-08 16:08:21 +0000324
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000325To make a completely independent list use |deepcopy()|. This also makes a
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000326copy of the values in the list, recursively. Up to a hundred levels deep.
Bram Moolenaar13065c42005-01-08 16:08:21 +0000327
328The operator "is" can be used to check if two variables refer to the same
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000329List. "isnot" does the opposite. In contrast "==" compares if two lists have
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000330the same value. >
331 :let alist = [1, 2, 3]
332 :let blist = [1, 2, 3]
333 :echo alist is blist
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000334< 0 >
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000335 :echo alist == blist
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000336< 1
Bram Moolenaar13065c42005-01-08 16:08:21 +0000337
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +0000338Note about comparing lists: Two lists are considered equal if they have the
339same length and all items compare equal, as with using "==". There is one
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000340exception: When comparing a number with a string they are considered
341different. There is no automatic type conversion, as with using "==" on
342variables. Example: >
343 echo 4 == "4"
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +0000344< 1 >
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000345 echo [4] == ["4"]
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +0000346< 0
347
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000348Thus comparing Lists is more strict than comparing numbers and strings. You
Bram Moolenaar446cb832008-06-24 21:56:24 +0000349can compare simple values this way too by putting them in a list: >
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000350
351 :let a = 5
352 :let b = "5"
Bram Moolenaar446cb832008-06-24 21:56:24 +0000353 :echo a == b
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000354< 1 >
Bram Moolenaar446cb832008-06-24 21:56:24 +0000355 :echo [a] == [b]
Bram Moolenaar7d1f5db2005-07-03 21:39:27 +0000356< 0
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +0000357
Bram Moolenaar13065c42005-01-08 16:08:21 +0000358
359List unpack ~
360
361To unpack the items in a list to individual variables, put the variables in
362square brackets, like list items: >
363 :let [var1, var2] = mylist
364
365When the number of variables does not match the number of items in the list
366this produces an error. To handle any extra items from the list append ";"
367and a variable name: >
368 :let [var1, var2; rest] = mylist
369
370This works like: >
371 :let var1 = mylist[0]
372 :let var2 = mylist[1]
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +0000373 :let rest = mylist[2:]
Bram Moolenaar13065c42005-01-08 16:08:21 +0000374
375Except that there is no error if there are only two items. "rest" will be an
376empty list then.
377
378
379List modification ~
380 *list-modification*
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000381To change a specific item of a list use |:let| this way: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000382 :let list[4] = "four"
383 :let listlist[0][3] = item
384
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000385To change part of a list you can specify the first and last item to be
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000386modified. The value must at least have the number of items in the range: >
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000387 :let list[3:5] = [3, 4, 5]
388
Bram Moolenaar13065c42005-01-08 16:08:21 +0000389Adding and removing items from a list is done with functions. Here are a few
390examples: >
391 :call insert(list, 'a') " prepend item 'a'
392 :call insert(list, 'a', 3) " insert item 'a' before list[3]
393 :call add(list, "new") " append String item
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000394 :call add(list, [1, 2]) " append a List as one new item
Bram Moolenaar13065c42005-01-08 16:08:21 +0000395 :call extend(list, [1, 2]) " extend the list with two more items
396 :let i = remove(list, 3) " remove item 3
Bram Moolenaar9cd15162005-01-16 22:02:49 +0000397 :unlet list[3] " idem
Bram Moolenaar13065c42005-01-08 16:08:21 +0000398 :let l = remove(list, 3, -1) " remove items 3 to last item
Bram Moolenaar9cd15162005-01-16 22:02:49 +0000399 :unlet list[3 : ] " idem
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000400 :call filter(list, 'v:val !~ "x"') " remove items with an 'x'
Bram Moolenaar13065c42005-01-08 16:08:21 +0000401
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000402Changing the order of items in a list: >
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000403 :call sort(list) " sort a list alphabetically
404 :call reverse(list) " reverse the order of items
Bram Moolenaar327aa022014-03-25 18:24:23 +0100405 :call uniq(sort(list)) " sort and remove duplicates
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000406
Bram Moolenaar13065c42005-01-08 16:08:21 +0000407
408For loop ~
409
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000410The |:for| loop executes commands for each item in a list. A variable is set
411to each item in the list in sequence. Example: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000412 :for item in mylist
413 : call Doit(item)
Bram Moolenaar13065c42005-01-08 16:08:21 +0000414 :endfor
415
416This works like: >
417 :let index = 0
418 :while index < len(mylist)
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000419 : let item = mylist[index]
420 : :call Doit(item)
Bram Moolenaar13065c42005-01-08 16:08:21 +0000421 : let index = index + 1
422 :endwhile
423
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +0000424If all you want to do is modify each item in the list then the |map()|
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000425function will be a simpler method than a for loop.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +0000426
Bram Moolenaar58b85342016-08-14 19:54:54 +0200427Just like the |:let| command, |:for| also accepts a list of variables. This
Bram Moolenaar13065c42005-01-08 16:08:21 +0000428requires the argument to be a list of lists. >
429 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]]
430 : call Doit(lnum, col)
431 :endfor
432
433This works like a |:let| command is done for each list item. Again, the types
434must remain the same to avoid an error.
435
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000436It is also possible to put remaining items in a List variable: >
Bram Moolenaar13065c42005-01-08 16:08:21 +0000437 :for [i, j; rest] in listlist
438 : call Doit(i, j)
439 : if !empty(rest)
440 : echo "remainder: " . string(rest)
441 : endif
442 :endfor
443
444
445List functions ~
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000446 *E714*
Bram Moolenaar13065c42005-01-08 16:08:21 +0000447Functions that are useful with a List: >
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000448 :let r = call(funcname, list) " call a function with an argument list
Bram Moolenaar13065c42005-01-08 16:08:21 +0000449 :if empty(list) " check if list is empty
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000450 :let l = len(list) " number of items in list
451 :let big = max(list) " maximum value in list
452 :let small = min(list) " minimum value in list
Bram Moolenaar9588a0f2005-01-08 21:45:39 +0000453 :let xs = count(list, 'x') " count nr of times 'x' appears in list
454 :let i = index(list, 'x') " index of first 'x' in list
Bram Moolenaar13065c42005-01-08 16:08:21 +0000455 :let lines = getline(1, 10) " get ten text lines from buffer
456 :call append('$', lines) " append text lines in buffer
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +0000457 :let list = split("a b c") " create list from items in a string
458 :let string = join(list, ', ') " create string from list items
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000459 :let s = string(list) " String representation of list
460 :call map(list, '">> " . v:val') " prepend ">> " to each item
Bram Moolenaar13065c42005-01-08 16:08:21 +0000461
Bram Moolenaar0cb032e2005-04-23 20:52:00 +0000462Don't forget that a combination of features can make things simple. For
463example, to add up all the numbers in a list: >
464 :exe 'let sum = ' . join(nrlist, '+')
465
Bram Moolenaar13065c42005-01-08 16:08:21 +0000466
Bram Moolenaard8b02732005-01-14 21:48:43 +00004671.4 Dictionaries ~
Bram Moolenaard8968242019-01-15 22:51:57 +0100468 *dict* *Dict* *Dictionaries* *Dictionary*
Bram Moolenaard8b02732005-01-14 21:48:43 +0000469A Dictionary is an associative array: Each entry has a key and a value. The
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000470entry can be located with the key. The entries are stored without a specific
471ordering.
Bram Moolenaard8b02732005-01-14 21:48:43 +0000472
473
474Dictionary creation ~
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000475 *E720* *E721* *E722* *E723*
Bram Moolenaard8b02732005-01-14 21:48:43 +0000476A Dictionary is created with a comma separated list of entries in curly
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000477braces. Each entry has a key and a value, separated by a colon. Each key can
478only appear once. Examples: >
Bram Moolenaard8b02732005-01-14 21:48:43 +0000479 :let mydict = {1: 'one', 2: 'two', 3: 'three'}
480 :let emptydict = {}
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000481< *E713* *E716* *E717*
Bram Moolenaard8b02732005-01-14 21:48:43 +0000482A key is always a String. You can use a Number, it will be converted to a
483String automatically. Thus the String '4' and the number 4 will find the same
Bram Moolenaar58b85342016-08-14 19:54:54 +0200484entry. Note that the String '04' and the Number 04 are different, since the
Bram Moolenaard5abb4c2019-07-13 22:46:10 +0200485Number will be converted to the String '4'. The empty string can also be used
486as a key.
Bram Moolenaar56c860c2019-08-17 20:09:31 +0200487 *literal-Dict* *#{}*
Bram Moolenaar4c6d9042019-07-16 22:04:02 +0200488To avoid having to put quotes around every key the #{} form can be used. This
Bram Moolenaard5abb4c2019-07-13 22:46:10 +0200489does require the key to consist only of ASCII letters, digits, '-' and '_'.
490Example: >
Bram Moolenaar4c6d9042019-07-16 22:04:02 +0200491 let mydict = #{zero: 0, one_key: 1, two-key: 2, 333: 3}
492Note that 333 here is the string "333". Empty keys are not possible with #{}.
Bram Moolenaard8b02732005-01-14 21:48:43 +0000493
Bram Moolenaar58b85342016-08-14 19:54:54 +0200494A value can be any expression. Using a Dictionary for a value creates a
Bram Moolenaard8b02732005-01-14 21:48:43 +0000495nested Dictionary: >
496 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}}
497
498An extra comma after the last entry is ignored.
499
500
501Accessing entries ~
502
503The normal way to access an entry is by putting the key in square brackets: >
504 :let val = mydict["one"]
505 :let mydict["four"] = 4
506
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000507You can add new entries to an existing Dictionary this way, unlike Lists.
Bram Moolenaard8b02732005-01-14 21:48:43 +0000508
509For keys that consist entirely of letters, digits and underscore the following
510form can be used |expr-entry|: >
511 :let val = mydict.one
512 :let mydict.four = 4
513
514Since an entry can be any type, also a List and a Dictionary, the indexing and
515key lookup can be repeated: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000516 :echo dict.key[idx].key
Bram Moolenaard8b02732005-01-14 21:48:43 +0000517
518
519Dictionary to List conversion ~
520
Bram Moolenaar58b85342016-08-14 19:54:54 +0200521You may want to loop over the entries in a dictionary. For this you need to
Bram Moolenaard8b02732005-01-14 21:48:43 +0000522turn the Dictionary into a List and pass it to |:for|.
523
524Most often you want to loop over the keys, using the |keys()| function: >
525 :for key in keys(mydict)
526 : echo key . ': ' . mydict[key]
527 :endfor
528
529The List of keys is unsorted. You may want to sort them first: >
530 :for key in sort(keys(mydict))
531
532To loop over the values use the |values()| function: >
533 :for v in values(mydict)
534 : echo "value: " . v
535 :endfor
536
537If you want both the key and the value use the |items()| function. It returns
Bram Moolenaard47d5222018-12-09 20:43:55 +0100538a List in which each item is a List with two items, the key and the value: >
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000539 :for [key, value] in items(mydict)
540 : echo key . ': ' . value
Bram Moolenaard8b02732005-01-14 21:48:43 +0000541 :endfor
542
543
544Dictionary identity ~
Bram Moolenaar7c626922005-02-07 22:01:03 +0000545 *dict-identity*
Bram Moolenaard8b02732005-01-14 21:48:43 +0000546Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a
547Dictionary. Otherwise, assignment results in referring to the same
548Dictionary: >
549 :let onedict = {'a': 1, 'b': 2}
550 :let adict = onedict
551 :let adict['a'] = 11
552 :echo onedict['a']
553 11
554
Bram Moolenaarf3bd51a2005-06-14 22:11:18 +0000555Two Dictionaries compare equal if all the key-value pairs compare equal. For
556more info see |list-identity|.
Bram Moolenaard8b02732005-01-14 21:48:43 +0000557
558
559Dictionary modification ~
560 *dict-modification*
561To change an already existing entry of a Dictionary, or to add a new entry,
562use |:let| this way: >
563 :let dict[4] = "four"
564 :let dict['one'] = item
565
Bram Moolenaar9cd15162005-01-16 22:02:49 +0000566Removing an entry from a Dictionary is done with |remove()| or |:unlet|.
567Three ways to remove the entry with key "aaa" from dict: >
568 :let i = remove(dict, 'aaa')
569 :unlet dict.aaa
570 :unlet dict['aaa']
Bram Moolenaard8b02732005-01-14 21:48:43 +0000571
572Merging a Dictionary with another is done with |extend()|: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000573 :call extend(adict, bdict)
574This extends adict with all entries from bdict. Duplicate keys cause entries
575in adict to be overwritten. An optional third argument can change this.
Bram Moolenaar383f9bc2005-01-19 22:18:32 +0000576Note that the order of entries in a Dictionary is irrelevant, thus don't
577expect ":echo adict" to show the items from bdict after the older entries in
578adict.
Bram Moolenaard8b02732005-01-14 21:48:43 +0000579
580Weeding out entries from a Dictionary can be done with |filter()|: >
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000581 :call filter(dict, 'v:val =~ "x"')
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000582This removes all entries from "dict" with a value not matching 'x'.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000583
584
585Dictionary function ~
Bram Moolenaar26402cb2013-02-20 21:26:00 +0100586 *Dictionary-function* *self* *E725* *E862*
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000587When a function is defined with the "dict" attribute it can be used in a
Bram Moolenaar58b85342016-08-14 19:54:54 +0200588special way with a dictionary. Example: >
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000589 :function Mylen() dict
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000590 : return len(self.data)
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000591 :endfunction
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000592 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")}
593 :echo mydict.len()
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000594
595This is like a method in object oriented programming. The entry in the
596Dictionary is a |Funcref|. The local variable "self" refers to the dictionary
597the function was invoked from.
598
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000599It is also possible to add a function without the "dict" attribute as a
600Funcref to a Dictionary, but the "self" variable is not available then.
601
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000602 *numbered-function* *anonymous-function*
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000603To avoid the extra name for the function it can be defined and directly
604assigned to a Dictionary in this way: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000605 :let mydict = {'data': [0, 1, 2, 3]}
Bram Moolenaar5a5f4592015-04-13 12:43:06 +0200606 :function mydict.len()
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000607 : return len(self.data)
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000608 :endfunction
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000609 :echo mydict.len()
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000610
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000611The function will then get a number and the value of dict.len is a |Funcref|
Bram Moolenaar58b85342016-08-14 19:54:54 +0200612that references this function. The function can only be used through a
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000613|Funcref|. It will automatically be deleted when there is no |Funcref|
614remaining that refers to it.
615
616It is not necessary to use the "dict" attribute for a numbered function.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000617
Bram Moolenaar1affd722010-08-04 17:49:30 +0200618If you get an error for a numbered function, you can find out what it is with
619a trick. Assuming the function is 42, the command is: >
620 :function {42}
621
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000622
623Functions for Dictionaries ~
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000624 *E715*
625Functions that can be used with a Dictionary: >
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000626 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo"
627 :if empty(dict) " TRUE if dict is empty
628 :let l = len(dict) " number of items in dict
629 :let big = max(dict) " maximum value in dict
630 :let small = min(dict) " minimum value in dict
631 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict
632 :let s = string(dict) " String representation of dict
633 :call map(dict, '">> " . v:val') " prepend ">> " to each item
Bram Moolenaard8b02732005-01-14 21:48:43 +0000634
635
Bram Moolenaard8968242019-01-15 22:51:57 +01006361.5 Blobs ~
637 *blob* *Blob* *Blobs* *E978*
Bram Moolenaaraff74912019-03-30 18:11:49 +0100638A Blob is a binary object. It can be used to read an image from a file and
639send it over a channel, for example.
640
641A Blob mostly behaves like a |List| of numbers, where each number has the
642value of an 8-bit byte, from 0 to 255.
Bram Moolenaard8968242019-01-15 22:51:57 +0100643
644
645Blob creation ~
646
647A Blob can be created with a |blob-literal|: >
648 :let b = 0zFF00ED015DAF
Bram Moolenaar0d17f0d2019-01-22 22:20:38 +0100649Dots can be inserted between bytes (pair of hex characters) for readability,
650they don't change the value: >
651 :let b = 0zFF00.ED01.5DAF
Bram Moolenaard8968242019-01-15 22:51:57 +0100652
653A blob can be read from a file with |readfile()| passing the {type} argument
654set to "B", for example: >
655 :let b = readfile('image.png', 'B')
656
657A blob can be read from a channel with the |ch_readblob()| function.
658
659
660Blob index ~
661 *blob-index* *E979*
662A byte in the Blob can be accessed by putting the index in square brackets
663after the Blob. Indexes are zero-based, thus the first byte has index zero. >
664 :let myblob = 0z00112233
665 :let byte = myblob[0] " get the first byte: 0x00
666 :let byte = myblob[2] " get the third byte: 0x22
667
668A negative index is counted from the end. Index -1 refers to the last byte in
669the Blob, -2 to the last but one byte, etc. >
670 :let last = myblob[-1] " get the last byte: 0x33
671
672To avoid an error for an invalid index use the |get()| function. When an item
673is not available it returns -1 or the default value you specify: >
674 :echo get(myblob, idx)
675 :echo get(myblob, idx, 999)
676
677
Bram Moolenaar5e66b422019-01-24 21:58:10 +0100678Blob iteration ~
679
680The |:for| loop executes commands for each byte of a Blob. The loop variable is
681set to each byte in the Blob. Example: >
682 :for byte in 0z112233
683 : call Doit(byte)
684 :endfor
685This calls Doit() with 0x11, 0x22 and 0x33.
686
687
Bram Moolenaard8968242019-01-15 22:51:57 +0100688Blob concatenation ~
689
690Two blobs can be concatenated with the "+" operator: >
691 :let longblob = myblob + 0z4455
692 :let myblob += 0z6677
693
694To change a blob in-place see |blob-modification| below.
695
696
697Part of a blob ~
698
699A part of the Blob can be obtained by specifying the first and last index,
700separated by a colon in square brackets: >
701 :let myblob = 0z00112233
Bram Moolenaard09091d2019-01-17 16:07:22 +0100702 :let shortblob = myblob[1:2] " get 0z1122
Bram Moolenaard8968242019-01-15 22:51:57 +0100703 :let shortblob = myblob[2:-1] " get 0z2233
704
705Omitting the first index is similar to zero. Omitting the last index is
706similar to -1. >
707 :let endblob = myblob[2:] " from item 2 to the end: 0z2233
708 :let shortblob = myblob[2:2] " Blob with one byte: 0z22
709 :let otherblob = myblob[:] " make a copy of the Blob
710
Bram Moolenaard09091d2019-01-17 16:07:22 +0100711If the first index is beyond the last byte of the Blob or the second index is
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +0100712before the first index, the result is an empty Blob. There is no error
Bram Moolenaard8968242019-01-15 22:51:57 +0100713message.
714
715If the second index is equal to or greater than the length of the list the
716length minus one is used: >
717 :echo myblob[2:8] " result: 0z2233
718
719
720Blob modification ~
721 *blob-modification*
722To change a specific byte of a blob use |:let| this way: >
723 :let blob[4] = 0x44
724
725When the index is just one beyond the end of the Blob, it is appended. Any
726higher index is an error.
727
728To change a sequence of bytes the [:] notation can be used: >
729 let blob[1:3] = 0z445566
Bram Moolenaard09091d2019-01-17 16:07:22 +0100730The length of the replaced bytes must be exactly the same as the value
Bram Moolenaard8968242019-01-15 22:51:57 +0100731provided. *E972*
732
733To change part of a blob you can specify the first and last byte to be
Bram Moolenaard09091d2019-01-17 16:07:22 +0100734modified. The value must have the same number of bytes in the range: >
735 :let blob[3:5] = 0z334455
Bram Moolenaard8968242019-01-15 22:51:57 +0100736
737You can also use the functions |add()|, |remove()| and |insert()|.
738
739
740Blob identity ~
741
742Blobs can be compared for equality: >
743 if blob == 0z001122
744And for equal identity: >
745 if blob is otherblob
746< *blob-identity* *E977*
747When variable "aa" is a Blob and you assign it to another variable "bb", both
748variables refer to the same Blob. Then the "is" operator returns true.
749
750When making a copy using [:] or |copy()| the values are the same, but the
751identity is different: >
752 :let blob = 0z112233
753 :let blob2 = blob
754 :echo blob == blob2
755< 1 >
756 :echo blob is blob2
757< 1 >
758 :let blob3 = blob[:]
759 :echo blob == blob3
760< 1 >
761 :echo blob is blob3
762< 0
763
Bram Moolenaard09091d2019-01-17 16:07:22 +0100764Making a copy of a Blob is done with the |copy()| function. Using [:] also
Bram Moolenaard8968242019-01-15 22:51:57 +0100765works, as explained above.
766
767
7681.6 More about variables ~
Bram Moolenaar13065c42005-01-08 16:08:21 +0000769 *more-variables*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770If you need to know the type of a variable or expression, use the |type()|
771function.
772
773When the '!' flag is included in the 'viminfo' option, global variables that
774start with an uppercase letter, and don't contain a lowercase letter, are
775stored in the viminfo file |viminfo-file|.
776
777When the 'sessionoptions' option contains "global", global variables that
778start with an uppercase letter and contain at least one lowercase letter are
779stored in the session file |session-file|.
780
781variable name can be stored where ~
782my_var_6 not
783My_Var_6 session file
784MY_VAR_6 viminfo file
785
786
787It's possible to form a variable name with curly braces, see
788|curly-braces-names|.
789
790==============================================================================
7912. Expression syntax *expression-syntax*
792
793Expression syntax summary, from least to most significant:
794
Bram Moolenaar50ba5262016-09-22 22:33:02 +0200795|expr1| expr2
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200796 expr2 ? expr1 : expr1 if-then-else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200798|expr2| expr3
Bram Moolenaar0f248b02019-04-04 15:36:05 +0200799 expr3 || expr3 ... logical OR
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200801|expr3| expr4
Bram Moolenaar0f248b02019-04-04 15:36:05 +0200802 expr4 && expr4 ... logical AND
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200804|expr4| expr5
805 expr5 == expr5 equal
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806 expr5 != expr5 not equal
807 expr5 > expr5 greater than
808 expr5 >= expr5 greater than or equal
809 expr5 < expr5 smaller than
810 expr5 <= expr5 smaller than or equal
811 expr5 =~ expr5 regexp matches
812 expr5 !~ expr5 regexp doesn't match
813
814 expr5 ==? expr5 equal, ignoring case
815 expr5 ==# expr5 equal, match case
816 etc. As above, append ? for ignoring case, # for
817 matching case
818
Bram Moolenaar5e66b422019-01-24 21:58:10 +0100819 expr5 is expr5 same |List|, |Dictionary| or |Blob| instance
820 expr5 isnot expr5 different |List|, |Dictionary| or |Blob|
821 instance
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000822
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200823|expr5| expr6
Bram Moolenaar0f248b02019-04-04 15:36:05 +0200824 expr6 + expr6 ... number addition, list or blob concatenation
825 expr6 - expr6 ... number subtraction
826 expr6 . expr6 ... string concatenation
827 expr6 .. expr6 ... string concatenation
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200829|expr6| expr7
Bram Moolenaar0f248b02019-04-04 15:36:05 +0200830 expr7 * expr7 ... number multiplication
831 expr7 / expr7 ... number division
832 expr7 % expr7 ... number modulo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200834|expr7| expr8
835 ! expr7 logical NOT
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 - expr7 unary minus
837 + expr7 unary plus
Bram Moolenaar071d4272004-06-13 20:20:40 +0000838
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200839|expr8| expr9
840 expr8[expr1] byte of a String or item of a |List|
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000841 expr8[expr1 : expr1] substring of a String or sublist of a |List|
842 expr8.name entry in a |Dictionary|
843 expr8(expr1, ...) function call with |Funcref| variable
Bram Moolenaar25e42232019-08-04 15:04:10 +0200844 expr8->name(expr1, ...) |method| call
Bram Moolenaar2fda12f2005-01-15 22:14:15 +0000845
Bram Moolenaar50ba5262016-09-22 22:33:02 +0200846|expr9| number number constant
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000847 "string" string constant, backslash is special
Bram Moolenaard8b02732005-01-14 21:48:43 +0000848 'string' string constant, ' is doubled
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000849 [expr1, ...] |List|
850 {expr1: expr1, ...} |Dictionary|
Bram Moolenaar25e42232019-08-04 15:04:10 +0200851 #{key: expr1, ...} |Dictionary|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852 &option option value
853 (expr1) nested expression
854 variable internal variable
855 va{ria}ble internal variable with curly braces
856 $VAR environment variable
857 @r contents of register 'r'
858 function(expr1, ...) function call
859 func{ti}on(expr1, ...) function call with curly braces
Bram Moolenaar069c1e72016-07-15 21:25:08 +0200860 {args -> expr1} lambda expression
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861
862
Bram Moolenaar0f248b02019-04-04 15:36:05 +0200863"..." indicates that the operations in this level can be concatenated.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864Example: >
865 &nu || &list && &shell == "csh"
866
867All expressions within one level are parsed from left to right.
868
869
870expr1 *expr1* *E109*
871-----
872
873expr2 ? expr1 : expr1
874
875The expression before the '?' is evaluated to a number. If it evaluates to
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200876|TRUE|, the result is the value of the expression between the '?' and ':',
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877otherwise the result is the value of the expression after the ':'.
878Example: >
879 :echo lnum == 1 ? "top" : lnum
880
881Since the first expression is an "expr2", it cannot contain another ?:. The
882other two expressions can, thus allow for recursive use of ?:.
883Example: >
884 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum
885
886To keep this readable, using |line-continuation| is suggested: >
887 :echo lnum == 1
888 :\ ? "top"
889 :\ : lnum == 1000
890 :\ ? "last"
891 :\ : lnum
892
Bram Moolenaaref2f6562007-05-06 13:32:59 +0000893You should always put a space before the ':', otherwise it can be mistaken for
894use in a variable such as "a:1".
895
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896
897expr2 and expr3 *expr2* *expr3*
898---------------
899
Bram Moolenaar04186092016-08-29 21:55:35 +0200900expr3 || expr3 .. logical OR *expr-barbar*
901expr4 && expr4 .. logical AND *expr-&&*
902
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903The "||" and "&&" operators take one argument on each side. The arguments
904are (converted to) Numbers. The result is:
905
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200906 input output ~
907n1 n2 n1 || n2 n1 && n2 ~
908|FALSE| |FALSE| |FALSE| |FALSE|
909|FALSE| |TRUE| |TRUE| |FALSE|
910|TRUE| |FALSE| |TRUE| |FALSE|
911|TRUE| |TRUE| |TRUE| |TRUE|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912
913The operators can be concatenated, for example: >
914
915 &nu || &list && &shell == "csh"
916
917Note that "&&" takes precedence over "||", so this has the meaning of: >
918
919 &nu || (&list && &shell == "csh")
920
921Once the result is known, the expression "short-circuits", that is, further
922arguments are not evaluated. This is like what happens in C. For example: >
923
924 let a = 1
925 echo a || b
926
Bram Moolenaare381d3d2016-07-07 14:50:41 +0200927This is valid even if there is no variable called "b" because "a" is |TRUE|,
928so the result must be |TRUE|. Similarly below: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929
930 echo exists("b") && b == "yes"
931
932This is valid whether "b" has been defined or not. The second clause will
933only be evaluated if "b" has been defined.
934
935
936expr4 *expr4*
937-----
938
939expr5 {cmp} expr5
940
941Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1
942if it evaluates to true.
943
Bram Moolenaar446cb832008-06-24 21:56:24 +0000944 *expr-==* *expr-!=* *expr->* *expr->=*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945 *expr-<* *expr-<=* *expr-=~* *expr-!~*
946 *expr-==#* *expr-!=#* *expr->#* *expr->=#*
947 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#*
948 *expr-==?* *expr-!=?* *expr->?* *expr->=?*
949 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?*
Bram Moolenaar251e1912011-06-19 05:09:16 +0200950 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#*
951 *expr-is?* *expr-isnot?*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000952 use 'ignorecase' match case ignore case ~
953equal == ==# ==?
954not equal != !=# !=?
955greater than > ># >?
956greater than or equal >= >=# >=?
957smaller than < <# <?
958smaller than or equal <= <=# <=?
959regexp matches =~ =~# =~?
960regexp doesn't match !~ !~# !~?
Bram Moolenaar251e1912011-06-19 05:09:16 +0200961same instance is is# is?
962different instance isnot isnot# isnot?
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963
964Examples:
965"abc" ==# "Abc" evaluates to 0
966"abc" ==? "Abc" evaluates to 1
967"abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise
968
Bram Moolenaar13065c42005-01-08 16:08:21 +0000969 *E691* *E692*
Bram Moolenaar01164a62017-11-02 22:58:42 +0100970A |List| can only be compared with a |List| and only "equal", "not equal",
971"is" and "isnot" can be used. This compares the values of the list,
972recursively. Ignoring case means case is ignored when comparing item values.
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000973
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000974 *E735* *E736*
Bram Moolenaar32466aa2006-02-24 23:53:04 +0000975A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not
Bram Moolenaar01164a62017-11-02 22:58:42 +0100976equal", "is" and "isnot" can be used. This compares the key/values of the
977|Dictionary| recursively. Ignoring case means case is ignored when comparing
978item values.
Bram Moolenaar3a3a7232005-01-17 22:16:15 +0000979
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +0200980 *E694*
Bram Moolenaare18dbe82016-07-02 21:42:23 +0200981A |Funcref| can only be compared with a |Funcref| and only "equal", "not
982equal", "is" and "isnot" can be used. Case is never ignored. Whether
983arguments or a Dictionary are bound (with a partial) matters. The
984Dictionaries must also be equal (or the same, in case of "is") and the
985arguments must be equal (or the same).
986
987To compare Funcrefs to see if they refer to the same function, ignoring bound
988Dictionary and arguments, use |get()| to get the function name: >
989 if get(Part1, 'name') == get(Part2, 'name')
990 " Part1 and Part2 refer to the same function
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000991
Bram Moolenaar5e66b422019-01-24 21:58:10 +0100992Using "is" or "isnot" with a |List|, |Dictionary| or |Blob| checks whether
993the expressions are referring to the same |List|, |Dictionary| or |Blob|
994instance. A copy of a |List| is different from the original |List|. When
995using "is" without a |List|, |Dictionary| or |Blob|, it is equivalent to
996using "equal", using "isnot" equivalent to using "not equal". Except that
997a different type means the values are different: >
Bram Moolenaar86edef62016-03-13 18:07:30 +0100998 echo 4 == '4'
999 1
1000 echo 4 is '4'
1001 0
1002 echo 0 is []
1003 0
1004"is#"/"isnot#" and "is?"/"isnot?" can be used to match and ignore case.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001005
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006When comparing a String with a Number, the String is converted to a Number,
Bram Moolenaar58b85342016-08-14 19:54:54 +02001007and the comparison is done on Numbers. This means that: >
Bram Moolenaar86edef62016-03-13 18:07:30 +01001008 echo 0 == 'x'
1009 1
1010because 'x' converted to a Number is zero. However: >
1011 echo [0] == ['x']
1012 0
1013Inside a List or Dictionary this conversion is not used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001014
1015When comparing two Strings, this is done with strcmp() or stricmp(). This
1016results in the mathematical difference (comparing byte values), not
1017necessarily the alphabetical difference in the local language.
1018
Bram Moolenaar446cb832008-06-24 21:56:24 +00001019When using the operators with a trailing '#', or the short version and
Bram Moolenaaref2f6562007-05-06 13:32:59 +00001020'ignorecase' is off, the comparing is done with strcmp(): case matters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021
1022When using the operators with a trailing '?', or the short version and
Bram Moolenaaref2f6562007-05-06 13:32:59 +00001023'ignorecase' is set, the comparing is done with stricmp(): case is ignored.
1024
1025'smartcase' is not used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026
1027The "=~" and "!~" operators match the lefthand argument with the righthand
1028argument, which is used as a pattern. See |pattern| for what a pattern is.
1029This matching is always done like 'magic' was set and 'cpoptions' is empty, no
1030matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts
1031portable. To avoid backslashes in the regexp pattern to be doubled, use a
1032single-quote string, see |literal-string|.
1033Since a string is considered to be a single line, a multi-line pattern
1034(containing \n, backslash-n) will not match. However, a literal NL character
1035can be matched like an ordinary character. Examples:
1036 "foo\nbar" =~ "\n" evaluates to 1
1037 "foo\nbar" =~ "\\n" evaluates to 0
1038
1039
1040expr5 and expr6 *expr5* *expr6*
1041---------------
Bram Moolenaar0f248b02019-04-04 15:36:05 +02001042expr6 + expr6 Number addition, |List| or |Blob| concatenation *expr-+*
1043expr6 - expr6 Number subtraction *expr--*
1044expr6 . expr6 String concatenation *expr-.*
1045expr6 .. expr6 String concatenation *expr-..*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046
Bram Moolenaara23ccb82006-02-27 00:08:02 +00001047For |Lists| only "+" is possible and then both expr6 must be a list. The
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001048result is a new list with the two lists Concatenated.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001049
Bram Moolenaar0f248b02019-04-04 15:36:05 +02001050For String concatenation ".." is preferred, since "." is ambiguous, it is also
1051used for |Dict| member access and floating point numbers.
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02001052When |vimscript-version| is 2 or higher, using "." is not allowed.
Bram Moolenaar0f248b02019-04-04 15:36:05 +02001053
Bram Moolenaar5e66b422019-01-24 21:58:10 +01001054expr7 * expr7 Number multiplication *expr-star*
1055expr7 / expr7 Number division *expr-/*
1056expr7 % expr7 Number modulo *expr-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057
Bram Moolenaar62e1bb42019-04-08 16:25:07 +02001058For all, except "." and "..", Strings are converted to Numbers.
Bram Moolenaard6e256c2011-12-14 15:32:50 +01001059For bitwise operators see |and()|, |or()| and |xor()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060
1061Note the difference between "+" and ".":
1062 "123" + "456" = 579
1063 "123" . "456" = "123456"
1064
Bram Moolenaar446cb832008-06-24 21:56:24 +00001065Since '.' has the same precedence as '+' and '-', you need to read: >
1066 1 . 90 + 90.0
1067As: >
1068 (1 . 90) + 90.0
1069That works, since the String "190" is automatically converted to the Number
1070190, which can be added to the Float 90.0. However: >
1071 1 . 90 * 90.0
1072Should be read as: >
1073 1 . (90 * 90.0)
1074Since '.' has lower precedence than '*'. This does NOT work, since this
1075attempts to concatenate a Float and a String.
1076
1077When dividing a Number by zero the result depends on the value:
1078 0 / 0 = -0x80000000 (like NaN for Float)
1079 >0 / 0 = 0x7fffffff (like positive infinity)
1080 <0 / 0 = -0x7fffffff (like negative infinity)
1081 (before Vim 7.2 it was always 0x7fffffff)
1082
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02001083When 64-bit Number support is enabled:
1084 0 / 0 = -0x8000000000000000 (like NaN for Float)
1085 >0 / 0 = 0x7fffffffffffffff (like positive infinity)
1086 <0 / 0 = -0x7fffffffffffffff (like negative infinity)
1087
Bram Moolenaar071d4272004-06-13 20:20:40 +00001088When the righthand side of '%' is zero, the result is 0.
1089
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001090None of these work for |Funcref|s.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001091
Bram Moolenaar446cb832008-06-24 21:56:24 +00001092. and % do not work for Float. *E804*
1093
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094
1095expr7 *expr7*
1096-----
1097! expr7 logical NOT *expr-!*
1098- expr7 unary minus *expr-unary--*
1099+ expr7 unary plus *expr-unary-+*
1100
Bram Moolenaare381d3d2016-07-07 14:50:41 +02001101For '!' |TRUE| becomes |FALSE|, |FALSE| becomes |TRUE| (one).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102For '-' the sign of the number is changed.
1103For '+' the number is unchanged.
1104
1105A String will be converted to a Number first.
1106
Bram Moolenaar58b85342016-08-14 19:54:54 +02001107These three can be repeated and mixed. Examples:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 !-1 == 0
1109 !!8 == 1
1110 --9 == 9
1111
1112
1113expr8 *expr8*
1114-----
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02001115This expression is either |expr9| or a sequence of the alternatives below,
1116in any order. E.g., these are all possible:
Bram Moolenaar25e42232019-08-04 15:04:10 +02001117 expr8[expr1].name
1118 expr8.name[expr1]
1119 expr8(expr1, ...)[expr1].name
1120 expr8->(expr1, ...)[expr1]
Bram Moolenaarac92e252019-08-03 21:58:38 +02001121Evaluation is always from left to right.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02001122
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001123expr8[expr1] item of String or |List| *expr-[]* *E111*
Bram Moolenaar03413f42016-04-12 21:07:15 +02001124 *E909* *subscript*
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001125If expr8 is a Number or String this results in a String that contains the
1126expr1'th single byte from expr8. expr8 is used as a String, expr1 as a
Bram Moolenaar50ba5262016-09-22 22:33:02 +02001127Number. This doesn't recognize multi-byte encodings, see `byteidx()` for
Bram Moolenaar03413f42016-04-12 21:07:15 +02001128an alternative, or use `split()` to turn the string into a list of characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129
Bram Moolenaar256972a2015-12-29 19:10:25 +01001130Index zero gives the first byte. This is like it works in C. Careful:
1131text column numbers start with one! Example, to get the byte under the
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001132cursor: >
Bram Moolenaar61660ea2006-04-07 21:40:07 +00001133 :let c = getline(".")[col(".") - 1]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001134
1135If the length of the String is less than the index, the result is an empty
Bram Moolenaar85084ef2016-01-17 22:26:33 +01001136String. A negative index always results in an empty string (reason: backward
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001137compatibility). Use [-1:] to get the last byte.
1138
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001139If expr8 is a |List| then it results the item at index expr1. See |list-index|
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001140for possible index values. If the index is out of range this results in an
Bram Moolenaar58b85342016-08-14 19:54:54 +02001141error. Example: >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001142 :let item = mylist[-1] " get last item
1143
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001144Generally, if a |List| index is equal to or higher than the length of the
1145|List|, or more negative than the length of the |List|, this results in an
1146error.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001147
Bram Moolenaard8b02732005-01-14 21:48:43 +00001148
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001149expr8[expr1a : expr1b] substring or sublist *expr-[:]*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001150
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001151If expr8 is a Number or String this results in the substring with the bytes
1152from expr1a to and including expr1b. expr8 is used as a String, expr1a and
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001153expr1b are used as a Number. This doesn't recognize multi-byte encodings, see
1154|byteidx()| for computing the indexes.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001155
1156If expr1a is omitted zero is used. If expr1b is omitted the length of the
1157string minus one is used.
1158
1159A negative number can be used to measure from the end of the string. -1 is
1160the last character, -2 the last but one, etc.
1161
1162If an index goes out of range for the string characters are omitted. If
1163expr1b is smaller than expr1a the result is an empty string.
1164
1165Examples: >
1166 :let c = name[-1:] " last byte of a string
1167 :let c = name[-2:-2] " last but one byte of a string
1168 :let s = line(".")[4:] " from the fifth byte to the end
1169 :let s = s[:-3] " remove last two bytes
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001170<
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02001171 *slice*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001172If expr8 is a |List| this results in a new |List| with the items indicated by
Bram Moolenaar58b85342016-08-14 19:54:54 +02001173the indexes expr1a and expr1b. This works like with a String, as explained
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02001174just above. Also see |sublist| below. Examples: >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00001175 :let l = mylist[:3] " first four items
1176 :let l = mylist[4:4] " List with one item
1177 :let l = mylist[:] " shallow copy of a List
1178
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01001179If expr8 is a |Blob| this results in a new |Blob| with the bytes in the
1180indexes expr1a and expr1b, inclusive. Examples: >
1181 :let b = 0zDEADBEEF
1182 :let bs = b[1:2] " 0zADBE
Bram Moolenaard09091d2019-01-17 16:07:22 +01001183 :let bs = b[:] " copy of 0zDEADBEEF
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01001184
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001185Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an
1186error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187
Bram Moolenaarda440d22016-01-16 21:27:23 +01001188Watch out for confusion between a namespace and a variable followed by a colon
1189for a sublist: >
1190 mylist[n:] " uses variable n
1191 mylist[s:] " uses namespace s:, error!
1192
Bram Moolenaard8b02732005-01-14 21:48:43 +00001193
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001194expr8.name entry in a |Dictionary| *expr-entry*
Bram Moolenaard8b02732005-01-14 21:48:43 +00001195
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001196If expr8 is a |Dictionary| and it is followed by a dot, then the following
1197name will be used as a key in the |Dictionary|. This is just like:
1198expr8[name].
Bram Moolenaard8b02732005-01-14 21:48:43 +00001199
1200The name must consist of alphanumeric characters, just like a variable name,
1201but it may start with a number. Curly braces cannot be used.
1202
1203There must not be white space before or after the dot.
1204
1205Examples: >
1206 :let dict = {"one": 1, 2: "two"}
Bram Moolenaar68e65602019-05-26 21:33:31 +02001207 :echo dict.one " shows "1"
1208 :echo dict.2 " shows "two"
1209 :echo dict .2 " error because of space before the dot
Bram Moolenaard8b02732005-01-14 21:48:43 +00001210
1211Note that the dot is also used for String concatenation. To avoid confusion
1212always put spaces around the dot for String concatenation.
1213
1214
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001215expr8(expr1, ...) |Funcref| function call
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001216
1217When expr8 is a |Funcref| type variable, invoke the function it refers to.
1218
1219
Bram Moolenaar22a0c0c2019-08-09 23:25:08 +02001220expr8->name([args]) method call *method* *->*
1221expr8->{lambda}([args])
Bram Moolenaar56c860c2019-08-17 20:09:31 +02001222 *E276*
Bram Moolenaar25e42232019-08-04 15:04:10 +02001223For methods that are also available as global functions this is the same as: >
Bram Moolenaarac92e252019-08-03 21:58:38 +02001224 name(expr8 [, args])
1225There can also be methods specifically for the type of "expr8".
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001226
Bram Moolenaar51841322019-08-08 21:10:01 +02001227This allows for chaining, passing the value that one method returns to the
1228next method: >
Bram Moolenaar25e42232019-08-04 15:04:10 +02001229 mylist->filter(filterexpr)->map(mapexpr)->sort()->join()
1230<
Bram Moolenaar22a0c0c2019-08-09 23:25:08 +02001231Example of using a lambda: >
Bram Moolenaar02b31112019-08-31 22:16:38 +02001232 GetPercentage()->{x -> x * 100}()->printf('%d%%')
Bram Moolenaar56c860c2019-08-17 20:09:31 +02001233<
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02001234When using -> the |expr7| operators will be applied first, thus: >
1235 -1.234->string()
1236Is equivalent to: >
1237 (-1.234)->string()
1238And NOT: >
1239 -(1.234->string())
1240<
Bram Moolenaar51841322019-08-08 21:10:01 +02001241 *E274*
1242"->name(" must not contain white space. There can be white space before the
1243"->" and after the "(", thus you can split the lines like this: >
1244 mylist
1245 \ ->filter(filterexpr)
1246 \ ->map(mapexpr)
1247 \ ->sort()
1248 \ ->join()
Bram Moolenaar56c860c2019-08-17 20:09:31 +02001249
1250When using the lambda form there must be no white space between the } and the
1251(.
1252
Bram Moolenaar25e42232019-08-04 15:04:10 +02001253
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001254 *expr9*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255number
1256------
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001257number number constant *expr-number*
Bram Moolenaar7571d552016-08-18 22:54:46 +02001258 *hex-number* *octal-number* *binary-number*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001259
Bram Moolenaar7571d552016-08-18 22:54:46 +02001260Decimal, Hexadecimal (starting with 0x or 0X), Binary (starting with 0b or 0B)
1261and Octal (starting with 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262
Bram Moolenaar446cb832008-06-24 21:56:24 +00001263 *floating-point-format*
1264Floating point numbers can be written in two forms:
1265
1266 [-+]{N}.{M}
Bram Moolenaar8a94d872015-01-25 13:02:57 +01001267 [-+]{N}.{M}[eE][-+]{exp}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001268
1269{N} and {M} are numbers. Both {N} and {M} must be present and can only
1270contain digits.
1271[-+] means there is an optional plus or minus sign.
1272{exp} is the exponent, power of 10.
Bram Moolenaar58b85342016-08-14 19:54:54 +02001273Only a decimal point is accepted, not a comma. No matter what the current
Bram Moolenaar446cb832008-06-24 21:56:24 +00001274locale is.
1275{only when compiled with the |+float| feature}
1276
1277Examples:
1278 123.456
1279 +0.0001
1280 55.0
1281 -0.123
1282 1.234e03
1283 1.0E-6
1284 -3.1416e+88
1285
1286These are INVALID:
1287 3. empty {M}
1288 1e40 missing .{M}
1289
1290Rationale:
1291Before floating point was introduced, the text "123.456" was interpreted as
1292the two numbers "123" and "456", both converted to a string and concatenated,
1293resulting in the string "123456". Since this was considered pointless, and we
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001294could not find it intentionally being used in Vim scripts, this backwards
Bram Moolenaar446cb832008-06-24 21:56:24 +00001295incompatibility was accepted in favor of being able to use the normal notation
1296for floating point numbers.
1297
Bram Moolenaard47d5222018-12-09 20:43:55 +01001298 *float-pi* *float-e*
1299A few useful values to copy&paste: >
1300 :let pi = 3.14159265359
1301 :let e = 2.71828182846
1302Or, if you don't want to write them in as floating-point literals, you can
1303also use functions, like the following: >
1304 :let pi = acos(-1.0)
1305 :let e = exp(1.0)
Bram Moolenaar98aefe72018-12-13 22:20:09 +01001306<
Bram Moolenaar446cb832008-06-24 21:56:24 +00001307 *floating-point-precision*
1308The precision and range of floating points numbers depends on what "double"
1309means in the library Vim was compiled with. There is no way to change this at
1310runtime.
1311
1312The default for displaying a |Float| is to use 6 decimal places, like using
1313printf("%g", f). You can select something else when using the |printf()|
1314function. Example: >
1315 :echo printf('%.15e', atan(1))
1316< 7.853981633974483e-01
1317
1318
Bram Moolenaar071d4272004-06-13 20:20:40 +00001319
Bram Moolenaar979243b2015-06-26 19:35:49 +02001320string *string* *String* *expr-string* *E114*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321------
1322"string" string constant *expr-quote*
1323
1324Note that double quotes are used.
1325
1326A string constant accepts these special characters:
1327\... three-digit octal number (e.g., "\316")
1328\.. two-digit octal number (must be followed by non-digit)
1329\. one-digit octal number (must be followed by non-digit)
1330\x.. byte specified with two hex numbers (e.g., "\x1f")
1331\x. byte specified with one hex number (must be followed by non-hex char)
1332\X.. same as \x..
1333\X. same as \x.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001334\u.... character specified with up to 4 hex numbers, stored according to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335 current value of 'encoding' (e.g., "\u02a4")
Bram Moolenaar541f92d2015-06-19 13:27:23 +02001336\U.... same as \u but allows up to 8 hex numbers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001337\b backspace <BS>
1338\e escape <Esc>
1339\f formfeed <FF>
1340\n newline <NL>
1341\r return <CR>
1342\t tab <Tab>
1343\\ backslash
1344\" double quote
Bram Moolenaar00a927d2010-05-14 23:24:24 +02001345\<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use
Bram Moolenaar58b85342016-08-14 19:54:54 +02001346 in mappings, the 0x80 byte is escaped.
1347 To use the double quote character it must be escaped: "<M-\">".
1348 Don't use <Char-xxxx> to get a utf-8 character, use \uxxxx as
1349 mentioned above.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350
Bram Moolenaaref2f6562007-05-06 13:32:59 +00001351Note that "\xff" is stored as the byte 255, which may be invalid in some
1352encodings. Use "\u00ff" to store character 255 according to the current value
1353of 'encoding'.
1354
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355Note that "\000" and "\x00" force the end of the string.
1356
1357
Bram Moolenaard8968242019-01-15 22:51:57 +01001358blob-literal *blob-literal* *E973*
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01001359------------
1360
1361Hexadecimal starting with 0z or 0Z, with an arbitrary number of bytes.
1362The sequence must be an even number of hex characters. Example: >
1363 :let b = 0zFF00ED015DAF
1364
1365
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366literal-string *literal-string* *E115*
1367---------------
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001368'string' string constant *expr-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369
1370Note that single quotes are used.
1371
Bram Moolenaar58b85342016-08-14 19:54:54 +02001372This string is taken as it is. No backslashes are removed or have a special
Bram Moolenaard8b02732005-01-14 21:48:43 +00001373meaning. The only exception is that two quotes stand for one quote.
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001374
1375Single quoted strings are useful for patterns, so that backslashes do not need
Bram Moolenaar58b85342016-08-14 19:54:54 +02001376to be doubled. These two commands are equivalent: >
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001377 if a =~ "\\s*"
1378 if a =~ '\s*'
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379
1380
1381option *expr-option* *E112* *E113*
1382------
1383&option option value, local value if possible
1384&g:option global option value
1385&l:option local option value
1386
1387Examples: >
1388 echo "tabstop is " . &tabstop
1389 if &insertmode
1390
1391Any option name can be used here. See |options|. When using the local value
1392and there is no buffer-local or window-local value, the global value is used
1393anyway.
1394
1395
Bram Moolenaaref2f6562007-05-06 13:32:59 +00001396register *expr-register* *@r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397--------
1398@r contents of register 'r'
1399
1400The result is the contents of the named register, as a single string.
1401Newlines are inserted where required. To get the contents of the unnamed
Bram Moolenaar58b85342016-08-14 19:54:54 +02001402register use @" or @@. See |registers| for an explanation of the available
Bram Moolenaare7566042005-06-17 22:00:15 +00001403registers.
1404
1405When using the '=' register you get the expression itself, not what it
1406evaluates to. Use |eval()| to evaluate it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407
1408
1409nesting *expr-nesting* *E110*
1410-------
1411(expr1) nested expression
1412
1413
1414environment variable *expr-env*
1415--------------------
1416$VAR environment variable
1417
1418The String value of any environment variable. When it is not defined, the
1419result is an empty string.
Bram Moolenaar691ddee2019-05-09 14:52:41 +02001420
1421The functions `getenv()` and `setenv()` can also be used and work for
1422environment variables with non-alphanumeric names.
1423The function `environ()` can be used to get a Dict with all environment
1424variables.
1425
1426
Bram Moolenaar071d4272004-06-13 20:20:40 +00001427 *expr-env-expand*
1428Note that there is a difference between using $VAR directly and using
1429expand("$VAR"). Using it directly will only expand environment variables that
1430are known inside the current Vim session. Using expand() will first try using
1431the environment variables known inside the current Vim session. If that
1432fails, a shell will be used to expand the variable. This can be slow, but it
1433does expand all variables that the shell knows about. Example: >
Bram Moolenaar34401cc2014-08-29 15:12:19 +02001434 :echo $shell
1435 :echo expand("$shell")
1436The first one probably doesn't echo anything, the second echoes the $shell
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437variable (if your shell supports it).
1438
1439
1440internal variable *expr-variable*
1441-----------------
1442variable internal variable
1443See below |internal-variables|.
1444
1445
Bram Moolenaar05159a02005-02-26 23:04:13 +00001446function call *expr-function* *E116* *E118* *E119* *E120*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447-------------
1448function(expr1, ...) function call
1449See below |functions|.
1450
1451
Bram Moolenaar069c1e72016-07-15 21:25:08 +02001452lambda expression *expr-lambda* *lambda*
1453-----------------
1454{args -> expr1} lambda expression
1455
1456A lambda expression creates a new unnamed function which returns the result of
Bram Moolenaar42ebd062016-07-17 13:35:14 +02001457evaluating |expr1|. Lambda expressions differ from |user-functions| in
Bram Moolenaar069c1e72016-07-15 21:25:08 +02001458the following ways:
1459
14601. The body of the lambda expression is an |expr1| and not a sequence of |Ex|
1461 commands.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +020014622. The prefix "a:" should not be used for arguments. E.g.: >
Bram Moolenaar069c1e72016-07-15 21:25:08 +02001463 :let F = {arg1, arg2 -> arg1 - arg2}
1464 :echo F(5, 2)
1465< 3
1466
1467The arguments are optional. Example: >
1468 :let F = {-> 'error function'}
1469 :echo F()
1470< error function
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001471 *closure*
1472Lambda expressions can access outer scope variables and arguments. This is
Bram Moolenaar50ba5262016-09-22 22:33:02 +02001473often called a closure. Example where "i" and "a:arg" are used in a lambda
Bram Moolenaar6bb2cdf2018-02-24 19:53:53 +01001474while they already exist in the function scope. They remain valid even after
1475the function returns: >
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001476 :function Foo(arg)
1477 : let i = 3
1478 : return {x -> x + i - a:arg}
1479 :endfunction
1480 :let Bar = Foo(4)
1481 :echo Bar(6)
1482< 5
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001483
Bram Moolenaar6bb2cdf2018-02-24 19:53:53 +01001484Note that the variables must exist in the outer scope before the lamba is
1485defined for this to work. See also |:func-closure|.
1486
1487Lambda and closure support can be checked with: >
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001488 if has('lambda')
Bram Moolenaar069c1e72016-07-15 21:25:08 +02001489
1490Examples for using a lambda expression with |sort()|, |map()| and |filter()|: >
1491 :echo map([1, 2, 3], {idx, val -> val + 1})
1492< [2, 3, 4] >
1493 :echo sort([3,7,2,1,4], {a, b -> a - b})
1494< [1, 2, 3, 4, 7]
1495
1496The lambda expression is also useful for Channel, Job and timer: >
1497 :let timer = timer_start(500,
1498 \ {-> execute("echo 'Handler called'", "")},
1499 \ {'repeat': 3})
1500< Handler called
1501 Handler called
1502 Handler called
1503
1504Note how execute() is used to execute an Ex command. That's ugly though.
1505
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001506
1507Lambda expressions have internal names like '<lambda>42'. If you get an error
1508for a lambda expression, you can find what it is with the following command: >
1509 :function {'<lambda>42'}
1510See also: |numbered-function|
1511
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512==============================================================================
Bram Moolenaar4a748032010-09-30 21:47:56 +020015133. Internal variable *internal-variables* *E461*
1514
Bram Moolenaar071d4272004-06-13 20:20:40 +00001515An internal variable name can be made up of letters, digits and '_'. But it
1516cannot start with a digit. It's also possible to use curly braces, see
1517|curly-braces-names|.
1518
1519An internal variable is created with the ":let" command |:let|.
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00001520An internal variable is explicitly destroyed with the ":unlet" command
1521|:unlet|.
1522Using a name that is not an internal variable or refers to a variable that has
1523been destroyed results in an error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001524
1525There are several name spaces for variables. Which one is to be used is
1526specified by what is prepended:
1527
1528 (nothing) In a function: local to a function; otherwise: global
1529|buffer-variable| b: Local to the current buffer.
1530|window-variable| w: Local to the current window.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001531|tabpage-variable| t: Local to the current tab page.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532|global-variable| g: Global.
1533|local-variable| l: Local to a function.
1534|script-variable| s: Local to a |:source|'ed Vim script.
1535|function-argument| a: Function argument (only inside a function).
Bram Moolenaar75b81562014-04-06 14:09:13 +02001536|vim-variable| v: Global, predefined by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001538The scope name by itself can be used as a |Dictionary|. For example, to
1539delete all script-local variables: >
Bram Moolenaar8f999f12005-01-25 22:12:55 +00001540 :for k in keys(s:)
1541 : unlet s:[k]
1542 :endfor
1543<
Bram Moolenaar531da592013-05-06 05:58:55 +02001544 *buffer-variable* *b:var* *b:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545A variable name that is preceded with "b:" is local to the current buffer.
1546Thus you can have several "b:foo" variables, one for each buffer.
1547This kind of variable is deleted when the buffer is wiped out or deleted with
1548|:bdelete|.
1549
1550One local buffer variable is predefined:
Bram Moolenaarbf884932013-04-05 22:26:15 +02001551 *b:changedtick* *changetick*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001552b:changedtick The total number of changes to the current buffer. It is
1553 incremented for each change. An undo command is also a change
Bram Moolenaarc024b462019-06-08 18:07:21 +02001554 in this case. Resetting 'modified' when writing the buffer is
1555 also counted.
1556 This can be used to perform an action only when the buffer has
1557 changed. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 :if my_changedtick != b:changedtick
Bram Moolenaar446cb832008-06-24 21:56:24 +00001559 : let my_changedtick = b:changedtick
1560 : call My_Update()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561 :endif
Bram Moolenaar3df01732017-02-17 22:47:16 +01001562< You cannot change or delete the b:changedtick variable.
1563
Bram Moolenaar531da592013-05-06 05:58:55 +02001564 *window-variable* *w:var* *w:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565A variable name that is preceded with "w:" is local to the current window. It
1566is deleted when the window is closed.
1567
Bram Moolenaarad3b3662013-05-17 18:14:19 +02001568 *tabpage-variable* *t:var* *t:*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001569A variable name that is preceded with "t:" is local to the current tab page,
1570It is deleted when the tab page is closed. {not available when compiled
Bram Moolenaardb84e452010-08-15 13:50:43 +02001571without the |+windows| feature}
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001572
Bram Moolenaar531da592013-05-06 05:58:55 +02001573 *global-variable* *g:var* *g:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001574Inside functions global variables are accessed with "g:". Omitting this will
Bram Moolenaar58b85342016-08-14 19:54:54 +02001575access a variable local to a function. But "g:" can also be used in any other
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576place if you like.
1577
Bram Moolenaar531da592013-05-06 05:58:55 +02001578 *local-variable* *l:var* *l:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001579Inside functions local variables are accessed without prepending anything.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00001580But you can also prepend "l:" if you like. However, without prepending "l:"
1581you may run into reserved variable names. For example "count". By itself it
1582refers to "v:count". Using "l:count" you can have a local variable with the
1583same name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001584
1585 *script-variable* *s:var*
1586In a Vim script variables starting with "s:" can be used. They cannot be
1587accessed from outside of the scripts, thus are local to the script.
1588
1589They can be used in:
1590- commands executed while the script is sourced
1591- functions defined in the script
1592- autocommands defined in the script
1593- functions and autocommands defined in functions and autocommands which were
1594 defined in the script (recursively)
1595- user defined commands defined in the script
1596Thus not in:
1597- other scripts sourced from this one
1598- mappings
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001599- menus
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600- etc.
1601
Bram Moolenaaref2f6562007-05-06 13:32:59 +00001602Script variables can be used to avoid conflicts with global variable names.
1603Take this example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001604
1605 let s:counter = 0
1606 function MyCounter()
1607 let s:counter = s:counter + 1
1608 echo s:counter
1609 endfunction
1610 command Tick call MyCounter()
1611
1612You can now invoke "Tick" from any script, and the "s:counter" variable in
1613that script will not be changed, only the "s:counter" in the script where
1614"Tick" was defined is used.
1615
1616Another example that does the same: >
1617
1618 let s:counter = 0
1619 command Tick let s:counter = s:counter + 1 | echo s:counter
1620
1621When calling a function and invoking a user-defined command, the context for
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001622script variables is set to the script where the function or command was
Bram Moolenaar071d4272004-06-13 20:20:40 +00001623defined.
1624
1625The script variables are also available when a function is defined inside a
1626function that is defined in a script. Example: >
1627
1628 let s:counter = 0
1629 function StartCounting(incr)
1630 if a:incr
1631 function MyCounter()
1632 let s:counter = s:counter + 1
1633 endfunction
1634 else
1635 function MyCounter()
1636 let s:counter = s:counter - 1
1637 endfunction
1638 endif
1639 endfunction
1640
1641This defines the MyCounter() function either for counting up or counting down
1642when calling StartCounting(). It doesn't matter from where StartCounting() is
1643called, the s:counter variable will be accessible in MyCounter().
1644
1645When the same script is sourced again it will use the same script variables.
1646They will remain valid as long as Vim is running. This can be used to
1647maintain a counter: >
1648
1649 if !exists("s:counter")
1650 let s:counter = 1
1651 echo "script executed for the first time"
1652 else
1653 let s:counter = s:counter + 1
1654 echo "script executed " . s:counter . " times now"
1655 endif
1656
1657Note that this means that filetype plugins don't get a different set of script
1658variables for each buffer. Use local buffer variables instead |b:var|.
1659
1660
Bram Moolenaard47d5222018-12-09 20:43:55 +01001661PREDEFINED VIM VARIABLES *vim-variable* *v:var* *v:*
1662 *E963*
1663Some variables can be set by the user, but the type cannot be changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001665 *v:beval_col* *beval_col-variable*
1666v:beval_col The number of the column, over which the mouse pointer is.
1667 This is the byte index in the |v:beval_lnum| line.
1668 Only valid while evaluating the 'balloonexpr' option.
1669
1670 *v:beval_bufnr* *beval_bufnr-variable*
1671v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only
1672 valid while evaluating the 'balloonexpr' option.
1673
1674 *v:beval_lnum* *beval_lnum-variable*
1675v:beval_lnum The number of the line, over which the mouse pointer is. Only
1676 valid while evaluating the 'balloonexpr' option.
1677
1678 *v:beval_text* *beval_text-variable*
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00001679v:beval_text The text under or after the mouse pointer. Usually a word as
1680 it is useful for debugging a C program. 'iskeyword' applies,
1681 but a dot and "->" before the position is included. When on a
1682 ']' the text before it is used, including the matching '[' and
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001683 word before it. When on a Visual area within one line the
Bram Moolenaarb4d5fba2017-09-11 19:31:28 +02001684 highlighted text is used. Also see |<cexpr>|.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001685 Only valid while evaluating the 'balloonexpr' option.
1686
1687 *v:beval_winnr* *beval_winnr-variable*
1688v:beval_winnr The number of the window, over which the mouse pointer is. Only
Bram Moolenaar00654022011-02-25 14:42:19 +01001689 valid while evaluating the 'balloonexpr' option. The first
1690 window has number zero (unlike most other places where a
1691 window gets a number).
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001692
Bram Moolenaar511972d2016-06-04 18:09:59 +02001693 *v:beval_winid* *beval_winid-variable*
Bram Moolenaar7571d552016-08-18 22:54:46 +02001694v:beval_winid The |window-ID| of the window, over which the mouse pointer
1695 is. Otherwise like v:beval_winnr.
Bram Moolenaar511972d2016-06-04 18:09:59 +02001696
Bram Moolenaarf193fff2006-04-27 00:02:13 +00001697 *v:char* *char-variable*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001698v:char Argument for evaluating 'formatexpr' and used for the typed
Bram Moolenaar945e2db2010-06-05 17:43:32 +02001699 character when using <expr> in an abbreviation |:map-<expr>|.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02001700 It is also used by the |InsertCharPre| and |InsertEnter| events.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00001701
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702 *v:charconvert_from* *charconvert_from-variable*
1703v:charconvert_from
1704 The name of the character encoding of a file to be converted.
1705 Only valid while evaluating the 'charconvert' option.
1706
1707 *v:charconvert_to* *charconvert_to-variable*
1708v:charconvert_to
1709 The name of the character encoding of a file after conversion.
1710 Only valid while evaluating the 'charconvert' option.
1711
1712 *v:cmdarg* *cmdarg-variable*
1713v:cmdarg This variable is used for two purposes:
1714 1. The extra arguments given to a file read/write command.
1715 Currently these are "++enc=" and "++ff=". This variable is
1716 set before an autocommand event for a file read/write
1717 command is triggered. There is a leading space to make it
1718 possible to append this variable directly after the
Bram Moolenaar58b85342016-08-14 19:54:54 +02001719 read/write command. Note: The "+cmd" argument isn't
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 included here, because it will be executed anyway.
1721 2. When printing a PostScript file with ":hardcopy" this is
1722 the argument for the ":hardcopy" command. This can be used
1723 in 'printexpr'.
1724
1725 *v:cmdbang* *cmdbang-variable*
1726v:cmdbang Set like v:cmdarg for a file read/write command. When a "!"
1727 was used the value is 1, otherwise it is 0. Note that this
1728 can only be used in autocommands. For user commands |<bang>|
1729 can be used.
1730
Bram Moolenaar42a45122015-07-10 17:56:23 +02001731 *v:completed_item* *completed_item-variable*
1732v:completed_item
1733 |Dictionary| containing the |complete-items| for the most
1734 recently completed word after |CompleteDone|. The
1735 |Dictionary| is empty if the completion failed.
1736
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 *v:count* *count-variable*
1738v:count The count given for the last Normal mode command. Can be used
Bram Moolenaar58b85342016-08-14 19:54:54 +02001739 to get the count before a mapping. Read-only. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740 :map _x :<C-U>echo "the count is " . v:count<CR>
1741< Note: The <C-U> is required to remove the line range that you
1742 get when typing ':' after a count.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001743 When there are two counts, as in "3d2w", they are multiplied,
1744 just like what happens in the command, "d6w" for the example.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001745 Also used for evaluating the 'formatexpr' option.
Bram Moolenaard2e716e2019-04-20 14:39:52 +02001746 "count" also works, for backwards compatibility, unless
1747 |scriptversion| is 3 or higher.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748
1749 *v:count1* *count1-variable*
1750v:count1 Just like "v:count", but defaults to one when no count is
1751 used.
1752
1753 *v:ctype* *ctype-variable*
1754v:ctype The current locale setting for characters of the runtime
1755 environment. This allows Vim scripts to be aware of the
1756 current locale encoding. Technical: it's the value of
1757 LC_CTYPE. When not using a locale the value is "C".
1758 This variable can not be set directly, use the |:language|
1759 command.
1760 See |multi-lang|.
1761
1762 *v:dying* *dying-variable*
Bram Moolenaar58b85342016-08-14 19:54:54 +02001763v:dying Normally zero. When a deadly signal is caught it's set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 one. When multiple signals are caught the number increases.
1765 Can be used in an autocommand to check if Vim didn't
1766 terminate normally. {only works on Unix}
1767 Example: >
1768 :au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endif
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +02001769< Note: if another deadly signal is caught when v:dying is one,
1770 VimLeave autocommands will not be executed.
1771
Bram Moolenaar37f4cbd2019-08-23 20:58:45 +02001772 *v:echospace* *echospace-variable*
1773v:echospace Number of screen cells that can be used for an `:echo` message
1774 in the last screen line before causing the |hit-enter-prompt|.
1775 Depends on 'showcmd', 'ruler' and 'columns'. You need to
1776 check 'cmdheight' for whether there are full-width lines
1777 available above the last line.
1778
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 *v:errmsg* *errmsg-variable*
1780v:errmsg Last given error message. It's allowed to set this variable.
1781 Example: >
1782 :let v:errmsg = ""
1783 :silent! next
1784 :if v:errmsg != ""
1785 : ... handle error
Bram Moolenaard2e716e2019-04-20 14:39:52 +02001786< "errmsg" also works, for backwards compatibility, unless
1787 |scriptversion| is 3 or higher.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788
Bram Moolenaar65a54642018-04-28 16:56:53 +02001789 *v:errors* *errors-variable* *assert-return*
Bram Moolenaar683fa182015-11-30 21:38:24 +01001790v:errors Errors found by assert functions, such as |assert_true()|.
Bram Moolenaar43345542015-11-29 17:35:35 +01001791 This is a list of strings.
1792 The assert functions append an item when an assert fails.
Bram Moolenaar65a54642018-04-28 16:56:53 +02001793 The return value indicates this: a one is returned if an item
1794 was added to v:errors, otherwise zero is returned.
Bram Moolenaar43345542015-11-29 17:35:35 +01001795 To remove old results make it empty: >
1796 :let v:errors = []
1797< If v:errors is set to anything but a list it is made an empty
1798 list by the assert function.
1799
Bram Moolenaar7e1652c2017-12-16 18:27:02 +01001800 *v:event* *event-variable*
1801v:event Dictionary containing information about the current
1802 |autocommand|. The dictionary is emptied when the |autocommand|
1803 finishes, please refer to |dict-identity| for how to get an
1804 independent copy of it.
1805
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806 *v:exception* *exception-variable*
1807v:exception The value of the exception most recently caught and not
1808 finished. See also |v:throwpoint| and |throw-variables|.
1809 Example: >
1810 :try
1811 : throw "oops"
1812 :catch /.*/
Bram Moolenaar54775062019-07-31 21:07:14 +02001813 : echo "caught " .. v:exception
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814 :endtry
1815< Output: "caught oops".
1816
Bram Moolenaar520e1e42016-01-23 19:46:28 +01001817 *v:false* *false-variable*
1818v:false A Number with value zero. Used to put "false" in JSON. See
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001819 |json_encode()|.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001820 When used as a string this evaluates to "v:false". >
Bram Moolenaar705ada12016-01-24 17:56:50 +01001821 echo v:false
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001822< v:false ~
1823 That is so that eval() can parse the string back to the same
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001824 value. Read-only.
Bram Moolenaar520e1e42016-01-23 19:46:28 +01001825
Bram Moolenaar19a09a12005-03-04 23:39:37 +00001826 *v:fcs_reason* *fcs_reason-variable*
1827v:fcs_reason The reason why the |FileChangedShell| event was triggered.
1828 Can be used in an autocommand to decide what to do and/or what
1829 to set v:fcs_choice to. Possible values:
1830 deleted file no longer exists
1831 conflict file contents, mode or timestamp was
1832 changed and buffer is modified
1833 changed file contents has changed
1834 mode mode of file changed
1835 time only file timestamp changed
1836
1837 *v:fcs_choice* *fcs_choice-variable*
1838v:fcs_choice What should happen after a |FileChangedShell| event was
1839 triggered. Can be used in an autocommand to tell Vim what to
1840 do with the affected buffer:
1841 reload Reload the buffer (does not work if
1842 the file was deleted).
1843 ask Ask the user what to do, as if there
1844 was no autocommand. Except that when
1845 only the timestamp changed nothing
1846 will happen.
1847 <empty> Nothing, the autocommand should do
1848 everything that needs to be done.
1849 The default is empty. If another (invalid) value is used then
1850 Vim behaves like it is empty, there is no warning message.
1851
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852 *v:fname_in* *fname_in-variable*
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001853v:fname_in The name of the input file. Valid while evaluating:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854 option used for ~
1855 'charconvert' file to be converted
1856 'diffexpr' original file
1857 'patchexpr' original file
1858 'printexpr' file to be printed
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00001859 And set to the swap file name for |SwapExists|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860
1861 *v:fname_out* *fname_out-variable*
1862v:fname_out The name of the output file. Only valid while
1863 evaluating:
1864 option used for ~
1865 'charconvert' resulting converted file (*)
1866 'diffexpr' output of diff
1867 'patchexpr' resulting patched file
1868 (*) When doing conversion for a write command (e.g., ":w
Bram Moolenaar58b85342016-08-14 19:54:54 +02001869 file") it will be equal to v:fname_in. When doing conversion
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 for a read command (e.g., ":e file") it will be a temporary
1871 file and different from v:fname_in.
1872
1873 *v:fname_new* *fname_new-variable*
1874v:fname_new The name of the new version of the file. Only valid while
1875 evaluating 'diffexpr'.
1876
1877 *v:fname_diff* *fname_diff-variable*
1878v:fname_diff The name of the diff (patch) file. Only valid while
1879 evaluating 'patchexpr'.
1880
1881 *v:folddashes* *folddashes-variable*
1882v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed
1883 fold.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001884 Read-only in the |sandbox|. |fold-foldtext|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885
1886 *v:foldlevel* *foldlevel-variable*
1887v:foldlevel Used for 'foldtext': foldlevel of closed fold.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001888 Read-only in the |sandbox|. |fold-foldtext|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889
1890 *v:foldend* *foldend-variable*
1891v:foldend Used for 'foldtext': last line of closed fold.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001892 Read-only in the |sandbox|. |fold-foldtext|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893
1894 *v:foldstart* *foldstart-variable*
1895v:foldstart Used for 'foldtext': first line of closed fold.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001896 Read-only in the |sandbox|. |fold-foldtext|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897
Bram Moolenaar817a8802013-11-09 01:44:43 +01001898 *v:hlsearch* *hlsearch-variable*
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01001899v:hlsearch Variable that indicates whether search highlighting is on.
Bram Moolenaar76440e22014-11-27 19:14:49 +01001900 Setting it makes sense only if 'hlsearch' is enabled which
1901 requires |+extra_search|. Setting this variable to zero acts
Bram Moolenaar705ada12016-01-24 17:56:50 +01001902 like the |:nohlsearch| command, setting it to one acts like >
Bram Moolenaar817a8802013-11-09 01:44:43 +01001903 let &hlsearch = &hlsearch
Bram Moolenaar86ae7202015-07-10 19:31:35 +02001904< Note that the value is restored when returning from a
1905 function. |function-search-undo|.
1906
Bram Moolenaar843ee412004-06-30 16:16:41 +00001907 *v:insertmode* *insertmode-variable*
1908v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand
1909 events. Values:
1910 i Insert mode
1911 r Replace mode
1912 v Virtual Replace mode
1913
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001914 *v:key* *key-variable*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00001915v:key Key of the current item of a |Dictionary|. Only valid while
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00001916 evaluating the expression used with |map()| and |filter()|.
1917 Read-only.
1918
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 *v:lang* *lang-variable*
1920v:lang The current locale setting for messages of the runtime
1921 environment. This allows Vim scripts to be aware of the
1922 current language. Technical: it's the value of LC_MESSAGES.
1923 The value is system dependent.
1924 This variable can not be set directly, use the |:language|
1925 command.
1926 It can be different from |v:ctype| when messages are desired
1927 in a different language than what is used for character
1928 encoding. See |multi-lang|.
1929
1930 *v:lc_time* *lc_time-variable*
1931v:lc_time The current locale setting for time messages of the runtime
1932 environment. This allows Vim scripts to be aware of the
1933 current language. Technical: it's the value of LC_TIME.
1934 This variable can not be set directly, use the |:language|
1935 command. See |multi-lang|.
1936
1937 *v:lnum* *lnum-variable*
Bram Moolenaar368373e2010-07-19 20:46:22 +02001938v:lnum Line number for the 'foldexpr' |fold-expr|, 'formatexpr' and
1939 'indentexpr' expressions, tab page number for 'guitablabel'
1940 and 'guitabtooltip'. Only valid while one of these
1941 expressions is being evaluated. Read-only when in the
1942 |sandbox|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943
Bram Moolenaar219b8702006-11-01 14:32:36 +00001944 *v:mouse_win* *mouse_win-variable*
1945v:mouse_win Window number for a mouse click obtained with |getchar()|.
1946 First window has number 1, like with |winnr()|. The value is
1947 zero when there was no mouse button click.
1948
Bram Moolenaar511972d2016-06-04 18:09:59 +02001949 *v:mouse_winid* *mouse_winid-variable*
1950v:mouse_winid Window ID for a mouse click obtained with |getchar()|.
1951 The value is zero when there was no mouse button click.
1952
Bram Moolenaar219b8702006-11-01 14:32:36 +00001953 *v:mouse_lnum* *mouse_lnum-variable*
1954v:mouse_lnum Line number for a mouse click obtained with |getchar()|.
1955 This is the text line number, not the screen line number. The
1956 value is zero when there was no mouse button click.
1957
1958 *v:mouse_col* *mouse_col-variable*
1959v:mouse_col Column number for a mouse click obtained with |getchar()|.
1960 This is the screen column number, like with |virtcol()|. The
1961 value is zero when there was no mouse button click.
1962
Bram Moolenaard09091d2019-01-17 16:07:22 +01001963 *v:none* *none-variable* *None*
Bram Moolenaar520e1e42016-01-23 19:46:28 +01001964v:none An empty String. Used to put an empty item in JSON. See
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001965 |json_encode()|.
Bram Moolenaar705ada12016-01-24 17:56:50 +01001966 When used as a number this evaluates to zero.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001967 When used as a string this evaluates to "v:none". >
Bram Moolenaar705ada12016-01-24 17:56:50 +01001968 echo v:none
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001969< v:none ~
1970 That is so that eval() can parse the string back to the same
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001971 value. Read-only.
Bram Moolenaar520e1e42016-01-23 19:46:28 +01001972
1973 *v:null* *null-variable*
1974v:null An empty String. Used to put "null" in JSON. See
Bram Moolenaar6463ca22016-02-13 17:04:46 +01001975 |json_encode()|.
Bram Moolenaar705ada12016-01-24 17:56:50 +01001976 When used as a number this evaluates to zero.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001977 When used as a string this evaluates to "v:null". >
Bram Moolenaar705ada12016-01-24 17:56:50 +01001978 echo v:null
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001979< v:null ~
1980 That is so that eval() can parse the string back to the same
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001981 value. Read-only.
Bram Moolenaar520e1e42016-01-23 19:46:28 +01001982
Bram Moolenaard812df62008-11-09 12:46:09 +00001983 *v:oldfiles* *oldfiles-variable*
1984v:oldfiles List of file names that is loaded from the |viminfo| file on
1985 startup. These are the files that Vim remembers marks for.
1986 The length of the List is limited by the ' argument of the
1987 'viminfo' option (default is 100).
Bram Moolenaar8d043172014-01-23 14:24:41 +01001988 When the |viminfo| file is not used the List is empty.
Bram Moolenaard812df62008-11-09 12:46:09 +00001989 Also see |:oldfiles| and |c_#<|.
1990 The List can be modified, but this has no effect on what is
1991 stored in the |viminfo| file later. If you use values other
1992 than String this will cause trouble.
Bram Moolenaardb84e452010-08-15 13:50:43 +02001993 {only when compiled with the |+viminfo| feature}
Bram Moolenaard812df62008-11-09 12:46:09 +00001994
Bram Moolenaar53744302015-07-17 17:38:22 +02001995 *v:option_new*
1996v:option_new New value of the option. Valid while executing an |OptionSet|
1997 autocommand.
1998 *v:option_old*
1999v:option_old Old value of the option. Valid while executing an |OptionSet|
Bram Moolenaard7c96872019-06-15 17:12:48 +02002000 autocommand. Depending on the command used for setting and the
2001 kind of option this is either the local old value or the
2002 global old value.
2003 *v:option_oldlocal*
2004v:option_oldlocal
2005 Old local value of the option. Valid while executing an
2006 |OptionSet| autocommand.
2007 *v:option_oldglobal*
2008v:option_oldglobal
2009 Old global value of the option. Valid while executing an
2010 |OptionSet| autocommand.
Bram Moolenaar53744302015-07-17 17:38:22 +02002011 *v:option_type*
2012v:option_type Scope of the set command. Valid while executing an
2013 |OptionSet| autocommand. Can be either "global" or "local"
Bram Moolenaard7c96872019-06-15 17:12:48 +02002014 *v:option_command*
2015v:option_command
2016 Command used to set the option. Valid while executing an
2017 |OptionSet| autocommand.
2018 value option was set via ~
2019 "setlocal" |:setlocal| or ":let l:xxx"
2020 "setglobal" |:setglobal| or ":let g:xxx"
2021 "set" |:set| or |:let|
2022 "modeline" |modeline|
Bram Moolenaar8af1fbf2008-01-05 12:35:21 +00002023 *v:operator* *operator-variable*
2024v:operator The last operator given in Normal mode. This is a single
2025 character except for commands starting with <g> or <z>,
2026 in which case it is two characters. Best used alongside
2027 |v:prevcount| and |v:register|. Useful if you want to cancel
2028 Operator-pending mode and then use the operator, e.g.: >
2029 :omap O <Esc>:call MyMotion(v:operator)<CR>
2030< The value remains set until another operator is entered, thus
2031 don't expect it to be empty.
2032 v:operator is not set for |:delete|, |:yank| or other Ex
2033 commands.
2034 Read-only.
2035
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036 *v:prevcount* *prevcount-variable*
2037v:prevcount The count given for the last but one Normal mode command.
2038 This is the v:count value of the previous command. Useful if
Bram Moolenaar8af1fbf2008-01-05 12:35:21 +00002039 you want to cancel Visual or Operator-pending mode and then
2040 use the count, e.g.: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 :vmap % <Esc>:call MyFilter(v:prevcount)<CR>
2042< Read-only.
2043
Bram Moolenaar05159a02005-02-26 23:04:13 +00002044 *v:profiling* *profiling-variable*
Bram Moolenaar58b85342016-08-14 19:54:54 +02002045v:profiling Normally zero. Set to one after using ":profile start".
Bram Moolenaar05159a02005-02-26 23:04:13 +00002046 See |profiling|.
2047
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048 *v:progname* *progname-variable*
2049v:progname Contains the name (with path removed) with which Vim was
Bram Moolenaard38b0552012-04-25 19:07:41 +02002050 invoked. Allows you to do special initialisations for |view|,
2051 |evim| etc., or any other name you might symlink to Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052 Read-only.
2053
Bram Moolenaara1706c92014-04-01 19:55:49 +02002054 *v:progpath* *progpath-variable*
Bram Moolenaar56c860c2019-08-17 20:09:31 +02002055v:progpath Contains the command with which Vim was invoked, in a form
2056 that when passed to the shell will run the same Vim executable
2057 as the current one (if $PATH remains unchanged).
2058 Useful if you want to message a Vim server using a
Bram Moolenaara1706c92014-04-01 19:55:49 +02002059 |--remote-expr|.
Bram Moolenaarc7f02552014-04-01 21:00:59 +02002060 To get the full path use: >
2061 echo exepath(v:progpath)
Bram Moolenaar56c860c2019-08-17 20:09:31 +02002062< If the command has a relative path it will be expanded to the
2063 full path, so that it still works after `:cd`. Thus starting
2064 "./vim" results in "/home/user/path/to/vim/src/vim".
2065 On Linux and other systems it will always be the full path.
2066 On Mac it may just be "vim" and using exepath() as mentioned
2067 above should be used to get the full path.
Bram Moolenaar08cab962017-03-04 14:37:18 +01002068 On MS-Windows the executable may be called "vim.exe", but the
2069 ".exe" is not added to v:progpath.
Bram Moolenaara1706c92014-04-01 19:55:49 +02002070 Read-only.
2071
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 *v:register* *register-variable*
Bram Moolenaard58e9292011-02-09 17:07:58 +01002073v:register The name of the register in effect for the current normal mode
Bram Moolenaard38b0552012-04-25 19:07:41 +02002074 command (regardless of whether that command actually used a
2075 register). Or for the currently executing normal mode mapping
2076 (use this in custom commands that take a register).
2077 If none is supplied it is the default register '"', unless
2078 'clipboard' contains "unnamed" or "unnamedplus", then it is
2079 '*' or '+'.
Bram Moolenaard58e9292011-02-09 17:07:58 +01002080 Also see |getreg()| and |setreg()|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002081
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002082 *v:scrollstart* *scrollstart-variable*
2083v:scrollstart String describing the script or function that caused the
2084 screen to scroll up. It's only set when it is empty, thus the
2085 first reason is remembered. It is set to "Unknown" for a
2086 typed command.
2087 This can be used to find out why your script causes the
2088 hit-enter prompt.
2089
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090 *v:servername* *servername-variable*
Bram Moolenaarc2ce52c2017-08-01 18:35:38 +02002091v:servername The resulting registered |client-server-name| if any.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092 Read-only.
2093
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002094
Bram Moolenaar446cb832008-06-24 21:56:24 +00002095v:searchforward *v:searchforward* *searchforward-variable*
2096 Search direction: 1 after a forward search, 0 after a
2097 backward search. It is reset to forward when directly setting
2098 the last search pattern, see |quote/|.
2099 Note that the value is restored when returning from a
2100 function. |function-search-undo|.
2101 Read-write.
2102
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103 *v:shell_error* *shell_error-variable*
2104v:shell_error Result of the last shell command. When non-zero, the last
2105 shell command had an error. When zero, there was no problem.
2106 This only works when the shell returns the error code to Vim.
2107 The value -1 is often used when the command could not be
2108 executed. Read-only.
2109 Example: >
2110 :!mv foo bar
2111 :if v:shell_error
2112 : echo 'could not rename "foo" to "bar"!'
2113 :endif
Bram Moolenaard2e716e2019-04-20 14:39:52 +02002114< "shell_error" also works, for backwards compatibility, unless
2115 |scriptversion| is 3 or higher.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116
2117 *v:statusmsg* *statusmsg-variable*
2118v:statusmsg Last given status message. It's allowed to set this variable.
2119
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00002120 *v:swapname* *swapname-variable*
2121v:swapname Only valid when executing |SwapExists| autocommands: Name of
2122 the swap file found. Read-only.
2123
2124 *v:swapchoice* *swapchoice-variable*
2125v:swapchoice |SwapExists| autocommands can set this to the selected choice
2126 for handling an existing swap file:
2127 'o' Open read-only
2128 'e' Edit anyway
2129 'r' Recover
2130 'd' Delete swapfile
2131 'q' Quit
2132 'a' Abort
Bram Moolenaar58b85342016-08-14 19:54:54 +02002133 The value should be a single-character string. An empty value
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00002134 results in the user being asked, as would happen when there is
2135 no SwapExists autocommand. The default is empty.
2136
Bram Moolenaarb3480382005-12-11 21:33:32 +00002137 *v:swapcommand* *swapcommand-variable*
Bram Moolenaar4770d092006-01-12 23:22:24 +00002138v:swapcommand Normal mode command to be executed after a file has been
Bram Moolenaarb3480382005-12-11 21:33:32 +00002139 opened. Can be used for a |SwapExists| autocommand to have
Bram Moolenaar58b85342016-08-14 19:54:54 +02002140 another Vim open the file and jump to the right place. For
Bram Moolenaarb3480382005-12-11 21:33:32 +00002141 example, when jumping to a tag the value is ":tag tagname\r".
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002142 For ":edit +cmd file" the value is ":cmd\r".
Bram Moolenaarb3480382005-12-11 21:33:32 +00002143
Bram Moolenaard823fa92016-08-12 16:29:27 +02002144 *v:t_TYPE* *v:t_bool* *t_bool-variable*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002145v:t_bool Value of |Boolean| type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02002146 *v:t_channel* *t_channel-variable*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002147v:t_channel Value of |Channel| type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02002148 *v:t_dict* *t_dict-variable*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002149v:t_dict Value of |Dictionary| type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02002150 *v:t_float* *t_float-variable*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002151v:t_float Value of |Float| type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02002152 *v:t_func* *t_func-variable*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002153v:t_func Value of |Funcref| type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02002154 *v:t_job* *t_job-variable*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002155v:t_job Value of |Job| type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02002156 *v:t_list* *t_list-variable*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002157v:t_list Value of |List| type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02002158 *v:t_none* *t_none-variable*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002159v:t_none Value of |None| type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02002160 *v:t_number* *t_number-variable*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002161v:t_number Value of |Number| type. Read-only. See: |type()|
Bram Moolenaard823fa92016-08-12 16:29:27 +02002162 *v:t_string* *t_string-variable*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002163v:t_string Value of |String| type. Read-only. See: |type()|
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002164 *v:t_blob* *t_blob-variable*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002165v:t_blob Value of |Blob| type. Read-only. See: |type()|
Bram Moolenaarf562e722016-07-19 17:25:25 +02002166
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167 *v:termresponse* *termresponse-variable*
2168v:termresponse The escape sequence returned by the terminal for the |t_RV|
Bram Moolenaar58b85342016-08-14 19:54:54 +02002169 termcap entry. It is set when Vim receives an escape sequence
Bram Moolenaarb4230122019-05-30 18:40:53 +02002170 that starts with ESC [ or CSI, then '>' or '?' and ends in a
2171 'c', with only digits and ';' in between.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 When this option is set, the TermResponse autocommand event is
2173 fired, so that you can react to the response from the
2174 terminal.
Bram Moolenaarb4230122019-05-30 18:40:53 +02002175 The response from a new xterm is: "<Esc>[> Pp ; Pv ; Pc c". Pp
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the
2177 patch level (since this was introduced in patch 95, it's
2178 always 95 or bigger). Pc is always zero.
2179 {only when compiled with |+termresponse| feature}
2180
Bram Moolenaarf3af54e2017-08-30 14:53:06 +02002181 *v:termblinkresp*
2182v:termblinkresp The escape sequence returned by the terminal for the |t_RC|
2183 termcap entry. This is used to find out whether the terminal
2184 cursor is blinking. This is used by |term_getcursor()|.
2185
2186 *v:termstyleresp*
2187v:termstyleresp The escape sequence returned by the terminal for the |t_RS|
2188 termcap entry. This is used to find out what the shape of the
2189 cursor is. This is used by |term_getcursor()|.
2190
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02002191 *v:termrbgresp*
2192v:termrbgresp The escape sequence returned by the terminal for the |t_RB|
Bram Moolenaarf3af54e2017-08-30 14:53:06 +02002193 termcap entry. This is used to find out what the terminal
2194 background color is, see 'background'.
2195
Bram Moolenaar65e4c4f2017-10-14 23:24:25 +02002196 *v:termrfgresp*
2197v:termrfgresp The escape sequence returned by the terminal for the |t_RF|
2198 termcap entry. This is used to find out what the terminal
2199 foreground color is.
2200
Bram Moolenaarf3af54e2017-08-30 14:53:06 +02002201 *v:termu7resp*
2202v:termu7resp The escape sequence returned by the terminal for the |t_u7|
2203 termcap entry. This is used to find out what the terminal
2204 does with ambiguous width characters, see 'ambiwidth'.
2205
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02002206 *v:testing* *testing-variable*
Bram Moolenaar8e8df252016-05-25 21:23:21 +02002207v:testing Must be set before using `test_garbagecollect_now()`.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002208 Also, when set certain error messages won't be shown for 2
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002209 seconds. (e.g. "'dictionary' option is empty")
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02002210
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211 *v:this_session* *this_session-variable*
2212v:this_session Full filename of the last loaded or saved session file. See
2213 |:mksession|. It is allowed to set this variable. When no
2214 session file has been saved, this variable is empty.
Bram Moolenaard2e716e2019-04-20 14:39:52 +02002215 "this_session" also works, for backwards compatibility, unless
2216 |scriptversion| is 3 or higher
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217
2218 *v:throwpoint* *throwpoint-variable*
2219v:throwpoint The point where the exception most recently caught and not
Bram Moolenaar58b85342016-08-14 19:54:54 +02002220 finished was thrown. Not set when commands are typed. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 also |v:exception| and |throw-variables|.
2222 Example: >
2223 :try
2224 : throw "oops"
2225 :catch /.*/
2226 : echo "Exception from" v:throwpoint
2227 :endtry
2228< Output: "Exception from test.vim, line 2"
2229
Bram Moolenaar520e1e42016-01-23 19:46:28 +01002230 *v:true* *true-variable*
2231v:true A Number with value one. Used to put "true" in JSON. See
Bram Moolenaar6463ca22016-02-13 17:04:46 +01002232 |json_encode()|.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02002233 When used as a string this evaluates to "v:true". >
Bram Moolenaar705ada12016-01-24 17:56:50 +01002234 echo v:true
Bram Moolenaarc95a3022016-06-12 23:01:46 +02002235< v:true ~
2236 That is so that eval() can parse the string back to the same
Bram Moolenaardf48fb42016-07-22 21:50:18 +02002237 value. Read-only.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002238 *v:val* *val-variable*
Bram Moolenaar58b85342016-08-14 19:54:54 +02002239v:val Value of the current item of a |List| or |Dictionary|. Only
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002240 valid while evaluating the expression used with |map()| and
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002241 |filter()|. Read-only.
2242
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243 *v:version* *version-variable*
2244v:version Version number of Vim: Major version number times 100 plus
Bram Moolenaar9b283522019-06-17 22:19:33 +02002245 minor version number. Version 5.0 is 500. Version 5.1
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 is 501. Read-only. "version" also works, for backwards
Bram Moolenaard2e716e2019-04-20 14:39:52 +02002247 compatibility, unless |scriptversion| is 3 or higher.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248 Use |has()| to check if a certain patch was included, e.g.: >
Bram Moolenaar6716d9a2014-04-02 12:12:08 +02002249 if has("patch-7.4.123")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250< Note that patch numbers are specific to the version, thus both
2251 version 5.0 and 5.1 may have a patch 123, but these are
2252 completely different.
2253
Bram Moolenaar37df9a42019-06-14 14:39:51 +02002254 *v:versionlong* *versionlong-variable*
Bram Moolenaar9b283522019-06-17 22:19:33 +02002255v:versionlong Like v:version, but also including the patchlevel in the last
2256 four digits. Version 8.1 with patch 123 has value 8010123.
2257 This can be used like this: >
2258 if v:versionlong >= 8010123
Bram Moolenaar37df9a42019-06-14 14:39:51 +02002259< However, if there are gaps in the list of patches included
2260 this will not work well. This can happen if a recent patch
2261 was included into an older version, e.g. for a security fix.
2262 Use the has() function to make sure the patch is actually
2263 included.
2264
Bram Moolenaar14735512016-03-26 21:00:08 +01002265 *v:vim_did_enter* *vim_did_enter-variable*
2266v:vim_did_enter Zero until most of startup is done. It is set to one just
2267 before |VimEnter| autocommands are triggered.
2268
Bram Moolenaar071d4272004-06-13 20:20:40 +00002269 *v:warningmsg* *warningmsg-variable*
2270v:warningmsg Last given warning message. It's allowed to set this variable.
2271
Bram Moolenaar727c8762010-10-20 19:17:48 +02002272 *v:windowid* *windowid-variable*
2273v:windowid When any X11 based GUI is running or when running in a
2274 terminal and Vim connects to the X server (|-X|) this will be
Bram Moolenaar264e9fd2010-10-27 12:33:17 +02002275 set to the window ID.
2276 When an MS-Windows GUI is running this will be set to the
2277 window handle.
2278 Otherwise the value is zero.
Bram Moolenaar7571d552016-08-18 22:54:46 +02002279 Note: for windows inside Vim use |winnr()| or |win_getid()|,
2280 see |window-ID|.
Bram Moolenaar727c8762010-10-20 19:17:48 +02002281
Bram Moolenaar071d4272004-06-13 20:20:40 +00002282==============================================================================
22834. Builtin Functions *functions*
2284
2285See |function-list| for a list grouped by what the function is used for.
2286
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00002287(Use CTRL-] on the function name to jump to the full explanation.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288
2289USAGE RESULT DESCRIPTION ~
2290
Bram Moolenaar81edd172016-04-14 13:51:37 +02002291abs({expr}) Float or Number absolute value of {expr}
2292acos({expr}) Float arc cosine of {expr}
Bram Moolenaard8968242019-01-15 22:51:57 +01002293add({object}, {item}) List/Blob append {item} to {object}
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002294and({expr}, {expr}) Number bitwise AND
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002295append({lnum}, {text}) Number append {text} below line {lnum}
2296appendbufline({expr}, {lnum}, {text})
2297 Number append {text} below line {lnum}
2298 in buffer {expr}
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002299argc([{winid}]) Number number of files in the argument list
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002300argidx() Number current index in the argument list
Bram Moolenaar81edd172016-04-14 13:51:37 +02002301arglistid([{winnr} [, {tabnr}]]) Number argument list id
Bram Moolenaare6e39892018-10-25 12:32:11 +02002302argv({nr} [, {winid}]) String {nr} entry of the argument list
2303argv([-1, {winid}]) List the argument list
Bram Moolenaar65a54642018-04-28 16:56:53 +02002304assert_beeps({cmd}) Number assert {cmd} causes a beep
Bram Moolenaar42205552017-03-18 19:42:22 +01002305assert_equal({exp}, {act} [, {msg}])
Bram Moolenaar65a54642018-04-28 16:56:53 +02002306 Number assert {exp} is equal to {act}
Bram Moolenaard96ff162018-02-18 22:13:29 +01002307assert_equalfile({fname-one}, {fname-two})
Bram Moolenaar65a54642018-04-28 16:56:53 +02002308 Number assert file contents is equal
Bram Moolenaar42205552017-03-18 19:42:22 +01002309assert_exception({error} [, {msg}])
Bram Moolenaar65a54642018-04-28 16:56:53 +02002310 Number assert {error} is in v:exception
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02002311assert_fails({cmd} [, {error} [, {msg}]])
2312 Number assert {cmd} fails
Bram Moolenaar42205552017-03-18 19:42:22 +01002313assert_false({actual} [, {msg}])
Bram Moolenaar65a54642018-04-28 16:56:53 +02002314 Number assert {actual} is false
Bram Moolenaar61c04492016-07-23 15:35:35 +02002315assert_inrange({lower}, {upper}, {actual} [, {msg}])
Bram Moolenaar65a54642018-04-28 16:56:53 +02002316 Number assert {actual} is inside the range
Bram Moolenaar42205552017-03-18 19:42:22 +01002317assert_match({pat}, {text} [, {msg}])
Bram Moolenaar65a54642018-04-28 16:56:53 +02002318 Number assert {pat} matches {text}
Bram Moolenaar42205552017-03-18 19:42:22 +01002319assert_notequal({exp}, {act} [, {msg}])
Bram Moolenaar65a54642018-04-28 16:56:53 +02002320 Number assert {exp} is not equal {act}
Bram Moolenaar42205552017-03-18 19:42:22 +01002321assert_notmatch({pat}, {text} [, {msg}])
Bram Moolenaar65a54642018-04-28 16:56:53 +02002322 Number assert {pat} not matches {text}
2323assert_report({msg}) Number report a test failure
2324assert_true({actual} [, {msg}]) Number assert {actual} is true
Bram Moolenaar81edd172016-04-14 13:51:37 +02002325asin({expr}) Float arc sine of {expr}
2326atan({expr}) Float arc tangent of {expr}
Bram Moolenaar04186092016-08-29 21:55:35 +02002327atan2({expr1}, {expr2}) Float arc tangent of {expr1} / {expr2}
Bram Moolenaarbe0a2592019-05-09 13:50:16 +02002328balloon_gettext() String current text in the balloon
Bram Moolenaar74240d32017-12-10 15:26:15 +01002329balloon_show({expr}) none show {expr} inside the balloon
Bram Moolenaar246fe032017-11-19 19:56:27 +01002330balloon_split({msg}) List split {msg} as used for a balloon
Bram Moolenaar81edd172016-04-14 13:51:37 +02002331browse({save}, {title}, {initdir}, {default})
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332 String put up a file requester
Bram Moolenaar81edd172016-04-14 13:51:37 +02002333browsedir({title}, {initdir}) String put up a directory requester
Bram Moolenaar15e248e2019-06-30 20:21:37 +02002334bufadd({name}) Number add a buffer to the buffer list
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002335bufexists({expr}) Number |TRUE| if buffer {expr} exists
2336buflisted({expr}) Number |TRUE| if buffer {expr} is listed
Bram Moolenaar15e248e2019-06-30 20:21:37 +02002337bufload({expr}) Number load buffer {expr} if not loaded yet
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002338bufloaded({expr}) Number |TRUE| if buffer {expr} is loaded
Bram Moolenaara8eee212019-08-24 22:14:58 +02002339bufname([{expr}]) String Name of the buffer {expr}
2340bufnr([{expr} [, {create}]]) Number Number of the buffer {expr}
Bram Moolenaarb3619a92016-06-04 17:58:52 +02002341bufwinid({expr}) Number window ID of buffer {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002342bufwinnr({expr}) Number window number of buffer {expr}
2343byte2line({byte}) Number line number at byte count {byte}
2344byteidx({expr}, {nr}) Number byte index of {nr}'th char in {expr}
2345byteidxcomp({expr}, {nr}) Number byte index of {nr}'th char in {expr}
2346call({func}, {arglist} [, {dict}])
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00002347 any call {func} with arguments {arglist}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002348ceil({expr}) Float round {expr} up
Bram Moolenaar4b785f62016-11-29 21:54:44 +01002349ch_canread({handle}) Number check if there is something to read
Bram Moolenaar81edd172016-04-14 13:51:37 +02002350ch_close({handle}) none close {handle}
Bram Moolenaar0874a832016-09-01 15:11:51 +02002351ch_close_in({handle}) none close in part of {handle}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002352ch_evalexpr({handle}, {expr} [, {options}])
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01002353 any evaluate {expr} on JSON {handle}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002354ch_evalraw({handle}, {string} [, {options}])
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01002355 any evaluate {string} on raw {handle}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002356ch_getbufnr({handle}, {what}) Number get buffer number for {handle}/{what}
2357ch_getjob({channel}) Job get the Job of {channel}
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002358ch_info({handle}) String info about channel {handle}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002359ch_log({msg} [, {handle}]) none write {msg} in the channel log file
2360ch_logfile({fname} [, {mode}]) none start logging channel activity
2361ch_open({address} [, {options}])
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002362 Channel open a channel to {address}
2363ch_read({handle} [, {options}]) String read from {handle}
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002364ch_readblob({handle} [, {options}])
2365 Blob read Blob from {handle}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002366ch_readraw({handle} [, {options}])
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002367 String read raw from {handle}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002368ch_sendexpr({handle}, {expr} [, {options}])
Bram Moolenaar5f148ec2016-03-07 22:59:26 +01002369 any send {expr} over JSON {handle}
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002370ch_sendraw({handle}, {expr} [, {options}])
2371 any send {expr} over raw {handle}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002372ch_setoptions({handle}, {options})
2373 none set options for {handle}
Bram Moolenaar7ef38102016-09-26 22:36:58 +02002374ch_status({handle} [, {options}])
2375 String status of channel {handle}
Bram Moolenaar446cb832008-06-24 21:56:24 +00002376changenr() Number current change number
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002377char2nr({expr} [, {utf8}]) Number ASCII/UTF8 value of first char in {expr}
Bram Moolenaar1063f3d2019-05-07 22:06:52 +02002378chdir({dir}) String change current working directory
Bram Moolenaar81edd172016-04-14 13:51:37 +02002379cindent({lnum}) Number C indent for line {lnum}
Bram Moolenaaraff74912019-03-30 18:11:49 +01002380clearmatches([{win}]) none clear all matches
Bram Moolenaar81edd172016-04-14 13:51:37 +02002381col({expr}) Number column nr of cursor or mark
2382complete({startcol}, {matches}) none set Insert mode completion
2383complete_add({expr}) Number add completion match
Bram Moolenaar446cb832008-06-24 21:56:24 +00002384complete_check() Number check for key typed during completion
Bram Moolenaarfd133322019-03-29 12:20:27 +01002385complete_info([{what}]) Dict get current completion information
Bram Moolenaar81edd172016-04-14 13:51:37 +02002386confirm({msg} [, {choices} [, {default} [, {type}]]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 Number number of choice picked by user
Bram Moolenaar81edd172016-04-14 13:51:37 +02002388copy({expr}) any make a shallow copy of {expr}
2389cos({expr}) Float cosine of {expr}
2390cosh({expr}) Float hyperbolic cosine of {expr}
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002391count({comp}, {expr} [, {ic} [, {start}]])
2392 Number count how many {expr} are in {comp}
Bram Moolenaardc1f1642016-08-16 18:33:43 +02002393cscope_connection([{num}, {dbpath} [, {prepend}]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002394 Number checks existence of cscope connection
Bram Moolenaar81edd172016-04-14 13:51:37 +02002395cursor({lnum}, {col} [, {off}])
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01002396 Number move cursor to {lnum}, {col}, {off}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002397cursor({list}) Number move cursor to position in {list}
Bram Moolenaar4551c0a2018-06-20 22:38:21 +02002398debugbreak({pid}) Number interrupt process being debugged
Bram Moolenaar81edd172016-04-14 13:51:37 +02002399deepcopy({expr} [, {noref}]) any make a full copy of {expr}
2400delete({fname} [, {flags}]) Number delete the file or directory {fname}
Bram Moolenaard473c8c2018-08-11 18:00:22 +02002401deletebufline({expr}, {first} [, {last}])
Bram Moolenaard79a2622018-06-07 18:17:46 +02002402 Number delete lines from buffer {expr}
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002403did_filetype() Number |TRUE| if FileType autocmd event used
Bram Moolenaar81edd172016-04-14 13:51:37 +02002404diff_filler({lnum}) Number diff filler lines about {lnum}
2405diff_hlID({lnum}, {col}) Number diff highlighting at {lnum}/{col}
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002406empty({expr}) Number |TRUE| if {expr} is empty
Bram Moolenaar691ddee2019-05-09 14:52:41 +02002407environ() Dict return environment variables
Bram Moolenaar81edd172016-04-14 13:51:37 +02002408escape({string}, {chars}) String escape {chars} in {string} with '\'
2409eval({string}) any evaluate {string} into its value
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002410eventhandler() Number |TRUE| if inside an event handler
Bram Moolenaar81edd172016-04-14 13:51:37 +02002411executable({expr}) Number 1 if executable {expr} exists
Bram Moolenaar79815f12016-07-09 17:07:29 +02002412execute({command}) String execute {command} and get the output
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002413exepath({expr}) String full path of the command {expr}
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002414exists({expr}) Number |TRUE| if {expr} exists
Bram Moolenaar81edd172016-04-14 13:51:37 +02002415extend({expr1}, {expr2} [, {expr3}])
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00002416 List/Dict insert items of {expr2} into {expr1}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002417exp({expr}) Float exponential of {expr}
2418expand({expr} [, {nosuf} [, {list}]])
Bram Moolenaar146e9c32012-03-07 19:18:23 +01002419 any expand special keywords in {expr}
Bram Moolenaar80dad482019-06-09 17:22:31 +02002420expandcmd({expr}) String expand {expr} like with `:edit`
Bram Moolenaar81edd172016-04-14 13:51:37 +02002421feedkeys({string} [, {mode}]) Number add key sequence to typeahead buffer
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002422filereadable({file}) Number |TRUE| if {file} is a readable file
2423filewritable({file}) Number |TRUE| if {file} is a writable file
Bram Moolenaar50ba5262016-09-22 22:33:02 +02002424filter({expr1}, {expr2}) List/Dict remove items from {expr1} where
2425 {expr2} is 0
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002426finddir({name} [, {path} [, {count}]])
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00002427 String find directory {name} in {path}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002428findfile({name} [, {path} [, {count}]])
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00002429 String find file {name} in {path}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002430float2nr({expr}) Number convert Float {expr} to a Number
2431floor({expr}) Float round {expr} down
2432fmod({expr1}, {expr2}) Float remainder of {expr1} / {expr2}
2433fnameescape({fname}) String escape special characters in {fname}
2434fnamemodify({fname}, {mods}) String modify file name
2435foldclosed({lnum}) Number first line of fold at {lnum} if closed
2436foldclosedend({lnum}) Number last line of fold at {lnum} if closed
2437foldlevel({lnum}) Number fold level at {lnum}
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002438foldtext() String line displayed for closed fold
Bram Moolenaar81edd172016-04-14 13:51:37 +02002439foldtextresult({lnum}) String text for closed fold at {lnum}
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002440foreground() Number bring the Vim window to the foreground
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002441funcref({name} [, {arglist}] [, {dict}])
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002442 Funcref reference to function {name}
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002443function({name} [, {arglist}] [, {dict}])
2444 Funcref named reference to function {name}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002445garbagecollect([{atexit}]) none free memory, breaking cyclic references
Bram Moolenaar81edd172016-04-14 13:51:37 +02002446get({list}, {idx} [, {def}]) any get item {idx} from {list} or {def}
2447get({dict}, {key} [, {def}]) any get item {key} from {dict} or {def}
Bram Moolenaar03e19a02016-05-24 22:29:49 +02002448get({func}, {what}) any get property of funcref/partial {func}
Bram Moolenaar50ba5262016-09-22 22:33:02 +02002449getbufinfo([{expr}]) List information about buffers
Bram Moolenaar81edd172016-04-14 13:51:37 +02002450getbufline({expr}, {lnum} [, {end}])
Bram Moolenaar45360022005-07-21 21:08:21 +00002451 List lines {lnum} to {end} of buffer {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002452getbufvar({expr}, {varname} [, {def}])
Bram Moolenaar63dbda12013-02-20 21:12:10 +01002453 any variable {varname} in buffer {expr}
Bram Moolenaar4c313b12019-08-24 22:58:31 +02002454getchangelist([{expr}]) List list of change list items
Bram Moolenaar81edd172016-04-14 13:51:37 +02002455getchar([expr]) Number get one character from the user
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002456getcharmod() Number modifiers for the last typed character
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02002457getcharsearch() Dict last character search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458getcmdline() String return the current command-line
2459getcmdpos() Number return cursor position in command-line
Bram Moolenaarfb539272014-08-22 19:21:47 +02002460getcmdtype() String return current command-line type
2461getcmdwintype() String return current command-line window type
Bram Moolenaare9d58a62016-08-13 15:07:41 +02002462getcompletion({pat}, {type} [, {filtered}])
2463 List list of cmdline completion matches
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02002464getcurpos() List position of the cursor
Bram Moolenaar81edd172016-04-14 13:51:37 +02002465getcwd([{winnr} [, {tabnr}]]) String get the current working directory
Bram Moolenaar691ddee2019-05-09 14:52:41 +02002466getenv({name}) String return environment variable
Bram Moolenaar81edd172016-04-14 13:51:37 +02002467getfontname([{name}]) String name of font being used
2468getfperm({fname}) String file permissions of file {fname}
2469getfsize({fname}) Number size in bytes of file {fname}
2470getftime({fname}) Number last modification time of file
2471getftype({fname}) String description of type of file {fname}
Bram Moolenaara3a12462019-09-07 15:08:38 +02002472getimstatus() Number |TRUE| if the IME status is active
Bram Moolenaar4f505882018-02-10 21:06:32 +01002473getjumplist([{winnr} [, {tabnr}]])
2474 List list of jump list items
Bram Moolenaar81edd172016-04-14 13:51:37 +02002475getline({lnum}) String line {lnum} of current buffer
2476getline({lnum}, {end}) List lines {lnum} to {end} of current buffer
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002477getloclist({nr} [, {what}]) List list of location list items
Bram Moolenaaraff74912019-03-30 18:11:49 +01002478getmatches([{win}]) List list of current matches
Bram Moolenaar18081e32008-02-20 19:11:07 +00002479getpid() Number process ID of Vim
Bram Moolenaar81edd172016-04-14 13:51:37 +02002480getpos({expr}) List position of cursor, mark, etc.
Bram Moolenaard823fa92016-08-12 16:29:27 +02002481getqflist([{what}]) List list of quickfix items
Bram Moolenaar81edd172016-04-14 13:51:37 +02002482getreg([{regname} [, 1 [, {list}]]])
Bram Moolenaarb7cb42b2014-04-02 19:55:10 +02002483 String or List contents of register
Bram Moolenaar81edd172016-04-14 13:51:37 +02002484getregtype([{regname}]) String type of register
Bram Moolenaar50ba5262016-09-22 22:33:02 +02002485gettabinfo([{expr}]) List list of tab pages
Bram Moolenaar81edd172016-04-14 13:51:37 +02002486gettabvar({nr}, {varname} [, {def}])
Bram Moolenaar63dbda12013-02-20 21:12:10 +01002487 any variable {varname} in tab {nr} or {def}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002488gettabwinvar({tabnr}, {winnr}, {name} [, {def}])
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00002489 any {name} in {winnr} in tab page {tabnr}
Bram Moolenaarf49cc602018-11-11 15:21:05 +01002490gettagstack([{nr}]) Dict get the tag stack of window {nr}
Bram Moolenaar7132ddc2018-07-15 17:01:11 +02002491getwininfo([{winid}]) List list of info about each window
Bram Moolenaar98ef2332018-03-18 14:44:37 +01002492getwinpos([{timeout}]) List X and Y coord in pixels of the Vim window
Bram Moolenaar3f54fd32018-03-03 21:29:55 +01002493getwinposx() Number X coord in pixels of the Vim window
2494getwinposy() Number Y coord in pixels of the Vim window
Bram Moolenaar81edd172016-04-14 13:51:37 +02002495getwinvar({nr}, {varname} [, {def}])
Bram Moolenaar63dbda12013-02-20 21:12:10 +01002496 any variable {varname} in window {nr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002497glob({expr} [, {nosuf} [, {list} [, {alllinks}]]])
Bram Moolenaar146e9c32012-03-07 19:18:23 +01002498 any expand file wildcards in {expr}
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002499glob2regpat({expr}) String convert a glob pat into a search pat
Bram Moolenaar81edd172016-04-14 13:51:37 +02002500globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00002501 String do glob({expr}) for all dirs in {path}
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002502has({feature}) Number |TRUE| if feature {feature} supported
2503has_key({dict}, {key}) Number |TRUE| if {dict} has entry {key}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002504haslocaldir([{winnr} [, {tabnr}]])
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002505 Number |TRUE| if the window executed |:lcd|
Bram Moolenaar00aa0692019-04-27 20:37:57 +02002506 or |:tcd|
Bram Moolenaar81edd172016-04-14 13:51:37 +02002507hasmapto({what} [, {mode} [, {abbr}]])
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002508 Number |TRUE| if mapping to {what} exists
Bram Moolenaar81edd172016-04-14 13:51:37 +02002509histadd({history}, {item}) String add an item to a history
2510histdel({history} [, {item}]) String remove an item from a history
2511histget({history} [, {index}]) String get the item {index} from a history
2512histnr({history}) Number highest index of a history
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002513hlexists({name}) Number |TRUE| if highlight group {name} exists
Bram Moolenaar81edd172016-04-14 13:51:37 +02002514hlID({name}) Number syntax ID of highlight group {name}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515hostname() String name of the machine Vim is running on
Bram Moolenaar81edd172016-04-14 13:51:37 +02002516iconv({expr}, {from}, {to}) String convert encoding of {expr}
2517indent({lnum}) Number indent of line {lnum}
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002518index({object}, {expr} [, {start} [, {ic}]])
2519 Number index in {object} where {expr} appears
Bram Moolenaar81edd172016-04-14 13:51:37 +02002520input({prompt} [, {text} [, {completion}]])
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00002521 String get input from the user
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +02002522inputdialog({prompt} [, {text} [, {completion}]])
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002523 String like input() but in a GUI dialog
Bram Moolenaar81edd172016-04-14 13:51:37 +02002524inputlist({textlist}) Number let the user pick from a choice list
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002525inputrestore() Number restore typeahead
2526inputsave() Number save and clear typeahead
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002527inputsecret({prompt} [, {text}]) String like input() but hiding the text
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002528insert({object}, {item} [, {idx}]) List insert {item} in {object} [before {idx}]
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002529invert({expr}) Number bitwise invert
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002530isdirectory({directory}) Number |TRUE| if {directory} is a directory
Bram Moolenaarfda1bff2019-04-04 13:44:37 +02002531isinf({expr}) Number determine if {expr} is infinity value
2532 (positive or negative)
Bram Moolenaare381d3d2016-07-07 14:50:41 +02002533islocked({expr}) Number |TRUE| if {expr} is locked
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002534isnan({expr}) Number |TRUE| if {expr} is NaN
Bram Moolenaar81edd172016-04-14 13:51:37 +02002535items({dict}) List key-value pairs in {dict}
2536job_getchannel({job}) Channel get the channel handle for {job}
Bram Moolenaare1fc5152018-04-21 19:49:08 +02002537job_info([{job}]) Dict get information about {job}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002538job_setoptions({job}, {options}) none set options for {job}
2539job_start({command} [, {options}])
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002540 Job start a job
Bram Moolenaar81edd172016-04-14 13:51:37 +02002541job_status({job}) String get the status of {job}
2542job_stop({job} [, {how}]) Number stop {job}
2543join({list} [, {sep}]) String join {list} items into one String
2544js_decode({string}) any decode JS style JSON
2545js_encode({expr}) String encode JS style JSON
2546json_decode({string}) any decode JSON
2547json_encode({expr}) String encode JSON
2548keys({dict}) List keys in {dict}
2549len({expr}) Number the length of {expr}
2550libcall({lib}, {func}, {arg}) String call {func} in library {lib} with {arg}
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002551libcallnr({lib}, {func}, {arg}) Number idem, but return a Number
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02002552line({expr} [, {winid}]) Number line nr of cursor, last line or mark
Bram Moolenaar81edd172016-04-14 13:51:37 +02002553line2byte({lnum}) Number byte count of line {lnum}
2554lispindent({lnum}) Number Lisp indent for line {lnum}
Bram Moolenaar9d401282019-04-06 13:18:12 +02002555list2str({list} [, {utf8}]) String turn numbers in {list} into a String
Bram Moolenaara3347722019-05-11 21:14:24 +02002556listener_add({callback} [, {buf}])
2557 Number add a callback to listen to changes
Bram Moolenaarfe1ade02019-05-14 21:20:36 +02002558listener_flush([{buf}]) none invoke listener callbacks
Bram Moolenaara3347722019-05-11 21:14:24 +02002559listener_remove({id}) none remove a listener callback
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560localtime() Number current time
Bram Moolenaar81edd172016-04-14 13:51:37 +02002561log({expr}) Float natural logarithm (base e) of {expr}
2562log10({expr}) Float logarithm of Float {expr} to base 10
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002563luaeval({expr} [, {expr}]) any evaluate |Lua| expression
Bram Moolenaar50ba5262016-09-22 22:33:02 +02002564map({expr1}, {expr2}) List/Dict change each item in {expr1} to {expr}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002565maparg({name} [, {mode} [, {abbr} [, {dict}]]])
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01002566 String or Dict
2567 rhs of mapping {name} in mode {mode}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002568mapcheck({name} [, {mode} [, {abbr}]])
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002569 String check for mappings matching {name}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002570match({expr}, {pat} [, {start} [, {count}]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 Number position where {pat} matches in {expr}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002572matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
Bram Moolenaar6ee10162007-07-26 20:58:42 +00002573 Number highlight {pattern} with {group}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002574matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
Bram Moolenaarb3414592014-06-17 17:48:32 +02002575 Number highlight positions with {group}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002576matcharg({nr}) List arguments of |:match|
Bram Moolenaaraff74912019-03-30 18:11:49 +01002577matchdelete({id} [, {win}]) Number delete match identified by {id}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002578matchend({expr}, {pat} [, {start} [, {count}]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579 Number position where {pat} ends in {expr}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002580matchlist({expr}, {pat} [, {start} [, {count}]])
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00002581 List match and submatches of {pat} in {expr}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002582matchstr({expr}, {pat} [, {start} [, {count}]])
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00002583 String {count}'th match of {pat} in {expr}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002584matchstrpos({expr}, {pat} [, {start} [, {count}]])
Bram Moolenaar7fed5c12016-03-29 23:10:31 +02002585 List {count}'th match of {pat} in {expr}
Bram Moolenaar690afe12017-01-28 18:34:47 +01002586max({expr}) Number maximum value of items in {expr}
2587min({expr}) Number minimum value of items in {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002588mkdir({name} [, {path} [, {prot}]])
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002589 Number create directory {name}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002590mode([expr]) String current editing mode
2591mzeval({expr}) any evaluate |MzScheme| expression
2592nextnonblank({lnum}) Number line nr of non-blank line >= {lnum}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002593nr2char({expr} [, {utf8}]) String single char with ASCII/UTF8 value {expr}
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002594or({expr}, {expr}) Number bitwise OR
Bram Moolenaar81edd172016-04-14 13:51:37 +02002595pathshorten({expr}) String shorten directory names in a path
2596perleval({expr}) any evaluate |Perl| expression
Bram Moolenaar931a2772019-07-04 16:54:54 +02002597popup_atcursor({what}, {options}) Number create popup window near the cursor
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002598popup_beval({what}, {options}) Number create popup window for 'ballooneval'
Bram Moolenaar931a2772019-07-04 16:54:54 +02002599popup_clear() none close all popup windows
2600popup_close({id} [, {result}]) none close popup window {id}
2601popup_create({what}, {options}) Number create a popup window
2602popup_dialog({what}, {options}) Number create a popup window used as a dialog
2603popup_filter_menu({id}, {key}) Number filter for a menu popup window
2604popup_filter_yesno({id}, {key}) Number filter for a dialog popup window
Bram Moolenaare49fbff2019-08-21 22:50:07 +02002605popup_findinfo() Number get window ID of info popup window
2606popup_findpreview() Number get window ID of preview popup window
Bram Moolenaar931a2772019-07-04 16:54:54 +02002607popup_getoptions({id}) Dict get options of popup window {id}
2608popup_getpos({id}) Dict get position of popup window {id}
2609popup_hide({id}) none hide popup menu {id}
2610popup_menu({what}, {options}) Number create a popup window used as a menu
2611popup_move({id}, {options}) none set position of popup window {id}
2612popup_notification({what}, {options})
2613 Number create a notification popup window
2614popup_show({id}) none unhide popup window {id}
2615popup_setoptions({id}, {options})
2616 none set options for popup window {id}
2617popup_settext({id}, {text}) none set the text of popup window {id}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002618pow({x}, {y}) Float {x} to the power of {y}
2619prevnonblank({lnum}) Number line nr of non-blank line <= {lnum}
2620printf({fmt}, {expr1}...) String format text
Bram Moolenaarf2732452018-06-03 14:47:35 +02002621prompt_setcallback({buf}, {expr}) none set prompt callback function
Bram Moolenaar0e5979a2018-06-17 19:36:33 +02002622prompt_setinterrupt({buf}, {text}) none set prompt interrupt function
2623prompt_setprompt({buf}, {text}) none set prompt text
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002624prop_add({lnum}, {col}, {props}) none add a text property
Bram Moolenaare3d31b02018-12-24 23:07:04 +01002625prop_clear({lnum} [, {lnum-end} [, {props}]])
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002626 none remove all text properties
2627prop_find({props} [, {direction}])
2628 Dict search for a text property
Bram Moolenaar5b69c222019-01-11 14:50:06 +01002629prop_list({lnum} [, {props}) List text properties in {lnum}
Bram Moolenaarc8c88492018-12-27 23:59:26 +01002630prop_remove({props} [, {lnum} [, {lnum-end}]])
Bram Moolenaar98aefe72018-12-13 22:20:09 +01002631 Number remove a text property
2632prop_type_add({name}, {props}) none define a new property type
2633prop_type_change({name}, {props})
2634 none change an existing property type
2635prop_type_delete({name} [, {props}])
2636 none delete a property type
2637prop_type_get([{name} [, {props}])
2638 Dict get property type values
2639prop_type_list([{props}]) List get list of property types
Bram Moolenaare9bd5722019-08-17 19:36:06 +02002640pum_getpos() Dict position and size of pum if visible
Bram Moolenaar446cb832008-06-24 21:56:24 +00002641pumvisible() Number whether popup menu is visible
Bram Moolenaar81edd172016-04-14 13:51:37 +02002642pyeval({expr}) any evaluate |Python| expression
2643py3eval({expr}) any evaluate |python3| expression
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01002644pyxeval({expr}) any evaluate |python_x| expression
Bram Moolenaar81edd172016-04-14 13:51:37 +02002645range({expr} [, {max} [, {stride}]])
Bram Moolenaard8b02732005-01-14 21:48:43 +00002646 List items from {expr} to {max}
Bram Moolenaar62e1bb42019-04-08 16:25:07 +02002647readdir({dir} [, {expr}]) List file names in {dir} selected by {expr}
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002648readfile({fname} [, {type} [, {max}]])
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002649 List get list of lines from file {fname}
Bram Moolenaarf2732452018-06-03 14:47:35 +02002650reg_executing() String get the executing register name
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02002651reg_recording() String get the recording register name
Bram Moolenaar81edd172016-04-14 13:51:37 +02002652reltime([{start} [, {end}]]) List get time value
2653reltimefloat({time}) Float turn the time value into a Float
2654reltimestr({time}) String turn time value into a String
Bram Moolenaar3c2881d2017-03-21 19:18:29 +01002655remote_expr({server}, {string} [, {idvar} [, {timeout}]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 String send expression
Bram Moolenaar81edd172016-04-14 13:51:37 +02002657remote_foreground({server}) Number bring Vim server to the foreground
2658remote_peek({serverid} [, {retvar}])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659 Number check for reply string
Bram Moolenaar3c2881d2017-03-21 19:18:29 +01002660remote_read({serverid} [, {timeout}])
2661 String read reply string
Bram Moolenaar81edd172016-04-14 13:51:37 +02002662remote_send({server}, {string} [, {idvar}])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663 String send key sequence
Bram Moolenaar7416f3e2017-03-18 18:10:13 +01002664remote_startserver({name}) none become server {name}
Bram Moolenaar39536dd2019-01-29 22:58:21 +01002665remove({list}, {idx} [, {end}]) any/List
2666 remove items {idx}-{end} from {list}
2667remove({blob}, {idx} [, {end}]) Number/Blob
2668 remove bytes {idx}-{end} from {blob}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002669remove({dict}, {key}) any remove entry {key} from {dict}
2670rename({from}, {to}) Number rename (move) file from {from} to {to}
2671repeat({expr}, {count}) String repeat {expr} {count} times
2672resolve({filename}) String get filename a shortcut points to
2673reverse({list}) List reverse {list} in-place
2674round({expr}) Float round off {expr}
Bram Moolenaare99be0e2019-03-26 22:51:09 +01002675rubyeval({expr}) any evaluate |Ruby| expression
Bram Moolenaar81edd172016-04-14 13:51:37 +02002676screenattr({row}, {col}) Number attribute at screen position
2677screenchar({row}, {col}) Number character at screen position
Bram Moolenaar2912abb2019-03-29 14:16:42 +01002678screenchars({row}, {col}) List List of characters at screen position
Bram Moolenaar9750bb12012-12-05 16:10:42 +01002679screencol() Number current cursor column
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02002680screenpos({winid}, {lnum}, {col}) Dict screen row and col of a text character
Bram Moolenaar9750bb12012-12-05 16:10:42 +01002681screenrow() Number current cursor row
Bram Moolenaar2912abb2019-03-29 14:16:42 +01002682screenstring({row}, {col}) String characters at screen position
Bram Moolenaar81edd172016-04-14 13:51:37 +02002683search({pattern} [, {flags} [, {stopline} [, {timeout}]]])
Bram Moolenaar76929292008-01-06 19:07:36 +00002684 Number search for {pattern}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002685searchdecl({name} [, {global} [, {thisblock}]])
Bram Moolenaar446cb832008-06-24 21:56:24 +00002686 Number search for variable declaration
Bram Moolenaar81edd172016-04-14 13:51:37 +02002687searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002688 Number search for other end of start/end pair
Bram Moolenaar81edd172016-04-14 13:51:37 +02002689searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002690 List search for other end of start/end pair
Bram Moolenaar81edd172016-04-14 13:51:37 +02002691searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]])
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002692 List search for {pattern}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002693server2client({clientid}, {string})
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 Number send reply string
2695serverlist() String get a list of available servers
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002696setbufline({expr}, {lnum}, {text})
2697 Number set line {lnum} to {text} in buffer
Bram Moolenaarb31cf2b2017-09-02 19:45:19 +02002698 {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002699setbufvar({expr}, {varname}, {val})
2700 none set {varname} in buffer {expr} to {val}
2701setcharsearch({dict}) Dict set character search from {dict}
2702setcmdpos({pos}) Number set cursor position in command-line
Bram Moolenaar691ddee2019-05-09 14:52:41 +02002703setenv({name}, {val}) none set environment variable
Bram Moolenaar81edd172016-04-14 13:51:37 +02002704setfperm({fname}, {mode}) Number set {fname} file permissions to {mode}
2705setline({lnum}, {line}) Number set line {lnum} to {line}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002706setloclist({nr}, {list} [, {action} [, {what}]])
Bram Moolenaar17c7c012006-01-26 22:25:15 +00002707 Number modify location list using {list}
Bram Moolenaaraff74912019-03-30 18:11:49 +01002708setmatches({list} [, {win}]) Number restore a list of matches
Bram Moolenaar81edd172016-04-14 13:51:37 +02002709setpos({expr}, {list}) Number set the {expr} position to {list}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002710setqflist({list} [, {action} [, {what}]])
Bram Moolenaard823fa92016-08-12 16:29:27 +02002711 Number modify quickfix list using {list}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002712setreg({n}, {v} [, {opt}]) Number set register to value and type
Bram Moolenaar81edd172016-04-14 13:51:37 +02002713settabvar({nr}, {varname}, {val}) none set {varname} in tab page {nr} to {val}
2714settabwinvar({tabnr}, {winnr}, {varname}, {val})
2715 none set {varname} in window {winnr} in tab
2716 page {tabnr} to {val}
Bram Moolenaarf49cc602018-11-11 15:21:05 +01002717settagstack({nr}, {dict} [, {action}])
2718 Number modify tag stack using {dict}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002719setwinvar({nr}, {varname}, {val}) none set {varname} in window {nr} to {val}
2720sha256({string}) String SHA256 checksum of {string}
2721shellescape({string} [, {special}])
Bram Moolenaar05bb9532008-07-04 09:44:11 +00002722 String escape {string} for use as shell
Bram Moolenaar60a495f2006-10-03 12:44:42 +00002723 command argument
Bram Moolenaarf9514162018-11-22 03:08:29 +01002724shiftwidth([{col}]) Number effective value of 'shiftwidth'
Bram Moolenaar162b7142018-12-21 15:17:36 +01002725sign_define({name} [, {dict}]) Number define or update a sign
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002726sign_define({list}) List define or update a list of signs
Bram Moolenaar162b7142018-12-21 15:17:36 +01002727sign_getdefined([{name}]) List get a list of defined signs
2728sign_getplaced([{expr} [, {dict}]])
2729 List get a list of placed signs
Bram Moolenaar6b7b7192019-01-11 13:42:41 +01002730sign_jump({id}, {group}, {expr})
2731 Number jump to a sign
Bram Moolenaar162b7142018-12-21 15:17:36 +01002732sign_place({id}, {group}, {name}, {expr} [, {dict}])
2733 Number place a sign
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002734sign_placelist({list}) List place a list of signs
Bram Moolenaar162b7142018-12-21 15:17:36 +01002735sign_undefine([{name}]) Number undefine a sign
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002736sign_undefine({list}) List undefine a list of signs
Bram Moolenaar162b7142018-12-21 15:17:36 +01002737sign_unplace({group} [, {dict}])
2738 Number unplace a sign
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02002739sign_unplacelist({list}) List unplace a list of signs
Bram Moolenaar81edd172016-04-14 13:51:37 +02002740simplify({filename}) String simplify filename as much as possible
2741sin({expr}) Float sine of {expr}
2742sinh({expr}) Float hyperbolic sine of {expr}
2743sort({list} [, {func} [, {dict}]])
Bram Moolenaar5f894962011-06-19 02:55:37 +02002744 List sort {list}, using {func} to compare
Bram Moolenaar3ff5f0f2019-06-10 13:11:22 +02002745sound_clear() none stop playing all sounds
Bram Moolenaar427f5b62019-06-09 13:43:51 +02002746sound_playevent({name} [, {callback}])
2747 Number play an event sound
Bram Moolenaar3ff5f0f2019-06-10 13:11:22 +02002748sound_playfile({path} [, {callback}])
2749 Number play sound file {path}
Bram Moolenaar427f5b62019-06-09 13:43:51 +02002750sound_stop({id}) none stop playing sound {id}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002751soundfold({word}) String sound-fold {word}
Bram Moolenaard857f0e2005-06-21 22:37:39 +00002752spellbadword() String badly spelled word at cursor
Bram Moolenaar81edd172016-04-14 13:51:37 +02002753spellsuggest({word} [, {max} [, {capital}]])
Bram Moolenaarc54b8a72005-09-30 21:20:29 +00002754 List spelling suggestions
Bram Moolenaar81edd172016-04-14 13:51:37 +02002755split({expr} [, {pat} [, {keepempty}]])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002756 List make |List| from {pat} separated {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002757sqrt({expr}) Float square root of {expr}
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02002758state([{what}]) String current state of Vim
Bram Moolenaar81edd172016-04-14 13:51:37 +02002759str2float({expr}) Float convert String to Float
Bram Moolenaar9d401282019-04-06 13:18:12 +02002760str2list({expr} [, {utf8}]) List convert each character of {expr} to
2761 ASCII/UTF8 value
Bram Moolenaar60a8de22019-09-15 14:33:22 +02002762str2nr({expr} [, {base} [, {quoted}]])
2763 Number convert String to Number
Bram Moolenaar81edd172016-04-14 13:51:37 +02002764strchars({expr} [, {skipcc}]) Number character length of the String {expr}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002765strcharpart({str}, {start} [, {len}])
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02002766 String {len} characters of {str} at {start}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002767strdisplaywidth({expr} [, {col}]) Number display length of the String {expr}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002768strftime({format} [, {time}]) String time in specified format
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02002769strgetchar({str}, {index}) Number get char {index} from {str}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002770stridx({haystack}, {needle} [, {start}])
Bram Moolenaar8f999f12005-01-25 22:12:55 +00002771 Number index of {needle} in {haystack}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002772string({expr}) String String representation of {expr} value
2773strlen({expr}) Number length of the String {expr}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002774strpart({str}, {start} [, {len}])
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02002775 String {len} characters of {str} at {start}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002776strridx({haystack}, {needle} [, {start}])
Bram Moolenaar677ee682005-01-27 14:41:15 +00002777 Number last index of {needle} in {haystack}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002778strtrans({expr}) String translate string to make it printable
2779strwidth({expr}) Number display cell length of the String {expr}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002780submatch({nr} [, {list}]) String or List
Bram Moolenaar41571762014-04-02 19:00:58 +02002781 specific match in ":s" or substitute()
Bram Moolenaar81edd172016-04-14 13:51:37 +02002782substitute({expr}, {pat}, {sub}, {flags})
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 String all {pat} in {expr} replaced with {sub}
Bram Moolenaar00f123a2018-08-21 20:28:54 +02002784swapinfo({fname}) Dict information about swap file {fname}
Bram Moolenaar110bd602018-09-16 18:46:59 +02002785swapname({expr}) String swap file of buffer {expr}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002786synID({lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col}
2787synIDattr({synID}, {what} [, {mode}])
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788 String attribute {what} of syntax ID {synID}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002789synIDtrans({synID}) Number translated syntax ID of {synID}
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002790synconcealed({lnum}, {col}) List info about concealing
Bram Moolenaar81edd172016-04-14 13:51:37 +02002791synstack({lnum}, {col}) List stack of syntax IDs at {lnum} and {col}
2792system({expr} [, {input}]) String output of shell command/filter {expr}
2793systemlist({expr} [, {input}]) List output of shell command/filter {expr}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02002794tabpagebuflist([{arg}]) List list of buffer numbers in tab page
Bram Moolenaar81edd172016-04-14 13:51:37 +02002795tabpagenr([{arg}]) Number number of current or last tab page
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002796tabpagewinnr({tabarg} [, {arg}]) Number number of current window in tab page
2797taglist({expr} [, {filename}]) List list of tags matching {expr}
Bram Moolenaar446cb832008-06-24 21:56:24 +00002798tagfiles() List tags files used
Bram Moolenaar81edd172016-04-14 13:51:37 +02002799tan({expr}) Float tangent of {expr}
2800tanh({expr}) Float hyperbolic tangent of {expr}
Bram Moolenaar975b5272016-03-15 23:10:59 +01002801tempname() String name for a temporary file
Bram Moolenaard96ff162018-02-18 22:13:29 +01002802term_dumpdiff({filename}, {filename} [, {options}])
2803 Number display difference between two dumps
2804term_dumpload({filename} [, {options}])
2805 Number displaying a screen dump
Bram Moolenaar6bb2cdf2018-02-24 19:53:53 +01002806term_dumpwrite({buf}, {filename} [, {options}])
Bram Moolenaard96ff162018-02-18 22:13:29 +01002807 none dump terminal window contents
Bram Moolenaare41e3b42017-08-11 16:24:50 +02002808term_getaltscreen({buf}) Number get the alternate screen flag
Bram Moolenaarf59c6e82018-04-10 15:59:11 +02002809term_getansicolors({buf}) List get ANSI palette in GUI color mode
Bram Moolenaar45356542017-08-06 17:53:31 +02002810term_getattr({attr}, {what}) Number get the value of attribute {what}
Bram Moolenaar97870002017-07-30 18:28:38 +02002811term_getcursor({buf}) List get the cursor position of a terminal
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02002812term_getjob({buf}) Job get the job associated with a terminal
Bram Moolenaarc2ce52c2017-08-01 18:35:38 +02002813term_getline({buf}, {row}) String get a line of text from a terminal
Bram Moolenaar82b9ca02017-08-08 23:06:46 +02002814term_getscrolled({buf}) Number get the scroll count of a terminal
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02002815term_getsize({buf}) List get the size of a terminal
Bram Moolenaarb000e322017-07-30 19:38:21 +02002816term_getstatus({buf}) String get the status of a terminal
2817term_gettitle({buf}) String get the title of a terminal
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01002818term_gettty({buf}, [{input}]) String get the tty name of a terminal
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02002819term_list() List get the list of terminal buffers
Bram Moolenaarc2ce52c2017-08-01 18:35:38 +02002820term_scrape({buf}, {row}) List get row of a terminal screen
Bram Moolenaarc6df10e2017-07-29 20:15:08 +02002821term_sendkeys({buf}, {keys}) none send keystrokes to a terminal
Bram Moolenaarf59c6e82018-04-10 15:59:11 +02002822term_setansicolors({buf}, {colors})
2823 none set ANSI palette in GUI color mode
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02002824term_setkill({buf}, {how}) none set signal to stop job in terminal
Bram Moolenaarb5b75622018-03-09 22:22:21 +01002825term_setrestore({buf}, {command}) none set command to restore terminal
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02002826term_setsize({buf}, {rows}, {cols})
2827 none set the size of a terminal
Bram Moolenaar911ead12019-04-21 00:03:35 +02002828term_start({cmd} [, {options}]) Number open a terminal window and run a job
Bram Moolenaarf3402b12017-08-06 19:07:08 +02002829term_wait({buf} [, {time}]) Number wait for screen to be updated
Bram Moolenaar8e8df252016-05-25 21:23:21 +02002830test_alloc_fail({id}, {countdown}, {repeat})
2831 none make memory allocation fail
Bram Moolenaar6f1d9a02016-07-24 14:12:38 +02002832test_autochdir() none enable 'autochdir' during startup
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002833test_feedinput({string}) none add key sequence to input buffer
Bram Moolenaar574860b2016-05-24 17:33:34 +02002834test_garbagecollect_now() none free memory right now for testing
Bram Moolenaaradc67142019-06-22 01:40:42 +02002835test_garbagecollect_soon() none free memory soon for testing
Bram Moolenaareda65222019-05-16 20:29:44 +02002836test_getvalue({string}) any get value of an internal variable
Bram Moolenaare0c31f62017-03-01 15:07:05 +01002837test_ignore_error({expr}) none ignore a specific error
Bram Moolenaarc0f5a782019-01-13 15:16:13 +01002838test_null_blob() Blob null value for testing
Bram Moolenaar574860b2016-05-24 17:33:34 +02002839test_null_channel() Channel null value for testing
2840test_null_dict() Dict null value for testing
2841test_null_job() Job null value for testing
2842test_null_list() List null value for testing
2843test_null_partial() Funcref null value for testing
2844test_null_string() String null value for testing
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02002845test_option_not_set({name}) none reset flag indicating option was set
2846test_override({expr}, {val}) none test with Vim internal overrides
Bram Moolenaarc3e92c12019-03-23 14:23:07 +01002847test_refcount({expr}) Number get the reference count of {expr}
Bram Moolenaarab186732018-09-14 21:27:06 +02002848test_scrollbar({which}, {value}, {dragging})
2849 none scroll in the GUI for testing
Bram Moolenaarbb8476b2019-05-04 15:47:48 +02002850test_setmouse({row}, {col}) none set the mouse position for testing
Bram Moolenaarc95a3022016-06-12 23:01:46 +02002851test_settime({expr}) none set current time for testing
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02002852timer_info([{id}]) List information about timers
Bram Moolenaarb73598e2016-08-07 18:22:53 +02002853timer_pause({id}, {pause}) none pause or unpause a timer
Bram Moolenaar81edd172016-04-14 13:51:37 +02002854timer_start({time}, {callback} [, {options}])
Bram Moolenaar975b5272016-03-15 23:10:59 +01002855 Number create a timer
Bram Moolenaar81edd172016-04-14 13:51:37 +02002856timer_stop({timer}) none stop a timer
Bram Moolenaarb73598e2016-08-07 18:22:53 +02002857timer_stopall() none stop all timers
Bram Moolenaar81edd172016-04-14 13:51:37 +02002858tolower({expr}) String the String {expr} switched to lowercase
2859toupper({expr}) String the String {expr} switched to uppercase
2860tr({src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr}
Bram Moolenaar8299df92004-07-10 09:47:34 +00002861 to chars in {tostr}
Bram Moolenaard473c8c2018-08-11 18:00:22 +02002862trim({text} [, {mask}]) String trim characters in {mask} from {text}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002863trunc({expr}) Float truncate Float {expr}
2864type({name}) Number type of variable {name}
2865undofile({name}) String undo file name for {name}
Bram Moolenaara800b422010-06-27 01:15:55 +02002866undotree() List undo file tree
Bram Moolenaar81edd172016-04-14 13:51:37 +02002867uniq({list} [, {func} [, {dict}]])
Bram Moolenaar327aa022014-03-25 18:24:23 +01002868 List remove adjacent duplicates from a list
Bram Moolenaar81edd172016-04-14 13:51:37 +02002869values({dict}) List values in {dict}
2870virtcol({expr}) Number screen column of cursor or mark
2871visualmode([expr]) String last visual mode used
Bram Moolenaar8738fc12013-02-20 17:59:11 +01002872wildmenumode() Number whether 'wildmenu' mode is active
Bram Moolenaar868b7b62019-05-29 21:44:40 +02002873win_execute({id}, {command} [, {silent}])
2874 String execute {command} in window {id}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002875win_findbuf({bufnr}) List find windows containing {bufnr}
2876win_getid([{win} [, {tab}]]) Number get window ID for {win} in {tab}
2877win_gotoid({expr}) Number go to window with ID {expr}
2878win_id2tabwin({expr}) List get tab and window nr from window ID
2879win_id2win({expr}) Number get window nr from window ID
Bram Moolenaar22044dc2017-12-02 15:43:37 +01002880win_screenpos({nr}) List get screen position of window {nr}
Bram Moolenaard20dcb32019-09-10 21:22:58 +02002881win_splitmove({nr}, {target} [, {options}])
2882 none move window {nr} to split of {target}
Bram Moolenaar81edd172016-04-14 13:51:37 +02002883winbufnr({nr}) Number buffer number of window {nr}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884wincol() Number window column of the cursor
Bram Moolenaar81edd172016-04-14 13:51:37 +02002885winheight({nr}) Number height of window {nr}
Bram Moolenaar0f6b4f02018-08-21 16:56:34 +02002886winlayout([{tabnr}]) List layout of windows in tab {tabnr}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887winline() Number window line of the cursor
Bram Moolenaar81edd172016-04-14 13:51:37 +02002888winnr([{expr}]) Number number of current window
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002889winrestcmd() String returns command to restore window sizes
Bram Moolenaar81edd172016-04-14 13:51:37 +02002890winrestview({dict}) none restore view of current window
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00002891winsaveview() Dict save view of current window
Bram Moolenaar81edd172016-04-14 13:51:37 +02002892winwidth({nr}) Number width of window {nr}
Bram Moolenaared767a22016-01-03 22:49:16 +01002893wordcount() Dict get byte/char/word statistics
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01002894writefile({object}, {fname} [, {flags}])
2895 Number write |Blob| or |List| of lines to file
Bram Moolenaara06ecab2016-07-16 14:47:36 +02002896xor({expr}, {expr}) Number bitwise XOR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897
Bram Moolenaar03413f42016-04-12 21:07:15 +02002898
Bram Moolenaar446cb832008-06-24 21:56:24 +00002899abs({expr}) *abs()*
2900 Return the absolute value of {expr}. When {expr} evaluates to
2901 a |Float| abs() returns a |Float|. When {expr} can be
2902 converted to a |Number| abs() returns a |Number|. Otherwise
2903 abs() gives an error message and returns -1.
2904 Examples: >
2905 echo abs(1.456)
2906< 1.456 >
2907 echo abs(-5.456)
2908< 5.456 >
2909 echo abs(-4)
2910< 4
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02002911
2912 Can also be used as a |method|: >
2913 Compute()->abs()
2914
2915< {only available when compiled with the |+float| feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00002916
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002917
2918acos({expr}) *acos()*
2919 Return the arc cosine of {expr} measured in radians, as a
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02002920 |Float| in the range of [0, pi].
2921 {expr} must evaluate to a |Float| or a |Number| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002922 [-1, 1].
2923 Examples: >
2924 :echo acos(0)
2925< 1.570796 >
2926 :echo acos(-0.5)
2927< 2.094395
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02002928
2929 Can also be used as a |method|: >
2930 Compute()->acos()
2931
2932< {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02002933
2934
Bram Moolenaard8968242019-01-15 22:51:57 +01002935add({object}, {expr}) *add()*
2936 Append the item {expr} to |List| or |Blob| {object}. Returns
2937 the resulting |List| or |Blob|. Examples: >
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002938 :let alist = add([1, 2, 3], item)
2939 :call add(mylist, "woodstock")
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002940< Note that when {expr} is a |List| it is appended as a single
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002941 item. Use |extend()| to concatenate |Lists|.
Bram Moolenaard8968242019-01-15 22:51:57 +01002942 When {object} is a |Blob| then {expr} must be a number.
Bram Moolenaar13065c42005-01-08 16:08:21 +00002943 Use |insert()| to add an item at another position.
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02002944
Bram Moolenaarac92e252019-08-03 21:58:38 +02002945 Can also be used as a |method|: >
2946 mylist->add(val1)->add(val2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002948
Bram Moolenaard6e256c2011-12-14 15:32:50 +01002949and({expr}, {expr}) *and()*
2950 Bitwise AND on the two arguments. The arguments are converted
2951 to a number. A List, Dict or Float argument causes an error.
2952 Example: >
2953 :let flag = and(bits, 0x80)
Bram Moolenaar073e4b92019-08-18 23:01:56 +02002954< Can also be used as a |method|: >
2955 :let flag = bits->and(0x80)
Bram Moolenaard6e256c2011-12-14 15:32:50 +01002956
2957
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002958append({lnum}, {text}) *append()*
2959 When {text} is a |List|: Append each item of the |List| as a
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002960 text line below line {lnum} in the current buffer.
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002961 Otherwise append {text} as one text line below line {lnum} in
Bram Moolenaar748bf032005-02-02 23:04:36 +00002962 the current buffer.
2963 {lnum} can be zero to insert a line before the first one.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002964 Returns 1 for failure ({lnum} out of range or out of memory),
Bram Moolenaar58b85342016-08-14 19:54:54 +02002965 0 for success. Example: >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002966 :let failed = append(line('$'), "# THE END")
Bram Moolenaara14de3d2005-01-07 21:48:26 +00002967 :let failed = append(0, ["Chapter 1", "the beginning"])
Bram Moolenaarca851592018-06-06 21:04:07 +02002968
Bram Moolenaar25e42232019-08-04 15:04:10 +02002969< Can also be used as a |method| after a List: >
2970 mylist->append(lnum)
2971
2972
Bram Moolenaarca851592018-06-06 21:04:07 +02002973appendbufline({expr}, {lnum}, {text}) *appendbufline()*
2974 Like |append()| but append the text in buffer {expr}.
2975
2976 For the use of {expr}, see |bufname()|.
2977
2978 {lnum} is used like with |append()|. Note that using |line()|
2979 would use the current buffer, not the one appending to.
2980 Use "$" to append at the end of the buffer.
2981
2982 On success 0 is returned, on failure 1 is returned.
2983
2984 If {expr} is not a valid buffer or {lnum} is not valid, an
2985 error message is given. Example: >
2986 :let failed = appendbufline(13, 0, "# THE START")
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00002987<
Bram Moolenaar25e42232019-08-04 15:04:10 +02002988 Can also be used as a |method| after a List: >
2989 mylist->appendbufline(buf, lnum)
2990
2991
2992argc([{winid}]) *argc()*
Bram Moolenaare6e39892018-10-25 12:32:11 +02002993 The result is the number of files in the argument list. See
2994 |arglist|.
2995 If {winid} is not supplied, the argument list of the current
2996 window is used.
2997 If {winid} is -1, the global argument list is used.
2998 Otherwise {winid} specifies the window of which the argument
2999 list is used: either the window number or the window ID.
3000 Returns -1 if the {winid} argument is invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001
3002 *argidx()*
3003argidx() The result is the current index in the argument list. 0 is
3004 the first file. argc() - 1 is the last one. See |arglist|.
3005
Bram Moolenaar2d1fe052014-05-28 18:22:57 +02003006 *arglistid()*
Bram Moolenaare0fa3742016-02-20 15:47:01 +01003007arglistid([{winnr} [, {tabnr}]])
Bram Moolenaar2d1fe052014-05-28 18:22:57 +02003008 Return the argument list ID. This is a number which
3009 identifies the argument list being used. Zero is used for the
Bram Moolenaarfb539272014-08-22 19:21:47 +02003010 global argument list. See |arglist|.
Bram Moolenaare6e39892018-10-25 12:32:11 +02003011 Returns -1 if the arguments are invalid.
Bram Moolenaar2d1fe052014-05-28 18:22:57 +02003012
3013 Without arguments use the current window.
3014 With {winnr} only use this window in the current tab page.
3015 With {winnr} and {tabnr} use the window in the specified tab
3016 page.
Bram Moolenaar7571d552016-08-18 22:54:46 +02003017 {winnr} can be the window number or the |window-ID|.
Bram Moolenaar2d1fe052014-05-28 18:22:57 +02003018
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 *argv()*
Bram Moolenaare6e39892018-10-25 12:32:11 +02003020argv([{nr} [, {winid}])
3021 The result is the {nr}th file in the argument list. See
3022 |arglist|. "argv(0)" is the first one. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 :let i = 0
3024 :while i < argc()
Bram Moolenaar446cb832008-06-24 21:56:24 +00003025 : let f = escape(fnameescape(argv(i)), '.')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>'
3027 : let i = i + 1
3028 :endwhile
Bram Moolenaare6e39892018-10-25 12:32:11 +02003029< Without the {nr} argument, or when {nr} is -1, a |List| with
3030 the whole |arglist| is returned.
3031
3032 The {winid} argument specifies the window ID, see |argc()|.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00003033
Bram Moolenaarb48e96f2018-02-13 12:26:14 +01003034
Bram Moolenaar54775062019-07-31 21:07:14 +02003035assert_ functions are documented here: |assert-functions-details|
Bram Moolenaar43345542015-11-29 17:35:35 +01003036
Bram Moolenaar43345542015-11-29 17:35:35 +01003037
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003038asin({expr}) *asin()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003039 Return the arc sine of {expr} measured in radians, as a |Float|
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003040 in the range of [-pi/2, pi/2].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003041 {expr} must evaluate to a |Float| or a |Number| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003042 [-1, 1].
3043 Examples: >
3044 :echo asin(0.8)
3045< 0.927295 >
3046 :echo asin(-0.5)
3047< -0.523599
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02003048
3049 Can also be used as a |method|: >
3050 Compute()->asin()
3051<
Bram Moolenaardb84e452010-08-15 13:50:43 +02003052 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003053
3054
Bram Moolenaar446cb832008-06-24 21:56:24 +00003055atan({expr}) *atan()*
3056 Return the principal value of the arc tangent of {expr}, in
3057 the range [-pi/2, +pi/2] radians, as a |Float|.
3058 {expr} must evaluate to a |Float| or a |Number|.
3059 Examples: >
3060 :echo atan(100)
3061< 1.560797 >
3062 :echo atan(-4.01)
3063< -1.326405
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02003064
3065 Can also be used as a |method|: >
3066 Compute()->atan()
3067<
Bram Moolenaar446cb832008-06-24 21:56:24 +00003068 {only available when compiled with the |+float| feature}
3069
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003070
3071atan2({expr1}, {expr2}) *atan2()*
3072 Return the arc tangent of {expr1} / {expr2}, measured in
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003073 radians, as a |Float| in the range [-pi, pi].
3074 {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003075 Examples: >
3076 :echo atan2(-1, 1)
3077< -0.785398 >
3078 :echo atan2(1, -1)
3079< 2.356194
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02003080
3081 Can also be used as a |method|: >
3082 Compute()->atan(1)
3083<
Bram Moolenaardb84e452010-08-15 13:50:43 +02003084 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003085
Bram Moolenaarbe0a2592019-05-09 13:50:16 +02003086balloon_gettext() *balloon_gettext()*
3087 Return the current text in the balloon. Only for the string,
3088 not used for the List.
3089
Bram Moolenaar246fe032017-11-19 19:56:27 +01003090balloon_show({expr}) *balloon_show()*
3091 Show {expr} inside the balloon. For the GUI {expr} is used as
3092 a string. For a terminal {expr} can be a list, which contains
3093 the lines of the balloon. If {expr} is not a list it will be
3094 split with |balloon_split()|.
Bram Moolenaarbe0a2592019-05-09 13:50:16 +02003095 If {expr} is an empty string any existing balloon is removed.
Bram Moolenaar246fe032017-11-19 19:56:27 +01003096
Bram Moolenaar214641f2017-03-05 17:04:09 +01003097 Example: >
Bram Moolenaar59716a22017-03-01 20:32:44 +01003098 func GetBalloonContent()
Bram Moolenaarbe0a2592019-05-09 13:50:16 +02003099 " ... initiate getting the content
Bram Moolenaar59716a22017-03-01 20:32:44 +01003100 return ''
3101 endfunc
3102 set balloonexpr=GetBalloonContent()
3103
3104 func BalloonCallback(result)
Bram Moolenaar214641f2017-03-05 17:04:09 +01003105 call balloon_show(a:result)
Bram Moolenaar59716a22017-03-01 20:32:44 +01003106 endfunc
Bram Moolenaar073e4b92019-08-18 23:01:56 +02003107< Can also be used as a |method|: >
3108 GetText()->balloon_show()
Bram Moolenaar59716a22017-03-01 20:32:44 +01003109<
3110 The intended use is that fetching the content of the balloon
3111 is initiated from 'balloonexpr'. It will invoke an
3112 asynchronous method, in which a callback invokes
3113 balloon_show(). The 'balloonexpr' itself can return an
3114 empty string or a placeholder.
Bram Moolenaar214641f2017-03-05 17:04:09 +01003115
3116 When showing a balloon is not possible nothing happens, no
3117 error message.
Bram Moolenaar95bafa22018-10-02 13:26:25 +02003118 {only available when compiled with the |+balloon_eval| or
3119 |+balloon_eval_term| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003120
Bram Moolenaar246fe032017-11-19 19:56:27 +01003121balloon_split({msg}) *balloon_split()*
3122 Split {msg} into lines to be displayed in a balloon. The
3123 splits are made for the current window size and optimize to
3124 show debugger output.
3125 Returns a |List| with the split lines.
Bram Moolenaar073e4b92019-08-18 23:01:56 +02003126 Can also be used as a |method|: >
3127 GetText()->balloon_split()->balloon_show()
3128
3129< {only available when compiled with the |+balloon_eval_term|
Bram Moolenaar669a8282017-11-19 20:13:05 +01003130 feature}
Bram Moolenaar246fe032017-11-19 19:56:27 +01003131
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 *browse()*
3133browse({save}, {title}, {initdir}, {default})
3134 Put up a file requester. This only works when "has("browse")"
Bram Moolenaare381d3d2016-07-07 14:50:41 +02003135 returns |TRUE| (only in some GUI versions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136 The input fields are:
Bram Moolenaare381d3d2016-07-07 14:50:41 +02003137 {save} when |TRUE|, select file to write
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 {title} title for the requester
3139 {initdir} directory to start browsing in
3140 {default} default file name
Bram Moolenaar073e4b92019-08-18 23:01:56 +02003141 An empty string is returned when the "Cancel" button is hit,
3142 something went wrong, or browsing is not possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003144 *browsedir()*
3145browsedir({title}, {initdir})
3146 Put up a directory requester. This only works when
Bram Moolenaare381d3d2016-07-07 14:50:41 +02003147 "has("browse")" returns |TRUE| (only in some GUI versions).
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003148 On systems where a directory browser is not supported a file
3149 browser is used. In that case: select a file in the directory
3150 to be used.
3151 The input fields are:
3152 {title} title for the requester
3153 {initdir} directory to start browsing in
3154 When the "Cancel" button is hit, something went wrong, or
3155 browsing is not possible, an empty string is returned.
3156
Bram Moolenaar15e248e2019-06-30 20:21:37 +02003157bufadd({name}) *bufadd()*
3158 Add a buffer to the buffer list with {name}.
3159 If a buffer for file {name} already exists, return that buffer
3160 number. Otherwise return the buffer number of the newly
3161 created buffer. When {name} is an empty string then a new
3162 buffer is always created.
Bram Moolenaaraad222c2019-09-06 22:46:09 +02003163 The buffer will not have 'buflisted' set and not be loaded
Bram Moolenaar5ca1ac32019-07-04 15:39:28 +02003164 yet. To add some text to the buffer use this: >
3165 let bufnr = bufadd('someName')
3166 call bufload(bufnr)
3167 call setbufline(bufnr, 1, ['some', 'text'])
Bram Moolenaar073e4b92019-08-18 23:01:56 +02003168< Can also be used as a |method|: >
3169 let bufnr = 'somename'->bufadd()
Bram Moolenaar15e248e2019-06-30 20:21:37 +02003170
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171bufexists({expr}) *bufexists()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02003172 The result is a Number, which is |TRUE| if a buffer called
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 {expr} exists.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00003174 If the {expr} argument is a number, buffer numbers are used.
Bram Moolenaara2a80162017-11-21 23:09:50 +01003175 Number zero is the alternate buffer for the current window.
3176
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 If the {expr} argument is a string it must match a buffer name
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00003178 exactly. The name can be:
3179 - Relative to the current directory.
3180 - A full path.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003181 - The name of a buffer with 'buftype' set to "nofile".
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00003182 - A URL name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 Unlisted buffers will be found.
3184 Note that help files are listed by their short name in the
3185 output of |:buffers|, but bufexists() requires using their
3186 long name to be able to find them.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003187 bufexists() may report a buffer exists, but to use the name
3188 with a |:buffer| command you may need to use |expand()|. Esp
3189 for MS-Windows 8.3 names in the form "c:\DOCUME~1"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 Use "bufexists(0)" to test for the existence of an alternate
3191 file name.
Bram Moolenaar073e4b92019-08-18 23:01:56 +02003192
3193 Can also be used as a |method|: >
3194 let exists = 'somename'->bufexists()
3195<
3196 Obsolete name: buffer_exists(). *buffer_exists()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197
3198buflisted({expr}) *buflisted()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02003199 The result is a Number, which is |TRUE| if a buffer called
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 {expr} exists and is listed (has the 'buflisted' option set).
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00003201 The {expr} argument is used like with |bufexists()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202
Bram Moolenaar073e4b92019-08-18 23:01:56 +02003203 Can also be used as a |method|: >
3204 let listed = 'somename'->buflisted()
3205
Bram Moolenaar15e248e2019-06-30 20:21:37 +02003206bufload({expr}) *bufload()*
3207 Ensure the buffer {expr} is loaded. When the buffer name
3208 refers to an existing file then the file is read. Otherwise
3209 the buffer will be empty. If the buffer was already loaded
3210 then there is no change.
3211 If there is an existing swap file for the file of the buffer,
3212 there will be no dialog, the buffer will be loaded anyway.
3213 The {expr} argument is used like with |bufexists()|.
3214
Bram Moolenaar073e4b92019-08-18 23:01:56 +02003215 Can also be used as a |method|: >
3216 eval 'somename'->bufload()
3217
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218bufloaded({expr}) *bufloaded()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02003219 The result is a Number, which is |TRUE| if a buffer called
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 {expr} exists and is loaded (shown in a window or hidden).
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00003221 The {expr} argument is used like with |bufexists()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222
Bram Moolenaar073e4b92019-08-18 23:01:56 +02003223 Can also be used as a |method|: >
3224 let loaded = 'somename'->bufloaded()
3225
Bram Moolenaara8eee212019-08-24 22:14:58 +02003226bufname([{expr}]) *bufname()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 The result is the name of a buffer, as it is displayed by the
3228 ":ls" command.
Bram Moolenaara8eee212019-08-24 22:14:58 +02003229 If {expr} is omitted the current buffer is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 If {expr} is a Number, that buffer number's name is given.
3231 Number zero is the alternate buffer for the current window.
3232 If {expr} is a String, it is used as a |file-pattern| to match
Bram Moolenaar58b85342016-08-14 19:54:54 +02003233 with the buffer names. This is always done like 'magic' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 set and 'cpoptions' is empty. When there is more than one
3235 match an empty string is returned.
3236 "" or "%" can be used for the current buffer, "#" for the
3237 alternate buffer.
3238 A full match is preferred, otherwise a match at the start, end
Bram Moolenaaref2f6562007-05-06 13:32:59 +00003239 or middle of the buffer name is accepted. If you only want a
3240 full match then put "^" at the start and "$" at the end of the
3241 pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 Listed buffers are found first. If there is a single match
3243 with a listed buffer, that one is returned. Next unlisted
3244 buffers are searched for.
3245 If the {expr} is a String, but you want to use it as a buffer
3246 number, force it to be a Number by adding zero to it: >
3247 :echo bufname("3" + 0)
Bram Moolenaar073e4b92019-08-18 23:01:56 +02003248< Can also be used as a |method|: >
3249 echo bufnr->bufname()
3250
Bram Moolenaar071d4272004-06-13 20:20:40 +00003251< If the buffer doesn't exist, or doesn't have a name, an empty
3252 string is returned. >
3253 bufname("#") alternate buffer name
3254 bufname(3) name of buffer 3
3255 bufname("%") name of current buffer
3256 bufname("file2") name of buffer where "file2" matches.
3257< *buffer_name()*
3258 Obsolete name: buffer_name().
3259
3260 *bufnr()*
Bram Moolenaara8eee212019-08-24 22:14:58 +02003261bufnr([{expr} [, {create}]])
Bram Moolenaar65c923a2006-03-03 22:56:30 +00003262 The result is the number of a buffer, as it is displayed by
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 the ":ls" command. For the use of {expr}, see |bufname()|
Bram Moolenaar65c923a2006-03-03 22:56:30 +00003264 above.
3265 If the buffer doesn't exist, -1 is returned. Or, if the
3266 {create} argument is present and not zero, a new, unlisted,
3267 buffer is created and its number is returned.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 bufnr("$") is the last buffer: >
Bram Moolenaara8eee212019-08-24 22:14:58 +02003269 :let last_buffer = bufnr("$")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270< The result is a Number, which is the highest buffer number
3271 of existing buffers. Note that not all buffers with a smaller
3272 number necessarily exist, because ":bwipeout" may have removed
3273 them. Use bufexists() to test for the existence of a buffer.
Bram Moolenaar073e4b92019-08-18 23:01:56 +02003274
3275 Can also be used as a |method|: >
3276 echo bufref->bufnr()
3277<
3278 Obsolete name: buffer_number(). *buffer_number()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 *last_buffer_nr()*
3280 Obsolete name for bufnr("$"): last_buffer_nr().
3281
Bram Moolenaarb3619a92016-06-04 17:58:52 +02003282bufwinid({expr}) *bufwinid()*
Bram Moolenaar7571d552016-08-18 22:54:46 +02003283 The result is a Number, which is the |window-ID| of the first
Bram Moolenaarb3619a92016-06-04 17:58:52 +02003284 window associated with buffer {expr}. For the use of {expr},
Bram Moolenaar58b85342016-08-14 19:54:54 +02003285 see |bufname()| above. If buffer {expr} doesn't exist or
Bram Moolenaarb3619a92016-06-04 17:58:52 +02003286 there is no such window, -1 is returned. Example: >
3287
3288 echo "A window containing buffer 1 is " . (bufwinid(1))
3289<
3290 Only deals with the current tab page.
3291
Bram Moolenaare49fbff2019-08-21 22:50:07 +02003292 Can also be used as a |method|: >
3293 FindBuffer()->bufwinid()
3294
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295bufwinnr({expr}) *bufwinnr()*
Bram Moolenaare49fbff2019-08-21 22:50:07 +02003296 Like |bufwinid()| but return the window number instead of the
3297 |window-ID|.
3298 If buffer {expr} doesn't exist or there is no such window, -1
3299 is returned. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300
3301 echo "A window containing buffer 1 is " . (bufwinnr(1))
3302
3303< The number can be used with |CTRL-W_w| and ":wincmd w"
3304 |:wincmd|.
Bram Moolenaare49fbff2019-08-21 22:50:07 +02003305
3306 Can also be used as a |method|: >
3307 FindBuffer()->bufwinnr()
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309byte2line({byte}) *byte2line()*
3310 Return the line number that contains the character at byte
3311 count {byte} in the current buffer. This includes the
3312 end-of-line character, depending on the 'fileformat' option
3313 for the current buffer. The first character has byte count
3314 one.
3315 Also see |line2byte()|, |go| and |:goto|.
Bram Moolenaar64b4d732019-08-22 22:18:17 +02003316
3317 Can also be used as a |method|: >
3318 GetOffset()->byte2line()
3319
3320< {not available when compiled without the |+byte_offset|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 feature}
3322
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00003323byteidx({expr}, {nr}) *byteidx()*
3324 Return byte index of the {nr}'th character in the string
3325 {expr}. Use zero for the first character, it returns zero.
3326 This function is only useful when there are multibyte
3327 characters, otherwise the returned value is equal to {nr}.
Bram Moolenaar0ffbbf92013-11-02 23:29:26 +01003328 Composing characters are not counted separately, their byte
3329 length is added to the preceding base character. See
3330 |byteidxcomp()| below for counting composing characters
3331 separately.
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00003332 Example : >
3333 echo matchstr(str, ".", byteidx(str, 3))
3334< will display the fourth character. Another way to do the
3335 same: >
3336 let s = strpart(str, byteidx(str, 3))
3337 echo strpart(s, 0, byteidx(s, 1))
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02003338< Also see |strgetchar()| and |strcharpart()|.
3339
3340 If there are less than {nr} characters -1 is returned.
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00003341 If there are exactly {nr} characters the length of the string
Bram Moolenaar0ffbbf92013-11-02 23:29:26 +01003342 in bytes is returned.
3343
Bram Moolenaar64b4d732019-08-22 22:18:17 +02003344 Can also be used as a |method|: >
3345 GetName()->byteidx(idx)
3346
Bram Moolenaar0ffbbf92013-11-02 23:29:26 +01003347byteidxcomp({expr}, {nr}) *byteidxcomp()*
3348 Like byteidx(), except that a composing character is counted
3349 as a separate character. Example: >
3350 let s = 'e' . nr2char(0x301)
3351 echo byteidx(s, 1)
3352 echo byteidxcomp(s, 1)
3353 echo byteidxcomp(s, 2)
3354< The first and third echo result in 3 ('e' plus composing
3355 character is 3 bytes), the second echo results in 1 ('e' is
3356 one byte).
3357 Only works different from byteidx() when 'encoding' is set to
3358 a Unicode encoding.
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00003359
Bram Moolenaar64b4d732019-08-22 22:18:17 +02003360 Can also be used as a |method|: >
3361 GetName()->byteidxcomp(idx)
3362
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003363call({func}, {arglist} [, {dict}]) *call()* *E699*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003364 Call function {func} with the items in |List| {arglist} as
Bram Moolenaarde8866b2005-01-06 23:24:37 +00003365 arguments.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003366 {func} can either be a |Funcref| or the name of a function.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00003367 a:firstline and a:lastline are set to the cursor line.
3368 Returns the return value of the called function.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003369 {dict} is for functions with the "dict" attribute. It will be
3370 used to set the local variable "self". |Dictionary-function|
Bram Moolenaarde8866b2005-01-06 23:24:37 +00003371
Bram Moolenaar64b4d732019-08-22 22:18:17 +02003372 Can also be used as a |method|: >
3373 GetFunc()->call([arg, arg], dict)
3374
Bram Moolenaar446cb832008-06-24 21:56:24 +00003375ceil({expr}) *ceil()*
3376 Return the smallest integral value greater than or equal to
3377 {expr} as a |Float| (round up).
3378 {expr} must evaluate to a |Float| or a |Number|.
3379 Examples: >
3380 echo ceil(1.456)
3381< 2.0 >
3382 echo ceil(-5.456)
3383< -5.0 >
3384 echo ceil(4.0)
3385< 4.0
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02003386
3387 Can also be used as a |method|: >
3388 Compute()->ceil()
3389<
Bram Moolenaar446cb832008-06-24 21:56:24 +00003390 {only available when compiled with the |+float| feature}
3391
Bram Moolenaar4b785f62016-11-29 21:54:44 +01003392
Bram Moolenaared997ad2019-07-21 16:42:00 +02003393ch_ functions are documented here: |channel-functions-details|
Bram Moolenaar82b9ca02017-08-08 23:06:46 +02003394
Bram Moolenaar328da0d2016-03-04 22:22:32 +01003395
Bram Moolenaar214641f2017-03-05 17:04:09 +01003396changenr() *changenr()*
3397 Return the number of the most recent change. This is the same
3398 number as what is displayed with |:undolist| and can be used
3399 with the |:undo| command.
3400 When a change was made it is the number of that change. After
3401 redo it is the number of the redone change. After undo it is
3402 one less than the number of the undone change.
3403
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003404char2nr({expr} [, {utf8}]) *char2nr()*
Bram Moolenaar214641f2017-03-05 17:04:09 +01003405 Return number value of the first char in {expr}. Examples: >
3406 char2nr(" ") returns 32
3407 char2nr("ABC") returns 65
3408< When {utf8} is omitted or zero, the current 'encoding' is used.
3409 Example for "utf-8": >
Bram Moolenaar98ef2332018-03-18 14:44:37 +01003410 char2nr("á") returns 225
3411 char2nr("á"[0]) returns 195
Bram Moolenaar214641f2017-03-05 17:04:09 +01003412< With {utf8} set to 1, always treat as utf-8 characters.
3413 A combining character is a separate character.
3414 |nr2char()| does the opposite.
Bram Moolenaaraff74912019-03-30 18:11:49 +01003415 To turn a string into a list of character numbers: >
3416 let str = "ABC"
3417 let list = map(split(str, '\zs'), {_, val -> char2nr(val)})
3418< Result: [65, 66, 67]
Bram Moolenaar214641f2017-03-05 17:04:09 +01003419
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003420 Can also be used as a |method|: >
3421 GetChar()->char2nr()
3422
Bram Moolenaar1063f3d2019-05-07 22:06:52 +02003423chdir({dir}) *chdir()*
3424 Change the current working directory to {dir}. The scope of
3425 the directory change depends on the directory of the current
3426 window:
3427 - If the current window has a window-local directory
3428 (|:lcd|), then changes the window local directory.
3429 - Otherwise, if the current tabpage has a local
3430 directory (|:tcd|) then changes the tabpage local
3431 directory.
3432 - Otherwise, changes the global directory.
3433 If successful, returns the previous working directory. Pass
3434 this to another chdir() to restore the directory.
3435 On failure, returns an empty string.
3436
3437 Example: >
3438 let save_dir = chdir(newdir)
Bram Moolenaar68e65602019-05-26 21:33:31 +02003439 if save_dir != ""
Bram Moolenaar1063f3d2019-05-07 22:06:52 +02003440 " ... do some work
3441 call chdir(save_dir)
3442 endif
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003443
3444< Can also be used as a |method|: >
3445 GetDir()->chdir()
Bram Moolenaar1063f3d2019-05-07 22:06:52 +02003446<
Bram Moolenaar214641f2017-03-05 17:04:09 +01003447cindent({lnum}) *cindent()*
3448 Get the amount of indent for line {lnum} according the C
3449 indenting rules, as with 'cindent'.
3450 The indent is counted in spaces, the value of 'tabstop' is
3451 relevant. {lnum} is used just like in |getline()|.
3452 When {lnum} is invalid or Vim was not compiled the |+cindent|
3453 feature, -1 is returned.
3454 See |C-indenting|.
3455
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003456 Can also be used as a |method|: >
3457 GetLnum()->cindent()
3458
Bram Moolenaaraff74912019-03-30 18:11:49 +01003459clearmatches([{win}]) *clearmatches()*
Bram Moolenaarfd133322019-03-29 12:20:27 +01003460 Clears all matches previously defined for the current window
3461 by |matchadd()| and the |:match| commands.
Bram Moolenaaraff74912019-03-30 18:11:49 +01003462 If {win} is specified, use the window with this number or
3463 window ID instead of the current window.
Bram Moolenaar214641f2017-03-05 17:04:09 +01003464
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003465 Can also be used as a |method|: >
3466 GetWin()->clearmatches()
3467<
Bram Moolenaar214641f2017-03-05 17:04:09 +01003468 *col()*
3469col({expr}) The result is a Number, which is the byte index of the column
3470 position given with {expr}. The accepted positions are:
3471 . the cursor position
3472 $ the end of the cursor line (the result is the
3473 number of bytes in the cursor line plus one)
3474 'x position of mark x (if the mark is not set, 0 is
3475 returned)
3476 v In Visual mode: the start of the Visual area (the
3477 cursor is the end). When not in Visual mode
3478 returns the cursor position. Differs from |'<| in
3479 that it's updated right away.
3480 Additionally {expr} can be [lnum, col]: a |List| with the line
3481 and column number. Most useful when the column is "$", to get
3482 the last column of a specific line. When "lnum" or "col" is
3483 out of range then col() returns zero.
3484 To get the line number use |line()|. To get both use
3485 |getpos()|.
3486 For the screen column position use |virtcol()|.
3487 Note that only marks in the current file can be used.
3488 Examples: >
3489 col(".") column of cursor
3490 col("$") length of cursor line plus one
3491 col("'t") column of mark t
3492 col("'" . markname) column of mark markname
3493< The first column is 1. 0 is returned for an error.
3494 For an uppercase mark the column may actually be in another
3495 buffer.
3496 For the cursor position, when 'virtualedit' is active, the
3497 column is one higher if the cursor is after the end of the
3498 line. This can be used to obtain the column in Insert mode: >
3499 :imap <F2> <C-O>:let save_ve = &ve<CR>
3500 \<C-O>:set ve=all<CR>
3501 \<C-O>:echo col(".") . "\n" <Bar>
3502 \let &ve = save_ve<CR>
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003503
3504< Can also be used as a |method|: >
3505 GetPos()->col()
Bram Moolenaar214641f2017-03-05 17:04:09 +01003506<
3507
3508complete({startcol}, {matches}) *complete()* *E785*
3509 Set the matches for Insert mode completion.
3510 Can only be used in Insert mode. You need to use a mapping
3511 with CTRL-R = (see |i_CTRL-R|). It does not work after CTRL-O
3512 or with an expression mapping.
3513 {startcol} is the byte offset in the line where the completed
3514 text start. The text up to the cursor is the original text
3515 that will be replaced by the matches. Use col('.') for an
3516 empty string. "col('.') - 1" will replace one character by a
3517 match.
3518 {matches} must be a |List|. Each |List| item is one match.
3519 See |complete-items| for the kind of items that are possible.
3520 Note that the after calling this function you need to avoid
3521 inserting anything that would cause completion to stop.
3522 The match can be selected with CTRL-N and CTRL-P as usual with
3523 Insert mode completion. The popup menu will appear if
3524 specified, see |ins-completion-menu|.
3525 Example: >
3526 inoremap <F5> <C-R>=ListMonths()<CR>
3527
3528 func! ListMonths()
3529 call complete(col('.'), ['January', 'February', 'March',
3530 \ 'April', 'May', 'June', 'July', 'August', 'September',
3531 \ 'October', 'November', 'December'])
3532 return ''
3533 endfunc
3534< This isn't very useful, but it shows how it works. Note that
3535 an empty string is returned to avoid a zero being inserted.
3536
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003537 Can also be used as a |method|, the second argument is passed
3538 in: >
3539 GetMatches()->complete(col('.'))
3540
Bram Moolenaar214641f2017-03-05 17:04:09 +01003541complete_add({expr}) *complete_add()*
3542 Add {expr} to the list of matches. Only to be used by the
3543 function specified with the 'completefunc' option.
3544 Returns 0 for failure (empty string or out of memory),
3545 1 when the match was added, 2 when the match was already in
3546 the list.
3547 See |complete-functions| for an explanation of {expr}. It is
3548 the same as one item in the list that 'omnifunc' would return.
3549
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003550 Can also be used as a |method|: >
3551 GetMoreMatches()->complete_add()
3552
Bram Moolenaar214641f2017-03-05 17:04:09 +01003553complete_check() *complete_check()*
3554 Check for a key typed while looking for completion matches.
3555 This is to be used when looking for matches takes some time.
3556 Returns |TRUE| when searching for matches is to be aborted,
3557 zero otherwise.
3558 Only to be used by the function specified with the
3559 'completefunc' option.
3560
Bram Moolenaarfd133322019-03-29 12:20:27 +01003561 *complete_info()*
3562complete_info([{what}])
3563 Returns a Dictionary with information about Insert mode
3564 completion. See |ins-completion|.
3565 The items are:
3566 mode Current completion mode name string.
Bram Moolenaar723dd942019-04-04 13:11:03 +02003567 See |complete_info_mode| for the values.
Bram Moolenaarfd133322019-03-29 12:20:27 +01003568 pum_visible |TRUE| if popup menu is visible.
3569 See |pumvisible()|.
3570 items List of completion matches. Each item is a
3571 dictionary containing the entries "word",
3572 "abbr", "menu", "kind", "info" and "user_data".
3573 See |complete-items|.
3574 selected Selected item index. First index is zero.
3575 Index is -1 if no item is selected (showing
3576 typed text only)
3577 inserted Inserted string. [NOT IMPLEMENT YET]
3578
3579 *complete_info_mode*
3580 mode values are:
3581 "" Not in completion mode
3582 "keyword" Keyword completion |i_CTRL-X_CTRL-N|
3583 "ctrl_x" Just pressed CTRL-X |i_CTRL-X|
3584 "whole_line" Whole lines |i_CTRL-X_CTRL-L|
3585 "files" File names |i_CTRL-X_CTRL-F|
3586 "tags" Tags |i_CTRL-X_CTRL-]|
3587 "path_defines" Definition completion |i_CTRL-X_CTRL-D|
3588 "path_patterns" Include completion |i_CTRL-X_CTRL-I|
3589 "dictionary" Dictionary |i_CTRL-X_CTRL-K|
3590 "thesaurus" Thesaurus |i_CTRL-X_CTRL-T|
3591 "cmdline" Vim Command line |i_CTRL-X_CTRL-V|
3592 "function" User defined completion |i_CTRL-X_CTRL-U|
3593 "omni" Omni completion |i_CTRL-X_CTRL-O|
3594 "spell" Spelling suggestions |i_CTRL-X_s|
3595 "eval" |complete()| completion
3596 "unknown" Other internal modes
3597
3598 If the optional {what} list argument is supplied, then only
3599 the items listed in {what} are returned. Unsupported items in
3600 {what} are silently ignored.
3601
Bram Moolenaare9bd5722019-08-17 19:36:06 +02003602 To get the position and size of the popup menu, see
3603 |pum_getpos()|. It's also available in |v:event| during the
3604 |CompleteChanged| event.
3605
Bram Moolenaarfd133322019-03-29 12:20:27 +01003606 Examples: >
3607 " Get all items
3608 call complete_info()
3609 " Get only 'mode'
3610 call complete_info(['mode'])
3611 " Get only 'mode' and 'pum_visible'
3612 call complete_info(['mode', 'pum_visible'])
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003613
3614< Can also be used as a |method|: >
3615 GetItems()->complete_info()
Bram Moolenaarfd133322019-03-29 12:20:27 +01003616<
Bram Moolenaar214641f2017-03-05 17:04:09 +01003617 *confirm()*
3618confirm({msg} [, {choices} [, {default} [, {type}]]])
Bram Moolenaar647e24b2019-03-17 16:39:46 +01003619 confirm() offers the user a dialog, from which a choice can be
Bram Moolenaar214641f2017-03-05 17:04:09 +01003620 made. It returns the number of the choice. For the first
3621 choice this is 1.
3622 Note: confirm() is only supported when compiled with dialog
3623 support, see |+dialog_con| and |+dialog_gui|.
3624
3625 {msg} is displayed in a |dialog| with {choices} as the
3626 alternatives. When {choices} is missing or empty, "&OK" is
3627 used (and translated).
3628 {msg} is a String, use '\n' to include a newline. Only on
3629 some systems the string is wrapped when it doesn't fit.
3630
3631 {choices} is a String, with the individual choices separated
3632 by '\n', e.g. >
3633 confirm("Save changes?", "&Yes\n&No\n&Cancel")
3634< The letter after the '&' is the shortcut key for that choice.
3635 Thus you can type 'c' to select "Cancel". The shortcut does
3636 not need to be the first letter: >
3637 confirm("file has been modified", "&Save\nSave &All")
3638< For the console, the first letter of each choice is used as
3639 the default shortcut key.
3640
3641 The optional {default} argument is the number of the choice
3642 that is made if the user hits <CR>. Use 1 to make the first
3643 choice the default one. Use 0 to not set a default. If
3644 {default} is omitted, 1 is used.
3645
3646 The optional {type} argument gives the type of dialog. This
3647 is only used for the icon of the GTK, Mac, Motif and Win32
3648 GUI. It can be one of these values: "Error", "Question",
3649 "Info", "Warning" or "Generic". Only the first character is
3650 relevant. When {type} is omitted, "Generic" is used.
3651
3652 If the user aborts the dialog by pressing <Esc>, CTRL-C,
3653 or another valid interrupt key, confirm() returns 0.
3654
3655 An example: >
3656 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2)
3657 :if choice == 0
3658 : echo "make up your mind!"
3659 :elseif choice == 3
3660 : echo "tasteful"
3661 :else
3662 : echo "I prefer bananas myself."
3663 :endif
3664< In a GUI dialog, buttons are used. The layout of the buttons
3665 depends on the 'v' flag in 'guioptions'. If it is included,
3666 the buttons are always put vertically. Otherwise, confirm()
3667 tries to put the buttons in one horizontal line. If they
3668 don't fit, a vertical layout is used anyway. For some systems
3669 the horizontal layout is always used.
3670
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003671 Can also be used as a |method|in: >
3672 BuildMessage()->confirm("&Yes\n&No")
3673
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00003674 *copy()*
Bram Moolenaar58b85342016-08-14 19:54:54 +02003675copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00003676 different from using {expr} directly.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003677 When {expr} is a |List| a shallow copy is created. This means
3678 that the original |List| can be changed without changing the
Bram Moolenaar446cb832008-06-24 21:56:24 +00003679 copy, and vice versa. But the items are identical, thus
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01003680 changing an item changes the contents of both |Lists|.
3681 A |Dictionary| is copied in a similar way as a |List|.
3682 Also see |deepcopy()|.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003683 Can also be used as a |method|: >
3684 mylist->copy()
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00003685
Bram Moolenaar446cb832008-06-24 21:56:24 +00003686cos({expr}) *cos()*
3687 Return the cosine of {expr}, measured in radians, as a |Float|.
3688 {expr} must evaluate to a |Float| or a |Number|.
3689 Examples: >
3690 :echo cos(100)
3691< 0.862319 >
3692 :echo cos(-4.01)
3693< -0.646043
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02003694
3695 Can also be used as a |method|: >
3696 Compute()->cos()
3697<
Bram Moolenaar446cb832008-06-24 21:56:24 +00003698 {only available when compiled with the |+float| feature}
3699
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003700
3701cosh({expr}) *cosh()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003702 Return the hyperbolic cosine of {expr} as a |Float| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003703 [1, inf].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003704 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003705 Examples: >
3706 :echo cosh(0.5)
3707< 1.127626 >
3708 :echo cosh(-0.5)
3709< -1.127626
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02003710
3711 Can also be used as a |method|: >
3712 Compute()->cosh()
3713<
Bram Moolenaardb84e452010-08-15 13:50:43 +02003714 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02003715
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003716
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003717count({comp}, {expr} [, {ic} [, {start}]]) *count()*
Bram Moolenaarde8866b2005-01-06 23:24:37 +00003718 Return the number of times an item with value {expr} appears
Bram Moolenaar9966b212017-07-28 16:46:57 +02003719 in |String|, |List| or |Dictionary| {comp}.
3720
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00003721 If {start} is given then start with the item with this index.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003722 {start} can only be used with a |List|.
Bram Moolenaar9966b212017-07-28 16:46:57 +02003723
Bram Moolenaare381d3d2016-07-07 14:50:41 +02003724 When {ic} is given and it's |TRUE| then case is ignored.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00003725
Bram Moolenaar9966b212017-07-28 16:46:57 +02003726 When {comp} is a string then the number of not overlapping
Bram Moolenaar338e47f2017-12-19 11:55:26 +01003727 occurrences of {expr} is returned. Zero is returned when
3728 {expr} is an empty string.
Bram Moolenaara74e4942019-08-04 17:35:53 +02003729
Bram Moolenaarac92e252019-08-03 21:58:38 +02003730 Can also be used as a |method|: >
3731 mylist->count(val)
Bram Moolenaara74e4942019-08-04 17:35:53 +02003732<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 *cscope_connection()*
3734cscope_connection([{num} , {dbpath} [, {prepend}]])
3735 Checks for the existence of a |cscope| connection. If no
3736 parameters are specified, then the function returns:
3737 0, if cscope was not available (not compiled in), or
3738 if there are no cscope connections;
3739 1, if there is at least one cscope connection.
3740
3741 If parameters are specified, then the value of {num}
3742 determines how existence of a cscope connection is checked:
3743
3744 {num} Description of existence check
3745 ----- ------------------------------
3746 0 Same as no parameters (e.g., "cscope_connection()").
3747 1 Ignore {prepend}, and use partial string matches for
3748 {dbpath}.
3749 2 Ignore {prepend}, and use exact string matches for
3750 {dbpath}.
3751 3 Use {prepend}, use partial string matches for both
3752 {dbpath} and {prepend}.
3753 4 Use {prepend}, use exact string matches for both
3754 {dbpath} and {prepend}.
3755
3756 Note: All string comparisons are case sensitive!
3757
3758 Examples. Suppose we had the following (from ":cs show"): >
3759
3760 # pid database name prepend path
3761 0 27664 cscope.out /usr/local
3762<
3763 Invocation Return Val ~
3764 ---------- ---------- >
3765 cscope_connection() 1
3766 cscope_connection(1, "out") 1
3767 cscope_connection(2, "out") 0
3768 cscope_connection(3, "out") 0
3769 cscope_connection(3, "out", "local") 1
3770 cscope_connection(4, "out") 0
3771 cscope_connection(4, "out", "local") 0
3772 cscope_connection(4, "cscope.out", "/usr/local") 1
3773<
Bram Moolenaar0b238792006-03-02 22:49:12 +00003774cursor({lnum}, {col} [, {off}]) *cursor()*
3775cursor({list})
Bram Moolenaaref2f6562007-05-06 13:32:59 +00003776 Positions the cursor at the column (byte count) {col} in the
3777 line {lnum}. The first column is one.
Bram Moolenaar493c1782014-05-28 14:34:46 +02003778
Bram Moolenaar0b238792006-03-02 22:49:12 +00003779 When there is one argument {list} this is used as a |List|
Bram Moolenaar493c1782014-05-28 14:34:46 +02003780 with two, three or four item:
Bram Moolenaar03413f42016-04-12 21:07:15 +02003781 [{lnum}, {col}]
Bram Moolenaar493c1782014-05-28 14:34:46 +02003782 [{lnum}, {col}, {off}]
3783 [{lnum}, {col}, {off}, {curswant}]
Bram Moolenaar946e27a2014-06-25 18:50:27 +02003784 This is like the return value of |getpos()| or |getcurpos()|,
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02003785 but without the first item.
Bram Moolenaar493c1782014-05-28 14:34:46 +02003786
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 Does not change the jumplist.
3788 If {lnum} is greater than the number of lines in the buffer,
3789 the cursor will be positioned at the last line in the buffer.
3790 If {lnum} is zero, the cursor will stay in the current line.
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00003791 If {col} is greater than the number of bytes in the line,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 the cursor will be positioned at the last character in the
3793 line.
3794 If {col} is zero, the cursor will stay in the current column.
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02003795 If {curswant} is given it is used to set the preferred column
Bram Moolenaar34401cc2014-08-29 15:12:19 +02003796 for vertical movement. Otherwise {col} is used.
Bram Moolenaar2f3b5102014-11-19 18:54:17 +01003797
Bram Moolenaar0b238792006-03-02 22:49:12 +00003798 When 'virtualedit' is used {off} specifies the offset in
3799 screen columns from the start of the character. E.g., a
Bram Moolenaard46bbc72007-05-12 14:38:41 +00003800 position within a <Tab> or after the last character.
Bram Moolenaar798b30b2009-04-22 10:56:16 +00003801 Returns 0 when the position could be set, -1 otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003803 Can also be used as a |method|: >
3804 GetCursorPos()->cursor()
3805
Bram Moolenaar4551c0a2018-06-20 22:38:21 +02003806debugbreak({pid}) *debugbreak()*
3807 Specifically used to interrupt a program being debugged. It
3808 will cause process {pid} to get a SIGTRAP. Behavior for other
3809 processes is undefined. See |terminal-debugger|.
3810 {only available on MS-Windows}
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00003811
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003812 Can also be used as a |method|: >
3813 GetPid()->debugbreak()
3814
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003815deepcopy({expr} [, {noref}]) *deepcopy()* *E698*
Bram Moolenaar58b85342016-08-14 19:54:54 +02003816 Make a copy of {expr}. For Numbers and Strings this isn't
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00003817 different from using {expr} directly.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003818 When {expr} is a |List| a full copy is created. This means
3819 that the original |List| can be changed without changing the
Bram Moolenaar6463ca22016-02-13 17:04:46 +01003820 copy, and vice versa. When an item is a |List| or
3821 |Dictionary|, a copy for it is made, recursively. Thus
3822 changing an item in the copy does not change the contents of
3823 the original |List|.
3824 A |Dictionary| is copied in a similar way as a |List|.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003825 When {noref} is omitted or zero a contained |List| or
3826 |Dictionary| is only copied once. All references point to
3827 this single copy. With {noref} set to 1 every occurrence of a
3828 |List| or |Dictionary| results in a new copy. This also means
3829 that a cyclic reference causes deepcopy() to fail.
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00003830 *E724*
3831 Nesting is possible up to 100 levels. When there is an item
Bram Moolenaar4399ef42005-02-12 14:29:27 +00003832 that refers back to a higher level making a deep copy with
3833 {noref} set to 1 will fail.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00003834 Also see |copy()|.
3835
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003836 Can also be used as a |method|: >
3837 GetObject()->deepcopy()
3838
Bram Moolenaarda440d22016-01-16 21:27:23 +01003839delete({fname} [, {flags}]) *delete()*
3840 Without {flags} or with {flags} empty: Deletes the file by the
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003841 name {fname}. This also works when {fname} is a symbolic link.
Bram Moolenaarda440d22016-01-16 21:27:23 +01003842
3843 When {flags} is "d": Deletes the directory by the name
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003844 {fname}. This fails when directory {fname} is not empty.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003845
Bram Moolenaarda440d22016-01-16 21:27:23 +01003846 When {flags} is "rf": Deletes the directory by the name
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003847 {fname} and everything in it, recursively. BE CAREFUL!
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003848 Note: on MS-Windows it is not possible to delete a directory
3849 that is being used.
Bram Moolenaar818078d2016-08-27 21:58:42 +02003850
Bram Moolenaar43a34f92016-01-17 15:56:34 +01003851 A symbolic link itself is deleted, not what it points to.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003852
Bram Moolenaarda440d22016-01-16 21:27:23 +01003853 The result is a Number, which is 0 if the delete operation was
3854 successful and -1 when the deletion failed or partly failed.
3855
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003856 Use |remove()| to delete an item from a |List|.
Bram Moolenaard79a2622018-06-07 18:17:46 +02003857 To delete a line from the buffer use |:delete| or
3858 |deletebufline()|.
3859
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003860 Can also be used as a |method|: >
3861 GetName()->delete()
3862
Bram Moolenaard473c8c2018-08-11 18:00:22 +02003863deletebufline({expr}, {first} [, {last}]) *deletebufline()*
Bram Moolenaard79a2622018-06-07 18:17:46 +02003864 Delete lines {first} to {last} (inclusive) from buffer {expr}.
3865 If {last} is omitted then delete line {first} only.
3866 On success 0 is returned, on failure 1 is returned.
3867
3868 For the use of {expr}, see |bufname()| above.
3869
Bram Moolenaar95bafa22018-10-02 13:26:25 +02003870 {first} and {last} are used like with |getline()|. Note that
Bram Moolenaard79a2622018-06-07 18:17:46 +02003871 when using |line()| this refers to the current buffer. Use "$"
3872 to refer to the last line in buffer {expr}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003874 Can also be used as a |method|: >
3875 GetBuffer()->deletebufline(1)
3876
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 *did_filetype()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02003878did_filetype() Returns |TRUE| when autocommands are being executed and the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 FileType event has been triggered at least once. Can be used
3880 to avoid triggering the FileType event again in the scripts
3881 that detect the file type. |FileType|
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02003882 Returns |FALSE| when `:setf FALLBACK` was used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 When editing another file, the counter is reset, thus this
3884 really checks if the FileType event has been triggered for the
3885 current buffer. This allows an autocommand that starts
3886 editing another buffer to set 'filetype' and load a syntax
3887 file.
3888
Bram Moolenaar47136d72004-10-12 20:02:24 +00003889diff_filler({lnum}) *diff_filler()*
3890 Returns the number of filler lines above line {lnum}.
3891 These are the lines that were inserted at this point in
3892 another diff'ed window. These filler lines are shown in the
3893 display but don't exist in the buffer.
3894 {lnum} is used like with |getline()|. Thus "." is the current
3895 line, "'m" mark m, etc.
3896 Returns 0 if the current window is not in diff mode.
3897
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003898 Can also be used as a |method|: >
3899 GetLnum()->diff_filler()
3900
Bram Moolenaar47136d72004-10-12 20:02:24 +00003901diff_hlID({lnum}, {col}) *diff_hlID()*
3902 Returns the highlight ID for diff mode at line {lnum} column
3903 {col} (byte index). When the current line does not have a
3904 diff change zero is returned.
3905 {lnum} is used like with |getline()|. Thus "." is the current
3906 line, "'m" mark m, etc.
3907 {col} is 1 for the leftmost column, {lnum} is 1 for the first
3908 line.
3909 The highlight ID can be used with |synIDattr()| to obtain
3910 syntax information about the highlighting.
3911
Bram Moolenaar1a3a8912019-08-23 22:31:37 +02003912 Can also be used as a |method|: >
3913 GetLnum()->diff_hlID(col)
Bram Moolenaar691ddee2019-05-09 14:52:41 +02003914environ() *environ()*
3915 Return all of environment variables as dictionary. You can
3916 check if an environment variable exists like this: >
3917 :echo has_key(environ(), 'HOME')
3918< Note that the variable name may be CamelCase; to ignore case
3919 use this: >
3920 :echo index(keys(environ()), 'HOME', 0, 1) != -1
3921
Bram Moolenaar13065c42005-01-08 16:08:21 +00003922empty({expr}) *empty()*
3923 Return the Number 1 if {expr} is empty, zero otherwise.
Bram Moolenaar835dc632016-02-07 14:27:38 +01003924 - A |List| or |Dictionary| is empty when it does not have any
3925 items.
Bram Moolenaard8968242019-01-15 22:51:57 +01003926 - A |String| is empty when its length is zero.
3927 - A |Number| and |Float| are empty when their value is zero.
Bram Moolenaar835dc632016-02-07 14:27:38 +01003928 - |v:false|, |v:none| and |v:null| are empty, |v:true| is not.
Bram Moolenaard8968242019-01-15 22:51:57 +01003929 - A |Job| is empty when it failed to start.
3930 - A |Channel| is empty when it is closed.
Bram Moolenaard09091d2019-01-17 16:07:22 +01003931 - A |Blob| is empty when its length is zero.
Bram Moolenaar835dc632016-02-07 14:27:38 +01003932
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003933 For a long |List| this is much faster than comparing the
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003934 length with zero.
Bram Moolenaara4208962019-08-24 20:50:19 +02003935
Bram Moolenaarac92e252019-08-03 21:58:38 +02003936 Can also be used as a |method|: >
3937 mylist->empty()
Bram Moolenaar13065c42005-01-08 16:08:21 +00003938
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939escape({string}, {chars}) *escape()*
3940 Escape the characters in {chars} that occur in {string} with a
3941 backslash. Example: >
3942 :echo escape('c:\program files\vim', ' \')
3943< results in: >
3944 c:\\program\ files\\vim
Bram Moolenaarb4d5fba2017-09-11 19:31:28 +02003945< Also see |shellescape()| and |fnameescape()|.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00003946
Bram Moolenaara4208962019-08-24 20:50:19 +02003947 Can also be used as a |method|: >
3948 GetText()->escape(' \')
3949<
Bram Moolenaar446cb832008-06-24 21:56:24 +00003950 *eval()*
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00003951eval({string}) Evaluate {string} and return the result. Especially useful to
3952 turn the result of |string()| back into the original value.
Bram Moolenaar0d17f0d2019-01-22 22:20:38 +01003953 This works for Numbers, Floats, Strings, Blobs and composites
3954 of them. Also works for |Funcref|s that refer to existing
Bram Moolenaar446cb832008-06-24 21:56:24 +00003955 functions.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00003956
Bram Moolenaar25e42232019-08-04 15:04:10 +02003957 Can also be used as a |method|: >
3958 argv->join()->eval()
3959
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960eventhandler() *eventhandler()*
3961 Returns 1 when inside an event handler. That is that Vim got
3962 interrupted while waiting for the user to type a character,
3963 e.g., when dropping a file on Vim. This means interactive
3964 commands cannot be used. Otherwise zero is returned.
3965
3966executable({expr}) *executable()*
3967 This function checks if an executable with the name {expr}
3968 exists. {expr} must be the name of the program without any
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003969 arguments.
3970 executable() uses the value of $PATH and/or the normal
3971 searchpath for programs. *PATHEXT*
3972 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can
3973 optionally be included. Then the extensions in $PATHEXT are
Bram Moolenaar58b85342016-08-14 19:54:54 +02003974 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be
3975 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003976 used. A dot by itself can be used in $PATHEXT to try using
Bram Moolenaar58b85342016-08-14 19:54:54 +02003977 the name without an extension. When 'shell' looks like a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003978 Unix shell, then the name is also tried without adding an
3979 extension.
3980 On MS-DOS and MS-Windows it only checks if the file exists and
3981 is not a directory, not if it's really executable.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003982 On MS-Windows an executable in the same directory as Vim is
3983 always found. Since this directory is added to $PATH it
3984 should also work to execute it |win32-PATH|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 The result is a Number:
3986 1 exists
3987 0 does not exist
3988 -1 not implemented on this system
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02003989 |exepath()| can be used to get the full path of an executable.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990
Bram Moolenaara4208962019-08-24 20:50:19 +02003991 Can also be used as a |method|: >
3992 GetCommand()->executable()
3993
Bram Moolenaar79815f12016-07-09 17:07:29 +02003994execute({command} [, {silent}]) *execute()*
3995 Execute an Ex command or commands and return the output as a
3996 string.
3997 {command} can be a string or a List. In case of a List the
3998 lines are executed one by one.
3999 This is equivalent to: >
4000 redir => var
4001 {command}
4002 redir END
4003<
4004 The optional {silent} argument can have these values:
4005 "" no `:silent` used
4006 "silent" `:silent` used
4007 "silent!" `:silent!` used
Bram Moolenaar214641f2017-03-05 17:04:09 +01004008 The default is "silent". Note that with "silent!", unlike
Bram Moolenaar069c1e72016-07-15 21:25:08 +02004009 `:redir`, error messages are dropped. When using an external
4010 command the screen may be messed up, use `system()` instead.
Bram Moolenaar79815f12016-07-09 17:07:29 +02004011 *E930*
4012 It is not possible to use `:redir` anywhere in {command}.
4013
4014 To get a list of lines use |split()| on the result: >
Bram Moolenaar063b9d12016-07-09 20:21:48 +02004015 split(execute('args'), "\n")
Bram Moolenaar79815f12016-07-09 17:07:29 +02004016
Bram Moolenaar868b7b62019-05-29 21:44:40 +02004017< To execute a command in another window than the current one
4018 use `win_execute()`.
4019
4020 When used recursively the output of the recursive call is not
Bram Moolenaar79815f12016-07-09 17:07:29 +02004021 included in the output of the higher level call.
4022
Bram Moolenaara4208962019-08-24 20:50:19 +02004023 Can also be used as a |method|: >
4024 GetCommand()->execute()
4025
Bram Moolenaarc7f02552014-04-01 21:00:59 +02004026exepath({expr}) *exepath()*
4027 If {expr} is an executable and is either an absolute path, a
4028 relative path or found in $PATH, return the full path.
4029 Note that the current directory is used when {expr} starts
4030 with "./", which may be a problem for Vim: >
4031 echo exepath(v:progpath)
Bram Moolenaar7e38ea22014-04-05 22:55:53 +02004032< If {expr} cannot be found in $PATH or is not executable then
Bram Moolenaarc7f02552014-04-01 21:00:59 +02004033 an empty string is returned.
4034
Bram Moolenaara4208962019-08-24 20:50:19 +02004035 Can also be used as a |method|: >
4036 GetCommand()->exepath()
4037
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 *exists()*
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02004039exists({expr}) The result is a Number, which is |TRUE| if {expr} is defined,
4040 zero otherwise.
4041
4042 For checking for a supported feature use |has()|.
4043 For checking if a file exists use |filereadable()|.
4044
4045 The {expr} argument is a string, which contains one of these:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 &option-name Vim option (only checks if it exists,
4047 not if it really works)
4048 +option-name Vim option that works.
4049 $ENVNAME environment variable (could also be
4050 done by comparing with an empty
4051 string)
4052 *funcname built-in function (see |functions|)
4053 or user defined function (see
Bram Moolenaarbcb98982014-05-01 14:08:19 +02004054 |user-functions|). Also works for a
4055 variable that is a Funcref.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 varname internal variable (see
Bram Moolenaar58b85342016-08-14 19:54:54 +02004057 |internal-variables|). Also works
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004058 for |curly-braces-names|, |Dictionary|
4059 entries, |List| items, etc. Beware
Bram Moolenaarc236c162008-07-13 17:41:49 +00004060 that evaluating an index may cause an
4061 error message for an invalid
4062 expression. E.g.: >
4063 :let l = [1, 2, 3]
4064 :echo exists("l[5]")
4065< 0 >
4066 :echo exists("l[xx]")
4067< E121: Undefined variable: xx
4068 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 :cmdname Ex command: built-in command, user
4070 command or command modifier |:command|.
4071 Returns:
4072 1 for match with start of a command
4073 2 full match with a command
4074 3 matches several user commands
4075 To check for a supported command
4076 always check the return value to be 2.
Bram Moolenaar14716812006-05-04 21:54:08 +00004077 :2match The |:2match| command.
4078 :3match The |:3match| command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004079 #event autocommand defined for this event
4080 #event#pattern autocommand defined for this event and
4081 pattern (the pattern is taken
4082 literally and compared to the
4083 autocommand patterns character by
4084 character)
Bram Moolenaara9b1e742005-12-19 22:14:58 +00004085 #group autocommand group exists
4086 #group#event autocommand defined for this group and
4087 event.
4088 #group#event#pattern
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004089 autocommand defined for this group,
Bram Moolenaara9b1e742005-12-19 22:14:58 +00004090 event and pattern.
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +00004091 ##event autocommand for this event is
4092 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093
4094 Examples: >
4095 exists("&shortname")
4096 exists("$HOSTNAME")
4097 exists("*strftime")
4098 exists("*s:MyFunc")
4099 exists("bufcount")
4100 exists(":Make")
Bram Moolenaara9b1e742005-12-19 22:14:58 +00004101 exists("#CursorHold")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 exists("#BufReadPre#*.gz")
Bram Moolenaara9b1e742005-12-19 22:14:58 +00004103 exists("#filetypeindent")
4104 exists("#filetypeindent#FileType")
4105 exists("#filetypeindent#FileType#*")
Bram Moolenaarf4cd3e82005-12-22 22:47:02 +00004106 exists("##ColorScheme")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107< There must be no space between the symbol (&/$/*/#) and the
4108 name.
Bram Moolenaar91170f82006-05-05 21:15:17 +00004109 There must be no extra characters after the name, although in
4110 a few cases this is ignored. That may become more strict in
4111 the future, thus don't count on it!
4112 Working example: >
4113 exists(":make")
4114< NOT working example: >
4115 exists(":make install")
Bram Moolenaar9c102382006-05-03 21:26:49 +00004116
4117< Note that the argument must be a string, not the name of the
4118 variable itself. For example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 exists(bufcount)
4120< This doesn't check for existence of the "bufcount" variable,
Bram Moolenaar06a89a52006-04-29 22:01:03 +00004121 but gets the value of "bufcount", and checks if that exists.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122
Bram Moolenaara4208962019-08-24 20:50:19 +02004123 Can also be used as a |method|: >
4124 Varname()->exists()
4125
Bram Moolenaardb7c6862010-05-21 16:33:48 +02004126exp({expr}) *exp()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004127 Return the exponential of {expr} as a |Float| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02004128 [0, inf].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004129 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02004130 Examples: >
4131 :echo exp(2)
4132< 7.389056 >
4133 :echo exp(-1)
4134< 0.367879
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02004135
4136 Can also be used as a |method|: >
4137 Compute()->exp()
4138<
Bram Moolenaardb84e452010-08-15 13:50:43 +02004139 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02004140
4141
Bram Moolenaar84f72352012-03-11 15:57:40 +01004142expand({expr} [, {nosuf} [, {list}]]) *expand()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 Expand wildcards and the following special keywords in {expr}.
Bram Moolenaar84f72352012-03-11 15:57:40 +01004144 'wildignorecase' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145
Bram Moolenaare381d3d2016-07-07 14:50:41 +02004146 If {list} is given and it is |TRUE|, a List will be returned.
Bram Moolenaar84f72352012-03-11 15:57:40 +01004147 Otherwise the result is a String and when there are several
4148 matches, they are separated by <NL> characters. [Note: in
4149 version 5.0 a space was used, which caused problems when a
4150 file name contains a space]
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151
Bram Moolenaar58b85342016-08-14 19:54:54 +02004152 If the expansion fails, the result is an empty string. A name
Bram Moolenaarec7944a2013-06-12 21:29:15 +02004153 for a non-existing file is not included, unless {expr} does
4154 not start with '%', '#' or '<', see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155
4156 When {expr} starts with '%', '#' or '<', the expansion is done
4157 like for the |cmdline-special| variables with their associated
4158 modifiers. Here is a short overview:
4159
4160 % current file name
4161 # alternate file name
4162 #n alternate file name n
4163 <cfile> file name under the cursor
4164 <afile> autocmd file name
4165 <abuf> autocmd buffer number (as a String!)
4166 <amatch> autocmd matched name
Bram Moolenaara6878372014-03-22 21:02:50 +01004167 <sfile> sourced script file or function name
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004168 <slnum> sourced script line number or function
4169 line number
4170 <sflnum> script file line number, also when in
4171 a function
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 <cword> word under the cursor
4173 <cWORD> WORD under the cursor
4174 <client> the {clientid} of the last received
4175 message |server2client()|
4176 Modifiers:
4177 :p expand to full path
4178 :h head (last path component removed)
4179 :t tail (last path component only)
4180 :r root (one extension removed)
4181 :e extension only
4182
4183 Example: >
4184 :let &tags = expand("%:p:h") . "/tags"
4185< Note that when expanding a string that starts with '%', '#' or
4186 '<', any following text is ignored. This does NOT work: >
4187 :let doesntwork = expand("%:h.bak")
4188< Use this: >
4189 :let doeswork = expand("%:h") . ".bak"
4190< Also note that expanding "<cfile>" and others only returns the
4191 referenced file name without further expansion. If "<cfile>"
4192 is "~/.cshrc", you need to do another expand() to have the
4193 "~/" expanded into the path of the home directory: >
4194 :echo expand(expand("<cfile>"))
4195<
4196 There cannot be white space between the variables and the
4197 following modifier. The |fnamemodify()| function can be used
4198 to modify normal file names.
4199
4200 When using '%' or '#', and the current or alternate file name
4201 is not defined, an empty string is used. Using "%:p" in a
4202 buffer with no name, results in the current directory, with a
4203 '/' added.
4204
4205 When {expr} does not start with '%', '#' or '<', it is
4206 expanded like a file name is expanded on the command line.
4207 'suffixes' and 'wildignore' are used, unless the optional
Bram Moolenaare381d3d2016-07-07 14:50:41 +02004208 {nosuf} argument is given and it is |TRUE|.
Bram Moolenaar146e9c32012-03-07 19:18:23 +01004209 Names for non-existing files are included. The "**" item can
4210 be used to search in a directory tree. For example, to find
4211 all "README" files in the current directory and below: >
Bram Moolenaar02743632005-07-25 20:42:36 +00004212 :echo expand("**/README")
4213<
Bram Moolenaar647e24b2019-03-17 16:39:46 +01004214 expand() can also be used to expand variables and environment
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 variables that are only known in a shell. But this can be
Bram Moolenaar34401cc2014-08-29 15:12:19 +02004216 slow, because a shell may be used to do the expansion. See
4217 |expr-env-expand|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 The expanded variable is still handled like a list of file
Bram Moolenaar58b85342016-08-14 19:54:54 +02004219 names. When an environment variable cannot be expanded, it is
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 left unchanged. Thus ":echo expand('$FOOBAR')" results in
4221 "$FOOBAR".
4222
4223 See |glob()| for finding existing files. See |system()| for
4224 getting the raw output of an external command.
4225
Bram Moolenaara4208962019-08-24 20:50:19 +02004226 Can also be used as a |method|: >
4227 Getpattern()->expand()
4228
Bram Moolenaar80dad482019-06-09 17:22:31 +02004229expandcmd({expr}) *expandcmd()*
4230 Expand special items in {expr} like what is done for an Ex
4231 command such as `:edit`. This expands special keywords, like
4232 with |expand()|, and environment variables, anywhere in
4233 {expr}. Returns the expanded string.
4234 Example: >
4235 :echo expandcmd('make %<.o')
Bram Moolenaara4208962019-08-24 20:50:19 +02004236
4237< Can also be used as a |method|: >
4238 GetCommand()->expandcmd()
Bram Moolenaar80dad482019-06-09 17:22:31 +02004239<
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004240extend({expr1}, {expr2} [, {expr3}]) *extend()*
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004241 {expr1} and {expr2} must be both |Lists| or both
4242 |Dictionaries|.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004243
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004244 If they are |Lists|: Append {expr2} to {expr1}.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004245 If {expr3} is given insert the items of {expr2} before item
4246 {expr3} in {expr1}. When {expr3} is zero insert before the
4247 first item. When {expr3} is equal to len({expr1}) then
4248 {expr2} is appended.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00004249 Examples: >
4250 :echo sort(extend(mylist, [7, 5]))
4251 :call extend(mylist, [2, 3], 1)
Bram Moolenaardc9cf9c2008-08-08 10:36:31 +00004252< When {expr1} is the same List as {expr2} then the number of
4253 items copied is equal to the original length of the List.
4254 E.g., when {expr3} is 1 you get N new copies of the first item
4255 (where N is the original length of the List).
Bram Moolenaar58b85342016-08-14 19:54:54 +02004256 Use |add()| to concatenate one item to a list. To concatenate
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004257 two lists into a new list use the + operator: >
Bram Moolenaarde8866b2005-01-06 23:24:37 +00004258 :let newlist = [1, 2, 3] + [4, 5]
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004259<
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004260 If they are |Dictionaries|:
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004261 Add all entries from {expr2} to {expr1}.
4262 If a key exists in both {expr1} and {expr2} then {expr3} is
4263 used to decide what to do:
4264 {expr3} = "keep": keep the value of {expr1}
4265 {expr3} = "force": use the value of {expr2}
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004266 {expr3} = "error": give an error message *E737*
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004267 When {expr3} is omitted then "force" is assumed.
4268
4269 {expr1} is changed when {expr2} is not empty. If necessary
4270 make a copy of {expr1} first.
4271 {expr2} remains unchanged.
Bram Moolenaarf2571c62015-06-09 19:44:55 +02004272 When {expr1} is locked and {expr2} is not empty the operation
4273 fails.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004274 Returns {expr1}.
4275
Bram Moolenaarac92e252019-08-03 21:58:38 +02004276 Can also be used as a |method|: >
4277 mylist->extend(otherlist)
4278
Bram Moolenaarde8866b2005-01-06 23:24:37 +00004279
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004280feedkeys({string} [, {mode}]) *feedkeys()*
4281 Characters in {string} are queued for processing as if they
Bram Moolenaar0a988df2015-01-27 15:19:24 +01004282 come from a mapping or were typed by the user.
Bram Moolenaarb328cca2019-01-06 16:24:01 +01004283
Bram Moolenaar0a988df2015-01-27 15:19:24 +01004284 By default the string is added to the end of the typeahead
4285 buffer, thus if a mapping is still being executed the
4286 characters come after them. Use the 'i' flag to insert before
4287 other characters, they will be executed next, before any
4288 characters from a mapping.
Bram Moolenaarb328cca2019-01-06 16:24:01 +01004289
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004290 The function does not wait for processing of keys contained in
4291 {string}.
Bram Moolenaarb328cca2019-01-06 16:24:01 +01004292
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004293 To include special keys into {string}, use double-quotes
4294 and "\..." notation |expr-quote|. For example,
Bram Moolenaar79166c42007-05-10 18:29:51 +00004295 feedkeys("\<CR>") simulates pressing of the <Enter> key. But
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004296 feedkeys('\<CR>') pushes 5 characters.
Bram Moolenaarbe0a2592019-05-09 13:50:16 +02004297 A special code that might be useful is <Ignore>, it exits the
4298 wait for a character without doing anything. *<Ignore>*
Bram Moolenaarb328cca2019-01-06 16:24:01 +01004299
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004300 {mode} is a String, which can contain these character flags:
Bram Moolenaarb328cca2019-01-06 16:24:01 +01004301 'm' Remap keys. This is default. If {mode} is absent,
4302 keys are remapped.
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00004303 'n' Do not remap keys.
4304 't' Handle keys as if typed; otherwise they are handled as
4305 if coming from a mapping. This matters for undo,
4306 opening folds, etc.
Bram Moolenaar5e66b422019-01-24 21:58:10 +01004307 'L' Lowlevel input. Only works for Unix or when using the
4308 GUI. Keys are used as if they were coming from the
4309 terminal. Other flags are not used. *E980*
Bram Moolenaar0a988df2015-01-27 15:19:24 +01004310 'i' Insert the string instead of appending (see above).
Bram Moolenaar25281632016-01-21 23:32:32 +01004311 'x' Execute commands until typeahead is empty. This is
4312 similar to using ":normal!". You can call feedkeys()
4313 several times without 'x' and then one time with 'x'
4314 (possibly with an empty {string}) to execute all the
Bram Moolenaar03413f42016-04-12 21:07:15 +02004315 typeahead. Note that when Vim ends in Insert mode it
4316 will behave as if <Esc> is typed, to avoid getting
4317 stuck, waiting for a character to be typed before the
4318 script continues.
Bram Moolenaarb328cca2019-01-06 16:24:01 +01004319 Note that if you manage to call feedkeys() while
Bram Moolenaar5b69c222019-01-11 14:50:06 +01004320 executing commands, thus calling it recursively, then
Bram Moolenaarb328cca2019-01-06 16:24:01 +01004321 all typehead will be consumed by the last call.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004322 '!' When used with 'x' will not end Insert mode. Can be
4323 used in a test when a timer is set to exit Insert mode
4324 a little later. Useful for testing CursorHoldI.
4325
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004326 Return value is always 0.
4327
Bram Moolenaara4208962019-08-24 20:50:19 +02004328 Can also be used as a |method|: >
4329 GetInput()->feedkeys()
4330
Bram Moolenaar071d4272004-06-13 20:20:40 +00004331filereadable({file}) *filereadable()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02004332 The result is a Number, which is |TRUE| when a file with the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 name {file} exists, and can be read. If {file} doesn't exist,
Bram Moolenaare381d3d2016-07-07 14:50:41 +02004334 or is a directory, the result is |FALSE|. {file} is any
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 expression, which is used as a String.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00004336 If you don't care about the file being readable you can use
4337 |glob()|.
Bram Moolenaar25e42232019-08-04 15:04:10 +02004338 {file} is used as-is, you may want to expand wildcards first: >
4339 echo filereadable('~/.vimrc')
4340 0
4341 echo filereadable(expand('~/.vimrc'))
4342 1
Bram Moolenaara4208962019-08-24 20:50:19 +02004343
4344< Can also be used as a |method|: >
4345 GetName()->filereadable()
Bram Moolenaar25e42232019-08-04 15:04:10 +02004346< *file_readable()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347 Obsolete name: file_readable().
4348
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004349
Bram Moolenaaref2f6562007-05-06 13:32:59 +00004350filewritable({file}) *filewritable()*
4351 The result is a Number, which is 1 when a file with the
4352 name {file} exists, and can be written. If {file} doesn't
Bram Moolenaar446cb832008-06-24 21:56:24 +00004353 exist, or is not writable, the result is 0. If {file} is a
Bram Moolenaaref2f6562007-05-06 13:32:59 +00004354 directory, and we can write to it, the result is 2.
4355
Bram Moolenaara4208962019-08-24 20:50:19 +02004356 Can also be used as a |method|: >
4357 GetName()->filewriteable()
4358
Bram Moolenaaref2f6562007-05-06 13:32:59 +00004359
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02004360filter({expr1}, {expr2}) *filter()*
4361 {expr1} must be a |List| or a |Dictionary|.
4362 For each item in {expr1} evaluate {expr2} and when the result
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004363 is zero remove the item from the |List| or |Dictionary|.
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02004364 {expr2} must be a |string| or |Funcref|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004365
Bram Moolenaar50ba5262016-09-22 22:33:02 +02004366 If {expr2} is a |string|, inside {expr2} |v:val| has the value
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02004367 of the current item. For a |Dictionary| |v:key| has the key
Bram Moolenaar50ba5262016-09-22 22:33:02 +02004368 of the current item and for a |List| |v:key| has the index of
4369 the current item.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004370 Examples: >
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02004371 call filter(mylist, 'v:val !~ "OLD"')
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004372< Removes the items where "OLD" appears. >
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02004373 call filter(mydict, 'v:key >= 8')
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004374< Removes the items with a key below 8. >
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02004375 call filter(var, 0)
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004376< Removes all the items, thus clears the |List| or |Dictionary|.
Bram Moolenaard8b02732005-01-14 21:48:43 +00004377
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02004378 Note that {expr2} is the result of expression and is then
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004379 used as an expression again. Often it is good to use a
4380 |literal-string| to avoid having to double backslashes.
4381
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02004382 If {expr2} is a |Funcref| it must take two arguments:
4383 1. the key or the index of the current item.
4384 2. the value of the current item.
Bram Moolenaare381d3d2016-07-07 14:50:41 +02004385 The function must return |TRUE| if the item should be kept.
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02004386 Example that keeps the odd items of a list: >
4387 func Odd(idx, val)
4388 return a:idx % 2 == 1
4389 endfunc
4390 call filter(mylist, function('Odd'))
Bram Moolenaar50ba5262016-09-22 22:33:02 +02004391< It is shorter when using a |lambda|: >
4392 call filter(myList, {idx, val -> idx * val <= 42})
4393< If you do not use "val" you can leave it out: >
4394 call filter(myList, {idx -> idx % 2 == 1})
Bram Moolenaar2ec618c2016-10-01 14:47:05 +02004395<
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004396 The operation is done in-place. If you want a |List| or
4397 |Dictionary| to remain unmodified make a copy first: >
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00004398 :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004399
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02004400< Returns {expr1}, the |List| or |Dictionary| that was filtered.
4401 When an error is encountered while evaluating {expr2} no
4402 further items in {expr1} are processed. When {expr2} is a
4403 Funcref errors inside a function are ignored, unless it was
4404 defined with the "abort" flag.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004405
Bram Moolenaarac92e252019-08-03 21:58:38 +02004406 Can also be used as a |method|: >
4407 mylist->filter(expr2)
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004408
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004409finddir({name} [, {path} [, {count}]]) *finddir()*
Bram Moolenaar5b6b1ca2007-03-27 08:19:43 +00004410 Find directory {name} in {path}. Supports both downwards and
4411 upwards recursive directory searches. See |file-searching|
4412 for the syntax of {path}.
4413 Returns the path of the first found match. When the found
4414 directory is below the current directory a relative path is
4415 returned. Otherwise a full path is returned.
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00004416 If {path} is omitted or empty then 'path' is used.
4417 If the optional {count} is given, find {count}'s occurrence of
Bram Moolenaar433f7c82006-03-21 21:29:36 +00004418 {name} in {path} instead of the first one.
Bram Moolenaar899dddf2006-03-26 21:06:50 +00004419 When {count} is negative return all the matches in a |List|.
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00004420 This is quite similar to the ex-command |:find|.
Bram Moolenaardb84e452010-08-15 13:50:43 +02004421 {only available when compiled with the |+file_in_path|
4422 feature}
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00004423
Bram Moolenaara4208962019-08-24 20:50:19 +02004424 Can also be used as a |method|: >
4425 GetName()->finddir()
4426
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004427findfile({name} [, {path} [, {count}]]) *findfile()*
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00004428 Just like |finddir()|, but find a file instead of a directory.
Bram Moolenaar433f7c82006-03-21 21:29:36 +00004429 Uses 'suffixesadd'.
4430 Example: >
4431 :echo findfile("tags.vim", ".;")
Bram Moolenaaref2f6562007-05-06 13:32:59 +00004432< Searches from the directory of the current file upwards until
4433 it finds the file "tags.vim".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434
Bram Moolenaara4208962019-08-24 20:50:19 +02004435 Can also be used as a |method|: >
4436 GetName()->findfile()
4437
Bram Moolenaar446cb832008-06-24 21:56:24 +00004438float2nr({expr}) *float2nr()*
4439 Convert {expr} to a Number by omitting the part after the
4440 decimal point.
4441 {expr} must evaluate to a |Float| or a Number.
4442 When the value of {expr} is out of range for a |Number| the
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004443 result is truncated to 0x7fffffff or -0x7fffffff (or when
4444 64-bit Number support is enabled, 0x7fffffffffffffff or
Bram Moolenaarb4d5fba2017-09-11 19:31:28 +02004445 -0x7fffffffffffffff). NaN results in -0x80000000 (or when
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004446 64-bit Number support is enabled, -0x8000000000000000).
Bram Moolenaar446cb832008-06-24 21:56:24 +00004447 Examples: >
4448 echo float2nr(3.95)
4449< 3 >
4450 echo float2nr(-23.45)
4451< -23 >
4452 echo float2nr(1.0e100)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004453< 2147483647 (or 9223372036854775807) >
Bram Moolenaar446cb832008-06-24 21:56:24 +00004454 echo float2nr(-1.0e150)
Bram Moolenaar22fcfad2016-07-01 18:17:26 +02004455< -2147483647 (or -9223372036854775807) >
Bram Moolenaar446cb832008-06-24 21:56:24 +00004456 echo float2nr(1.0e-100)
4457< 0
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02004458
4459 Can also be used as a |method|: >
4460 Compute()->float2nr()
4461<
Bram Moolenaar446cb832008-06-24 21:56:24 +00004462 {only available when compiled with the |+float| feature}
4463
4464
4465floor({expr}) *floor()*
4466 Return the largest integral value less than or equal to
4467 {expr} as a |Float| (round down).
4468 {expr} must evaluate to a |Float| or a |Number|.
4469 Examples: >
4470 echo floor(1.856)
4471< 1.0 >
4472 echo floor(-5.456)
4473< -6.0 >
4474 echo floor(4.0)
4475< 4.0
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02004476
4477 Can also be used as a |method|: >
4478 Compute()->floor()
4479<
Bram Moolenaar446cb832008-06-24 21:56:24 +00004480 {only available when compiled with the |+float| feature}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004481
Bram Moolenaardb7c6862010-05-21 16:33:48 +02004482
4483fmod({expr1}, {expr2}) *fmod()*
4484 Return the remainder of {expr1} / {expr2}, even if the
4485 division is not representable. Returns {expr1} - i * {expr2}
4486 for some integer i such that if {expr2} is non-zero, the
4487 result has the same sign as {expr1} and magnitude less than
4488 the magnitude of {expr2}. If {expr2} is zero, the value
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004489 returned is zero. The value returned is a |Float|.
4490 {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02004491 Examples: >
4492 :echo fmod(12.33, 1.22)
4493< 0.13 >
4494 :echo fmod(-12.33, 1.22)
4495< -0.13
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02004496
4497 Can also be used as a |method|: >
4498 Compute()->fmod(1.22)
4499<
Bram Moolenaardb84e452010-08-15 13:50:43 +02004500 {only available when compiled with |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02004501
4502
Bram Moolenaaraebaf892008-05-28 14:49:58 +00004503fnameescape({string}) *fnameescape()*
Bram Moolenaar58b85342016-08-14 19:54:54 +02004504 Escape {string} for use as file name command argument. All
Bram Moolenaaraebaf892008-05-28 14:49:58 +00004505 characters that have a special meaning, such as '%' and '|'
4506 are escaped with a backslash.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004507 For most systems the characters escaped are
4508 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash
4509 appears in a filename, it depends on the value of 'isfname'.
Bram Moolenaar1b24e4b2008-08-08 10:59:17 +00004510 A leading '+' and '>' is also escaped (special after |:edit|
4511 and |:write|). And a "-" by itself (special after |:cd|).
Bram Moolenaaraebaf892008-05-28 14:49:58 +00004512 Example: >
Bram Moolenaar1b24e4b2008-08-08 10:59:17 +00004513 :let fname = '+some str%nge|name'
Bram Moolenaaraebaf892008-05-28 14:49:58 +00004514 :exe "edit " . fnameescape(fname)
4515< results in executing: >
Bram Moolenaar1b24e4b2008-08-08 10:59:17 +00004516 edit \+some\ str\%nge\|name
Bram Moolenaara4208962019-08-24 20:50:19 +02004517<
4518 Can also be used as a |method|: >
4519 GetName()->fnameescape()
Bram Moolenaaraebaf892008-05-28 14:49:58 +00004520
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521fnamemodify({fname}, {mods}) *fnamemodify()*
4522 Modify file name {fname} according to {mods}. {mods} is a
4523 string of characters like it is used for file names on the
4524 command line. See |filename-modifiers|.
4525 Example: >
4526 :echo fnamemodify("main.c", ":p:h")
4527< results in: >
4528 /home/mool/vim/vim/src
Bram Moolenaar446cb832008-06-24 21:56:24 +00004529< Note: Environment variables don't work in {fname}, use
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 |expand()| first then.
4531
Bram Moolenaara4208962019-08-24 20:50:19 +02004532 Can also be used as a |method|: >
4533 GetName()->fnamemodify(':p:h')
4534
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535foldclosed({lnum}) *foldclosed()*
4536 The result is a Number. If the line {lnum} is in a closed
4537 fold, the result is the number of the first line in that fold.
4538 If the line {lnum} is not in a closed fold, -1 is returned.
4539
Bram Moolenaara4208962019-08-24 20:50:19 +02004540 Can also be used as a |method|: >
4541 GetLnum()->foldclosed()
4542
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543foldclosedend({lnum}) *foldclosedend()*
4544 The result is a Number. If the line {lnum} is in a closed
4545 fold, the result is the number of the last line in that fold.
4546 If the line {lnum} is not in a closed fold, -1 is returned.
4547
Bram Moolenaara4208962019-08-24 20:50:19 +02004548 Can also be used as a |method|: >
4549 GetLnum()->foldclosedend()
4550
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551foldlevel({lnum}) *foldlevel()*
4552 The result is a Number, which is the foldlevel of line {lnum}
Bram Moolenaar58b85342016-08-14 19:54:54 +02004553 in the current buffer. For nested folds the deepest level is
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 returned. If there is no fold at line {lnum}, zero is
4555 returned. It doesn't matter if the folds are open or closed.
4556 When used while updating folds (from 'foldexpr') -1 is
4557 returned for lines where folds are still to be updated and the
4558 foldlevel is unknown. As a special case the level of the
4559 previous line is usually available.
4560
Bram Moolenaara4208962019-08-24 20:50:19 +02004561 Can also be used as a |method|: >
4562 GetLnum()->foldlevel()
4563
Bram Moolenaar071d4272004-06-13 20:20:40 +00004564 *foldtext()*
4565foldtext() Returns a String, to be displayed for a closed fold. This is
4566 the default function used for the 'foldtext' option and should
4567 only be called from evaluating 'foldtext'. It uses the
4568 |v:foldstart|, |v:foldend| and |v:folddashes| variables.
4569 The returned string looks like this: >
4570 +-- 45 lines: abcdef
Bram Moolenaar42205552017-03-18 19:42:22 +01004571< The number of leading dashes depends on the foldlevel. The
4572 "45" is the number of lines in the fold. "abcdef" is the text
4573 in the first non-blank line of the fold. Leading white space,
4574 "//" or "/*" and the text from the 'foldmarker' and
4575 'commentstring' options is removed.
4576 When used to draw the actual foldtext, the rest of the line
4577 will be filled with the fold char from the 'fillchars'
4578 setting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 {not available when compiled without the |+folding| feature}
4580
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00004581foldtextresult({lnum}) *foldtextresult()*
4582 Returns the text that is displayed for the closed fold at line
4583 {lnum}. Evaluates 'foldtext' in the appropriate context.
4584 When there is no closed fold at {lnum} an empty string is
4585 returned.
4586 {lnum} is used like with |getline()|. Thus "." is the current
4587 line, "'m" mark m, etc.
4588 Useful when exporting folded text, e.g., to HTML.
4589 {not available when compiled without the |+folding| feature}
4590
Bram Moolenaara4208962019-08-24 20:50:19 +02004591
4592 Can also be used as a |method|: >
4593 GetLnum()->foldtextresult()
4594<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595 *foreground()*
Bram Moolenaar58b85342016-08-14 19:54:54 +02004596foreground() Move the Vim window to the foreground. Useful when sent from
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597 a client to a Vim server. |remote_send()|
4598 On Win32 systems this might not work, the OS does not always
4599 allow a window to bring itself to the foreground. Use
4600 |remote_foreground()| instead.
4601 {only in the Win32, Athena, Motif and GTK GUI versions and the
4602 Win32 console version}
4603
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004604 *funcref()*
4605funcref({name} [, {arglist}] [, {dict}])
4606 Just like |function()|, but the returned Funcref will lookup
4607 the function by reference, not by name. This matters when the
4608 function {name} is redefined later.
4609
4610 Unlike |function()|, {name} must be an existing user function.
4611 Also for autoloaded functions. {name} cannot be a builtin
4612 function.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004613
Bram Moolenaara4208962019-08-24 20:50:19 +02004614 Can also be used as a |method|: >
4615 GetFuncname()->funcref([arg])
4616<
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004617 *function()* *E700* *E922* *E923*
4618function({name} [, {arglist}] [, {dict}])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004619 Return a |Funcref| variable that refers to function {name}.
Bram Moolenaar975b5272016-03-15 23:10:59 +01004620 {name} can be the name of a user defined function or an
4621 internal function.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00004622
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004623 {name} can also be a Funcref or a partial. When it is a
Bram Moolenaar975b5272016-03-15 23:10:59 +01004624 partial the dict stored in it will be used and the {dict}
4625 argument is not allowed. E.g.: >
4626 let FuncWithArg = function(dict.Func, [arg])
4627 let Broken = function(dict.Func, [arg], dict)
4628<
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004629 When using the Funcref the function will be found by {name},
4630 also when it was redefined later. Use |funcref()| to keep the
4631 same function.
4632
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004633 When {arglist} or {dict} is present this creates a partial.
Bram Moolenaar06d2d382016-05-20 17:24:11 +02004634 That means the argument list and/or the dictionary is stored in
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004635 the Funcref and will be used when the Funcref is called.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004636
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004637 The arguments are passed to the function in front of other
Bram Moolenaar088e8e32019-08-08 22:15:18 +02004638 arguments, but after any argument from |method|. Example: >
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004639 func Callback(arg1, arg2, name)
4640 ...
Bram Moolenaar088e8e32019-08-08 22:15:18 +02004641 let Partial = function('Callback', ['one', 'two'])
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004642 ...
Bram Moolenaar088e8e32019-08-08 22:15:18 +02004643 call Partial('name')
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004644< Invokes the function as with: >
4645 call Callback('one', 'two', 'name')
4646
Bram Moolenaar088e8e32019-08-08 22:15:18 +02004647< With a |method|: >
4648 func Callback(one, two, three)
4649 ...
4650 let Partial = function('Callback', ['two'])
4651 ...
4652 eval 'one'->Partial('three')
4653< Invokes the function as with: >
4654 call Callback('one', 'two', 'three')
4655
Bram Moolenaar03602ec2016-03-20 20:57:45 +01004656< The function() call can be nested to add more arguments to the
4657 Funcref. The extra arguments are appended to the list of
4658 arguments. Example: >
4659 func Callback(arg1, arg2, name)
4660 ...
4661 let Func = function('Callback', ['one'])
4662 let Func2 = function(Func, ['two'])
4663 ...
4664 call Func2('name')
4665< Invokes the function as with: >
4666 call Callback('one', 'two', 'name')
4667
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004668< The Dictionary is only useful when calling a "dict" function.
4669 In that case the {dict} is passed in as "self". Example: >
4670 function Callback() dict
4671 echo "called for " . self.name
4672 endfunction
4673 ...
4674 let context = {"name": "example"}
4675 let Func = function('Callback', context)
4676 ...
4677 call Func() " will echo: called for example
Bram Moolenaar975b5272016-03-15 23:10:59 +01004678< The use of function() is not needed when there are no extra
4679 arguments, these two are equivalent: >
4680 let Func = function('Callback', context)
4681 let Func = context.Callback
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004682
4683< The argument list and the Dictionary can be combined: >
4684 function Callback(arg1, count) dict
4685 ...
4686 let context = {"name": "example"}
4687 let Func = function('Callback', ['one'], context)
4688 ...
4689 call Func(500)
4690< Invokes the function as with: >
4691 call context.Callback('one', 500)
Bram Moolenaara4208962019-08-24 20:50:19 +02004692<
4693 Can also be used as a |method|: >
4694 GetFuncname()->function([arg])
Bram Moolenaar1735bc92016-03-14 23:05:14 +01004695
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004696
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004697garbagecollect([{atexit}]) *garbagecollect()*
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02004698 Cleanup unused |Lists|, |Dictionaries|, |Channels| and |Jobs|
4699 that have circular references.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004700
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02004701 There is hardly ever a need to invoke this function, as it is
4702 automatically done when Vim runs out of memory or is waiting
4703 for the user to press a key after 'updatetime'. Items without
4704 circular references are always freed when they become unused.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004705 This is useful if you have deleted a very big |List| and/or
4706 |Dictionary| with circular references in a script that runs
4707 for a long time.
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02004708
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004709 When the optional {atexit} argument is one, garbage
Bram Moolenaar9d2c8c12007-09-25 16:00:00 +00004710 collection will also be done when exiting Vim, if it wasn't
4711 done before. This is useful when checking for memory leaks.
Bram Moolenaar39a58ca2005-06-27 22:42:44 +00004712
Bram Moolenaar574860b2016-05-24 17:33:34 +02004713 The garbage collection is not done immediately but only when
4714 it's safe to perform. This is when waiting for the user to
4715 type a character. To force garbage collection immediately use
4716 |test_garbagecollect_now()|.
Bram Moolenaarebf7dfa2016-04-14 12:46:51 +02004717
Bram Moolenaar677ee682005-01-27 14:41:15 +00004718get({list}, {idx} [, {default}]) *get()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004719 Get item {idx} from |List| {list}. When this item is not
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004720 available return {default}. Return zero when {default} is
4721 omitted.
Bram Moolenaarac92e252019-08-03 21:58:38 +02004722 Can also be used as a |method|: >
4723 mylist->get(idx)
Bram Moolenaard8968242019-01-15 22:51:57 +01004724get({blob}, {idx} [, {default}])
4725 Get byte {idx} from |Blob| {blob}. When this byte is not
4726 available return {default}. Return -1 when {default} is
4727 omitted.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004728get({dict}, {key} [, {default}])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004729 Get item with key {key} from |Dictionary| {dict}. When this
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004730 item is not available return {default}. Return zero when
Bram Moolenaar54775062019-07-31 21:07:14 +02004731 {default} is omitted. Useful example: >
4732 let val = get(g:, 'var_name', 'default')
4733< This gets the value of g:var_name if it exists, and uses
4734 'default' when it does not exist.
Bram Moolenaar03e19a02016-05-24 22:29:49 +02004735get({func}, {what})
4736 Get an item with from Funcref {func}. Possible values for
Bram Moolenaar2bbf8ef2016-05-24 18:37:12 +02004737 {what} are:
Bram Moolenaar214641f2017-03-05 17:04:09 +01004738 "name" The function name
4739 "func" The function
4740 "dict" The dictionary
4741 "args" The list with arguments
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00004742
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004743 *getbufinfo()*
4744getbufinfo([{expr}])
4745getbufinfo([{dict}])
Bram Moolenaar58b85342016-08-14 19:54:54 +02004746 Get information about buffers as a List of Dictionaries.
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004747
4748 Without an argument information about all the buffers is
4749 returned.
4750
4751 When the argument is a Dictionary only the buffers matching
4752 the specified criteria are returned. The following keys can
4753 be specified in {dict}:
4754 buflisted include only listed buffers.
4755 bufloaded include only loaded buffers.
Bram Moolenaar8e6a31d2017-12-10 21:06:22 +01004756 bufmodified include only modified buffers.
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004757
4758 Otherwise, {expr} specifies a particular buffer to return
4759 information for. For the use of {expr}, see |bufname()|
4760 above. If the buffer is found the returned List has one item.
4761 Otherwise the result is an empty list.
4762
4763 Each returned List item is a dictionary with the following
4764 entries:
Bram Moolenaar33928832016-08-18 21:22:04 +02004765 bufnr buffer number.
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004766 changed TRUE if the buffer is modified.
4767 changedtick number of changes made to the buffer.
4768 hidden TRUE if the buffer is hidden.
4769 listed TRUE if the buffer is listed.
4770 lnum current line number in buffer.
4771 loaded TRUE if the buffer is loaded.
4772 name full path to the file in the buffer.
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004773 signs list of signs placed in the buffer.
4774 Each list item is a dictionary with
4775 the following fields:
4776 id sign identifier
4777 lnum line number
4778 name sign name
Bram Moolenaar30567352016-08-27 21:25:44 +02004779 variables a reference to the dictionary with
4780 buffer-local variables.
4781 windows list of |window-ID|s that display this
4782 buffer
Bram Moolenaar5ca1ac32019-07-04 15:39:28 +02004783 popups list of popup |window-ID|s that
4784 display this buffer
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004785
4786 Examples: >
4787 for buf in getbufinfo()
4788 echo buf.name
4789 endfor
4790 for buf in getbufinfo({'buflisted':1})
Bram Moolenaar30567352016-08-27 21:25:44 +02004791 if buf.changed
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02004792 ....
4793 endif
4794 endfor
4795<
Bram Moolenaar30567352016-08-27 21:25:44 +02004796 To get buffer-local options use: >
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004797 getbufvar({bufnr}, '&option_name')
Bram Moolenaar30567352016-08-27 21:25:44 +02004798
4799<
Bram Moolenaar45360022005-07-21 21:08:21 +00004800 *getbufline()*
4801getbufline({expr}, {lnum} [, {end}])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004802 Return a |List| with the lines starting from {lnum} to {end}
4803 (inclusive) in the buffer {expr}. If {end} is omitted, a
4804 |List| with only the line {lnum} is returned.
Bram Moolenaar45360022005-07-21 21:08:21 +00004805
4806 For the use of {expr}, see |bufname()| above.
4807
Bram Moolenaar661b1822005-07-28 22:36:45 +00004808 For {lnum} and {end} "$" can be used for the last line of the
4809 buffer. Otherwise a number must be used.
Bram Moolenaar45360022005-07-21 21:08:21 +00004810
4811 When {lnum} is smaller than 1 or bigger than the number of
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004812 lines in the buffer, an empty |List| is returned.
Bram Moolenaar45360022005-07-21 21:08:21 +00004813
4814 When {end} is greater than the number of lines in the buffer,
4815 it is treated as {end} is set to the number of lines in the
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004816 buffer. When {end} is before {lnum} an empty |List| is
Bram Moolenaar45360022005-07-21 21:08:21 +00004817 returned.
4818
Bram Moolenaar661b1822005-07-28 22:36:45 +00004819 This function works only for loaded buffers. For unloaded and
Bram Moolenaar32466aa2006-02-24 23:53:04 +00004820 non-existing buffers, an empty |List| is returned.
Bram Moolenaar45360022005-07-21 21:08:21 +00004821
4822 Example: >
4823 :let lines = getbufline(bufnr("myfile"), 1, "$")
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004824
Bram Moolenaar4c313b12019-08-24 22:58:31 +02004825< Can also be used as a |method|: >
4826 GetBufnr()->getbufline(lnum)
4827
Bram Moolenaar63dbda12013-02-20 21:12:10 +01004828getbufvar({expr}, {varname} [, {def}]) *getbufvar()*
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004829 The result is the value of option or local buffer variable
4830 {varname} in buffer {expr}. Note that the name without "b:"
4831 must be used.
Bram Moolenaarc236c162008-07-13 17:41:49 +00004832 When {varname} is empty returns a dictionary with all the
4833 buffer-local variables.
Bram Moolenaar30567352016-08-27 21:25:44 +02004834 When {varname} is equal to "&" returns a dictionary with all
4835 the buffer-local options.
4836 Otherwise, when {varname} starts with "&" returns the value of
4837 a buffer-local option.
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00004838 This also works for a global or buffer-local option, but it
4839 doesn't work for a global variable, window-local variable or
4840 window-local option.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004841 For the use of {expr}, see |bufname()| above.
Bram Moolenaar63dbda12013-02-20 21:12:10 +01004842 When the buffer or variable doesn't exist {def} or an empty
4843 string is returned, there is no error message.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004844 Examples: >
4845 :let bufmodified = getbufvar(1, "&mod")
4846 :echo "todo myvar = " . getbufvar("todo", "myvar")
Bram Moolenaar4c313b12019-08-24 22:58:31 +02004847
4848< Can also be used as a |method|: >
4849 GetBufnr()->getbufvar(varname)
Bram Moolenaara14de3d2005-01-07 21:48:26 +00004850<
Bram Moolenaar4c313b12019-08-24 22:58:31 +02004851getchangelist([{expr}]) *getchangelist()*
Bram Moolenaar07ad8162018-02-13 13:59:59 +01004852 Returns the |changelist| for the buffer {expr}. For the use
4853 of {expr}, see |bufname()| above. If buffer {expr} doesn't
4854 exist, an empty list is returned.
4855
4856 The returned list contains two entries: a list with the change
4857 locations and the current position in the list. Each
4858 entry in the change list is a dictionary with the following
4859 entries:
4860 col column number
4861 coladd column offset for 'virtualedit'
4862 lnum line number
4863 If buffer {expr} is the current buffer, then the current
4864 position refers to the position in the list. For other
4865 buffers, it is set to the length of the list.
4866
Bram Moolenaar4c313b12019-08-24 22:58:31 +02004867 Can also be used as a |method|: >
4868 GetBufnr()->getchangelist()
4869
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870getchar([expr]) *getchar()*
Bram Moolenaar91170f82006-05-05 21:15:17 +00004871 Get a single character from the user or input stream.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 If [expr] is omitted, wait until a character is available.
4873 If [expr] is 0, only get a character when one is available.
Bram Moolenaar91170f82006-05-05 21:15:17 +00004874 Return zero otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 If [expr] is 1, only check if a character is available, it is
Bram Moolenaar91170f82006-05-05 21:15:17 +00004876 not consumed. Return zero if no character available.
4877
Bram Moolenaardfb18412013-12-11 18:53:29 +01004878 Without [expr] and when [expr] is 0 a whole character or
Bram Moolenaarc577d812017-07-08 22:37:34 +02004879 special key is returned. If it is a single character, the
Bram Moolenaar91170f82006-05-05 21:15:17 +00004880 result is a number. Use nr2char() to convert it to a String.
4881 Otherwise a String is returned with the encoded character.
Bram Moolenaarc577d812017-07-08 22:37:34 +02004882 For a special key it's a String with a sequence of bytes
4883 starting with 0x80 (decimal: 128). This is the same value as
4884 the String "\<Key>", e.g., "\<Left>". The returned value is
4885 also a String when a modifier (shift, control, alt) was used
4886 that is not included in the character.
Bram Moolenaar91170f82006-05-05 21:15:17 +00004887
Bram Moolenaar822ff862014-06-12 21:46:14 +02004888 When [expr] is 0 and Esc is typed, there will be a short delay
4889 while Vim waits to see if this is the start of an escape
4890 sequence.
4891
Bram Moolenaardfb18412013-12-11 18:53:29 +01004892 When [expr] is 1 only the first byte is returned. For a
Bram Moolenaar56a907a2006-05-06 21:44:30 +00004893 one-byte character it is the character itself as a number.
4894 Use nr2char() to convert it to a String.
Bram Moolenaar91170f82006-05-05 21:15:17 +00004895
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004896 Use getcharmod() to obtain any additional modifiers.
4897
Bram Moolenaar219b8702006-11-01 14:32:36 +00004898 When the user clicks a mouse button, the mouse event will be
4899 returned. The position can then be found in |v:mouse_col|,
Bram Moolenaar511972d2016-06-04 18:09:59 +02004900 |v:mouse_lnum|, |v:mouse_winid| and |v:mouse_win|. This
4901 example positions the mouse as it would normally happen: >
Bram Moolenaar219b8702006-11-01 14:32:36 +00004902 let c = getchar()
Bram Moolenaar446cb832008-06-24 21:56:24 +00004903 if c == "\<LeftMouse>" && v:mouse_win > 0
Bram Moolenaar219b8702006-11-01 14:32:36 +00004904 exe v:mouse_win . "wincmd w"
4905 exe v:mouse_lnum
4906 exe "normal " . v:mouse_col . "|"
4907 endif
4908<
Bram Moolenaar690afe12017-01-28 18:34:47 +01004909 When using bracketed paste only the first character is
4910 returned, the rest of the pasted text is dropped.
4911 |xterm-bracketed-paste|.
4912
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913 There is no prompt, you will somehow have to make clear to the
4914 user that a character has to be typed.
4915 There is no mapping for the character.
4916 Key codes are replaced, thus when the user presses the <Del>
4917 key you get the code for the <Del> key, not the raw character
4918 sequence. Examples: >
4919 getchar() == "\<Del>"
4920 getchar() == "\<S-Left>"
4921< This example redefines "f" to ignore case: >
4922 :nmap f :call FindChar()<CR>
4923 :function FindChar()
4924 : let c = nr2char(getchar())
4925 : while col('.') < col('$') - 1
4926 : normal l
4927 : if getline('.')[col('.') - 1] ==? c
4928 : break
4929 : endif
4930 : endwhile
4931 :endfunction
Bram Moolenaared32d942014-12-06 23:33:00 +01004932<
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01004933 You may also receive synthetic characters, such as
Bram Moolenaared32d942014-12-06 23:33:00 +01004934 |<CursorHold>|. Often you will want to ignore this and get
4935 another character: >
4936 :function GetKey()
4937 : let c = getchar()
4938 : while c == "\<CursorHold>"
4939 : let c = getchar()
4940 : endwhile
4941 : return c
4942 :endfunction
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943
4944getcharmod() *getcharmod()*
4945 The result is a Number which is the state of the modifiers for
4946 the last obtained character with getchar() or in another way.
4947 These values are added together:
4948 2 shift
4949 4 control
4950 8 alt (meta)
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004951 16 meta (when it's different from ALT)
4952 32 mouse double click
4953 64 mouse triple click
4954 96 mouse quadruple click (== 32 + 64)
4955 128 command (Macintosh only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 Only the modifiers that have not been included in the
Bram Moolenaar58b85342016-08-14 19:54:54 +02004957 character itself are obtained. Thus Shift-a results in "A"
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004958 without a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959
Bram Moolenaardbd24b52015-08-11 14:26:19 +02004960getcharsearch() *getcharsearch()*
4961 Return the current character search information as a {dict}
4962 with the following entries:
4963
4964 char character previously used for a character
4965 search (|t|, |f|, |T|, or |F|); empty string
4966 if no character search has been performed
4967 forward direction of character search; 1 for forward,
4968 0 for backward
4969 until type of character search; 1 for a |t| or |T|
4970 character search, 0 for an |f| or |F|
4971 character search
4972
4973 This can be useful to always have |;| and |,| search
4974 forward/backward regardless of the direction of the previous
4975 character search: >
4976 :nnoremap <expr> ; getcharsearch().forward ? ';' : ','
4977 :nnoremap <expr> , getcharsearch().forward ? ',' : ';'
4978< Also see |setcharsearch()|.
4979
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980getcmdline() *getcmdline()*
4981 Return the current command-line. Only works when the command
4982 line is being edited, thus requires use of |c_CTRL-\_e| or
4983 |c_CTRL-R_=|.
4984 Example: >
4985 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00004986< Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|.
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004987 Returns an empty string when entering a password or using
4988 |inputsecret()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00004990getcmdpos() *getcmdpos()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 Return the position of the cursor in the command line as a
4992 byte count. The first column is 1.
4993 Only works when editing the command line, thus requires use of
Bram Moolenaar5b435d62012-04-05 17:33:26 +02004994 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
4995 Returns 0 otherwise.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00004996 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|.
4997
4998getcmdtype() *getcmdtype()*
4999 Return the current command-line type. Possible return values
5000 are:
Bram Moolenaar1e015462005-09-25 22:16:38 +00005001 : normal Ex command
5002 > debug mode command |debug-mode|
5003 / forward search command
5004 ? backward search command
5005 @ |input()| command
5006 - |:insert| or |:append| command
Bram Moolenaar6e932462014-09-09 18:48:09 +02005007 = |i_CTRL-R_=|
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00005008 Only works when editing the command line, thus requires use of
Bram Moolenaar5b435d62012-04-05 17:33:26 +02005009 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
5010 Returns an empty string otherwise.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00005011 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012
Bram Moolenaarfb539272014-08-22 19:21:47 +02005013getcmdwintype() *getcmdwintype()*
5014 Return the current |command-line-window| type. Possible return
5015 values are the same as |getcmdtype()|. Returns an empty string
5016 when not in the command-line window.
5017
Bram Moolenaare9d58a62016-08-13 15:07:41 +02005018getcompletion({pat}, {type} [, {filtered}]) *getcompletion()*
Bram Moolenaaraa4d7322016-07-09 18:50:29 +02005019 Return a list of command-line completion matches. {type}
5020 specifies what for. The following completion types are
5021 supported:
5022
Bram Moolenaarcd43eff2018-03-29 15:55:38 +02005023 arglist file names in argument list
Bram Moolenaaraa4d7322016-07-09 18:50:29 +02005024 augroup autocmd groups
5025 buffer buffer names
5026 behave :behave suboptions
5027 color color schemes
5028 command Ex command (and arguments)
5029 compiler compilers
5030 cscope |:cscope| suboptions
5031 dir directory names
5032 environment environment variable names
5033 event autocommand events
5034 expression Vim expression
5035 file file and directory names
5036 file_in_path file and directory names in |'path'|
5037 filetype filetype names |'filetype'|
5038 function function name
5039 help help subjects
5040 highlight highlight groups
5041 history :history suboptions
5042 locale locale names (as output of locale -a)
Bram Moolenaarcae92dc2017-08-06 15:22:15 +02005043 mapclear buffer argument
Bram Moolenaaraa4d7322016-07-09 18:50:29 +02005044 mapping mapping name
5045 menu menus
Bram Moolenaar9e507ca2016-10-15 15:39:39 +02005046 messages |:messages| suboptions
Bram Moolenaaraa4d7322016-07-09 18:50:29 +02005047 option options
Bram Moolenaar9e507ca2016-10-15 15:39:39 +02005048 packadd optional package |pack-add| names
Bram Moolenaaraa4d7322016-07-09 18:50:29 +02005049 shellcmd Shell command
5050 sign |:sign| suboptions
5051 syntax syntax file names |'syntax'|
5052 syntime |:syntime| suboptions
5053 tag tags
5054 tag_listfiles tags, file names
5055 user user names
5056 var user variables
5057
5058 If {pat} is an empty string, then all the matches are returned.
5059 Otherwise only items matching {pat} are returned. See
5060 |wildcards| for the use of special characters in {pat}.
5061
Bram Moolenaare9d58a62016-08-13 15:07:41 +02005062 If the optional {filtered} flag is set to 1, then 'wildignore'
5063 is applied to filter the results. Otherwise all the matches
5064 are returned. The 'wildignorecase' option always applies.
5065
Bram Moolenaaraa4d7322016-07-09 18:50:29 +02005066 If there are no matches, an empty list is returned. An
5067 invalid value for {type} produces an error.
5068
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005069 Can also be used as a |method|: >
5070 GetPattern()->getcompletion('color')
5071<
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02005072 *getcurpos()*
5073getcurpos() Get the position of the cursor. This is like getpos('.'), but
5074 includes an extra item in the list:
Bram Moolenaar345efa02016-01-15 20:57:49 +01005075 [bufnum, lnum, col, off, curswant] ~
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02005076 The "curswant" number is the preferred column when moving the
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02005077 cursor vertically. Also see |getpos()|.
5078
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02005079 This can be used to save and restore the cursor position: >
5080 let save_cursor = getcurpos()
5081 MoveTheCursorAround
5082 call setpos('.', save_cursor)
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02005083< Note that this only works within the window. See
5084 |winrestview()| for restoring more state.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005085 *getcwd()*
Bram Moolenaarc9703302016-01-17 21:49:33 +01005086getcwd([{winnr} [, {tabnr}]])
5087 The result is a String, which is the name of the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 working directory.
Bram Moolenaarc9703302016-01-17 21:49:33 +01005089
5090 With {winnr} return the local current directory of this window
Bram Moolenaar54591292018-02-09 20:53:59 +01005091 in the current tab page. {winnr} can be the window number or
5092 the |window-ID|.
5093 If {winnr} is -1 return the name of the global working
5094 directory. See also |haslocaldir()|.
5095
Bram Moolenaarc9703302016-01-17 21:49:33 +01005096 With {winnr} and {tabnr} return the local current directory of
Bram Moolenaar00aa0692019-04-27 20:37:57 +02005097 the window in the specified tab page. If {winnr} is -1 return
5098 the working directory of the tabpage.
5099 If {winnr} is zero use the current window, if {tabnr} is zero
5100 use the current tabpage.
5101 Without any arguments, return the working directory of the
5102 current window.
Bram Moolenaarc9703302016-01-17 21:49:33 +01005103 Return an empty string if the arguments are invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104
Bram Moolenaar00aa0692019-04-27 20:37:57 +02005105 Examples: >
5106 " Get the working directory of the current window
5107 :echo getcwd()
5108 :echo getcwd(0)
5109 :echo getcwd(0, 0)
5110 " Get the working directory of window 3 in tabpage 2
5111 :echo getcwd(3, 2)
5112 " Get the global working directory
5113 :echo getcwd(-1)
5114 " Get the working directory of tabpage 3
5115 :echo getcwd(-1, 3)
5116 " Get the working directory of current tabpage
5117 :echo getcwd(-1, 0)
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005118
5119< Can also be used as a |method|: >
5120 GetWinnr()->getcwd()
Bram Moolenaar00aa0692019-04-27 20:37:57 +02005121<
Bram Moolenaar691ddee2019-05-09 14:52:41 +02005122getenv({name}) *getenv()*
5123 Return the value of environment variable {name}.
5124 When the variable does not exist |v:null| is returned. That
Bram Moolenaar54775062019-07-31 21:07:14 +02005125 is different from a variable set to an empty string, although
5126 some systems interpret the empty value as the variable being
5127 deleted. See also |expr-env|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005129 Can also be used as a |method|: >
5130 GetVarname()->getenv()
5131
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00005132getfontname([{name}]) *getfontname()*
5133 Without an argument returns the name of the normal font being
5134 used. Like what is used for the Normal highlight group
5135 |hl-Normal|.
5136 With an argument a check is done whether {name} is a valid
5137 font name. If not then an empty string is returned.
5138 Otherwise the actual font name is returned, or {name} if the
5139 GUI does not support obtaining the real name.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00005140 Only works when the GUI is running, thus not in your vimrc or
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00005141 gvimrc file. Use the |GUIEnter| autocommand to use this
5142 function just after the GUI has started.
Bram Moolenaar3df01732017-02-17 22:47:16 +01005143 Note that the GTK GUI accepts any font name, thus checking for
5144 a valid name does not work.
Bram Moolenaard8b0cf12004-12-12 11:33:30 +00005145
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005146getfperm({fname}) *getfperm()*
5147 The result is a String, which is the read, write, and execute
5148 permissions of the given file {fname}.
5149 If {fname} does not exist or its directory cannot be read, an
5150 empty string is returned.
5151 The result is of the form "rwxrwxrwx", where each group of
5152 "rwx" flags represent, in turn, the permissions of the owner
5153 of the file, the group the file belongs to, and other users.
5154 If a user does not have a given permission the flag for this
Bram Moolenaar9b451252012-08-15 17:43:31 +02005155 is replaced with the string "-". Examples: >
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005156 :echo getfperm("/etc/passwd")
Bram Moolenaar9b451252012-08-15 17:43:31 +02005157 :echo getfperm(expand("~/.vimrc"))
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005158< This will hopefully (from a security point of view) display
5159 the string "rw-r--r--" or even "rw-------".
Bram Moolenaare2cc9702005-03-15 22:43:58 +00005160
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005161 Can also be used as a |method|: >
5162 GetFilename()->getfperm()
5163<
Bram Moolenaar2ec618c2016-10-01 14:47:05 +02005164 For setting permissions use |setfperm()|.
Bram Moolenaar80492532016-03-08 17:08:53 +01005165
Bram Moolenaar691ddee2019-05-09 14:52:41 +02005166getfsize({fname}) *getfsize()*
5167 The result is a Number, which is the size in bytes of the
5168 given file {fname}.
5169 If {fname} is a directory, 0 is returned.
5170 If the file {fname} can't be found, -1 is returned.
5171 If the size of {fname} is too big to fit in a Number then -2
5172 is returned.
5173
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005174 Can also be used as a |method|: >
5175 GetFilename()->getfsize()
5176
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177getftime({fname}) *getftime()*
5178 The result is a Number, which is the last modification time of
5179 the given file {fname}. The value is measured as seconds
5180 since 1st Jan 1970, and may be passed to strftime(). See also
5181 |localtime()| and |strftime()|.
5182 If the file {fname} can't be found -1 is returned.
5183
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005184 Can also be used as a |method|: >
5185 GetFilename()->getftime()
5186
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005187getftype({fname}) *getftype()*
5188 The result is a String, which is a description of the kind of
5189 file of the given file {fname}.
5190 If {fname} does not exist an empty string is returned.
5191 Here is a table over different kinds of files and their
5192 results:
5193 Normal file "file"
5194 Directory "dir"
5195 Symbolic link "link"
5196 Block device "bdev"
5197 Character device "cdev"
5198 Socket "socket"
5199 FIFO "fifo"
5200 All other "other"
5201 Example: >
5202 getftype("/home")
5203< Note that a type such as "link" will only be returned on
5204 systems that support it. On some systems only "dir" and
Bram Moolenaar13d5aee2016-01-21 23:36:05 +01005205 "file" are returned. On MS-Windows a symbolic link to a
5206 directory returns "dir" instead of "link".
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00005207
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005208 Can also be used as a |method|: >
5209 GetFilename()->getftype()
5210
Bram Moolenaara3a12462019-09-07 15:08:38 +02005211getimstatus() *getimstatus()*
5212 The result is a Number, which is |TRUE| when the IME status is
5213 active.
5214 See 'imstatusfunc'.
5215
Bram Moolenaard96ff162018-02-18 22:13:29 +01005216getjumplist([{winnr} [, {tabnr}]]) *getjumplist()*
Bram Moolenaar4f505882018-02-10 21:06:32 +01005217 Returns the |jumplist| for the specified window.
5218
5219 Without arguments use the current window.
5220 With {winnr} only use this window in the current tab page.
5221 {winnr} can also be a |window-ID|.
5222 With {winnr} and {tabnr} use the window in the specified tab
5223 page.
5224
5225 The returned list contains two entries: a list with the jump
5226 locations and the last used jump position number in the list.
5227 Each entry in the jump location list is a dictionary with
5228 the following entries:
5229 bufnr buffer number
5230 col column number
5231 coladd column offset for 'virtualedit'
5232 filename filename if available
5233 lnum line number
5234
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005235 Can also be used as a |method|: >
5236 GetWinnr()->getjumplist()
5237
5238< *getline()*
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005239getline({lnum} [, {end}])
5240 Without {end} the result is a String, which is line {lnum}
5241 from the current buffer. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242 getline(1)
5243< When {lnum} is a String that doesn't start with a
Bram Moolenaarf2732452018-06-03 14:47:35 +02005244 digit, |line()| is called to translate the String into a Number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 To get the line under the cursor: >
5246 getline(".")
5247< When {lnum} is smaller than 1 or bigger than the number of
5248 lines in the buffer, an empty string is returned.
5249
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005250 When {end} is given the result is a |List| where each item is
5251 a line from the current buffer in the range {lnum} to {end},
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005252 including line {end}.
5253 {end} is used in the same way as {lnum}.
5254 Non-existing lines are silently omitted.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005255 When {end} is before {lnum} an empty |List| is returned.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005256 Example: >
5257 :let start = line('.')
5258 :let end = search("^$") - 1
5259 :let lines = getline(start, end)
5260
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005261< Can also be used as a |method|: >
5262 ComputeLnum()->getline()
5263
Bram Moolenaaref2f6562007-05-06 13:32:59 +00005264< To get lines from another buffer see |getbufline()|
5265
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005266getloclist({nr} [, {what}]) *getloclist()*
Bram Moolenaar17c7c012006-01-26 22:25:15 +00005267 Returns a list with all the entries in the location list for
Bram Moolenaar7571d552016-08-18 22:54:46 +02005268 window {nr}. {nr} can be the window number or the |window-ID|.
Bram Moolenaar888ccac2016-06-04 18:49:36 +02005269 When {nr} is zero the current window is used.
5270
Bram Moolenaar17c7c012006-01-26 22:25:15 +00005271 For a location list window, the displayed location list is
Bram Moolenaar280f1262006-01-30 00:14:18 +00005272 returned. For an invalid window number {nr}, an empty list is
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005273 returned. Otherwise, same as |getqflist()|.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005274
Bram Moolenaard823fa92016-08-12 16:29:27 +02005275 If the optional {what} dictionary argument is supplied, then
5276 returns the items listed in {what} as a dictionary. Refer to
5277 |getqflist()| for the supported items in {what}.
Bram Moolenaar647e24b2019-03-17 16:39:46 +01005278
5279 In addition to the items supported by |getqflist()| in {what},
5280 the following item is supported by |getloclist()|:
5281
Bram Moolenaar68e65602019-05-26 21:33:31 +02005282 filewinid id of the window used to display files
Bram Moolenaar647e24b2019-03-17 16:39:46 +01005283 from the location list. This field is
5284 applicable only when called from a
5285 location list window. See
5286 |location-list-file-window| for more
5287 details.
Bram Moolenaard823fa92016-08-12 16:29:27 +02005288
Bram Moolenaaraff74912019-03-30 18:11:49 +01005289getmatches([{win}]) *getmatches()*
Bram Moolenaarfd133322019-03-29 12:20:27 +01005290 Returns a |List| with all matches previously defined for the
5291 current window by |matchadd()| and the |:match| commands.
5292 |getmatches()| is useful in combination with |setmatches()|,
5293 as |setmatches()| can restore a list of matches saved by
5294 |getmatches()|.
Bram Moolenaar6ee10162007-07-26 20:58:42 +00005295 Example: >
5296 :echo getmatches()
5297< [{'group': 'MyGroup1', 'pattern': 'TODO',
5298 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
5299 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
5300 :let m = getmatches()
5301 :call clearmatches()
5302 :echo getmatches()
5303< [] >
5304 :call setmatches(m)
5305 :echo getmatches()
5306< [{'group': 'MyGroup1', 'pattern': 'TODO',
5307 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
5308 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
5309 :unlet m
5310<
Bram Moolenaar822ff862014-06-12 21:46:14 +02005311 *getpid()*
5312getpid() Return a Number which is the process ID of the Vim process.
5313 On Unix and MS-Windows this is a unique number, until Vim
Bram Moolenaar58b85342016-08-14 19:54:54 +02005314 exits. On MS-DOS it's always zero.
Bram Moolenaar822ff862014-06-12 21:46:14 +02005315
5316 *getpos()*
5317getpos({expr}) Get the position for {expr}. For possible values of {expr}
5318 see |line()|. For getting the cursor position see
5319 |getcurpos()|.
5320 The result is a |List| with four numbers:
5321 [bufnum, lnum, col, off]
5322 "bufnum" is zero, unless a mark like '0 or 'A is used, then it
5323 is the buffer number of the mark.
5324 "lnum" and "col" are the position in the buffer. The first
5325 column is 1.
5326 The "off" number is zero, unless 'virtualedit' is used. Then
5327 it is the offset in screen columns from the start of the
5328 character. E.g., a position within a <Tab> or after the last
5329 character.
5330 Note that for '< and '> Visual mode matters: when it is "V"
5331 (visual line mode) the column of '< is zero and the column of
5332 '> is a large number.
5333 This can be used to save and restore the position of a mark: >
5334 let save_a_mark = getpos("'a")
5335 ...
Bram Moolenaared32d942014-12-06 23:33:00 +01005336 call setpos("'a", save_a_mark)
Bram Moolenaar822ff862014-06-12 21:46:14 +02005337< Also see |getcurpos()| and |setpos()|.
5338
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005339 Can also be used as a |method|: >
5340 GetMark()->getpos()
5341
Bram Moolenaar6ee10162007-07-26 20:58:42 +00005342
Bram Moolenaard823fa92016-08-12 16:29:27 +02005343getqflist([{what}]) *getqflist()*
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005344 Returns a list with all the current quickfix errors. Each
5345 list item is a dictionary with these entries:
5346 bufnr number of buffer that has the file name, use
5347 bufname() to get the name
Bram Moolenaard76ce852018-05-01 15:02:04 +02005348 module module name
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005349 lnum line number in the buffer (first line is 1)
5350 col column number (first column is 1)
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005351 vcol |TRUE|: "col" is visual column
5352 |FALSE|: "col" is byte index
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005353 nr error number
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00005354 pattern search pattern used to locate the error
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005355 text description of the error
5356 type type of the error, 'E', '1', etc.
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005357 valid |TRUE|: recognized error message
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005358
Bram Moolenaar7571d552016-08-18 22:54:46 +02005359 When there is no error list or it's empty, an empty list is
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00005360 returned. Quickfix list entries with non-existing buffer
5361 number are returned with "bufnr" set to zero.
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00005362
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005363 Useful application: Find pattern matches in multiple files and
5364 do something with them: >
5365 :vimgrep /theword/jg *.c
5366 :for d in getqflist()
5367 : echo bufname(d.bufnr) ':' d.lnum '=' d.text
5368 :endfor
Bram Moolenaard823fa92016-08-12 16:29:27 +02005369<
5370 If the optional {what} dictionary argument is supplied, then
5371 returns only the items listed in {what} as a dictionary. The
5372 following string items are supported in {what}:
Bram Moolenaarb254af32017-12-18 19:48:58 +01005373 changedtick get the total number of changes made
Bram Moolenaar15142e22018-04-30 22:19:58 +02005374 to the list |quickfix-changedtick|
5375 context get the |quickfix-context|
Bram Moolenaar36538222017-09-02 19:51:44 +02005376 efm errorformat to use when parsing "lines". If
Bram Moolenaar2f058492017-11-30 20:27:52 +01005377 not present, then the 'errorformat' option
Bram Moolenaar36538222017-09-02 19:51:44 +02005378 value is used.
Bram Moolenaara539f4f2017-08-30 20:33:55 +02005379 id get information for the quickfix list with
5380 |quickfix-ID|; zero means the id for the
Bram Moolenaar2f058492017-11-30 20:27:52 +01005381 current list or the list specified by "nr"
Bram Moolenaar5b69c222019-01-11 14:50:06 +01005382 idx index of the current entry in the quickfix
5383 list specified by 'id' or 'nr'.
5384 See |quickfix-index|
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02005385 items quickfix list entries
Bram Moolenaar15142e22018-04-30 22:19:58 +02005386 lines parse a list of lines using 'efm' and return
5387 the resulting entries. Only a |List| type is
5388 accepted. The current quickfix list is not
5389 modified. See |quickfix-parse|.
Bram Moolenaar890680c2016-09-27 21:28:56 +02005390 nr get information for this quickfix list; zero
Bram Moolenaar36538222017-09-02 19:51:44 +02005391 means the current quickfix list and "$" means
Bram Moolenaar875feea2017-06-11 16:07:51 +02005392 the last quickfix list
Bram Moolenaar647e24b2019-03-17 16:39:46 +01005393 qfbufnr number of the buffer displayed in the quickfix
5394 window. Returns 0 if the quickfix buffer is
5395 not present. See |quickfix-buffer|.
Bram Moolenaarfc2b2702017-09-15 22:43:07 +02005396 size number of entries in the quickfix list
Bram Moolenaar15142e22018-04-30 22:19:58 +02005397 title get the list title |quickfix-title|
Bram Moolenaar74240d32017-12-10 15:26:15 +01005398 winid get the quickfix |window-ID|
Bram Moolenaard823fa92016-08-12 16:29:27 +02005399 all all of the above quickfix properties
Bram Moolenaar74240d32017-12-10 15:26:15 +01005400 Non-string items in {what} are ignored. To get the value of a
Bram Moolenaara6d48492017-12-12 22:45:31 +01005401 particular item, set it to zero.
Bram Moolenaard823fa92016-08-12 16:29:27 +02005402 If "nr" is not present then the current quickfix list is used.
Bram Moolenaara539f4f2017-08-30 20:33:55 +02005403 If both "nr" and a non-zero "id" are specified, then the list
5404 specified by "id" is used.
Bram Moolenaarb4d5fba2017-09-11 19:31:28 +02005405 To get the number of lists in the quickfix stack, set "nr" to
5406 "$" in {what}. The "nr" value in the returned dictionary
Bram Moolenaar875feea2017-06-11 16:07:51 +02005407 contains the quickfix stack size.
Bram Moolenaarb4d5fba2017-09-11 19:31:28 +02005408 When "lines" is specified, all the other items except "efm"
5409 are ignored. The returned dictionary contains the entry
5410 "items" with the list of entries.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00005411
Bram Moolenaard823fa92016-08-12 16:29:27 +02005412 The returned dictionary contains the following entries:
Bram Moolenaarb254af32017-12-18 19:48:58 +01005413 changedtick total number of changes made to the
5414 list |quickfix-changedtick|
Bram Moolenaar15142e22018-04-30 22:19:58 +02005415 context quickfix list context. See |quickfix-context|
Bram Moolenaara6d48492017-12-12 22:45:31 +01005416 If not present, set to "".
5417 id quickfix list ID |quickfix-ID|. If not
5418 present, set to 0.
5419 idx index of the current entry in the list. If not
5420 present, set to 0.
5421 items quickfix list entries. If not present, set to
5422 an empty list.
5423 nr quickfix list number. If not present, set to 0
Bram Moolenaar647e24b2019-03-17 16:39:46 +01005424 qfbufnr number of the buffer displayed in the quickfix
5425 window. If not present, set to 0.
Bram Moolenaara6d48492017-12-12 22:45:31 +01005426 size number of entries in the quickfix list. If not
5427 present, set to 0.
5428 title quickfix list title text. If not present, set
5429 to "".
Bram Moolenaar74240d32017-12-10 15:26:15 +01005430 winid quickfix |window-ID|. If not present, set to 0
Bram Moolenaard823fa92016-08-12 16:29:27 +02005431
Bram Moolenaar15142e22018-04-30 22:19:58 +02005432 Examples (See also |getqflist-examples|): >
Bram Moolenaard823fa92016-08-12 16:29:27 +02005433 :echo getqflist({'all': 1})
5434 :echo getqflist({'nr': 2, 'title': 1})
Bram Moolenaar2c809b72017-09-01 18:34:02 +02005435 :echo getqflist({'lines' : ["F1:10:L10"]})
Bram Moolenaard823fa92016-08-12 16:29:27 +02005436<
Bram Moolenaarb7cb42b2014-04-02 19:55:10 +02005437getreg([{regname} [, 1 [, {list}]]]) *getreg()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005438 The result is a String, which is the contents of register
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005439 {regname}. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 :let cliptext = getreg('*')
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005441< When {regname} was not set the result is an empty string.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005442
5443 getreg('=') returns the last evaluated value of the expression
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005444 register. (For use in maps.)
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00005445 getreg('=', 1) returns the expression itself, so that it can
5446 be restored with |setreg()|. For other registers the extra
5447 argument is ignored, thus you can always give it.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005448
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005449 If {list} is present and |TRUE|, the result type is changed
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005450 to |List|. Each list item is one text line. Use it if you care
Bram Moolenaarb7cb42b2014-04-02 19:55:10 +02005451 about zero bytes possibly present inside register: without
5452 third argument both NLs and zero bytes are represented as NLs
5453 (see |NL-used-for-Nul|).
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005454 When the register was not set an empty list is returned.
5455
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456 If {regname} is not specified, |v:register| is used.
5457
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005458 Can also be used as a |method|: >
5459 GetRegname()->getreg()
5460
Bram Moolenaara14de3d2005-01-07 21:48:26 +00005461
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462getregtype([{regname}]) *getregtype()*
5463 The result is a String, which is type of register {regname}.
5464 The value will be one of:
5465 "v" for |characterwise| text
5466 "V" for |linewise| text
5467 "<CTRL-V>{width}" for |blockwise-visual| text
Bram Moolenaar32b92012014-01-14 12:33:36 +01005468 "" for an empty or unknown register
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 <CTRL-V> is one character with value 0x16.
5470 If {regname} is not specified, |v:register| is used.
5471
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005472 Can also be used as a |method|: >
5473 GetRegname()->getregtype()
5474
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02005475gettabinfo([{arg}]) *gettabinfo()*
5476 If {arg} is not specified, then information about all the tab
5477 pages is returned as a List. Each List item is a Dictionary.
5478 Otherwise, {arg} specifies the tab page number and information
5479 about that one is returned. If the tab page does not exist an
5480 empty List is returned.
5481
5482 Each List item is a Dictionary with the following entries:
Bram Moolenaar7571d552016-08-18 22:54:46 +02005483 tabnr tab page number.
Bram Moolenaar30567352016-08-27 21:25:44 +02005484 variables a reference to the dictionary with
5485 tabpage-local variables
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005486 windows List of |window-ID|s in the tab page.
Bram Moolenaarb5ae48e2016-08-12 22:23:25 +02005487
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005488 Can also be used as a |method|: >
5489 GetTabnr()->gettabinfo()
5490
Bram Moolenaar63dbda12013-02-20 21:12:10 +01005491gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()*
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005492 Get the value of a tab-local variable {varname} in tab page
5493 {tabnr}. |t:var|
5494 Tabs are numbered starting with one.
Bram Moolenaar0e2ea1b2014-09-09 16:13:08 +02005495 When {varname} is empty a dictionary with all tab-local
5496 variables is returned.
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005497 Note that the name without "t:" must be used.
Bram Moolenaar63dbda12013-02-20 21:12:10 +01005498 When the tab or variable doesn't exist {def} or an empty
5499 string is returned, there is no error message.
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005500
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005501 Can also be used as a |method|: >
5502 GetTabnr()->gettabvar(varname)
5503
Bram Moolenaar63dbda12013-02-20 21:12:10 +01005504gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()*
Bram Moolenaaref2f6562007-05-06 13:32:59 +00005505 Get the value of window-local variable {varname} in window
5506 {winnr} in tab page {tabnr}.
Bram Moolenaar63dbda12013-02-20 21:12:10 +01005507 When {varname} is empty a dictionary with all window-local
5508 variables is returned.
Bram Moolenaar30567352016-08-27 21:25:44 +02005509 When {varname} is equal to "&" get the values of all
5510 window-local options in a Dictionary.
5511 Otherwise, when {varname} starts with "&" get the value of a
5512 window-local option.
Bram Moolenaar63dbda12013-02-20 21:12:10 +01005513 Note that {varname} must be the name without "w:".
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00005514 Tabs are numbered starting with one. For the current tabpage
5515 use |getwinvar()|.
Bram Moolenaar7571d552016-08-18 22:54:46 +02005516 {winnr} can be the window number or the |window-ID|.
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00005517 When {winnr} is zero the current window is used.
5518 This also works for a global option, buffer-local option and
5519 window-local option, but it doesn't work for a global variable
5520 or buffer-local variable.
Bram Moolenaar63dbda12013-02-20 21:12:10 +01005521 When the tab, window or variable doesn't exist {def} or an
5522 empty string is returned, there is no error message.
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00005523 Examples: >
5524 :let list_is_on = gettabwinvar(1, 2, '&list')
5525 :echo "myvar = " . gettabwinvar(3, 1, 'myvar')
Bram Moolenaard46bbc72007-05-12 14:38:41 +00005526<
Bram Moolenaarb477af22018-07-15 20:20:18 +02005527 To obtain all window-local variables use: >
5528 gettabwinvar({tabnr}, {winnr}, '&')
5529
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005530< Can also be used as a |method|: >
Bram Moolenaar5d69fdb2019-08-31 19:13:58 +02005531 GetTabnr()->gettabwinvar(winnr, varname)
Bram Moolenaar4c313b12019-08-24 22:58:31 +02005532
Bram Moolenaarf49cc602018-11-11 15:21:05 +01005533gettagstack([{nr}]) *gettagstack()*
5534 The result is a Dict, which is the tag stack of window {nr}.
5535 {nr} can be the window number or the |window-ID|.
5536 When {nr} is not specified, the current window is used.
5537 When window {nr} doesn't exist, an empty Dict is returned.
5538
5539 The returned dictionary contains the following entries:
5540 curidx Current index in the stack. When at
5541 top of the stack, set to (length + 1).
5542 Index of bottom of the stack is 1.
5543 items List of items in the stack. Each item
5544 is a dictionary containing the
5545 entries described below.
5546 length Number of entries in the stack.
5547
5548 Each item in the stack is a dictionary with the following
5549 entries:
5550 bufnr buffer number of the current jump
5551 from cursor position before the tag jump.
5552 See |getpos()| for the format of the
5553 returned list.
5554 matchnr current matching tag number. Used when
5555 multiple matching tags are found for a
5556 name.
5557 tagname name of the tag
5558
5559 See |tagstack| for more information about the tag stack.
5560
Bram Moolenaar5d69fdb2019-08-31 19:13:58 +02005561 Can also be used as a |method|: >
5562 GetWinnr()->gettagstack()
5563
Bram Moolenaar7132ddc2018-07-15 17:01:11 +02005564getwininfo([{winid}]) *getwininfo()*
5565 Returns information about windows as a List with Dictionaries.
5566
5567 If {winid} is given Information about the window with that ID
5568 is returned. If the window does not exist the result is an
5569 empty list.
5570
5571 Without {winid} information about all the windows in all the
5572 tab pages is returned.
5573
5574 Each List item is a Dictionary with the following entries:
Bram Moolenaar8fcb60f2019-03-04 13:18:30 +01005575 botline last displayed buffer line
Bram Moolenaar7132ddc2018-07-15 17:01:11 +02005576 bufnr number of buffer in the window
5577 height window height (excluding winbar)
Bram Moolenaar7132ddc2018-07-15 17:01:11 +02005578 loclist 1 if showing a location list
5579 {only with the +quickfix feature}
5580 quickfix 1 if quickfix or location list window
5581 {only with the +quickfix feature}
5582 terminal 1 if a terminal window
5583 {only with the +terminal feature}
5584 tabnr tab page number
Bram Moolenaar8fcb60f2019-03-04 13:18:30 +01005585 topline first displayed buffer line
Bram Moolenaar7132ddc2018-07-15 17:01:11 +02005586 variables a reference to the dictionary with
5587 window-local variables
5588 width window width
Bram Moolenaarb477af22018-07-15 20:20:18 +02005589 winbar 1 if the window has a toolbar, 0
5590 otherwise
Bram Moolenaar7132ddc2018-07-15 17:01:11 +02005591 wincol leftmost screen column of the window,
5592 col from |win_screenpos()|
5593 winid |window-ID|
5594 winnr window number
5595 winrow topmost screen column of the window,
5596 row from |win_screenpos()|
5597
Bram Moolenaar5d69fdb2019-08-31 19:13:58 +02005598 Can also be used as a |method|: >
5599 GetWinnr()->getwininfo()
5600
Bram Moolenaar3f54fd32018-03-03 21:29:55 +01005601getwinpos([{timeout}]) *getwinpos()*
5602 The result is a list with two numbers, the result of
Bram Moolenaar9d87a372018-12-18 21:41:50 +01005603 getwinposx() and getwinposy() combined:
Bram Moolenaar3f54fd32018-03-03 21:29:55 +01005604 [x-pos, y-pos]
5605 {timeout} can be used to specify how long to wait in msec for
5606 a response from the terminal. When omitted 100 msec is used.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005607 Use a longer time for a remote terminal.
5608 When using a value less than 10 and no response is received
5609 within that time, a previously reported position is returned,
5610 if available. This can be used to poll for the position and
Bram Moolenaar5b69c222019-01-11 14:50:06 +01005611 do some work in the meantime: >
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005612 while 1
5613 let res = getwinpos(1)
5614 if res[0] >= 0
5615 break
5616 endif
5617 " Do some work here
5618 endwhile
5619<
Bram Moolenaar5d69fdb2019-08-31 19:13:58 +02005620
5621 Can also be used as a |method|: >
5622 GetTimeout()->getwinpos()
5623<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005624 *getwinposx()*
5625getwinposx() The result is a Number, which is the X coordinate in pixels of
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02005626 the left hand side of the GUI Vim window. Also works for an
Bram Moolenaar3f54fd32018-03-03 21:29:55 +01005627 xterm (uses a timeout of 100 msec).
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02005628 The result will be -1 if the information is not available.
5629 The value can be used with `:winpos`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630
5631 *getwinposy()*
5632getwinposy() The result is a Number, which is the Y coordinate in pixels of
Bram Moolenaar3f54fd32018-03-03 21:29:55 +01005633 the top of the GUI Vim window. Also works for an xterm (uses
5634 a timeout of 100 msec).
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02005635 The result will be -1 if the information is not available.
5636 The value can be used with `:winpos`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005637
Bram Moolenaar63dbda12013-02-20 21:12:10 +01005638getwinvar({winnr}, {varname} [, {def}]) *getwinvar()*
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00005639 Like |gettabwinvar()| for the current tabpage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005640 Examples: >
5641 :let list_is_on = getwinvar(2, '&list')
5642 :echo "myvar = " . getwinvar(1, 'myvar')
Bram Moolenaar5d69fdb2019-08-31 19:13:58 +02005643
5644< Can also be used as a |method|: >
5645 GetWinnr()->getwinvar(varname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646<
Bram Moolenaard8b77f72015-03-05 21:21:19 +01005647glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()*
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00005648 Expand the file wildcards in {expr}. See |wildcards| for the
Bram Moolenaaref2f6562007-05-06 13:32:59 +00005649 use of special characters.
Bram Moolenaar84f72352012-03-11 15:57:40 +01005650
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005651 Unless the optional {nosuf} argument is given and is |TRUE|,
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00005652 the 'suffixes' and 'wildignore' options apply: Names matching
5653 one of the patterns in 'wildignore' will be skipped and
5654 'suffixes' affect the ordering of matches.
Bram Moolenaar81af9252010-12-10 20:35:50 +01005655 'wildignorecase' always applies.
Bram Moolenaar84f72352012-03-11 15:57:40 +01005656
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005657 When {list} is present and it is |TRUE| the result is a List
Bram Moolenaar84f72352012-03-11 15:57:40 +01005658 with all matching files. The advantage of using a List is,
5659 you also get filenames containing newlines correctly.
5660 Otherwise the result is a String and when there are several
5661 matches, they are separated by <NL> characters.
5662
5663 If the expansion fails, the result is an empty String or List.
Bram Moolenaard8b77f72015-03-05 21:21:19 +01005664
Bram Moolenaar62e1bb42019-04-08 16:25:07 +02005665 You can also use |readdir()| if you need to do complicated
5666 things, such as limiting the number of matches.
5667
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005668 A name for a non-existing file is not included. A symbolic
5669 link is only included if it points to an existing file.
Bram Moolenaard8b77f72015-03-05 21:21:19 +01005670 However, when the {alllinks} argument is present and it is
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005671 |TRUE| then all symbolic links are included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672
5673 For most systems backticks can be used to get files names from
5674 any external command. Example: >
5675 :let tagfiles = glob("`find . -name tags -print`")
5676 :let &tags = substitute(tagfiles, "\n", ",", "g")
5677< The result of the program inside the backticks should be one
Bram Moolenaar58b85342016-08-14 19:54:54 +02005678 item per line. Spaces inside an item are allowed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679
5680 See |expand()| for expanding special Vim variables. See
5681 |system()| for getting the raw output of an external command.
5682
Bram Moolenaar5d69fdb2019-08-31 19:13:58 +02005683 Can also be used as a |method|: >
5684 GetExpr()->glob()
5685
Bram Moolenaar5837f1f2015-03-21 18:06:14 +01005686glob2regpat({expr}) *glob2regpat()*
5687 Convert a file pattern, as used by glob(), into a search
5688 pattern. The result can be used to match with a string that
5689 is a file name. E.g. >
5690 if filename =~ glob2regpat('Make*.mak')
5691< This is equivalent to: >
5692 if filename =~ '^Make.*\.mak$'
Bram Moolenaar3b5f9292016-01-28 22:37:01 +01005693< When {expr} is an empty string the result is "^$", match an
5694 empty string.
Bram Moolenaard823fa92016-08-12 16:29:27 +02005695 Note that the result depends on the system. On MS-Windows
Bram Moolenaar58b85342016-08-14 19:54:54 +02005696 a backslash usually means a path separator.
Bram Moolenaar3b5f9292016-01-28 22:37:01 +01005697
Bram Moolenaar5d69fdb2019-08-31 19:13:58 +02005698 Can also be used as a |method|: >
5699 GetExpr()->glob2regpat()
5700< *globpath()*
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005701globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02005702 Perform glob() for {expr} on all directories in {path} and
5703 concatenate the results. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 :echo globpath(&rtp, "syntax/c.vim")
Bram Moolenaar1b1063a2014-05-07 18:35:30 +02005705<
5706 {path} is a comma-separated list of directory names. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 directory name is prepended to {expr} and expanded like with
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00005708 |glob()|. A path separator is inserted when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 To add a comma inside a directory name escape it with a
5710 backslash. Note that on MS-Windows a directory may have a
5711 trailing backslash, remove it if you put a comma after it.
5712 If the expansion fails for one of the directories, there is no
5713 error message.
Bram Moolenaar1b1063a2014-05-07 18:35:30 +02005714
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005715 Unless the optional {nosuf} argument is given and is |TRUE|,
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00005716 the 'suffixes' and 'wildignore' options apply: Names matching
5717 one of the patterns in 'wildignore' will be skipped and
5718 'suffixes' affect the ordering of matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005719
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005720 When {list} is present and it is |TRUE| the result is a List
Bram Moolenaar1b1063a2014-05-07 18:35:30 +02005721 with all matching files. The advantage of using a List is, you
5722 also get filenames containing newlines correctly. Otherwise
5723 the result is a String and when there are several matches,
5724 they are separated by <NL> characters. Example: >
5725 :echo globpath(&rtp, "syntax/c.vim", 0, 1)
5726<
Bram Moolenaar6463ca22016-02-13 17:04:46 +01005727 {alllinks} is used as with |glob()|.
Bram Moolenaard8b77f72015-03-05 21:21:19 +01005728
Bram Moolenaar02743632005-07-25 20:42:36 +00005729 The "**" item can be used to search in a directory tree.
5730 For example, to find all "README.txt" files in the directories
5731 in 'runtimepath' and below: >
5732 :echo globpath(&rtp, "**/README.txt")
Bram Moolenaarc236c162008-07-13 17:41:49 +00005733< Upwards search and limiting the depth of "**" is not
5734 supported, thus using 'path' will not always work properly.
5735
Bram Moolenaar5d69fdb2019-08-31 19:13:58 +02005736 Can also be used as a |method|, the base is passed as the
5737 second argument: >
5738 GetExpr()->globpath(&rtp)
5739<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 *has()*
5741has({feature}) The result is a Number, which is 1 if the feature {feature} is
5742 supported, zero otherwise. The {feature} argument is a
5743 string. See |feature-list| below.
5744 Also see |exists()|.
5745
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00005746
5747has_key({dict}, {key}) *has_key()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00005748 The result is a Number, which is 1 if |Dictionary| {dict} has
5749 an entry with key {key}. Zero otherwise.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00005750
Bram Moolenaara74e4942019-08-04 17:35:53 +02005751 Can also be used as a |method|: >
5752 mydict->has_key(key)
5753
Bram Moolenaarc9703302016-01-17 21:49:33 +01005754haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()*
Bram Moolenaar00aa0692019-04-27 20:37:57 +02005755 The result is a Number:
5756 1 when the window has set a local directory via |:lcd|
5757 2 when the tab-page has set a local directory via |:tcd|
5758 0 otherwise.
Bram Moolenaarc9703302016-01-17 21:49:33 +01005759
5760 Without arguments use the current window.
5761 With {winnr} use this window in the current tab page.
5762 With {winnr} and {tabnr} use the window in the specified tab
5763 page.
Bram Moolenaar7571d552016-08-18 22:54:46 +02005764 {winnr} can be the window number or the |window-ID|.
Bram Moolenaar00aa0692019-04-27 20:37:57 +02005765 If {winnr} is -1 it is ignored and only the tabpage is used.
Bram Moolenaarc9703302016-01-17 21:49:33 +01005766 Return 0 if the arguments are invalid.
Bram Moolenaar00aa0692019-04-27 20:37:57 +02005767 Examples: >
5768 if haslocaldir() == 1
5769 " window local directory case
5770 elseif haslocaldir() == 2
5771 " tab-local directory case
5772 else
5773 " global directory case
5774 endif
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00005775
Bram Moolenaar00aa0692019-04-27 20:37:57 +02005776 " current window
5777 :echo haslocaldir()
5778 :echo haslocaldir(0)
5779 :echo haslocaldir(0, 0)
5780 " window n in current tab page
5781 :echo haslocaldir(n)
5782 :echo haslocaldir(n, 0)
5783 " window n in tab page m
5784 :echo haslocaldir(n, m)
5785 " tab page m
5786 :echo haslocaldir(-1, m)
5787<
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02005788 Can also be used as a |method|: >
5789 GetWinnr()->haslocaldir()
5790
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00005791hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792 The result is a Number, which is 1 if there is a mapping that
5793 contains {what} in somewhere in the rhs (what it is mapped to)
5794 and this mapping exists in one of the modes indicated by
5795 {mode}.
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005796 When {abbr} is there and it is |TRUE| use abbreviations
Bram Moolenaar39f05632006-03-19 22:15:26 +00005797 instead of mappings. Don't forget to specify Insert and/or
5798 Command-line mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005799 Both the global mappings and the mappings local to the current
5800 buffer are checked for a match.
5801 If no matching mapping is found 0 is returned.
5802 The following characters are recognized in {mode}:
5803 n Normal mode
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02005804 v Visual and Select mode
5805 x Visual mode
5806 s Select mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807 o Operator-pending mode
5808 i Insert mode
5809 l Language-Argument ("r", "f", "t", etc.)
5810 c Command-line mode
5811 When {mode} is omitted, "nvo" is used.
5812
5813 This function is useful to check if a mapping already exists
Bram Moolenaar58b85342016-08-14 19:54:54 +02005814 to a function in a Vim script. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815 :if !hasmapto('\ABCdoit')
5816 : map <Leader>d \ABCdoit
5817 :endif
5818< This installs the mapping to "\ABCdoit" only if there isn't
5819 already a mapping to "\ABCdoit".
5820
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02005821 Can also be used as a |method|: >
5822 GetRHS()->hasmapto()
5823
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824histadd({history}, {item}) *histadd()*
5825 Add the String {item} to the history {history} which can be
5826 one of: *hist-names*
5827 "cmd" or ":" command line history
5828 "search" or "/" search pattern history
Bram Moolenaar446cb832008-06-24 21:56:24 +00005829 "expr" or "=" typed expression history
Bram Moolenaar071d4272004-06-13 20:20:40 +00005830 "input" or "@" input line history
Bram Moolenaar30b65812012-07-12 22:01:11 +02005831 "debug" or ">" debug command history
Bram Moolenaar3e496b02016-09-25 22:11:48 +02005832 empty the current or last used history
Bram Moolenaar30b65812012-07-12 22:01:11 +02005833 The {history} string does not need to be the whole name, one
5834 character is sufficient.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835 If {item} does already exist in the history, it will be
5836 shifted to become the newest entry.
5837 The result is a Number: 1 if the operation was successful,
5838 otherwise 0 is returned.
5839
5840 Example: >
5841 :call histadd("input", strftime("%Y %b %d"))
5842 :let date=input("Enter date: ")
5843< This function is not available in the |sandbox|.
5844
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02005845 Can also be used as a |method|, the base is used for the
5846 second argument: >
Bram Moolenaar196b4662019-09-06 21:34:30 +02005847 GetHistory()->histadd('search')
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02005848
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849histdel({history} [, {item}]) *histdel()*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005850 Clear {history}, i.e. delete all its entries. See |hist-names|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851 for the possible values of {history}.
5852
Bram Moolenaarc236c162008-07-13 17:41:49 +00005853 If the parameter {item} evaluates to a String, it is used as a
5854 regular expression. All entries matching that expression will
5855 be removed from the history (if there are any).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856 Upper/lowercase must match, unless "\c" is used |/\c|.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005857 If {item} evaluates to a Number, it will be interpreted as
5858 an index, see |:history-indexing|. The respective entry will
5859 be removed if it exists.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005860
5861 The result is a Number: 1 for a successful operation,
5862 otherwise 0 is returned.
5863
5864 Examples:
5865 Clear expression register history: >
5866 :call histdel("expr")
5867<
5868 Remove all entries starting with "*" from the search history: >
5869 :call histdel("/", '^\*')
5870<
5871 The following three are equivalent: >
5872 :call histdel("search", histnr("search"))
5873 :call histdel("search", -1)
5874 :call histdel("search", '^'.histget("search", -1).'$')
5875<
5876 To delete the last search pattern and use the last-but-one for
5877 the "n" command and 'hlsearch': >
5878 :call histdel("search", -1)
5879 :let @/ = histget("search", -1)
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02005880<
5881 Can also be used as a |method|: >
5882 GetHistory()->histdel()
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883
5884histget({history} [, {index}]) *histget()*
5885 The result is a String, the entry with Number {index} from
5886 {history}. See |hist-names| for the possible values of
5887 {history}, and |:history-indexing| for {index}. If there is
5888 no such entry, an empty String is returned. When {index} is
5889 omitted, the most recent item from the history is used.
5890
5891 Examples:
5892 Redo the second last search from history. >
5893 :execute '/' . histget("search", -2)
5894
5895< Define an Ex command ":H {num}" that supports re-execution of
5896 the {num}th entry from the output of |:history|. >
5897 :command -nargs=1 H execute histget("cmd", 0+<args>)
5898<
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02005899 Can also be used as a |method|: >
5900 GetHistory()->histget()
5901
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902histnr({history}) *histnr()*
5903 The result is the Number of the current entry in {history}.
5904 See |hist-names| for the possible values of {history}.
5905 If an error occurred, -1 is returned.
5906
5907 Example: >
5908 :let inp_index = histnr("expr")
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02005909
5910< Can also be used as a |method|: >
5911 GetHistory()->histnr()
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912<
5913hlexists({name}) *hlexists()*
5914 The result is a Number, which is non-zero if a highlight group
5915 called {name} exists. This is when the group has been
5916 defined in some way. Not necessarily when highlighting has
5917 been defined for it, it may also have been used for a syntax
5918 item.
5919 *highlight_exists()*
5920 Obsolete name: highlight_exists().
5921
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02005922 Can also be used as a |method|: >
5923 GetName()->hlexists()
5924<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 *hlID()*
5926hlID({name}) The result is a Number, which is the ID of the highlight group
5927 with name {name}. When the highlight group doesn't exist,
5928 zero is returned.
5929 This can be used to retrieve information about the highlight
Bram Moolenaar58b85342016-08-14 19:54:54 +02005930 group. For example, to get the background color of the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005931 "Comment" group: >
5932 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
5933< *highlightID()*
5934 Obsolete name: highlightID().
5935
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02005936 Can also be used as a |method|: >
5937 GetName()->hlID()
5938
Bram Moolenaar071d4272004-06-13 20:20:40 +00005939hostname() *hostname()*
5940 The result is a String, which is the name of the machine on
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005941 which Vim is currently running. Machine names greater than
Bram Moolenaar071d4272004-06-13 20:20:40 +00005942 256 characters long are truncated.
5943
5944iconv({expr}, {from}, {to}) *iconv()*
5945 The result is a String, which is the text {expr} converted
5946 from encoding {from} to encoding {to}.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005947 When the conversion completely fails an empty string is
5948 returned. When some characters could not be converted they
5949 are replaced with "?".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 The encoding names are whatever the iconv() library function
5951 can accept, see ":!man 3 iconv".
5952 Most conversions require Vim to be compiled with the |+iconv|
5953 feature. Otherwise only UTF-8 to latin1 conversion and back
5954 can be done.
5955 This can be used to display messages with special characters,
5956 no matter what 'encoding' is set to. Write the message in
5957 UTF-8 and use: >
5958 echo iconv(utf8_str, "utf-8", &enc)
5959< Note that Vim uses UTF-8 for all Unicode encodings, conversion
5960 from/to UCS-2 is automatically changed to use UTF-8. You
5961 cannot use UCS-2 in a string anyway, because of the NUL bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005962
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02005963 Can also be used as a |method|: >
5964 GetText()->iconv('latin1', 'utf-8')
5965<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005966 *indent()*
5967indent({lnum}) The result is a Number, which is indent of line {lnum} in the
5968 current buffer. The indent is counted in spaces, the value
5969 of 'tabstop' is relevant. {lnum} is used just like in
5970 |getline()|.
5971 When {lnum} is invalid -1 is returned.
5972
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02005973 Can also be used as a |method|: >
5974 GetLnum()->indent()
Bram Moolenaarde8866b2005-01-06 23:24:37 +00005975
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01005976index({object}, {expr} [, {start} [, {ic}]]) *index()*
5977 If {object} is a |List| return the lowest index where the item
5978 has a value equal to {expr}. There is no automatic
5979 conversion, so the String "4" is different from the Number 4.
5980 And the number 4 is different from the Float 4.0. The value
5981 of 'ignorecase' is not used here, case always matters.
5982
5983 If {object} is |Blob| return the lowest index where the byte
5984 value is equal to {expr}.
5985
Bram Moolenaar748bf032005-02-02 23:04:36 +00005986 If {start} is given then start looking at the item with index
5987 {start} (may be negative for an item relative to the end).
Bram Moolenaare381d3d2016-07-07 14:50:41 +02005988 When {ic} is given and it is |TRUE|, ignore case. Otherwise
Bram Moolenaarde8866b2005-01-06 23:24:37 +00005989 case must match.
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01005990 -1 is returned when {expr} is not found in {object}.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00005991 Example: >
5992 :let idx = index(words, "the")
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00005993 :if index(numbers, 123) >= 0
Bram Moolenaarde8866b2005-01-06 23:24:37 +00005994
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02005995< Can also be used as a |method|: >
5996 GetObject()->index(what)
Bram Moolenaarde8866b2005-01-06 23:24:37 +00005997
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00005998input({prompt} [, {text} [, {completion}]]) *input()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999 The result is a String, which is whatever the user typed on
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006000 the command-line. The {prompt} argument is either a prompt
6001 string, or a blank string (for no prompt). A '\n' can be used
6002 in the prompt to start a new line.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006003 The highlighting set with |:echohl| is used for the prompt.
6004 The input is entered just like a command-line, with the same
Bram Moolenaar58b85342016-08-14 19:54:54 +02006005 editing commands and mappings. There is a separate history
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006006 for lines typed for input().
6007 Example: >
6008 :if input("Coffee or beer? ") == "beer"
6009 : echo "Cheers!"
6010 :endif
6011<
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006012 If the optional {text} argument is present and not empty, this
6013 is used for the default reply, as if the user typed this.
6014 Example: >
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006015 :let color = input("Color? ", "white")
6016
6017< The optional {completion} argument specifies the type of
6018 completion supported for the input. Without it completion is
Bram Moolenaar58b85342016-08-14 19:54:54 +02006019 not performed. The supported completion types are the same as
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006020 that can be supplied to a user-defined command using the
Bram Moolenaar58b85342016-08-14 19:54:54 +02006021 "-complete=" argument. Refer to |:command-completion| for
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006022 more information. Example: >
6023 let fname = input("File: ", "", "file")
6024<
6025 NOTE: This function must not be used in a startup file, for
6026 the versions that only run in GUI mode (e.g., the Win32 GUI).
Bram Moolenaar071d4272004-06-13 20:20:40 +00006027 Note: When input() is called from within a mapping it will
6028 consume remaining characters from that mapping, because a
6029 mapping is handled like the characters were typed.
6030 Use |inputsave()| before input() and |inputrestore()|
6031 after input() to avoid that. Another solution is to avoid
6032 that further characters follow in the mapping, e.g., by using
6033 |:execute| or |:normal|.
6034
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006035 Example with a mapping: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR>
6037 :function GetFoo()
6038 : call inputsave()
6039 : let g:Foo = input("enter search pattern: ")
6040 : call inputrestore()
6041 :endfunction
6042
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02006043< Can also be used as a |method|: >
6044 GetPrompt()->input()
6045
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006047 Like |input()|, but when the GUI is running and text dialogs
6048 are supported, a dialog window pops up to input the text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006049 Example: >
Bram Moolenaar2d17fa32012-10-21 00:45:18 +02006050 :let n = inputdialog("value for shiftwidth", shiftwidth())
6051 :if n != ""
6052 : let &sw = n
6053 :endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054< When the dialog is cancelled {cancelreturn} is returned. When
6055 omitted an empty string is returned.
6056 Hitting <Enter> works like pressing the OK button. Hitting
6057 <Esc> works like pressing the Cancel button.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006058 NOTE: Command-line completion is not supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02006060 Can also be used as a |method|: >
6061 GetPrompt()->inputdialog()
6062
Bram Moolenaar578b49e2005-09-10 19:22:57 +00006063inputlist({textlist}) *inputlist()*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006064 {textlist} must be a |List| of strings. This |List| is
6065 displayed, one string per line. The user will be prompted to
6066 enter a number, which is returned.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00006067 The user can also select an item by clicking on it with the
Bram Moolenaar58b85342016-08-14 19:54:54 +02006068 mouse. For the first string 0 is returned. When clicking
Bram Moolenaar578b49e2005-09-10 19:22:57 +00006069 above the first item a negative number is returned. When
6070 clicking on the prompt one more than the length of {textlist}
6071 is returned.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006072 Make sure {textlist} has less than 'lines' entries, otherwise
Bram Moolenaar58b85342016-08-14 19:54:54 +02006073 it won't work. It's a good idea to put the entry number at
Bram Moolenaaref2f6562007-05-06 13:32:59 +00006074 the start of the string. And put a prompt in the first item.
6075 Example: >
Bram Moolenaar578b49e2005-09-10 19:22:57 +00006076 let color = inputlist(['Select color:', '1. red',
6077 \ '2. green', '3. blue'])
6078
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02006079< Can also be used as a |method|: >
6080 GetChoices()->inputlist()
6081
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082inputrestore() *inputrestore()*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006083 Restore typeahead that was saved with a previous |inputsave()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 Should be called the same number of times inputsave() is
6085 called. Calling it more often is harmless though.
6086 Returns 1 when there is nothing to restore, 0 otherwise.
6087
6088inputsave() *inputsave()*
6089 Preserve typeahead (also from mappings) and clear it, so that
6090 a following prompt gets input from the user. Should be
6091 followed by a matching inputrestore() after the prompt. Can
6092 be used several times, in which case there must be just as
6093 many inputrestore() calls.
6094 Returns 1 when out of memory, 0 otherwise.
6095
6096inputsecret({prompt} [, {text}]) *inputsecret()*
6097 This function acts much like the |input()| function with but
6098 two exceptions:
6099 a) the user's response will be displayed as a sequence of
6100 asterisks ("*") thereby keeping the entry secret, and
6101 b) the user's response will not be recorded on the input
6102 |history| stack.
6103 The result is a String, which is whatever the user actually
6104 typed on the command-line in response to the issued prompt.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006105 NOTE: Command-line completion is not supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02006107 Can also be used as a |method|: >
6108 GetPrompt()->inputsecret()
6109
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01006110insert({object}, {item} [, {idx}]) *insert()*
6111 When {object} is a |List| or a |Blob| insert {item} at the start
6112 of it.
6113
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00006114 If {idx} is specified insert {item} before the item with index
Bram Moolenaar58b85342016-08-14 19:54:54 +02006115 {idx}. If {idx} is zero it goes before the first item, just
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00006116 like omitting {idx}. A negative {idx} is also possible, see
6117 |list-index|. -1 inserts just before the last item.
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01006118
6119 Returns the resulting |List| or |Blob|. Examples: >
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00006120 :let mylist = insert([2, 3, 5], 1)
6121 :call insert(mylist, 4, -1)
6122 :call insert(mylist, 6, len(mylist))
Bram Moolenaara14de3d2005-01-07 21:48:26 +00006123< The last example can be done simpler with |add()|.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006124 Note that when {item} is a |List| it is inserted as a single
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006125 item. Use |extend()| to concatenate |Lists|.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00006126
Bram Moolenaarac92e252019-08-03 21:58:38 +02006127 Can also be used as a |method|: >
6128 mylist->insert(item)
6129
Bram Moolenaard6e256c2011-12-14 15:32:50 +01006130invert({expr}) *invert()*
6131 Bitwise invert. The argument is converted to a number. A
6132 List, Dict or Float argument causes an error. Example: >
6133 :let bits = invert(bits)
Bram Moolenaar073e4b92019-08-18 23:01:56 +02006134< Can also be used as a |method|: >
6135 :let bits = bits->invert()
Bram Moolenaard6e256c2011-12-14 15:32:50 +01006136
Bram Moolenaar071d4272004-06-13 20:20:40 +00006137isdirectory({directory}) *isdirectory()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02006138 The result is a Number, which is |TRUE| when a directory
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139 with the name {directory} exists. If {directory} doesn't
Bram Moolenaare381d3d2016-07-07 14:50:41 +02006140 exist, or isn't a directory, the result is |FALSE|. {directory}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 is any expression, which is used as a String.
6142
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02006143 Can also be used as a |method|: >
6144 GetName()->isdirectory()
6145
Bram Moolenaarfda1bff2019-04-04 13:44:37 +02006146isinf({expr}) *isinf()*
6147 Return 1 if {expr} is a positive infinity, or -1 a negative
6148 infinity, otherwise 0. >
6149 :echo isinf(1.0 / 0.0)
6150< 1 >
6151 :echo isinf(-1.0 / 0.0)
6152< -1
6153
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02006154 Can also be used as a |method|: >
6155 Compute()->isinf()
6156<
Bram Moolenaarfda1bff2019-04-04 13:44:37 +02006157 {only available when compiled with the |+float| feature}
6158
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006159islocked({expr}) *islocked()* *E786*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02006160 The result is a Number, which is |TRUE| when {expr} is the
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006161 name of a locked variable.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006162 {expr} must be the name of a variable, |List| item or
6163 |Dictionary| entry, not the variable itself! Example: >
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006164 :let alist = [0, ['a', 'b'], 2, 3]
6165 :lockvar 1 alist
6166 :echo islocked('alist') " 1
6167 :echo islocked('alist[1]') " 0
6168
6169< When {expr} is a variable that does not exist you get an error
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00006170 message. Use |exists()| to check for existence.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00006171
Bram Moolenaarf9f24ce2019-08-31 21:17:39 +02006172 Can also be used as a |method|: >
6173 GetName()->islocked()
6174
Bram Moolenaarf3913272016-02-25 00:00:01 +01006175isnan({expr}) *isnan()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +02006176 Return |TRUE| if {expr} is a float with value NaN. >
Bram Moolenaarf3913272016-02-25 00:00:01 +01006177 echo isnan(0.0 / 0.0)
Bram Moolenaar0f248b02019-04-04 15:36:05 +02006178< 1
Bram Moolenaarf3913272016-02-25 00:00:01 +01006179
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02006180 Can also be used as a |method|: >
6181 Compute()->isnan()
6182<
Bram Moolenaarf3913272016-02-25 00:00:01 +01006183 {only available when compiled with the |+float| feature}
6184
Bram Moolenaar677ee682005-01-27 14:41:15 +00006185items({dict}) *items()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006186 Return a |List| with all the key-value pairs of {dict}. Each
6187 |List| item is a list with two items: the key of a {dict}
6188 entry and the value of this entry. The |List| is in arbitrary
Bram Moolenaar0d17f0d2019-01-22 22:20:38 +01006189 order. Also see |keys()| and |values()|.
6190 Example: >
6191 for [key, value] in items(mydict)
6192 echo key . ': ' . value
6193 endfor
Bram Moolenaar677ee682005-01-27 14:41:15 +00006194
Bram Moolenaarac92e252019-08-03 21:58:38 +02006195< Can also be used as a |method|: >
6196 mydict->items()
Bram Moolenaar38a55632016-02-15 22:07:32 +01006197
Bram Moolenaared997ad2019-07-21 16:42:00 +02006198job_ functions are documented here: |job-functions-details|
Bram Moolenaarf6f32c32016-03-12 19:03:59 +01006199
Bram Moolenaar835dc632016-02-07 14:27:38 +01006200
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00006201join({list} [, {sep}]) *join()*
6202 Join the items in {list} together into one String.
6203 When {sep} is specified it is put in between the items. If
6204 {sep} is omitted a single space is used.
6205 Note that {sep} is not added at the end. You might want to
6206 add it there too: >
6207 let lines = join(mylist, "\n") . "\n"
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006208< String items are used as-is. |Lists| and |Dictionaries| are
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00006209 converted into a string like with |string()|.
6210 The opposite function is |split()|.
6211
Bram Moolenaarac92e252019-08-03 21:58:38 +02006212 Can also be used as a |method|: >
6213 mylist->join()
6214
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01006215js_decode({string}) *js_decode()*
6216 This is similar to |json_decode()| with these differences:
Bram Moolenaar595e64e2016-02-07 19:19:53 +01006217 - Object key names do not have to be in quotes.
Bram Moolenaaree142ad2017-01-11 21:50:08 +01006218 - Strings can be in single quotes.
Bram Moolenaar595e64e2016-02-07 19:19:53 +01006219 - Empty items in an array (between two commas) are allowed and
6220 result in v:none items.
6221
Bram Moolenaar02b31112019-08-31 22:16:38 +02006222 Can also be used as a |method|: >
6223 ReadObject()->js_decode()
6224
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01006225js_encode({expr}) *js_encode()*
6226 This is similar to |json_encode()| with these differences:
Bram Moolenaar595e64e2016-02-07 19:19:53 +01006227 - Object key names are not in quotes.
6228 - v:none items in an array result in an empty item between
6229 commas.
6230 For example, the Vim object:
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01006231 [1,v:none,{"one":1},v:none] ~
Bram Moolenaar595e64e2016-02-07 19:19:53 +01006232 Will be encoded as:
6233 [1,,{one:1},,] ~
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01006234 While json_encode() would produce:
Bram Moolenaar595e64e2016-02-07 19:19:53 +01006235 [1,null,{"one":1},null] ~
6236 This encoding is valid for JavaScript. It is more efficient
6237 than JSON, especially when using an array with optional items.
6238
Bram Moolenaar02b31112019-08-31 22:16:38 +02006239 Can also be used as a |method|: >
6240 GetObject()->js_encode()
Bram Moolenaar595e64e2016-02-07 19:19:53 +01006241
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01006242json_decode({string}) *json_decode()*
Bram Moolenaar705ada12016-01-24 17:56:50 +01006243 This parses a JSON formatted string and returns the equivalent
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01006244 in Vim values. See |json_encode()| for the relation between
Bram Moolenaar705ada12016-01-24 17:56:50 +01006245 JSON and Vim values.
6246 The decoding is permissive:
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02006247 - A trailing comma in an array and object is ignored, e.g.
6248 "[1, 2, ]" is the same as "[1, 2]".
Bram Moolenaard09091d2019-01-17 16:07:22 +01006249 - Integer keys are accepted in objects, e.g. {1:2} is the
Bram Moolenaar0d17f0d2019-01-22 22:20:38 +01006250 same as {"1":2}.
Bram Moolenaar705ada12016-01-24 17:56:50 +01006251 - More floating point numbers are recognized, e.g. "1." for
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02006252 "1.0", or "001.2" for "1.2". Special floating point values
Bram Moolenaar5f6b3792019-01-12 14:24:27 +01006253 "Infinity", "-Infinity" and "NaN" (capitalization ignored)
6254 are accepted.
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02006255 - Leading zeroes in integer numbers are ignored, e.g. "012"
6256 for "12" or "-012" for "-12".
6257 - Capitalization is ignored in literal names null, true or
6258 false, e.g. "NULL" for "null", "True" for "true".
6259 - Control characters U+0000 through U+001F which are not
6260 escaped in strings are accepted, e.g. " " (tab
6261 character in string) for "\t".
Bram Moolenaar0d17f0d2019-01-22 22:20:38 +01006262 - An empty JSON expression or made of only spaces is accepted
6263 and results in v:none.
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +02006264 - Backslash in an invalid 2-character sequence escape is
6265 ignored, e.g. "\a" is decoded as "a".
6266 - A correct surrogate pair in JSON strings should normally be
6267 a 12 character sequence such as "\uD834\uDD1E", but
6268 json_decode() silently accepts truncated surrogate pairs
6269 such as "\uD834" or "\uD834\u"
6270 *E938*
6271 A duplicate key in an object, valid in rfc7159, is not
6272 accepted by json_decode() as the result must be a valid Vim
6273 type, e.g. this fails: {"a":"b", "a":"c"}
6274
Bram Moolenaar02b31112019-08-31 22:16:38 +02006275 Can also be used as a |method|: >
6276 ReadObject()->json_decode()
Bram Moolenaar520e1e42016-01-23 19:46:28 +01006277
Bram Moolenaar7823a3b2016-02-11 21:08:32 +01006278json_encode({expr}) *json_encode()*
Bram Moolenaar705ada12016-01-24 17:56:50 +01006279 Encode {expr} as JSON and return this as a string.
Bram Moolenaar520e1e42016-01-23 19:46:28 +01006280 The encoding is specified in:
Bram Moolenaar009d84a2016-01-28 14:12:00 +01006281 https://tools.ietf.org/html/rfc7159.html
Bram Moolenaar520e1e42016-01-23 19:46:28 +01006282 Vim values are converted as follows:
Bram Moolenaard09091d2019-01-17 16:07:22 +01006283 |Number| decimal number
6284 |Float| floating point number
Bram Moolenaar7ce686c2016-02-27 16:33:22 +01006285 Float nan "NaN"
6286 Float inf "Infinity"
Bram Moolenaar5f6b3792019-01-12 14:24:27 +01006287 Float -inf "-Infinity"
Bram Moolenaard09091d2019-01-17 16:07:22 +01006288 |String| in double quotes (possibly null)
6289 |Funcref| not possible, error
6290 |List| as an array (possibly null); when
Bram Moolenaar81edd172016-04-14 13:51:37 +02006291 used recursively: []
Bram Moolenaard09091d2019-01-17 16:07:22 +01006292 |Dict| as an object (possibly null); when
Bram Moolenaar81edd172016-04-14 13:51:37 +02006293 used recursively: {}
Bram Moolenaard09091d2019-01-17 16:07:22 +01006294 |Blob| as an array of the individual bytes
Bram Moolenaar520e1e42016-01-23 19:46:28 +01006295 v:false "false"
6296 v:true "true"
Bram Moolenaar595e64e2016-02-07 19:19:53 +01006297 v:none "null"
Bram Moolenaar520e1e42016-01-23 19:46:28 +01006298 v:null "null"
Bram Moolenaar7ce686c2016-02-27 16:33:22 +01006299 Note that NaN and Infinity are passed on as values. This is
6300 missing in the JSON standard, but several implementations do
6301 allow it. If not then you will get an error.
Bram Moolenaar520e1e42016-01-23 19:46:28 +01006302
Bram Moolenaar02b31112019-08-31 22:16:38 +02006303 Can also be used as a |method|: >
6304 GetObject()->json_encode()
6305
Bram Moolenaard8b02732005-01-14 21:48:43 +00006306keys({dict}) *keys()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006307 Return a |List| with all the keys of {dict}. The |List| is in
Bram Moolenaar0d17f0d2019-01-22 22:20:38 +01006308 arbitrary order. Also see |items()| and |values()|.
Bram Moolenaard8b02732005-01-14 21:48:43 +00006309
Bram Moolenaarac92e252019-08-03 21:58:38 +02006310 Can also be used as a |method|: >
6311 mydict->keys()
6312
6313< *len()* *E701*
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00006314len({expr}) The result is a Number, which is the length of the argument.
6315 When {expr} is a String or a Number the length in bytes is
6316 used, as with |strlen()|.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006317 When {expr} is a |List| the number of items in the |List| is
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00006318 returned.
Bram Moolenaard09091d2019-01-17 16:07:22 +01006319 When {expr} is a |Blob| the number of bytes is returned.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006320 When {expr} is a |Dictionary| the number of entries in the
6321 |Dictionary| is returned.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00006322 Otherwise an error is given.
6323
Bram Moolenaarac92e252019-08-03 21:58:38 +02006324 Can also be used as a |method|: >
6325 mylist->len()
6326
6327< *libcall()* *E364* *E368*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006328libcall({libname}, {funcname}, {argument})
6329 Call function {funcname} in the run-time library {libname}
6330 with single argument {argument}.
6331 This is useful to call functions in a library that you
6332 especially made to be used with Vim. Since only one argument
6333 is possible, calling standard library functions is rather
6334 limited.
6335 The result is the String returned by the function. If the
6336 function returns NULL, this will appear as an empty string ""
6337 to Vim.
6338 If the function returns a number, use libcallnr()!
6339 If {argument} is a number, it is passed to the function as an
6340 int; if {argument} is a string, it is passed as a
6341 null-terminated string.
6342 This function will fail in |restricted-mode|.
6343
6344 libcall() allows you to write your own 'plug-in' extensions to
6345 Vim without having to recompile the program. It is NOT a
6346 means to call system functions! If you try to do so Vim will
6347 very probably crash.
6348
6349 For Win32, the functions you write must be placed in a DLL
6350 and use the normal C calling convention (NOT Pascal which is
6351 used in Windows System DLLs). The function must take exactly
6352 one parameter, either a character pointer or a long integer,
6353 and must return a character pointer or NULL. The character
6354 pointer returned must point to memory that will remain valid
6355 after the function has returned (e.g. in static data in the
6356 DLL). If it points to allocated memory, that memory will
6357 leak away. Using a static buffer in the function should work,
6358 it's then freed when the DLL is unloaded.
6359
6360 WARNING: If the function returns a non-valid pointer, Vim may
Bram Moolenaar446cb832008-06-24 21:56:24 +00006361 crash! This also happens if the function returns a number,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 because Vim thinks it's a pointer.
6363 For Win32 systems, {libname} should be the filename of the DLL
6364 without the ".DLL" suffix. A full path is only required if
6365 the DLL is not in the usual places.
6366 For Unix: When compiling your own plugins, remember that the
6367 object code must be compiled as position-independent ('PIC').
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006368 {only in Win32 and some Unix versions, when the |+libcall|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006369 feature is present}
6370 Examples: >
6371 :echo libcall("libc.so", "getenv", "HOME")
Bram Moolenaar02b31112019-08-31 22:16:38 +02006372
6373< Can also be used as a |method|, where the base is passed as
6374 the argument to the called function: >
6375 GetValue()->libcall("libc.so", "getenv")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376<
6377 *libcallnr()*
6378libcallnr({libname}, {funcname}, {argument})
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006379 Just like |libcall()|, but used for a function that returns an
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 int instead of a string.
6381 {only in Win32 on some Unix versions, when the |+libcall|
6382 feature is present}
Bram Moolenaar446cb832008-06-24 21:56:24 +00006383 Examples: >
6384 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385 :call libcallnr("libc.so", "printf", "Hello World!\n")
6386 :call libcallnr("libc.so", "sleep", 10)
6387<
Bram Moolenaar02b31112019-08-31 22:16:38 +02006388 Can also be used as a |method|, where the base is passed as
6389 the argument to the called function: >
6390 GetValue()->libcallnr("libc.so", "printf")
6391<
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02006392
6393line({expr} [, {winid}]) *line()*
6394 The result is a Number, which is the line number of the file
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 position given with {expr}. The accepted positions are:
6396 . the cursor position
6397 $ the last line in the current buffer
6398 'x position of mark x (if the mark is not set, 0 is
6399 returned)
Bram Moolenaara1d5fa62017-04-03 22:02:55 +02006400 w0 first line visible in current window (one if the
6401 display isn't updated, e.g. in silent Ex mode)
6402 w$ last line visible in current window (this is one
6403 less than "w0" if no lines are visible)
Bram Moolenaar9ecd0232008-06-20 15:31:51 +00006404 v In Visual mode: the start of the Visual area (the
6405 cursor is the end). When not in Visual mode
6406 returns the cursor position. Differs from |'<| in
6407 that it's updated right away.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00006408 Note that a mark in another file can be used. The line number
6409 then applies to another buffer.
Bram Moolenaar0b238792006-03-02 22:49:12 +00006410 To get the column number use |col()|. To get both use
6411 |getpos()|.
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02006412 With the optional {winid} argument the values are obtained for
6413 that window instead of the current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 Examples: >
6415 line(".") line number of the cursor
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02006416 line(".", winid) idem, in window "winid"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006417 line("'t") line number of mark t
6418 line("'" . marker) line number of mark marker
Bram Moolenaar39536dd2019-01-29 22:58:21 +01006419<
6420 To jump to the last known position when opening a file see
6421 |last-position-jump|.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006422
Bram Moolenaar02b31112019-08-31 22:16:38 +02006423 Can also be used as a |method|: >
6424 GetValue()->line()
6425
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426line2byte({lnum}) *line2byte()*
6427 Return the byte count from the start of the buffer for line
6428 {lnum}. This includes the end-of-line character, depending on
6429 the 'fileformat' option for the current buffer. The first
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01006430 line returns 1. 'encoding' matters, 'fileencoding' is ignored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006431 This can also be used to get the byte count for the line just
6432 below the last line: >
6433 line2byte(line("$") + 1)
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01006434< This is the buffer size plus one. If 'fileencoding' is empty
6435 it is the file size plus one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 When {lnum} is invalid, or the |+byte_offset| feature has been
6437 disabled at compile time, -1 is returned.
6438 Also see |byte2line()|, |go| and |:goto|.
6439
Bram Moolenaar02b31112019-08-31 22:16:38 +02006440 Can also be used as a |method|: >
6441 GetLnum()->line2byte()
6442
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443lispindent({lnum}) *lispindent()*
6444 Get the amount of indent for line {lnum} according the lisp
6445 indenting rules, as with 'lisp'.
6446 The indent is counted in spaces, the value of 'tabstop' is
6447 relevant. {lnum} is used just like in |getline()|.
6448 When {lnum} is invalid or Vim was not compiled the
6449 |+lispindent| feature, -1 is returned.
6450
Bram Moolenaar02b31112019-08-31 22:16:38 +02006451 Can also be used as a |method|: >
6452 GetLnum()->lispindent()
6453
Bram Moolenaar9d401282019-04-06 13:18:12 +02006454list2str({list} [, {utf8}]) *list2str()*
6455 Convert each number in {list} to a character string can
6456 concatenate them all. Examples: >
6457 list2str([32]) returns " "
6458 list2str([65, 66, 67]) returns "ABC"
6459< The same can be done (slowly) with: >
6460 join(map(list, {nr, val -> nr2char(val)}), '')
6461< |str2list()| does the opposite.
6462
6463 When {utf8} is omitted or zero, the current 'encoding' is used.
6464 With {utf8} is 1, always return utf-8 characters.
6465 With utf-8 composing characters work as expected: >
6466 list2str([97, 769]) returns "á"
6467<
Bram Moolenaar02b31112019-08-31 22:16:38 +02006468 Can also be used as a |method|: >
6469 GetList()->list2str()
6470
Bram Moolenaara3347722019-05-11 21:14:24 +02006471listener_add({callback} [, {buf}]) *listener_add()*
6472 Add a callback function that will be invoked when changes have
6473 been made to buffer {buf}.
6474 {buf} refers to a buffer name or number. For the accepted
6475 values, see |bufname()|. When {buf} is omitted the current
6476 buffer is used.
6477 Returns a unique ID that can be passed to |listener_remove()|.
6478
Bram Moolenaaraad222c2019-09-06 22:46:09 +02006479 The {callback} is invoked with five arguments:
Bram Moolenaarfe1ade02019-05-14 21:20:36 +02006480 a:bufnr the buffer that was changed
6481 a:start first changed line number
6482 a:end first line number below the change
6483 a:added total number of lines added, negative if lines
6484 were deleted
6485 a:changes a List of items with details about the changes
6486
6487 Example: >
6488 func Listener(bufnr, start, end, added, changes)
6489 echo 'lines ' .. a:start .. ' until ' .. a:end .. ' changed'
6490 endfunc
6491 call listener_add('Listener', bufnr)
6492
6493< The List cannot be changed. Each item in a:changes is a
Bram Moolenaar8aad88d2019-05-12 13:53:50 +02006494 dictionary with these entries:
Bram Moolenaara3347722019-05-11 21:14:24 +02006495 lnum the first line number of the change
6496 end the first line below the change
6497 added number of lines added; negative if lines were
6498 deleted
6499 col first column in "lnum" that was affected by
6500 the change; one if unknown or the whole line
6501 was affected; this is a byte index, first
6502 character has a value of one.
6503 When lines are inserted the values are:
Bram Moolenaar68e65602019-05-26 21:33:31 +02006504 lnum line above which the new line is added
Bram Moolenaara3347722019-05-11 21:14:24 +02006505 end equal to "lnum"
6506 added number of lines inserted
Bram Moolenaarfe1ade02019-05-14 21:20:36 +02006507 col 1
Bram Moolenaara3347722019-05-11 21:14:24 +02006508 When lines are deleted the values are:
6509 lnum the first deleted line
6510 end the line below the first deleted line, before
6511 the deletion was done
6512 added negative, number of lines deleted
Bram Moolenaarfe1ade02019-05-14 21:20:36 +02006513 col 1
Bram Moolenaara3347722019-05-11 21:14:24 +02006514 When lines are changed:
6515 lnum the first changed line
6516 end the line below the last changed line
Bram Moolenaarfe1ade02019-05-14 21:20:36 +02006517 added 0
6518 col first column with a change or 1
Bram Moolenaara3347722019-05-11 21:14:24 +02006519
Bram Moolenaarfe1ade02019-05-14 21:20:36 +02006520 The entries are in the order the changes were made, thus the
6521 most recent change is at the end. The line numbers are valid
6522 when the callback is invoked, but later changes may make them
6523 invalid, thus keeping a copy for later might not work.
Bram Moolenaar8aad88d2019-05-12 13:53:50 +02006524
Bram Moolenaarfe1ade02019-05-14 21:20:36 +02006525 The {callback} is invoked just before the screen is updated,
6526 when |listener_flush()| is called or when a change is being
6527 made that changes the line count in a way it causes a line
6528 number in the list of changes to become invalid.
Bram Moolenaar8aad88d2019-05-12 13:53:50 +02006529
Bram Moolenaarfe1ade02019-05-14 21:20:36 +02006530 The {callback} is invoked with the text locked, see
6531 |textlock|. If you do need to make changes to the buffer, use
6532 a timer to do this later |timer_start()|.
Bram Moolenaara3347722019-05-11 21:14:24 +02006533
6534 The {callback} is not invoked when the buffer is first loaded.
6535 Use the |BufReadPost| autocmd event to handle the initial text
6536 of a buffer.
6537 The {callback} is also not invoked when the buffer is
6538 unloaded, use the |BufUnload| autocmd event for that.
6539
Bram Moolenaar02b31112019-08-31 22:16:38 +02006540 Can also be used as a |method|, where the base is passed as
6541 the second argument, the buffer: >
6542 GetBuffer()->listener_add(callback)
6543
Bram Moolenaarfe1ade02019-05-14 21:20:36 +02006544listener_flush([{buf}]) *listener_flush()*
6545 Invoke listener callbacks for buffer {buf}. If there are no
6546 pending changes then no callbacks are invoked.
6547
6548 {buf} refers to a buffer name or number. For the accepted
6549 values, see |bufname()|. When {buf} is omitted the current
6550 buffer is used.
6551
Bram Moolenaar02b31112019-08-31 22:16:38 +02006552 Can also be used as a |method|: >
6553 GetBuffer()->listener_flush()
6554
Bram Moolenaara3347722019-05-11 21:14:24 +02006555listener_remove({id}) *listener_remove()*
6556 Remove a listener previously added with listener_add().
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02006557 Returns zero when {id} could not be found, one when {id} was
6558 removed.
Bram Moolenaara3347722019-05-11 21:14:24 +02006559
Bram Moolenaar02b31112019-08-31 22:16:38 +02006560 Can also be used as a |method|: >
6561 GetListenerId()->listener_remove()
6562
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563localtime() *localtime()*
6564 Return the current time, measured as seconds since 1st Jan
6565 1970. See also |strftime()| and |getftime()|.
6566
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00006567
Bram Moolenaardb7c6862010-05-21 16:33:48 +02006568log({expr}) *log()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02006569 Return the natural logarithm (base e) of {expr} as a |Float|.
6570 {expr} must evaluate to a |Float| or a |Number| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02006571 (0, inf].
6572 Examples: >
6573 :echo log(10)
6574< 2.302585 >
6575 :echo log(exp(5))
6576< 5.0
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02006577
6578 Can also be used as a |method|: >
6579 Compute()->log()
6580<
Bram Moolenaardb84e452010-08-15 13:50:43 +02006581 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02006582
6583
Bram Moolenaar446cb832008-06-24 21:56:24 +00006584log10({expr}) *log10()*
6585 Return the logarithm of Float {expr} to base 10 as a |Float|.
6586 {expr} must evaluate to a |Float| or a |Number|.
6587 Examples: >
6588 :echo log10(1000)
6589< 3.0 >
6590 :echo log10(0.01)
6591< -2.0
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02006592
6593 Can also be used as a |method|: >
6594 Compute()->log10()
6595<
Bram Moolenaar446cb832008-06-24 21:56:24 +00006596 {only available when compiled with the |+float| feature}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006597
6598luaeval({expr} [, {expr}]) *luaeval()*
6599 Evaluate Lua expression {expr} and return its result converted
6600 to Vim data structures. Second {expr} may hold additional
Bram Moolenaard38b0552012-04-25 19:07:41 +02006601 argument accessible as _A inside first {expr}.
6602 Strings are returned as they are.
6603 Boolean objects are converted to numbers.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006604 Numbers are converted to |Float| values if vim was compiled
Bram Moolenaard38b0552012-04-25 19:07:41 +02006605 with |+float| and to numbers otherwise.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006606 Dictionaries and lists obtained by vim.eval() are returned
Bram Moolenaard38b0552012-04-25 19:07:41 +02006607 as-is.
6608 Other objects are returned as zero without any errors.
6609 See |lua-luaeval| for more details.
Bram Moolenaar02b31112019-08-31 22:16:38 +02006610
6611 Can also be used as a |method|: >
6612 GetExpr()->luaeval()
6613
6614< {only available when compiled with the |+lua| feature}
Bram Moolenaard38b0552012-04-25 19:07:41 +02006615
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02006616map({expr1}, {expr2}) *map()*
6617 {expr1} must be a |List| or a |Dictionary|.
6618 Replace each item in {expr1} with the result of evaluating
6619 {expr2}. {expr2} must be a |string| or |Funcref|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006620
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02006621 If {expr2} is a |string|, inside {expr2} |v:val| has the value
6622 of the current item. For a |Dictionary| |v:key| has the key
6623 of the current item and for a |List| |v:key| has the index of
6624 the current item.
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00006625 Example: >
6626 :call map(mylist, '"> " . v:val . " <"')
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00006627< This puts "> " before and " <" after each item in "mylist".
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00006628
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02006629 Note that {expr2} is the result of an expression and is then
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00006630 used as an expression again. Often it is good to use a
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00006631 |literal-string| to avoid having to double backslashes. You
6632 still have to double ' quotes
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00006633
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02006634 If {expr2} is a |Funcref| it is called with two arguments:
6635 1. The key or the index of the current item.
6636 2. the value of the current item.
6637 The function must return the new value of the item. Example
6638 that changes each value by "key-value": >
6639 func KeyValue(key, val)
6640 return a:key . '-' . a:val
6641 endfunc
6642 call map(myDict, function('KeyValue'))
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006643< It is shorter when using a |lambda|: >
6644 call map(myDict, {key, val -> key . '-' . val})
6645< If you do not use "val" you can leave it out: >
6646 call map(myDict, {key -> 'item: ' . key})
Bram Moolenaar088e8e32019-08-08 22:15:18 +02006647< If you do not use "key" you can use a short name: >
6648 call map(myDict, {_, val -> 'item: ' . val})
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02006649<
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006650 The operation is done in-place. If you want a |List| or
6651 |Dictionary| to remain unmodified make a copy first: >
Bram Moolenaar30b65812012-07-12 22:01:11 +02006652 :let tlist = map(copy(mylist), ' v:val . "\t"')
Bram Moolenaar2fda12f2005-01-15 22:14:15 +00006653
Bram Moolenaarb33c7eb2016-07-04 22:29:49 +02006654< Returns {expr1}, the |List| or |Dictionary| that was filtered.
6655 When an error is encountered while evaluating {expr2} no
6656 further items in {expr1} are processed. When {expr2} is a
6657 Funcref errors inside a function are ignored, unless it was
6658 defined with the "abort" flag.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00006659
Bram Moolenaarac92e252019-08-03 21:58:38 +02006660 Can also be used as a |method|: >
6661 mylist->map(expr2)
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00006662
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006663maparg({name} [, {mode} [, {abbr} [, {dict}]]]) *maparg()*
Bram Moolenaarbd743252010-10-20 21:23:33 +02006664 When {dict} is omitted or zero: Return the rhs of mapping
6665 {name} in mode {mode}. The returned String has special
6666 characters translated like in the output of the ":map" command
6667 listing.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006668
Bram Moolenaarbd743252010-10-20 21:23:33 +02006669 When there is no mapping for {name}, an empty String is
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02006670 returned. When the mapping for {name} is empty, then "<Nop>"
6671 is returned.
Bram Moolenaarbd743252010-10-20 21:23:33 +02006672
6673 The {name} can have special key names, like in the ":map"
6674 command.
6675
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006676 {mode} can be one of these strings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 "n" Normal
Bram Moolenaarbd743252010-10-20 21:23:33 +02006678 "v" Visual (including Select)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006679 "o" Operator-pending
6680 "i" Insert
6681 "c" Cmd-line
Bram Moolenaarbd743252010-10-20 21:23:33 +02006682 "s" Select
6683 "x" Visual
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 "l" langmap |language-mapping|
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006685 "t" Terminal-Job
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686 "" Normal, Visual and Operator-pending
Bram Moolenaard12f5c12006-01-25 22:10:52 +00006687 When {mode} is omitted, the modes for "" are used.
Bram Moolenaarbd743252010-10-20 21:23:33 +02006688
Bram Moolenaare381d3d2016-07-07 14:50:41 +02006689 When {abbr} is there and it is |TRUE| use abbreviations
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006690 instead of mappings.
Bram Moolenaarbd743252010-10-20 21:23:33 +02006691
Bram Moolenaare381d3d2016-07-07 14:50:41 +02006692 When {dict} is there and it is |TRUE| return a dictionary
Bram Moolenaarbd743252010-10-20 21:23:33 +02006693 containing all the information of the mapping with the
6694 following items:
6695 "lhs" The {lhs} of the mapping.
6696 "rhs" The {rhs} of the mapping as typed.
6697 "silent" 1 for a |:map-silent| mapping, else 0.
Bram Moolenaar05365702010-10-27 18:34:44 +02006698 "noremap" 1 if the {rhs} of the mapping is not remappable.
Bram Moolenaarbd743252010-10-20 21:23:33 +02006699 "expr" 1 for an expression mapping (|:map-<expr>|).
6700 "buffer" 1 for a buffer local mapping (|:map-local|).
6701 "mode" Modes for which the mapping is defined. In
6702 addition to the modes mentioned above, these
6703 characters will be used:
6704 " " Normal, Visual and Operator-pending
6705 "!" Insert and Commandline mode
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006706 (|mapmode-ic|)
Bram Moolenaar05365702010-10-27 18:34:44 +02006707 "sid" The script local ID, used for <sid> mappings
6708 (|<SID>|).
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02006709 "lnum" The line number in "sid", zero if unknown.
Bram Moolenaardfb18412013-12-11 18:53:29 +01006710 "nowait" Do not wait for other, longer mappings.
6711 (|:map-<nowait>|).
Bram Moolenaarbd743252010-10-20 21:23:33 +02006712
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 The mappings local to the current buffer are checked first,
6714 then the global mappings.
Bram Moolenaara40ceaf2006-01-13 22:35:40 +00006715 This function can be used to map a key even when it's already
6716 mapped, and have it do the original mapping too. Sketch: >
6717 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n')
6718
Bram Moolenaara1449832019-09-01 20:16:52 +02006719< Can also be used as a |method|: >
6720 GetKey()->maparg('n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006722mapcheck({name} [, {mode} [, {abbr}]]) *mapcheck()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 Check if there is a mapping that matches with {name} in mode
6724 {mode}. See |maparg()| for {mode} and special names in
6725 {name}.
Bram Moolenaare381d3d2016-07-07 14:50:41 +02006726 When {abbr} is there and it is |TRUE| use abbreviations
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006727 instead of mappings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 A match happens with a mapping that starts with {name} and
6729 with a mapping which is equal to the start of {name}.
6730
Bram Moolenaar446cb832008-06-24 21:56:24 +00006731 matches mapping "a" "ab" "abc" ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 mapcheck("a") yes yes yes
6733 mapcheck("abc") yes yes yes
6734 mapcheck("ax") yes no no
6735 mapcheck("b") no no no
6736
6737 The difference with maparg() is that mapcheck() finds a
6738 mapping that matches with {name}, while maparg() only finds a
6739 mapping for {name} exactly.
6740 When there is no mapping that starts with {name}, an empty
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02006741 String is returned. If there is one, the RHS of that mapping
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 is returned. If there are several mappings that start with
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02006743 {name}, the RHS of one of them is returned. This will be
6744 "<Nop>" if the RHS is empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745 The mappings local to the current buffer are checked first,
6746 then the global mappings.
6747 This function can be used to check if a mapping can be added
6748 without being ambiguous. Example: >
6749 :if mapcheck("_vv") == ""
6750 : map _vv :set guifont=7x13<CR>
6751 :endif
6752< This avoids adding the "_vv" mapping when there already is a
6753 mapping for "_v" or for "_vvv".
6754
Bram Moolenaara1449832019-09-01 20:16:52 +02006755 Can also be used as a |method|: >
6756 GetKey()->mapcheck('n')
6757
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006758match({expr}, {pat} [, {start} [, {count}]]) *match()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006759 When {expr} is a |List| then this returns the index of the
6760 first item where {pat} matches. Each item is used as a
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006761 String, |Lists| and |Dictionaries| are used as echoed.
Bram Moolenaar93a1df22018-09-10 11:51:50 +02006762
Bram Moolenaar58b85342016-08-14 19:54:54 +02006763 Otherwise, {expr} is used as a String. The result is a
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00006764 Number, which gives the index (byte offset) in {expr} where
6765 {pat} matches.
Bram Moolenaar93a1df22018-09-10 11:51:50 +02006766
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006767 A match at the first character or |List| item returns zero.
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00006768 If there is no match -1 is returned.
Bram Moolenaar93a1df22018-09-10 11:51:50 +02006769
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02006770 For getting submatches see |matchlist()|.
Bram Moolenaar89cb5e02004-07-19 20:55:54 +00006771 Example: >
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00006772 :echo match("testing", "ing") " results in 4
Bram Moolenaar362e1a32006-03-06 23:29:24 +00006773 :echo match([1, 'x'], '\a') " results in 1
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00006774< See |string-match| for how {pat} is used.
Bram Moolenaar05159a02005-02-26 23:04:13 +00006775 *strpbrk()*
Bram Moolenaar58b85342016-08-14 19:54:54 +02006776 Vim doesn't have a strpbrk() function. But you can do: >
Bram Moolenaar05159a02005-02-26 23:04:13 +00006777 :let sepidx = match(line, '[.,;: \t]')
6778< *strcasestr()*
6779 Vim doesn't have a strcasestr() function. But you can add
6780 "\c" to the pattern to ignore case: >
6781 :let idx = match(haystack, '\cneedle')
6782<
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00006783 If {start} is given, the search starts from byte index
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006784 {start} in a String or item {start} in a |List|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 The result, however, is still the index counted from the
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006786 first character/item. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 :echo match("testing", "ing", 2)
6788< result is again "4". >
6789 :echo match("testing", "ing", 4)
6790< result is again "4". >
6791 :echo match("testing", "t", 2)
6792< result is "3".
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00006793 For a String, if {start} > 0 then it is like the string starts
Bram Moolenaar0b238792006-03-02 22:49:12 +00006794 {start} bytes later, thus "^" will match at {start}. Except
6795 when {count} is given, then it's like matches before the
6796 {start} byte are ignored (this is a bit complicated to keep it
6797 backwards compatible).
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00006798 For a String, if {start} < 0, it will be set to 0. For a list
6799 the index is counted from the end.
Bram Moolenaare224ffa2006-03-01 00:01:28 +00006800 If {start} is out of range ({start} > strlen({expr}) for a
6801 String or {start} > len({expr}) for a |List|) -1 is returned.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00006802
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00006803 When {count} is given use the {count}'th match. When a match
Bram Moolenaare224ffa2006-03-01 00:01:28 +00006804 is found in a String the search for the next one starts one
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00006805 character further. Thus this example results in 1: >
6806 echo match("testing", "..", 0, 2)
6807< In a |List| the search continues in the next item.
Bram Moolenaar0b238792006-03-02 22:49:12 +00006808 Note that when {count} is added the way {start} works changes,
6809 see above.
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00006810
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 See |pattern| for the patterns that are accepted.
6812 The 'ignorecase' option is used to set the ignore-caseness of
Bram Moolenaar58b85342016-08-14 19:54:54 +02006813 the pattern. 'smartcase' is NOT used. The matching is always
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 done like 'magic' is set and 'cpoptions' is empty.
6815
Bram Moolenaara1449832019-09-01 20:16:52 +02006816 Can also be used as a |method|: >
6817 GetList()->match('word')
6818<
Bram Moolenaar95e51472018-07-28 16:55:56 +02006819 *matchadd()* *E798* *E799* *E801* *E957*
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006820matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
Bram Moolenaar6ee10162007-07-26 20:58:42 +00006821 Defines a pattern to be highlighted in the current window (a
6822 "match"). It will be highlighted with {group}. Returns an
6823 identification number (ID), which can be used to delete the
Bram Moolenaaraff74912019-03-30 18:11:49 +01006824 match using |matchdelete()|. The ID is bound to the window.
Bram Moolenaar8e69b4a2013-11-09 03:41:58 +01006825 Matching is case sensitive and magic, unless case sensitivity
6826 or magicness are explicitly overridden in {pattern}. The
6827 'magic', 'smartcase' and 'ignorecase' options are not used.
Bram Moolenaarf9132812015-07-21 19:19:13 +02006828 The "Conceal" value is special, it causes the match to be
6829 concealed.
Bram Moolenaar6ee10162007-07-26 20:58:42 +00006830
6831 The optional {priority} argument assigns a priority to the
Bram Moolenaar58b85342016-08-14 19:54:54 +02006832 match. A match with a high priority will have its
Bram Moolenaar6ee10162007-07-26 20:58:42 +00006833 highlighting overrule that of a match with a lower priority.
6834 A priority is specified as an integer (negative numbers are no
6835 exception). If the {priority} argument is not specified, the
6836 default priority is 10. The priority of 'hlsearch' is zero,
6837 hence all matches with a priority greater than zero will
6838 overrule it. Syntax highlighting (see 'syntax') is a separate
6839 mechanism, and regardless of the chosen priority a match will
6840 always overrule syntax highlighting.
6841
6842 The optional {id} argument allows the request for a specific
6843 match ID. If a specified ID is already taken, an error
6844 message will appear and the match will not be added. An ID
6845 is specified as a positive integer (zero excluded). IDs 1, 2
6846 and 3 are reserved for |:match|, |:2match| and |:3match|,
Bram Moolenaar6561d522015-07-21 15:48:27 +02006847 respectively. If the {id} argument is not specified or -1,
Bram Moolenaar6ee10162007-07-26 20:58:42 +00006848 |matchadd()| automatically chooses a free ID.
6849
Bram Moolenaar85084ef2016-01-17 22:26:33 +01006850 The optional {dict} argument allows for further custom
6851 values. Currently this is used to specify a match specific
Bram Moolenaar6561d522015-07-21 15:48:27 +02006852 conceal character that will be shown for |hl-Conceal|
6853 highlighted matches. The dict can have the following members:
6854
6855 conceal Special character to show instead of the
Bram Moolenaar6463ca22016-02-13 17:04:46 +01006856 match (only for |hl-Conceal| highlighted
Bram Moolenaar6561d522015-07-21 15:48:27 +02006857 matches, see |:syn-cchar|)
Bram Moolenaar95e51472018-07-28 16:55:56 +02006858 window Instead of the current window use the
6859 window with this number or window ID.
Bram Moolenaar6561d522015-07-21 15:48:27 +02006860
Bram Moolenaar6ee10162007-07-26 20:58:42 +00006861 The number of matches is not limited, as it is the case with
6862 the |:match| commands.
6863
6864 Example: >
6865 :highlight MyGroup ctermbg=green guibg=green
6866 :let m = matchadd("MyGroup", "TODO")
6867< Deletion of the pattern: >
6868 :call matchdelete(m)
6869
6870< A list of matches defined by |matchadd()| and |:match| are
Bram Moolenaar58b85342016-08-14 19:54:54 +02006871 available from |getmatches()|. All matches can be deleted in
Bram Moolenaar6ee10162007-07-26 20:58:42 +00006872 one operation by |clearmatches()|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006873
Bram Moolenaara1449832019-09-01 20:16:52 +02006874 Can also be used as a |method|: >
6875 GetGroup()->matchadd('TODO')
6876<
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02006877 *matchaddpos()*
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006878matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
Bram Moolenaarb3414592014-06-17 17:48:32 +02006879 Same as |matchadd()|, but requires a list of positions {pos}
6880 instead of a pattern. This command is faster than |matchadd()|
6881 because it does not require to handle regular expressions and
6882 sets buffer line boundaries to redraw screen. It is supposed
6883 to be used when fast match additions and deletions are
6884 required, for example to highlight matching parentheses.
6885
6886 The list {pos} can contain one of these items:
Bram Moolenaarb6da44a2014-06-25 18:15:22 +02006887 - A number. This whole line will be highlighted. The first
Bram Moolenaarb3414592014-06-17 17:48:32 +02006888 line has number 1.
6889 - A list with one number, e.g., [23]. The whole line with this
6890 number will be highlighted.
6891 - A list with two numbers, e.g., [23, 11]. The first number is
Bram Moolenaarb6da44a2014-06-25 18:15:22 +02006892 the line number, the second one is the column number (first
6893 column is 1, the value must correspond to the byte index as
6894 |col()| would return). The character at this position will
6895 be highlighted.
Bram Moolenaarb3414592014-06-17 17:48:32 +02006896 - A list with three numbers, e.g., [23, 11, 3]. As above, but
Bram Moolenaarb6da44a2014-06-25 18:15:22 +02006897 the third number gives the length of the highlight in bytes.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006898
Bram Moolenaarb3414592014-06-17 17:48:32 +02006899 The maximum number of positions is 8.
6900
6901 Example: >
6902 :highlight MyGroup ctermbg=green guibg=green
6903 :let m = matchaddpos("MyGroup", [[23, 24], 34])
6904< Deletion of the pattern: >
6905 :call matchdelete(m)
6906
6907< Matches added by |matchaddpos()| are returned by
6908 |getmatches()| with an entry "pos1", "pos2", etc., with the
6909 value a list like the {pos} item.
Bram Moolenaarb3414592014-06-17 17:48:32 +02006910
Bram Moolenaara1449832019-09-01 20:16:52 +02006911 Can also be used as a |method|: >
6912 GetGroup()->matchaddpos([23, 11])
6913
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006914matcharg({nr}) *matcharg()*
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006915 Selects the {nr} match item, as set with a |:match|,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006916 |:2match| or |:3match| command.
6917 Return a |List| with two elements:
6918 The name of the highlight group used
6919 The pattern used.
6920 When {nr} is not 1, 2 or 3 returns an empty |List|.
6921 When there is no match item set returns ['', ''].
Bram Moolenaar6ee10162007-07-26 20:58:42 +00006922 This is useful to save and restore a |:match|.
6923 Highlighting matches using the |:match| commands are limited
6924 to three matches. |matchadd()| does not have this limitation.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006925
Bram Moolenaara1449832019-09-01 20:16:52 +02006926 Can also be used as a |method|: >
6927 GetMatch()->matcharg()
6928
Bram Moolenaaraff74912019-03-30 18:11:49 +01006929matchdelete({id} [, {win}) *matchdelete()* *E802* *E803*
Bram Moolenaar6ee10162007-07-26 20:58:42 +00006930 Deletes a match with ID {id} previously defined by |matchadd()|
Bram Moolenaar446cb832008-06-24 21:56:24 +00006931 or one of the |:match| commands. Returns 0 if successful,
Bram Moolenaar6ee10162007-07-26 20:58:42 +00006932 otherwise -1. See example for |matchadd()|. All matches can
6933 be deleted in one operation by |clearmatches()|.
Bram Moolenaaraff74912019-03-30 18:11:49 +01006934 If {win} is specified, use the window with this number or
6935 window ID instead of the current window.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006936
Bram Moolenaara1449832019-09-01 20:16:52 +02006937 Can also be used as a |method|: >
6938 GetMatch()->matchdelete()
6939
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006940matchend({expr}, {pat} [, {start} [, {count}]]) *matchend()*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006941 Same as |match()|, but return the index of first character
6942 after the match. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943 :echo matchend("testing", "ing")
6944< results in "7".
Bram Moolenaar05159a02005-02-26 23:04:13 +00006945 *strspn()* *strcspn()*
6946 Vim doesn't have a strspn() or strcspn() function, but you can
6947 do it with matchend(): >
6948 :let span = matchend(line, '[a-zA-Z]')
6949 :let span = matchend(line, '[^a-zA-Z]')
6950< Except that -1 is returned when there are no matches.
6951
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006952 The {start}, if given, has the same meaning as for |match()|. >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953 :echo matchend("testing", "ing", 2)
6954< results in "7". >
6955 :echo matchend("testing", "ing", 5)
6956< result is "-1".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006957 When {expr} is a |List| the result is equal to |match()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006958
Bram Moolenaara1449832019-09-01 20:16:52 +02006959 Can also be used as a |method|: >
6960 GetText()->matchend('word')
6961
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006962matchlist({expr}, {pat} [, {start} [, {count}]]) *matchlist()*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006963 Same as |match()|, but return a |List|. The first item in the
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00006964 list is the matched string, same as what matchstr() would
6965 return. Following items are submatches, like "\1", "\2", etc.
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00006966 in |:substitute|. When an optional submatch didn't match an
6967 empty string is used. Example: >
6968 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')
6969< Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00006970 When there is no match an empty list is returned.
6971
Bram Moolenaara1449832019-09-01 20:16:52 +02006972 Can also be used as a |method|: >
6973 GetList()->matchlist('word')
6974
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006975matchstr({expr}, {pat} [, {start} [, {count}]]) *matchstr()*
Bram Moolenaar446cb832008-06-24 21:56:24 +00006976 Same as |match()|, but return the matched string. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006977 :echo matchstr("testing", "ing")
6978< results in "ing".
6979 When there is no match "" is returned.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006980 The {start}, if given, has the same meaning as for |match()|. >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 :echo matchstr("testing", "ing", 2)
6982< results in "ing". >
6983 :echo matchstr("testing", "ing", 5)
6984< result is "".
Bram Moolenaar32466aa2006-02-24 23:53:04 +00006985 When {expr} is a |List| then the matching item is returned.
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00006986 The type isn't changed, it's not necessarily a String.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987
Bram Moolenaara1449832019-09-01 20:16:52 +02006988 Can also be used as a |method|: >
6989 GetText()->matchstr('word')
6990
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01006991matchstrpos({expr}, {pat} [, {start} [, {count}]]) *matchstrpos()*
Bram Moolenaar7fed5c12016-03-29 23:10:31 +02006992 Same as |matchstr()|, but return the matched string, the start
6993 position and the end position of the match. Example: >
6994 :echo matchstrpos("testing", "ing")
6995< results in ["ing", 4, 7].
6996 When there is no match ["", -1, -1] is returned.
6997 The {start}, if given, has the same meaning as for |match()|. >
6998 :echo matchstrpos("testing", "ing", 2)
6999< results in ["ing", 4, 7]. >
7000 :echo matchstrpos("testing", "ing", 5)
7001< result is ["", -1, -1].
7002 When {expr} is a |List| then the matching item, the index
7003 of first item where {pat} matches, the start position and the
7004 end position of the match are returned. >
7005 :echo matchstrpos([1, '__x'], '\a')
7006< result is ["x", 1, 2, 3].
7007 The type isn't changed, it's not necessarily a String.
7008
Bram Moolenaara1449832019-09-01 20:16:52 +02007009 Can also be used as a |method|: >
7010 GetText()->matchstrpos('word')
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00007011 *max()*
Bram Moolenaar690afe12017-01-28 18:34:47 +01007012max({expr}) Return the maximum value of all items in {expr}.
7013 {expr} can be a list or a dictionary. For a dictionary,
7014 it returns the maximum of all values in the dictionary.
7015 If {expr} is neither a list nor a dictionary, or one of the
7016 items in {expr} cannot be used as a Number this results in
Bram Moolenaarf8be4612017-06-23 20:52:40 +02007017 an error. An empty |List| or |Dictionary| results in zero.
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00007018
Bram Moolenaarac92e252019-08-03 21:58:38 +02007019 Can also be used as a |method|: >
7020 mylist->max()
7021
7022< *min()*
Bram Moolenaar690afe12017-01-28 18:34:47 +01007023min({expr}) Return the minimum value of all items in {expr}.
7024 {expr} can be a list or a dictionary. For a dictionary,
7025 it returns the minimum of all values in the dictionary.
7026 If {expr} is neither a list nor a dictionary, or one of the
7027 items in {expr} cannot be used as a Number this results in
Bram Moolenaarf8be4612017-06-23 20:52:40 +02007028 an error. An empty |List| or |Dictionary| results in zero.
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00007029
Bram Moolenaarac92e252019-08-03 21:58:38 +02007030 Can also be used as a |method|: >
7031 mylist->min()
7032
7033< *mkdir()* *E739*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007034mkdir({name} [, {path} [, {prot}]])
7035 Create directory {name}.
Bram Moolenaar39536dd2019-01-29 22:58:21 +01007036
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007037 If {path} is "p" then intermediate directories are created as
7038 necessary. Otherwise it must be "".
Bram Moolenaar39536dd2019-01-29 22:58:21 +01007039
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007040 If {prot} is given it is used to set the protection bits of
7041 the new directory. The default is 0755 (rwxr-xr-x: r/w for
Bram Moolenaar58b85342016-08-14 19:54:54 +02007042 the user readable for others). Use 0700 to make it unreadable
Bram Moolenaared39e1d2008-08-09 17:55:22 +00007043 for others. This is only used for the last part of {name}.
7044 Thus if you create /tmp/foo/bar then /tmp/foo will be created
7045 with 0755.
7046 Example: >
7047 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700)
Bram Moolenaar39536dd2019-01-29 22:58:21 +01007048
Bram Moolenaared39e1d2008-08-09 17:55:22 +00007049< This function is not available in the |sandbox|.
Bram Moolenaar39536dd2019-01-29 22:58:21 +01007050
Bram Moolenaar78a16b02018-04-14 13:51:55 +02007051 There is no error if the directory already exists and the "p"
Bram Moolenaar39536dd2019-01-29 22:58:21 +01007052 flag is passed (since patch 8.0.1708). However, without the
7053 "p" option the call will fail.
7054
7055 The function result is a Number, which is 1 if the call was
7056 successful or 0 if the directory creation failed or partly
7057 failed.
7058
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007059 Not available on all systems. To check use: >
7060 :if exists("*mkdir")
Bram Moolenaara1449832019-09-01 20:16:52 +02007061
7062< Can also be used as a |method|: >
7063 GetName()->mkdir()
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007064<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065 *mode()*
Bram Moolenaar446cb832008-06-24 21:56:24 +00007066mode([expr]) Return a string that indicates the current mode.
Bram Moolenaar05bb9532008-07-04 09:44:11 +00007067 If [expr] is supplied and it evaluates to a non-zero Number or
7068 a non-empty String (|non-zero-arg|), then the full mode is
Bram Moolenaare381d3d2016-07-07 14:50:41 +02007069 returned, otherwise only the first letter is returned.
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02007070 Also see |state()|.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007071
Bram Moolenaar612cc382018-07-29 15:34:26 +02007072 n Normal, Terminal-Normal
7073 no Operator-pending
Bram Moolenaar5976f8f2018-12-27 23:44:44 +01007074 nov Operator-pending (forced characterwise |o_v|)
7075 noV Operator-pending (forced linewise |o_V|)
7076 noCTRL-V Operator-pending (forced blockwise |o_CTRL-V|);
Bram Moolenaar5b69c222019-01-11 14:50:06 +01007077 CTRL-V is one character
Bram Moolenaar612cc382018-07-29 15:34:26 +02007078 niI Normal using |i_CTRL-O| in |Insert-mode|
7079 niR Normal using |i_CTRL-O| in |Replace-mode|
7080 niV Normal using |i_CTRL-O| in |Virtual-Replace-mode|
7081 v Visual by character
7082 V Visual by line
7083 CTRL-V Visual blockwise
7084 s Select by character
7085 S Select by line
7086 CTRL-S Select blockwise
7087 i Insert
7088 ic Insert mode completion |compl-generic|
7089 ix Insert mode |i_CTRL-X| completion
7090 R Replace |R|
7091 Rc Replace mode completion |compl-generic|
7092 Rv Virtual Replace |gR|
7093 Rx Replace mode |i_CTRL-X| completion
7094 c Command-line editing
7095 cv Vim Ex mode |gQ|
7096 ce Normal Ex mode |Q|
7097 r Hit-enter prompt
7098 rm The -- more -- prompt
7099 r? A |:confirm| query of some sort
7100 ! Shell or external command is executing
7101 t Terminal-Job mode: keys go to the job
Bram Moolenaar446cb832008-06-24 21:56:24 +00007102 This is useful in the 'statusline' option or when used
7103 with |remote_expr()| In most other places it always returns
7104 "c" or "n".
Bram Moolenaar612cc382018-07-29 15:34:26 +02007105 Note that in the future more modes and more specific modes may
7106 be added. It's better not to compare the whole string but only
7107 the leading character(s).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007108 Also see |visualmode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109
Bram Moolenaara1449832019-09-01 20:16:52 +02007110 Can also be used as a |method|: >
7111 DoFull()->mode()
7112
Bram Moolenaar7e506b62010-01-19 15:55:06 +01007113mzeval({expr}) *mzeval()*
7114 Evaluate MzScheme expression {expr} and return its result
Bram Moolenaard38b0552012-04-25 19:07:41 +02007115 converted to Vim data structures.
Bram Moolenaar7e506b62010-01-19 15:55:06 +01007116 Numbers and strings are returned as they are.
7117 Pairs (including lists and improper lists) and vectors are
7118 returned as Vim |Lists|.
7119 Hash tables are represented as Vim |Dictionary| type with keys
7120 converted to strings.
7121 All other types are converted to string with display function.
7122 Examples: >
7123 :mz (define l (list 1 2 3))
7124 :mz (define h (make-hash)) (hash-set! h "list" l)
7125 :echo mzeval("l")
7126 :echo mzeval("h")
7127<
Bram Moolenaara1449832019-09-01 20:16:52 +02007128 Can also be used as a |method|: >
7129 GetExpr()->mzeval()
7130<
Bram Moolenaar7e506b62010-01-19 15:55:06 +01007131 {only available when compiled with the |+mzscheme| feature}
7132
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133nextnonblank({lnum}) *nextnonblank()*
7134 Return the line number of the first line at or below {lnum}
7135 that is not blank. Example: >
7136 if getline(nextnonblank(1)) =~ "Java"
7137< When {lnum} is invalid or there is no non-blank line at or
7138 below it, zero is returned.
7139 See also |prevnonblank()|.
7140
Bram Moolenaar3f4f3d82019-09-04 20:05:59 +02007141 Can also be used as a |method|: >
7142 GetLnum()->nextnonblank()
7143
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01007144nr2char({expr} [, {utf8}]) *nr2char()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145 Return a string with a single character, which has the number
7146 value {expr}. Examples: >
7147 nr2char(64) returns "@"
7148 nr2char(32) returns " "
Bram Moolenaard35d7842013-01-23 17:17:10 +01007149< When {utf8} is omitted or zero, the current 'encoding' is used.
7150 Example for "utf-8": >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151 nr2char(300) returns I with bow character
Bram Moolenaard35d7842013-01-23 17:17:10 +01007152< With {utf8} set to 1, always return utf-8 characters.
7153 Note that a NUL character in the file is specified with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154 nr2char(10), because NULs are represented with newline
7155 characters. nr2char(0) is a real NUL and terminates the
Bram Moolenaar383f9bc2005-01-19 22:18:32 +00007156 string, thus results in an empty string.
Bram Moolenaaraff74912019-03-30 18:11:49 +01007157 To turn a list of character numbers into a string: >
7158 let list = [65, 66, 67]
7159 let str = join(map(list, {_, val -> nr2char(val)}), '')
7160< Result: "ABC"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161
Bram Moolenaar3f4f3d82019-09-04 20:05:59 +02007162 Can also be used as a |method|: >
7163 GetNumber()->nr2char()
Bram Moolenaar073e4b92019-08-18 23:01:56 +02007164
Bram Moolenaard6e256c2011-12-14 15:32:50 +01007165or({expr}, {expr}) *or()*
7166 Bitwise OR on the two arguments. The arguments are converted
7167 to a number. A List, Dict or Float argument causes an error.
7168 Example: >
7169 :let bits = or(bits, 0x80)
Bram Moolenaar073e4b92019-08-18 23:01:56 +02007170< Can also be used as a |method|: >
7171 :let bits = bits->or(0x80)
Bram Moolenaard6e256c2011-12-14 15:32:50 +01007172
7173
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007174pathshorten({expr}) *pathshorten()*
7175 Shorten directory names in the path {expr} and return the
7176 result. The tail, the file name, is kept as-is. The other
7177 components in the path are reduced to single letters. Leading
7178 '~' and '.' characters are kept. Example: >
7179 :echo pathshorten('~/.vim/autoload/myfile.vim')
7180< ~/.v/a/myfile.vim ~
7181 It doesn't matter if the path exists or not.
7182
Bram Moolenaar3f4f3d82019-09-04 20:05:59 +02007183 Can also be used as a |method|: >
7184 GetDirectories()->pathshorten()
7185
Bram Moolenaare9b892e2016-01-17 21:15:58 +01007186perleval({expr}) *perleval()*
7187 Evaluate Perl expression {expr} in scalar context and return
7188 its result converted to Vim data structures. If value can't be
Bram Moolenaar85084ef2016-01-17 22:26:33 +01007189 converted, it is returned as a string Perl representation.
7190 Note: If you want an array or hash, {expr} must return a
7191 reference to it.
Bram Moolenaare9b892e2016-01-17 21:15:58 +01007192 Example: >
7193 :echo perleval('[1 .. 4]')
7194< [1, 2, 3, 4]
Bram Moolenaar3f4f3d82019-09-04 20:05:59 +02007195
7196 Can also be used as a |method|: >
7197 GetExpr()->perleval()
7198
7199< {only available when compiled with the |+perl| feature}
Bram Moolenaare9b892e2016-01-17 21:15:58 +01007200
Bram Moolenaar931a2772019-07-04 16:54:54 +02007201
7202popup_ functions are documented here: |popup-functions|.
7203
7204
Bram Moolenaar446cb832008-06-24 21:56:24 +00007205pow({x}, {y}) *pow()*
7206 Return the power of {x} to the exponent {y} as a |Float|.
7207 {x} and {y} must evaluate to a |Float| or a |Number|.
7208 Examples: >
7209 :echo pow(3, 3)
7210< 27.0 >
7211 :echo pow(2, 16)
7212< 65536.0 >
7213 :echo pow(32, 0.20)
7214< 2.0
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02007215
7216 Can also be used as a |method|: >
7217 Compute()->pow(3)
7218<
Bram Moolenaar446cb832008-06-24 21:56:24 +00007219 {only available when compiled with the |+float| feature}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01007220
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007221prevnonblank({lnum}) *prevnonblank()*
7222 Return the line number of the first line at or above {lnum}
7223 that is not blank. Example: >
7224 let ind = indent(prevnonblank(v:lnum - 1))
7225< When {lnum} is invalid or there is no non-blank line at or
7226 above it, zero is returned.
7227 Also see |nextnonblank()|.
7228
Bram Moolenaar3f4f3d82019-09-04 20:05:59 +02007229 Can also be used as a |method|: >
7230 GetLnum()->prevnonblank()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007231
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007232printf({fmt}, {expr1} ...) *printf()*
7233 Return a String with {fmt}, where "%" items are replaced by
7234 the formatted form of their respective arguments. Example: >
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007235 printf("%4d: E%d %.30s", lnum, errno, msg)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007236< May result in:
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007237 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007238
Bram Moolenaarfd8ca212019-08-10 00:13:30 +02007239 When used as a |method| the base is passed as the second
7240 argument: >
7241 Compute()->printf("result: %d")
7242
7243< Often used items are:
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007244 %s string
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01007245 %6S string right-aligned in 6 display cells
Bram Moolenaar98692072006-02-04 00:57:42 +00007246 %6s string right-aligned in 6 bytes
Bram Moolenaar446cb832008-06-24 21:56:24 +00007247 %.9s string truncated to 9 bytes
7248 %c single byte
7249 %d decimal number
7250 %5d decimal number padded with spaces to 5 characters
7251 %x hex number
7252 %04x hex number padded with zeros to at least 4 characters
7253 %X hex number using upper case letters
7254 %o octal number
Bram Moolenaar91984b92016-08-16 21:58:41 +02007255 %08b binary number padded with zeros to at least 8 chars
Bram Moolenaar04186092016-08-29 21:55:35 +02007256 %f floating point number as 12.23, inf, -inf or nan
7257 %F floating point number as 12.23, INF, -INF or NAN
7258 %e floating point number as 1.23e3, inf, -inf or nan
7259 %E floating point number as 1.23E3, INF, -INF or NAN
Bram Moolenaar446cb832008-06-24 21:56:24 +00007260 %g floating point number, as %f or %e depending on value
Bram Moolenaar3df01732017-02-17 22:47:16 +01007261 %G floating point number, as %F or %E depending on value
Bram Moolenaar446cb832008-06-24 21:56:24 +00007262 %% the % character itself
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007263
7264 Conversion specifications start with '%' and end with the
7265 conversion type. All other characters are copied unchanged to
7266 the result.
7267
7268 The "%" starts a conversion specification. The following
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007269 arguments appear in sequence:
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007270
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007271 % [flags] [field-width] [.precision] type
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007272
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007273 flags
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007274 Zero or more of the following flags:
7275
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007276 # The value should be converted to an "alternate
7277 form". For c, d, and s conversions, this option
7278 has no effect. For o conversions, the precision
7279 of the number is increased to force the first
7280 character of the output string to a zero (except
7281 if a zero value is printed with an explicit
7282 precision of zero).
Bram Moolenaar91984b92016-08-16 21:58:41 +02007283 For b and B conversions, a non-zero result has
7284 the string "0b" (or "0B" for B conversions)
7285 prepended to it.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007286 For x and X conversions, a non-zero result has
7287 the string "0x" (or "0X" for X conversions)
7288 prepended to it.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007289
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007290 0 (zero) Zero padding. For all conversions the converted
7291 value is padded on the left with zeros rather
7292 than blanks. If a precision is given with a
Bram Moolenaar91984b92016-08-16 21:58:41 +02007293 numeric conversion (d, b, B, o, x, and X), the 0
7294 flag is ignored.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007295
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007296 - A negative field width flag; the converted value
7297 is to be left adjusted on the field boundary.
7298 The converted value is padded on the right with
7299 blanks, rather than on the left with blanks or
7300 zeros. A - overrides a 0 if both are given.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007301
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007302 ' ' (space) A blank should be left before a positive
7303 number produced by a signed conversion (d).
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007304
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007305 + A sign must always be placed before a number
Bram Moolenaar58b85342016-08-14 19:54:54 +02007306 produced by a signed conversion. A + overrides
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007307 a space if both are used.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007308
7309 field-width
7310 An optional decimal digit string specifying a minimum
Bram Moolenaar98692072006-02-04 00:57:42 +00007311 field width. If the converted value has fewer bytes
7312 than the field width, it will be padded with spaces on
7313 the left (or right, if the left-adjustment flag has
7314 been given) to fill out the field width.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007315
7316 .precision
7317 An optional precision, in the form of a period '.'
7318 followed by an optional digit string. If the digit
7319 string is omitted, the precision is taken as zero.
7320 This gives the minimum number of digits to appear for
7321 d, o, x, and X conversions, or the maximum number of
Bram Moolenaar98692072006-02-04 00:57:42 +00007322 bytes to be printed from a string for s conversions.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007323 For floating point it is the number of digits after
7324 the decimal point.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007325
7326 type
7327 A character that specifies the type of conversion to
7328 be applied, see below.
7329
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007330 A field width or precision, or both, may be indicated by an
7331 asterisk '*' instead of a digit string. In this case, a
Bram Moolenaar58b85342016-08-14 19:54:54 +02007332 Number argument supplies the field width or precision. A
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007333 negative field width is treated as a left adjustment flag
7334 followed by a positive field width; a negative precision is
7335 treated as though it were missing. Example: >
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007336 :echo printf("%d: %.*s", nr, width, line)
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007337< This limits the length of the text used from "line" to
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007338 "width" bytes.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007339
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007340 The conversion specifiers and their meanings are:
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007341
Bram Moolenaar91984b92016-08-16 21:58:41 +02007342 *printf-d* *printf-b* *printf-B* *printf-o*
7343 *printf-x* *printf-X*
7344 dbBoxX The Number argument is converted to signed decimal
7345 (d), unsigned binary (b and B), unsigned octal (o), or
7346 unsigned hexadecimal (x and X) notation. The letters
7347 "abcdef" are used for x conversions; the letters
7348 "ABCDEF" are used for X conversions.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007349 The precision, if any, gives the minimum number of
7350 digits that must appear; if the converted value
7351 requires fewer digits, it is padded on the left with
7352 zeros.
7353 In no case does a non-existent or small field width
7354 cause truncation of a numeric field; if the result of
7355 a conversion is wider than the field width, the field
7356 is expanded to contain the conversion result.
Bram Moolenaar30567352016-08-27 21:25:44 +02007357 The 'h' modifier indicates the argument is 16 bits.
7358 The 'l' modifier indicates the argument is 32 bits.
7359 The 'L' modifier indicates the argument is 64 bits.
7360 Generally, these modifiers are not useful. They are
7361 ignored when type is known from the argument.
7362
7363 i alias for d
7364 D alias for ld
7365 U alias for lu
7366 O alias for lo
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007367
Bram Moolenaar446cb832008-06-24 21:56:24 +00007368 *printf-c*
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007369 c The Number argument is converted to a byte, and the
7370 resulting character is written.
7371
Bram Moolenaar446cb832008-06-24 21:56:24 +00007372 *printf-s*
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007373 s The text of the String argument is used. If a
7374 precision is specified, no more bytes than the number
7375 specified are used.
Bram Moolenaar7571d552016-08-18 22:54:46 +02007376 If the argument is not a String type, it is
7377 automatically converted to text with the same format
7378 as ":echo".
Bram Moolenaar0122c402015-02-03 19:13:34 +01007379 *printf-S*
Bram Moolenaar3ab72c52012-11-14 18:10:56 +01007380 S The text of the String argument is used. If a
7381 precision is specified, no more display cells than the
Bram Moolenaar4c92e752019-02-17 21:18:32 +01007382 number specified are used.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007383
Bram Moolenaar446cb832008-06-24 21:56:24 +00007384 *printf-f* *E807*
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01007385 f F The Float argument is converted into a string of the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007386 form 123.456. The precision specifies the number of
7387 digits after the decimal point. When the precision is
7388 zero the decimal point is omitted. When the precision
7389 is not specified 6 is used. A really big number
Bram Moolenaar04186092016-08-29 21:55:35 +02007390 (out of range or dividing by zero) results in "inf"
Bram Moolenaarf8be4612017-06-23 20:52:40 +02007391 or "-inf" with %f (INF or -INF with %F).
7392 "0.0 / 0.0" results in "nan" with %f (NAN with %F).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007393 Example: >
7394 echo printf("%.2f", 12.115)
7395< 12.12
7396 Note that roundoff depends on the system libraries.
7397 Use |round()| when in doubt.
7398
7399 *printf-e* *printf-E*
7400 e E The Float argument is converted into a string of the
7401 form 1.234e+03 or 1.234E+03 when using 'E'. The
7402 precision specifies the number of digits after the
7403 decimal point, like with 'f'.
7404
7405 *printf-g* *printf-G*
7406 g G The Float argument is converted like with 'f' if the
7407 value is between 0.001 (inclusive) and 10000000.0
7408 (exclusive). Otherwise 'e' is used for 'g' and 'E'
7409 for 'G'. When no precision is specified superfluous
7410 zeroes and '+' signs are removed, except for the zero
7411 immediately after the decimal point. Thus 10000000.0
7412 results in 1.0e7.
7413
7414 *printf-%*
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007415 % A '%' is written. No argument is converted. The
7416 complete conversion specification is "%%".
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007417
Bram Moolenaarc236c162008-07-13 17:41:49 +00007418 When a Number argument is expected a String argument is also
7419 accepted and automatically converted.
7420 When a Float or String argument is expected a Number argument
7421 is also accepted and automatically converted.
7422 Any other argument type results in an error message.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007423
Bram Moolenaar83bab712005-08-01 21:58:57 +00007424 *E766* *E767*
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007425 The number of {exprN} arguments must exactly match the number
7426 of "%" items. If there are not sufficient or too many
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00007427 arguments an error is given. Up to 18 arguments can be used.
Bram Moolenaar4be06f92005-07-29 22:36:03 +00007428
7429
Bram Moolenaarf2732452018-06-03 14:47:35 +02007430prompt_setcallback({buf}, {expr}) *prompt_setcallback()*
Bram Moolenaar0e5979a2018-06-17 19:36:33 +02007431 Set prompt callback for buffer {buf} to {expr}. When {expr}
7432 is an empty string the callback is removed. This has only
Bram Moolenaarf2732452018-06-03 14:47:35 +02007433 effect if {buf} has 'buftype' set to "prompt".
Bram Moolenaar0e5979a2018-06-17 19:36:33 +02007434
Bram Moolenaarf2732452018-06-03 14:47:35 +02007435 The callback is invoked when pressing Enter. The current
7436 buffer will always be the prompt buffer. A new line for a
7437 prompt is added before invoking the callback, thus the prompt
7438 for which the callback was invoked will be in the last but one
7439 line.
7440 If the callback wants to add text to the buffer, it must
7441 insert it above the last line, since that is where the current
7442 prompt is. This can also be done asynchronously.
7443 The callback is invoked with one argument, which is the text
7444 that was entered at the prompt. This can be an empty string
7445 if the user only typed Enter.
7446 Example: >
Bram Moolenaara8eee212019-08-24 22:14:58 +02007447 call prompt_setcallback(bufnr(), function('s:TextEntered'))
Bram Moolenaarf2732452018-06-03 14:47:35 +02007448 func s:TextEntered(text)
7449 if a:text == 'exit' || a:text == 'quit'
7450 stopinsert
7451 close
7452 else
7453 call append(line('$') - 1, 'Entered: "' . a:text . '"')
7454 " Reset 'modified' to allow the buffer to be closed.
7455 set nomodified
7456 endif
7457 endfunc
7458
Bram Moolenaar3f4f3d82019-09-04 20:05:59 +02007459< Can also be used as a |method|: >
7460 GetBuffer()->prompt_setcallback(callback)
7461
7462
Bram Moolenaar0e5979a2018-06-17 19:36:33 +02007463prompt_setinterrupt({buf}, {expr}) *prompt_setinterrupt()*
7464 Set a callback for buffer {buf} to {expr}. When {expr} is an
7465 empty string the callback is removed. This has only effect if
7466 {buf} has 'buftype' set to "prompt".
7467
7468 This callback will be invoked when pressing CTRL-C in Insert
7469 mode. Without setting a callback Vim will exit Insert mode,
7470 as in any buffer.
7471
Bram Moolenaar3f4f3d82019-09-04 20:05:59 +02007472 Can also be used as a |method|: >
7473 GetBuffer()->prompt_setinterrupt(callback)
7474
Bram Moolenaar0e5979a2018-06-17 19:36:33 +02007475prompt_setprompt({buf}, {text}) *prompt_setprompt()*
7476 Set prompt for buffer {buf} to {text}. You most likely want
7477 {text} to end in a space.
7478 The result is only visible if {buf} has 'buftype' set to
7479 "prompt". Example: >
Bram Moolenaara8eee212019-08-24 22:14:58 +02007480 call prompt_setprompt(bufnr(), 'command: ')
Bram Moolenaar98aefe72018-12-13 22:20:09 +01007481<
Bram Moolenaar3f4f3d82019-09-04 20:05:59 +02007482 Can also be used as a |method|: >
7483 GetBuffer()->prompt_setprompt('command: ')
7484
Bram Moolenaared997ad2019-07-21 16:42:00 +02007485prop_ functions are documented here: |text-prop-functions|.
Bram Moolenaarf2732452018-06-03 14:47:35 +02007486
Bram Moolenaare9bd5722019-08-17 19:36:06 +02007487pum_getpos() *pum_getpos()*
7488 If the popup menu (see |ins-completion-menu|) is not visible,
7489 returns an empty |Dictionary|, otherwise, returns a
7490 |Dictionary| with the following keys:
7491 height nr of items visible
7492 width screen cells
7493 row top screen row (0 first row)
7494 col leftmost screen column (0 first col)
7495 size total nr of items
7496 scrollbar |TRUE| if visible
7497
7498 The values are the same as in |v:event| during
7499 |CompleteChanged|.
7500
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007501pumvisible() *pumvisible()*
7502 Returns non-zero when the popup menu is visible, zero
7503 otherwise. See |ins-completion-menu|.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007504 This can be used to avoid some things that would remove the
7505 popup menu.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007506
Bram Moolenaar30b65812012-07-12 22:01:11 +02007507py3eval({expr}) *py3eval()*
7508 Evaluate Python expression {expr} and return its result
7509 converted to Vim data structures.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01007510 Numbers and strings are returned as they are (strings are
7511 copied though, Unicode strings are additionally converted to
Bram Moolenaar30b65812012-07-12 22:01:11 +02007512 'encoding').
7513 Lists are represented as Vim |List| type.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01007514 Dictionaries are represented as Vim |Dictionary| type with
Bram Moolenaar30b65812012-07-12 22:01:11 +02007515 keys converted to strings.
Bram Moolenaar3f4f3d82019-09-04 20:05:59 +02007516
7517 Can also be used as a |method|: >
7518 GetExpr()->py3eval()
7519
7520< {only available when compiled with the |+python3| feature}
Bram Moolenaar30b65812012-07-12 22:01:11 +02007521
7522 *E858* *E859*
7523pyeval({expr}) *pyeval()*
7524 Evaluate Python expression {expr} and return its result
7525 converted to Vim data structures.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01007526 Numbers and strings are returned as they are (strings are
Bram Moolenaar30b65812012-07-12 22:01:11 +02007527 copied though).
7528 Lists are represented as Vim |List| type.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01007529 Dictionaries are represented as Vim |Dictionary| type,
Bram Moolenaard09acef2012-09-21 14:54:30 +02007530 non-string keys result in error.
Bram Moolenaar3f4f3d82019-09-04 20:05:59 +02007531
7532 Can also be used as a |method|: >
7533 GetExpr()->pyeval()
7534
7535< {only available when compiled with the |+python| feature}
Bram Moolenaar30b65812012-07-12 22:01:11 +02007536
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01007537pyxeval({expr}) *pyxeval()*
7538 Evaluate Python expression {expr} and return its result
7539 converted to Vim data structures.
7540 Uses Python 2 or 3, see |python_x| and 'pyxversion'.
7541 See also: |pyeval()|, |py3eval()|
Bram Moolenaar3f4f3d82019-09-04 20:05:59 +02007542
7543 Can also be used as a |method|: >
7544 GetExpr()->pyxeval()
7545
7546< {only available when compiled with the |+python| or the
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01007547 |+python3| feature}
7548
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00007549 *E726* *E727*
Bram Moolenaard8b02732005-01-14 21:48:43 +00007550range({expr} [, {max} [, {stride}]]) *range()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007551 Returns a |List| with Numbers:
Bram Moolenaard8b02732005-01-14 21:48:43 +00007552 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
7553 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
7554 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
7555 {max}] (increasing {expr} with {stride} each time, not
7556 producing a value past {max}).
Bram Moolenaare7566042005-06-17 22:00:15 +00007557 When the maximum is one before the start the result is an
7558 empty list. When the maximum is more than one before the
7559 start this is an error.
Bram Moolenaard8b02732005-01-14 21:48:43 +00007560 Examples: >
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007561 range(4) " [0, 1, 2, 3]
Bram Moolenaard8b02732005-01-14 21:48:43 +00007562 range(2, 4) " [2, 3, 4]
7563 range(2, 9, 3) " [2, 5, 8]
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007564 range(2, -2, -1) " [2, 1, 0, -1, -2]
Bram Moolenaare7566042005-06-17 22:00:15 +00007565 range(0) " []
7566 range(2, 0) " error!
Bram Moolenaard8b02732005-01-14 21:48:43 +00007567<
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02007568 Can also be used as a |method|: >
7569 GetExpr()->range()
7570<
Bram Moolenaar543c9b12019-04-05 22:50:40 +02007571 *readdir()*
7572readdir({directory} [, {expr}])
7573 Return a list with file and directory names in {directory}.
Bram Moolenaar62e1bb42019-04-08 16:25:07 +02007574 You can also use |glob()| if you don't need to do complicated
7575 things, such as limiting the number of matches.
Bram Moolenaar543c9b12019-04-05 22:50:40 +02007576
7577 When {expr} is omitted all entries are included.
7578 When {expr} is given, it is evaluated to check what to do:
7579 If {expr} results in -1 then no further entries will
7580 be handled.
7581 If {expr} results in 0 then this entry will not be
7582 added to the list.
7583 If {expr} results in 1 then this entry will be added
7584 to the list.
7585 Each time {expr} is evaluated |v:val| is set to the entry name.
7586 When {expr} is a function the name is passed as the argument.
7587 For example, to get a list of files ending in ".txt": >
7588 readdir(dirname, {n -> n =~ '.txt$'})
7589< To skip hidden and backup files: >
7590 readdir(dirname, {n -> n !~ '^\.\|\~$'})
7591
7592< If you want to get a directory tree: >
7593 function! s:tree(dir)
7594 return {a:dir : map(readdir(a:dir),
7595 \ {_, x -> isdirectory(x) ?
7596 \ {x : s:tree(a:dir . '/' . x)} : x})}
7597 endfunction
7598 echo s:tree(".")
7599<
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02007600 Can also be used as a |method|: >
7601 GetDirName()->readdir()
7602<
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00007603 *readfile()*
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007604readfile({fname} [, {type} [, {max}]])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007605 Read file {fname} and return a |List|, each line of the file
Bram Moolenaar6100d022016-10-02 16:51:57 +02007606 as an item. Lines are broken at NL characters. Macintosh
7607 files separated with CR will result in a single long line
7608 (unless a NL appears somewhere).
Bram Moolenaar06583f12010-08-07 20:30:49 +02007609 All NUL characters are replaced with a NL character.
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007610 When {type} contains "b" binary mode is used:
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00007611 - When the last line ends in a NL an extra empty list item is
7612 added.
7613 - No CR characters are removed.
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007614 When {type} contains "B" a |Blob| is returned with the binary
7615 data of the file unmodified.
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00007616 Otherwise:
7617 - CR characters that appear before a NL are removed.
7618 - Whether the last line ends in a NL or not does not matter.
Bram Moolenaar06583f12010-08-07 20:30:49 +02007619 - When 'encoding' is Unicode any UTF-8 byte order mark is
7620 removed from the text.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007621 When {max} is given this specifies the maximum number of lines
7622 to be read. Useful if you only want to check the first ten
7623 lines of a file: >
7624 :for line in readfile(fname, '', 10)
7625 : if line =~ 'Date' | echo line | endif
7626 :endfor
Bram Moolenaar582fd852005-03-28 20:58:01 +00007627< When {max} is negative -{max} lines from the end of the file
7628 are returned, or as many as there are.
7629 When {max} is zero the result is an empty list.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007630 Note that without {max} the whole file is read into memory.
7631 Also note that there is no recognition of encoding. Read a
7632 file into a buffer if you need to.
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +00007633 When the file can't be opened an error message is given and
7634 the result is an empty list.
7635 Also see |writefile()|.
7636
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02007637 Can also be used as a |method|: >
7638 GetFileName()->readfile()
7639
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02007640reg_executing() *reg_executing()*
7641 Returns the single letter name of the register being executed.
7642 Returns an empty string when no register is being executed.
7643 See |@|.
7644
7645reg_recording() *reg_recording()*
7646 Returns the single letter name of the register being recorded.
Bram Moolenaar62e1bb42019-04-08 16:25:07 +02007647 Returns an empty string when not recording. See |q|.
Bram Moolenaar0b6d9112018-05-22 20:35:17 +02007648
Bram Moolenaar433f7c82006-03-21 21:29:36 +00007649reltime([{start} [, {end}]]) *reltime()*
7650 Return an item that represents a time value. The format of
7651 the item depends on the system. It can be passed to
Bram Moolenaar03413f42016-04-12 21:07:15 +02007652 |reltimestr()| to convert it to a string or |reltimefloat()|
7653 to convert to a Float.
Bram Moolenaar433f7c82006-03-21 21:29:36 +00007654 Without an argument it returns the current time.
7655 With one argument is returns the time passed since the time
7656 specified in the argument.
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00007657 With two arguments it returns the time passed between {start}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00007658 and {end}.
7659 The {start} and {end} arguments must be values returned by
7660 reltime().
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02007661
7662 Can also be used as a |method|: >
7663 GetStart()->reltime()
7664<
Bram Moolenaardb84e452010-08-15 13:50:43 +02007665 {only available when compiled with the |+reltime| feature}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00007666
Bram Moolenaar03413f42016-04-12 21:07:15 +02007667reltimefloat({time}) *reltimefloat()*
7668 Return a Float that represents the time value of {time}.
7669 Example: >
7670 let start = reltime()
7671 call MyFunction()
7672 let seconds = reltimefloat(reltime(start))
7673< See the note of reltimestr() about overhead.
7674 Also see |profiling|.
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02007675
7676 Can also be used as a |method|: >
7677 reltime(start)->reltimefloat()
7678
7679< {only available when compiled with the |+reltime| feature}
Bram Moolenaar03413f42016-04-12 21:07:15 +02007680
Bram Moolenaar433f7c82006-03-21 21:29:36 +00007681reltimestr({time}) *reltimestr()*
7682 Return a String that represents the time value of {time}.
7683 This is the number of seconds, a dot and the number of
7684 microseconds. Example: >
7685 let start = reltime()
7686 call MyFunction()
7687 echo reltimestr(reltime(start))
7688< Note that overhead for the commands will be added to the time.
7689 The accuracy depends on the system.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00007690 Leading spaces are used to make the string align nicely. You
7691 can use split() to remove it. >
7692 echo split(reltimestr(reltime(start)))[0]
7693< Also see |profiling|.
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02007694
7695 Can also be used as a |method|: >
7696 reltime(start)->reltimestr()
7697
7698< {only available when compiled with the |+reltime| feature}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00007699
Bram Moolenaar071d4272004-06-13 20:20:40 +00007700 *remote_expr()* *E449*
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +01007701remote_expr({server}, {string} [, {idvar} [, {timeout}]])
Bram Moolenaar58b85342016-08-14 19:54:54 +02007702 Send the {string} to {server}. The string is sent as an
Bram Moolenaar071d4272004-06-13 20:20:40 +00007703 expression and the result is returned after evaluation.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007704 The result must be a String or a |List|. A |List| is turned
7705 into a String by joining the items with a line break in
7706 between (not at the end), like with join(expr, "\n").
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +01007707 If {idvar} is present and not empty, it is taken as the name
7708 of a variable and a {serverid} for later use with
Bram Moolenaar6bb2cdf2018-02-24 19:53:53 +01007709 |remote_read()| is stored there.
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +01007710 If {timeout} is given the read times out after this many
7711 seconds. Otherwise a timeout of 600 seconds is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 See also |clientserver| |RemoteReply|.
7713 This function is not available in the |sandbox|.
7714 {only available when compiled with the |+clientserver| feature}
7715 Note: Any errors will cause a local error message to be issued
7716 and the result will be the empty string.
Bram Moolenaar01164a62017-11-02 22:58:42 +01007717
7718 Variables will be evaluated in the global namespace,
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01007719 independent of a function currently being active. Except
Bram Moolenaar01164a62017-11-02 22:58:42 +01007720 when in debug mode, then local function variables and
7721 arguments can be evaluated.
7722
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723 Examples: >
7724 :echo remote_expr("gvim", "2+2")
7725 :echo remote_expr("gvim1", "b:current_syntax")
7726<
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02007727 Can also be used as a |method|: >
7728 ServerName()->remote_expr(expr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729
7730remote_foreground({server}) *remote_foreground()*
7731 Move the Vim server with the name {server} to the foreground.
7732 This works like: >
7733 remote_expr({server}, "foreground()")
7734< Except that on Win32 systems the client does the work, to work
7735 around the problem that the OS doesn't always allow the server
7736 to bring itself to the foreground.
Bram Moolenaar9372a112005-12-06 19:59:18 +00007737 Note: This does not restore the window if it was minimized,
7738 like foreground() does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739 This function is not available in the |sandbox|.
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02007740
7741 Can also be used as a |method|: >
7742 ServerName()->remote_foreground()
7743
7744< {only in the Win32, Athena, Motif and GTK GUI versions and the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 Win32 console version}
7746
7747
7748remote_peek({serverid} [, {retvar}]) *remote_peek()*
7749 Returns a positive number if there are available strings
7750 from {serverid}. Copies any reply string into the variable
Bram Moolenaar58b85342016-08-14 19:54:54 +02007751 {retvar} if specified. {retvar} must be a string with the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752 name of a variable.
7753 Returns zero if none are available.
7754 Returns -1 if something is wrong.
7755 See also |clientserver|.
7756 This function is not available in the |sandbox|.
7757 {only available when compiled with the |+clientserver| feature}
7758 Examples: >
7759 :let repl = ""
7760 :echo "PEEK: ".remote_peek(id, "repl").": ".repl
7761
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02007762< Can also be used as a |method|: >
7763 ServerId()->remote_peek()
7764
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +01007765remote_read({serverid}, [{timeout}]) *remote_read()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007766 Return the oldest available reply from {serverid} and consume
Bram Moolenaar81b9d0b2017-03-19 21:20:53 +01007767 it. Unless a {timeout} in seconds is given, it blocks until a
7768 reply is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007769 See also |clientserver|.
7770 This function is not available in the |sandbox|.
7771 {only available when compiled with the |+clientserver| feature}
7772 Example: >
7773 :echo remote_read(id)
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02007774
7775< Can also be used as a |method|: >
7776 ServerId()->remote_read()
Bram Moolenaar071d4272004-06-13 20:20:40 +00007777<
7778 *remote_send()* *E241*
7779remote_send({server}, {string} [, {idvar}])
Bram Moolenaar58b85342016-08-14 19:54:54 +02007780 Send the {string} to {server}. The string is sent as input
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007781 keys and the function returns immediately. At the Vim server
7782 the keys are not mapped |:map|.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007783 If {idvar} is present, it is taken as the name of a variable
7784 and a {serverid} for later use with remote_read() is stored
7785 there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786 See also |clientserver| |RemoteReply|.
7787 This function is not available in the |sandbox|.
7788 {only available when compiled with the |+clientserver| feature}
Bram Moolenaar7416f3e2017-03-18 18:10:13 +01007789
Bram Moolenaar071d4272004-06-13 20:20:40 +00007790 Note: Any errors will be reported in the server and may mess
7791 up the display.
7792 Examples: >
7793 :echo remote_send("gvim", ":DropAndReply ".file, "serverid").
7794 \ remote_read(serverid)
7795
7796 :autocmd NONE RemoteReply *
7797 \ echo remote_read(expand("<amatch>"))
7798 :echo remote_send("gvim", ":sleep 10 | echo ".
7799 \ 'server2client(expand("<client>"), "HELLO")<CR>')
Bram Moolenaara14de3d2005-01-07 21:48:26 +00007800<
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02007801 Can also be used as a |method|: >
7802 ServerName()->remote_send(keys)
7803<
Bram Moolenaar7416f3e2017-03-18 18:10:13 +01007804 *remote_startserver()* *E941* *E942*
7805remote_startserver({name})
7806 Become the server {name}. This fails if already running as a
7807 server, when |v:servername| is not empty.
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02007808
7809 Can also be used as a |method|: >
7810 ServerName()->remote_startserver()
7811
7812< {only available when compiled with the |+clientserver| feature}
Bram Moolenaar7416f3e2017-03-18 18:10:13 +01007813
Bram Moolenaarde8866b2005-01-06 23:24:37 +00007814remove({list}, {idx} [, {end}]) *remove()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007815 Without {end}: Remove the item at {idx} from |List| {list} and
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007816 return the item.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00007817 With {end}: Remove items from {idx} to {end} (inclusive) and
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007818 return a List with these items. When {idx} points to the same
Bram Moolenaarde8866b2005-01-06 23:24:37 +00007819 item as {end} a list with one item is returned. When {end}
7820 points to an item before {idx} this is an error.
7821 See |list-index| for possible values of {idx} and {end}.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00007822 Example: >
7823 :echo "last item: " . remove(mylist, -1)
Bram Moolenaarde8866b2005-01-06 23:24:37 +00007824 :call remove(mylist, 0, 9)
Bram Moolenaar39536dd2019-01-29 22:58:21 +01007825<
7826 Use |delete()| to remove a file.
7827
Bram Moolenaarac92e252019-08-03 21:58:38 +02007828 Can also be used as a |method|: >
7829 mylist->remove(idx)
7830
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007831remove({blob}, {idx} [, {end}])
7832 Without {end}: Remove the byte at {idx} from |Blob| {blob} and
7833 return the byte.
7834 With {end}: Remove bytes from {idx} to {end} (inclusive) and
7835 return a |Blob| with these bytes. When {idx} points to the same
7836 byte as {end} a |Blob| with one byte is returned. When {end}
7837 points to a byte before {idx} this is an error.
7838 Example: >
7839 :echo "last byte: " . remove(myblob, -1)
7840 :call remove(mylist, 0, 9)
Bram Moolenaar39536dd2019-01-29 22:58:21 +01007841
Bram Moolenaard8b02732005-01-14 21:48:43 +00007842remove({dict}, {key})
Bram Moolenaar54775062019-07-31 21:07:14 +02007843 Remove the entry from {dict} with key {key} and return it.
7844 Example: >
Bram Moolenaard8b02732005-01-14 21:48:43 +00007845 :echo "removed " . remove(dict, "one")
7846< If there is no {key} in {dict} this is an error.
7847
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848rename({from}, {to}) *rename()*
7849 Rename the file by the name {from} to the name {to}. This
7850 should also work to move files across file systems. The
7851 result is a Number, which is 0 if the file was renamed
7852 successfully, and non-zero when the renaming failed.
Bram Moolenaar798b30b2009-04-22 10:56:16 +00007853 NOTE: If {to} exists it is overwritten without warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 This function is not available in the |sandbox|.
7855
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02007856 Can also be used as a |method|: >
7857 GetOldName()->rename(newname)
7858
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00007859repeat({expr}, {count}) *repeat()*
7860 Repeat {expr} {count} times and return the concatenated
7861 result. Example: >
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00007862 :let separator = repeat('-', 80)
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00007863< When {count} is zero or negative the result is empty.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00007864 When {expr} is a |List| the result is {expr} concatenated
Bram Moolenaar58b85342016-08-14 19:54:54 +02007865 {count} times. Example: >
Bram Moolenaarde8866b2005-01-06 23:24:37 +00007866 :let longlist = repeat(['a', 'b'], 3)
7867< Results in ['a', 'b', 'a', 'b', 'a', 'b'].
Bram Moolenaarab79bcb2004-07-18 21:34:53 +00007868
Bram Moolenaarac92e252019-08-03 21:58:38 +02007869 Can also be used as a |method|: >
7870 mylist->repeat(count)
Bram Moolenaara14de3d2005-01-07 21:48:26 +00007871
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872resolve({filename}) *resolve()* *E655*
7873 On MS-Windows, when {filename} is a shortcut (a .lnk file),
7874 returns the path the shortcut points to in a simplified form.
Bram Moolenaardce1e892019-02-10 23:18:53 +01007875 When {filename} is a symbolic link or junction point, return
7876 the full path to the target. If the target of junction is
7877 removed, return {filename}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 On Unix, repeat resolving symbolic links in all path
7879 components of {filename} and return the simplified result.
7880 To cope with link cycles, resolving of symbolic links is
7881 stopped after 100 iterations.
7882 On other systems, return the simplified {filename}.
7883 The simplification step is done as by |simplify()|.
7884 resolve() keeps a leading path component specifying the
7885 current directory (provided the result is still a relative
7886 path name) and also keeps a trailing path separator.
7887
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02007888 Can also be used as a |method|: >
7889 GetName()->resolve()
Bram Moolenaarac92e252019-08-03 21:58:38 +02007890
7891reverse({object}) *reverse()*
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +01007892 Reverse the order of items in {object} in-place.
7893 {object} can be a |List| or a |Blob|.
7894 Returns {object}.
7895 If you want an object to remain unmodified make a copy first: >
Bram Moolenaara14de3d2005-01-07 21:48:26 +00007896 :let revlist = reverse(copy(mylist))
Bram Moolenaarac92e252019-08-03 21:58:38 +02007897< Can also be used as a |method|: >
7898 mylist->reverse()
Bram Moolenaara14de3d2005-01-07 21:48:26 +00007899
Bram Moolenaar446cb832008-06-24 21:56:24 +00007900round({expr}) *round()*
Bram Moolenaarc236c162008-07-13 17:41:49 +00007901 Round off {expr} to the nearest integral value and return it
Bram Moolenaar446cb832008-06-24 21:56:24 +00007902 as a |Float|. If {expr} lies halfway between two integral
7903 values, then use the larger one (away from zero).
7904 {expr} must evaluate to a |Float| or a |Number|.
7905 Examples: >
7906 echo round(0.456)
7907< 0.0 >
7908 echo round(4.5)
7909< 5.0 >
7910 echo round(-4.5)
7911< -5.0
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02007912
7913 Can also be used as a |method|: >
7914 Compute()->round()
7915<
Bram Moolenaar446cb832008-06-24 21:56:24 +00007916 {only available when compiled with the |+float| feature}
Bram Moolenaar34feacb2012-12-05 19:01:43 +01007917
Bram Moolenaare99be0e2019-03-26 22:51:09 +01007918rubyeval({expr}) *rubyeval()*
7919 Evaluate Ruby expression {expr} and return its result
7920 converted to Vim data structures.
7921 Numbers, floats and strings are returned as they are (strings
7922 are copied though).
7923 Arrays are represented as Vim |List| type.
7924 Hashes are represented as Vim |Dictionary| type.
7925 Other objects are represented as strings resulted from their
7926 "Object#to_s" method.
Bram Moolenaara0d1fef2019-09-04 22:29:14 +02007927
7928 Can also be used as a |method|: >
7929 GetRubyExpr()->rubyeval()
7930
7931< {only available when compiled with the |+ruby| feature}
Bram Moolenaare99be0e2019-03-26 22:51:09 +01007932
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01007933screenattr({row}, {col}) *screenattr()*
Bram Moolenaar36f44c22016-08-28 18:17:20 +02007934 Like |screenchar()|, but return the attribute. This is a rather
Bram Moolenaar9a773482013-06-11 18:40:13 +02007935 arbitrary number that can only be used to compare to the
7936 attribute at other positions.
7937
Bram Moolenaar196b4662019-09-06 21:34:30 +02007938 Can also be used as a |method|: >
7939 GetRow()->screenattr(col)
7940
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01007941screenchar({row}, {col}) *screenchar()*
Bram Moolenaar9a773482013-06-11 18:40:13 +02007942 The result is a Number, which is the character at position
7943 [row, col] on the screen. This works for every possible
7944 screen position, also status lines, window separators and the
7945 command line. The top left position is row one, column one
7946 The character excludes composing characters. For double-byte
7947 encodings it may only be the first byte.
7948 This is mainly to be used for testing.
7949 Returns -1 when row or col is out of range.
7950
Bram Moolenaar196b4662019-09-06 21:34:30 +02007951 Can also be used as a |method|: >
7952 GetRow()->screenchar(col)
7953
Bram Moolenaar2912abb2019-03-29 14:16:42 +01007954screenchars({row}, {col}) *screenchars()*
7955 The result is a List of Numbers. The first number is the same
7956 as what |screenchar()| returns. Further numbers are
7957 composing characters on top of the base character.
7958 This is mainly to be used for testing.
7959 Returns an empty List when row or col is out of range.
7960
Bram Moolenaar196b4662019-09-06 21:34:30 +02007961 Can also be used as a |method|: >
7962 GetRow()->screenchars(col)
7963
Bram Moolenaar34feacb2012-12-05 19:01:43 +01007964screencol() *screencol()*
7965 The result is a Number, which is the current screen column of
7966 the cursor. The leftmost column has number 1.
7967 This function is mainly used for testing.
7968
7969 Note: Always returns the current screen column, thus if used
7970 in a command (e.g. ":echo screencol()") it will return the
7971 column inside the command line, which is 1 when the command is
7972 executed. To get the cursor position in the file use one of
7973 the following mappings: >
7974 nnoremap <expr> GG ":echom ".screencol()."\n"
7975 nnoremap <silent> GG :echom screencol()<CR>
7976<
Bram Moolenaarb3d17a22019-07-07 18:28:14 +02007977screenpos({winid}, {lnum}, {col}) *screenpos()*
7978 The result is a Dict with the screen position of the text
7979 character in window {winid} at buffer line {lnum} and column
7980 {col}. {col} is a one-based byte index.
7981 The Dict has these members:
7982 row screen row
7983 col first screen column
7984 endcol last screen column
7985 curscol cursor screen column
7986 If the specified position is not visible, all values are zero.
7987 The "endcol" value differs from "col" when the character
7988 occupies more than one screen cell. E.g. for a Tab "col" can
7989 be 1 and "endcol" can be 8.
7990 The "curscol" value is where the cursor would be placed. For
7991 a Tab it would be the same as "endcol", while for a double
7992 width character it would be the same as "col".
7993
Bram Moolenaar196b4662019-09-06 21:34:30 +02007994 Can also be used as a |method|: >
7995 GetWinid()->screenpos(lnum, col)
7996
Bram Moolenaar34feacb2012-12-05 19:01:43 +01007997screenrow() *screenrow()*
7998 The result is a Number, which is the current screen row of the
7999 cursor. The top line has number one.
8000 This function is mainly used for testing.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02008001 Alternatively you can use |winline()|.
Bram Moolenaar34feacb2012-12-05 19:01:43 +01008002
8003 Note: Same restrictions as with |screencol()|.
8004
Bram Moolenaar2912abb2019-03-29 14:16:42 +01008005screenstring({row}, {col}) *screenstring()*
8006 The result is a String that contains the base character and
8007 any composing characters at position [row, col] on the screen.
8008 This is like |screenchars()| but returning a String with the
8009 characters.
8010 This is mainly to be used for testing.
8011 Returns an empty String when row or col is out of range.
8012
Bram Moolenaar196b4662019-09-06 21:34:30 +02008013 Can also be used as a |method|: >
8014 GetRow()->screenstring(col)
8015
Bram Moolenaar76929292008-01-06 19:07:36 +00008016search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017 Search for regexp pattern {pattern}. The search starts at the
Bram Moolenaar383f9bc2005-01-19 22:18:32 +00008018 cursor position (you can use |cursor()| to set it).
Bram Moolenaar65c923a2006-03-03 22:56:30 +00008019
Bram Moolenaar2df58b42012-11-28 18:21:11 +01008020 When a match has been found its line number is returned.
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01008021 If there is no match a 0 is returned and the cursor doesn't
8022 move. No error message is given.
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01008023
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 {flags} is a String, which can contain these character flags:
Bram Moolenaarad4d8a12015-12-28 19:20:36 +01008025 'b' search Backward instead of forward
8026 'c' accept a match at the Cursor position
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008027 'e' move to the End of the match
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00008028 'n' do Not move the cursor
Bram Moolenaarad4d8a12015-12-28 19:20:36 +01008029 'p' return number of matching sub-Pattern (see below)
8030 's' Set the ' mark at the previous location of the cursor
8031 'w' Wrap around the end of the file
8032 'W' don't Wrap around the end of the file
8033 'z' start searching at the cursor column instead of zero
Bram Moolenaar071d4272004-06-13 20:20:40 +00008034 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
8035
Bram Moolenaar02743632005-07-25 20:42:36 +00008036 If the 's' flag is supplied, the ' mark is set, only if the
8037 cursor is moved. The 's' flag cannot be combined with the 'n'
8038 flag.
8039
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008040 'ignorecase', 'smartcase' and 'magic' are used.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01008041
Bram Moolenaar85084ef2016-01-17 22:26:33 +01008042 When the 'z' flag is not given, searching always starts in
Bram Moolenaarad4d8a12015-12-28 19:20:36 +01008043 column zero and then matches before the cursor are skipped.
8044 When the 'c' flag is present in 'cpo' the next search starts
8045 after the match. Without the 'c' flag the next search starts
8046 one column further.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008047
Bram Moolenaara23ccb82006-02-27 00:08:02 +00008048 When the {stopline} argument is given then the search stops
8049 after searching this line. This is useful to restrict the
8050 search to a range of lines. Examples: >
8051 let match = search('(', 'b', line("w0"))
8052 let end = search('END', '', line("w$"))
8053< When {stopline} is used and it is not zero this also implies
8054 that the search does not wrap around the end of the file.
Bram Moolenaar76929292008-01-06 19:07:36 +00008055 A zero value is equal to not giving the argument.
8056
8057 When the {timeout} argument is given the search stops when
Bram Moolenaar58b85342016-08-14 19:54:54 +02008058 more than this many milliseconds have passed. Thus when
Bram Moolenaar76929292008-01-06 19:07:36 +00008059 {timeout} is 500 the search stops after half a second.
8060 The value must not be negative. A zero value is like not
8061 giving the argument.
Bram Moolenaardb84e452010-08-15 13:50:43 +02008062 {only available when compiled with the |+reltime| feature}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00008063
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008064 *search()-sub-match*
8065 With the 'p' flag the returned value is one more than the
8066 first sub-match in \(\). One if none of them matched but the
8067 whole pattern did match.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00008068 To get the column number too use |searchpos()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008069
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008070 The cursor will be positioned at the match, unless the 'n'
8071 flag is used.
8072
Bram Moolenaar071d4272004-06-13 20:20:40 +00008073 Example (goes over all files in the argument list): >
8074 :let n = 1
8075 :while n <= argc() " loop over all files in arglist
8076 : exe "argument " . n
8077 : " start at the last char in the file and wrap for the
8078 : " first search to find match at start of file
8079 : normal G$
8080 : let flags = "w"
8081 : while search("foo", flags) > 0
Bram Moolenaar446cb832008-06-24 21:56:24 +00008082 : s/foo/bar/g
Bram Moolenaar071d4272004-06-13 20:20:40 +00008083 : let flags = "W"
8084 : endwhile
8085 : update " write the file if modified
8086 : let n = n + 1
8087 :endwhile
8088<
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008089 Example for using some flags: >
8090 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
8091< This will search for the keywords "if", "else", and "endif"
8092 under or after the cursor. Because of the 'p' flag, it
8093 returns 1, 2, or 3 depending on which keyword is found, or 0
8094 if the search fails. With the cursor on the first word of the
8095 line:
8096 if (foo == 0) | let foo = foo + 1 | endif ~
8097 the function returns 1. Without the 'c' flag, the function
8098 finds the "endif" and returns 3. The same thing happens
8099 without the 'e' flag if the cursor is on the "f" of "if".
8100 The 'n' flag tells the function not to move the cursor.
8101
Bram Moolenaar196b4662019-09-06 21:34:30 +02008102 Can also be used as a |method|: >
8103 GetPattern()->search()
Bram Moolenaar92d640f2005-09-05 22:11:52 +00008104
Bram Moolenaarf75a9632005-09-13 21:20:47 +00008105searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()*
8106 Search for the declaration of {name}.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008107
Bram Moolenaarf75a9632005-09-13 21:20:47 +00008108 With a non-zero {global} argument it works like |gD|, find
8109 first match in the file. Otherwise it works like |gd|, find
8110 first match in the function.
8111
8112 With a non-zero {thisblock} argument matches in a {} block
8113 that ends before the cursor position are ignored. Avoids
8114 finding variable declarations only valid in another scope.
8115
Bram Moolenaar92d640f2005-09-05 22:11:52 +00008116 Moves the cursor to the found match.
8117 Returns zero for success, non-zero for failure.
8118 Example: >
8119 if searchdecl('myvar') == 0
8120 echo getline('.')
8121 endif
8122<
Bram Moolenaar196b4662019-09-06 21:34:30 +02008123 Can also be used as a |method|: >
8124 GetName()->searchdecl()
8125<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008126 *searchpair()*
Bram Moolenaar76929292008-01-06 19:07:36 +00008127searchpair({start}, {middle}, {end} [, {flags} [, {skip}
8128 [, {stopline} [, {timeout}]]]])
Bram Moolenaar071d4272004-06-13 20:20:40 +00008129 Search for the match of a nested start-end pair. This can be
8130 used to find the "endif" that matches an "if", while other
8131 if/endif pairs in between are ignored.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00008132 The search starts at the cursor. The default is to search
8133 forward, include 'b' in {flags} to search backward.
8134 If a match is found, the cursor is positioned at it and the
8135 line number is returned. If no match is found 0 or -1 is
8136 returned and the cursor doesn't move. No error message is
8137 given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008138
8139 {start}, {middle} and {end} are patterns, see |pattern|. They
8140 must not contain \( \) pairs. Use of \%( \) is allowed. When
8141 {middle} is not empty, it is found when searching from either
8142 direction, but only when not in a nested start-end pair. A
8143 typical use is: >
8144 searchpair('\<if\>', '\<else\>', '\<endif\>')
8145< By leaving {middle} empty the "else" is skipped.
8146
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008147 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
8148 |search()|. Additionally:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008149 'r' Repeat until no more matches found; will find the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008150 outer pair. Implies the 'W' flag.
8151 'm' Return number of matches instead of line number with
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008152 the match; will be > 1 when 'r' is used.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008153 Note: it's nearly always a good idea to use the 'W' flag, to
8154 avoid wrapping around the end of the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155
8156 When a match for {start}, {middle} or {end} is found, the
8157 {skip} expression is evaluated with the cursor positioned on
8158 the start of the match. It should return non-zero if this
8159 match is to be skipped. E.g., because it is inside a comment
8160 or a string.
8161 When {skip} is omitted or empty, every match is accepted.
8162 When evaluating {skip} causes an error the search is aborted
8163 and -1 returned.
Bram Moolenaar48570482017-10-30 21:48:41 +01008164 {skip} can be a string, a lambda, a funcref or a partial.
Bram Moolenaar675e8d62018-06-24 20:42:01 +02008165 Anything else makes the function fail.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008166
Bram Moolenaar76929292008-01-06 19:07:36 +00008167 For {stopline} and {timeout} see |search()|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00008168
Bram Moolenaar071d4272004-06-13 20:20:40 +00008169 The value of 'ignorecase' is used. 'magic' is ignored, the
8170 patterns are used like it's on.
8171
8172 The search starts exactly at the cursor. A match with
8173 {start}, {middle} or {end} at the next character, in the
8174 direction of searching, is the first one found. Example: >
8175 if 1
8176 if 2
8177 endif 2
8178 endif 1
8179< When starting at the "if 2", with the cursor on the "i", and
8180 searching forwards, the "endif 2" is found. When starting on
8181 the character just before the "if 2", the "endif 1" will be
Bram Moolenaar58b85342016-08-14 19:54:54 +02008182 found. That's because the "if 2" will be found first, and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008183 then this is considered to be a nested if/endif from "if 2" to
8184 "endif 2".
8185 When searching backwards and {end} is more than one character,
8186 it may be useful to put "\zs" at the end of the pattern, so
8187 that when the cursor is inside a match with the end it finds
8188 the matching start.
8189
8190 Example, to find the "endif" command in a Vim script: >
8191
8192 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
8193 \ 'getline(".") =~ "^\\s*\""')
8194
8195< The cursor must be at or after the "if" for which a match is
8196 to be found. Note that single-quote strings are used to avoid
8197 having to double the backslashes. The skip expression only
8198 catches comments at the start of a line, not after a command.
8199 Also, a word "en" or "if" halfway a line is considered a
8200 match.
8201 Another example, to search for the matching "{" of a "}": >
8202
8203 :echo searchpair('{', '', '}', 'bW')
8204
8205< This works when the cursor is at or before the "}" for which a
8206 match is to be found. To reject matches that syntax
8207 highlighting recognized as strings: >
8208
8209 :echo searchpair('{', '', '}', 'bW',
8210 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
8211<
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008212 *searchpairpos()*
Bram Moolenaar76929292008-01-06 19:07:36 +00008213searchpairpos({start}, {middle}, {end} [, {flags} [, {skip}
8214 [, {stopline} [, {timeout}]]]])
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008215 Same as |searchpair()|, but returns a |List| with the line and
Bram Moolenaar32466aa2006-02-24 23:53:04 +00008216 column position of the match. The first element of the |List|
8217 is the line number and the second element is the byte index of
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008218 the column position of the match. If no match is found,
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02008219 returns [0, 0]. >
8220
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008221 :let [lnum,col] = searchpairpos('{', '', '}', 'n')
8222<
8223 See |match-parens| for a bigger and more useful example.
8224
Bram Moolenaar76929292008-01-06 19:07:36 +00008225searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()*
Bram Moolenaara23ccb82006-02-27 00:08:02 +00008226 Same as |search()|, but returns a |List| with the line and
Bram Moolenaar32466aa2006-02-24 23:53:04 +00008227 column position of the match. The first element of the |List|
8228 is the line number and the second element is the byte index of
8229 the column position of the match. If no match is found,
8230 returns [0, 0].
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008231 Example: >
8232 :let [lnum, col] = searchpos('mypattern', 'n')
8233
8234< When the 'p' flag is given then there is an extra item with
8235 the sub-pattern match number |search()-sub-match|. Example: >
8236 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
8237< In this example "submatch" is 2 when a lowercase letter is
8238 found |/\l|, 3 when an uppercase letter is found |/\u|.
8239
Bram Moolenaar196b4662019-09-06 21:34:30 +02008240 Can also be used as a |method|: >
8241 GetPattern()->searchpos()
8242
Bram Moolenaar81edd172016-04-14 13:51:37 +02008243server2client({clientid}, {string}) *server2client()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008244 Send a reply string to {clientid}. The most recent {clientid}
8245 that sent a string can be retrieved with expand("<client>").
8246 {only available when compiled with the |+clientserver| feature}
8247 Note:
8248 This id has to be stored before the next command can be
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00008249 received. I.e. before returning from the received command and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008250 before calling any commands that waits for input.
8251 See also |clientserver|.
8252 Example: >
8253 :echo server2client(expand("<client>"), "HELLO")
Bram Moolenaar196b4662019-09-06 21:34:30 +02008254
8255< Can also be used as a |method|: >
8256 GetClientId()->server2client(string)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008257<
8258serverlist() *serverlist()*
8259 Return a list of available server names, one per line.
8260 When there are no servers or the information is not available
8261 an empty string is returned. See also |clientserver|.
8262 {only available when compiled with the |+clientserver| feature}
8263 Example: >
8264 :echo serverlist()
8265<
Bram Moolenaarb31cf2b2017-09-02 19:45:19 +02008266setbufline({expr}, {lnum}, {text}) *setbufline()*
8267 Set line {lnum} to {text} in buffer {expr}. To insert
Bram Moolenaarb328cca2019-01-06 16:24:01 +01008268 lines use |append()|. Any text properties in {lnum} are
8269 cleared.
Bram Moolenaarb31cf2b2017-09-02 19:45:19 +02008270
8271 For the use of {expr}, see |bufname()| above.
8272
8273 {lnum} is used like with |setline()|.
8274 This works like |setline()| for the specified buffer.
Bram Moolenaarb31cf2b2017-09-02 19:45:19 +02008275
Bram Moolenaar6bf2c622019-07-04 17:12:09 +02008276 When {expr} is not a valid buffer, the buffer is not loaded or
8277 {lnum} is not valid then 1 is returned. On success 0 is
8278 returned.
Bram Moolenaarb31cf2b2017-09-02 19:45:19 +02008279
Bram Moolenaar196b4662019-09-06 21:34:30 +02008280 Can also be used as a |method|: >
8281 GetText()->setbufline(buf, lnum)
8282
Bram Moolenaar071d4272004-06-13 20:20:40 +00008283setbufvar({expr}, {varname}, {val}) *setbufvar()*
8284 Set option or local variable {varname} in buffer {expr} to
8285 {val}.
8286 This also works for a global or local window option, but it
8287 doesn't work for a global or local window variable.
8288 For a local window option the global value is unchanged.
8289 For the use of {expr}, see |bufname()| above.
8290 Note that the variable name without "b:" must be used.
8291 Examples: >
8292 :call setbufvar(1, "&mod", 1)
8293 :call setbufvar("todo", "myvar", "foobar")
8294< This function is not available in the |sandbox|.
8295
Bram Moolenaar196b4662019-09-06 21:34:30 +02008296 Can also be used as a |method|: >
8297 GetValue()->setbufvar(buf, varname)
8298
Bram Moolenaar12969c02015-09-08 23:36:10 +02008299setcharsearch({dict}) *setcharsearch()*
Bram Moolenaardbd24b52015-08-11 14:26:19 +02008300 Set the current character search information to {dict},
8301 which contains one or more of the following entries:
8302
8303 char character which will be used for a subsequent
8304 |,| or |;| command; an empty string clears the
8305 character search
8306 forward direction of character search; 1 for forward,
8307 0 for backward
8308 until type of character search; 1 for a |t| or |T|
8309 character search, 0 for an |f| or |F|
8310 character search
8311
8312 This can be useful to save/restore a user's character search
8313 from a script: >
8314 :let prevsearch = getcharsearch()
8315 :" Perform a command which clobbers user's search
8316 :call setcharsearch(prevsearch)
8317< Also see |getcharsearch()|.
8318
Bram Moolenaar196b4662019-09-06 21:34:30 +02008319 Can also be used as a |method|: >
8320 SavedSearch()->setcharsearch()
8321
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322setcmdpos({pos}) *setcmdpos()*
8323 Set the cursor position in the command line to byte position
Bram Moolenaar58b85342016-08-14 19:54:54 +02008324 {pos}. The first position is 1.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008325 Use |getcmdpos()| to obtain the current position.
8326 Only works while editing the command line, thus you must use
Bram Moolenaard8b02732005-01-14 21:48:43 +00008327 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For
8328 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is
8329 set after the command line is set to the expression. For
8330 |c_CTRL-R_=| it is set after evaluating the expression but
8331 before inserting the resulting text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332 When the number is too big the cursor is put at the end of the
8333 line. A number smaller than one has undefined results.
8334 Returns 0 when successful, 1 when not editing the command
8335 line.
8336
Bram Moolenaar196b4662019-09-06 21:34:30 +02008337 Can also be used as a |method|: >
8338 GetPos()->setcmdpos()
8339
Bram Moolenaar691ddee2019-05-09 14:52:41 +02008340setenv({name}, {val}) *setenv()*
8341 Set environment variable {name} to {val}.
8342 When {val} is |v:null| the environment variable is deleted.
8343 See also |expr-env|.
8344
Bram Moolenaar196b4662019-09-06 21:34:30 +02008345 Can also be used as a |method|, passing the value as the base: >
8346 GetPath()->setenv('PATH')
8347
Bram Moolenaar80492532016-03-08 17:08:53 +01008348setfperm({fname}, {mode}) *setfperm()* *chmod*
8349 Set the file permissions for {fname} to {mode}.
8350 {mode} must be a string with 9 characters. It is of the form
8351 "rwxrwxrwx", where each group of "rwx" flags represent, in
8352 turn, the permissions of the owner of the file, the group the
8353 file belongs to, and other users. A '-' character means the
8354 permission is off, any other character means on. Multi-byte
8355 characters are not supported.
8356
8357 For example "rw-r-----" means read-write for the user,
8358 readable by the group, not accessible by others. "xx-x-----"
8359 would do the same thing.
8360
8361 Returns non-zero for success, zero for failure.
8362
Bram Moolenaar4c313b12019-08-24 22:58:31 +02008363 Can also be used as a |method|: >
8364 GetFilename()->setfperm(mode)
8365<
Bram Moolenaar80492532016-03-08 17:08:53 +01008366 To read permissions see |getfperm()|.
8367
8368
Bram Moolenaar446cb832008-06-24 21:56:24 +00008369setline({lnum}, {text}) *setline()*
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01008370 Set line {lnum} of the current buffer to {text}. To insert
Bram Moolenaarb31cf2b2017-09-02 19:45:19 +02008371 lines use |append()|. To set lines in another buffer use
Bram Moolenaarb328cca2019-01-06 16:24:01 +01008372 |setbufline()|. Any text properties in {lnum} are cleared.
Bram Moolenaarb31cf2b2017-09-02 19:45:19 +02008373
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00008374 {lnum} is used like with |getline()|.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008375 When {lnum} is just below the last line the {text} will be
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00008376 added as a new line.
Bram Moolenaarb31cf2b2017-09-02 19:45:19 +02008377
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00008378 If this succeeds, 0 is returned. If this fails (most likely
Bram Moolenaarb31cf2b2017-09-02 19:45:19 +02008379 because {lnum} is invalid) 1 is returned.
8380
8381 Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008382 :call setline(5, strftime("%c"))
Bram Moolenaarb31cf2b2017-09-02 19:45:19 +02008383
Bram Moolenaar446cb832008-06-24 21:56:24 +00008384< When {text} is a |List| then line {lnum} and following lines
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00008385 will be set to the items in the list. Example: >
8386 :call setline(5, ['aaa', 'bbb', 'ccc'])
8387< This is equivalent to: >
Bram Moolenaar53bfca22012-04-13 23:04:47 +02008388 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']]
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00008389 : call setline(n, l)
8390 :endfor
Bram Moolenaarb4d5fba2017-09-11 19:31:28 +02008391
Bram Moolenaar071d4272004-06-13 20:20:40 +00008392< Note: The '[ and '] marks are not set.
8393
Bram Moolenaar196b4662019-09-06 21:34:30 +02008394 Can also be used as a |method|, passing the text as the base: >
8395 GetText()->setline(lnum)
8396
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01008397setloclist({nr}, {list} [, {action} [, {what}]]) *setloclist()*
Bram Moolenaar17c7c012006-01-26 22:25:15 +00008398 Create or replace or add to the location list for window {nr}.
Bram Moolenaar7571d552016-08-18 22:54:46 +02008399 {nr} can be the window number or the |window-ID|.
Bram Moolenaar888ccac2016-06-04 18:49:36 +02008400 When {nr} is zero the current window is used.
8401
8402 For a location list window, the displayed location list is
8403 modified. For an invalid window number {nr}, -1 is returned.
Bram Moolenaar6ee10162007-07-26 20:58:42 +00008404 Otherwise, same as |setqflist()|.
8405 Also see |location-list|.
8406
Bram Moolenaard823fa92016-08-12 16:29:27 +02008407 If the optional {what} dictionary argument is supplied, then
8408 only the items listed in {what} are set. Refer to |setqflist()|
8409 for the list of supported keys in {what}.
8410
Bram Moolenaaraad222c2019-09-06 22:46:09 +02008411 Can also be used as a |method|, the base is passed as the
8412 second argument: >
8413 GetLoclist()->setloclist(winnr)
8414
Bram Moolenaaraff74912019-03-30 18:11:49 +01008415setmatches({list} [, {win}]) *setmatches()*
Bram Moolenaarfd133322019-03-29 12:20:27 +01008416 Restores a list of matches saved by |getmatches() for the
8417 current window|. Returns 0 if successful, otherwise -1. All
8418 current matches are cleared before the list is restored. See
8419 example for |getmatches()|.
Bram Moolenaaraff74912019-03-30 18:11:49 +01008420 If {win} is specified, use the window with this number or
8421 window ID instead of the current window.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00008422
Bram Moolenaaraad222c2019-09-06 22:46:09 +02008423 Can also be used as a |method|: >
8424 GetMatches()->setmatches()
8425<
Bram Moolenaar65c923a2006-03-03 22:56:30 +00008426 *setpos()*
8427setpos({expr}, {list})
8428 Set the position for {expr}. Possible values:
8429 . the cursor
8430 'x mark x
8431
Bram Moolenaar493c1782014-05-28 14:34:46 +02008432 {list} must be a |List| with four or five numbers:
Bram Moolenaar65c923a2006-03-03 22:56:30 +00008433 [bufnum, lnum, col, off]
Bram Moolenaar493c1782014-05-28 14:34:46 +02008434 [bufnum, lnum, col, off, curswant]
Bram Moolenaar65c923a2006-03-03 22:56:30 +00008435
Bram Moolenaar58b85342016-08-14 19:54:54 +02008436 "bufnum" is the buffer number. Zero can be used for the
Bram Moolenaarf13e00b2017-01-28 18:23:54 +01008437 current buffer. When setting an uppercase mark "bufnum" is
8438 used for the mark position. For other marks it specifies the
8439 buffer to set the mark in. You can use the |bufnr()| function
8440 to turn a file name into a buffer number.
8441 For setting the cursor and the ' mark "bufnum" is ignored,
8442 since these are associated with a window, not a buffer.
Bram Moolenaardb552d602006-03-23 22:59:57 +00008443 Does not change the jumplist.
Bram Moolenaar65c923a2006-03-03 22:56:30 +00008444
8445 "lnum" and "col" are the position in the buffer. The first
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008446 column is 1. Use a zero "lnum" to delete a mark. If "col" is
8447 smaller than 1 then 1 is used.
Bram Moolenaar65c923a2006-03-03 22:56:30 +00008448
8449 The "off" number is only used when 'virtualedit' is set. Then
8450 it is the offset in screen columns from the start of the
Bram Moolenaard46bbc72007-05-12 14:38:41 +00008451 character. E.g., a position within a <Tab> or after the last
Bram Moolenaar65c923a2006-03-03 22:56:30 +00008452 character.
8453
Bram Moolenaar493c1782014-05-28 14:34:46 +02008454 The "curswant" number is only used when setting the cursor
8455 position. It sets the preferred column for when moving the
8456 cursor vertically. When the "curswant" number is missing the
8457 preferred column is not set. When it is present and setting a
8458 mark position it is not used.
8459
Bram Moolenaardfb18412013-12-11 18:53:29 +01008460 Note that for '< and '> changing the line number may result in
8461 the marks to be effectively be swapped, so that '< is always
8462 before '>.
8463
Bram Moolenaar08250432008-02-13 11:42:46 +00008464 Returns 0 when the position could be set, -1 otherwise.
8465 An error message is given if {expr} is invalid.
8466
Bram Moolenaar6f6c0f82014-05-28 20:31:42 +02008467 Also see |getpos()| and |getcurpos()|.
Bram Moolenaar65c923a2006-03-03 22:56:30 +00008468
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008469 This does not restore the preferred column for moving
Bram Moolenaar493c1782014-05-28 14:34:46 +02008470 vertically; if you set the cursor position with this, |j| and
8471 |k| motions will jump to previous columns! Use |cursor()| to
8472 also set the preferred column. Also see the "curswant" key in
8473 |winrestview()|.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00008474
Bram Moolenaaraad222c2019-09-06 22:46:09 +02008475 Can also be used as a |method|: >
8476 GetPosition()->setpos('.')
8477
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01008478setqflist({list} [, {action} [, {what}]]) *setqflist()*
Bram Moolenaarae338332017-08-11 20:25:26 +02008479 Create or replace or add to the quickfix list.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01008480
Bram Moolenaarae338332017-08-11 20:25:26 +02008481 When {what} is not present, use the items in {list}. Each
8482 item must be a dictionary. Non-dictionary items in {list} are
8483 ignored. Each dictionary item can contain the following
8484 entries:
Bram Moolenaar68b76a62005-03-25 21:53:48 +00008485
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00008486 bufnr buffer number; must be the number of a valid
Bram Moolenaar446cb832008-06-24 21:56:24 +00008487 buffer
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00008488 filename name of a file; only used when "bufnr" is not
Bram Moolenaar446cb832008-06-24 21:56:24 +00008489 present or it is invalid.
Bram Moolenaard76ce852018-05-01 15:02:04 +02008490 module name of a module; if given it will be used in
8491 quickfix error window instead of the filename.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00008492 lnum line number in the file
Bram Moolenaar68b76a62005-03-25 21:53:48 +00008493 pattern search pattern used to locate the error
Bram Moolenaar582fd852005-03-28 20:58:01 +00008494 col column number
8495 vcol when non-zero: "col" is visual column
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008496 when zero: "col" is byte index
Bram Moolenaar582fd852005-03-28 20:58:01 +00008497 nr error number
Bram Moolenaar68b76a62005-03-25 21:53:48 +00008498 text description of the error
Bram Moolenaar582fd852005-03-28 20:58:01 +00008499 type single-character error type, 'E', 'W', etc.
Bram Moolenaarf1d21c82017-04-22 21:20:46 +02008500 valid recognized error message
Bram Moolenaar68b76a62005-03-25 21:53:48 +00008501
Bram Moolenaar582fd852005-03-28 20:58:01 +00008502 The "col", "vcol", "nr", "type" and "text" entries are
8503 optional. Either "lnum" or "pattern" entry can be used to
8504 locate a matching error line.
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00008505 If the "filename" and "bufnr" entries are not present or
8506 neither the "lnum" or "pattern" entries are present, then the
8507 item will not be handled as an error line.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00008508 If both "pattern" and "lnum" are present then "pattern" will
8509 be used.
Bram Moolenaarf1d21c82017-04-22 21:20:46 +02008510 If the "valid" entry is not supplied, then the valid flag is
8511 set when "bufnr" is a valid buffer or "filename" exists.
Bram Moolenaar00a927d2010-05-14 23:24:24 +02008512 If you supply an empty {list}, the quickfix list will be
8513 cleared.
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00008514 Note that the list is not exactly the same as what
8515 |getqflist()| returns.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00008516
Bram Moolenaarb6fa30c2017-03-29 14:19:25 +02008517 {action} values: *E927*
8518 'a' The items from {list} are added to the existing
8519 quickfix list. If there is no existing list, then a
8520 new list is created.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01008521
Bram Moolenaarb6fa30c2017-03-29 14:19:25 +02008522 'r' The items from the current quickfix list are replaced
8523 with the items from {list}. This can also be used to
8524 clear the list: >
8525 :call setqflist([], 'r')
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01008526<
Bram Moolenaarb6fa30c2017-03-29 14:19:25 +02008527 'f' All the quickfix lists in the quickfix stack are
8528 freed.
8529
Bram Moolenaar511972d2016-06-04 18:09:59 +02008530 If {action} is not present or is set to ' ', then a new list
Bram Moolenaar55b69262017-08-13 13:42:01 +02008531 is created. The new quickfix list is added after the current
8532 quickfix list in the stack and all the following lists are
8533 freed. To add a new quickfix list at the end of the stack,
Bram Moolenaar36538222017-09-02 19:51:44 +02008534 set "nr" in {what} to "$".
Bram Moolenaar35c54e52005-05-20 21:25:31 +00008535
Bram Moolenaard823fa92016-08-12 16:29:27 +02008536 If the optional {what} dictionary argument is supplied, then
8537 only the items listed in {what} are set. The first {list}
8538 argument is ignored. The following items can be specified in
8539 {what}:
Bram Moolenaar15142e22018-04-30 22:19:58 +02008540 context quickfix list context. See |quickfix-context|
Bram Moolenaar36538222017-09-02 19:51:44 +02008541 efm errorformat to use when parsing text from
8542 "lines". If this is not present, then the
8543 'errorformat' option value is used.
Bram Moolenaar5b69c222019-01-11 14:50:06 +01008544 See |quickfix-parse|
Bram Moolenaara539f4f2017-08-30 20:33:55 +02008545 id quickfix list identifier |quickfix-ID|
Bram Moolenaar5b69c222019-01-11 14:50:06 +01008546 idx index of the current entry in the quickfix
8547 list specified by 'id' or 'nr'. If set to '$',
8548 then the last entry in the list is set as the
8549 current entry. See |quickfix-index|
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02008550 items list of quickfix entries. Same as the {list}
8551 argument.
Bram Moolenaar2c809b72017-09-01 18:34:02 +02008552 lines use 'errorformat' to parse a list of lines and
8553 add the resulting entries to the quickfix list
8554 {nr} or {id}. Only a |List| value is supported.
Bram Moolenaar5b69c222019-01-11 14:50:06 +01008555 See |quickfix-parse|
Bram Moolenaar875feea2017-06-11 16:07:51 +02008556 nr list number in the quickfix stack; zero
Bram Moolenaar36538222017-09-02 19:51:44 +02008557 means the current quickfix list and "$" means
Bram Moolenaar5b69c222019-01-11 14:50:06 +01008558 the last quickfix list.
8559 title quickfix list title text. See |quickfix-title|
Bram Moolenaard823fa92016-08-12 16:29:27 +02008560 Unsupported keys in {what} are ignored.
8561 If the "nr" item is not present, then the current quickfix list
Bram Moolenaar86f100dc2017-06-28 21:26:27 +02008562 is modified. When creating a new quickfix list, "nr" can be
8563 set to a value one greater than the quickfix stack size.
Bram Moolenaara539f4f2017-08-30 20:33:55 +02008564 When modifying a quickfix list, to guarantee that the correct
Bram Moolenaar36538222017-09-02 19:51:44 +02008565 list is modified, "id" should be used instead of "nr" to
Bram Moolenaara539f4f2017-08-30 20:33:55 +02008566 specify the list.
Bram Moolenaard823fa92016-08-12 16:29:27 +02008567
Bram Moolenaar15142e22018-04-30 22:19:58 +02008568 Examples (See also |setqflist-examples|): >
Bram Moolenaar2c809b72017-09-01 18:34:02 +02008569 :call setqflist([], 'r', {'title': 'My search'})
8570 :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
Bram Moolenaar15142e22018-04-30 22:19:58 +02008571 :call setqflist([], 'a', {'id':qfid, 'lines':["F1:10:L10"]})
Bram Moolenaard823fa92016-08-12 16:29:27 +02008572<
Bram Moolenaar68b76a62005-03-25 21:53:48 +00008573 Returns zero for success, -1 for failure.
8574
8575 This function can be used to create a quickfix list
8576 independent of the 'errorformat' setting. Use a command like
Bram Moolenaar94237492017-04-23 18:40:21 +02008577 `:cc 1` to jump to the first position.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00008578
Bram Moolenaaraad222c2019-09-06 22:46:09 +02008579 Can also be used as a |method|, the base is passed as the
8580 second argument: >
8581 GetErrorlist()->setqflist()
8582<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008583 *setreg()*
Bram Moolenaare0fa3742016-02-20 15:47:01 +01008584setreg({regname}, {value} [, {options}])
Bram Moolenaar071d4272004-06-13 20:20:40 +00008585 Set the register {regname} to {value}.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01008586 {value} may be any value returned by |getreg()|, including
Bram Moolenaar5a50c222014-04-02 22:17:10 +02008587 a |List|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008588 If {options} contains "a" or {regname} is upper case,
8589 then the value is appended.
Bram Moolenaarc6485bc2010-07-28 17:02:55 +02008590 {options} can also contain a register type specification:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008591 "c" or "v" |characterwise| mode
8592 "l" or "V" |linewise| mode
8593 "b" or "<CTRL-V>" |blockwise-visual| mode
8594 If a number immediately follows "b" or "<CTRL-V>" then this is
8595 used as the width of the selection - if it is not specified
8596 then the width of the block is set to the number of characters
Bram Moolenaard46bbc72007-05-12 14:38:41 +00008597 in the longest line (counting a <Tab> as 1 character).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008598
8599 If {options} contains no register settings, then the default
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01008600 is to use character mode unless {value} ends in a <NL> for
8601 string {value} and linewise mode for list {value}. Blockwise
Bram Moolenaar5a50c222014-04-02 22:17:10 +02008602 mode is never selected automatically.
8603 Returns zero for success, non-zero for failure.
8604
8605 *E883*
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01008606 Note: you may not use |List| containing more than one item to
8607 set search and expression registers. Lists containing no
Bram Moolenaar5a50c222014-04-02 22:17:10 +02008608 items act like empty strings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008609
8610 Examples: >
8611 :call setreg(v:register, @*)
8612 :call setreg('*', @%, 'ac')
8613 :call setreg('a', "1\n2\n3", 'b5')
8614
8615< This example shows using the functions to save and restore a
Bram Moolenaarb4d5fba2017-09-11 19:31:28 +02008616 register: >
Bram Moolenaar5a50c222014-04-02 22:17:10 +02008617 :let var_a = getreg('a', 1, 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008618 :let var_amode = getregtype('a')
8619 ....
8620 :call setreg('a', var_a, var_amode)
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01008621< Note: you may not reliably restore register value
8622 without using the third argument to |getreg()| as without it
Bram Moolenaarb4d5fba2017-09-11 19:31:28 +02008623 newlines are represented as newlines AND Nul bytes are
8624 represented as newlines as well, see |NL-used-for-Nul|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625
Bram Moolenaarb4d5fba2017-09-11 19:31:28 +02008626 You can also change the type of a register by appending
Bram Moolenaar071d4272004-06-13 20:20:40 +00008627 nothing: >
8628 :call setreg('a', '', 'al')
8629
Bram Moolenaaraad222c2019-09-06 22:46:09 +02008630< Can also be used as a |method|, the base is passed as the
8631 second argument: >
8632 GetText()->setreg('a')
8633
Bram Moolenaar06b5d512010-05-22 15:37:44 +02008634settabvar({tabnr}, {varname}, {val}) *settabvar()*
8635 Set tab-local variable {varname} to {val} in tab page {tabnr}.
8636 |t:var|
Bram Moolenaarb4230122019-05-30 18:40:53 +02008637 Note that autocommands are blocked, side effects may not be
8638 triggered, e.g. when setting 'filetype'.
Bram Moolenaar06b5d512010-05-22 15:37:44 +02008639 Note that the variable name without "t:" must be used.
8640 Tabs are numbered starting with one.
Bram Moolenaar06b5d512010-05-22 15:37:44 +02008641 This function is not available in the |sandbox|.
8642
Bram Moolenaaraad222c2019-09-06 22:46:09 +02008643 Can also be used as a |method|, the base is used as the value: >
8644 GetValue()->settabvar(tab, name)
8645
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00008646settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()*
8647 Set option or local variable {varname} in window {winnr} to
8648 {val}.
8649 Tabs are numbered starting with one. For the current tabpage
8650 use |setwinvar()|.
Bram Moolenaar7571d552016-08-18 22:54:46 +02008651 {winnr} can be the window number or the |window-ID|.
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00008652 When {winnr} is zero the current window is used.
Bram Moolenaarb4230122019-05-30 18:40:53 +02008653 Note that autocommands are blocked, side effects may not be
8654 triggered, e.g. when setting 'filetype' or 'syntax'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008655 This also works for a global or local buffer option, but it
8656 doesn't work for a global or local buffer variable.
8657 For a local buffer option the global value is unchanged.
8658 Note that the variable name without "w:" must be used.
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00008659 Examples: >
8660 :call settabwinvar(1, 1, "&list", 0)
8661 :call settabwinvar(3, 2, "myvar", "foobar")
8662< This function is not available in the |sandbox|.
8663
Bram Moolenaaraad222c2019-09-06 22:46:09 +02008664 Can also be used as a |method|, the base is used as the value: >
8665 GetValue()->settabvar(tab, winnr, name)
8666
Bram Moolenaarf49cc602018-11-11 15:21:05 +01008667settagstack({nr}, {dict} [, {action}]) *settagstack()*
8668 Modify the tag stack of the window {nr} using {dict}.
8669 {nr} can be the window number or the |window-ID|.
8670
8671 For a list of supported items in {dict}, refer to
8672 |gettagstack()|
8673 *E962*
8674 If {action} is not present or is set to 'r', then the tag
8675 stack is replaced. If {action} is set to 'a', then new entries
8676 from {dict} are pushed onto the tag stack.
8677
8678 Returns zero for success, -1 for failure.
8679
8680 Examples:
8681 Set current index of the tag stack to 4: >
8682 call settagstack(1005, {'curidx' : 4})
8683
8684< Empty the tag stack of window 3: >
8685 call settagstack(3, {'items' : []})
8686
8687< Push a new item onto the tag stack: >
8688 let pos = [bufnr('myfile.txt'), 10, 1, 0]
8689 let newtag = [{'tagname' : 'mytag', 'from' : pos}]
8690 call settagstack(2, {'items' : newtag}, 'a')
8691
8692< Save and restore the tag stack: >
8693 let stack = gettagstack(1003)
8694 " do something else
8695 call settagstack(1003, stack)
8696 unlet stack
8697<
Bram Moolenaaraad222c2019-09-06 22:46:09 +02008698 Can also be used as a |method|, the base is used as the Dict: >
8699 GetStack()->settagstack(winnr)
8700
8701setwinvar({winnr}, {varname}, {val}) *setwinvar()*
Bram Moolenaarc6249bb2006-04-15 20:25:09 +00008702 Like |settabwinvar()| for the current tab page.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008703 Examples: >
8704 :call setwinvar(1, "&list", 0)
8705 :call setwinvar(2, "myvar", "foobar")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008706
Bram Moolenaaraad222c2019-09-06 22:46:09 +02008707< Can also be used as a |method|, the base is used as the value: >
8708 GetValue()->setwinvar(winnr, name)
8709
Bram Moolenaaraf9aeb92013-02-13 17:35:04 +01008710sha256({string}) *sha256()*
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01008711 Returns a String with 64 hex characters, which is the SHA256
Bram Moolenaaraf9aeb92013-02-13 17:35:04 +01008712 checksum of {string}.
Bram Moolenaaraad222c2019-09-06 22:46:09 +02008713
8714 Can also be used as a |method|: >
8715 GetText()->sha256()
8716
8717< {only available when compiled with the |+cryptv| feature}
Bram Moolenaaraf9aeb92013-02-13 17:35:04 +01008718
Bram Moolenaar05bb9532008-07-04 09:44:11 +00008719shellescape({string} [, {special}]) *shellescape()*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008720 Escape {string} for use as a shell command argument.
Bram Moolenaar25e42232019-08-04 15:04:10 +02008721 On MS-Windows, when 'shellslash' is not set, it will enclose
8722 {string} in double quotes and double all double quotes within
8723 {string}.
Bram Moolenaare381d3d2016-07-07 14:50:41 +02008724 Otherwise it will enclose {string} in single quotes and
8725 replace all "'" with "'\''".
Bram Moolenaar875feea2017-06-11 16:07:51 +02008726
Bram Moolenaar05bb9532008-07-04 09:44:11 +00008727 When the {special} argument is present and it's a non-zero
8728 Number or a non-empty String (|non-zero-arg|), then special
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008729 items such as "!", "%", "#" and "<cword>" will be preceded by
8730 a backslash. This backslash will be removed again by the |:!|
Bram Moolenaar05bb9532008-07-04 09:44:11 +00008731 command.
Bram Moolenaar875feea2017-06-11 16:07:51 +02008732
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008733 The "!" character will be escaped (again with a |non-zero-arg|
8734 {special}) when 'shell' contains "csh" in the tail. That is
8735 because for csh and tcsh "!" is used for history replacement
8736 even when inside single quotes.
Bram Moolenaar875feea2017-06-11 16:07:51 +02008737
8738 With a |non-zero-arg| {special} the <NL> character is also
8739 escaped. When 'shell' containing "csh" in the tail it's
Bram Moolenaare37d50a2008-08-06 17:06:04 +00008740 escaped a second time.
Bram Moolenaar875feea2017-06-11 16:07:51 +02008741
Bram Moolenaar05bb9532008-07-04 09:44:11 +00008742 Example of use with a |:!| command: >
8743 :exe '!dir ' . shellescape(expand('<cfile>'), 1)
8744< This results in a directory listing for the file under the
8745 cursor. Example of use with |system()|: >
8746 :call system("chmod +w -- " . shellescape(expand("%")))
Bram Moolenaar26df0922014-02-23 23:39:13 +01008747< See also |::S|.
Bram Moolenaar60a495f2006-10-03 12:44:42 +00008748
Bram Moolenaaraad222c2019-09-06 22:46:09 +02008749 Can also be used as a |method|: >
8750 GetCommand()->shellescape()
Bram Moolenaar60a495f2006-10-03 12:44:42 +00008751
Bram Moolenaarf9514162018-11-22 03:08:29 +01008752shiftwidth([{col}]) *shiftwidth()*
Bram Moolenaar2d17fa32012-10-21 00:45:18 +02008753 Returns the effective value of 'shiftwidth'. This is the
8754 'shiftwidth' value unless it is zero, in which case it is the
Bram Moolenaar009d84a2016-01-28 14:12:00 +01008755 'tabstop' value. This function was introduced with patch
Bram Moolenaarf9514162018-11-22 03:08:29 +01008756 7.3.694 in 2012, everybody should have it by now (however it
8757 did not allow for the optional {col} argument until 8.1.542).
Bram Moolenaar2d17fa32012-10-21 00:45:18 +02008758
Bram Moolenaarf9514162018-11-22 03:08:29 +01008759 When there is one argument {col} this is used as column number
8760 for which to return the 'shiftwidth' value. This matters for the
8761 'vartabstop' feature. If the 'vartabstop' setting is enabled and
8762 no {col} argument is given, column 1 will be assumed.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008763
Bram Moolenaaraad222c2019-09-06 22:46:09 +02008764 Can also be used as a |method|: >
8765 GetColumn()->shiftwidth()
8766
Bram Moolenaared997ad2019-07-21 16:42:00 +02008767sign_ functions are documented here: |sign-functions-details|
Bram Moolenaar2d17fa32012-10-21 00:45:18 +02008768
Bram Moolenaar162b7142018-12-21 15:17:36 +01008769
Bram Moolenaar071d4272004-06-13 20:20:40 +00008770simplify({filename}) *simplify()*
8771 Simplify the file name as much as possible without changing
8772 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
8773 Unix) are not resolved. If the first path component in
8774 {filename} designates the current directory, this will be
8775 valid for the result as well. A trailing path separator is
8776 not removed either.
8777 Example: >
8778 simplify("./dir/.././/file/") == "./file/"
8779< Note: The combination "dir/.." is only removed if "dir" is
8780 a searchable directory or does not exist. On Unix, it is also
8781 removed when "dir" is a symbolic link within the same
8782 directory. In order to resolve all the involved symbolic
8783 links before simplifying the path name, use |resolve()|.
8784
Bram Moolenaara14de3d2005-01-07 21:48:26 +00008785
Bram Moolenaar446cb832008-06-24 21:56:24 +00008786sin({expr}) *sin()*
8787 Return the sine of {expr}, measured in radians, as a |Float|.
8788 {expr} must evaluate to a |Float| or a |Number|.
8789 Examples: >
8790 :echo sin(100)
8791< -0.506366 >
8792 :echo sin(-4.01)
8793< 0.763301
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02008794
8795 Can also be used as a |method|: >
8796 Compute()->sin()
8797<
Bram Moolenaar446cb832008-06-24 21:56:24 +00008798 {only available when compiled with the |+float| feature}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01008799
Bram Moolenaar446cb832008-06-24 21:56:24 +00008800
Bram Moolenaardb7c6862010-05-21 16:33:48 +02008801sinh({expr}) *sinh()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02008802 Return the hyperbolic sine of {expr} as a |Float| in the range
Bram Moolenaardb7c6862010-05-21 16:33:48 +02008803 [-inf, inf].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02008804 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02008805 Examples: >
8806 :echo sinh(0.5)
8807< 0.521095 >
8808 :echo sinh(-0.9)
8809< -1.026517
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02008810
8811 Can also be used as a |method|: >
8812 Compute()->sinh()
8813<
Bram Moolenaardb84e452010-08-15 13:50:43 +02008814 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02008815
8816
Bram Moolenaar5f894962011-06-19 02:55:37 +02008817sort({list} [, {func} [, {dict}]]) *sort()* *E702*
Bram Moolenaar327aa022014-03-25 18:24:23 +01008818 Sort the items in {list} in-place. Returns {list}.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01008819
Bram Moolenaar327aa022014-03-25 18:24:23 +01008820 If you want a list to remain unmodified make a copy first: >
Bram Moolenaara14de3d2005-01-07 21:48:26 +00008821 :let sortedlist = sort(copy(mylist))
Bram Moolenaar822ff862014-06-12 21:46:14 +02008822
Bram Moolenaar946e27a2014-06-25 18:50:27 +02008823< When {func} is omitted, is empty or zero, then sort() uses the
8824 string representation of each item to sort on. Numbers sort
8825 after Strings, |Lists| after Numbers. For sorting text in the
8826 current buffer use |:sort|.
Bram Moolenaar327aa022014-03-25 18:24:23 +01008827
Bram Moolenaar34401cc2014-08-29 15:12:19 +02008828 When {func} is given and it is '1' or 'i' then case is
Bram Moolenaar946e27a2014-06-25 18:50:27 +02008829 ignored.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01008830
Bram Moolenaar946e27a2014-06-25 18:50:27 +02008831 When {func} is given and it is 'n' then all items will be
8832 sorted numerical (Implementation detail: This uses the
8833 strtod() function to parse numbers, Strings, Lists, Dicts and
8834 Funcrefs will be considered as being 0).
8835
Bram Moolenaarb00da1d2015-12-03 16:33:12 +01008836 When {func} is given and it is 'N' then all items will be
8837 sorted numerical. This is like 'n' but a string containing
8838 digits will be used as the number they represent.
8839
Bram Moolenaar13d5aee2016-01-21 23:36:05 +01008840 When {func} is given and it is 'f' then all items will be
8841 sorted numerical. All values must be a Number or a Float.
8842
Bram Moolenaar32466aa2006-02-24 23:53:04 +00008843 When {func} is a |Funcref| or a function name, this function
8844 is called to compare items. The function is invoked with two
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008845 items as argument and must return zero if they are equal, 1 or
8846 bigger if the first one sorts after the second one, -1 or
8847 smaller if the first one sorts before the second one.
Bram Moolenaar327aa022014-03-25 18:24:23 +01008848
8849 {dict} is for functions with the "dict" attribute. It will be
8850 used to set the local variable "self". |Dictionary-function|
8851
Bram Moolenaar8bb1c3e2014-07-04 16:43:17 +02008852 The sort is stable, items which compare equal (as number or as
8853 string) will keep their relative position. E.g., when sorting
Bram Moolenaardb6ea062014-07-10 22:01:47 +02008854 on numbers, text strings will sort next to each other, in the
Bram Moolenaar8bb1c3e2014-07-04 16:43:17 +02008855 same order as they were originally.
8856
Bram Moolenaarac92e252019-08-03 21:58:38 +02008857 Can also be used as a |method|: >
8858 mylist->sort()
8859
8860< Also see |uniq()|.
Bram Moolenaar327aa022014-03-25 18:24:23 +01008861
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008862 Example: >
Bram Moolenaara14de3d2005-01-07 21:48:26 +00008863 func MyCompare(i1, i2)
8864 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
8865 endfunc
8866 let sortedlist = sort(mylist, "MyCompare")
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008867< A shorter compare version for this specific simple case, which
8868 ignores overflow: >
8869 func MyCompare(i1, i2)
8870 return a:i1 - a:i2
8871 endfunc
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008872<
Bram Moolenaar3ff5f0f2019-06-10 13:11:22 +02008873sound_clear() *sound_clear()*
8874 Stop playing all sounds.
Bram Moolenaar9b283522019-06-17 22:19:33 +02008875 {only available when compiled with the |+sound| feature}
Bram Moolenaar3ff5f0f2019-06-10 13:11:22 +02008876
Bram Moolenaar427f5b62019-06-09 13:43:51 +02008877 *sound_playevent()*
8878sound_playevent({name} [, {callback}])
8879 Play a sound identified by {name}. Which event names are
8880 supported depends on the system. Often the XDG sound names
8881 are used. On Ubuntu they may be found in
8882 /usr/share/sounds/freedesktop/stereo. Example: >
8883 call sound_playevent('bell')
Bram Moolenaar9b283522019-06-17 22:19:33 +02008884< On MS-Windows, {name} can be SystemAsterisk, SystemDefault,
8885 SystemExclamation, SystemExit, SystemHand, SystemQuestion,
8886 SystemStart, SystemWelcome, etc.
Bram Moolenaar427f5b62019-06-09 13:43:51 +02008887
Bram Moolenaar9b283522019-06-17 22:19:33 +02008888 When {callback} is specified it is invoked when the sound is
Bram Moolenaar427f5b62019-06-09 13:43:51 +02008889 finished. The first argument is the sound ID, the second
8890 argument is the status:
8891 0 sound was played to the end
Bram Moolenaar12ee7ff2019-06-10 22:47:40 +02008892 1 sound was interrupted
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02008893 2 error occurred after sound started
Bram Moolenaar427f5b62019-06-09 13:43:51 +02008894 Example: >
8895 func Callback(id, status)
8896 echomsg "sound " .. a:id .. " finished with " .. a:status
8897 endfunc
8898 call sound_playevent('bell', 'Callback')
8899
Bram Moolenaar9b283522019-06-17 22:19:33 +02008900< MS-Windows: {callback} doesn't work for this function.
8901
8902 Returns the sound ID, which can be passed to `sound_stop()`.
Bram Moolenaar427f5b62019-06-09 13:43:51 +02008903 Returns zero if the sound could not be played.
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02008904
8905 Can also be used as a |method|: >
8906 GetSoundName()->sound_playevent()
8907
8908< {only available when compiled with the |+sound| feature}
Bram Moolenaar427f5b62019-06-09 13:43:51 +02008909
8910 *sound_playfile()*
Bram Moolenaar3ff5f0f2019-06-10 13:11:22 +02008911sound_playfile({path} [, {callback}])
8912 Like `sound_playevent()` but play sound file {path}. {path}
Bram Moolenaar427f5b62019-06-09 13:43:51 +02008913 must be a full path. On Ubuntu you may find files to play
8914 with this command: >
8915 :!find /usr/share/sounds -type f | grep -v index.theme
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02008916
8917< Can also be used as a |method|: >
8918 GetSoundPath()->sound_playfile()
8919
Bram Moolenaar12ee7ff2019-06-10 22:47:40 +02008920< {only available when compiled with the |+sound| feature}
Bram Moolenaar427f5b62019-06-09 13:43:51 +02008921
8922
8923sound_stop({id}) *sound_stop()*
8924 Stop playing sound {id}. {id} must be previously returned by
8925 `sound_playevent()` or `sound_playfile()`.
Bram Moolenaar9b283522019-06-17 22:19:33 +02008926
8927 On MS-Windows, this does not work for event sound started by
8928 `sound_playevent()`. To stop event sounds, use `sound_clear()`.
8929
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02008930 Can also be used as a |method|: >
8931 soundid->sound_stop()
8932
8933< {only available when compiled with the |+sound| feature}
Bram Moolenaar427f5b62019-06-09 13:43:51 +02008934
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008935 *soundfold()*
8936soundfold({word})
8937 Return the sound-folded equivalent of {word}. Uses the first
Bram Moolenaar446cb832008-06-24 21:56:24 +00008938 language in 'spelllang' for the current window that supports
Bram Moolenaar42eeac32005-06-29 22:40:58 +00008939 soundfolding. 'spell' must be set. When no sound folding is
8940 possible the {word} is returned unmodified.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00008941 This can be used for making spelling suggestions. Note that
8942 the method can be quite slow.
8943
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02008944 Can also be used as a |method|: >
8945 GetWord()->soundfold()
8946<
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008947 *spellbadword()*
Bram Moolenaar1e015462005-09-25 22:16:38 +00008948spellbadword([{sentence}])
8949 Without argument: The result is the badly spelled word under
8950 or after the cursor. The cursor is moved to the start of the
8951 bad word. When no bad word is found in the cursor line the
8952 result is an empty string and the cursor doesn't move.
8953
8954 With argument: The result is the first word in {sentence} that
8955 is badly spelled. If there are no spelling mistakes the
8956 result is an empty string.
8957
8958 The return value is a list with two items:
8959 - The badly spelled word or an empty string.
8960 - The type of the spelling error:
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008961 "bad" spelling mistake
Bram Moolenaar1e015462005-09-25 22:16:38 +00008962 "rare" rare word
8963 "local" word only valid in another region
8964 "caps" word should start with Capital
8965 Example: >
8966 echo spellbadword("the quik brown fox")
8967< ['quik', 'bad'] ~
8968
8969 The spelling information for the current window is used. The
8970 'spell' option must be set and the value of 'spelllang' is
8971 used.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008972
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02008973 Can also be used as a |method|: >
8974 GetText()->spellbadword()
8975<
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008976 *spellsuggest()*
Bram Moolenaarc54b8a72005-09-30 21:20:29 +00008977spellsuggest({word} [, {max} [, {capital}]])
Bram Moolenaar32466aa2006-02-24 23:53:04 +00008978 Return a |List| with spelling suggestions to replace {word}.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008979 When {max} is given up to this number of suggestions are
8980 returned. Otherwise up to 25 suggestions are returned.
8981
Bram Moolenaarc54b8a72005-09-30 21:20:29 +00008982 When the {capital} argument is given and it's non-zero only
8983 suggestions with a leading capital will be given. Use this
8984 after a match with 'spellcapcheck'.
8985
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008986 {word} can be a badly spelled word followed by other text.
8987 This allows for joining two words that were split. The
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00008988 suggestions also include the following text, thus you can
8989 replace a line.
8990
8991 {word} may also be a good word. Similar words will then be
Bram Moolenaarc54b8a72005-09-30 21:20:29 +00008992 returned. {word} itself is not included in the suggestions,
8993 although it may appear capitalized.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008994
8995 The spelling information for the current window is used. The
Bram Moolenaar42eeac32005-06-29 22:40:58 +00008996 'spell' option must be set and the values of 'spelllang' and
8997 'spellsuggest' are used.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00008998
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02008999 Can also be used as a |method|: >
9000 GetWord()->spellsuggest()
Bram Moolenaara14de3d2005-01-07 21:48:26 +00009001
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00009002split({expr} [, {pattern} [, {keepempty}]]) *split()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00009003 Make a |List| out of {expr}. When {pattern} is omitted or
9004 empty each white-separated sequence of characters becomes an
9005 item.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00009006 Otherwise the string is split where {pattern} matches,
Bram Moolenaar97d62492012-11-15 21:28:22 +01009007 removing the matched characters. 'ignorecase' is not used
9008 here, add \c to ignore case. |/\c|
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00009009 When the first or last item is empty it is omitted, unless the
9010 {keepempty} argument is given and it's non-zero.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00009011 Other empty items are kept when {pattern} matches at least one
9012 character or when {keepempty} is non-zero.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00009013 Example: >
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00009014 :let words = split(getline('.'), '\W\+')
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00009015< To split a string in individual characters: >
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00009016 :for c in split(mystring, '\zs')
Bram Moolenaar12969c02015-09-08 23:36:10 +02009017< If you want to keep the separator you can also use '\zs' at
9018 the end of the pattern: >
Bram Moolenaar0cb032e2005-04-23 20:52:00 +00009019 :echo split('abc:def:ghi', ':\zs')
9020< ['abc:', 'def:', 'ghi'] ~
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00009021 Splitting a table where the first element can be empty: >
9022 :let items = split(line, ':', 1)
9023< The opposite function is |join()|.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00009024
Bram Moolenaara74e4942019-08-04 17:35:53 +02009025 Can also be used as a |method|: >
9026 GetString()->split()
Bram Moolenaara14de3d2005-01-07 21:48:26 +00009027
Bram Moolenaar446cb832008-06-24 21:56:24 +00009028sqrt({expr}) *sqrt()*
9029 Return the non-negative square root of Float {expr} as a
9030 |Float|.
9031 {expr} must evaluate to a |Float| or a |Number|. When {expr}
9032 is negative the result is NaN (Not a Number).
9033 Examples: >
9034 :echo sqrt(100)
9035< 10.0 >
9036 :echo sqrt(-4.01)
9037< nan
Bram Moolenaarc236c162008-07-13 17:41:49 +00009038 "nan" may be different, it depends on system libraries.
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02009039
9040 Can also be used as a |method|: >
9041 Compute()->sqrt()
9042<
Bram Moolenaar446cb832008-06-24 21:56:24 +00009043 {only available when compiled with the |+float| feature}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01009044
Bram Moolenaar446cb832008-06-24 21:56:24 +00009045
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02009046state([{what}]) *state()*
9047 Return a string which contains characters indicating the
9048 current state. Mostly useful in callbacks that want to do
9049 work that may not always be safe. Roughly this works like:
9050 - callback uses state() to check if work is safe to do.
9051 If yes, then do it right away.
9052 Otherwise add to work queue and add SafeState and/or
9053 SafeStateAgain autocommand.
9054 - When SafeState or SafeStateAgain is triggered, check with
9055 state() if the work can be done now, and if yes remove it
9056 from the queue and execute.
9057 Also see |mode()|.
9058
9059 When {what} is given only characters in this string will be
9060 added. E.g, this checks if the screen has scrolled: >
9061 if state('s') != ''
9062<
Bram Moolenaard103ee72019-09-18 21:15:31 +02009063 These characters indicate the state, generally indicating that
9064 something is busy:
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02009065 m halfway a mapping, :normal command, feedkeys() or
9066 stuffed command
9067 o operator pending or waiting for a command argument
9068 a Insert mode autocomplete active
9069 x executing an autocommand
9070 w blocked on waiting, e.g. ch_evalexpr() and
9071 ch_read(), ch_readraw() when reading json.
Bram Moolenaard103ee72019-09-18 21:15:31 +02009072 S not triggering SafeState or SafeStateAgain
9073 c callback invoked, including timer (repeats for
9074 recursiveness up to "ccc")
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02009075 s screen has scrolled for messages
9076
Bram Moolenaar81edd172016-04-14 13:51:37 +02009077str2float({expr}) *str2float()*
Bram Moolenaar446cb832008-06-24 21:56:24 +00009078 Convert String {expr} to a Float. This mostly works the same
9079 as when using a floating point number in an expression, see
9080 |floating-point-format|. But it's a bit more permissive.
9081 E.g., "1e40" is accepted, while in an expression you need to
Bram Moolenaard47d5222018-12-09 20:43:55 +01009082 write "1.0e40". The hexadecimal form "0x123" is also
9083 accepted, but not others, like binary or octal.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009084 Text after the number is silently ignored.
9085 The decimal point is always '.', no matter what the locale is
9086 set to. A comma ends the number: "12,345.67" is converted to
9087 12.0. You can strip out thousands separators with
9088 |substitute()|: >
9089 let f = str2float(substitute(text, ',', '', 'g'))
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02009090<
9091 Can also be used as a |method|: >
9092 let f = text->substitute(',', '', 'g')->str2float()
9093<
9094 {only available when compiled with the |+float| feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00009095
Bram Moolenaar9d401282019-04-06 13:18:12 +02009096str2list({expr} [, {utf8}]) *str2list()*
9097 Return a list containing the number values which represent
9098 each character in String {expr}. Examples: >
9099 str2list(" ") returns [32]
9100 str2list("ABC") returns [65, 66, 67]
9101< |list2str()| does the opposite.
9102
9103 When {utf8} is omitted or zero, the current 'encoding' is used.
9104 With {utf8} set to 1, always treat the String as utf-8
9105 characters. With utf-8 composing characters are handled
9106 properly: >
9107 str2list("á") returns [97, 769]
Bram Moolenaar446cb832008-06-24 21:56:24 +00009108
Bram Moolenaara74e4942019-08-04 17:35:53 +02009109< Can also be used as a |method|: >
9110 GetString()->str2list()
9111
9112
Bram Moolenaar60a8de22019-09-15 14:33:22 +02009113str2nr({expr} [, {base} [, {quoted}]]) *str2nr()*
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009114 Convert string {expr} to a number.
Bram Moolenaarfa735342016-01-03 22:14:44 +01009115 {base} is the conversion base, it can be 2, 8, 10 or 16.
Bram Moolenaar60a8de22019-09-15 14:33:22 +02009116 When {quoted} is present and non-zero then embedded single
9117 quotes are ignored, thus "1'000'000" is a million.
Bram Moolenaara74e4942019-08-04 17:35:53 +02009118
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009119 When {base} is omitted base 10 is used. This also means that
9120 a leading zero doesn't cause octal conversion to be used, as
Bram Moolenaara74e4942019-08-04 17:35:53 +02009121 with the default String to Number conversion. Example: >
9122 let nr = str2nr('123')
9123<
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009124 When {base} is 16 a leading "0x" or "0X" is ignored. With a
Bram Moolenaarfa735342016-01-03 22:14:44 +01009125 different base the result will be zero. Similarly, when
9126 {base} is 8 a leading "0" is ignored, and when {base} is 2 a
9127 leading "0b" or "0B" is ignored.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009128 Text after the number is silently ignored.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009129
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02009130 Can also be used as a |method|: >
9131 GetText()->str2nr()
9132
9133strcharpart({src}, {start} [, {len}]) *strcharpart()*
9134 Like |strpart()| but using character index and length instead
9135 of byte index and length.
9136 When a character index is used where a character does not
9137 exist it is assumed to be one character. For example: >
9138 strcharpart('abc', -1, 2)
9139< results in 'a'.
9140
9141 Can also be used as a |method|: >
9142 GetText()->strcharpart(5)
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009143
Bram Moolenaar979243b2015-06-26 19:35:49 +02009144strchars({expr} [, {skipcc}]) *strchars()*
Bram Moolenaar72597a52010-07-18 15:31:08 +02009145 The result is a Number, which is the number of characters
Bram Moolenaar979243b2015-06-26 19:35:49 +02009146 in String {expr}.
9147 When {skipcc} is omitted or zero, composing characters are
9148 counted separately.
9149 When {skipcc} set to 1, Composing characters are ignored.
Bram Moolenaardc536092010-07-18 15:45:49 +02009150 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01009151
Bram Moolenaar86ae7202015-07-10 19:31:35 +02009152 {skipcc} is only available after 7.4.755. For backward
9153 compatibility, you can define a wrapper function: >
9154 if has("patch-7.4.755")
9155 function s:strchars(str, skipcc)
9156 return strchars(a:str, a:skipcc)
9157 endfunction
9158 else
9159 function s:strchars(str, skipcc)
9160 if a:skipcc
9161 return strlen(substitute(a:str, ".", "x", "g"))
9162 else
9163 return strchars(a:str)
9164 endif
9165 endfunction
9166 endif
9167<
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02009168 Can also be used as a |method|: >
9169 GetText()->strchars()
Bram Moolenaar86ae7202015-07-10 19:31:35 +02009170
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01009171strdisplaywidth({expr} [, {col}]) *strdisplaywidth()*
Bram Moolenaardc536092010-07-18 15:45:49 +02009172 The result is a Number, which is the number of display cells
Bram Moolenaar4c92e752019-02-17 21:18:32 +01009173 String {expr} occupies on the screen when it starts at {col}
9174 (first column is zero). When {col} is omitted zero is used.
9175 Otherwise it is the screen column where to start. This
9176 matters for Tab characters.
Bram Moolenaar4d32c2d2010-07-18 22:10:01 +02009177 The option settings of the current window are used. This
9178 matters for anything that's displayed differently, such as
9179 'tabstop' and 'display'.
Bram Moolenaardc536092010-07-18 15:45:49 +02009180 When {expr} contains characters with East Asian Width Class
9181 Ambiguous, this function's return value depends on 'ambiwidth'.
9182 Also see |strlen()|, |strwidth()| and |strchars()|.
Bram Moolenaar72597a52010-07-18 15:31:08 +02009183
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02009184 Can also be used as a |method|: >
9185 GetText()->strdisplaywidth()
9186
Bram Moolenaar071d4272004-06-13 20:20:40 +00009187strftime({format} [, {time}]) *strftime()*
9188 The result is a String, which is a formatted date and time, as
9189 specified by the {format} string. The given {time} is used,
9190 or the current time if no time is given. The accepted
9191 {format} depends on your system, thus this is not portable!
9192 See the manual page of the C function strftime() for the
9193 format. The maximum length of the result is 80 characters.
9194 See also |localtime()| and |getftime()|.
9195 The language can be changed with the |:language| command.
9196 Examples: >
9197 :echo strftime("%c") Sun Apr 27 11:49:23 1997
9198 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
9199 :echo strftime("%y%m%d %T") 970427 11:53:55
9200 :echo strftime("%H:%M") 11:55
9201 :echo strftime("%c", getftime("file.c"))
9202 Show mod time of file.c.
Bram Moolenaara14de3d2005-01-07 21:48:26 +00009203< Not available on all systems. To check use: >
9204 :if exists("*strftime")
9205
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02009206< Can also be used as a |method|: >
9207 GetFormat()->strftime()
9208
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02009209strgetchar({str}, {index}) *strgetchar()*
9210 Get character {index} from {str}. This uses a character
9211 index, not a byte index. Composing characters are considered
9212 separate characters here.
9213 Also see |strcharpart()| and |strchars()|.
9214
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02009215 Can also be used as a |method|: >
9216 GetText()->strgetchar(5)
9217
Bram Moolenaar8f999f12005-01-25 22:12:55 +00009218stridx({haystack}, {needle} [, {start}]) *stridx()*
9219 The result is a Number, which gives the byte index in
9220 {haystack} of the first occurrence of the String {needle}.
Bram Moolenaar677ee682005-01-27 14:41:15 +00009221 If {start} is specified, the search starts at index {start}.
9222 This can be used to find a second match: >
Bram Moolenaar81af9252010-12-10 20:35:50 +01009223 :let colon1 = stridx(line, ":")
9224 :let colon2 = stridx(line, ":", colon1 + 1)
Bram Moolenaar677ee682005-01-27 14:41:15 +00009225< The search is done case-sensitive.
Bram Moolenaare2cc9702005-03-15 22:43:58 +00009226 For pattern searches use |match()|.
Bram Moolenaar8f999f12005-01-25 22:12:55 +00009227 -1 is returned if the {needle} does not occur in {haystack}.
Bram Moolenaar677ee682005-01-27 14:41:15 +00009228 See also |strridx()|.
9229 Examples: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009230 :echo stridx("An Example", "Example") 3
9231 :echo stridx("Starting point", "Start") 0
9232 :echo stridx("Starting point", "start") -1
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009233< *strstr()* *strchr()*
Bram Moolenaar05159a02005-02-26 23:04:13 +00009234 stridx() works similar to the C function strstr(). When used
9235 with a single character it works similar to strchr().
9236
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02009237 Can also be used as a |method|: >
9238 GetHaystack()->stridx(needle)
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00009239 *string()*
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00009240string({expr}) Return {expr} converted to a String. If {expr} is a Number,
Bram Moolenaar0d17f0d2019-01-22 22:20:38 +01009241 Float, String, Blob or a composition of them, then the result
9242 can be parsed back with |eval()|.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00009243 {expr} type result ~
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01009244 String 'string' (single quotes are doubled)
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00009245 Number 123
Bram Moolenaar446cb832008-06-24 21:56:24 +00009246 Float 123.123456 or 1.123456e8
Bram Moolenaard8b02732005-01-14 21:48:43 +00009247 Funcref function('name')
Bram Moolenaar0d17f0d2019-01-22 22:20:38 +01009248 Blob 0z00112233.44556677.8899
Bram Moolenaar5f2bb9f2005-01-11 21:29:04 +00009249 List [item, item]
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00009250 Dictionary {key: value, key: value}
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01009251
9252 When a List or Dictionary has a recursive reference it is
9253 replaced by "[...]" or "{...}". Using eval() on the result
9254 will then fail.
9255
Bram Moolenaarac92e252019-08-03 21:58:38 +02009256 Can also be used as a |method|: >
9257 mylist->string()
9258
9259< Also see |strtrans()|.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00009260
Bram Moolenaar071d4272004-06-13 20:20:40 +00009261 *strlen()*
9262strlen({expr}) The result is a Number, which is the length of the String
Bram Moolenaare344bea2005-09-01 20:46:49 +00009263 {expr} in bytes.
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +00009264 If the argument is a Number it is first converted to a String.
9265 For other types an error is given.
Bram Moolenaar641e48c2015-06-25 16:09:26 +02009266 If you want to count the number of multi-byte characters use
9267 |strchars()|.
9268 Also see |len()|, |strdisplaywidth()| and |strwidth()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009269
Bram Moolenaara74e4942019-08-04 17:35:53 +02009270 Can also be used as a |method|: >
9271 GetString()->strlen()
9272
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01009273strpart({src}, {start} [, {len}]) *strpart()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009274 The result is a String, which is part of {src}, starting from
Bram Moolenaar9372a112005-12-06 19:59:18 +00009275 byte {start}, with the byte length {len}.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02009276 To count characters instead of bytes use |strcharpart()|.
9277
9278 When bytes are selected which do not exist, this doesn't
9279 result in an error, the bytes are simply omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009280 If {len} is missing, the copy continues from {start} till the
9281 end of the {src}. >
9282 strpart("abcdefg", 3, 2) == "de"
9283 strpart("abcdefg", -2, 4) == "ab"
9284 strpart("abcdefg", 5, 4) == "fg"
Bram Moolenaar446cb832008-06-24 21:56:24 +00009285 strpart("abcdefg", 3) == "defg"
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02009286
Bram Moolenaar071d4272004-06-13 20:20:40 +00009287< Note: To get the first character, {start} must be 0. For
9288 example, to get three bytes under and after the cursor: >
Bram Moolenaar61660ea2006-04-07 21:40:07 +00009289 strpart(getline("."), col(".") - 1, 3)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009290<
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02009291 Can also be used as a |method|: >
9292 GetText()->strpart(5)
9293
Bram Moolenaar677ee682005-01-27 14:41:15 +00009294strridx({haystack}, {needle} [, {start}]) *strridx()*
9295 The result is a Number, which gives the byte index in
9296 {haystack} of the last occurrence of the String {needle}.
9297 When {start} is specified, matches beyond this index are
9298 ignored. This can be used to find a match before a previous
9299 match: >
9300 :let lastcomma = strridx(line, ",")
9301 :let comma2 = strridx(line, ",", lastcomma - 1)
9302< The search is done case-sensitive.
Bram Moolenaar8f999f12005-01-25 22:12:55 +00009303 For pattern searches use |match()|.
9304 -1 is returned if the {needle} does not occur in {haystack}.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00009305 If the {needle} is empty the length of {haystack} is returned.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00009306 See also |stridx()|. Examples: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009307 :echo strridx("an angry armadillo", "an") 3
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009308< *strrchr()*
Bram Moolenaar05159a02005-02-26 23:04:13 +00009309 When used with a single character it works similar to the C
9310 function strrchr().
9311
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02009312 Can also be used as a |method|: >
9313 GetHaystack()->strridx(needle)
9314
Bram Moolenaar071d4272004-06-13 20:20:40 +00009315strtrans({expr}) *strtrans()*
9316 The result is a String, which is {expr} with all unprintable
9317 characters translated into printable characters |'isprint'|.
9318 Like they are shown in a window. Example: >
9319 echo strtrans(@a)
9320< This displays a newline in register a as "^@" instead of
9321 starting a new line.
9322
Bram Moolenaara74e4942019-08-04 17:35:53 +02009323 Can also be used as a |method|: >
9324 GetString()->strtrans()
9325
Bram Moolenaar72597a52010-07-18 15:31:08 +02009326strwidth({expr}) *strwidth()*
9327 The result is a Number, which is the number of display cells
9328 String {expr} occupies. A Tab character is counted as one
Bram Moolenaardc536092010-07-18 15:45:49 +02009329 cell, alternatively use |strdisplaywidth()|.
Bram Moolenaar72597a52010-07-18 15:31:08 +02009330 When {expr} contains characters with East Asian Width Class
9331 Ambiguous, this function's return value depends on 'ambiwidth'.
Bram Moolenaardc536092010-07-18 15:45:49 +02009332 Also see |strlen()|, |strdisplaywidth()| and |strchars()|.
Bram Moolenaar72597a52010-07-18 15:31:08 +02009333
Bram Moolenaara74e4942019-08-04 17:35:53 +02009334 Can also be used as a |method|: >
9335 GetString()->strwidth()
9336
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01009337submatch({nr} [, {list}]) *submatch()* *E935*
Bram Moolenaar251e1912011-06-19 05:09:16 +02009338 Only for an expression in a |:substitute| command or
9339 substitute() function.
9340 Returns the {nr}'th submatch of the matched text. When {nr}
9341 is 0 the whole matched text is returned.
Bram Moolenaar41571762014-04-02 19:00:58 +02009342 Note that a NL in the string can stand for a line break of a
9343 multi-line match or a NUL character in the text.
Bram Moolenaar251e1912011-06-19 05:09:16 +02009344 Also see |sub-replace-expression|.
Bram Moolenaar41571762014-04-02 19:00:58 +02009345
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01009346 If {list} is present and non-zero then submatch() returns
9347 a list of strings, similar to |getline()| with two arguments.
Bram Moolenaar41571762014-04-02 19:00:58 +02009348 NL characters in the text represent NUL characters in the
9349 text.
9350 Only returns more than one item for |:substitute|, inside
9351 |substitute()| this list will always contain one or zero
9352 items, since there are no real line breaks.
9353
Bram Moolenaar6100d022016-10-02 16:51:57 +02009354 When substitute() is used recursively only the submatches in
9355 the current (deepest) call can be obtained.
9356
Bram Moolenaar2f058492017-11-30 20:27:52 +01009357 Examples: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009358 :s/\d\+/\=submatch(0) + 1/
Bram Moolenaar2f058492017-11-30 20:27:52 +01009359 :echo substitute(text, '\d\+', '\=submatch(0) + 1', '')
Bram Moolenaar071d4272004-06-13 20:20:40 +00009360< This finds the first number in the line and adds one to it.
9361 A line break is included as a newline character.
9362
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02009363 Can also be used as a |method|: >
9364 GetNr()->submatch()
9365
Bram Moolenaar071d4272004-06-13 20:20:40 +00009366substitute({expr}, {pat}, {sub}, {flags}) *substitute()*
9367 The result is a String, which is a copy of {expr}, in which
Bram Moolenaar251e1912011-06-19 05:09:16 +02009368 the first match of {pat} is replaced with {sub}.
9369 When {flags} is "g", all matches of {pat} in {expr} are
9370 replaced. Otherwise {flags} should be "".
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01009371
Bram Moolenaar251e1912011-06-19 05:09:16 +02009372 This works like the ":substitute" command (without any flags).
9373 But the matching with {pat} is always done like the 'magic'
9374 option is set and 'cpoptions' is empty (to make scripts
Bram Moolenaar2df58b42012-11-28 18:21:11 +01009375 portable). 'ignorecase' is still relevant, use |/\c| or |/\C|
9376 if you want to ignore or match case and ignore 'ignorecase'.
9377 'smartcase' is not used. See |string-match| for how {pat} is
9378 used.
Bram Moolenaar251e1912011-06-19 05:09:16 +02009379
9380 A "~" in {sub} is not replaced with the previous {sub}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009381 Note that some codes in {sub} have a special meaning
Bram Moolenaar58b85342016-08-14 19:54:54 +02009382 |sub-replace-special|. For example, to replace something with
Bram Moolenaar071d4272004-06-13 20:20:40 +00009383 "\n" (two characters), use "\\\\n" or '\\n'.
Bram Moolenaar251e1912011-06-19 05:09:16 +02009384
Bram Moolenaar071d4272004-06-13 20:20:40 +00009385 When {pat} does not match in {expr}, {expr} is returned
9386 unmodified.
Bram Moolenaar251e1912011-06-19 05:09:16 +02009387
Bram Moolenaar071d4272004-06-13 20:20:40 +00009388 Example: >
Bram Moolenaardf48fb42016-07-22 21:50:18 +02009389 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009390< This removes the last component of the 'path' option. >
Bram Moolenaardf48fb42016-07-22 21:50:18 +02009391 :echo substitute("testing", ".*", "\\U\\0", "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00009392< results in "TESTING".
Bram Moolenaar251e1912011-06-19 05:09:16 +02009393
9394 When {sub} starts with "\=", the remainder is interpreted as
9395 an expression. See |sub-replace-expression|. Example: >
Bram Moolenaardf48fb42016-07-22 21:50:18 +02009396 :echo substitute(s, '%\(\x\x\)',
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02009397 \ '\=nr2char("0x" . submatch(1))', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00009398
Bram Moolenaardf48fb42016-07-22 21:50:18 +02009399< When {sub} is a Funcref that function is called, with one
9400 optional argument. Example: >
9401 :echo substitute(s, '%\(\x\x\)', SubNr, 'g')
9402< The optional argument is a list which contains the whole
Bram Moolenaar58b85342016-08-14 19:54:54 +02009403 matched string and up to nine submatches, like what
9404 |submatch()| returns. Example: >
9405 :echo substitute(s, '%\(\x\x\)', {m -> '0x' . m[1]}, 'g')
Bram Moolenaardf48fb42016-07-22 21:50:18 +02009406
Bram Moolenaara74e4942019-08-04 17:35:53 +02009407< Can also be used as a |method|: >
9408 GetString()->substitute(pat, sub, flags)
9409
Bram Moolenaar20aac6c2018-09-02 21:07:30 +02009410swapinfo({fname}) *swapinfo()*
Bram Moolenaar00f123a2018-08-21 20:28:54 +02009411 The result is a dictionary, which holds information about the
9412 swapfile {fname}. The available fields are:
Bram Moolenaar95bafa22018-10-02 13:26:25 +02009413 version Vim version
Bram Moolenaar00f123a2018-08-21 20:28:54 +02009414 user user name
9415 host host name
9416 fname original file name
Bram Moolenaar95bafa22018-10-02 13:26:25 +02009417 pid PID of the Vim process that created the swap
Bram Moolenaar00f123a2018-08-21 20:28:54 +02009418 file
9419 mtime last modification time in seconds
9420 inode Optional: INODE number of the file
Bram Moolenaar47ad5652018-08-21 21:09:07 +02009421 dirty 1 if file was modified, 0 if not
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02009422 Note that "user" and "host" are truncated to at most 39 bytes.
Bram Moolenaar00f123a2018-08-21 20:28:54 +02009423 In case of failure an "error" item is added with the reason:
9424 Cannot open file: file not found or in accessible
9425 Cannot read file: cannot read first block
Bram Moolenaar47ad5652018-08-21 21:09:07 +02009426 Not a swap file: does not contain correct block ID
9427 Magic number mismatch: Info in first block is invalid
Bram Moolenaar00f123a2018-08-21 20:28:54 +02009428
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02009429 Can also be used as a |method|: >
9430 GetFilename()->swapinfo()
9431
Bram Moolenaar110bd602018-09-16 18:46:59 +02009432swapname({expr}) *swapname()*
9433 The result is the swap file path of the buffer {expr}.
9434 For the use of {expr}, see |bufname()| above.
9435 If buffer {expr} is the current buffer, the result is equal to
9436 |:swapname| (unless no swap file).
9437 If buffer {expr} has no swap file, returns an empty string.
9438
Bram Moolenaarf6ed61e2019-09-07 19:05:09 +02009439 Can also be used as a |method|: >
9440 GetBufname()->swapname()
9441
Bram Moolenaar47136d72004-10-12 20:02:24 +00009442synID({lnum}, {col}, {trans}) *synID()*
Bram Moolenaar071d4272004-06-13 20:20:40 +00009443 The result is a Number, which is the syntax ID at the position
Bram Moolenaar47136d72004-10-12 20:02:24 +00009444 {lnum} and {col} in the current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009445 The syntax ID can be used with |synIDattr()| and
9446 |synIDtrans()| to obtain syntax information about text.
Bram Moolenaarce0842a2005-07-18 21:58:11 +00009447
Bram Moolenaar47136d72004-10-12 20:02:24 +00009448 {col} is 1 for the leftmost column, {lnum} is 1 for the first
Bram Moolenaarce0842a2005-07-18 21:58:11 +00009449 line. 'synmaxcol' applies, in a longer line zero is returned.
Bram Moolenaarca635012015-09-25 20:34:21 +02009450 Note that when the position is after the last character,
9451 that's where the cursor can be in Insert mode, synID() returns
9452 zero.
Bram Moolenaarce0842a2005-07-18 21:58:11 +00009453
Bram Moolenaar79815f12016-07-09 17:07:29 +02009454 When {trans} is |TRUE|, transparent items are reduced to the
Bram Moolenaar58b85342016-08-14 19:54:54 +02009455 item that they reveal. This is useful when wanting to know
Bram Moolenaar79815f12016-07-09 17:07:29 +02009456 the effective color. When {trans} is |FALSE|, the transparent
Bram Moolenaar071d4272004-06-13 20:20:40 +00009457 item is returned. This is useful when wanting to know which
9458 syntax item is effective (e.g. inside parens).
9459 Warning: This function can be very slow. Best speed is
9460 obtained by going through the file in forward direction.
9461
9462 Example (echoes the name of the syntax item under the cursor): >
9463 :echo synIDattr(synID(line("."), col("."), 1), "name")
9464<
Bram Moolenaar7510fe72010-07-25 12:46:44 +02009465
Bram Moolenaar071d4272004-06-13 20:20:40 +00009466synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
9467 The result is a String, which is the {what} attribute of
9468 syntax ID {synID}. This can be used to obtain information
9469 about a syntax item.
9470 {mode} can be "gui", "cterm" or "term", to get the attributes
Bram Moolenaar58b85342016-08-14 19:54:54 +02009471 for that mode. When {mode} is omitted, or an invalid value is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009472 used, the attributes for the currently active highlighting are
9473 used (GUI, cterm or term).
9474 Use synIDtrans() to follow linked highlight groups.
9475 {what} result
9476 "name" the name of the syntax item
9477 "fg" foreground color (GUI: color name used to set
9478 the color, cterm: color number as a string,
9479 term: empty string)
Bram Moolenaar6f507d62008-11-28 10:16:05 +00009480 "bg" background color (as with "fg")
Bram Moolenaar12682fd2010-03-10 13:43:49 +01009481 "font" font name (only available in the GUI)
9482 |highlight-font|
Bram Moolenaar6f507d62008-11-28 10:16:05 +00009483 "sp" special color (as with "fg") |highlight-guisp|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009484 "fg#" like "fg", but for the GUI and the GUI is
9485 running the name in "#RRGGBB" form
9486 "bg#" like "fg#" for "bg"
Bram Moolenaar6f507d62008-11-28 10:16:05 +00009487 "sp#" like "fg#" for "sp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00009488 "bold" "1" if bold
9489 "italic" "1" if italic
9490 "reverse" "1" if reverse
9491 "inverse" "1" if inverse (= reverse)
Bram Moolenaar12682fd2010-03-10 13:43:49 +01009492 "standout" "1" if standout
Bram Moolenaar071d4272004-06-13 20:20:40 +00009493 "underline" "1" if underlined
Bram Moolenaare2cc9702005-03-15 22:43:58 +00009494 "undercurl" "1" if undercurled
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02009495 "strike" "1" if strikethrough
Bram Moolenaar071d4272004-06-13 20:20:40 +00009496
9497 Example (echoes the color of the syntax item under the
9498 cursor): >
9499 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
9500<
Bram Moolenaara74e4942019-08-04 17:35:53 +02009501 Can also be used as a |method|: >
9502 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
9503
9504
Bram Moolenaar071d4272004-06-13 20:20:40 +00009505synIDtrans({synID}) *synIDtrans()*
9506 The result is a Number, which is the translated syntax ID of
9507 {synID}. This is the syntax group ID of what is being used to
9508 highlight the character. Highlight links given with
9509 ":highlight link" are followed.
9510
Bram Moolenaara74e4942019-08-04 17:35:53 +02009511 Can also be used as a |method|: >
9512 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
9513
Bram Moolenaar483c5d82010-10-20 18:45:33 +02009514synconcealed({lnum}, {col}) *synconcealed()*
Bram Moolenaar4d785892017-06-22 22:00:50 +02009515 The result is a List with currently three items:
9516 1. The first item in the list is 0 if the character at the
9517 position {lnum} and {col} is not part of a concealable
9518 region, 1 if it is.
9519 2. The second item in the list is a string. If the first item
9520 is 1, the second item contains the text which will be
9521 displayed in place of the concealed text, depending on the
9522 current setting of 'conceallevel' and 'listchars'.
Bram Moolenaarcc0750d2017-06-24 22:29:24 +02009523 3. The third and final item in the list is a number
9524 representing the specific syntax region matched in the
9525 line. When the character is not concealed the value is
9526 zero. This allows detection of the beginning of a new
9527 concealable region if there are two consecutive regions
9528 with the same replacement character. For an example, if
9529 the text is "123456" and both "23" and "45" are concealed
Bram Moolenaar95bafa22018-10-02 13:26:25 +02009530 and replaced by the character "X", then:
Bram Moolenaarcc0750d2017-06-24 22:29:24 +02009531 call returns ~
Bram Moolenaarc572da52017-08-27 16:52:01 +02009532 synconcealed(lnum, 1) [0, '', 0]
9533 synconcealed(lnum, 2) [1, 'X', 1]
9534 synconcealed(lnum, 3) [1, 'X', 1]
9535 synconcealed(lnum, 4) [1, 'X', 2]
9536 synconcealed(lnum, 5) [1, 'X', 2]
9537 synconcealed(lnum, 6) [0, '', 0]
Bram Moolenaar483c5d82010-10-20 18:45:33 +02009538
9539
Bram Moolenaar9d188ab2008-01-10 21:24:39 +00009540synstack({lnum}, {col}) *synstack()*
9541 Return a |List|, which is the stack of syntax items at the
9542 position {lnum} and {col} in the current window. Each item in
9543 the List is an ID like what |synID()| returns.
Bram Moolenaar9d188ab2008-01-10 21:24:39 +00009544 The first item in the List is the outer region, following are
9545 items contained in that one. The last one is what |synID()|
9546 returns, unless not the whole item is highlighted or it is a
9547 transparent item.
9548 This function is useful for debugging a syntax file.
9549 Example that shows the syntax stack under the cursor: >
9550 for id in synstack(line("."), col("."))
9551 echo synIDattr(id, "name")
9552 endfor
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02009553< When the position specified with {lnum} and {col} is invalid
9554 nothing is returned. The position just after the last
9555 character in a line and the first column in an empty line are
9556 valid positions.
Bram Moolenaar9d188ab2008-01-10 21:24:39 +00009557
Bram Moolenaarc0197e22004-09-13 20:26:32 +00009558system({expr} [, {input}]) *system()* *E677*
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02009559 Get the output of the shell command {expr} as a string. See
9560 |systemlist()| to get the output as a List.
Bram Moolenaar57ebe6e2014-04-05 18:55:46 +02009561
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01009562 When {input} is given and is a string this string is written
9563 to a file and passed as stdin to the command. The string is
9564 written as-is, you need to take care of using the correct line
Bram Moolenaar57ebe6e2014-04-05 18:55:46 +02009565 separators yourself.
9566 If {input} is given and is a |List| it is written to the file
9567 in a way |writefile()| does with {binary} set to "b" (i.e.
9568 with a newline between each list item with newlines inside
Bram Moolenaar12c44922017-01-08 13:26:03 +01009569 list items converted to NULs).
9570 When {input} is given and is a number that is a valid id for
9571 an existing buffer then the content of the buffer is written
9572 to the file line by line, each line terminated by a NL and
9573 NULs characters where the text has a NL.
Bram Moolenaar069c1e72016-07-15 21:25:08 +02009574
9575 Pipes are not used, the 'shelltemp' option is not used.
Bram Moolenaar57ebe6e2014-04-05 18:55:46 +02009576
Bram Moolenaar04186092016-08-29 21:55:35 +02009577 When prepended by |:silent| the terminal will not be set to
Bram Moolenaar52a72462014-08-29 15:53:52 +02009578 cooked mode. This is meant to be used for commands that do
9579 not need the user to type. It avoids stray characters showing
9580 up on the screen which require |CTRL-L| to remove. >
9581 :silent let f = system('ls *.vim')
9582<
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01009583 Note: Use |shellescape()| or |::S| with |expand()| or
9584 |fnamemodify()| to escape special characters in a command
9585 argument. Newlines in {expr} may cause the command to fail.
9586 The characters in 'shellquote' and 'shellxquote' may also
Bram Moolenaar26df0922014-02-23 23:39:13 +01009587 cause trouble.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009588 This is not to be used for interactive commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009589
Bram Moolenaar05bb9532008-07-04 09:44:11 +00009590 The result is a String. Example: >
9591 :let files = system("ls " . shellescape(expand('%:h')))
Bram Moolenaar26df0922014-02-23 23:39:13 +01009592 :let files = system('ls ' . expand('%:h:S'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00009593
9594< To make the result more system-independent, the shell output
9595 is filtered to replace <CR> with <NL> for Macintosh, and
9596 <CR><NL> with <NL> for DOS-like systems.
Bram Moolenaar9d98fe92013-08-03 18:35:36 +02009597 To avoid the string being truncated at a NUL, all NUL
9598 characters are replaced with SOH (0x01).
9599
Bram Moolenaar071d4272004-06-13 20:20:40 +00009600 The command executed is constructed using several options:
9601 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
9602 ({tmp} is an automatically generated file name).
9603 For Unix and OS/2 braces are put around {expr} to allow for
9604 concatenated commands.
9605
Bram Moolenaar433f7c82006-03-21 21:29:36 +00009606 The command will be executed in "cooked" mode, so that a
9607 CTRL-C will interrupt the command (on Unix at least).
9608
Bram Moolenaar071d4272004-06-13 20:20:40 +00009609 The resulting error code can be found in |v:shell_error|.
9610 This function will fail in |restricted-mode|.
Bram Moolenaar4770d092006-01-12 23:22:24 +00009611
9612 Note that any wrong value in the options mentioned above may
9613 make the function fail. It has also been reported to fail
9614 when using a security agent application.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009615 Unlike ":!cmd" there is no automatic check for changed files.
9616 Use |:checktime| to force a check.
9617
Bram Moolenaara74e4942019-08-04 17:35:53 +02009618 Can also be used as a |method|: >
9619 :echo GetCmd()->system()
9620
Bram Moolenaare2cc9702005-03-15 22:43:58 +00009621
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02009622systemlist({expr} [, {input}]) *systemlist()*
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01009623 Same as |system()|, but returns a |List| with lines (parts of
9624 output separated by NL) with NULs transformed into NLs. Output
9625 is the same as |readfile()| will output with {binary} argument
Bram Moolenaar68563932017-01-10 13:31:15 +01009626 set to "b". Note that on MS-Windows you may get trailing CR
9627 characters.
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02009628
Bram Moolenaar975b5272016-03-15 23:10:59 +01009629 Returns an empty string on error.
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02009630
Bram Moolenaara74e4942019-08-04 17:35:53 +02009631 Can also be used as a |method|: >
9632 :echo GetCmd()->systemlist()
9633
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02009634
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00009635tabpagebuflist([{arg}]) *tabpagebuflist()*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00009636 The result is a |List|, where each item is the number of the
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00009637 buffer associated with each window in the current tab page.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02009638 {arg} specifies the number of the tab page to be used. When
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00009639 omitted the current tab page is used.
9640 When {arg} is invalid the number zero is returned.
9641 To get a list of all buffers in all tabs use this: >
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02009642 let buflist = []
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00009643 for i in range(tabpagenr('$'))
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02009644 call extend(buflist, tabpagebuflist(i + 1))
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00009645 endfor
9646< Note that a buffer may appear in more than one window.
9647
Bram Moolenaarce90e362019-09-08 18:58:44 +02009648 Can also be used as a |method|: >
9649 GetTabpage()->tabpagebuflist()
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00009650
9651tabpagenr([{arg}]) *tabpagenr()*
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00009652 The result is a Number, which is the number of the current
9653 tab page. The first tab page has number 1.
9654 When the optional argument is "$", the number of the last tab
9655 page is returned (the tab page count).
9656 The number can be used with the |:tab| command.
9657
9658
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01009659tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()*
Bram Moolenaard04f4402010-08-15 13:30:34 +02009660 Like |winnr()| but for tab page {tabarg}.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00009661 {tabarg} specifies the number of tab page to be used.
9662 {arg} is used like with |winnr()|:
9663 - When omitted the current window number is returned. This is
9664 the window which will be used when going to this tab page.
9665 - When "$" the number of windows is returned.
9666 - When "#" the previous window nr is returned.
9667 Useful examples: >
9668 tabpagewinnr(1) " current window of tab page 1
9669 tabpagewinnr(4, '$') " number of windows in tab page 4
9670< When {tabarg} is invalid zero is returned.
9671
Bram Moolenaarce90e362019-09-08 18:58:44 +02009672 Can also be used as a |method|: >
9673 GetTabpage()->tabpagewinnr()
9674<
Bram Moolenaarfa1d1402006-03-25 21:59:56 +00009675 *tagfiles()*
9676tagfiles() Returns a |List| with the file names used to search for tags
9677 for the current buffer. This is the 'tags' option expanded.
9678
9679
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01009680taglist({expr} [, {filename}]) *taglist()*
Bram Moolenaare2cc9702005-03-15 22:43:58 +00009681 Returns a list of tags matching the regular expression {expr}.
Bram Moolenaarc6aafba2017-03-21 17:09:10 +01009682
9683 If {filename} is passed it is used to prioritize the results
9684 in the same way that |:tselect| does. See |tag-priority|.
9685 {filename} should be the full path of the file.
9686
Bram Moolenaard8c00872005-07-22 21:52:15 +00009687 Each list item is a dictionary with at least the following
9688 entries:
Bram Moolenaar280f1262006-01-30 00:14:18 +00009689 name Name of the tag.
9690 filename Name of the file where the tag is
Bram Moolenaaref2f6562007-05-06 13:32:59 +00009691 defined. It is either relative to the
9692 current directory or a full path.
Bram Moolenaare2cc9702005-03-15 22:43:58 +00009693 cmd Ex command used to locate the tag in
9694 the file.
Bram Moolenaar280f1262006-01-30 00:14:18 +00009695 kind Type of the tag. The value for this
Bram Moolenaare2cc9702005-03-15 22:43:58 +00009696 entry depends on the language specific
Bram Moolenaaref2f6562007-05-06 13:32:59 +00009697 kind values. Only available when
9698 using a tags file generated by
9699 Exuberant ctags or hdrtag.
Bram Moolenaar280f1262006-01-30 00:14:18 +00009700 static A file specific tag. Refer to
Bram Moolenaare2cc9702005-03-15 22:43:58 +00009701 |static-tag| for more information.
Bram Moolenaaref2f6562007-05-06 13:32:59 +00009702 More entries may be present, depending on the content of the
9703 tags file: access, implementation, inherits and signature.
9704 Refer to the ctags documentation for information about these
9705 fields. For C code the fields "struct", "class" and "enum"
9706 may appear, they give the name of the entity the tag is
9707 contained in.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00009708
Bram Moolenaar214641f2017-03-05 17:04:09 +01009709 The ex-command "cmd" can be either an ex search pattern, a
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00009710 line number or a line number followed by a byte number.
Bram Moolenaare2cc9702005-03-15 22:43:58 +00009711
9712 If there are no matching tags, then an empty list is returned.
9713
9714 To get an exact tag match, the anchors '^' and '$' should be
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01009715 used in {expr}. This also make the function work faster.
9716 Refer to |tag-regexp| for more information about the tag
9717 search regular expression pattern.
Bram Moolenaare2cc9702005-03-15 22:43:58 +00009718
9719 Refer to |'tags'| for information about how the tags file is
9720 located by Vim. Refer to |tags-file-format| for the format of
9721 the tags file generated by the different ctags tools.
9722
Bram Moolenaarce90e362019-09-08 18:58:44 +02009723 Can also be used as a |method|: >
9724 GetTagpattern()->taglist()
9725
Bram Moolenaardb7c6862010-05-21 16:33:48 +02009726tan({expr}) *tan()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02009727 Return the tangent of {expr}, measured in radians, as a |Float|
Bram Moolenaardb7c6862010-05-21 16:33:48 +02009728 in the range [-inf, inf].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02009729 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02009730 Examples: >
9731 :echo tan(10)
9732< 0.648361 >
9733 :echo tan(-4.01)
9734< -1.181502
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02009735
9736 Can also be used as a |method|: >
9737 Compute()->tan()
9738<
Bram Moolenaardb84e452010-08-15 13:50:43 +02009739 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02009740
9741
9742tanh({expr}) *tanh()*
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02009743 Return the hyperbolic tangent of {expr} as a |Float| in the
Bram Moolenaardb7c6862010-05-21 16:33:48 +02009744 range [-1, 1].
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02009745 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaardb7c6862010-05-21 16:33:48 +02009746 Examples: >
9747 :echo tanh(0.5)
9748< 0.462117 >
9749 :echo tanh(-1)
9750< -0.761594
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02009751
9752 Can also be used as a |method|: >
9753 Compute()->tanh()
9754<
Bram Moolenaardb84e452010-08-15 13:50:43 +02009755 {only available when compiled with the |+float| feature}
Bram Moolenaardb7c6862010-05-21 16:33:48 +02009756
9757
Bram Moolenaar574860b2016-05-24 17:33:34 +02009758tempname() *tempname()* *temp-file-name*
9759 The result is a String, which is the name of a file that
Bram Moolenaar58b85342016-08-14 19:54:54 +02009760 doesn't exist. It can be used for a temporary file. The name
Bram Moolenaar574860b2016-05-24 17:33:34 +02009761 is different for at least 26 consecutive calls. Example: >
9762 :let tmpfile = tempname()
9763 :exe "redir > " . tmpfile
9764< For Unix, the file will be in a private directory |tempfile|.
9765 For MS-Windows forward slashes are used when the 'shellslash'
9766 option is set or when 'shellcmdflag' starts with '-'.
9767
Bram Moolenaared997ad2019-07-21 16:42:00 +02009768
Bram Moolenaar6bf2c622019-07-04 17:12:09 +02009769term_ functions are documented here: |terminal-function-details|
Bram Moolenaar574860b2016-05-24 17:33:34 +02009770
Bram Moolenaar54775062019-07-31 21:07:14 +02009771test_ functions are documented here: |test-functions-details|
Bram Moolenaar8e8df252016-05-25 21:23:21 +02009772
Bram Moolenaar574860b2016-05-24 17:33:34 +02009773
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02009774 *timer_info()*
9775timer_info([{id}])
9776 Return a list with information about timers.
9777 When {id} is given only information about this timer is
9778 returned. When timer {id} does not exist an empty list is
9779 returned.
9780 When {id} is omitted information about all timers is returned.
9781
9782 For each timer the information is stored in a Dictionary with
9783 these items:
9784 "id" the timer ID
9785 "time" time the timer was started with
9786 "remaining" time until the timer fires
9787 "repeat" number of times the timer will still fire;
Bram Moolenaarb73598e2016-08-07 18:22:53 +02009788 -1 means forever
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02009789 "callback" the callback
Bram Moolenaarb73598e2016-08-07 18:22:53 +02009790 "paused" 1 if the timer is paused, 0 otherwise
9791
Bram Moolenaarf92e58c2019-09-08 21:51:41 +02009792 Can also be used as a |method|: >
9793 GetTimer()->timer_info()
9794
9795< {only available when compiled with the |+timers| feature}
Bram Moolenaarb73598e2016-08-07 18:22:53 +02009796
9797timer_pause({timer}, {paused}) *timer_pause()*
9798 Pause or unpause a timer. A paused timer does not invoke its
Bram Moolenaardc1f1642016-08-16 18:33:43 +02009799 callback when its time expires. Unpausing a timer may cause
9800 the callback to be invoked almost immediately if enough time
9801 has passed.
Bram Moolenaarb73598e2016-08-07 18:22:53 +02009802
9803 Pausing a timer is useful to avoid the callback to be called
9804 for a short time.
9805
9806 If {paused} evaluates to a non-zero Number or a non-empty
9807 String, then the timer is paused, otherwise it is unpaused.
9808 See |non-zero-arg|.
9809
Bram Moolenaarf92e58c2019-09-08 21:51:41 +02009810 Can also be used as a |method|: >
9811 GetTimer()->timer_pause(1)
9812
9813< {only available when compiled with the |+timers| feature}
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02009814
Bram Moolenaardc1f1642016-08-16 18:33:43 +02009815 *timer_start()* *timer* *timers*
Bram Moolenaar975b5272016-03-15 23:10:59 +01009816timer_start({time}, {callback} [, {options}])
9817 Create a timer and return the timer ID.
9818
9819 {time} is the waiting time in milliseconds. This is the
9820 minimum time before invoking the callback. When the system is
9821 busy or Vim is not waiting for input the time will be longer.
9822
9823 {callback} is the function to call. It can be the name of a
Bram Moolenaarf37506f2016-08-31 22:22:10 +02009824 function or a |Funcref|. It is called with one argument, which
Bram Moolenaar975b5272016-03-15 23:10:59 +01009825 is the timer ID. The callback is only invoked when Vim is
9826 waiting for input.
9827
9828 {options} is a dictionary. Supported entries:
9829 "repeat" Number of times to repeat calling the
Bram Moolenaarabd468e2016-09-08 22:22:43 +02009830 callback. -1 means forever. When not present
9831 the callback will be called once.
Bram Moolenaarc577d812017-07-08 22:37:34 +02009832 If the timer causes an error three times in a
9833 row the repeat is cancelled. This avoids that
9834 Vim becomes unusable because of all the error
9835 messages.
Bram Moolenaar975b5272016-03-15 23:10:59 +01009836
9837 Example: >
9838 func MyHandler(timer)
9839 echo 'Handler called'
9840 endfunc
9841 let timer = timer_start(500, 'MyHandler',
9842 \ {'repeat': 3})
9843< This will invoke MyHandler() three times at 500 msec
9844 intervals.
Bram Moolenaarb73598e2016-08-07 18:22:53 +02009845
Bram Moolenaarf92e58c2019-09-08 21:51:41 +02009846 Can also be used as a |method|: >
9847 GetMsec()->timer_start(callback)
9848
9849< Not available in the |sandbox|.
Bram Moolenaar975b5272016-03-15 23:10:59 +01009850 {only available when compiled with the |+timers| feature}
9851
Bram Moolenaar03602ec2016-03-20 20:57:45 +01009852timer_stop({timer}) *timer_stop()*
Bram Moolenaar06d2d382016-05-20 17:24:11 +02009853 Stop a timer. The timer callback will no longer be invoked.
9854 {timer} is an ID returned by timer_start(), thus it must be a
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02009855 Number. If {timer} does not exist there is no error.
Bram Moolenaar03602ec2016-03-20 20:57:45 +01009856
Bram Moolenaarf92e58c2019-09-08 21:51:41 +02009857 Can also be used as a |method|: >
9858 GetTimer()->timer_stop()
9859
9860< {only available when compiled with the |+timers| feature}
Bram Moolenaarb73598e2016-08-07 18:22:53 +02009861
9862timer_stopall() *timer_stopall()*
9863 Stop all timers. The timer callbacks will no longer be
Bram Moolenaar809ce4d2019-07-13 21:21:40 +02009864 invoked. Useful if a timer is misbehaving. If there are no
9865 timers there is no error.
Bram Moolenaarb73598e2016-08-07 18:22:53 +02009866
9867 {only available when compiled with the |+timers| feature}
9868
Bram Moolenaar071d4272004-06-13 20:20:40 +00009869tolower({expr}) *tolower()*
9870 The result is a copy of the String given, with all uppercase
9871 characters turned into lowercase (just like applying |gu| to
9872 the string).
9873
Bram Moolenaarf92e58c2019-09-08 21:51:41 +02009874 Can also be used as a |method|: >
9875 GetText()->tolower()
9876
Bram Moolenaar071d4272004-06-13 20:20:40 +00009877toupper({expr}) *toupper()*
9878 The result is a copy of the String given, with all lowercase
9879 characters turned into uppercase (just like applying |gU| to
9880 the string).
9881
Bram Moolenaarf92e58c2019-09-08 21:51:41 +02009882 Can also be used as a |method|: >
9883 GetText()->toupper()
9884
Bram Moolenaar8299df92004-07-10 09:47:34 +00009885tr({src}, {fromstr}, {tostr}) *tr()*
9886 The result is a copy of the {src} string with all characters
9887 which appear in {fromstr} replaced by the character in that
9888 position in the {tostr} string. Thus the first character in
9889 {fromstr} is translated into the first character in {tostr}
9890 and so on. Exactly like the unix "tr" command.
9891 This code also deals with multibyte characters properly.
9892
9893 Examples: >
9894 echo tr("hello there", "ht", "HT")
9895< returns "Hello THere" >
9896 echo tr("<blob>", "<>", "{}")
9897< returns "{blob}"
9898
Bram Moolenaarf92e58c2019-09-08 21:51:41 +02009899 Can also be used as a |method|: >
9900 GetText()->tr(from, to)
9901
Bram Moolenaard473c8c2018-08-11 18:00:22 +02009902trim({text} [, {mask}]) *trim()*
Bram Moolenaar295ac5a2018-03-22 23:04:02 +01009903 Return {text} as a String where any character in {mask} is
9904 removed from the beginning and end of {text}.
9905 If {mask} is not given, {mask} is all characters up to 0x20,
9906 which includes Tab, space, NL and CR, plus the non-breaking
9907 space character 0xa0.
9908 This code deals with multibyte characters properly.
9909
9910 Examples: >
Bram Moolenaarab943432018-03-29 18:27:07 +02009911 echo trim(" some text ")
9912< returns "some text" >
9913 echo trim(" \r\t\t\r RESERVE \t\n\x0B\xA0") . "_TAIL"
Bram Moolenaar295ac5a2018-03-22 23:04:02 +01009914< returns "RESERVE_TAIL" >
Bram Moolenaarab943432018-03-29 18:27:07 +02009915 echo trim("rm<Xrm<>X>rrm", "rm<>")
9916< returns "Xrm<>X" (characters in the middle are not removed)
Bram Moolenaar295ac5a2018-03-22 23:04:02 +01009917
Bram Moolenaarf92e58c2019-09-08 21:51:41 +02009918 Can also be used as a |method|: >
9919 GetText()->trim()
9920
Bram Moolenaar446cb832008-06-24 21:56:24 +00009921trunc({expr}) *trunc()*
Bram Moolenaarc236c162008-07-13 17:41:49 +00009922 Return the largest integral value with magnitude less than or
Bram Moolenaar446cb832008-06-24 21:56:24 +00009923 equal to {expr} as a |Float| (truncate towards zero).
9924 {expr} must evaluate to a |Float| or a |Number|.
9925 Examples: >
9926 echo trunc(1.456)
9927< 1.0 >
9928 echo trunc(-5.456)
9929< -5.0 >
9930 echo trunc(4.0)
9931< 4.0
Bram Moolenaar93cf85f2019-08-17 21:36:28 +02009932
9933 Can also be used as a |method|: >
9934 Compute()->trunc()
9935<
Bram Moolenaar446cb832008-06-24 21:56:24 +00009936 {only available when compiled with the |+float| feature}
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01009937
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00009938 *type()*
Bram Moolenaardf48fb42016-07-22 21:50:18 +02009939type({expr}) The result is a Number representing the type of {expr}.
9940 Instead of using the number directly, it is better to use the
9941 v:t_ variable that has the value:
9942 Number: 0 |v:t_number|
9943 String: 1 |v:t_string|
9944 Funcref: 2 |v:t_func|
9945 List: 3 |v:t_list|
9946 Dictionary: 4 |v:t_dict|
9947 Float: 5 |v:t_float|
9948 Boolean: 6 |v:t_bool| (v:false and v:true)
Bram Moolenaar39536dd2019-01-29 22:58:21 +01009949 None: 7 |v:t_none| (v:null and v:none)
9950 Job: 8 |v:t_job|
9951 Channel: 9 |v:t_channel|
9952 Blob: 10 |v:t_blob|
Bram Moolenaardf48fb42016-07-22 21:50:18 +02009953 For backward compatibility, this method can be used: >
Bram Moolenaar9588a0f2005-01-08 21:45:39 +00009954 :if type(myvar) == type(0)
9955 :if type(myvar) == type("")
9956 :if type(myvar) == type(function("tr"))
9957 :if type(myvar) == type([])
Bram Moolenaar748bf032005-02-02 23:04:36 +00009958 :if type(myvar) == type({})
Bram Moolenaar446cb832008-06-24 21:56:24 +00009959 :if type(myvar) == type(0.0)
Bram Moolenaar705ada12016-01-24 17:56:50 +01009960 :if type(myvar) == type(v:false)
Bram Moolenaar6463ca22016-02-13 17:04:46 +01009961 :if type(myvar) == type(v:none)
Bram Moolenaardf48fb42016-07-22 21:50:18 +02009962< To check if the v:t_ variables exist use this: >
9963 :if exists('v:t_number')
Bram Moolenaar071d4272004-06-13 20:20:40 +00009964
Bram Moolenaarac92e252019-08-03 21:58:38 +02009965< Can also be used as a |method|: >
9966 mylist->type()
9967
Bram Moolenaara17d4c12010-05-30 18:30:36 +02009968undofile({name}) *undofile()*
9969 Return the name of the undo file that would be used for a file
9970 with name {name} when writing. This uses the 'undodir'
9971 option, finding directories that exist. It does not check if
Bram Moolenaar860cae12010-06-05 23:22:07 +02009972 the undo file exists.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02009973 {name} is always expanded to the full path, since that is what
9974 is used internally.
Bram Moolenaar80716072012-05-01 21:14:34 +02009975 If {name} is empty undofile() returns an empty string, since a
9976 buffer without a file name will not write an undo file.
Bram Moolenaara17d4c12010-05-30 18:30:36 +02009977 Useful in combination with |:wundo| and |:rundo|.
Bram Moolenaarb328cca2019-01-06 16:24:01 +01009978 When compiled without the |+persistent_undo| option this always
Bram Moolenaara17d4c12010-05-30 18:30:36 +02009979 returns an empty string.
9980
Bram Moolenaarf92e58c2019-09-08 21:51:41 +02009981 Can also be used as a |method|: >
9982 GetFilename()->undofile()
9983
Bram Moolenaara800b422010-06-27 01:15:55 +02009984undotree() *undotree()*
9985 Return the current state of the undo tree in a dictionary with
9986 the following items:
9987 "seq_last" The highest undo sequence number used.
9988 "seq_cur" The sequence number of the current position in
9989 the undo tree. This differs from "seq_last"
9990 when some changes were undone.
9991 "time_cur" Time last used for |:earlier| and related
9992 commands. Use |strftime()| to convert to
9993 something readable.
9994 "save_last" Number of the last file write. Zero when no
9995 write yet.
Bram Moolenaar730cde92010-06-27 05:18:54 +02009996 "save_cur" Number of the current position in the undo
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01009997 tree.
Bram Moolenaara800b422010-06-27 01:15:55 +02009998 "synced" Non-zero when the last undo block was synced.
9999 This happens when waiting from input from the
10000 user. See |undo-blocks|.
10001 "entries" A list of dictionaries with information about
10002 undo blocks.
10003
10004 The first item in the "entries" list is the oldest undo item.
10005 Each List item is a Dictionary with these items:
10006 "seq" Undo sequence number. Same as what appears in
10007 |:undolist|.
10008 "time" Timestamp when the change happened. Use
10009 |strftime()| to convert to something readable.
10010 "newhead" Only appears in the item that is the last one
10011 that was added. This marks the last change
10012 and where further changes will be added.
10013 "curhead" Only appears in the item that is the last one
10014 that was undone. This marks the current
10015 position in the undo tree, the block that will
10016 be used by a redo command. When nothing was
10017 undone after the last change this item will
10018 not appear anywhere.
10019 "save" Only appears on the last block before a file
10020 write. The number is the write count. The
10021 first write has number 1, the last one the
10022 "save_last" mentioned above.
10023 "alt" Alternate entry. This is again a List of undo
10024 blocks. Each item may again have an "alt"
10025 item.
10026
Bram Moolenaar327aa022014-03-25 18:24:23 +010010027uniq({list} [, {func} [, {dict}]]) *uniq()* *E882*
10028 Remove second and succeeding copies of repeated adjacent
10029 {list} items in-place. Returns {list}. If you want a list
10030 to remain unmodified make a copy first: >
10031 :let newlist = uniq(copy(mylist))
10032< The default compare function uses the string representation of
10033 each item. For the use of {func} and {dict} see |sort()|.
10034
Bram Moolenaarac92e252019-08-03 21:58:38 +020010035 Can also be used as a |method|: >
10036 mylist->uniq()
10037
Bram Moolenaar677ee682005-01-27 14:41:15 +000010038values({dict}) *values()*
Bram Moolenaar58b85342016-08-14 19:54:54 +020010039 Return a |List| with all the values of {dict}. The |List| is
Bram Moolenaar0d17f0d2019-01-22 22:20:38 +010010040 in arbitrary order. Also see |items()| and |keys()|.
Bram Moolenaar677ee682005-01-27 14:41:15 +000010041
Bram Moolenaarac92e252019-08-03 21:58:38 +020010042 Can also be used as a |method|: >
10043 mydict->values()
Bram Moolenaar677ee682005-01-27 14:41:15 +000010044
Bram Moolenaar071d4272004-06-13 20:20:40 +000010045virtcol({expr}) *virtcol()*
10046 The result is a Number, which is the screen column of the file
10047 position given with {expr}. That is, the last screen position
10048 occupied by the character at that position, when the screen
10049 would be of unlimited width. When there is a <Tab> at the
10050 position, the returned Number will be the column at the end of
10051 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
Bram Moolenaar61d35bd2012-03-28 20:51:51 +020010052 set to 8, it returns 8. |conceal| is ignored.
Bram Moolenaar477933c2007-07-17 14:32:23 +000010053 For the byte position use |col()|.
10054 For the use of {expr} see |col()|.
10055 When 'virtualedit' is used {expr} can be [lnum, col, off], where
Bram Moolenaar0b238792006-03-02 22:49:12 +000010056 "off" is the offset in screen columns from the start of the
Bram Moolenaard46bbc72007-05-12 14:38:41 +000010057 character. E.g., a position within a <Tab> or after the last
Bram Moolenaar97293012011-07-18 19:40:27 +020010058 character. When "off" is omitted zero is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010059 When Virtual editing is active in the current mode, a position
10060 beyond the end of the line can be returned. |'virtualedit'|
10061 The accepted positions are:
10062 . the cursor position
10063 $ the end of the cursor line (the result is the
10064 number of displayed characters in the cursor line
10065 plus one)
10066 'x position of mark x (if the mark is not set, 0 is
10067 returned)
Bram Moolenaare3faf442014-12-14 01:27:49 +010010068 v In Visual mode: the start of the Visual area (the
10069 cursor is the end). When not in Visual mode
10070 returns the cursor position. Differs from |'<| in
10071 that it's updated right away.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010072 Note that only marks in the current file can be used.
10073 Examples: >
10074 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5
10075 virtcol("$") with text "foo^Lbar", returns 9
Bram Moolenaar446cb832008-06-24 21:56:24 +000010076 virtcol("'t") with text " there", with 't at 'h', returns 6
Bram Moolenaar58b85342016-08-14 19:54:54 +020010077< The first column is 1. 0 is returned for an error.
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010078 A more advanced example that echoes the maximum length of
10079 all lines: >
10080 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
10081
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010082< Can also be used as a |method|: >
10083 GetPos()->virtcol()
Bram Moolenaar071d4272004-06-13 20:20:40 +000010084
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010085
10086visualmode([{expr}]) *visualmode()*
Bram Moolenaar071d4272004-06-13 20:20:40 +000010087 The result is a String, which describes the last Visual mode
Bram Moolenaarc9b4b052006-04-30 18:54:39 +000010088 used in the current buffer. Initially it returns an empty
10089 string, but once Visual mode has been used, it returns "v",
10090 "V", or "<CTRL-V>" (a single CTRL-V character) for
10091 character-wise, line-wise, or block-wise Visual mode
10092 respectively.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010093 Example: >
10094 :exe "normal " . visualmode()
10095< This enters the same Visual mode as before. It is also useful
10096 in scripts if you wish to act differently depending on the
10097 Visual mode that was used.
Bram Moolenaar446cb832008-06-24 21:56:24 +000010098 If Visual mode is active, use |mode()| to get the Visual mode
10099 (e.g., in a |:vmap|).
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010100 If {expr} is supplied and it evaluates to a non-zero Number or
Bram Moolenaar05bb9532008-07-04 09:44:11 +000010101 a non-empty String, then the Visual mode will be cleared and
Bram Moolenaare381d3d2016-07-07 14:50:41 +020010102 the old value is returned. See |non-zero-arg|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010103
Bram Moolenaar8738fc12013-02-20 17:59:11 +010010104wildmenumode() *wildmenumode()*
Bram Moolenaare381d3d2016-07-07 14:50:41 +020010105 Returns |TRUE| when the wildmenu is active and |FALSE|
Bram Moolenaar8738fc12013-02-20 17:59:11 +010010106 otherwise. See 'wildmenu' and 'wildmode'.
10107 This can be used in mappings to handle the 'wildcharm' option
10108 gracefully. (Makes only sense with |mapmode-c| mappings).
10109
10110 For example to make <c-j> work like <down> in wildmode, use: >
10111 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
10112<
10113 (Note, this needs the 'wildcharm' option set appropriately).
10114
Bram Moolenaar868b7b62019-05-29 21:44:40 +020010115win_execute({id}, {command} [, {silent}]) *win_execute()*
10116 Like `execute()` but in the context of window {id}.
10117 The window will temporarily be made the current window,
Bram Moolenaarb4230122019-05-30 18:40:53 +020010118 without triggering autocommands. When executing {command}
10119 autocommands will be triggered, this may have unexpected side
10120 effects. Use |:noautocmd| if needed.
Bram Moolenaar868b7b62019-05-29 21:44:40 +020010121 Example: >
Bram Moolenaarb4230122019-05-30 18:40:53 +020010122 call win_execute(winid, 'set syntax=python')
10123< Doing the same with `setwinvar()` would not trigger
10124 autocommands and not actually show syntax highlighting.
Bram Moolenaar61da1bf2019-06-06 12:14:49 +020010125 *E994*
10126 Not all commands are allowed in popup windows.
Bram Moolenaar56c860c2019-08-17 20:09:31 +020010127 When window {id} does not exist then no error is given.
Bram Moolenaar8738fc12013-02-20 17:59:11 +010010128
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010129 Can also be used as a |method|, the base is used for the
10130 command: >
10131 GetCommand()->win_execute(winid)
10132
Bram Moolenaar9cdf86b2016-03-13 19:04:51 +010010133win_findbuf({bufnr}) *win_findbuf()*
Bram Moolenaar7571d552016-08-18 22:54:46 +020010134 Returns a list with |window-ID|s for windows that contain
10135 buffer {bufnr}. When there is none the list is empty.
Bram Moolenaar9cdf86b2016-03-13 19:04:51 +010010136
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010137 Can also be used as a |method|: >
10138 GetBufnr()->win_findbuf()
10139
Bram Moolenaar86edef62016-03-13 18:07:30 +010010140win_getid([{win} [, {tab}]]) *win_getid()*
Bram Moolenaar7571d552016-08-18 22:54:46 +020010141 Get the |window-ID| for the specified window.
Bram Moolenaar86edef62016-03-13 18:07:30 +010010142 When {win} is missing use the current window.
10143 With {win} this is the window number. The top window has
Bram Moolenaarba3ff532018-11-04 14:45:49 +010010144 number 1.
Bram Moolenaar86edef62016-03-13 18:07:30 +010010145 Without {tab} use the current tab, otherwise the tab with
10146 number {tab}. The first tab has number one.
10147 Return zero if the window cannot be found.
10148
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010149 Can also be used as a |method|: >
10150 GetWinnr()->win_getid()
10151
Bram Moolenaar86edef62016-03-13 18:07:30 +010010152win_gotoid({expr}) *win_gotoid()*
10153 Go to window with ID {expr}. This may also change the current
10154 tabpage.
10155 Return 1 if successful, 0 if the window cannot be found.
10156
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010157 Can also be used as a |method|: >
10158 GetWinid()->win_gotoid()
10159
Bram Moolenaar03413f42016-04-12 21:07:15 +020010160win_id2tabwin({expr}) *win_id2tabwin()*
Bram Moolenaar86edef62016-03-13 18:07:30 +010010161 Return a list with the tab number and window number of window
10162 with ID {expr}: [tabnr, winnr].
10163 Return [0, 0] if the window cannot be found.
10164
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010165 Can also be used as a |method|: >
10166 GetWinid()->win_id2tabwin()
10167
Bram Moolenaar86edef62016-03-13 18:07:30 +010010168win_id2win({expr}) *win_id2win()*
10169 Return the window number of window with ID {expr}.
10170 Return 0 if the window cannot be found in the current tabpage.
10171
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010172 Can also be used as a |method|: >
10173 GetWinid()->win_id2win()
10174
Bram Moolenaar22044dc2017-12-02 15:43:37 +010010175win_screenpos({nr}) *win_screenpos()*
10176 Return the screen position of window {nr} as a list with two
10177 numbers: [row, col]. The first window always has position
Bram Moolenaar7132ddc2018-07-15 17:01:11 +020010178 [1, 1], unless there is a tabline, then it is [2, 1].
Bram Moolenaar22044dc2017-12-02 15:43:37 +010010179 {nr} can be the window number or the |window-ID|.
10180 Return [0, 0] if the window cannot be found in the current
10181 tabpage.
10182
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010183 Can also be used as a |method|: >
10184 GetWinid()->win_screenpos()
10185<
Bram Moolenaard20dcb32019-09-10 21:22:58 +020010186win_splitmove({nr}, {target} [, {options}]) *win_splitmove()*
10187 Move the window {nr} to a new split of the window {target}.
10188 This is similar to moving to {target}, creating a new window
10189 using |:split| but having the same contents as window {nr}, and
10190 then closing {nr}.
10191
10192 Both {nr} and {target} can be window numbers or |window-ID|s.
10193
10194 Returns zero for success, non-zero for failure.
10195
10196 {options} is a Dictionary with the following optional entries:
10197 "vertical" When TRUE, the split is created vertically,
10198 like with |:vsplit|.
10199 "rightbelow" When TRUE, the split is made below or to the
10200 right (if vertical). When FALSE, it is done
10201 above or to the left (if vertical). When not
10202 present, the values of 'splitbelow' and
10203 'splitright' are used.
10204
10205 Can also be used as a |method|: >
10206 GetWinid()->win_splitmove(target)
10207<
Bram Moolenaar071d4272004-06-13 20:20:40 +000010208 *winbufnr()*
10209winbufnr({nr}) The result is a Number, which is the number of the buffer
Bram Moolenaar888ccac2016-06-04 18:49:36 +020010210 associated with window {nr}. {nr} can be the window number or
Bram Moolenaar7571d552016-08-18 22:54:46 +020010211 the |window-ID|.
Bram Moolenaar888ccac2016-06-04 18:49:36 +020010212 When {nr} is zero, the number of the buffer in the current
10213 window is returned.
10214 When window {nr} doesn't exist, -1 is returned.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010215 Example: >
10216 :echo "The file in the current window is " . bufname(winbufnr(0))
10217<
Bram Moolenaare49fbff2019-08-21 22:50:07 +020010218 Can also be used as a |method|: >
10219 FindWindow()->winbufnr()->bufname()
10220<
Bram Moolenaar071d4272004-06-13 20:20:40 +000010221 *wincol()*
10222wincol() The result is a Number, which is the virtual column of the
10223 cursor in the window. This is counting screen cells from the
10224 left side of the window. The leftmost column is one.
10225
10226winheight({nr}) *winheight()*
10227 The result is a Number, which is the height of window {nr}.
Bram Moolenaar7571d552016-08-18 22:54:46 +020010228 {nr} can be the window number or the |window-ID|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010229 When {nr} is zero, the height of the current window is
10230 returned. When window {nr} doesn't exist, -1 is returned.
10231 An existing window always has a height of zero or more.
Bram Moolenaar37c64c72017-09-19 22:06:03 +020010232 This excludes any window toolbar line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010233 Examples: >
10234 :echo "The current window has " . winheight(0) . " lines."
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010235
10236< Can also be used as a |method|: >
10237 GetWinid()->winheight()
Bram Moolenaar071d4272004-06-13 20:20:40 +000010238<
Bram Moolenaar0f6b4f02018-08-21 16:56:34 +020010239winlayout([{tabnr}]) *winlayout()*
10240 The result is a nested List containing the layout of windows
10241 in a tabpage.
10242
10243 Without {tabnr} use the current tabpage, otherwise the tabpage
10244 with number {tabnr}. If the tabpage {tabnr} is not found,
10245 returns an empty list.
10246
10247 For a leaf window, it returns:
10248 ['leaf', {winid}]
10249 For horizontally split windows, which form a column, it
10250 returns:
10251 ['col', [{nested list of windows}]]
10252 For vertically split windows, which form a row, it returns:
10253 ['row', [{nested list of windows}]]
10254
10255 Example: >
10256 " Only one window in the tab page
10257 :echo winlayout()
10258 ['leaf', 1000]
10259 " Two horizontally split windows
10260 :echo winlayout()
10261 ['col', [['leaf', 1000], ['leaf', 1001]]]
10262 " Three horizontally split windows, with two
10263 " vertically split windows in the middle window
10264 :echo winlayout(2)
10265 ['col', [['leaf', 1002], ['row', ['leaf', 1003],
10266 ['leaf', 1001]]], ['leaf', 1000]]
10267<
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010268 Can also be used as a |method|: >
10269 GetTabnr()->winlayout()
10270<
Bram Moolenaar071d4272004-06-13 20:20:40 +000010271 *winline()*
10272winline() The result is a Number, which is the screen line of the cursor
Bram Moolenaar58b85342016-08-14 19:54:54 +020010273 in the window. This is counting screen lines from the top of
Bram Moolenaar071d4272004-06-13 20:20:40 +000010274 the window. The first line is one.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +000010275 If the cursor was moved the view on the file will be updated
10276 first, this may cause a scroll.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010277
10278 *winnr()*
Bram Moolenaar5eb86f92004-07-26 12:53:41 +000010279winnr([{arg}]) The result is a Number, which is the number of the current
10280 window. The top window has number 1.
Bram Moolenaar46ad2882019-04-08 20:01:47 +020010281
10282 The optional argument {arg} supports the following values:
10283 $ the number of the last window (the window
10284 count).
10285 # the number of the last accessed window (where
10286 |CTRL-W_p| goes to). If there is no previous
10287 window or it is in another tab page 0 is
10288 returned.
10289 {N}j the number of the Nth window below the
10290 current window (where |CTRL-W_j| goes to).
10291 {N}k the number of the Nth window above the current
10292 window (where |CTRL-W_k| goes to).
10293 {N}h the number of the Nth window left of the
10294 current window (where |CTRL-W_h| goes to).
10295 {N}l the number of the Nth window right of the
10296 current window (where |CTRL-W_l| goes to).
Bram Moolenaar5eb86f92004-07-26 12:53:41 +000010297 The number can be used with |CTRL-W_w| and ":wincmd w"
10298 |:wincmd|.
Bram Moolenaar690afe12017-01-28 18:34:47 +010010299 Also see |tabpagewinnr()| and |win_getid()|.
Bram Moolenaar46ad2882019-04-08 20:01:47 +020010300 Examples: >
10301 let window_count = winnr('$')
10302 let prev_window = winnr('#')
10303 let wnum = winnr('3k')
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010304
10305< Can also be used as a |method|: >
10306 GetWinval()->winnr()
Bram Moolenaar46ad2882019-04-08 20:01:47 +020010307<
Bram Moolenaar071d4272004-06-13 20:20:40 +000010308 *winrestcmd()*
10309winrestcmd() Returns a sequence of |:resize| commands that should restore
10310 the current window sizes. Only works properly when no windows
Bram Moolenaar87b5ca52006-03-04 21:55:31 +000010311 are opened or closed and the current window and tab page is
10312 unchanged.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010313 Example: >
10314 :let cmd = winrestcmd()
10315 :call MessWithWindowSizes()
10316 :exe cmd
Bram Moolenaar87b5ca52006-03-04 21:55:31 +000010317<
10318 *winrestview()*
10319winrestview({dict})
10320 Uses the |Dictionary| returned by |winsaveview()| to restore
10321 the view of the current window.
Bram Moolenaar82c25852014-05-28 16:47:16 +020010322 Note: The {dict} does not have to contain all values, that are
10323 returned by |winsaveview()|. If values are missing, those
10324 settings won't be restored. So you can use: >
10325 :call winrestview({'curswant': 4})
10326<
10327 This will only set the curswant value (the column the cursor
10328 wants to move on vertical movements) of the cursor to column 5
10329 (yes, that is 5), while all other settings will remain the
10330 same. This is useful, if you set the cursor position manually.
10331
Bram Moolenaar87b5ca52006-03-04 21:55:31 +000010332 If you have changed the values the result is unpredictable.
10333 If the window size changed the result won't be the same.
10334
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010335 Can also be used as a |method|: >
10336 GetView()->winrestview()
10337<
Bram Moolenaar87b5ca52006-03-04 21:55:31 +000010338 *winsaveview()*
10339winsaveview() Returns a |Dictionary| that contains information to restore
10340 the view of the current window. Use |winrestview()| to
10341 restore the view.
10342 This is useful if you have a mapping that jumps around in the
10343 buffer and you want to go back to the original view.
10344 This does not save fold information. Use the 'foldenable'
Bram Moolenaardb552d602006-03-23 22:59:57 +000010345 option to temporarily switch off folding, so that folds are
Bram Moolenaar07d87792014-07-19 14:04:47 +020010346 not opened when moving around. This may have side effects.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +000010347 The return value includes:
10348 lnum cursor line number
Bram Moolenaar82c25852014-05-28 16:47:16 +020010349 col cursor column (Note: the first column
10350 zero, as opposed to what getpos()
10351 returns)
Bram Moolenaar87b5ca52006-03-04 21:55:31 +000010352 coladd cursor column offset for 'virtualedit'
10353 curswant column for vertical movement
10354 topline first line in the window
10355 topfill filler lines, only in diff mode
10356 leftcol first column displayed
10357 skipcol columns skipped
10358 Note that no option values are saved.
10359
Bram Moolenaar071d4272004-06-13 20:20:40 +000010360
10361winwidth({nr}) *winwidth()*
10362 The result is a Number, which is the width of window {nr}.
Bram Moolenaar7571d552016-08-18 22:54:46 +020010363 {nr} can be the window number or the |window-ID|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010364 When {nr} is zero, the width of the current window is
10365 returned. When window {nr} doesn't exist, -1 is returned.
10366 An existing window always has a width of zero or more.
10367 Examples: >
10368 :echo "The current window has " . winwidth(0) . " columns."
10369 :if winwidth(0) <= 50
Bram Moolenaar7567d0b2017-11-16 23:04:15 +010010370 : 50 wincmd |
Bram Moolenaar071d4272004-06-13 20:20:40 +000010371 :endif
Bram Moolenaarf8be4612017-06-23 20:52:40 +020010372< For getting the terminal or screen size, see the 'columns'
10373 option.
Bram Moolenaar22fcfad2016-07-01 18:17:26 +020010374
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010375 Can also be used as a |method|: >
10376 GetWinid()->winwidth()
10377
Bram Moolenaar22fcfad2016-07-01 18:17:26 +020010378
Bram Moolenaared767a22016-01-03 22:49:16 +010010379wordcount() *wordcount()*
10380 The result is a dictionary of byte/chars/word statistics for
10381 the current buffer. This is the same info as provided by
10382 |g_CTRL-G|
10383 The return value includes:
10384 bytes Number of bytes in the buffer
10385 chars Number of chars in the buffer
10386 words Number of words in the buffer
10387 cursor_bytes Number of bytes before cursor position
10388 (not in Visual mode)
10389 cursor_chars Number of chars before cursor position
10390 (not in Visual mode)
10391 cursor_words Number of words before cursor position
10392 (not in Visual mode)
10393 visual_bytes Number of bytes visually selected
Bram Moolenaarf8be4612017-06-23 20:52:40 +020010394 (only in Visual mode)
Bram Moolenaared767a22016-01-03 22:49:16 +010010395 visual_chars Number of chars visually selected
Bram Moolenaarf8be4612017-06-23 20:52:40 +020010396 (only in Visual mode)
Bram Moolenaarc572da52017-08-27 16:52:01 +020010397 visual_words Number of words visually selected
Bram Moolenaarf8be4612017-06-23 20:52:40 +020010398 (only in Visual mode)
Bram Moolenaared767a22016-01-03 22:49:16 +010010399
10400
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +000010401 *writefile()*
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +010010402writefile({object}, {fname} [, {flags}])
10403 When {object} is a |List| write it to file {fname}. Each list
10404 item is separated with a NL. Each list item must be a String
10405 or Number.
Bram Moolenaar6b2e9382014-11-05 18:06:01 +010010406 When {flags} contains "b" then binary mode is used: There will
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +000010407 not be a NL after the last list item. An empty item at the
10408 end does cause the last line in the file to end in a NL.
Bram Moolenaar6b2e9382014-11-05 18:06:01 +010010409
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +010010410 When {object} is a |Blob| write the bytes to file {fname}
10411 unmodified.
10412
Bram Moolenaar6b2e9382014-11-05 18:06:01 +010010413 When {flags} contains "a" then append mode is used, lines are
Bram Moolenaar46fceaa2016-10-23 21:21:08 +020010414 appended to the file: >
Bram Moolenaar6b2e9382014-11-05 18:06:01 +010010415 :call writefile(["foo"], "event.log", "a")
10416 :call writefile(["bar"], "event.log", "a")
Bram Moolenaar7567d0b2017-11-16 23:04:15 +010010417<
10418 When {flags} contains "s" then fsync() is called after writing
10419 the file. This flushes the file to disk, if possible. This
10420 takes more time but avoids losing the file if the system
10421 crashes.
Bram Moolenaar74240d32017-12-10 15:26:15 +010010422 When {flags} does not contain "S" or "s" then fsync() is
10423 called if the 'fsync' option is set.
Bram Moolenaar7567d0b2017-11-16 23:04:15 +010010424 When {flags} contains "S" then fsync() is not called, even
10425 when 'fsync' is set.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +010010426
Bram Moolenaar7567d0b2017-11-16 23:04:15 +010010427 All NL characters are replaced with a NUL character.
Bram Moolenaar3a7c85b2005-02-05 21:39:53 +000010428 Inserting CR characters needs to be done before passing {list}
10429 to writefile().
10430 An existing file is overwritten, if possible.
10431 When the write fails -1 is returned, otherwise 0. There is an
10432 error message if the file can't be created or when writing
10433 fails.
10434 Also see |readfile()|.
10435 To copy a file byte for byte: >
10436 :let fl = readfile("foo", "b")
10437 :call writefile(fl, "foocopy", "b")
Bram Moolenaard6e256c2011-12-14 15:32:50 +010010438
Bram Moolenaarf92e58c2019-09-08 21:51:41 +020010439< Can also be used as a |method|: >
10440 GetText()->writefile("thefile")
10441
Bram Moolenaard6e256c2011-12-14 15:32:50 +010010442
10443xor({expr}, {expr}) *xor()*
10444 Bitwise XOR on the two arguments. The arguments are converted
10445 to a number. A List, Dict or Float argument causes an error.
10446 Example: >
10447 :let bits = xor(bits, 0x80)
Bram Moolenaar073e4b92019-08-18 23:01:56 +020010448< Can also be used as a |method|: >
10449 :let bits = bits->xor(0x80)
Bram Moolenaar6ee8d892012-01-10 14:55:01 +010010450<
Bram Moolenaard6e256c2011-12-14 15:32:50 +010010451
Bram Moolenaar071d4272004-06-13 20:20:40 +000010452
10453 *feature-list*
Bram Moolenaar946e27a2014-06-25 18:50:27 +020010454There are four types of features:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000104551. Features that are only supported when they have been enabled when Vim
10456 was compiled |+feature-list|. Example: >
10457 :if has("cindent")
104582. Features that are only supported when certain conditions have been met.
10459 Example: >
10460 :if has("gui_running")
10461< *has-patch*
Bram Moolenaar2f018892018-05-18 18:12:06 +0200104623. Beyond a certain version or at a certain version and including a specific
10463 patch. The "patch-7.4.248" feature means that the Vim version is 7.5 or
10464 later, or it is version 7.4 and patch 248 was included. Example: >
Bram Moolenaarbcb98982014-05-01 14:08:19 +020010465 :if has("patch-7.4.248")
Bram Moolenaar2f018892018-05-18 18:12:06 +020010466< Note that it's possible for patch 248 to be omitted even though 249 is
10467 included. Only happens when cherry-picking patches.
10468 Note that this form only works for patch 7.4.237 and later, before that
10469 you need to check for the patch and the v:version. Example (checking
10470 version 6.2.148 or later): >
10471 :if v:version > 602 || (v:version == 602 && has("patch148"))
Bram Moolenaar071d4272004-06-13 20:20:40 +000010472
Bram Moolenaard823fa92016-08-12 16:29:27 +020010473Hint: To find out if Vim supports backslashes in a file name (MS-Windows),
10474use: `if exists('+shellslash')`
10475
10476
Bram Moolenaar7cba6c02013-09-05 22:13:31 +020010477acl Compiled with |ACL| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010478all_builtin_terms Compiled with all builtin terminals enabled.
10479amiga Amiga version of Vim.
10480arabic Compiled with Arabic support |Arabic|.
10481arp Compiled with ARP support (Amiga).
Bram Moolenaar39536dd2019-01-29 22:58:21 +010010482autocmd Compiled with autocommand support. (always true)
Bram Moolenaar91f84f62018-07-29 15:07:52 +020010483autochdir Compiled with support for 'autochdir'
Bram Moolenaare42a6d22017-11-12 19:21:51 +010010484autoservername Automatically enable |clientserver|
Bram Moolenaar071d4272004-06-13 20:20:40 +000010485balloon_eval Compiled with |balloon-eval| support.
Bram Moolenaar45360022005-07-21 21:08:21 +000010486balloon_multiline GUI supports multiline balloons.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010487beos BeOS version of Vim.
10488browse Compiled with |:browse| support, and browse() will
10489 work.
Bram Moolenaar30b65812012-07-12 22:01:11 +020010490browsefilter Compiled with support for |browsefilter|.
Bram Moolenaar39536dd2019-01-29 22:58:21 +010010491bsd Compiled on an OS in the BSD family (excluding macOS).
Bram Moolenaar071d4272004-06-13 20:20:40 +000010492builtin_terms Compiled with some builtin terminals.
10493byte_offset Compiled with support for 'o' in 'statusline'
10494cindent Compiled with 'cindent' support.
10495clientserver Compiled with remote invocation support |clientserver|.
10496clipboard Compiled with 'clipboard' support.
Bram Moolenaar4999a7f2019-08-10 22:21:48 +020010497clipboard_working Compiled with 'clipboard' support and it can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010498cmdline_compl Compiled with |cmdline-completion| support.
10499cmdline_hist Compiled with |cmdline-history| support.
10500cmdline_info Compiled with 'showcmd' and 'ruler' support.
10501comments Compiled with |'comments'| support.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +010010502compatible Compiled to be very Vi compatible.
Bram Moolenaaraa5df7e2019-02-03 14:53:10 +010010503conpty Platform where |ConPTY| can be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010504cryptv Compiled with encryption support |encryption|.
10505cscope Compiled with |cscope| support.
Bram Moolenaar314dd792019-02-03 15:27:20 +010010506cursorbind Compiled with |'cursorbind'| (always true)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010507debug Compiled with "DEBUG" defined.
10508dialog_con Compiled with console dialog support.
10509dialog_gui Compiled with GUI dialog support.
10510diff Compiled with |vimdiff| and 'diff' support.
10511digraphs Compiled with support for digraphs.
Bram Moolenaar58b85342016-08-14 19:54:54 +020010512directx Compiled with support for DirectX and 'renderoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010513dnd Compiled with support for the "~ register |quote_~|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010514ebcdic Compiled on a machine with ebcdic character set.
10515emacs_tags Compiled with support for Emacs tags.
10516eval Compiled with expression evaluation support. Always
10517 true, of course!
Bram Moolenaar39536dd2019-01-29 22:58:21 +010010518ex_extra |+ex_extra| (always true)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010519extra_search Compiled with support for |'incsearch'| and
10520 |'hlsearch'|
10521farsi Compiled with Farsi support |farsi|.
10522file_in_path Compiled with support for |gf| and |<cfile>|
Bram Moolenaar26a60b42005-02-22 08:49:11 +000010523filterpipe When 'shelltemp' is off pipes are used for shell
10524 read/write/filter commands
Bram Moolenaar071d4272004-06-13 20:20:40 +000010525find_in_path Compiled with support for include file searches
10526 |+find_in_path|.
Bram Moolenaar446cb832008-06-24 21:56:24 +000010527float Compiled with support for |Float|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010528fname_case Case in file names matters (for Amiga, MS-DOS, and
10529 Windows this is not present).
10530folding Compiled with |folding| support.
10531footer Compiled with GUI footer support. |gui-footer|
10532fork Compiled to use fork()/exec() instead of system().
10533gettext Compiled with message translation |multi-lang|
10534gui Compiled with GUI enabled.
10535gui_athena Compiled with Athena GUI.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +010010536gui_gnome Compiled with Gnome support (gui_gtk is also defined).
Bram Moolenaar071d4272004-06-13 20:20:40 +000010537gui_gtk Compiled with GTK+ GUI (any version).
10538gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
Bram Moolenaar98921892016-02-23 17:14:37 +010010539gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined).
Bram Moolenaar071d4272004-06-13 20:20:40 +000010540gui_mac Compiled with Macintosh GUI.
10541gui_motif Compiled with Motif GUI.
10542gui_photon Compiled with Photon GUI.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +010010543gui_running Vim is running in the GUI, or it will start soon.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010544gui_win32 Compiled with MS Windows Win32 GUI.
10545gui_win32s idem, and Win32s system being used (Windows 3.1)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010546hangul_input Compiled with Hangul input support. |hangul|
Bram Moolenaar39536dd2019-01-29 22:58:21 +010010547hpux HP-UX version of Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010548iconv Can use iconv() for conversion.
10549insert_expand Compiled with support for CTRL-X expansion commands in
Bram Moolenaare49fbff2019-08-21 22:50:07 +020010550 Insert mode. (always true)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010551jumplist Compiled with |jumplist| support.
10552keymap Compiled with 'keymap' support.
Bram Moolenaar437bafe2016-08-01 15:40:54 +020010553lambda Compiled with |lambda| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010554langmap Compiled with 'langmap' support.
10555libcall Compiled with |libcall()| support.
Bram Moolenaar597a4222014-06-25 14:39:50 +020010556linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and
10557 'breakindent' support.
Bram Moolenaar39536dd2019-01-29 22:58:21 +010010558linux Linux version of Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010559lispindent Compiled with support for lisp indenting.
10560listcmds Compiled with commands for the buffer list |:files|
10561 and the argument list |arglist|.
10562localmap Compiled with local mappings and abbr. |:map-local|
Bram Moolenaar0ba04292010-07-14 23:23:17 +020010563lua Compiled with Lua interface |Lua|.
Bram Moolenaard0573012017-10-28 21:11:06 +020010564mac Any Macintosh version of Vim cf. osx
10565macunix Synonym for osxdarwin
Bram Moolenaar071d4272004-06-13 20:20:40 +000010566menu Compiled with support for |:menu|.
10567mksession Compiled with support for |:mksession|.
10568modify_fname Compiled with file name modifiers. |filename-modifiers|
Bram Moolenaara0d1fef2019-09-04 22:29:14 +020010569 (always true)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010570mouse Compiled with support mouse.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010571mouse_dec Compiled with support for Dec terminal mouse.
10572mouse_gpm Compiled with support for gpm (Linux console mouse)
Bram Moolenaar4b8366b2019-05-04 17:34:34 +020010573mouse_gpm_enabled GPM mouse is working
Bram Moolenaar071d4272004-06-13 20:20:40 +000010574mouse_netterm Compiled with support for netterm mouse.
10575mouse_pterm Compiled with support for qnx pterm mouse.
Bram Moolenaar446cb832008-06-24 21:56:24 +000010576mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse)
Bram Moolenaar9b451252012-08-15 17:43:31 +020010577mouse_sgr Compiled with support for sgr mouse.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +010010578mouse_urxvt Compiled with support for urxvt mouse.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010579mouse_xterm Compiled with support for xterm mouse.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +010010580mouseshape Compiled with support for 'mouseshape'.
Bram Moolenaar4c92e752019-02-17 21:18:32 +010010581multi_byte Compiled with support for 'encoding' (always true)
Bram Moolenaar42022d52008-12-09 09:57:49 +000010582multi_byte_encoding 'encoding' is set to a multi-byte encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010583multi_byte_ime Compiled with support for IME input method.
10584multi_lang Compiled with support for multiple languages.
Bram Moolenaar325b7a22004-07-05 15:58:32 +000010585mzscheme Compiled with MzScheme interface |mzscheme|.
Bram Moolenaarb26e6322010-05-22 21:34:09 +020010586netbeans_enabled Compiled with support for |netbeans| and connected.
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +010010587netbeans_intg Compiled with support for |netbeans|.
Bram Moolenaar22fcfad2016-07-01 18:17:26 +020010588num64 Compiled with 64-bit |Number| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010589ole Compiled with OLE automation support for Win32.
Bram Moolenaard0573012017-10-28 21:11:06 +020010590osx Compiled for macOS cf. mac
10591osxdarwin Compiled for macOS, with |mac-darwin-feature|
Bram Moolenaar91c49372016-05-08 09:50:29 +020010592packages Compiled with |packages| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010593path_extra Compiled with up/downwards search in 'path' and 'tags'
10594perl Compiled with Perl interface.
Bram Moolenaar55debbe2010-05-23 23:34:36 +020010595persistent_undo Compiled with support for persistent undo history.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010596postscript Compiled with PostScript file printing.
10597printer Compiled with |:hardcopy| support.
Bram Moolenaar05159a02005-02-26 23:04:13 +000010598profile Compiled with |:profile| support.
Bram Moolenaar84b242c2018-01-28 17:45:49 +010010599python Python 2.x interface available. |has-python|
10600python_compiled Compiled with Python 2.x interface. |has-python|
10601python_dynamic Python 2.x interface is dynamically loaded. |has-python|
10602python3 Python 3.x interface available. |has-python|
10603python3_compiled Compiled with Python 3.x interface. |has-python|
10604python3_dynamic Python 3.x interface is dynamically loaded. |has-python|
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +010010605pythonx Compiled with |python_x| interface. |has-pythonx|
Bram Moolenaar071d4272004-06-13 20:20:40 +000010606qnx QNX version of Vim.
10607quickfix Compiled with |quickfix| support.
Bram Moolenaard68071d2006-05-02 22:08:30 +000010608reltime Compiled with |reltime()| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010609rightleft Compiled with 'rightleft' support.
10610ruby Compiled with Ruby interface |ruby|.
Bram Moolenaar39536dd2019-01-29 22:58:21 +010010611scrollbind Compiled with 'scrollbind' support. (always true)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010612showcmd Compiled with 'showcmd' support.
10613signs Compiled with |:sign| support.
10614smartindent Compiled with 'smartindent' support.
Bram Moolenaar427f5b62019-06-09 13:43:51 +020010615sound Compiled with sound support, e.g. `sound_playevent()`
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +010010616spell Compiled with spell checking support |spell|.
Bram Moolenaaref94eec2009-11-11 13:22:11 +000010617startuptime Compiled with |--startuptime| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010618statusline Compiled with support for 'statusline', 'rulerformat'
10619 and special formats of 'titlestring' and 'iconstring'.
Bram Moolenaar39536dd2019-01-29 22:58:21 +010010620sun SunOS version of Vim.
Bram Moolenaard09091d2019-01-17 16:07:22 +010010621sun_workshop Support for Sun |workshop| has been removed.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +000010622syntax Compiled with syntax highlighting support |syntax|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010623syntax_items There are active syntax highlighting items for the
10624 current buffer.
10625system Compiled to use system() instead of fork()/exec().
10626tag_binary Compiled with binary searching in tags files
10627 |tag-binary-search|.
Bram Moolenaar723dd942019-04-04 13:11:03 +020010628tag_old_static Support for old static tags was removed, see
Bram Moolenaar071d4272004-06-13 20:20:40 +000010629 |tag-old-static|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010630tcl Compiled with Tcl interface.
Bram Moolenaar91c49372016-05-08 09:50:29 +020010631termguicolors Compiled with true color in terminal support.
Bram Moolenaarc2ce52c2017-08-01 18:35:38 +020010632terminal Compiled with |terminal| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010633terminfo Compiled with terminfo instead of termcap.
10634termresponse Compiled with support for |t_RV| and |v:termresponse|.
10635textobjects Compiled with support for |text-objects|.
Bram Moolenaar98aefe72018-12-13 22:20:09 +010010636textprop Compiled with support for |text-properties|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010637tgetent Compiled with tgetent support, able to use a termcap
10638 or terminfo file.
Bram Moolenaar975b5272016-03-15 23:10:59 +010010639timers Compiled with |timer_start()| support.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010640title Compiled with window title support |'title'|.
10641toolbar Compiled with support for |gui-toolbar|.
Bram Moolenaar2cab0e12016-11-24 15:09:07 +010010642ttyin input is a terminal (tty)
10643ttyout output is a terminal (tty)
Bram Moolenaar37c64c72017-09-19 22:06:03 +020010644unix Unix version of Vim. *+unix*
Bram Moolenaar3df01732017-02-17 22:47:16 +010010645unnamedplus Compiled with support for "unnamedplus" in 'clipboard'
Bram Moolenaarac9fb182019-04-27 13:04:13 +020010646user_commands User-defined commands. (always true)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010010647vcon Win32: Virtual console support is working, can use
10648 'termguicolors'. Also see |+vtp|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010649vertsplit Compiled with vertically split windows |:vsplit|.
Bram Moolenaar39536dd2019-01-29 22:58:21 +010010650 (always true)
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +010010651vim_starting True while initial source'ing takes place. |startup|
Bram Moolenaar4f3f6682016-03-26 23:01:59 +010010652 *vim_starting*
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +010010653viminfo Compiled with viminfo support.
Bram Moolenaar558ca4a2019-04-04 18:15:38 +020010654vimscript-1 Compiled Vim script version 1 support
10655vimscript-2 Compiled Vim script version 2 support
Bram Moolenaar911ead12019-04-21 00:03:35 +020010656vimscript-3 Compiled Vim script version 3 support
Bram Moolenaar39536dd2019-01-29 22:58:21 +010010657virtualedit Compiled with 'virtualedit' option. (always true)
Bram Moolenaar5b69c222019-01-11 14:50:06 +010010658visual Compiled with Visual mode. (always true)
10659visualextra Compiled with extra Visual mode commands. (always
10660 true) |blockwise-operators|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010661vms VMS version of Vim.
Bram Moolenaar39536dd2019-01-29 22:58:21 +010010662vreplace Compiled with |gR| and |gr| commands. (always true)
Bram Moolenaar98ef2332018-03-18 14:44:37 +010010663vtp Compiled for vcon support |+vtp| (check vcon to find
Bram Moolenaar5a3a49e2018-03-20 18:35:53 +010010664 out if it works in the current console).
Bram Moolenaar071d4272004-06-13 20:20:40 +000010665wildignore Compiled with 'wildignore' option.
10666wildmenu Compiled with 'wildmenu' option.
Bram Moolenaar39536dd2019-01-29 22:58:21 +010010667win16 old version for MS-Windows 3.1 (always false)
Bram Moolenaard58e9292011-02-09 17:07:58 +010010668win32 Win32 version of Vim (MS-Windows 95 and later, 32 or
10669 64 bits)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010670win32unix Win32 version of Vim, using Unix files (Cygwin)
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +010010671win64 Win64 version of Vim (MS-Windows 64 bit).
Bram Moolenaar39536dd2019-01-29 22:58:21 +010010672win95 Win32 version for MS-Windows 95/98/ME (always false)
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +010010673winaltkeys Compiled with 'winaltkeys' option.
10674windows Compiled with support for more than one window.
Bram Moolenaar39536dd2019-01-29 22:58:21 +010010675 (always true)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010676writebackup Compiled with 'writebackup' default on.
10677xfontset Compiled with X fontset support |xfontset|.
10678xim Compiled with X input method support |xim|.
Bram Moolenaar7cba6c02013-09-05 22:13:31 +020010679xpm Compiled with pixmap support.
10680xpm_w32 Compiled with pixmap support for Win32. (Only for
10681 backward compatibility. Use "xpm" instead.)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010682xsmp Compiled with X session management support.
10683xsmp_interact Compiled with interactive X session management support.
10684xterm_clipboard Compiled with support for xterm clipboard.
10685xterm_save Compiled with support for saving and restoring the
10686 xterm screen.
10687x11 Compiled with X11 support.
10688
10689 *string-match*
10690Matching a pattern in a String
10691
10692A regexp pattern as explained at |pattern| is normally used to find a match in
10693the buffer lines. When a pattern is used to find a match in a String, almost
10694everything works in the same way. The difference is that a String is handled
10695like it is one line. When it contains a "\n" character, this is not seen as a
10696line break for the pattern. It can be matched with a "\n" in the pattern, or
10697with ".". Example: >
10698 :let a = "aaaa\nxxxx"
10699 :echo matchstr(a, "..\n..")
10700 aa
10701 xx
10702 :echo matchstr(a, "a.x")
10703 a
10704 x
10705
10706Don't forget that "^" will only match at the first character of the String and
10707"$" at the last character of the string. They don't match after or before a
10708"\n".
10709
10710==============================================================================
107115. Defining functions *user-functions*
10712
10713New functions can be defined. These can be called just like builtin
10714functions. The function executes a sequence of Ex commands. Normal mode
10715commands can be executed with the |:normal| command.
10716
10717The function name must start with an uppercase letter, to avoid confusion with
10718builtin functions. To prevent from using the same name in different scripts
10719avoid obvious, short names. A good habit is to start the function name with
10720the name of the script, e.g., "HTMLcolor()".
10721
Bram Moolenaar92d640f2005-09-05 22:11:52 +000010722It's also possible to use curly braces, see |curly-braces-names|. And the
10723|autoload| facility is useful to define a function only when it's called.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010724
10725 *local-function*
10726A function local to a script must start with "s:". A local script function
10727can only be called from within the script and from functions, user commands
10728and autocommands defined in the script. It is also possible to call the
Bram Moolenaare37d50a2008-08-06 17:06:04 +000010729function from a mapping defined in the script, but then |<SID>| must be used
Bram Moolenaar071d4272004-06-13 20:20:40 +000010730instead of "s:" when the mapping is expanded outside of the script.
Bram Moolenaarbcb98982014-05-01 14:08:19 +020010731There are only script-local functions, no buffer-local or window-local
10732functions.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010733
10734 *:fu* *:function* *E128* *E129* *E123*
10735:fu[nction] List all functions and their arguments.
10736
10737:fu[nction] {name} List function {name}.
Bram Moolenaar32466aa2006-02-24 23:53:04 +000010738 {name} can also be a |Dictionary| entry that is a
10739 |Funcref|: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000010740 :function dict.init
Bram Moolenaar92d640f2005-09-05 22:11:52 +000010741
10742:fu[nction] /{pattern} List functions with a name matching {pattern}.
10743 Example that lists all functions ending with "File": >
10744 :function /File$
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +000010745<
10746 *:function-verbose*
10747When 'verbose' is non-zero, listing a function will also display where it was
10748last defined. Example: >
10749
10750 :verbose function SetFileTypeSH
10751 function SetFileTypeSH(name)
10752 Last set from /usr/share/vim/vim-7.0/filetype.vim
10753<
Bram Moolenaar8aff23a2005-08-19 20:40:30 +000010754See |:verbose-cmd| for more information.
Bram Moolenaar5b8d8fd2005-08-16 23:01:50 +000010755
Bram Moolenaarbcb98982014-05-01 14:08:19 +020010756 *E124* *E125* *E853* *E884*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +020010757:fu[nction][!] {name}([arguments]) [range] [abort] [dict] [closure]
Bram Moolenaar01164a62017-11-02 22:58:42 +010010758 Define a new function by the name {name}. The body of
10759 the function follows in the next lines, until the
10760 matching |:endfunction|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +010010761
Bram Moolenaar01164a62017-11-02 22:58:42 +010010762 The name must be made of alphanumeric characters and
10763 '_', and must start with a capital or "s:" (see
10764 above). Note that using "b:" or "g:" is not allowed.
10765 (since patch 7.4.260 E884 is given if the function
10766 name has a colon in the name, e.g. for "foo:bar()".
10767 Before that patch no error was given).
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000010768
Bram Moolenaar32466aa2006-02-24 23:53:04 +000010769 {name} can also be a |Dictionary| entry that is a
10770 |Funcref|: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000010771 :function dict.init(arg)
Bram Moolenaar58b85342016-08-14 19:54:54 +020010772< "dict" must be an existing dictionary. The entry
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000010773 "init" is added if it didn't exist yet. Otherwise [!]
Bram Moolenaar58b85342016-08-14 19:54:54 +020010774 is required to overwrite an existing function. The
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000010775 result is a |Funcref| to a numbered function. The
10776 function can only be used with a |Funcref| and will be
10777 deleted if there are no more references to it.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010778 *E127* *E122*
10779 When a function by this name already exists and [!] is
Bram Moolenaarded5f1b2018-11-10 17:33:29 +010010780 not used an error message is given. There is one
10781 exception: When sourcing a script again, a function
10782 that was previously defined in that script will be
10783 silently replaced.
10784 When [!] is used, an existing function is silently
10785 replaced. Unless it is currently being executed, that
10786 is an error.
Bram Moolenaarf8be4612017-06-23 20:52:40 +020010787 NOTE: Use ! wisely. If used without care it can cause
10788 an existing function to be replaced unexpectedly,
10789 which is hard to debug.
Bram Moolenaar8f999f12005-01-25 22:12:55 +000010790
10791 For the {arguments} see |function-argument|.
10792
Bram Moolenaar8d043172014-01-23 14:24:41 +010010793 *:func-range* *a:firstline* *a:lastline*
Bram Moolenaar071d4272004-06-13 20:20:40 +000010794 When the [range] argument is added, the function is
10795 expected to take care of a range itself. The range is
10796 passed as "a:firstline" and "a:lastline". If [range]
10797 is excluded, ":{range}call" will call the function for
10798 each line in the range, with the cursor on the start
10799 of each line. See |function-range-example|.
Bram Moolenaar2df58b42012-11-28 18:21:11 +010010800 The cursor is still moved to the first line of the
10801 range, as is the case with all Ex commands.
Bram Moolenaar8d043172014-01-23 14:24:41 +010010802 *:func-abort*
Bram Moolenaar071d4272004-06-13 20:20:40 +000010803 When the [abort] argument is added, the function will
10804 abort as soon as an error is detected.
Bram Moolenaar8d043172014-01-23 14:24:41 +010010805 *:func-dict*
Bram Moolenaar2fda12f2005-01-15 22:14:15 +000010806 When the [dict] argument is added, the function must
Bram Moolenaar58b85342016-08-14 19:54:54 +020010807 be invoked through an entry in a |Dictionary|. The
Bram Moolenaar2fda12f2005-01-15 22:14:15 +000010808 local variable "self" will then be set to the
10809 dictionary. See |Dictionary-function|.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +020010810 *:func-closure* *E932*
10811 When the [closure] argument is added, the function
10812 can access variables and arguments from the outer
10813 scope. This is usually called a closure. In this
10814 example Bar() uses "x" from the scope of Foo(). It
10815 remains referenced even after Foo() returns: >
10816 :function! Foo()
10817 : let x = 0
10818 : function! Bar() closure
10819 : let x += 1
10820 : return x
10821 : endfunction
Bram Moolenaarbc8801c2016-08-02 21:04:33 +020010822 : return funcref('Bar')
Bram Moolenaar10ce39a2016-07-29 22:37:06 +020010823 :endfunction
10824
10825 :let F = Foo()
10826 :echo F()
10827< 1 >
10828 :echo F()
10829< 2 >
10830 :echo F()
10831< 3
Bram Moolenaar071d4272004-06-13 20:20:40 +000010832
Bram Moolenaar446cb832008-06-24 21:56:24 +000010833 *function-search-undo*
Bram Moolenaar98692072006-02-04 00:57:42 +000010834 The last used search pattern and the redo command "."
Bram Moolenaar446cb832008-06-24 21:56:24 +000010835 will not be changed by the function. This also
10836 implies that the effect of |:nohlsearch| is undone
10837 when the function returns.
Bram Moolenaar98692072006-02-04 00:57:42 +000010838
Bram Moolenaarf8be4612017-06-23 20:52:40 +020010839 *:endf* *:endfunction* *E126* *E193* *W22*
Bram Moolenaar663bb232017-06-22 19:12:10 +020010840:endf[unction] [argument]
10841 The end of a function definition. Best is to put it
10842 on a line by its own, without [argument].
10843
10844 [argument] can be:
10845 | command command to execute next
10846 \n command command to execute next
10847 " comment always ignored
Bram Moolenaarf8be4612017-06-23 20:52:40 +020010848 anything else ignored, warning given when
10849 'verbose' is non-zero
Bram Moolenaar663bb232017-06-22 19:12:10 +020010850 The support for a following command was added in Vim
10851 8.0.0654, before that any argument was silently
10852 ignored.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010853
Bram Moolenaarf8be4612017-06-23 20:52:40 +020010854 To be able to define a function inside an `:execute`
10855 command, use line breaks instead of |:bar|: >
10856 :exe "func Foo()\necho 'foo'\nendfunc"
10857<
Bram Moolenaar437bafe2016-08-01 15:40:54 +020010858 *:delf* *:delfunction* *E130* *E131* *E933*
Bram Moolenaar663bb232017-06-22 19:12:10 +020010859:delf[unction][!] {name}
10860 Delete function {name}.
Bram Moolenaar32466aa2006-02-24 23:53:04 +000010861 {name} can also be a |Dictionary| entry that is a
10862 |Funcref|: >
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000010863 :delfunc dict.init
Bram Moolenaar58b85342016-08-14 19:54:54 +020010864< This will remove the "init" entry from "dict". The
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000010865 function is deleted if there are no more references to
10866 it.
Bram Moolenaar663bb232017-06-22 19:12:10 +020010867 With the ! there is no error if the function does not
10868 exist.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010869 *:retu* *:return* *E133*
10870:retu[rn] [expr] Return from a function. When "[expr]" is given, it is
10871 evaluated and returned as the result of the function.
10872 If "[expr]" is not given, the number 0 is returned.
10873 When a function ends without an explicit ":return",
10874 the number 0 is returned.
10875 Note that there is no check for unreachable lines,
10876 thus there is no warning if commands follow ":return".
10877
10878 If the ":return" is used after a |:try| but before the
10879 matching |:finally| (if present), the commands
10880 following the ":finally" up to the matching |:endtry|
10881 are executed first. This process applies to all
10882 nested ":try"s inside the function. The function
10883 returns at the outermost ":endtry".
10884
Bram Moolenaar8f999f12005-01-25 22:12:55 +000010885 *function-argument* *a:var*
Bram Moolenaar58b85342016-08-14 19:54:54 +020010886An argument can be defined by giving its name. In the function this can then
Bram Moolenaar8f999f12005-01-25 22:12:55 +000010887be used as "a:name" ("a:" for argument).
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010888 *a:0* *a:1* *a:000* *E740* *...*
Bram Moolenaar8f999f12005-01-25 22:12:55 +000010889Up to 20 arguments can be given, separated by commas. After the named
10890arguments an argument "..." can be specified, which means that more arguments
10891may optionally be following. In the function the extra arguments can be used
10892as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which
Bram Moolenaar32466aa2006-02-24 23:53:04 +000010893can be 0). "a:000" is set to a |List| that contains these arguments. Note
10894that "a:1" is the same as "a:000[0]".
Bram Moolenaar2ce06f62005-01-31 19:19:04 +000010895 *E742*
10896The a: scope and the variables in it cannot be changed, they are fixed.
Bram Moolenaar069c1e72016-07-15 21:25:08 +020010897However, if a composite type is used, such as |List| or |Dictionary| , you can
10898change their contents. Thus you can pass a |List| to a function and have the
10899function add an item to it. If you want to make sure the function cannot
10900change a |List| or |Dictionary| use |:lockvar|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010901
Bram Moolenaar8f999f12005-01-25 22:12:55 +000010902It is also possible to define a function without any arguments. You must
Bram Moolenaar01164a62017-11-02 22:58:42 +010010903still supply the () then.
10904
Bram Moolenaar98ef2332018-03-18 14:44:37 +010010905It is allowed to define another function inside a function body.
Bram Moolenaar8f999f12005-01-25 22:12:55 +000010906
Bram Moolenaar42ae78c2019-05-09 21:08:58 +020010907 *optional-function-argument*
10908You can provide default values for positional named arguments. This makes
10909them optional for function calls. When a positional argument is not
10910specified at a call, the default expression is used to initialize it.
Bram Moolenaar68e65602019-05-26 21:33:31 +020010911This only works for functions declared with `:function`, not for lambda
Bram Moolenaar42ae78c2019-05-09 21:08:58 +020010912expressions |expr-lambda|.
10913
10914Example: >
10915 function Something(key, value = 10)
Bram Moolenaar8aad88d2019-05-12 13:53:50 +020010916 echo a:key .. ": " .. a:value
Bram Moolenaar42ae78c2019-05-09 21:08:58 +020010917 endfunction
10918 call Something('empty') "empty: 10"
Bram Moolenaar8aad88d2019-05-12 13:53:50 +020010919 call Something('key', 20) "key: 20"
Bram Moolenaar42ae78c2019-05-09 21:08:58 +020010920
10921The argument default expressions are evaluated at the time of the function
10922call, not definition. Thus it is possible to use an expression which is
Bram Moolenaar68e65602019-05-26 21:33:31 +020010923invalid the moment the function is defined. The expressions are also only
Bram Moolenaar42ae78c2019-05-09 21:08:58 +020010924evaluated when arguments are not specified during a call.
10925
10926You can pass |v:none| to use the default expression. Note that this means you
10927cannot pass v:none as an ordinary value when an argument has a default
10928expression.
10929
10930Example: >
10931 function Something(a = 10, b = 20, c = 30)
10932 endfunction
10933 call Something(1, v:none, 3) " b = 20
10934<
10935 *E989*
10936Optional arguments with default expressions must occur after any mandatory
10937arguments. You can use "..." after all optional named arguments.
10938
10939It is possible for later argument defaults to refer to prior arguments,
10940but not the other way around. They must be prefixed with "a:", as with all
10941arguments.
10942
10943Example that works: >
10944 :function Okay(mandatory, optional = a:mandatory)
10945 :endfunction
10946Example that does NOT work: >
10947 :function NoGood(first = a:second, second = 10)
10948 :endfunction
10949<
10950When not using "...", the number of arguments in a function call must be equal
10951to the number of mandatory named arguments. When using "...", the number of
10952arguments may be larger.
10953
Bram Moolenaar8f999f12005-01-25 22:12:55 +000010954 *local-variables*
Bram Moolenaar069c1e72016-07-15 21:25:08 +020010955Inside a function local variables can be used. These will disappear when the
10956function returns. Global variables need to be accessed with "g:".
Bram Moolenaar071d4272004-06-13 20:20:40 +000010957
10958Example: >
10959 :function Table(title, ...)
10960 : echohl Title
10961 : echo a:title
10962 : echohl None
Bram Moolenaar677ee682005-01-27 14:41:15 +000010963 : echo a:0 . " items:"
10964 : for s in a:000
10965 : echon ' ' . s
10966 : endfor
Bram Moolenaar071d4272004-06-13 20:20:40 +000010967 :endfunction
10968
10969This function can then be called with: >
Bram Moolenaar677ee682005-01-27 14:41:15 +000010970 call Table("Table", "line1", "line2")
10971 call Table("Empty Table")
Bram Moolenaar071d4272004-06-13 20:20:40 +000010972
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010973To return more than one value, return a |List|: >
10974 :function Compute(n1, n2)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010975 : if a:n2 == 0
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010976 : return ["fail", 0]
Bram Moolenaar071d4272004-06-13 20:20:40 +000010977 : endif
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010978 : return ["ok", a:n1 / a:n2]
Bram Moolenaar071d4272004-06-13 20:20:40 +000010979 :endfunction
10980
10981This function can then be called with: >
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010982 :let [success, div] = Compute(102, 6)
Bram Moolenaar071d4272004-06-13 20:20:40 +000010983 :if success == "ok"
10984 : echo div
10985 :endif
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010986<
Bram Moolenaar39f05632006-03-19 22:15:26 +000010987 *:cal* *:call* *E107* *E117*
Bram Moolenaar071d4272004-06-13 20:20:40 +000010988:[range]cal[l] {name}([arguments])
10989 Call a function. The name of the function and its arguments
Bram Moolenaar68e65602019-05-26 21:33:31 +020010990 are as specified with `:function`. Up to 20 arguments can be
Bram Moolenaaref2f6562007-05-06 13:32:59 +000010991 used. The returned value is discarded.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010992 Without a range and for functions that accept a range, the
10993 function is called once. When a range is given the cursor is
10994 positioned at the start of the first line before executing the
10995 function.
10996 When a range is given and the function doesn't handle it
10997 itself, the function is executed for each line in the range,
10998 with the cursor in the first column of that line. The cursor
10999 is left at the last line (possibly moved by the last function
Bram Moolenaar58b85342016-08-14 19:54:54 +020011000 call). The arguments are re-evaluated for each line. Thus
Bram Moolenaar071d4272004-06-13 20:20:40 +000011001 this works:
11002 *function-range-example* >
11003 :function Mynumber(arg)
11004 : echo line(".") . " " . a:arg
11005 :endfunction
11006 :1,5call Mynumber(getline("."))
11007<
11008 The "a:firstline" and "a:lastline" are defined anyway, they
11009 can be used to do something different at the start or end of
11010 the range.
11011
11012 Example of a function that handles the range itself: >
11013
11014 :function Cont() range
11015 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ '
11016 :endfunction
11017 :4,8call Cont()
11018<
11019 This function inserts the continuation character "\" in front
11020 of all the lines in the range, except the first one.
11021
Bram Moolenaaref2f6562007-05-06 13:32:59 +000011022 When the function returns a composite value it can be further
11023 dereferenced, but the range will not be used then. Example: >
11024 :4,8call GetDict().method()
11025< Here GetDict() gets the range but method() does not.
11026
Bram Moolenaar071d4272004-06-13 20:20:40 +000011027 *E132*
11028The recursiveness of user functions is restricted with the |'maxfuncdepth'|
11029option.
11030
Bram Moolenaar25e42232019-08-04 15:04:10 +020011031It is also possible to use `:eval`. It does not support a range, but does
11032allow for method chaining, e.g.: >
11033 eval GetList()->Filter()->append('$')
11034
Bram Moolenaar088e8e32019-08-08 22:15:18 +020011035A function can also be called as part of evaluating an expression or when it
11036is used as a method: >
11037 let x = GetList()
11038 let y = GetList()->Filter()
11039
Bram Moolenaar7c626922005-02-07 22:01:03 +000011040
11041AUTOMATICALLY LOADING FUNCTIONS ~
Bram Moolenaar071d4272004-06-13 20:20:40 +000011042 *autoload-functions*
11043When using many or large functions, it's possible to automatically define them
Bram Moolenaar7c626922005-02-07 22:01:03 +000011044only when they are used. There are two methods: with an autocommand and with
11045the "autoload" directory in 'runtimepath'.
11046
11047
11048Using an autocommand ~
11049
Bram Moolenaar05159a02005-02-26 23:04:13 +000011050This is introduced in the user manual, section |41.14|.
11051
Bram Moolenaar7c626922005-02-07 22:01:03 +000011052The autocommand is useful if you have a plugin that is a long Vim script file.
Bram Moolenaar68e65602019-05-26 21:33:31 +020011053You can define the autocommand and quickly quit the script with `:finish`.
Bram Moolenaar58b85342016-08-14 19:54:54 +020011054That makes Vim startup faster. The autocommand should then load the same file
Bram Moolenaar68e65602019-05-26 21:33:31 +020011055again, setting a variable to skip the `:finish` command.
Bram Moolenaar7c626922005-02-07 22:01:03 +000011056
11057Use the FuncUndefined autocommand event with a pattern that matches the
11058function(s) to be defined. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +000011059
11060 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim
11061
11062The file "~/vim/bufnetfuncs.vim" should then define functions that start with
11063"BufNet". Also see |FuncUndefined|.
11064
Bram Moolenaar7c626922005-02-07 22:01:03 +000011065
11066Using an autoload script ~
Bram Moolenaar26a60b42005-02-22 08:49:11 +000011067 *autoload* *E746*
Bram Moolenaar05159a02005-02-26 23:04:13 +000011068This is introduced in the user manual, section |41.15|.
11069
Bram Moolenaar7c626922005-02-07 22:01:03 +000011070Using a script in the "autoload" directory is simpler, but requires using
11071exactly the right file name. A function that can be autoloaded has a name
11072like this: >
11073
Bram Moolenaara7fc0102005-05-18 22:17:12 +000011074 :call filename#funcname()
Bram Moolenaar7c626922005-02-07 22:01:03 +000011075
11076When such a function is called, and it is not defined yet, Vim will search the
11077"autoload" directories in 'runtimepath' for a script file called
11078"filename.vim". For example "~/.vim/autoload/filename.vim". That file should
11079then define the function like this: >
11080
Bram Moolenaara7fc0102005-05-18 22:17:12 +000011081 function filename#funcname()
Bram Moolenaar7c626922005-02-07 22:01:03 +000011082 echo "Done!"
11083 endfunction
11084
Bram Moolenaar60a795a2005-09-16 21:55:43 +000011085The file name and the name used before the # in the function must match
Bram Moolenaar7c626922005-02-07 22:01:03 +000011086exactly, and the defined function must have the name exactly as it will be
11087called.
11088
Bram Moolenaara7fc0102005-05-18 22:17:12 +000011089It is possible to use subdirectories. Every # in the function name works like
11090a path separator. Thus when calling a function: >
Bram Moolenaar7c626922005-02-07 22:01:03 +000011091
Bram Moolenaara7fc0102005-05-18 22:17:12 +000011092 :call foo#bar#func()
Bram Moolenaar7c626922005-02-07 22:01:03 +000011093
11094Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'.
11095
Bram Moolenaar26a60b42005-02-22 08:49:11 +000011096This also works when reading a variable that has not been set yet: >
11097
Bram Moolenaara7fc0102005-05-18 22:17:12 +000011098 :let l = foo#bar#lvar
Bram Moolenaar26a60b42005-02-22 08:49:11 +000011099
Bram Moolenaara5792f52005-11-23 21:25:05 +000011100However, when the autoload script was already loaded it won't be loaded again
11101for an unknown variable.
11102
Bram Moolenaar26a60b42005-02-22 08:49:11 +000011103When assigning a value to such a variable nothing special happens. This can
11104be used to pass settings to the autoload script before it's loaded: >
11105
Bram Moolenaara7fc0102005-05-18 22:17:12 +000011106 :let foo#bar#toggle = 1
11107 :call foo#bar#func()
Bram Moolenaar26a60b42005-02-22 08:49:11 +000011108
Bram Moolenaar4399ef42005-02-12 14:29:27 +000011109Note that when you make a mistake and call a function that is supposed to be
11110defined in an autoload script, but the script doesn't actually define the
11111function, the script will be sourced every time you try to call the function.
Bram Moolenaar26a60b42005-02-22 08:49:11 +000011112And you will get an error message every time.
11113
11114Also note that if you have two script files, and one calls a function in the
Bram Moolenaar446cb832008-06-24 21:56:24 +000011115other and vice versa, before the used function is defined, it won't work.
Bram Moolenaar26a60b42005-02-22 08:49:11 +000011116Avoid using the autoload functionality at the toplevel.
Bram Moolenaar7c626922005-02-07 22:01:03 +000011117
Bram Moolenaar433f7c82006-03-21 21:29:36 +000011118Hint: If you distribute a bunch of scripts you can pack them together with the
11119|vimball| utility. Also read the user manual |distribute-script|.
11120
Bram Moolenaar071d4272004-06-13 20:20:40 +000011121==============================================================================
111226. Curly braces names *curly-braces-names*
11123
Bram Moolenaar84f72352012-03-11 15:57:40 +010011124In most places where you can use a variable, you can use a "curly braces name"
11125variable. This is a regular variable name with one or more expressions
11126wrapped in braces {} like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +000011127 my_{adjective}_variable
11128
11129When Vim encounters this, it evaluates the expression inside the braces, puts
11130that in place of the expression, and re-interprets the whole as a variable
11131name. So in the above example, if the variable "adjective" was set to
11132"noisy", then the reference would be to "my_noisy_variable", whereas if
11133"adjective" was set to "quiet", then it would be to "my_quiet_variable".
11134
11135One application for this is to create a set of variables governed by an option
Bram Moolenaar58b85342016-08-14 19:54:54 +020011136value. For example, the statement >
Bram Moolenaar071d4272004-06-13 20:20:40 +000011137 echo my_{&background}_message
11138
11139would output the contents of "my_dark_message" or "my_light_message" depending
11140on the current value of 'background'.
11141
11142You can use multiple brace pairs: >
11143 echo my_{adverb}_{adjective}_message
11144..or even nest them: >
11145 echo my_{ad{end_of_word}}_message
11146where "end_of_word" is either "verb" or "jective".
11147
11148However, the expression inside the braces must evaluate to a valid single
Bram Moolenaar402d2fe2005-04-15 21:00:38 +000011149variable name, e.g. this is invalid: >
Bram Moolenaar071d4272004-06-13 20:20:40 +000011150 :let foo='a + b'
11151 :echo c{foo}d
11152.. since the result of expansion is "ca + bd", which is not a variable name.
11153
11154 *curly-braces-function-names*
11155You can call and define functions by an evaluated name in a similar way.
11156Example: >
11157 :let func_end='whizz'
11158 :call my_func_{func_end}(parameter)
11159
11160This would call the function "my_func_whizz(parameter)".
11161
Bram Moolenaar84f72352012-03-11 15:57:40 +010011162This does NOT work: >
11163 :let i = 3
11164 :let @{i} = '' " error
11165 :echo @{i} " error
11166
Bram Moolenaar071d4272004-06-13 20:20:40 +000011167==============================================================================
111687. Commands *expression-commands*
11169
11170:let {var-name} = {expr1} *:let* *E18*
11171 Set internal variable {var-name} to the result of the
11172 expression {expr1}. The variable will get the type
11173 from the {expr}. If {var-name} didn't exist yet, it
11174 is created.
11175
Bram Moolenaar13065c42005-01-08 16:08:21 +000011176:let {var-name}[{idx}] = {expr1} *E689*
11177 Set a list item to the result of the expression
11178 {expr1}. {var-name} must refer to a list and {idx}
11179 must be a valid index in that list. For nested list
11180 the index can be repeated.
Bram Moolenaar446cb832008-06-24 21:56:24 +000011181 This cannot be used to add an item to a |List|.
Bram Moolenaar58b85342016-08-14 19:54:54 +020011182 This cannot be used to set a byte in a String. You
Bram Moolenaar446cb832008-06-24 21:56:24 +000011183 can do that like this: >
11184 :let var = var[0:2] . 'X' . var[4:]
Bram Moolenaar6e5ea8d2019-01-12 22:47:31 +010011185< When {var-name} is a |Blob| then {idx} can be the
11186 length of the blob, in which case one byte is
11187 appended.
11188
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000011189 *E711* *E719*
11190:let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710*
Bram Moolenaar32466aa2006-02-24 23:53:04 +000011191 Set a sequence of items in a |List| to the result of
11192 the expression {expr1}, which must be a list with the
Bram Moolenaar9588a0f2005-01-08 21:45:39 +000011193 correct number of items.
11194 {idx1} can be omitted, zero is used instead.
11195 {idx2} can be omitted, meaning the end of the list.
11196 When the selected range of items is partly past the
11197 end of the list, items will be added.
11198
Bram Moolenaar558ca4a2019-04-04 18:15:38 +020011199 *:let+=* *:let-=* *:letstar=*
11200 *:let/=* *:let%=* *:let.=* *:let..=* *E734* *E985*
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000011201:let {var} += {expr1} Like ":let {var} = {var} + {expr1}".
11202:let {var} -= {expr1} Like ":let {var} = {var} - {expr1}".
Bram Moolenaarff697e62019-02-12 22:28:33 +010011203:let {var} *= {expr1} Like ":let {var} = {var} * {expr1}".
11204:let {var} /= {expr1} Like ":let {var} = {var} / {expr1}".
11205:let {var} %= {expr1} Like ":let {var} = {var} % {expr1}".
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000011206:let {var} .= {expr1} Like ":let {var} = {var} . {expr1}".
Bram Moolenaar558ca4a2019-04-04 18:15:38 +020011207:let {var} ..= {expr1} Like ":let {var} = {var} .. {expr1}".
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000011208 These fail if {var} was not set yet and when the type
11209 of {var} and {expr1} don't fit the operator.
Bram Moolenaar558ca4a2019-04-04 18:15:38 +020011210 `.=` is not supported with Vim script version 2 and
11211 later, see |vimscript-version|.
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000011212
11213
Bram Moolenaar071d4272004-06-13 20:20:40 +000011214:let ${env-name} = {expr1} *:let-environment* *:let-$*
11215 Set environment variable {env-name} to the result of
11216 the expression {expr1}. The type is always String.
Bram Moolenaar56c860c2019-08-17 20:09:31 +020011217
11218 On some systems making an environment variable empty
11219 causes it to be deleted. Many systems do not make a
11220 difference between an environment variable that is not
11221 set and an environment variable that is empty.
11222
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000011223:let ${env-name} .= {expr1}
11224 Append {expr1} to the environment variable {env-name}.
11225 If the environment variable didn't exist yet this
11226 works like "=".
Bram Moolenaar071d4272004-06-13 20:20:40 +000011227
11228:let @{reg-name} = {expr1} *:let-register* *:let-@*
11229 Write the result of the expression {expr1} in register
11230 {reg-name}. {reg-name} must be a single letter, and
11231 must be the name of a writable register (see
11232 |registers|). "@@" can be used for the unnamed
11233 register, "@/" for the search pattern.
11234 If the result of {expr1} ends in a <CR> or <NL>, the
11235 register will be linewise, otherwise it will be set to
11236 characterwise.
11237 This can be used to clear the last search pattern: >
11238 :let @/ = ""
11239< This is different from searching for an empty string,
11240 that would match everywhere.
11241
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000011242:let @{reg-name} .= {expr1}
Bram Moolenaar58b85342016-08-14 19:54:54 +020011243 Append {expr1} to register {reg-name}. If the
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000011244 register was empty it's like setting it to {expr1}.
11245
Bram Moolenaaref2f6562007-05-06 13:32:59 +000011246:let &{option-name} = {expr1} *:let-option* *:let-&*
Bram Moolenaar071d4272004-06-13 20:20:40 +000011247 Set option {option-name} to the result of the
Bram Moolenaarfca34d62005-01-04 21:38:36 +000011248 expression {expr1}. A String or Number value is
11249 always converted to the type of the option.
Bram Moolenaar071d4272004-06-13 20:20:40 +000011250 For an option local to a window or buffer the effect
11251 is just like using the |:set| command: both the local
Bram Moolenaara5fac542005-10-12 20:58:49 +000011252 value and the global value are changed.
Bram Moolenaarfca34d62005-01-04 21:38:36 +000011253 Example: >
11254 :let &path = &path . ',/usr/local/include'
Bram Moolenaar3df01732017-02-17 22:47:16 +010011255< This also works for terminal codes in the form t_xx.
11256 But only for alphanumerical names. Example: >
11257 :let &t_k1 = "\<Esc>[234;"
11258< When the code does not exist yet it will be created as
11259 a terminal key code, there is no error.
Bram Moolenaar071d4272004-06-13 20:20:40 +000011260
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000011261:let &{option-name} .= {expr1}
11262 For a string option: Append {expr1} to the value.
11263 Does not insert a comma like |:set+=|.
11264
11265:let &{option-name} += {expr1}
11266:let &{option-name} -= {expr1}
11267 For a number or boolean option: Add or subtract
11268 {expr1}.
11269
Bram Moolenaar071d4272004-06-13 20:20:40 +000011270:let &l:{option-name} = {expr1}
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000011271:let &l:{option-name} .= {expr1}
11272:let &l:{option-name} += {expr1}
11273:let &l:{option-name} -= {expr1}
Bram Moolenaar071d4272004-06-13 20:20:40 +000011274 Like above, but only set the local value of an option
11275 (if there is one). Works like |:setlocal|.
11276
11277:let &g:{option-name} = {expr1}
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000011278:let &g:{option-name} .= {expr1}
11279:let &g:{option-name} += {expr1}
11280:let &g:{option-name} -= {expr1}
Bram Moolenaar071d4272004-06-13 20:20:40 +000011281 Like above, but only set the global value of an option
11282 (if there is one). Works like |:setglobal|.
11283
Bram Moolenaar13065c42005-01-08 16:08:21 +000011284:let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688*
Bram Moolenaar32466aa2006-02-24 23:53:04 +000011285 {expr1} must evaluate to a |List|. The first item in
Bram Moolenaarfca34d62005-01-04 21:38:36 +000011286 the list is assigned to {name1}, the second item to
11287 {name2}, etc.
11288 The number of names must match the number of items in
Bram Moolenaar32466aa2006-02-24 23:53:04 +000011289 the |List|.
Bram Moolenaarfca34d62005-01-04 21:38:36 +000011290 Each name can be one of the items of the ":let"
11291 command as mentioned above.
11292 Example: >
11293 :let [s, item] = GetItem(s)
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000011294< Detail: {expr1} is evaluated first, then the
11295 assignments are done in sequence. This matters if
11296 {name2} depends on {name1}. Example: >
11297 :let x = [0, 1]
11298 :let i = 0
11299 :let [i, x[i]] = [1, 2]
11300 :echo x
11301< The result is [0, 2].
11302
11303:let [{name1}, {name2}, ...] .= {expr1}
11304:let [{name1}, {name2}, ...] += {expr1}
11305:let [{name1}, {name2}, ...] -= {expr1}
11306 Like above, but append/add/subtract the value for each
Bram Moolenaar32466aa2006-02-24 23:53:04 +000011307 |List| item.
Bram Moolenaarfca34d62005-01-04 21:38:36 +000011308
11309:let [{name}, ..., ; {lastname}] = {expr1}
Bram Moolenaar32466aa2006-02-24 23:53:04 +000011310 Like |:let-unpack| above, but the |List| may have more
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000011311 items than there are names. A list of the remaining
11312 items is assigned to {lastname}. If there are no
11313 remaining items {lastname} is set to an empty list.
Bram Moolenaarfca34d62005-01-04 21:38:36 +000011314 Example: >
11315 :let [a, b; rest] = ["aval", "bval", 3, 4]
11316<
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000011317:let [{name}, ..., ; {lastname}] .= {expr1}
11318:let [{name}, ..., ; {lastname}] += {expr1}
11319:let [{name}, ..., ; {lastname}] -= {expr1}
11320 Like above, but append/add/subtract the value for each
Bram Moolenaar32466aa2006-02-24 23:53:04 +000011321 |List| item.
Bram Moolenaar4a748032010-09-30 21:47:56 +020011322
Bram Moolenaar24582002019-07-21 14:14:26 +020011323 *:let=<<* *:let-heredoc*
11324 *E990* *E991* *E172* *E221*
Bram Moolenaarf5842c52019-05-19 18:41:26 +020011325:let {var-name} =<< [trim] {marker}
11326text...
11327text...
11328{marker}
11329 Set internal variable {var-name} to a List containing
11330 the lines of text bounded by the string {marker}.
11331 {marker} must not contain white space.
Bram Moolenaar24582002019-07-21 14:14:26 +020011332 {marker} cannot start with a lower case character.
Bram Moolenaarf5842c52019-05-19 18:41:26 +020011333 The last line should end only with the {marker} string
11334 without any other character. Watch out for white
11335 space after {marker}!
Bram Moolenaarf5842c52019-05-19 18:41:26 +020011336
Bram Moolenaare7eb9272019-06-24 00:58:07 +020011337 Without "trim" any white space characters in the lines
11338 of text are preserved. If "trim" is specified before
11339 {marker}, then indentation is stripped so you can do: >
11340 let text =<< trim END
11341 if ok
11342 echo 'done'
11343 endif
11344 END
11345< Results in: ["if ok", " echo 'done'", "endif"]
11346 The marker must line up with "let" and the indentation
11347 of the first line is removed from all the text lines.
11348 Specifically: all the leading indentation exactly
11349 matching the leading indentation of the first
11350 non-empty text line is stripped from the input lines.
11351 All leading indentation exactly matching the leading
11352 indentation before `let` is stripped from the line
11353 containing {marker}. Note that the difference between
11354 space and tab matters here.
Bram Moolenaarf5842c52019-05-19 18:41:26 +020011355
11356 If {var-name} didn't exist yet, it is created.
11357 Cannot be followed by another command, but can be
11358 followed by a comment.
11359
11360 Examples: >
11361 let var1 =<< END
11362 Sample text 1
11363 Sample text 2
11364 Sample text 3
11365 END
11366
11367 let data =<< trim DATA
11368 1 2 3 4
11369 5 6 7 8
11370 DATA
11371<
Bram Moolenaar4a748032010-09-30 21:47:56 +020011372 *E121*
Bram Moolenaar58b85342016-08-14 19:54:54 +020011373:let {var-name} .. List the value of variable {var-name}. Multiple
Bram Moolenaardcaf10e2005-01-21 11:55:25 +000011374 variable names may be given. Special names recognized
11375 here: *E738*
Bram Moolenaarca003e12006-03-17 23:19:38 +000011376 g: global variables
11377 b: local buffer variables
11378 w: local window variables
Bram Moolenaar910f66f2006-04-05 20:41:53 +000011379 t: local tab page variables
Bram Moolenaarca003e12006-03-17 23:19:38 +000011380 s: script-local variables
11381 l: local function variables
Bram Moolenaardcaf10e2005-01-21 11:55:25 +000011382 v: Vim variables.
Bram Moolenaar071d4272004-06-13 20:20:40 +000011383
Bram Moolenaard7ee7ce2005-01-03 21:02:03 +000011384:let List the values of all variables. The type of the
11385 variable is indicated before the value:
11386 <nothing> String
11387 # Number
Bram Moolenaarc9b4b052006-04-30 18:54:39 +000011388 * Funcref
Bram Moolenaar071d4272004-06-13 20:20:40 +000011389
Bram Moolenaaref2f6562007-05-06 13:32:59 +000011390:unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795*
Bram Moolenaar2ce06f62005-01-31 19:19:04 +000011391 Remove the internal variable {name}. Several variable
11392 names can be given, they are all removed. The name
Bram Moolenaar32466aa2006-02-24 23:53:04 +000011393 may also be a |List| or |Dictionary| item.
Bram Moolenaar071d4272004-06-13 20:20:40 +000011394 With [!] no error message is given for non-existing
11395 variables.
Bram Moolenaar32466aa2006-02-24 23:53:04 +000011396 One or more items from a |List| can be removed: >
Bram Moolenaar9cd15162005-01-16 22:02:49 +000011397 :unlet list[3] " remove fourth item
11398 :unlet list[3:] " remove fourth item to last
Bram Moolenaar32466aa2006-02-24 23:53:04 +000011399< One item from a |Dictionary| can be removed at a time: >
Bram Moolenaar9cd15162005-01-16 22:02:49 +000011400 :unlet dict['two']
11401 :unlet dict.two
Bram Moolenaarc236c162008-07-13 17:41:49 +000011402< This is especially useful to clean up used global
11403 variables and script-local variables (these are not
11404 deleted when the script ends). Function-local
11405 variables are automatically deleted when the function
11406 ends.
Bram Moolenaar071d4272004-06-13 20:20:40 +000011407
Bram Moolenaar137374f2018-05-13 15:59:50 +020011408:unl[et] ${env-name} ... *:unlet-environment* *:unlet-$*
11409 Remove environment variable {env-name}.
11410 Can mix {name} and ${env-name} in one :unlet command.
11411 No error message is given for a non-existing
11412 variable, also without !.
11413 If the system does not support deleting an environment
Bram Moolenaar9937a052019-06-15 15:45:06 +020011414 variable, it is made empty.
Bram Moolenaar137374f2018-05-13 15:59:50 +020011415
Bram Moolenaar1c196e72019-06-16 15:41:58 +020011416 *:cons* *:const*
Bram Moolenaar9937a052019-06-15 15:45:06 +020011417:cons[t] {var-name} = {expr1}
11418:cons[t] [{name1}, {name2}, ...] = {expr1}
Bram Moolenaar9937a052019-06-15 15:45:06 +020011419:cons[t] [{name}, ..., ; {lastname}] = {expr1}
11420:cons[t] {var-name} =<< [trim] {marker}
11421text...
11422text...
11423{marker}
11424 Similar to |:let|, but additionally lock the variable
11425 after setting the value. This is the same as locking
11426 the variable with |:lockvar| just after |:let|, thus: >
11427 :const x = 1
11428< is equivalent to: >
11429 :let x = 1
11430 :lockvar 1 x
11431< This is useful if you want to make sure the variable
11432 is not modified.
11433 *E995*
Bram Moolenaar9b283522019-06-17 22:19:33 +020011434 |:const| does not allow to for changing a variable: >
Bram Moolenaar9937a052019-06-15 15:45:06 +020011435 :let x = 1
11436 :const x = 2 " Error!
Bram Moolenaar1c196e72019-06-16 15:41:58 +020011437< *E996*
11438 Note that environment variables, option values and
11439 register values cannot be used here, since they cannot
11440 be locked.
11441
Bram Moolenaar85850f32019-07-19 22:05:51 +020011442:cons[t]
11443:cons[t] {var-name}
11444 If no argument is given or only {var-name} is given,
11445 the behavior is the same as |:let|.
11446
Bram Moolenaar2ce06f62005-01-31 19:19:04 +000011447:lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv*
11448 Lock the internal variable {name}. Locking means that
11449 it can no longer be changed (until it is unlocked).
11450 A locked variable can be deleted: >
11451 :lockvar v
11452 :let v = 'asdf' " fails!
11453 :unlet v
Bram Moolenaare7877fe2017-02-20 22:35:33 +010011454< *E741* *E940*
Bram Moolenaar2ce06f62005-01-31 19:19:04 +000011455 If you try to change a locked variable you get an
Bram Moolenaare7877fe2017-02-20 22:35:33 +010011456 error message: "E741: Value is locked: {name}".
11457 If you try to lock or unlock a built-in variable you
11458 get an error message: "E940: Cannot lock or unlock
11459 variable {name}".
Bram Moolenaar2ce06f62005-01-31 19:19:04 +000011460
Bram Moolenaar32466aa2006-02-24 23:53:04 +000011461 [depth] is relevant when locking a |List| or
11462 |Dictionary|. It specifies how deep the locking goes:
11463 1 Lock the |List| or |Dictionary| itself,
Bram Moolenaar2ce06f62005-01-31 19:19:04 +000011464 cannot add or remove items, but can
11465 still change their values.
11466 2 Also lock the values, cannot change
Bram Moolenaar32466aa2006-02-24 23:53:04 +000011467 the items. If an item is a |List| or
11468 |Dictionary|, cannot add or remove
Bram Moolenaar2ce06f62005-01-31 19:19:04 +000011469 items, but can still change the
11470 values.
Bram Moolenaar32466aa2006-02-24 23:53:04 +000011471 3 Like 2 but for the |List| /
11472 |Dictionary| in the |List| /
11473 |Dictionary|, one level deeper.
11474 The default [depth] is 2, thus when {name} is a |List|
11475 or |Dictionary| the values cannot be changed.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +000011476 *E743*
11477 For unlimited depth use [!] and omit [depth].
11478 However, there is a maximum depth of 100 to catch
11479 loops.
11480
Bram Moolenaar32466aa2006-02-24 23:53:04 +000011481 Note that when two variables refer to the same |List|
11482 and you lock one of them, the |List| will also be
Bram Moolenaar910f66f2006-04-05 20:41:53 +000011483 locked when used through the other variable.
11484 Example: >
Bram Moolenaar2ce06f62005-01-31 19:19:04 +000011485 :let l = [0, 1, 2, 3]
11486 :let cl = l
11487 :lockvar l
11488 :let cl[1] = 99 " won't work!
11489< You may want to make a copy of a list to avoid this.
11490 See |deepcopy()|.
11491
11492
11493:unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo*
11494 Unlock the internal variable {name}. Does the
11495 opposite of |:lockvar|.
11496
Bram Moolenaar25e42232019-08-04 15:04:10 +020011497 *:eval*
11498:eval {expr} Evaluate {expr} and discard the result. Example: >
11499 :eval Getlist()->Filter()->append('$')
11500
11501< The expression is supposed to have a side effect,
11502 since the resulting value is not used. In the example
11503 the `append()` call appends the List with text to the
11504 buffer. This is similar to `:call` but works with any
11505 expression.
11506
11507 The command can be shortened to `:ev` or `:eva`, but
11508 these are hard to recognize and therefore not to be
11509 used.
11510
Bram Moolenaar2ce06f62005-01-31 19:19:04 +000011511
Bram Moolenaar61da1bf2019-06-06 12:14:49 +020011512:if {expr1} *:if* *:end* *:endif* *:en* *E171* *E579* *E580*
Bram Moolenaar071d4272004-06-13 20:20:40 +000011513:en[dif] Execute the commands until the next matching ":else"
11514 or ":endif" if {expr1} evaluates to non-zero.
11515
11516 From Vim version 4.5 until 5.0, every Ex command in
11517 between the ":if" and ":endif" is ignored. These two
11518 commands were just to allow for future expansions in a
Bram Moolenaar85084ef2016-01-17 22:26:33 +010011519 backward compatible way. Nesting was allowed. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +000011520 that any ":else" or ":elseif" was ignored, the "else"
11521 part was not executed either.
11522
11523 You can use this to remain compatible with older
11524 versions: >
11525 :if version >= 500
11526 : version-5-specific-commands
11527 :endif
11528< The commands still need to be parsed to find the
11529 "endif". Sometimes an older Vim has a problem with a
11530 new command. For example, ":silent" is recognized as
11531 a ":substitute" command. In that case ":execute" can
11532 avoid problems: >
11533 :if version >= 600
11534 : execute "silent 1,$delete"
11535 :endif
11536<
11537 NOTE: The ":append" and ":insert" commands don't work
11538 properly in between ":if" and ":endif".
11539
11540 *:else* *:el* *E581* *E583*
11541:el[se] Execute the commands until the next matching ":else"
11542 or ":endif" if they previously were not being
11543 executed.
11544
11545 *:elseif* *:elsei* *E582* *E584*
11546:elsei[f] {expr1} Short for ":else" ":if", with the addition that there
11547 is no extra ":endif".
11548
11549:wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw*
Bram Moolenaar3a3a7232005-01-17 22:16:15 +000011550 *E170* *E585* *E588* *E733*
Bram Moolenaar071d4272004-06-13 20:20:40 +000011551:endw[hile] Repeat the commands between ":while" and ":endwhile",
11552 as long as {expr1} evaluates to non-zero.
11553 When an error is detected from a command inside the
11554 loop, execution continues after the "endwhile".
Bram Moolenaar12805862005-01-05 22:16:17 +000011555 Example: >
11556 :let lnum = 1
11557 :while lnum <= line("$")
11558 :call FixLine(lnum)
11559 :let lnum = lnum + 1
11560 :endwhile
11561<
Bram Moolenaar071d4272004-06-13 20:20:40 +000011562 NOTE: The ":append" and ":insert" commands don't work
Bram Moolenaard8b02732005-01-14 21:48:43 +000011563 properly inside a ":while" and ":for" loop.
Bram Moolenaar071d4272004-06-13 20:20:40 +000011564
Bram Moolenaar5e66b422019-01-24 21:58:10 +010011565:for {var} in {object} *:for* *E690* *E732*
Bram Moolenaar12805862005-01-05 22:16:17 +000011566:endfo[r] *:endfo* *:endfor*
11567 Repeat the commands between ":for" and ":endfor" for
Bram Moolenaar5e66b422019-01-24 21:58:10 +010011568 each item in {object}. {object} can be a |List| or
11569 a |Blob|. Variable {var} is set to the value of each
11570 item. When an error is detected for a command inside
11571 the loop, execution continues after the "endfor".
11572 Changing {object} inside the loop affects what items
11573 are used. Make a copy if this is unwanted: >
Bram Moolenaarde8866b2005-01-06 23:24:37 +000011574 :for item in copy(mylist)
Bram Moolenaar5e66b422019-01-24 21:58:10 +010011575<
11576 When {object} is a |List| and not making a copy, Vim
11577 stores a reference to the next item in the |List|
11578 before executing the commands with the current item.
11579 Thus the current item can be removed without effect.
11580 Removing any later item means it will not be found.
11581 Thus the following example works (an inefficient way
11582 to make a |List| empty): >
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010011583 for item in mylist
11584 call remove(mylist, 0)
11585 endfor
Bram Moolenaar5e66b422019-01-24 21:58:10 +010011586< Note that reordering the |List| (e.g., with sort() or
Bram Moolenaar9588a0f2005-01-08 21:45:39 +000011587 reverse()) may have unexpected effects.
Bram Moolenaar12805862005-01-05 22:16:17 +000011588
Bram Moolenaar5e66b422019-01-24 21:58:10 +010011589 When {object} is a |Blob|, Vim always makes a copy to
11590 iterate over. Unlike with |List|, modifying the
11591 |Blob| does not affect the iteration.
11592
Bram Moolenaar12805862005-01-05 22:16:17 +000011593:for [{var1}, {var2}, ...] in {listlist}
11594:endfo[r]
11595 Like ":for" above, but each item in {listlist} must be
11596 a list, of which each item is assigned to {var1},
11597 {var2}, etc. Example: >
11598 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]]
11599 :echo getline(lnum)[col]
11600 :endfor
11601<
Bram Moolenaar071d4272004-06-13 20:20:40 +000011602 *:continue* *:con* *E586*
Bram Moolenaar12805862005-01-05 22:16:17 +000011603:con[tinue] When used inside a ":while" or ":for" loop, jumps back
11604 to the start of the loop.
11605 If it is used after a |:try| inside the loop but
11606 before the matching |:finally| (if present), the
11607 commands following the ":finally" up to the matching
11608 |:endtry| are executed first. This process applies to
11609 all nested ":try"s inside the loop. The outermost
11610 ":endtry" then jumps back to the start of the loop.
Bram Moolenaar071d4272004-06-13 20:20:40 +000011611
11612 *:break* *:brea* *E587*
Bram Moolenaar12805862005-01-05 22:16:17 +000011613:brea[k] When used inside a ":while" or ":for" loop, skips to
11614 the command after the matching ":endwhile" or
11615 ":endfor".
11616 If it is used after a |:try| inside the loop but
11617 before the matching |:finally| (if present), the
11618 commands following the ":finally" up to the matching
11619 |:endtry| are executed first. This process applies to
11620 all nested ":try"s inside the loop. The outermost
11621 ":endtry" then jumps to the command after the loop.
Bram Moolenaar071d4272004-06-13 20:20:40 +000011622
11623:try *:try* *:endt* *:endtry* *E600* *E601* *E602*
11624:endt[ry] Change the error handling for the commands between
11625 ":try" and ":endtry" including everything being
11626 executed across ":source" commands, function calls,
11627 or autocommand invocations.
11628
11629 When an error or interrupt is detected and there is
11630 a |:finally| command following, execution continues
11631 after the ":finally". Otherwise, or when the
11632 ":endtry" is reached thereafter, the next
11633 (dynamically) surrounding ":try" is checked for
11634 a corresponding ":finally" etc. Then the script
11635 processing is terminated. (Whether a function
11636 definition has an "abort" argument does not matter.)
11637 Example: >
11638 :try | edit too much | finally | echo "cleanup" | endtry
11639 :echo "impossible" " not reached, script terminated above
11640<
11641 Moreover, an error or interrupt (dynamically) inside
11642 ":try" and ":endtry" is converted to an exception. It
11643 can be caught as if it were thrown by a |:throw|
11644 command (see |:catch|). In this case, the script
11645 processing is not terminated.
11646
11647 The value "Vim:Interrupt" is used for an interrupt
11648 exception. An error in a Vim command is converted
11649 to a value of the form "Vim({command}):{errmsg}",
11650 other errors are converted to a value of the form
11651 "Vim:{errmsg}". {command} is the full command name,
11652 and {errmsg} is the message that is displayed if the
11653 error exception is not caught, always beginning with
11654 the error number.
11655 Examples: >
11656 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry
11657 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry
11658<
11659 *:cat* *:catch* *E603* *E604* *E605*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010011660:cat[ch] /{pattern}/ The following commands until the next |:catch|,
Bram Moolenaar071d4272004-06-13 20:20:40 +000011661 |:finally|, or |:endtry| that belongs to the same
11662 |:try| as the ":catch" are executed when an exception
11663 matching {pattern} is being thrown and has not yet
11664 been caught by a previous ":catch". Otherwise, these
11665 commands are skipped.
11666 When {pattern} is omitted all errors are caught.
11667 Examples: >
Bram Moolenaar647e24b2019-03-17 16:39:46 +010011668 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C)
11669 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors
11670 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts
11671 :catch /^Vim(write):/ " catch all errors in :write
11672 :catch /^Vim\%((\a\+)\)\=:E123:/ " catch error E123
11673 :catch /my-exception/ " catch user exception
11674 :catch /.*/ " catch everything
11675 :catch " same as /.*/
Bram Moolenaar071d4272004-06-13 20:20:40 +000011676<
11677 Another character can be used instead of / around the
11678 {pattern}, so long as it does not have a special
11679 meaning (e.g., '|' or '"') and doesn't occur inside
11680 {pattern}.
Bram Moolenaar7e38ea22014-04-05 22:55:53 +020011681 Information about the exception is available in
11682 |v:exception|. Also see |throw-variables|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000011683 NOTE: It is not reliable to ":catch" the TEXT of
11684 an error message because it may vary in different
11685 locales.
11686
11687 *:fina* *:finally* *E606* *E607*
11688:fina[lly] The following commands until the matching |:endtry|
11689 are executed whenever the part between the matching
11690 |:try| and the ":finally" is left: either by falling
11691 through to the ":finally" or by a |:continue|,
11692 |:break|, |:finish|, or |:return|, or by an error or
11693 interrupt or exception (see |:throw|).
11694
11695 *:th* *:throw* *E608*
11696:th[row] {expr1} The {expr1} is evaluated and thrown as an exception.
11697 If the ":throw" is used after a |:try| but before the
11698 first corresponding |:catch|, commands are skipped
11699 until the first ":catch" matching {expr1} is reached.
11700 If there is no such ":catch" or if the ":throw" is
11701 used after a ":catch" but before the |:finally|, the
11702 commands following the ":finally" (if present) up to
11703 the matching |:endtry| are executed. If the ":throw"
11704 is after the ":finally", commands up to the ":endtry"
11705 are skipped. At the ":endtry", this process applies
11706 again for the next dynamically surrounding ":try"
11707 (which may be found in a calling function or sourcing
11708 script), until a matching ":catch" has been found.
11709 If the exception is not caught, the command processing
11710 is terminated.
11711 Example: >
11712 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry
Bram Moolenaar662db672011-03-22 14:05:35 +010011713< Note that "catch" may need to be on a separate line
11714 for when an error causes the parsing to skip the whole
11715 line and not see the "|" that separates the commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +000011716
11717 *:ec* *:echo*
11718:ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The
11719 first {expr1} starts on a new line.
11720 Also see |:comment|.
11721 Use "\n" to start a new line. Use "\r" to move the
11722 cursor to the first column.
11723 Uses the highlighting set by the |:echohl| command.
11724 Cannot be followed by a comment.
11725 Example: >
11726 :echo "the value of 'shell' is" &shell
Bram Moolenaaref2f6562007-05-06 13:32:59 +000011727< *:echo-redraw*
11728 A later redraw may make the message disappear again.
11729 And since Vim mostly postpones redrawing until it's
11730 finished with a sequence of commands this happens
11731 quite often. To avoid that a command from before the
11732 ":echo" causes a redraw afterwards (redraws are often
11733 postponed until you type something), force a redraw
11734 with the |:redraw| command. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +000011735 :new | redraw | echo "there is a new window"
11736<
11737 *:echon*
11738:echon {expr1} .. Echoes each {expr1}, without anything added. Also see
11739 |:comment|.
11740 Uses the highlighting set by the |:echohl| command.
11741 Cannot be followed by a comment.
11742 Example: >
11743 :echon "the value of 'shell' is " &shell
11744<
11745 Note the difference between using ":echo", which is a
11746 Vim command, and ":!echo", which is an external shell
11747 command: >
11748 :!echo % --> filename
11749< The arguments of ":!" are expanded, see |:_%|. >
11750 :!echo "%" --> filename or "filename"
11751< Like the previous example. Whether you see the double
11752 quotes or not depends on your 'shell'. >
11753 :echo % --> nothing
11754< The '%' is an illegal character in an expression. >
11755 :echo "%" --> %
11756< This just echoes the '%' character. >
11757 :echo expand("%") --> filename
11758< This calls the expand() function to expand the '%'.
11759
11760 *:echoh* *:echohl*
11761:echoh[l] {name} Use the highlight group {name} for the following
11762 |:echo|, |:echon| and |:echomsg| commands. Also used
11763 for the |input()| prompt. Example: >
11764 :echohl WarningMsg | echo "Don't panic!" | echohl None
11765< Don't forget to set the group back to "None",
11766 otherwise all following echo's will be highlighted.
11767
11768 *:echom* *:echomsg*
11769:echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the
11770 message in the |message-history|.
11771 Spaces are placed between the arguments as with the
11772 |:echo| command. But unprintable characters are
11773 displayed, not interpreted.
Bram Moolenaaref2f6562007-05-06 13:32:59 +000011774 The parsing works slightly different from |:echo|,
11775 more like |:execute|. All the expressions are first
11776 evaluated and concatenated before echoing anything.
Bram Moolenaar461a7fc2018-12-22 13:28:07 +010011777 If expressions does not evaluate to a Number or
11778 String, string() is used to turn it into a string.
Bram Moolenaar071d4272004-06-13 20:20:40 +000011779 Uses the highlighting set by the |:echohl| command.
11780 Example: >
11781 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see."
Bram Moolenaaref2f6562007-05-06 13:32:59 +000011782< See |:echo-redraw| to avoid the message disappearing
11783 when the screen is redrawn.
Bram Moolenaar071d4272004-06-13 20:20:40 +000011784 *:echoe* *:echoerr*
11785:echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the
11786 message in the |message-history|. When used in a
11787 script or function the line number will be added.
11788 Spaces are placed between the arguments as with the
Bram Moolenaar461a7fc2018-12-22 13:28:07 +010011789 |:echomsg| command. When used inside a try conditional,
Bram Moolenaar071d4272004-06-13 20:20:40 +000011790 the message is raised as an error exception instead
11791 (see |try-echoerr|).
11792 Example: >
11793 :echoerr "This script just failed!"
11794< If you just want a highlighted message use |:echohl|.
11795 And to get a beep: >
11796 :exe "normal \<Esc>"
11797<
11798 *:exe* *:execute*
11799:exe[cute] {expr1} .. Executes the string that results from the evaluation
Bram Moolenaar00a927d2010-05-14 23:24:24 +020011800 of {expr1} as an Ex command.
11801 Multiple arguments are concatenated, with a space in
11802 between. To avoid the extra space use the "."
11803 operator to concatenate strings into one argument.
11804 {expr1} is used as the processed command, command line
11805 editing keys are not recognized.
Bram Moolenaar071d4272004-06-13 20:20:40 +000011806 Cannot be followed by a comment.
11807 Examples: >
Bram Moolenaar00a927d2010-05-14 23:24:24 +020011808 :execute "buffer" nextbuf
11809 :execute "normal" count . "w"
Bram Moolenaar071d4272004-06-13 20:20:40 +000011810<
11811 ":execute" can be used to append a command to commands
11812 that don't accept a '|'. Example: >
11813 :execute '!ls' | echo "theend"
11814
11815< ":execute" is also a nice way to avoid having to type
11816 control characters in a Vim script for a ":normal"
11817 command: >
11818 :execute "normal ixxx\<Esc>"
11819< This has an <Esc> character, see |expr-string|.
11820
Bram Moolenaar446cb832008-06-24 21:56:24 +000011821 Be careful to correctly escape special characters in
11822 file names. The |fnameescape()| function can be used
Bram Moolenaar05bb9532008-07-04 09:44:11 +000011823 for Vim commands, |shellescape()| for |:!| commands.
11824 Examples: >
Bram Moolenaar446cb832008-06-24 21:56:24 +000011825 :execute "e " . fnameescape(filename)
Bram Moolenaar251835e2014-02-24 02:51:51 +010011826 :execute "!ls " . shellescape(filename, 1)
Bram Moolenaar446cb832008-06-24 21:56:24 +000011827<
Bram Moolenaar071d4272004-06-13 20:20:40 +000011828 Note: The executed string may be any command-line, but
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +010011829 starting or ending "if", "while" and "for" does not
11830 always work, because when commands are skipped the
11831 ":execute" is not evaluated and Vim loses track of
11832 where blocks start and end. Also "break" and
11833 "continue" should not be inside ":execute".
11834 This example does not work, because the ":execute" is
11835 not evaluated and Vim does not see the "while", and
11836 gives an error for finding an ":endwhile": >
11837 :if 0
11838 : execute 'while i > 5'
11839 : echo "test"
11840 : endwhile
11841 :endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000011842<
11843 It is allowed to have a "while" or "if" command
11844 completely in the executed string: >
11845 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile'
11846<
11847
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010011848 *:exe-comment*
Bram Moolenaar071d4272004-06-13 20:20:40 +000011849 ":execute", ":echo" and ":echon" cannot be followed by
11850 a comment directly, because they see the '"' as the
11851 start of a string. But, you can use '|' followed by a
11852 comment. Example: >
11853 :echo "foo" | "this is a comment
11854
11855==============================================================================
118568. Exception handling *exception-handling*
11857
11858The Vim script language comprises an exception handling feature. This section
11859explains how it can be used in a Vim script.
11860
11861Exceptions may be raised by Vim on an error or on interrupt, see
11862|catch-errors| and |catch-interrupt|. You can also explicitly throw an
11863exception by using the ":throw" command, see |throw-catch|.
11864
11865
11866TRY CONDITIONALS *try-conditionals*
11867
11868Exceptions can be caught or can cause cleanup code to be executed. You can
11869use a try conditional to specify catch clauses (that catch exceptions) and/or
11870a finally clause (to be executed for cleanup).
11871 A try conditional begins with a |:try| command and ends at the matching
11872|:endtry| command. In between, you can use a |:catch| command to start
11873a catch clause, or a |:finally| command to start a finally clause. There may
11874be none or multiple catch clauses, but there is at most one finally clause,
11875which must not be followed by any catch clauses. The lines before the catch
11876clauses and the finally clause is called a try block. >
11877
11878 :try
Bram Moolenaar446cb832008-06-24 21:56:24 +000011879 : ...
11880 : ... TRY BLOCK
11881 : ...
Bram Moolenaar071d4272004-06-13 20:20:40 +000011882 :catch /{pattern}/
Bram Moolenaar446cb832008-06-24 21:56:24 +000011883 : ...
11884 : ... CATCH CLAUSE
11885 : ...
Bram Moolenaar071d4272004-06-13 20:20:40 +000011886 :catch /{pattern}/
Bram Moolenaar446cb832008-06-24 21:56:24 +000011887 : ...
11888 : ... CATCH CLAUSE
11889 : ...
Bram Moolenaar071d4272004-06-13 20:20:40 +000011890 :finally
Bram Moolenaar446cb832008-06-24 21:56:24 +000011891 : ...
11892 : ... FINALLY CLAUSE
11893 : ...
Bram Moolenaar071d4272004-06-13 20:20:40 +000011894 :endtry
11895
11896The try conditional allows to watch code for exceptions and to take the
11897appropriate actions. Exceptions from the try block may be caught. Exceptions
11898from the try block and also the catch clauses may cause cleanup actions.
11899 When no exception is thrown during execution of the try block, the control
11900is transferred to the finally clause, if present. After its execution, the
11901script continues with the line following the ":endtry".
11902 When an exception occurs during execution of the try block, the remaining
11903lines in the try block are skipped. The exception is matched against the
11904patterns specified as arguments to the ":catch" commands. The catch clause
11905after the first matching ":catch" is taken, other catch clauses are not
11906executed. The catch clause ends when the next ":catch", ":finally", or
11907":endtry" command is reached - whatever is first. Then, the finally clause
11908(if present) is executed. When the ":endtry" is reached, the script execution
11909continues in the following line as usual.
11910 When an exception that does not match any of the patterns specified by the
11911":catch" commands is thrown in the try block, the exception is not caught by
11912that try conditional and none of the catch clauses is executed. Only the
11913finally clause, if present, is taken. The exception pends during execution of
11914the finally clause. It is resumed at the ":endtry", so that commands after
11915the ":endtry" are not executed and the exception might be caught elsewhere,
11916see |try-nesting|.
11917 When during execution of a catch clause another exception is thrown, the
Bram Moolenaar58b85342016-08-14 19:54:54 +020011918remaining lines in that catch clause are not executed. The new exception is
Bram Moolenaar071d4272004-06-13 20:20:40 +000011919not matched against the patterns in any of the ":catch" commands of the same
11920try conditional and none of its catch clauses is taken. If there is, however,
11921a finally clause, it is executed, and the exception pends during its
11922execution. The commands following the ":endtry" are not executed. The new
11923exception might, however, be caught elsewhere, see |try-nesting|.
11924 When during execution of the finally clause (if present) an exception is
Bram Moolenaar58b85342016-08-14 19:54:54 +020011925thrown, the remaining lines in the finally clause are skipped. If the finally
Bram Moolenaar071d4272004-06-13 20:20:40 +000011926clause has been taken because of an exception from the try block or one of the
11927catch clauses, the original (pending) exception is discarded. The commands
11928following the ":endtry" are not executed, and the exception from the finally
11929clause is propagated and can be caught elsewhere, see |try-nesting|.
11930
11931The finally clause is also executed, when a ":break" or ":continue" for
11932a ":while" loop enclosing the complete try conditional is executed from the
11933try block or a catch clause. Or when a ":return" or ":finish" is executed
11934from the try block or a catch clause of a try conditional in a function or
11935sourced script, respectively. The ":break", ":continue", ":return", or
11936":finish" pends during execution of the finally clause and is resumed when the
11937":endtry" is reached. It is, however, discarded when an exception is thrown
11938from the finally clause.
11939 When a ":break" or ":continue" for a ":while" loop enclosing the complete
11940try conditional or when a ":return" or ":finish" is encountered in the finally
11941clause, the rest of the finally clause is skipped, and the ":break",
11942":continue", ":return" or ":finish" is executed as usual. If the finally
11943clause has been taken because of an exception or an earlier ":break",
11944":continue", ":return", or ":finish" from the try block or a catch clause,
11945this pending exception or command is discarded.
11946
11947For examples see |throw-catch| and |try-finally|.
11948
11949
11950NESTING OF TRY CONDITIONALS *try-nesting*
11951
11952Try conditionals can be nested arbitrarily. That is, a complete try
11953conditional can be put into the try block, a catch clause, or the finally
11954clause of another try conditional. If the inner try conditional does not
11955catch an exception thrown in its try block or throws a new exception from one
11956of its catch clauses or its finally clause, the outer try conditional is
11957checked according to the rules above. If the inner try conditional is in the
11958try block of the outer try conditional, its catch clauses are checked, but
Bram Moolenaar58b85342016-08-14 19:54:54 +020011959otherwise only the finally clause is executed. It does not matter for
Bram Moolenaar071d4272004-06-13 20:20:40 +000011960nesting, whether the inner try conditional is directly contained in the outer
11961one, or whether the outer one sources a script or calls a function containing
11962the inner try conditional.
11963
11964When none of the active try conditionals catches an exception, just their
11965finally clauses are executed. Thereafter, the script processing terminates.
11966An error message is displayed in case of an uncaught exception explicitly
11967thrown by a ":throw" command. For uncaught error and interrupt exceptions
11968implicitly raised by Vim, the error message(s) or interrupt message are shown
11969as usual.
11970
11971For examples see |throw-catch|.
11972
11973
11974EXAMINING EXCEPTION HANDLING CODE *except-examine*
11975
11976Exception handling code can get tricky. If you are in doubt what happens, set
11977'verbose' to 13 or use the ":13verbose" command modifier when sourcing your
11978script file. Then you see when an exception is thrown, discarded, caught, or
11979finished. When using a verbosity level of at least 14, things pending in
11980a finally clause are also shown. This information is also given in debug mode
11981(see |debug-scripts|).
11982
11983
11984THROWING AND CATCHING EXCEPTIONS *throw-catch*
11985
11986You can throw any number or string as an exception. Use the |:throw| command
11987and pass the value to be thrown as argument: >
11988 :throw 4711
11989 :throw "string"
11990< *throw-expression*
11991You can also specify an expression argument. The expression is then evaluated
11992first, and the result is thrown: >
11993 :throw 4705 + strlen("string")
11994 :throw strpart("strings", 0, 6)
11995
11996An exception might be thrown during evaluation of the argument of the ":throw"
11997command. Unless it is caught there, the expression evaluation is abandoned.
11998The ":throw" command then does not throw a new exception.
11999 Example: >
12000
12001 :function! Foo(arg)
12002 : try
12003 : throw a:arg
12004 : catch /foo/
12005 : endtry
12006 : return 1
12007 :endfunction
12008 :
12009 :function! Bar()
12010 : echo "in Bar"
12011 : return 4710
12012 :endfunction
12013 :
12014 :throw Foo("arrgh") + Bar()
12015
12016This throws "arrgh", and "in Bar" is not displayed since Bar() is not
12017executed. >
12018 :throw Foo("foo") + Bar()
12019however displays "in Bar" and throws 4711.
12020
12021Any other command that takes an expression as argument might also be
Bram Moolenaar58b85342016-08-14 19:54:54 +020012022abandoned by an (uncaught) exception during the expression evaluation. The
Bram Moolenaar071d4272004-06-13 20:20:40 +000012023exception is then propagated to the caller of the command.
12024 Example: >
12025
12026 :if Foo("arrgh")
12027 : echo "then"
12028 :else
12029 : echo "else"
12030 :endif
12031
12032Here neither of "then" or "else" is displayed.
12033
12034 *catch-order*
12035Exceptions can be caught by a try conditional with one or more |:catch|
12036commands, see |try-conditionals|. The values to be caught by each ":catch"
12037command can be specified as a pattern argument. The subsequent catch clause
12038gets executed when a matching exception is caught.
12039 Example: >
12040
12041 :function! Foo(value)
12042 : try
12043 : throw a:value
12044 : catch /^\d\+$/
12045 : echo "Number thrown"
12046 : catch /.*/
12047 : echo "String thrown"
12048 : endtry
12049 :endfunction
12050 :
12051 :call Foo(0x1267)
12052 :call Foo('string')
12053
12054The first call to Foo() displays "Number thrown", the second "String thrown".
12055An exception is matched against the ":catch" commands in the order they are
12056specified. Only the first match counts. So you should place the more
12057specific ":catch" first. The following order does not make sense: >
12058
12059 : catch /.*/
12060 : echo "String thrown"
12061 : catch /^\d\+$/
12062 : echo "Number thrown"
12063
12064The first ":catch" here matches always, so that the second catch clause is
12065never taken.
12066
12067 *throw-variables*
12068If you catch an exception by a general pattern, you may access the exact value
12069in the variable |v:exception|: >
12070
12071 : catch /^\d\+$/
12072 : echo "Number thrown. Value is" v:exception
12073
12074You may also be interested where an exception was thrown. This is stored in
12075|v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the
12076exception most recently caught as long it is not finished.
12077 Example: >
12078
12079 :function! Caught()
12080 : if v:exception != ""
12081 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint
12082 : else
12083 : echo 'Nothing caught'
12084 : endif
12085 :endfunction
12086 :
12087 :function! Foo()
12088 : try
12089 : try
12090 : try
12091 : throw 4711
12092 : finally
12093 : call Caught()
12094 : endtry
12095 : catch /.*/
12096 : call Caught()
12097 : throw "oops"
12098 : endtry
12099 : catch /.*/
12100 : call Caught()
12101 : finally
12102 : call Caught()
12103 : endtry
12104 :endfunction
12105 :
12106 :call Foo()
12107
12108This displays >
12109
12110 Nothing caught
12111 Caught "4711" in function Foo, line 4
12112 Caught "oops" in function Foo, line 10
12113 Nothing caught
12114
12115A practical example: The following command ":LineNumber" displays the line
12116number in the script or function where it has been used: >
12117
12118 :function! LineNumber()
12119 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "")
12120 :endfunction
12121 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry
12122<
12123 *try-nested*
12124An exception that is not caught by a try conditional can be caught by
12125a surrounding try conditional: >
12126
12127 :try
12128 : try
12129 : throw "foo"
12130 : catch /foobar/
12131 : echo "foobar"
12132 : finally
12133 : echo "inner finally"
12134 : endtry
12135 :catch /foo/
12136 : echo "foo"
12137 :endtry
12138
12139The inner try conditional does not catch the exception, just its finally
12140clause is executed. The exception is then caught by the outer try
12141conditional. The example displays "inner finally" and then "foo".
12142
12143 *throw-from-catch*
12144You can catch an exception and throw a new one to be caught elsewhere from the
12145catch clause: >
12146
12147 :function! Foo()
12148 : throw "foo"
12149 :endfunction
12150 :
12151 :function! Bar()
12152 : try
12153 : call Foo()
12154 : catch /foo/
12155 : echo "Caught foo, throw bar"
12156 : throw "bar"
12157 : endtry
12158 :endfunction
12159 :
12160 :try
12161 : call Bar()
12162 :catch /.*/
12163 : echo "Caught" v:exception
12164 :endtry
12165
12166This displays "Caught foo, throw bar" and then "Caught bar".
12167
12168 *rethrow*
12169There is no real rethrow in the Vim script language, but you may throw
12170"v:exception" instead: >
12171
12172 :function! Bar()
12173 : try
12174 : call Foo()
12175 : catch /.*/
12176 : echo "Rethrow" v:exception
12177 : throw v:exception
12178 : endtry
12179 :endfunction
12180< *try-echoerr*
12181Note that this method cannot be used to "rethrow" Vim error or interrupt
12182exceptions, because it is not possible to fake Vim internal exceptions.
12183Trying so causes an error exception. You should throw your own exception
12184denoting the situation. If you want to cause a Vim error exception containing
12185the original error exception value, you can use the |:echoerr| command: >
12186
12187 :try
12188 : try
12189 : asdf
12190 : catch /.*/
12191 : echoerr v:exception
12192 : endtry
12193 :catch /.*/
12194 : echo v:exception
12195 :endtry
12196
12197This code displays
12198
Bram Moolenaar446cb832008-06-24 21:56:24 +000012199 Vim(echoerr):Vim:E492: Not an editor command: asdf ~
Bram Moolenaar071d4272004-06-13 20:20:40 +000012200
12201
12202CLEANUP CODE *try-finally*
12203
12204Scripts often change global settings and restore them at their end. If the
12205user however interrupts the script by pressing CTRL-C, the settings remain in
Bram Moolenaar58b85342016-08-14 19:54:54 +020012206an inconsistent state. The same may happen to you in the development phase of
Bram Moolenaar071d4272004-06-13 20:20:40 +000012207a script when an error occurs or you explicitly throw an exception without
12208catching it. You can solve these problems by using a try conditional with
12209a finally clause for restoring the settings. Its execution is guaranteed on
12210normal control flow, on error, on an explicit ":throw", and on interrupt.
12211(Note that errors and interrupts from inside the try conditional are converted
Bram Moolenaar58b85342016-08-14 19:54:54 +020012212to exceptions. When not caught, they terminate the script after the finally
Bram Moolenaar071d4272004-06-13 20:20:40 +000012213clause has been executed.)
12214Example: >
12215
12216 :try
12217 : let s:saved_ts = &ts
12218 : set ts=17
12219 :
12220 : " Do the hard work here.
12221 :
12222 :finally
12223 : let &ts = s:saved_ts
12224 : unlet s:saved_ts
12225 :endtry
12226
12227This method should be used locally whenever a function or part of a script
12228changes global settings which need to be restored on failure or normal exit of
12229that function or script part.
12230
12231 *break-finally*
12232Cleanup code works also when the try block or a catch clause is left by
12233a ":continue", ":break", ":return", or ":finish".
12234 Example: >
12235
12236 :let first = 1
12237 :while 1
12238 : try
12239 : if first
12240 : echo "first"
12241 : let first = 0
12242 : continue
12243 : else
12244 : throw "second"
12245 : endif
12246 : catch /.*/
12247 : echo v:exception
12248 : break
12249 : finally
12250 : echo "cleanup"
12251 : endtry
12252 : echo "still in while"
12253 :endwhile
12254 :echo "end"
12255
12256This displays "first", "cleanup", "second", "cleanup", and "end". >
12257
12258 :function! Foo()
12259 : try
12260 : return 4711
12261 : finally
12262 : echo "cleanup\n"
12263 : endtry
12264 : echo "Foo still active"
12265 :endfunction
12266 :
12267 :echo Foo() "returned by Foo"
12268
12269This displays "cleanup" and "4711 returned by Foo". You don't need to add an
Bram Moolenaar58b85342016-08-14 19:54:54 +020012270extra ":return" in the finally clause. (Above all, this would override the
Bram Moolenaar071d4272004-06-13 20:20:40 +000012271return value.)
12272
12273 *except-from-finally*
12274Using either of ":continue", ":break", ":return", ":finish", or ":throw" in
12275a finally clause is possible, but not recommended since it abandons the
12276cleanup actions for the try conditional. But, of course, interrupt and error
12277exceptions might get raised from a finally clause.
12278 Example where an error in the finally clause stops an interrupt from
12279working correctly: >
12280
12281 :try
12282 : try
12283 : echo "Press CTRL-C for interrupt"
12284 : while 1
12285 : endwhile
12286 : finally
12287 : unlet novar
12288 : endtry
12289 :catch /novar/
12290 :endtry
12291 :echo "Script still running"
12292 :sleep 1
12293
12294If you need to put commands that could fail into a finally clause, you should
12295think about catching or ignoring the errors in these commands, see
12296|catch-errors| and |ignore-errors|.
12297
12298
12299CATCHING ERRORS *catch-errors*
12300
12301If you want to catch specific errors, you just have to put the code to be
12302watched in a try block and add a catch clause for the error message. The
12303presence of the try conditional causes all errors to be converted to an
12304exception. No message is displayed and |v:errmsg| is not set then. To find
12305the right pattern for the ":catch" command, you have to know how the format of
12306the error exception is.
12307 Error exceptions have the following format: >
12308
12309 Vim({cmdname}):{errmsg}
12310or >
12311 Vim:{errmsg}
12312
12313{cmdname} is the name of the command that failed; the second form is used when
Bram Moolenaar58b85342016-08-14 19:54:54 +020012314the command name is not known. {errmsg} is the error message usually produced
Bram Moolenaar071d4272004-06-13 20:20:40 +000012315when the error occurs outside try conditionals. It always begins with
12316a capital "E", followed by a two or three-digit error number, a colon, and
12317a space.
12318
12319Examples:
12320
12321The command >
12322 :unlet novar
12323normally produces the error message >
12324 E108: No such variable: "novar"
12325which is converted inside try conditionals to an exception >
12326 Vim(unlet):E108: No such variable: "novar"
12327
12328The command >
12329 :dwim
12330normally produces the error message >
12331 E492: Not an editor command: dwim
12332which is converted inside try conditionals to an exception >
12333 Vim:E492: Not an editor command: dwim
12334
12335You can catch all ":unlet" errors by a >
12336 :catch /^Vim(unlet):/
12337or all errors for misspelled command names by a >
12338 :catch /^Vim:E492:/
12339
12340Some error messages may be produced by different commands: >
12341 :function nofunc
12342and >
12343 :delfunction nofunc
12344both produce the error message >
12345 E128: Function name must start with a capital: nofunc
12346which is converted inside try conditionals to an exception >
12347 Vim(function):E128: Function name must start with a capital: nofunc
12348or >
12349 Vim(delfunction):E128: Function name must start with a capital: nofunc
12350respectively. You can catch the error by its number independently on the
12351command that caused it if you use the following pattern: >
12352 :catch /^Vim(\a\+):E128:/
12353
12354Some commands like >
12355 :let x = novar
12356produce multiple error messages, here: >
12357 E121: Undefined variable: novar
12358 E15: Invalid expression: novar
12359Only the first is used for the exception value, since it is the most specific
12360one (see |except-several-errors|). So you can catch it by >
12361 :catch /^Vim(\a\+):E121:/
12362
12363You can catch all errors related to the name "nofunc" by >
12364 :catch /\<nofunc\>/
12365
12366You can catch all Vim errors in the ":write" and ":read" commands by >
12367 :catch /^Vim(\(write\|read\)):E\d\+:/
12368
12369You can catch all Vim errors by the pattern >
12370 :catch /^Vim\((\a\+)\)\=:E\d\+:/
12371<
12372 *catch-text*
12373NOTE: You should never catch the error message text itself: >
12374 :catch /No such variable/
Bram Moolenaar2b8388b2015-02-28 13:11:45 +010012375only works in the English locale, but not when the user has selected
Bram Moolenaar071d4272004-06-13 20:20:40 +000012376a different language by the |:language| command. It is however helpful to
12377cite the message text in a comment: >
12378 :catch /^Vim(\a\+):E108:/ " No such variable
12379
12380
12381IGNORING ERRORS *ignore-errors*
12382
12383You can ignore errors in a specific Vim command by catching them locally: >
12384
12385 :try
12386 : write
12387 :catch
12388 :endtry
12389
12390But you are strongly recommended NOT to use this simple form, since it could
12391catch more than you want. With the ":write" command, some autocommands could
12392be executed and cause errors not related to writing, for instance: >
12393
12394 :au BufWritePre * unlet novar
12395
12396There could even be such errors you are not responsible for as a script
12397writer: a user of your script might have defined such autocommands. You would
12398then hide the error from the user.
12399 It is much better to use >
12400
12401 :try
12402 : write
12403 :catch /^Vim(write):/
12404 :endtry
12405
12406which only catches real write errors. So catch only what you'd like to ignore
12407intentionally.
12408
12409For a single command that does not cause execution of autocommands, you could
12410even suppress the conversion of errors to exceptions by the ":silent!"
12411command: >
12412 :silent! nunmap k
12413This works also when a try conditional is active.
12414
12415
12416CATCHING INTERRUPTS *catch-interrupt*
12417
12418When there are active try conditionals, an interrupt (CTRL-C) is converted to
Bram Moolenaar58b85342016-08-14 19:54:54 +020012419the exception "Vim:Interrupt". You can catch it like every exception. The
Bram Moolenaar071d4272004-06-13 20:20:40 +000012420script is not terminated, then.
12421 Example: >
12422
12423 :function! TASK1()
12424 : sleep 10
12425 :endfunction
12426
12427 :function! TASK2()
12428 : sleep 20
12429 :endfunction
12430
12431 :while 1
12432 : let command = input("Type a command: ")
12433 : try
12434 : if command == ""
12435 : continue
12436 : elseif command == "END"
12437 : break
12438 : elseif command == "TASK1"
12439 : call TASK1()
12440 : elseif command == "TASK2"
12441 : call TASK2()
12442 : else
12443 : echo "\nIllegal command:" command
12444 : continue
12445 : endif
12446 : catch /^Vim:Interrupt$/
12447 : echo "\nCommand interrupted"
12448 : " Caught the interrupt. Continue with next prompt.
12449 : endtry
12450 :endwhile
12451
12452You can interrupt a task here by pressing CTRL-C; the script then asks for
Bram Moolenaar58b85342016-08-14 19:54:54 +020012453a new command. If you press CTRL-C at the prompt, the script is terminated.
Bram Moolenaar071d4272004-06-13 20:20:40 +000012454
12455For testing what happens when CTRL-C would be pressed on a specific line in
12456your script, use the debug mode and execute the |>quit| or |>interrupt|
12457command on that line. See |debug-scripts|.
12458
12459
12460CATCHING ALL *catch-all*
12461
12462The commands >
12463
12464 :catch /.*/
12465 :catch //
12466 :catch
12467
12468catch everything, error exceptions, interrupt exceptions and exceptions
12469explicitly thrown by the |:throw| command. This is useful at the top level of
12470a script in order to catch unexpected things.
12471 Example: >
12472
12473 :try
12474 :
12475 : " do the hard work here
12476 :
12477 :catch /MyException/
12478 :
12479 : " handle known problem
12480 :
12481 :catch /^Vim:Interrupt$/
12482 : echo "Script interrupted"
12483 :catch /.*/
12484 : echo "Internal error (" . v:exception . ")"
12485 : echo " - occurred at " . v:throwpoint
12486 :endtry
12487 :" end of script
12488
12489Note: Catching all might catch more things than you want. Thus, you are
12490strongly encouraged to catch only for problems that you can really handle by
12491specifying a pattern argument to the ":catch".
12492 Example: Catching all could make it nearly impossible to interrupt a script
12493by pressing CTRL-C: >
12494
12495 :while 1
12496 : try
12497 : sleep 1
12498 : catch
12499 : endtry
12500 :endwhile
12501
12502
12503EXCEPTIONS AND AUTOCOMMANDS *except-autocmd*
12504
12505Exceptions may be used during execution of autocommands. Example: >
12506
12507 :autocmd User x try
12508 :autocmd User x throw "Oops!"
12509 :autocmd User x catch
12510 :autocmd User x echo v:exception
12511 :autocmd User x endtry
12512 :autocmd User x throw "Arrgh!"
12513 :autocmd User x echo "Should not be displayed"
12514 :
12515 :try
12516 : doautocmd User x
12517 :catch
12518 : echo v:exception
12519 :endtry
12520
12521This displays "Oops!" and "Arrgh!".
12522
12523 *except-autocmd-Pre*
12524For some commands, autocommands get executed before the main action of the
12525command takes place. If an exception is thrown and not caught in the sequence
12526of autocommands, the sequence and the command that caused its execution are
12527abandoned and the exception is propagated to the caller of the command.
12528 Example: >
12529
12530 :autocmd BufWritePre * throw "FAIL"
12531 :autocmd BufWritePre * echo "Should not be displayed"
12532 :
12533 :try
12534 : write
12535 :catch
12536 : echo "Caught:" v:exception "from" v:throwpoint
12537 :endtry
12538
12539Here, the ":write" command does not write the file currently being edited (as
12540you can see by checking 'modified'), since the exception from the BufWritePre
12541autocommand abandons the ":write". The exception is then caught and the
12542script displays: >
12543
12544 Caught: FAIL from BufWrite Auto commands for "*"
12545<
12546 *except-autocmd-Post*
12547For some commands, autocommands get executed after the main action of the
12548command has taken place. If this main action fails and the command is inside
12549an active try conditional, the autocommands are skipped and an error exception
12550is thrown that can be caught by the caller of the command.
12551 Example: >
12552
12553 :autocmd BufWritePost * echo "File successfully written!"
12554 :
12555 :try
12556 : write /i/m/p/o/s/s/i/b/l/e
12557 :catch
12558 : echo v:exception
12559 :endtry
12560
12561This just displays: >
12562
12563 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e)
12564
12565If you really need to execute the autocommands even when the main action
12566fails, trigger the event from the catch clause.
12567 Example: >
12568
12569 :autocmd BufWritePre * set noreadonly
12570 :autocmd BufWritePost * set readonly
12571 :
12572 :try
12573 : write /i/m/p/o/s/s/i/b/l/e
12574 :catch
12575 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e
12576 :endtry
12577<
12578You can also use ":silent!": >
12579
12580 :let x = "ok"
12581 :let v:errmsg = ""
12582 :autocmd BufWritePost * if v:errmsg != ""
12583 :autocmd BufWritePost * let x = "after fail"
12584 :autocmd BufWritePost * endif
12585 :try
12586 : silent! write /i/m/p/o/s/s/i/b/l/e
12587 :catch
12588 :endtry
12589 :echo x
12590
12591This displays "after fail".
12592
12593If the main action of the command does not fail, exceptions from the
12594autocommands will be catchable by the caller of the command: >
12595
12596 :autocmd BufWritePost * throw ":-("
12597 :autocmd BufWritePost * echo "Should not be displayed"
12598 :
12599 :try
12600 : write
12601 :catch
12602 : echo v:exception
12603 :endtry
12604<
12605 *except-autocmd-Cmd*
12606For some commands, the normal action can be replaced by a sequence of
12607autocommands. Exceptions from that sequence will be catchable by the caller
12608of the command.
12609 Example: For the ":write" command, the caller cannot know whether the file
Bram Moolenaar58b85342016-08-14 19:54:54 +020012610had actually been written when the exception occurred. You need to tell it in
Bram Moolenaar071d4272004-06-13 20:20:40 +000012611some way. >
12612
12613 :if !exists("cnt")
12614 : let cnt = 0
12615 :
12616 : autocmd BufWriteCmd * if &modified
12617 : autocmd BufWriteCmd * let cnt = cnt + 1
12618 : autocmd BufWriteCmd * if cnt % 3 == 2
12619 : autocmd BufWriteCmd * throw "BufWriteCmdError"
12620 : autocmd BufWriteCmd * endif
12621 : autocmd BufWriteCmd * write | set nomodified
12622 : autocmd BufWriteCmd * if cnt % 3 == 0
12623 : autocmd BufWriteCmd * throw "BufWriteCmdError"
12624 : autocmd BufWriteCmd * endif
12625 : autocmd BufWriteCmd * echo "File successfully written!"
12626 : autocmd BufWriteCmd * endif
12627 :endif
12628 :
12629 :try
12630 : write
12631 :catch /^BufWriteCmdError$/
12632 : if &modified
12633 : echo "Error on writing (file contents not changed)"
12634 : else
12635 : echo "Error after writing"
12636 : endif
12637 :catch /^Vim(write):/
12638 : echo "Error on writing"
12639 :endtry
12640
12641When this script is sourced several times after making changes, it displays
12642first >
12643 File successfully written!
12644then >
12645 Error on writing (file contents not changed)
12646then >
12647 Error after writing
12648etc.
12649
12650 *except-autocmd-ill*
12651You cannot spread a try conditional over autocommands for different events.
12652The following code is ill-formed: >
12653
12654 :autocmd BufWritePre * try
12655 :
12656 :autocmd BufWritePost * catch
12657 :autocmd BufWritePost * echo v:exception
12658 :autocmd BufWritePost * endtry
12659 :
12660 :write
12661
12662
12663EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param*
12664
12665Some programming languages allow to use hierarchies of exception classes or to
12666pass additional information with the object of an exception class. You can do
12667similar things in Vim.
12668 In order to throw an exception from a hierarchy, just throw the complete
12669class name with the components separated by a colon, for instance throw the
12670string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library.
12671 When you want to pass additional information with your exception class, add
12672it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)"
12673for an error when writing "myfile".
12674 With the appropriate patterns in the ":catch" command, you can catch for
12675base classes or derived classes of your hierarchy. Additional information in
12676parentheses can be cut out from |v:exception| with the ":substitute" command.
12677 Example: >
12678
12679 :function! CheckRange(a, func)
12680 : if a:a < 0
12681 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")"
12682 : endif
12683 :endfunction
12684 :
12685 :function! Add(a, b)
12686 : call CheckRange(a:a, "Add")
12687 : call CheckRange(a:b, "Add")
12688 : let c = a:a + a:b
12689 : if c < 0
12690 : throw "EXCEPT:MATHERR:OVERFLOW"
12691 : endif
12692 : return c
12693 :endfunction
12694 :
12695 :function! Div(a, b)
12696 : call CheckRange(a:a, "Div")
12697 : call CheckRange(a:b, "Div")
12698 : if (a:b == 0)
12699 : throw "EXCEPT:MATHERR:ZERODIV"
12700 : endif
12701 : return a:a / a:b
12702 :endfunction
12703 :
12704 :function! Write(file)
12705 : try
Bram Moolenaar446cb832008-06-24 21:56:24 +000012706 : execute "write" fnameescape(a:file)
Bram Moolenaar071d4272004-06-13 20:20:40 +000012707 : catch /^Vim(write):/
12708 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR"
12709 : endtry
12710 :endfunction
12711 :
12712 :try
12713 :
12714 : " something with arithmetics and I/O
12715 :
12716 :catch /^EXCEPT:MATHERR:RANGE/
12717 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "")
12718 : echo "Range error in" function
12719 :
12720 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV
12721 : echo "Math error"
12722 :
12723 :catch /^EXCEPT:IO/
12724 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "")
12725 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "")
12726 : if file !~ '^/'
12727 : let file = dir . "/" . file
12728 : endif
12729 : echo 'I/O error for "' . file . '"'
12730 :
12731 :catch /^EXCEPT/
12732 : echo "Unspecified error"
12733 :
12734 :endtry
12735
12736The exceptions raised by Vim itself (on error or when pressing CTRL-C) use
12737a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself
12738exceptions with the "Vim" prefix; they are reserved for Vim.
12739 Vim error exceptions are parameterized with the name of the command that
12740failed, if known. See |catch-errors|.
12741
12742
12743PECULIARITIES
12744 *except-compat*
12745The exception handling concept requires that the command sequence causing the
12746exception is aborted immediately and control is transferred to finally clauses
12747and/or a catch clause.
12748
12749In the Vim script language there are cases where scripts and functions
12750continue after an error: in functions without the "abort" flag or in a command
12751after ":silent!", control flow goes to the following line, and outside
12752functions, control flow goes to the line following the outermost ":endwhile"
12753or ":endif". On the other hand, errors should be catchable as exceptions
12754(thus, requiring the immediate abortion).
12755
12756This problem has been solved by converting errors to exceptions and using
12757immediate abortion (if not suppressed by ":silent!") only when a try
Bram Moolenaar58b85342016-08-14 19:54:54 +020012758conditional is active. This is no restriction since an (error) exception can
12759be caught only from an active try conditional. If you want an immediate
Bram Moolenaar071d4272004-06-13 20:20:40 +000012760termination without catching the error, just use a try conditional without
12761catch clause. (You can cause cleanup code being executed before termination
12762by specifying a finally clause.)
12763
12764When no try conditional is active, the usual abortion and continuation
12765behavior is used instead of immediate abortion. This ensures compatibility of
12766scripts written for Vim 6.1 and earlier.
12767
12768However, when sourcing an existing script that does not use exception handling
12769commands (or when calling one of its functions) from inside an active try
12770conditional of a new script, you might change the control flow of the existing
12771script on error. You get the immediate abortion on error and can catch the
12772error in the new script. If however the sourced script suppresses error
12773messages by using the ":silent!" command (checking for errors by testing
Bram Moolenaar58b85342016-08-14 19:54:54 +020012774|v:errmsg| if appropriate), its execution path is not changed. The error is
12775not converted to an exception. (See |:silent|.) So the only remaining cause
Bram Moolenaar071d4272004-06-13 20:20:40 +000012776where this happens is for scripts that don't care about errors and produce
12777error messages. You probably won't want to use such code from your new
12778scripts.
12779
12780 *except-syntax-err*
12781Syntax errors in the exception handling commands are never caught by any of
12782the ":catch" commands of the try conditional they belong to. Its finally
12783clauses, however, is executed.
12784 Example: >
12785
12786 :try
12787 : try
12788 : throw 4711
12789 : catch /\(/
12790 : echo "in catch with syntax error"
12791 : catch
12792 : echo "inner catch-all"
12793 : finally
12794 : echo "inner finally"
12795 : endtry
12796 :catch
12797 : echo 'outer catch-all caught "' . v:exception . '"'
12798 : finally
12799 : echo "outer finally"
12800 :endtry
12801
12802This displays: >
12803 inner finally
12804 outer catch-all caught "Vim(catch):E54: Unmatched \("
12805 outer finally
12806The original exception is discarded and an error exception is raised, instead.
12807
12808 *except-single-line*
12809The ":try", ":catch", ":finally", and ":endtry" commands can be put on
12810a single line, but then syntax errors may make it difficult to recognize the
12811"catch" line, thus you better avoid this.
12812 Example: >
12813 :try | unlet! foo # | catch | endtry
12814raises an error exception for the trailing characters after the ":unlet!"
12815argument, but does not see the ":catch" and ":endtry" commands, so that the
12816error exception is discarded and the "E488: Trailing characters" message gets
12817displayed.
12818
12819 *except-several-errors*
12820When several errors appear in a single command, the first error message is
12821usually the most specific one and therefor converted to the error exception.
12822 Example: >
12823 echo novar
12824causes >
12825 E121: Undefined variable: novar
12826 E15: Invalid expression: novar
12827The value of the error exception inside try conditionals is: >
12828 Vim(echo):E121: Undefined variable: novar
12829< *except-syntax-error*
12830But when a syntax error is detected after a normal error in the same command,
12831the syntax error is used for the exception being thrown.
12832 Example: >
12833 unlet novar #
12834causes >
12835 E108: No such variable: "novar"
12836 E488: Trailing characters
12837The value of the error exception inside try conditionals is: >
12838 Vim(unlet):E488: Trailing characters
12839This is done because the syntax error might change the execution path in a way
12840not intended by the user. Example: >
12841 try
12842 try | unlet novar # | catch | echo v:exception | endtry
12843 catch /.*/
12844 echo "outer catch:" v:exception
12845 endtry
12846This displays "outer catch: Vim(unlet):E488: Trailing characters", and then
12847a "E600: Missing :endtry" error message is given, see |except-single-line|.
12848
12849==============================================================================
128509. Examples *eval-examples*
12851
Bram Moolenaaref2f6562007-05-06 13:32:59 +000012852Printing in Binary ~
Bram Moolenaar071d4272004-06-13 20:20:40 +000012853>
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010012854 :" The function Nr2Bin() returns the binary string representation of a number.
Bram Moolenaaref2f6562007-05-06 13:32:59 +000012855 :func Nr2Bin(nr)
Bram Moolenaar071d4272004-06-13 20:20:40 +000012856 : let n = a:nr
12857 : let r = ""
12858 : while n
Bram Moolenaaref2f6562007-05-06 13:32:59 +000012859 : let r = '01'[n % 2] . r
12860 : let n = n / 2
Bram Moolenaar071d4272004-06-13 20:20:40 +000012861 : endwhile
12862 : return r
12863 :endfunc
12864
Bram Moolenaaref2f6562007-05-06 13:32:59 +000012865 :" The function String2Bin() converts each character in a string to a
12866 :" binary string, separated with dashes.
12867 :func String2Bin(str)
Bram Moolenaar071d4272004-06-13 20:20:40 +000012868 : let out = ''
Bram Moolenaaref2f6562007-05-06 13:32:59 +000012869 : for ix in range(strlen(a:str))
12870 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix]))
12871 : endfor
12872 : return out[1:]
Bram Moolenaar071d4272004-06-13 20:20:40 +000012873 :endfunc
12874
12875Example of its use: >
Bram Moolenaaref2f6562007-05-06 13:32:59 +000012876 :echo Nr2Bin(32)
12877result: "100000" >
12878 :echo String2Bin("32")
12879result: "110011-110010"
Bram Moolenaar071d4272004-06-13 20:20:40 +000012880
12881
Bram Moolenaaref2f6562007-05-06 13:32:59 +000012882Sorting lines ~
Bram Moolenaar071d4272004-06-13 20:20:40 +000012883
Bram Moolenaaref2f6562007-05-06 13:32:59 +000012884This example sorts lines with a specific compare function. >
12885
12886 :func SortBuffer()
12887 : let lines = getline(1, '$')
12888 : call sort(lines, function("Strcmp"))
12889 : call setline(1, lines)
Bram Moolenaar071d4272004-06-13 20:20:40 +000012890 :endfunction
12891
Bram Moolenaaref2f6562007-05-06 13:32:59 +000012892As a one-liner: >
12893 :call setline(1, sort(getline(1, '$'), function("Strcmp")))
Bram Moolenaar071d4272004-06-13 20:20:40 +000012894
Bram Moolenaar071d4272004-06-13 20:20:40 +000012895
Bram Moolenaaref2f6562007-05-06 13:32:59 +000012896scanf() replacement ~
Bram Moolenaar071d4272004-06-13 20:20:40 +000012897 *sscanf*
12898There is no sscanf() function in Vim. If you need to extract parts from a
12899line, you can use matchstr() and substitute() to do it. This example shows
12900how to get the file name, line number and column number out of a line like
12901"foobar.txt, 123, 45". >
12902 :" Set up the match bit
12903 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)'
12904 :"get the part matching the whole expression
12905 :let l = matchstr(line, mx)
12906 :"get each item out of the match
12907 :let file = substitute(l, mx, '\1', '')
12908 :let lnum = substitute(l, mx, '\2', '')
12909 :let col = substitute(l, mx, '\3', '')
12910
12911The input is in the variable "line", the results in the variables "file",
12912"lnum" and "col". (idea from Michael Geddes)
12913
Bram Moolenaaref2f6562007-05-06 13:32:59 +000012914
12915getting the scriptnames in a Dictionary ~
12916 *scriptnames-dictionary*
12917The |:scriptnames| command can be used to get a list of all script files that
12918have been sourced. There is no equivalent function or variable for this
12919(because it's rarely needed). In case you need to manipulate the list this
12920code can be used: >
12921 " Get the output of ":scriptnames" in the scriptnames_output variable.
12922 let scriptnames_output = ''
12923 redir => scriptnames_output
12924 silent scriptnames
12925 redir END
Bram Moolenaarb0d45e72017-11-05 18:19:24 +010012926
Bram Moolenaar446cb832008-06-24 21:56:24 +000012927 " Split the output into lines and parse each line. Add an entry to the
Bram Moolenaaref2f6562007-05-06 13:32:59 +000012928 " "scripts" dictionary.
12929 let scripts = {}
12930 for line in split(scriptnames_output, "\n")
12931 " Only do non-blank lines.
12932 if line =~ '\S'
12933 " Get the first number in the line.
Bram Moolenaar446cb832008-06-24 21:56:24 +000012934 let nr = matchstr(line, '\d\+')
Bram Moolenaaref2f6562007-05-06 13:32:59 +000012935 " Get the file name, remove the script number " 123: ".
Bram Moolenaar446cb832008-06-24 21:56:24 +000012936 let name = substitute(line, '.\+:\s*', '', '')
Bram Moolenaaref2f6562007-05-06 13:32:59 +000012937 " Add an item to the Dictionary
Bram Moolenaar446cb832008-06-24 21:56:24 +000012938 let scripts[nr] = name
Bram Moolenaaref2f6562007-05-06 13:32:59 +000012939 endif
12940 endfor
12941 unlet scriptnames_output
12942
Bram Moolenaar071d4272004-06-13 20:20:40 +000012943==============================================================================
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02001294410. Vim script versions *vimscript-version* *vimscript-versions*
Bram Moolenaar911ead12019-04-21 00:03:35 +020012945 *scriptversion*
Bram Moolenaar558ca4a2019-04-04 18:15:38 +020012946Over time many features have been added to Vim script. This includes Ex
12947commands, functions, variable types, etc. Each individual feature can be
12948checked with the |has()| and |exists()| functions.
12949
12950Sometimes old syntax of functionality gets in the way of making Vim better.
12951When support is taken away this will break older Vim scripts. To make this
12952explicit the |:scriptversion| command can be used. When a Vim script is not
12953compatible with older versions of Vim this will give an explicit error,
Bram Moolenaar3ff5f0f2019-06-10 13:11:22 +020012954instead of failing in mysterious ways.
Bram Moolenaar558ca4a2019-04-04 18:15:38 +020012955
Bram Moolenaar3ff5f0f2019-06-10 13:11:22 +020012956 *scriptversion-1* >
Bram Moolenaar558ca4a2019-04-04 18:15:38 +020012957 :scriptversion 1
12958< This is the original Vim script, same as not using a |:scriptversion|
12959 command. Can be used to go back to old syntax for a range of lines.
12960 Test for support with: >
12961 has('vimscript-1')
12962
Bram Moolenaar3ff5f0f2019-06-10 13:11:22 +020012963< *scriptversion-2* >
Bram Moolenaar558ca4a2019-04-04 18:15:38 +020012964 :scriptversion 2
Bram Moolenaar68e65602019-05-26 21:33:31 +020012965< String concatenation with "." is not supported, use ".." instead.
Bram Moolenaar558ca4a2019-04-04 18:15:38 +020012966 This avoids the ambiguity using "." for Dict member access and
12967 floating point numbers. Now ".5" means the number 0.5.
Bram Moolenaar3ff5f0f2019-06-10 13:11:22 +020012968
12969 *scriptversion-3* >
Bram Moolenaar911ead12019-04-21 00:03:35 +020012970 :scriptversion 3
12971< All |vim-variable|s must be prefixed by "v:". E.g. "version" doesn't
12972 work as |v:version| anymore, it can be used as a normal variable.
12973 Same for some obvious names as "count" and others.
Bram Moolenaar558ca4a2019-04-04 18:15:38 +020012974
Bram Moolenaar911ead12019-04-21 00:03:35 +020012975 Test for support with: >
12976 has('vimscript-3')
Bram Moolenaar60a8de22019-09-15 14:33:22 +020012977<
12978 *scriptversion-4* >
12979 :scriptversion 4
12980< Numbers with a leading zero are not recognized as octal. With the
12981 previous version you get: >
12982 echo 017 " displays 15
12983 echo 018 " displays 18
12984< with script version 4: >
12985 echo 017 " displays 17
12986 echo 018 " displays 18
12987< Also, it is possible to use single quotes inside numbers to make them
12988 easier to read: >
12989 echo 1'000'000
12990< The quotes must be surrounded by digits.
12991
12992 Test for support with: >
12993 has('vimscript-4')
Bram Moolenaar558ca4a2019-04-04 18:15:38 +020012994
12995==============================================================================
1299611. No +eval feature *no-eval-feature*
Bram Moolenaar071d4272004-06-13 20:20:40 +000012997
12998When the |+eval| feature was disabled at compile time, none of the expression
12999evaluation commands are available. To prevent this from causing Vim scripts
13000to generate all kinds of errors, the ":if" and ":endif" commands are still
13001recognized, though the argument of the ":if" and everything between the ":if"
13002and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but
13003only if the commands are at the start of the line. The ":else" command is not
13004recognized.
13005
13006Example of how to avoid executing commands when the |+eval| feature is
13007missing: >
13008
13009 :if 1
13010 : echo "Expression evaluation is compiled in"
13011 :else
13012 : echo "You will _never_ see this message"
13013 :endif
13014
Bram Moolenaar773a97c2019-06-06 20:39:55 +020013015To execute a command only when the |+eval| feature is disabled can be done in
13016two ways. The simplest is to exit the script (or Vim) prematurely: >
13017 if 1
13018 echo "commands executed with +eval"
13019 finish
13020 endif
13021 args " command executed without +eval
13022
13023If you do not want to abort loading the script you can use a trick, as this
13024example shows: >
Bram Moolenaar45d2cca2017-04-30 16:36:05 +020013025
13026 silent! while 0
13027 set history=111
13028 silent! endwhile
13029
13030When the |+eval| feature is available the command is skipped because of the
13031"while 0". Without the |+eval| feature the "while 0" is an error, which is
13032silently ignored, and the command is executed.
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +020013033
Bram Moolenaar071d4272004-06-13 20:20:40 +000013034==============================================================================
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02001303512. The sandbox *eval-sandbox* *sandbox* *E48*
Bram Moolenaar071d4272004-06-13 20:20:40 +000013036
Bram Moolenaar368373e2010-07-19 20:46:22 +020013037The 'foldexpr', 'formatexpr', 'includeexpr', 'indentexpr', 'statusline' and
13038'foldtext' options may be evaluated in a sandbox. This means that you are
13039protected from these expressions having nasty side effects. This gives some
13040safety for when these options are set from a modeline. It is also used when
13041the command from a tags file is executed and for CTRL-R = in the command line.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +000013042The sandbox is also used for the |:sandbox| command.
Bram Moolenaar071d4272004-06-13 20:20:40 +000013043
13044These items are not allowed in the sandbox:
13045 - changing the buffer text
Bram Moolenaarb477af22018-07-15 20:20:18 +020013046 - defining or changing mapping, autocommands, user commands
Bram Moolenaar071d4272004-06-13 20:20:40 +000013047 - setting certain options (see |option-summary|)
Bram Moolenaaref2f6562007-05-06 13:32:59 +000013048 - setting certain v: variables (see |v:var|) *E794*
Bram Moolenaar071d4272004-06-13 20:20:40 +000013049 - executing a shell command
13050 - reading or writing a file
13051 - jumping to another buffer or editing a file
Bram Moolenaar4770d092006-01-12 23:22:24 +000013052 - executing Python, Perl, etc. commands
Bram Moolenaar7b0294c2004-10-11 10:16:09 +000013053This is not guaranteed 100% secure, but it should block most attacks.
13054
13055 *:san* *:sandbox*
Bram Moolenaar045e82d2005-07-08 22:25:33 +000013056:san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an
Bram Moolenaar7b0294c2004-10-11 10:16:09 +000013057 option that may have been set from a modeline, e.g.
13058 'foldexpr'.
13059
Bram Moolenaarb71eaae2006-01-20 23:10:18 +000013060 *sandbox-option*
13061A few options contain an expression. When this expression is evaluated it may
Bram Moolenaar9b2200a2006-03-20 21:55:45 +000013062have to be done in the sandbox to avoid a security risk. But the sandbox is
Bram Moolenaarb71eaae2006-01-20 23:10:18 +000013063restrictive, thus this only happens when the option was set from an insecure
13064location. Insecure in this context are:
Bram Moolenaar551dbcc2006-04-25 22:13:59 +000013065- sourcing a .vimrc or .exrc in the current directory
Bram Moolenaarb71eaae2006-01-20 23:10:18 +000013066- while executing in the sandbox
13067- value coming from a modeline
Bram Moolenaarb477af22018-07-15 20:20:18 +020013068- executing a function that was defined in the sandbox
Bram Moolenaarb71eaae2006-01-20 23:10:18 +000013069
13070Note that when in the sandbox and saving an option value and restoring it, the
13071option will still be marked as it was set in the sandbox.
13072
13073==============================================================================
Bram Moolenaar558ca4a2019-04-04 18:15:38 +02001307413. Textlock *textlock*
Bram Moolenaarb71eaae2006-01-20 23:10:18 +000013075
13076In a few situations it is not allowed to change the text in the buffer, jump
13077to another window and some other things that might confuse or break what Vim
13078is currently doing. This mostly applies to things that happen when Vim is
Bram Moolenaar58b85342016-08-14 19:54:54 +020013079actually doing something else. For example, evaluating the 'balloonexpr' may
Bram Moolenaarb71eaae2006-01-20 23:10:18 +000013080happen any moment the mouse cursor is resting at some position.
13081
13082This is not allowed when the textlock is active:
13083 - changing the buffer text
13084 - jumping to another buffer or window
13085 - editing another file
13086 - closing a window or quitting Vim
13087 - etc.
13088
Bram Moolenaar071d4272004-06-13 20:20:40 +000013089
Bram Moolenaar91f84f62018-07-29 15:07:52 +020013090 vim:tw=78:ts=8:noet:ft=help:norl: