Mercurial > vim
annotate runtime/doc/eval.txt @ 7788:192ae655ac91 v7.4.1191
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Author: Bram Moolenaar <Bram@vim.org>
Date: Thu Jan 28 22:37:01 2016 +0100
patch 7.4.1191
Problem: The channel feature isn't working yet.
Solution: Add the connect(), disconnect(), sendexpr() and sendraw()
functions. Add initial documentation. Add a demo server.
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Thu, 28 Jan 2016 22:45:04 +0100 |
| parents | 3a99194bd187 |
| children | 93f747af7b58 |
| rev | line source |
|---|---|
|
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
1 *eval.txt* For Vim version 7.4. Last change: 2016 Jan 28 |
| 1621 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 7 | 5 |
| 6 | |
| 7 Expression evaluation *expression* *expr* *E15* *eval* | |
| 8 | |
| 9 Using expressions is introduced in chapter 41 of the user manual |usr_41.txt|. | |
| 10 | |
| 11 Note: Expression evaluation can be disabled at compile time. If this has been | |
| 1621 | 12 done, the features in this document are not available. See |+eval| and |
| 99 | 13 |no-eval-feature|. |
| 7 | 14 |
| 85 | 15 1. Variables |variables| |
| 16 1.1 Variable types | |
| 87 | 17 1.2 Function references |Funcref| |
| 161 | 18 1.3 Lists |Lists| |
| 99 | 19 1.4 Dictionaries |Dictionaries| |
| 20 1.5 More about variables |more-variables| | |
| 85 | 21 2. Expression syntax |expression-syntax| |
| 22 3. Internal variable |internal-variables| | |
| 23 4. Builtin Functions |functions| | |
| 24 5. Defining functions |user-functions| | |
| 25 6. Curly braces names |curly-braces-names| | |
| 26 7. Commands |expression-commands| | |
| 27 8. Exception handling |exception-handling| | |
| 28 9. Examples |eval-examples| | |
| 29 10. No +eval feature |no-eval-feature| | |
| 30 11. The sandbox |eval-sandbox| | |
| 634 | 31 12. Textlock |textlock| |
| 7 | 32 |
| 33 {Vi does not have any of these commands} | |
| 34 | |
| 35 ============================================================================== | |
| 36 1. Variables *variables* | |
| 37 | |
| 85 | 38 1.1 Variable types ~ |
| 114 | 39 *E712* |
| 1621 | 40 There are six types of variables: |
| 41 | |
| 3082 | 42 Number A 32 or 64 bit signed number. |expr-number| *Number* |
| 99 | 43 Examples: -123 0x10 0177 |
| 44 | |
| 1621 | 45 Float A floating point number. |floating-point-format| *Float* |
| 46 {only when compiled with the |+float| feature} | |
| 47 Examples: 123.456 1.15e-6 -1.1e3 | |
| 48 | |
| 99 | 49 String A NUL terminated string of 8-bit unsigned characters (bytes). |
| 1621 | 50 |expr-string| Examples: "ab\txx\"--" 'x-z''a,c' |
| 99 | 51 |
| 52 Funcref A reference to a function |Funcref|. | |
| 53 Example: function("strlen") | |
| 54 | |
| 55 List An ordered sequence of items |List|. | |
| 56 Example: [1, 2, ['a', 'b']] | |
| 55 | 57 |
| 370 | 58 Dictionary An associative, unordered array: Each entry has a key and a |
| 59 value. |Dictionary| | |
| 60 Example: {'blue': "#0000ff", 'red': "#ff0000"} | |
| 61 | |
| 55 | 62 The Number and String types are converted automatically, depending on how they |
| 63 are used. | |
| 7 | 64 |
| 65 Conversion from a Number to a String is by making the ASCII representation of | |
| 2581 | 66 the Number. Examples: |
| 67 Number 123 --> String "123" ~ | |
| 68 Number 0 --> String "0" ~ | |
| 69 Number -1 --> String "-1" ~ | |
| 2152 | 70 *octal* |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
71 Conversion from a String to a Number is done by converting the first digits to |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
72 a number. Hexadecimal "0xf9", Octal "017", and Binary "0b10" numbers are |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
73 recognized. If the String doesn't start with digits, the result is zero. |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
74 Examples: |
| 2581 | 75 String "456" --> Number 456 ~ |
| 76 String "6bar" --> Number 6 ~ | |
| 77 String "foo" --> Number 0 ~ | |
| 78 String "0xf1" --> Number 241 ~ | |
| 79 String "0100" --> Number 64 ~ | |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
80 String "0b101" --> Number 5 ~ |
| 2581 | 81 String "-8" --> Number -8 ~ |
| 82 String "+8" --> Number 0 ~ | |
| 7 | 83 |
| 84 To force conversion from String to Number, add zero to it: > | |
| 85 :echo "0100" + 0 | |
| 782 | 86 < 64 ~ |
| 87 | |
| 88 To avoid a leading zero to cause octal conversion, or for using a different | |
| 89 base, use |str2nr()|. | |
| 7 | 90 |
| 91 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE. | |
| 92 | |
| 93 Note that in the command > | |
| 94 :if "foo" | |
| 95 "foo" is converted to 0, which means FALSE. To test for a non-empty string, | |
| 3893 | 96 use empty(): > |
| 97 :if !empty("foo") | |
| 153 | 98 < *E745* *E728* *E703* *E729* *E730* *E731* |
| 99 List, Dictionary and Funcref types are not automatically converted. | |
| 85 | 100 |
| 1621 | 101 *E805* *E806* *E808* |
| 102 When mixing Number and Float the Number is converted to Float. Otherwise | |
| 103 there is no automatic conversion of Float. You can use str2float() for String | |
| 104 to Float, printf() for Float to String and float2nr() for Float to Number. | |
| 105 | |
|
7707
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
106 *E891* *E892* *E893* *E894* |
|
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
107 When expecting a Float a Number can also be used, but nothing else. |
|
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
108 |
| 1621 | 109 *E706* *sticky-type-checking* |
| 85 | 110 You will get an error if you try to change the type of a variable. You need |
| 111 to |:unlet| it first to avoid this error. String and Number are considered | |
| 1621 | 112 equivalent though, as well are Float and Number. Consider this sequence of |
| 113 commands: > | |
| 85 | 114 :let l = "string" |
| 87 | 115 :let l = 44 " changes type from String to Number |
| 1621 | 116 :let l = [1, 2, 3] " error! l is still a Number |
| 117 :let l = 4.4 " changes type from Number to Float | |
| 118 :let l = "string" " error! | |
| 85 | 119 |
| 120 | |
| 87 | 121 1.2 Function references ~ |
| 153 | 122 *Funcref* *E695* *E718* |
| 1621 | 123 A Funcref variable is obtained with the |function()| function. It can be used |
| 114 | 124 in an expression in the place of a function name, before the parenthesis |
| 125 around the arguments, to invoke the function it refers to. Example: > | |
| 55 | 126 |
| 127 :let Fn = function("MyFunc") | |
| 128 :echo Fn() | |
| 114 | 129 < *E704* *E705* *E707* |
| 819 | 130 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You |
| 5340 | 131 can use "g:" but the following name must still start with a capital. You |
| 819 | 132 cannot have both a Funcref variable and a function with the same name. |
| 85 | 133 |
| 114 | 134 A special case is defining a function and directly assigning its Funcref to a |
| 135 Dictionary entry. Example: > | |
| 136 :function dict.init() dict | |
| 137 : let self.val = 0 | |
| 138 :endfunction | |
| 139 | |
| 140 The key of the Dictionary can start with a lower case letter. The actual | |
| 141 function name is not used here. Also see |numbered-function|. | |
| 142 | |
| 143 A Funcref can also be used with the |:call| command: > | |
| 144 :call Fn() | |
| 145 :call dict.init() | |
| 85 | 146 |
| 147 The name of the referenced function can be obtained with |string()|. > | |
| 119 | 148 :let func = string(Fn) |
| 85 | 149 |
| 150 You can use |call()| to invoke a Funcref and use a list variable for the | |
| 151 arguments: > | |
| 119 | 152 :let r = call(Fn, mylist) |
| 85 | 153 |
| 154 | |
| 87 | 155 1.3 Lists ~ |
| 5814 | 156 *list* *List* *Lists* *E686* |
| 55 | 157 A List is an ordered sequence of items. An item can be of any type. Items |
| 1621 | 158 can be accessed by their index number. Items can be added and removed at any |
| 55 | 159 position in the sequence. |
| 160 | |
| 85 | 161 |
| 162 List creation ~ | |
| 163 *E696* *E697* | |
| 55 | 164 A List is created with a comma separated list of items in square brackets. |
| 85 | 165 Examples: > |
| 166 :let mylist = [1, two, 3, "four"] | |
| 167 :let emptylist = [] | |
| 55 | 168 |
| 1621 | 169 An item can be any expression. Using a List for an item creates a |
| 842 | 170 List of Lists: > |
| 85 | 171 :let nestlist = [[11, 12], [21, 22], [31, 32]] |
| 55 | 172 |
| 173 An extra comma after the last item is ignored. | |
| 174 | |
| 85 | 175 |
| 176 List index ~ | |
| 177 *list-index* *E684* | |
| 55 | 178 An item in the List can be accessed by putting the index in square brackets |
| 85 | 179 after the List. Indexes are zero-based, thus the first item has index zero. > |
| 180 :let item = mylist[0] " get the first item: 1 | |
| 55 | 181 :let item = mylist[2] " get the third item: 3 |
| 85 | 182 |
| 87 | 183 When the resulting item is a list this can be repeated: > |
| 85 | 184 :let item = nestlist[0][1] " get the first list, second item: 12 |
| 55 | 185 < |
| 85 | 186 A negative index is counted from the end. Index -1 refers to the last item in |
| 187 the List, -2 to the last but one item, etc. > | |
| 55 | 188 :let last = mylist[-1] " get the last item: "four" |
| 189 | |
| 85 | 190 To avoid an error for an invalid index use the |get()| function. When an item |
| 87 | 191 is not available it returns zero or the default value you specify: > |
| 85 | 192 :echo get(mylist, idx) |
| 193 :echo get(mylist, idx, "NONE") | |
| 194 | |
| 195 | |
| 196 List concatenation ~ | |
| 197 | |
| 198 Two lists can be concatenated with the "+" operator: > | |
| 199 :let longlist = mylist + [5, 6] | |
| 119 | 200 :let mylist += [7, 8] |
| 85 | 201 |
| 202 To prepend or append an item turn the item into a list by putting [] around | |
| 203 it. To change a list in-place see |list-modification| below. | |
| 204 | |
| 205 | |
| 206 Sublist ~ | |
| 207 | |
| 55 | 208 A part of the List can be obtained by specifying the first and last index, |
| 209 separated by a colon in square brackets: > | |
| 85 | 210 :let shortlist = mylist[2:-1] " get List [3, "four"] |
| 55 | 211 |
| 212 Omitting the first index is similar to zero. Omitting the last index is | |
| 1156 | 213 similar to -1. > |
| 90 | 214 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"] |
| 215 :let shortlist = mylist[2:2] " List with one item: [3] | |
| 216 :let otherlist = mylist[:] " make a copy of the List | |
| 85 | 217 |
| 842 | 218 If the first index is beyond the last item of the List or the second item is |
| 219 before the first item, the result is an empty list. There is no error | |
| 220 message. | |
| 221 | |
| 222 If the second index is equal to or greater than the length of the list the | |
| 223 length minus one is used: > | |
| 829 | 224 :let mylist = [0, 1, 2, 3] |
| 225 :echo mylist[2:8] " result: [2, 3] | |
| 226 | |
| 270 | 227 NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for |
| 1621 | 228 using a single letter variable before the ":". Insert a space when needed: |
| 270 | 229 mylist[s : e]. |
| 230 | |
| 85 | 231 |
| 232 List identity ~ | |
| 99 | 233 *list-identity* |
| 85 | 234 When variable "aa" is a list and you assign it to another variable "bb", both |
| 235 variables refer to the same list. Thus changing the list "aa" will also | |
| 236 change "bb": > | |
| 237 :let aa = [1, 2, 3] | |
| 238 :let bb = aa | |
| 239 :call add(aa, 4) | |
| 240 :echo bb | |
| 114 | 241 < [1, 2, 3, 4] |
| 85 | 242 |
| 243 Making a copy of a list is done with the |copy()| function. Using [:] also | |
| 244 works, as explained above. This creates a shallow copy of the list: Changing | |
| 87 | 245 a list item in the list will also change the item in the copied list: > |
| 85 | 246 :let aa = [[1, 'a'], 2, 3] |
| 247 :let bb = copy(aa) | |
| 114 | 248 :call add(aa, 4) |
| 85 | 249 :let aa[0][1] = 'aaa' |
| 250 :echo aa | |
| 114 | 251 < [[1, aaa], 2, 3, 4] > |
| 85 | 252 :echo bb |
| 114 | 253 < [[1, aaa], 2, 3] |
| 85 | 254 |
| 87 | 255 To make a completely independent list use |deepcopy()|. This also makes a |
| 114 | 256 copy of the values in the list, recursively. Up to a hundred levels deep. |
| 85 | 257 |
| 258 The operator "is" can be used to check if two variables refer to the same | |
| 114 | 259 List. "isnot" does the opposite. In contrast "==" compares if two lists have |
| 87 | 260 the same value. > |
| 261 :let alist = [1, 2, 3] | |
| 262 :let blist = [1, 2, 3] | |
| 263 :echo alist is blist | |
| 114 | 264 < 0 > |
| 87 | 265 :echo alist == blist |
| 114 | 266 < 1 |
| 85 | 267 |
| 323 | 268 Note about comparing lists: Two lists are considered equal if they have the |
| 269 same length and all items compare equal, as with using "==". There is one | |
| 388 | 270 exception: When comparing a number with a string they are considered |
| 271 different. There is no automatic type conversion, as with using "==" on | |
| 272 variables. Example: > | |
| 273 echo 4 == "4" | |
| 323 | 274 < 1 > |
| 388 | 275 echo [4] == ["4"] |
| 323 | 276 < 0 |
| 277 | |
| 388 | 278 Thus comparing Lists is more strict than comparing numbers and strings. You |
| 1621 | 279 can compare simple values this way too by putting them in a list: > |
| 388 | 280 |
| 281 :let a = 5 | |
| 282 :let b = "5" | |
| 1621 | 283 :echo a == b |
| 388 | 284 < 1 > |
| 1621 | 285 :echo [a] == [b] |
| 388 | 286 < 0 |
| 323 | 287 |
| 85 | 288 |
| 289 List unpack ~ | |
| 290 | |
| 291 To unpack the items in a list to individual variables, put the variables in | |
| 292 square brackets, like list items: > | |
| 293 :let [var1, var2] = mylist | |
| 294 | |
| 295 When the number of variables does not match the number of items in the list | |
| 296 this produces an error. To handle any extra items from the list append ";" | |
| 297 and a variable name: > | |
| 298 :let [var1, var2; rest] = mylist | |
| 299 | |
| 300 This works like: > | |
| 301 :let var1 = mylist[0] | |
| 302 :let var2 = mylist[1] | |
| 95 | 303 :let rest = mylist[2:] |
| 85 | 304 |
| 305 Except that there is no error if there are only two items. "rest" will be an | |
| 306 empty list then. | |
| 307 | |
| 308 | |
| 309 List modification ~ | |
| 310 *list-modification* | |
| 87 | 311 To change a specific item of a list use |:let| this way: > |
| 85 | 312 :let list[4] = "four" |
| 313 :let listlist[0][3] = item | |
| 314 | |
| 87 | 315 To change part of a list you can specify the first and last item to be |
| 114 | 316 modified. The value must at least have the number of items in the range: > |
| 87 | 317 :let list[3:5] = [3, 4, 5] |
| 318 | |
| 85 | 319 Adding and removing items from a list is done with functions. Here are a few |
| 320 examples: > | |
| 321 :call insert(list, 'a') " prepend item 'a' | |
| 322 :call insert(list, 'a', 3) " insert item 'a' before list[3] | |
| 323 :call add(list, "new") " append String item | |
| 114 | 324 :call add(list, [1, 2]) " append a List as one new item |
| 85 | 325 :call extend(list, [1, 2]) " extend the list with two more items |
| 326 :let i = remove(list, 3) " remove item 3 | |
| 108 | 327 :unlet list[3] " idem |
| 85 | 328 :let l = remove(list, 3, -1) " remove items 3 to last item |
| 108 | 329 :unlet list[3 : ] " idem |
| 114 | 330 :call filter(list, 'v:val !~ "x"') " remove items with an 'x' |
| 331 | |
| 332 Changing the order of items in a list: > | |
| 87 | 333 :call sort(list) " sort a list alphabetically |
| 334 :call reverse(list) " reverse the order of items | |
| 5747 | 335 :call uniq(sort(list)) " sort and remove duplicates |
| 87 | 336 |
| 85 | 337 |
| 338 For loop ~ | |
| 339 | |
| 87 | 340 The |:for| loop executes commands for each item in a list. A variable is set |
| 341 to each item in the list in sequence. Example: > | |
| 114 | 342 :for item in mylist |
| 343 : call Doit(item) | |
| 85 | 344 :endfor |
| 345 | |
| 346 This works like: > | |
| 347 :let index = 0 | |
| 348 :while index < len(mylist) | |
| 114 | 349 : let item = mylist[index] |
| 350 : :call Doit(item) | |
| 85 | 351 : let index = index + 1 |
| 352 :endwhile | |
| 353 | |
| 354 Note that all items in the list should be of the same type, otherwise this | |
| 114 | 355 results in error |E706|. To avoid this |:unlet| the variable at the end of |
| 87 | 356 the loop. |
| 85 | 357 |
| 95 | 358 If all you want to do is modify each item in the list then the |map()| |
| 114 | 359 function will be a simpler method than a for loop. |
| 95 | 360 |
| 1621 | 361 Just like the |:let| command, |:for| also accepts a list of variables. This |
| 85 | 362 requires the argument to be a list of lists. > |
| 363 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]] | |
| 364 : call Doit(lnum, col) | |
| 365 :endfor | |
| 366 | |
| 367 This works like a |:let| command is done for each list item. Again, the types | |
| 368 must remain the same to avoid an error. | |
| 369 | |
| 114 | 370 It is also possible to put remaining items in a List variable: > |
| 85 | 371 :for [i, j; rest] in listlist |
| 372 : call Doit(i, j) | |
| 373 : if !empty(rest) | |
| 374 : echo "remainder: " . string(rest) | |
| 375 : endif | |
| 376 :endfor | |
| 377 | |
| 378 | |
| 379 List functions ~ | |
| 114 | 380 *E714* |
| 85 | 381 Functions that are useful with a List: > |
| 87 | 382 :let r = call(funcname, list) " call a function with an argument list |
| 85 | 383 :if empty(list) " check if list is empty |
| 102 | 384 :let l = len(list) " number of items in list |
| 385 :let big = max(list) " maximum value in list | |
| 386 :let small = min(list) " minimum value in list | |
| 87 | 387 :let xs = count(list, 'x') " count nr of times 'x' appears in list |
| 388 :let i = index(list, 'x') " index of first 'x' in list | |
| 85 | 389 :let lines = getline(1, 10) " get ten text lines from buffer |
| 390 :call append('$', lines) " append text lines in buffer | |
| 95 | 391 :let list = split("a b c") " create list from items in a string |
| 392 :let string = join(list, ', ') " create string from list items | |
| 102 | 393 :let s = string(list) " String representation of list |
| 394 :call map(list, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 395 |
| 258 | 396 Don't forget that a combination of features can make things simple. For |
| 397 example, to add up all the numbers in a list: > | |
| 398 :exe 'let sum = ' . join(nrlist, '+') | |
| 399 | |
| 99 | 400 |
| 401 1.4 Dictionaries ~ | |
| 5814 | 402 *dict* *Dictionaries* *Dictionary* |
| 99 | 403 A Dictionary is an associative array: Each entry has a key and a value. The |
| 114 | 404 entry can be located with the key. The entries are stored without a specific |
| 405 ordering. | |
| 99 | 406 |
| 407 | |
| 408 Dictionary creation ~ | |
| 114 | 409 *E720* *E721* *E722* *E723* |
| 99 | 410 A Dictionary is created with a comma separated list of entries in curly |
| 114 | 411 braces. Each entry has a key and a value, separated by a colon. Each key can |
| 412 only appear once. Examples: > | |
| 99 | 413 :let mydict = {1: 'one', 2: 'two', 3: 'three'} |
| 414 :let emptydict = {} | |
| 114 | 415 < *E713* *E716* *E717* |
| 99 | 416 A key is always a String. You can use a Number, it will be converted to a |
| 417 String automatically. Thus the String '4' and the number 4 will find the same | |
| 1621 | 418 entry. Note that the String '04' and the Number 04 are different, since the |
| 114 | 419 Number will be converted to the String '4'. |
| 420 | |
| 1621 | 421 A value can be any expression. Using a Dictionary for a value creates a |
| 99 | 422 nested Dictionary: > |
| 423 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}} | |
| 424 | |
| 425 An extra comma after the last entry is ignored. | |
| 426 | |
| 427 | |
| 428 Accessing entries ~ | |
| 429 | |
| 430 The normal way to access an entry is by putting the key in square brackets: > | |
| 431 :let val = mydict["one"] | |
| 432 :let mydict["four"] = 4 | |
| 433 | |
| 114 | 434 You can add new entries to an existing Dictionary this way, unlike Lists. |
| 99 | 435 |
| 436 For keys that consist entirely of letters, digits and underscore the following | |
| 437 form can be used |expr-entry|: > | |
| 438 :let val = mydict.one | |
| 439 :let mydict.four = 4 | |
| 440 | |
| 441 Since an entry can be any type, also a List and a Dictionary, the indexing and | |
| 442 key lookup can be repeated: > | |
| 114 | 443 :echo dict.key[idx].key |
| 99 | 444 |
| 445 | |
| 446 Dictionary to List conversion ~ | |
| 447 | |
| 1621 | 448 You may want to loop over the entries in a dictionary. For this you need to |
| 99 | 449 turn the Dictionary into a List and pass it to |:for|. |
| 450 | |
| 451 Most often you want to loop over the keys, using the |keys()| function: > | |
| 452 :for key in keys(mydict) | |
| 453 : echo key . ': ' . mydict[key] | |
| 454 :endfor | |
| 455 | |
| 456 The List of keys is unsorted. You may want to sort them first: > | |
| 457 :for key in sort(keys(mydict)) | |
| 458 | |
| 459 To loop over the values use the |values()| function: > | |
| 460 :for v in values(mydict) | |
| 461 : echo "value: " . v | |
| 462 :endfor | |
| 463 | |
| 464 If you want both the key and the value use the |items()| function. It returns | |
| 1621 | 465 a List in which each item is a List with two items, the key and the value: > |
| 1156 | 466 :for [key, value] in items(mydict) |
| 467 : echo key . ': ' . value | |
| 99 | 468 :endfor |
| 469 | |
| 470 | |
| 471 Dictionary identity ~ | |
| 161 | 472 *dict-identity* |
| 99 | 473 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a |
| 474 Dictionary. Otherwise, assignment results in referring to the same | |
| 475 Dictionary: > | |
| 476 :let onedict = {'a': 1, 'b': 2} | |
| 477 :let adict = onedict | |
| 478 :let adict['a'] = 11 | |
| 479 :echo onedict['a'] | |
| 480 11 | |
| 481 | |
| 327 | 482 Two Dictionaries compare equal if all the key-value pairs compare equal. For |
| 483 more info see |list-identity|. | |
| 99 | 484 |
| 485 | |
| 486 Dictionary modification ~ | |
| 487 *dict-modification* | |
| 488 To change an already existing entry of a Dictionary, or to add a new entry, | |
| 489 use |:let| this way: > | |
| 490 :let dict[4] = "four" | |
| 491 :let dict['one'] = item | |
| 492 | |
| 108 | 493 Removing an entry from a Dictionary is done with |remove()| or |:unlet|. |
| 494 Three ways to remove the entry with key "aaa" from dict: > | |
| 495 :let i = remove(dict, 'aaa') | |
| 496 :unlet dict.aaa | |
| 497 :unlet dict['aaa'] | |
| 99 | 498 |
| 499 Merging a Dictionary with another is done with |extend()|: > | |
| 114 | 500 :call extend(adict, bdict) |
| 501 This extends adict with all entries from bdict. Duplicate keys cause entries | |
| 502 in adict to be overwritten. An optional third argument can change this. | |
| 119 | 503 Note that the order of entries in a Dictionary is irrelevant, thus don't |
| 504 expect ":echo adict" to show the items from bdict after the older entries in | |
| 505 adict. | |
| 99 | 506 |
| 507 Weeding out entries from a Dictionary can be done with |filter()|: > | |
| 1156 | 508 :call filter(dict, 'v:val =~ "x"') |
| 114 | 509 This removes all entries from "dict" with a value not matching 'x'. |
| 102 | 510 |
| 511 | |
| 512 Dictionary function ~ | |
| 4159 | 513 *Dictionary-function* *self* *E725* *E862* |
| 102 | 514 When a function is defined with the "dict" attribute it can be used in a |
| 1621 | 515 special way with a dictionary. Example: > |
| 102 | 516 :function Mylen() dict |
| 114 | 517 : return len(self.data) |
| 102 | 518 :endfunction |
| 114 | 519 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")} |
| 520 :echo mydict.len() | |
| 102 | 521 |
| 522 This is like a method in object oriented programming. The entry in the | |
| 523 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary | |
| 524 the function was invoked from. | |
| 525 | |
| 114 | 526 It is also possible to add a function without the "dict" attribute as a |
| 527 Funcref to a Dictionary, but the "self" variable is not available then. | |
| 528 | |
| 819 | 529 *numbered-function* *anonymous-function* |
| 102 | 530 To avoid the extra name for the function it can be defined and directly |
| 531 assigned to a Dictionary in this way: > | |
| 114 | 532 :let mydict = {'data': [0, 1, 2, 3]} |
| 6741 | 533 :function mydict.len() |
| 114 | 534 : return len(self.data) |
| 102 | 535 :endfunction |
| 114 | 536 :echo mydict.len() |
| 537 | |
| 538 The function will then get a number and the value of dict.len is a |Funcref| | |
| 1621 | 539 that references this function. The function can only be used through a |
| 114 | 540 |Funcref|. It will automatically be deleted when there is no |Funcref| |
| 541 remaining that refers to it. | |
| 542 | |
| 543 It is not necessary to use the "dict" attribute for a numbered function. | |
| 102 | 544 |
|
2488
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
545 If you get an error for a numbered function, you can find out what it is with |
|
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
546 a trick. Assuming the function is 42, the command is: > |
|
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
547 :function {42} |
|
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
548 |
| 102 | 549 |
| 550 Functions for Dictionaries ~ | |
| 114 | 551 *E715* |
| 552 Functions that can be used with a Dictionary: > | |
| 102 | 553 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo" |
| 554 :if empty(dict) " TRUE if dict is empty | |
| 555 :let l = len(dict) " number of items in dict | |
| 556 :let big = max(dict) " maximum value in dict | |
| 557 :let small = min(dict) " minimum value in dict | |
| 558 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict | |
| 559 :let s = string(dict) " String representation of dict | |
| 560 :call map(dict, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 561 |
| 562 | |
| 563 1.5 More about variables ~ | |
| 85 | 564 *more-variables* |
| 7 | 565 If you need to know the type of a variable or expression, use the |type()| |
| 566 function. | |
| 567 | |
| 568 When the '!' flag is included in the 'viminfo' option, global variables that | |
| 569 start with an uppercase letter, and don't contain a lowercase letter, are | |
| 570 stored in the viminfo file |viminfo-file|. | |
| 571 | |
| 572 When the 'sessionoptions' option contains "global", global variables that | |
| 573 start with an uppercase letter and contain at least one lowercase letter are | |
| 574 stored in the session file |session-file|. | |
| 575 | |
| 576 variable name can be stored where ~ | |
| 577 my_var_6 not | |
| 578 My_Var_6 session file | |
| 579 MY_VAR_6 viminfo file | |
| 580 | |
| 581 | |
| 582 It's possible to form a variable name with curly braces, see | |
| 583 |curly-braces-names|. | |
| 584 | |
| 585 ============================================================================== | |
| 586 2. Expression syntax *expression-syntax* | |
| 587 | |
| 588 Expression syntax summary, from least to most significant: | |
| 589 | |
| 590 |expr1| expr2 ? expr1 : expr1 if-then-else | |
| 591 | |
| 592 |expr2| expr3 || expr3 .. logical OR | |
| 593 | |
| 594 |expr3| expr4 && expr4 .. logical AND | |
| 595 | |
| 596 |expr4| expr5 == expr5 equal | |
| 597 expr5 != expr5 not equal | |
| 598 expr5 > expr5 greater than | |
| 599 expr5 >= expr5 greater than or equal | |
| 600 expr5 < expr5 smaller than | |
| 601 expr5 <= expr5 smaller than or equal | |
| 602 expr5 =~ expr5 regexp matches | |
| 603 expr5 !~ expr5 regexp doesn't match | |
| 604 | |
| 605 expr5 ==? expr5 equal, ignoring case | |
| 606 expr5 ==# expr5 equal, match case | |
| 607 etc. As above, append ? for ignoring case, # for | |
| 608 matching case | |
| 609 | |
| 685 | 610 expr5 is expr5 same |List| instance |
| 611 expr5 isnot expr5 different |List| instance | |
| 79 | 612 |
| 613 |expr5| expr6 + expr6 .. number addition or list concatenation | |
| 7 | 614 expr6 - expr6 .. number subtraction |
| 615 expr6 . expr6 .. string concatenation | |
| 616 | |
| 617 |expr6| expr7 * expr7 .. number multiplication | |
| 618 expr7 / expr7 .. number division | |
| 619 expr7 % expr7 .. number modulo | |
| 620 | |
| 621 |expr7| ! expr7 logical NOT | |
| 622 - expr7 unary minus | |
| 623 + expr7 unary plus | |
| 102 | 624 |
| 685 | 625 |expr8| expr8[expr1] byte of a String or item of a |List| |
| 626 expr8[expr1 : expr1] substring of a String or sublist of a |List| | |
| 627 expr8.name entry in a |Dictionary| | |
| 628 expr8(expr1, ...) function call with |Funcref| variable | |
| 102 | 629 |
| 630 |expr9| number number constant | |
| 26 | 631 "string" string constant, backslash is special |
| 99 | 632 'string' string constant, ' is doubled |
| 685 | 633 [expr1, ...] |List| |
| 634 {expr1: expr1, ...} |Dictionary| | |
| 7 | 635 &option option value |
| 636 (expr1) nested expression | |
| 637 variable internal variable | |
| 638 va{ria}ble internal variable with curly braces | |
| 639 $VAR environment variable | |
| 640 @r contents of register 'r' | |
| 641 function(expr1, ...) function call | |
| 642 func{ti}on(expr1, ...) function call with curly braces | |
| 643 | |
| 644 | |
| 645 ".." indicates that the operations in this level can be concatenated. | |
| 646 Example: > | |
| 647 &nu || &list && &shell == "csh" | |
| 648 | |
| 649 All expressions within one level are parsed from left to right. | |
| 650 | |
| 651 | |
| 652 expr1 *expr1* *E109* | |
| 653 ----- | |
| 654 | |
| 655 expr2 ? expr1 : expr1 | |
| 656 | |
| 657 The expression before the '?' is evaluated to a number. If it evaluates to | |
| 658 non-zero, the result is the value of the expression between the '?' and ':', | |
| 659 otherwise the result is the value of the expression after the ':'. | |
| 660 Example: > | |
| 661 :echo lnum == 1 ? "top" : lnum | |
| 662 | |
| 663 Since the first expression is an "expr2", it cannot contain another ?:. The | |
| 664 other two expressions can, thus allow for recursive use of ?:. | |
| 665 Example: > | |
| 666 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum | |
| 667 | |
| 668 To keep this readable, using |line-continuation| is suggested: > | |
| 669 :echo lnum == 1 | |
| 670 :\ ? "top" | |
| 671 :\ : lnum == 1000 | |
| 672 :\ ? "last" | |
| 673 :\ : lnum | |
| 674 | |
| 1156 | 675 You should always put a space before the ':', otherwise it can be mistaken for |
| 676 use in a variable such as "a:1". | |
| 677 | |
| 7 | 678 |
| 679 expr2 and expr3 *expr2* *expr3* | |
| 680 --------------- | |
| 681 | |
| 682 *expr-barbar* *expr-&&* | |
| 683 The "||" and "&&" operators take one argument on each side. The arguments | |
| 684 are (converted to) Numbers. The result is: | |
| 685 | |
| 686 input output ~ | |
| 687 n1 n2 n1 || n2 n1 && n2 ~ | |
| 688 zero zero zero zero | |
| 689 zero non-zero non-zero zero | |
| 690 non-zero zero non-zero zero | |
| 691 non-zero non-zero non-zero non-zero | |
| 692 | |
| 693 The operators can be concatenated, for example: > | |
| 694 | |
| 695 &nu || &list && &shell == "csh" | |
| 696 | |
| 697 Note that "&&" takes precedence over "||", so this has the meaning of: > | |
| 698 | |
| 699 &nu || (&list && &shell == "csh") | |
| 700 | |
| 701 Once the result is known, the expression "short-circuits", that is, further | |
| 702 arguments are not evaluated. This is like what happens in C. For example: > | |
| 703 | |
| 704 let a = 1 | |
| 705 echo a || b | |
| 706 | |
| 707 This is valid even if there is no variable called "b" because "a" is non-zero, | |
| 708 so the result must be non-zero. Similarly below: > | |
| 709 | |
| 710 echo exists("b") && b == "yes" | |
| 711 | |
| 712 This is valid whether "b" has been defined or not. The second clause will | |
| 713 only be evaluated if "b" has been defined. | |
| 714 | |
| 715 | |
| 716 expr4 *expr4* | |
| 717 ----- | |
| 718 | |
| 719 expr5 {cmp} expr5 | |
| 720 | |
| 721 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1 | |
| 722 if it evaluates to true. | |
| 723 | |
| 1621 | 724 *expr-==* *expr-!=* *expr->* *expr->=* |
| 7 | 725 *expr-<* *expr-<=* *expr-=~* *expr-!~* |
| 726 *expr-==#* *expr-!=#* *expr->#* *expr->=#* | |
| 727 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#* | |
| 728 *expr-==?* *expr-!=?* *expr->?* *expr->=?* | |
| 729 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?* | |
| 2908 | 730 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#* |
| 731 *expr-is?* *expr-isnot?* | |
| 7 | 732 use 'ignorecase' match case ignore case ~ |
| 733 equal == ==# ==? | |
| 734 not equal != !=# !=? | |
| 735 greater than > ># >? | |
| 736 greater than or equal >= >=# >=? | |
| 737 smaller than < <# <? | |
| 738 smaller than or equal <= <=# <=? | |
| 739 regexp matches =~ =~# =~? | |
| 740 regexp doesn't match !~ !~# !~? | |
| 2908 | 741 same instance is is# is? |
| 742 different instance isnot isnot# isnot? | |
| 7 | 743 |
| 744 Examples: | |
| 745 "abc" ==# "Abc" evaluates to 0 | |
| 746 "abc" ==? "Abc" evaluates to 1 | |
| 747 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise | |
| 748 | |
| 85 | 749 *E691* *E692* |
| 685 | 750 A |List| can only be compared with a |List| and only "equal", "not equal" and |
| 751 "is" can be used. This compares the values of the list, recursively. | |
| 752 Ignoring case means case is ignored when comparing item values. | |
| 79 | 753 |
| 114 | 754 *E735* *E736* |
| 685 | 755 A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not |
| 756 equal" and "is" can be used. This compares the key/values of the |Dictionary| | |
| 114 | 757 recursively. Ignoring case means case is ignored when comparing item values. |
| 758 | |
| 85 | 759 *E693* *E694* |
| 685 | 760 A |Funcref| can only be compared with a |Funcref| and only "equal" and "not |
| 761 equal" can be used. Case is never ignored. | |
| 762 | |
| 2908 | 763 When using "is" or "isnot" with a |List| or a |Dictionary| this checks if the |
| 764 expressions are referring to the same |List| or |Dictionary| instance. A copy | |
| 765 of a |List| is different from the original |List|. When using "is" without | |
| 766 a |List| or a |Dictionary| it is equivalent to using "equal", using "isnot" | |
| 767 equivalent to using "not equal". Except that a different type means the | |
| 768 values are different: "4 == '4'" is true, "4 is '4'" is false and "0 is []" is | |
| 3830 | 769 false and not an error. "is#"/"isnot#" and "is?"/"isnot?" can be used to match |
| 2908 | 770 and ignore case. |
| 79 | 771 |
| 7 | 772 When comparing a String with a Number, the String is converted to a Number, |
| 1621 | 773 and the comparison is done on Numbers. This means that "0 == 'x'" is TRUE, |
| 7 | 774 because 'x' converted to a Number is zero. |
| 775 | |
| 776 When comparing two Strings, this is done with strcmp() or stricmp(). This | |
| 777 results in the mathematical difference (comparing byte values), not | |
| 778 necessarily the alphabetical difference in the local language. | |
| 779 | |
| 1621 | 780 When using the operators with a trailing '#', or the short version and |
| 1156 | 781 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
| 7 | 782 |
| 783 When using the operators with a trailing '?', or the short version and | |
| 1156 | 784 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
| 785 | |
| 786 'smartcase' is not used. | |
| 7 | 787 |
| 788 The "=~" and "!~" operators match the lefthand argument with the righthand | |
| 789 argument, which is used as a pattern. See |pattern| for what a pattern is. | |
| 790 This matching is always done like 'magic' was set and 'cpoptions' is empty, no | |
| 791 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts | |
| 792 portable. To avoid backslashes in the regexp pattern to be doubled, use a | |
| 793 single-quote string, see |literal-string|. | |
| 794 Since a string is considered to be a single line, a multi-line pattern | |
| 795 (containing \n, backslash-n) will not match. However, a literal NL character | |
| 796 can be matched like an ordinary character. Examples: | |
| 797 "foo\nbar" =~ "\n" evaluates to 1 | |
| 798 "foo\nbar" =~ "\\n" evaluates to 0 | |
| 799 | |
| 800 | |
| 801 expr5 and expr6 *expr5* *expr6* | |
| 802 --------------- | |
| 685 | 803 expr6 + expr6 .. Number addition or |List| concatenation *expr-+* |
| 79 | 804 expr6 - expr6 .. Number subtraction *expr--* |
| 805 expr6 . expr6 .. String concatenation *expr-.* | |
| 806 | |
| 692 | 807 For |Lists| only "+" is possible and then both expr6 must be a list. The |
| 685 | 808 result is a new list with the two lists Concatenated. |
| 79 | 809 |
| 3214 | 810 expr7 * expr7 .. Number multiplication *expr-star* |
| 811 expr7 / expr7 .. Number division *expr-/* | |
| 812 expr7 % expr7 .. Number modulo *expr-%* | |
| 7 | 813 |
| 814 For all, except ".", Strings are converted to Numbers. | |
| 3214 | 815 For bitwise operators see |and()|, |or()| and |xor()|. |
| 7 | 816 |
| 817 Note the difference between "+" and ".": | |
| 818 "123" + "456" = 579 | |
| 819 "123" . "456" = "123456" | |
| 820 | |
| 1621 | 821 Since '.' has the same precedence as '+' and '-', you need to read: > |
| 822 1 . 90 + 90.0 | |
| 823 As: > | |
| 824 (1 . 90) + 90.0 | |
| 825 That works, since the String "190" is automatically converted to the Number | |
| 826 190, which can be added to the Float 90.0. However: > | |
| 827 1 . 90 * 90.0 | |
| 828 Should be read as: > | |
| 829 1 . (90 * 90.0) | |
| 830 Since '.' has lower precedence than '*'. This does NOT work, since this | |
| 831 attempts to concatenate a Float and a String. | |
| 832 | |
| 833 When dividing a Number by zero the result depends on the value: | |
| 834 0 / 0 = -0x80000000 (like NaN for Float) | |
| 835 >0 / 0 = 0x7fffffff (like positive infinity) | |
| 836 <0 / 0 = -0x7fffffff (like negative infinity) | |
| 837 (before Vim 7.2 it was always 0x7fffffff) | |
| 838 | |
| 7 | 839 When the righthand side of '%' is zero, the result is 0. |
| 840 | |
| 685 | 841 None of these work for |Funcref|s. |
| 79 | 842 |
| 1621 | 843 . and % do not work for Float. *E804* |
| 844 | |
| 7 | 845 |
| 846 expr7 *expr7* | |
| 847 ----- | |
| 848 ! expr7 logical NOT *expr-!* | |
| 849 - expr7 unary minus *expr-unary--* | |
| 850 + expr7 unary plus *expr-unary-+* | |
| 851 | |
| 852 For '!' non-zero becomes zero, zero becomes one. | |
| 853 For '-' the sign of the number is changed. | |
| 854 For '+' the number is unchanged. | |
| 855 | |
| 856 A String will be converted to a Number first. | |
| 857 | |
| 1621 | 858 These three can be repeated and mixed. Examples: |
| 7 | 859 !-1 == 0 |
| 860 !!8 == 1 | |
| 861 --9 == 9 | |
| 862 | |
| 863 | |
| 864 expr8 *expr8* | |
| 865 ----- | |
| 685 | 866 expr8[expr1] item of String or |List| *expr-[]* *E111* |
| 102 | 867 |
| 868 If expr8 is a Number or String this results in a String that contains the | |
| 869 expr1'th single byte from expr8. expr8 is used as a String, expr1 as a | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
870 Number. This doesn't recognize multi-byte encodings, see |byteidx()| for |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
871 an alternative. |
| 55 | 872 |
|
7384
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7358
diff
changeset
|
873 Index zero gives the first byte. This is like it works in C. Careful: |
|
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7358
diff
changeset
|
874 text column numbers start with one! Example, to get the byte under the |
| 55 | 875 cursor: > |
| 823 | 876 :let c = getline(".")[col(".") - 1] |
| 7 | 877 |
| 878 If the length of the String is less than the index, the result is an empty | |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
879 String. A negative index always results in an empty string (reason: backward |
| 55 | 880 compatibility). Use [-1:] to get the last byte. |
| 881 | |
| 685 | 882 If expr8 is a |List| then it results the item at index expr1. See |list-index| |
| 55 | 883 for possible index values. If the index is out of range this results in an |
| 1621 | 884 error. Example: > |
| 55 | 885 :let item = mylist[-1] " get last item |
| 886 | |
| 685 | 887 Generally, if a |List| index is equal to or higher than the length of the |
| 888 |List|, or more negative than the length of the |List|, this results in an | |
| 889 error. | |
| 55 | 890 |
| 99 | 891 |
| 102 | 892 expr8[expr1a : expr1b] substring or sublist *expr-[:]* |
| 893 | |
| 894 If expr8 is a Number or String this results in the substring with the bytes | |
| 895 from expr1a to and including expr1b. expr8 is used as a String, expr1a and | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
896 expr1b are used as a Number. This doesn't recognize multi-byte encodings, see |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
897 |byteidx()| for computing the indexes. |
| 55 | 898 |
| 899 If expr1a is omitted zero is used. If expr1b is omitted the length of the | |
| 900 string minus one is used. | |
| 901 | |
| 902 A negative number can be used to measure from the end of the string. -1 is | |
| 903 the last character, -2 the last but one, etc. | |
| 904 | |
| 905 If an index goes out of range for the string characters are omitted. If | |
| 906 expr1b is smaller than expr1a the result is an empty string. | |
| 907 | |
| 908 Examples: > | |
| 909 :let c = name[-1:] " last byte of a string | |
| 910 :let c = name[-2:-2] " last but one byte of a string | |
| 911 :let s = line(".")[4:] " from the fifth byte to the end | |
| 912 :let s = s[:-3] " remove last two bytes | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
913 < |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
914 *sublist* *slice* |
| 685 | 915 If expr8 is a |List| this results in a new |List| with the items indicated by |
| 1621 | 916 the indexes expr1a and expr1b. This works like with a String, as explained |
| 685 | 917 just above, except that indexes out of range cause an error. Examples: > |
| 55 | 918 :let l = mylist[:3] " first four items |
| 919 :let l = mylist[4:4] " List with one item | |
| 920 :let l = mylist[:] " shallow copy of a List | |
| 921 | |
| 685 | 922 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an |
| 923 error. | |
| 924 | |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
925 Watch out for confusion between a namespace and a variable followed by a colon |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
926 for a sublist: > |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
927 mylist[n:] " uses variable n |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
928 mylist[s:] " uses namespace s:, error! |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
929 |
| 685 | 930 |
| 931 expr8.name entry in a |Dictionary| *expr-entry* | |
| 932 | |
| 933 If expr8 is a |Dictionary| and it is followed by a dot, then the following | |
| 934 name will be used as a key in the |Dictionary|. This is just like: | |
| 935 expr8[name]. | |
| 99 | 936 |
| 937 The name must consist of alphanumeric characters, just like a variable name, | |
| 938 but it may start with a number. Curly braces cannot be used. | |
| 939 | |
| 940 There must not be white space before or after the dot. | |
| 941 | |
| 942 Examples: > | |
| 943 :let dict = {"one": 1, 2: "two"} | |
| 944 :echo dict.one | |
| 945 :echo dict .2 | |
| 946 | |
| 947 Note that the dot is also used for String concatenation. To avoid confusion | |
| 948 always put spaces around the dot for String concatenation. | |
| 949 | |
| 950 | |
| 685 | 951 expr8(expr1, ...) |Funcref| function call |
| 102 | 952 |
| 953 When expr8 is a |Funcref| type variable, invoke the function it refers to. | |
| 954 | |
| 955 | |
| 956 | |
| 957 *expr9* | |
| 7 | 958 number |
| 959 ------ | |
| 3224 | 960 number number constant *expr-number* |
| 961 *hex-number* *octal-number* | |
| 7 | 962 |
| 963 Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0). | |
| 964 | |
| 1621 | 965 *floating-point-format* |
| 966 Floating point numbers can be written in two forms: | |
| 967 | |
| 968 [-+]{N}.{M} | |
| 6530 | 969 [-+]{N}.{M}[eE][-+]{exp} |
| 1621 | 970 |
| 971 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
| 972 contain digits. | |
| 973 [-+] means there is an optional plus or minus sign. | |
| 974 {exp} is the exponent, power of 10. | |
| 975 Only a decimal point is accepted, not a comma. No matter what the current | |
| 976 locale is. | |
| 977 {only when compiled with the |+float| feature} | |
| 978 | |
| 979 Examples: | |
| 980 123.456 | |
| 981 +0.0001 | |
| 982 55.0 | |
| 983 -0.123 | |
| 984 1.234e03 | |
| 985 1.0E-6 | |
| 986 -3.1416e+88 | |
| 987 | |
| 988 These are INVALID: | |
| 989 3. empty {M} | |
| 990 1e40 missing .{M} | |
| 991 | |
| 1698 | 992 *float-pi* *float-e* |
| 993 A few useful values to copy&paste: > | |
| 994 :let pi = 3.14159265359 | |
| 995 :let e = 2.71828182846 | |
| 996 | |
| 1621 | 997 Rationale: |
| 998 Before floating point was introduced, the text "123.456" was interpreted as | |
| 999 the two numbers "123" and "456", both converted to a string and concatenated, | |
| 1000 resulting in the string "123456". Since this was considered pointless, and we | |
| 1698 | 1001 could not find it intentionally being used in Vim scripts, this backwards |
| 1621 | 1002 incompatibility was accepted in favor of being able to use the normal notation |
| 1003 for floating point numbers. | |
| 1004 | |
| 1005 *floating-point-precision* | |
| 1006 The precision and range of floating points numbers depends on what "double" | |
| 1007 means in the library Vim was compiled with. There is no way to change this at | |
| 1008 runtime. | |
| 1009 | |
| 1010 The default for displaying a |Float| is to use 6 decimal places, like using | |
| 1011 printf("%g", f). You can select something else when using the |printf()| | |
| 1012 function. Example: > | |
| 1013 :echo printf('%.15e', atan(1)) | |
| 1014 < 7.853981633974483e-01 | |
| 1015 | |
| 1016 | |
| 7 | 1017 |
| 6884 | 1018 string *string* *String* *expr-string* *E114* |
| 7 | 1019 ------ |
| 1020 "string" string constant *expr-quote* | |
| 1021 | |
| 1022 Note that double quotes are used. | |
| 1023 | |
| 1024 A string constant accepts these special characters: | |
| 1025 \... three-digit octal number (e.g., "\316") | |
| 1026 \.. two-digit octal number (must be followed by non-digit) | |
| 1027 \. one-digit octal number (must be followed by non-digit) | |
| 1028 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
| 1029 \x. byte specified with one hex number (must be followed by non-hex char) | |
| 1030 \X.. same as \x.. | |
| 1031 \X. same as \x. | |
| 1621 | 1032 \u.... character specified with up to 4 hex numbers, stored according to the |
| 7 | 1033 current value of 'encoding' (e.g., "\u02a4") |
| 6840 | 1034 \U.... same as \u but allows up to 8 hex numbers. |
| 7 | 1035 \b backspace <BS> |
| 1036 \e escape <Esc> | |
| 1037 \f formfeed <FF> | |
| 1038 \n newline <NL> | |
| 1039 \r return <CR> | |
| 1040 \t tab <Tab> | |
| 1041 \\ backslash | |
| 1042 \" double quote | |
| 2152 | 1043 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use |
| 1044 in mappings, the 0x80 byte is escaped. Don't use <Char-xxxx> to get a | |
| 1045 utf-8 character, use \uxxxx as mentioned above. | |
| 7 | 1046 |
| 1156 | 1047 Note that "\xff" is stored as the byte 255, which may be invalid in some |
| 1048 encodings. Use "\u00ff" to store character 255 according to the current value | |
| 1049 of 'encoding'. | |
| 1050 | |
| 7 | 1051 Note that "\000" and "\x00" force the end of the string. |
| 1052 | |
| 1053 | |
| 1054 literal-string *literal-string* *E115* | |
| 1055 --------------- | |
| 26 | 1056 'string' string constant *expr-'* |
| 7 | 1057 |
| 1058 Note that single quotes are used. | |
| 1059 | |
| 1621 | 1060 This string is taken as it is. No backslashes are removed or have a special |
| 99 | 1061 meaning. The only exception is that two quotes stand for one quote. |
| 26 | 1062 |
| 1063 Single quoted strings are useful for patterns, so that backslashes do not need | |
| 1621 | 1064 to be doubled. These two commands are equivalent: > |
| 26 | 1065 if a =~ "\\s*" |
| 1066 if a =~ '\s*' | |
| 7 | 1067 |
| 1068 | |
| 1069 option *expr-option* *E112* *E113* | |
| 1070 ------ | |
| 1071 &option option value, local value if possible | |
| 1072 &g:option global option value | |
| 1073 &l:option local option value | |
| 1074 | |
| 1075 Examples: > | |
| 1076 echo "tabstop is " . &tabstop | |
| 1077 if &insertmode | |
| 1078 | |
| 1079 Any option name can be used here. See |options|. When using the local value | |
| 1080 and there is no buffer-local or window-local value, the global value is used | |
| 1081 anyway. | |
| 1082 | |
| 1083 | |
| 1156 | 1084 register *expr-register* *@r* |
| 7 | 1085 -------- |
| 1086 @r contents of register 'r' | |
| 1087 | |
| 1088 The result is the contents of the named register, as a single string. | |
| 1089 Newlines are inserted where required. To get the contents of the unnamed | |
| 1621 | 1090 register use @" or @@. See |registers| for an explanation of the available |
| 336 | 1091 registers. |
| 1092 | |
| 1093 When using the '=' register you get the expression itself, not what it | |
| 1094 evaluates to. Use |eval()| to evaluate it. | |
| 7 | 1095 |
| 1096 | |
| 1097 nesting *expr-nesting* *E110* | |
| 1098 ------- | |
| 1099 (expr1) nested expression | |
| 1100 | |
| 1101 | |
| 1102 environment variable *expr-env* | |
| 1103 -------------------- | |
| 1104 $VAR environment variable | |
| 1105 | |
| 1106 The String value of any environment variable. When it is not defined, the | |
| 1107 result is an empty string. | |
| 1108 *expr-env-expand* | |
| 1109 Note that there is a difference between using $VAR directly and using | |
| 1110 expand("$VAR"). Using it directly will only expand environment variables that | |
| 1111 are known inside the current Vim session. Using expand() will first try using | |
| 1112 the environment variables known inside the current Vim session. If that | |
| 1113 fails, a shell will be used to expand the variable. This can be slow, but it | |
| 1114 does expand all variables that the shell knows about. Example: > | |
| 6180 | 1115 :echo $shell |
| 1116 :echo expand("$shell") | |
| 1117 The first one probably doesn't echo anything, the second echoes the $shell | |
| 7 | 1118 variable (if your shell supports it). |
| 1119 | |
| 1120 | |
| 1121 internal variable *expr-variable* | |
| 1122 ----------------- | |
| 1123 variable internal variable | |
| 1124 See below |internal-variables|. | |
| 1125 | |
| 1126 | |
| 170 | 1127 function call *expr-function* *E116* *E118* *E119* *E120* |
| 7 | 1128 ------------- |
| 1129 function(expr1, ...) function call | |
| 1130 See below |functions|. | |
| 1131 | |
| 1132 | |
| 1133 ============================================================================== | |
| 2596 | 1134 3. Internal variable *internal-variables* *E461* |
| 1135 | |
| 7 | 1136 An internal variable name can be made up of letters, digits and '_'. But it |
| 1137 cannot start with a digit. It's also possible to use curly braces, see | |
| 1138 |curly-braces-names|. | |
| 1139 | |
| 1140 An internal variable is created with the ":let" command |:let|. | |
| 87 | 1141 An internal variable is explicitly destroyed with the ":unlet" command |
| 1142 |:unlet|. | |
| 1143 Using a name that is not an internal variable or refers to a variable that has | |
| 1144 been destroyed results in an error. | |
| 7 | 1145 |
| 1146 There are several name spaces for variables. Which one is to be used is | |
| 1147 specified by what is prepended: | |
| 1148 | |
| 1149 (nothing) In a function: local to a function; otherwise: global | |
| 1150 |buffer-variable| b: Local to the current buffer. | |
| 1151 |window-variable| w: Local to the current window. | |
| 819 | 1152 |tabpage-variable| t: Local to the current tab page. |
| 7 | 1153 |global-variable| g: Global. |
| 1154 |local-variable| l: Local to a function. | |
| 1155 |script-variable| s: Local to a |:source|'ed Vim script. | |
| 1156 |function-argument| a: Function argument (only inside a function). | |
| 5815 | 1157 |vim-variable| v: Global, predefined by Vim. |
| 7 | 1158 |
| 685 | 1159 The scope name by itself can be used as a |Dictionary|. For example, to |
| 1160 delete all script-local variables: > | |
| 133 | 1161 :for k in keys(s:) |
| 1162 : unlet s:[k] | |
| 1163 :endfor | |
| 1164 < | |
| 4358 | 1165 *buffer-variable* *b:var* *b:* |
| 7 | 1166 A variable name that is preceded with "b:" is local to the current buffer. |
| 1167 Thus you can have several "b:foo" variables, one for each buffer. | |
| 1168 This kind of variable is deleted when the buffer is wiped out or deleted with | |
| 1169 |:bdelete|. | |
| 1170 | |
| 1171 One local buffer variable is predefined: | |
| 4264 | 1172 *b:changedtick* *changetick* |
| 7 | 1173 b:changedtick The total number of changes to the current buffer. It is |
| 1174 incremented for each change. An undo command is also a change | |
| 1175 in this case. This can be used to perform an action only when | |
| 1176 the buffer has changed. Example: > | |
| 1177 :if my_changedtick != b:changedtick | |
| 1621 | 1178 : let my_changedtick = b:changedtick |
| 1179 : call My_Update() | |
| 7 | 1180 :endif |
| 1181 < | |
| 4358 | 1182 *window-variable* *w:var* *w:* |
| 7 | 1183 A variable name that is preceded with "w:" is local to the current window. It |
| 1184 is deleted when the window is closed. | |
| 1185 | |
| 4437 | 1186 *tabpage-variable* *t:var* *t:* |
| 819 | 1187 A variable name that is preceded with "t:" is local to the current tab page, |
| 1188 It is deleted when the tab page is closed. {not available when compiled | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
1189 without the |+windows| feature} |
| 819 | 1190 |
| 4358 | 1191 *global-variable* *g:var* *g:* |
| 7 | 1192 Inside functions global variables are accessed with "g:". Omitting this will |
| 1621 | 1193 access a variable local to a function. But "g:" can also be used in any other |
| 7 | 1194 place if you like. |
| 1195 | |
| 4358 | 1196 *local-variable* *l:var* *l:* |
| 7 | 1197 Inside functions local variables are accessed without prepending anything. |
| 1156 | 1198 But you can also prepend "l:" if you like. However, without prepending "l:" |
| 1199 you may run into reserved variable names. For example "count". By itself it | |
| 1200 refers to "v:count". Using "l:count" you can have a local variable with the | |
| 1201 same name. | |
| 7 | 1202 |
| 1203 *script-variable* *s:var* | |
| 1204 In a Vim script variables starting with "s:" can be used. They cannot be | |
| 1205 accessed from outside of the scripts, thus are local to the script. | |
| 1206 | |
| 1207 They can be used in: | |
| 1208 - commands executed while the script is sourced | |
| 1209 - functions defined in the script | |
| 1210 - autocommands defined in the script | |
| 1211 - functions and autocommands defined in functions and autocommands which were | |
| 1212 defined in the script (recursively) | |
| 1213 - user defined commands defined in the script | |
| 1214 Thus not in: | |
| 1215 - other scripts sourced from this one | |
| 1216 - mappings | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1217 - menus |
| 7 | 1218 - etc. |
| 1219 | |
| 1156 | 1220 Script variables can be used to avoid conflicts with global variable names. |
| 1221 Take this example: > | |
| 7 | 1222 |
| 1223 let s:counter = 0 | |
| 1224 function MyCounter() | |
| 1225 let s:counter = s:counter + 1 | |
| 1226 echo s:counter | |
| 1227 endfunction | |
| 1228 command Tick call MyCounter() | |
| 1229 | |
| 1230 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
| 1231 that script will not be changed, only the "s:counter" in the script where | |
| 1232 "Tick" was defined is used. | |
| 1233 | |
| 1234 Another example that does the same: > | |
| 1235 | |
| 1236 let s:counter = 0 | |
| 1237 command Tick let s:counter = s:counter + 1 | echo s:counter | |
| 1238 | |
| 1239 When calling a function and invoking a user-defined command, the context for | |
| 9 | 1240 script variables is set to the script where the function or command was |
| 7 | 1241 defined. |
| 1242 | |
| 1243 The script variables are also available when a function is defined inside a | |
| 1244 function that is defined in a script. Example: > | |
| 1245 | |
| 1246 let s:counter = 0 | |
| 1247 function StartCounting(incr) | |
| 1248 if a:incr | |
| 1249 function MyCounter() | |
| 1250 let s:counter = s:counter + 1 | |
| 1251 endfunction | |
| 1252 else | |
| 1253 function MyCounter() | |
| 1254 let s:counter = s:counter - 1 | |
| 1255 endfunction | |
| 1256 endif | |
| 1257 endfunction | |
| 1258 | |
| 1259 This defines the MyCounter() function either for counting up or counting down | |
| 1260 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
| 1261 called, the s:counter variable will be accessible in MyCounter(). | |
| 1262 | |
| 1263 When the same script is sourced again it will use the same script variables. | |
| 1264 They will remain valid as long as Vim is running. This can be used to | |
| 1265 maintain a counter: > | |
| 1266 | |
| 1267 if !exists("s:counter") | |
| 1268 let s:counter = 1 | |
| 1269 echo "script executed for the first time" | |
| 1270 else | |
| 1271 let s:counter = s:counter + 1 | |
| 1272 echo "script executed " . s:counter . " times now" | |
| 1273 endif | |
| 1274 | |
| 1275 Note that this means that filetype plugins don't get a different set of script | |
| 1276 variables for each buffer. Use local buffer variables instead |b:var|. | |
| 1277 | |
| 1278 | |
| 4358 | 1279 Predefined Vim variables: *vim-variable* *v:var* *v:* |
| 7 | 1280 |
| 189 | 1281 *v:beval_col* *beval_col-variable* |
| 1282 v:beval_col The number of the column, over which the mouse pointer is. | |
| 1283 This is the byte index in the |v:beval_lnum| line. | |
| 1284 Only valid while evaluating the 'balloonexpr' option. | |
| 1285 | |
| 1286 *v:beval_bufnr* *beval_bufnr-variable* | |
| 1287 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
| 1288 valid while evaluating the 'balloonexpr' option. | |
| 1289 | |
| 1290 *v:beval_lnum* *beval_lnum-variable* | |
| 1291 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
| 1292 valid while evaluating the 'balloonexpr' option. | |
| 1293 | |
| 1294 *v:beval_text* *beval_text-variable* | |
| 374 | 1295 v:beval_text The text under or after the mouse pointer. Usually a word as |
| 1296 it is useful for debugging a C program. 'iskeyword' applies, | |
| 1297 but a dot and "->" before the position is included. When on a | |
| 1298 ']' the text before it is used, including the matching '[' and | |
| 189 | 1299 word before it. When on a Visual area within one line the |
| 1300 highlighted text is used. | |
| 1301 Only valid while evaluating the 'balloonexpr' option. | |
| 1302 | |
| 1303 *v:beval_winnr* *beval_winnr-variable* | |
| 1304 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
| 2709 | 1305 valid while evaluating the 'balloonexpr' option. The first |
| 1306 window has number zero (unlike most other places where a | |
| 1307 window gets a number). | |
| 189 | 1308 |
| 844 | 1309 *v:char* *char-variable* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1310 v:char Argument for evaluating 'formatexpr' and used for the typed |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
1311 character when using <expr> in an abbreviation |:map-<expr>|. |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4437
diff
changeset
|
1312 It is also used by the |InsertCharPre| and |InsertEnter| events. |
| 844 | 1313 |
| 7 | 1314 *v:charconvert_from* *charconvert_from-variable* |
| 1315 v:charconvert_from | |
| 1316 The name of the character encoding of a file to be converted. | |
| 1317 Only valid while evaluating the 'charconvert' option. | |
| 1318 | |
| 1319 *v:charconvert_to* *charconvert_to-variable* | |
| 1320 v:charconvert_to | |
| 1321 The name of the character encoding of a file after conversion. | |
| 1322 Only valid while evaluating the 'charconvert' option. | |
| 1323 | |
| 1324 *v:cmdarg* *cmdarg-variable* | |
| 1325 v:cmdarg This variable is used for two purposes: | |
| 1326 1. The extra arguments given to a file read/write command. | |
| 1327 Currently these are "++enc=" and "++ff=". This variable is | |
| 1328 set before an autocommand event for a file read/write | |
| 1329 command is triggered. There is a leading space to make it | |
| 1330 possible to append this variable directly after the | |
| 1621 | 1331 read/write command. Note: The "+cmd" argument isn't |
| 7 | 1332 included here, because it will be executed anyway. |
| 1333 2. When printing a PostScript file with ":hardcopy" this is | |
| 1334 the argument for the ":hardcopy" command. This can be used | |
| 1335 in 'printexpr'. | |
| 1336 | |
| 1337 *v:cmdbang* *cmdbang-variable* | |
| 1338 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
| 1339 was used the value is 1, otherwise it is 0. Note that this | |
| 1340 can only be used in autocommands. For user commands |<bang>| | |
| 1341 can be used. | |
| 1342 | |
| 6909 | 1343 *v:completed_item* *completed_item-variable* |
| 1344 v:completed_item | |
| 1345 |Dictionary| containing the |complete-items| for the most | |
| 1346 recently completed word after |CompleteDone|. The | |
| 1347 |Dictionary| is empty if the completion failed. | |
| 1348 | |
| 7 | 1349 *v:count* *count-variable* |
| 1350 v:count The count given for the last Normal mode command. Can be used | |
| 1621 | 1351 to get the count before a mapping. Read-only. Example: > |
| 7 | 1352 :map _x :<C-U>echo "the count is " . v:count<CR> |
| 1353 < Note: The <C-U> is required to remove the line range that you | |
| 1354 get when typing ':' after a count. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1355 When there are two counts, as in "3d2w", they are multiplied, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1356 just like what happens in the command, "d6w" for the example. |
| 667 | 1357 Also used for evaluating the 'formatexpr' option. |
| 7 | 1358 "count" also works, for backwards compatibility. |
| 1359 | |
| 1360 *v:count1* *count1-variable* | |
| 1361 v:count1 Just like "v:count", but defaults to one when no count is | |
| 1362 used. | |
| 1363 | |
| 1364 *v:ctype* *ctype-variable* | |
| 1365 v:ctype The current locale setting for characters of the runtime | |
| 1366 environment. This allows Vim scripts to be aware of the | |
| 1367 current locale encoding. Technical: it's the value of | |
| 1368 LC_CTYPE. When not using a locale the value is "C". | |
| 1369 This variable can not be set directly, use the |:language| | |
| 1370 command. | |
| 1371 See |multi-lang|. | |
| 1372 | |
| 1373 *v:dying* *dying-variable* | |
| 1621 | 1374 v:dying Normally zero. When a deadly signal is caught it's set to |
| 7 | 1375 one. When multiple signals are caught the number increases. |
| 1376 Can be used in an autocommand to check if Vim didn't | |
| 1377 terminate normally. {only works on Unix} | |
| 1378 Example: > | |
| 1379 :au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endif | |
|
2226
36a9ac99e1ca
Don't execute some autocommands when v:dying is 2 or more.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
1380 < Note: if another deadly signal is caught when v:dying is one, |
|
36a9ac99e1ca
Don't execute some autocommands when v:dying is 2 or more.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
1381 VimLeave autocommands will not be executed. |
|
36a9ac99e1ca
Don't execute some autocommands when v:dying is 2 or more.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
1382 |
| 7 | 1383 *v:errmsg* *errmsg-variable* |
| 1384 v:errmsg Last given error message. It's allowed to set this variable. | |
| 1385 Example: > | |
| 1386 :let v:errmsg = "" | |
| 1387 :silent! next | |
| 1388 :if v:errmsg != "" | |
| 1389 : ... handle error | |
| 1390 < "errmsg" also works, for backwards compatibility. | |
| 1391 | |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1392 *v:errors* *errors-variable* |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
1393 v:errors Errors found by assert functions, such as |assert_true()|. |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1394 This is a list of strings. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1395 The assert functions append an item when an assert fails. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1396 To remove old results make it empty: > |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1397 :let v:errors = [] |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1398 < If v:errors is set to anything but a list it is made an empty |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1399 list by the assert function. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1400 |
| 7 | 1401 *v:exception* *exception-variable* |
| 1402 v:exception The value of the exception most recently caught and not | |
| 1403 finished. See also |v:throwpoint| and |throw-variables|. | |
| 1404 Example: > | |
| 1405 :try | |
| 1406 : throw "oops" | |
| 1407 :catch /.*/ | |
| 1408 : echo "caught" v:exception | |
| 1409 :endtry | |
| 1410 < Output: "caught oops". | |
| 1411 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1412 *v:false* *false-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1413 v:false A Number with value zero. Used to put "false" in JSON. See |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1414 |jsonencode()|. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1415 When used as a string this evaluates to "false". > |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1416 echo v:false |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1417 < false ~ |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1418 |
| 179 | 1419 *v:fcs_reason* *fcs_reason-variable* |
| 1420 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
| 1421 Can be used in an autocommand to decide what to do and/or what | |
| 1422 to set v:fcs_choice to. Possible values: | |
| 1423 deleted file no longer exists | |
| 1424 conflict file contents, mode or timestamp was | |
| 1425 changed and buffer is modified | |
| 1426 changed file contents has changed | |
| 1427 mode mode of file changed | |
| 1428 time only file timestamp changed | |
| 1429 | |
| 1430 *v:fcs_choice* *fcs_choice-variable* | |
| 1431 v:fcs_choice What should happen after a |FileChangedShell| event was | |
| 1432 triggered. Can be used in an autocommand to tell Vim what to | |
| 1433 do with the affected buffer: | |
| 1434 reload Reload the buffer (does not work if | |
| 1435 the file was deleted). | |
| 1436 ask Ask the user what to do, as if there | |
| 1437 was no autocommand. Except that when | |
| 1438 only the timestamp changed nothing | |
| 1439 will happen. | |
| 1440 <empty> Nothing, the autocommand should do | |
| 1441 everything that needs to be done. | |
| 1442 The default is empty. If another (invalid) value is used then | |
| 1443 Vim behaves like it is empty, there is no warning message. | |
| 1444 | |
| 7 | 1445 *v:fname_in* *fname_in-variable* |
| 579 | 1446 v:fname_in The name of the input file. Valid while evaluating: |
| 7 | 1447 option used for ~ |
| 1448 'charconvert' file to be converted | |
| 1449 'diffexpr' original file | |
| 1450 'patchexpr' original file | |
| 1451 'printexpr' file to be printed | |
| 593 | 1452 And set to the swap file name for |SwapExists|. |
| 7 | 1453 |
| 1454 *v:fname_out* *fname_out-variable* | |
| 1455 v:fname_out The name of the output file. Only valid while | |
| 1456 evaluating: | |
| 1457 option used for ~ | |
| 1458 'charconvert' resulting converted file (*) | |
| 1459 'diffexpr' output of diff | |
| 1460 'patchexpr' resulting patched file | |
| 1461 (*) When doing conversion for a write command (e.g., ":w | |
| 1621 | 1462 file") it will be equal to v:fname_in. When doing conversion |
| 7 | 1463 for a read command (e.g., ":e file") it will be a temporary |
| 1464 file and different from v:fname_in. | |
| 1465 | |
| 1466 *v:fname_new* *fname_new-variable* | |
| 1467 v:fname_new The name of the new version of the file. Only valid while | |
| 1468 evaluating 'diffexpr'. | |
| 1469 | |
| 1470 *v:fname_diff* *fname_diff-variable* | |
| 1471 v:fname_diff The name of the diff (patch) file. Only valid while | |
| 1472 evaluating 'patchexpr'. | |
| 1473 | |
| 1474 *v:folddashes* *folddashes-variable* | |
| 1475 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
| 1476 fold. | |
| 29 | 1477 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1478 |
| 1479 *v:foldlevel* *foldlevel-variable* | |
| 1480 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
| 29 | 1481 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1482 |
| 1483 *v:foldend* *foldend-variable* | |
| 1484 v:foldend Used for 'foldtext': last line of closed fold. | |
| 29 | 1485 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1486 |
| 1487 *v:foldstart* *foldstart-variable* | |
| 1488 v:foldstart Used for 'foldtext': first line of closed fold. | |
| 29 | 1489 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1490 |
| 5460 | 1491 *v:hlsearch* *hlsearch-variable* |
| 6413 | 1492 v:hlsearch Variable that indicates whether search highlighting is on. |
| 1493 Setting it makes sense only if 'hlsearch' is enabled which | |
| 1494 requires |+extra_search|. Setting this variable to zero acts | |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1495 like the |:nohlsearch| command, setting it to one acts like > |
| 5460 | 1496 let &hlsearch = &hlsearch |
| 6918 | 1497 < Note that the value is restored when returning from a |
| 1498 function. |function-search-undo|. | |
| 1499 | |
| 11 | 1500 *v:insertmode* *insertmode-variable* |
| 1501 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
| 1502 events. Values: | |
| 1503 i Insert mode | |
| 1504 r Replace mode | |
| 1505 v Virtual Replace mode | |
| 1506 | |
| 102 | 1507 *v:key* *key-variable* |
| 685 | 1508 v:key Key of the current item of a |Dictionary|. Only valid while |
| 102 | 1509 evaluating the expression used with |map()| and |filter()|. |
| 1510 Read-only. | |
| 1511 | |
| 7 | 1512 *v:lang* *lang-variable* |
| 1513 v:lang The current locale setting for messages of the runtime | |
| 1514 environment. This allows Vim scripts to be aware of the | |
| 1515 current language. Technical: it's the value of LC_MESSAGES. | |
| 1516 The value is system dependent. | |
| 1517 This variable can not be set directly, use the |:language| | |
| 1518 command. | |
| 1519 It can be different from |v:ctype| when messages are desired | |
| 1520 in a different language than what is used for character | |
| 1521 encoding. See |multi-lang|. | |
| 1522 | |
| 1523 *v:lc_time* *lc_time-variable* | |
| 1524 v:lc_time The current locale setting for time messages of the runtime | |
| 1525 environment. This allows Vim scripts to be aware of the | |
| 1526 current language. Technical: it's the value of LC_TIME. | |
| 1527 This variable can not be set directly, use the |:language| | |
| 1528 command. See |multi-lang|. | |
| 1529 | |
| 1530 *v:lnum* *lnum-variable* | |
|
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1531 v:lnum Line number for the 'foldexpr' |fold-expr|, 'formatexpr' and |
|
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1532 'indentexpr' expressions, tab page number for 'guitablabel' |
|
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1533 and 'guitabtooltip'. Only valid while one of these |
|
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1534 expressions is being evaluated. Read-only when in the |
|
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1535 |sandbox|. |
| 7 | 1536 |
| 1029 | 1537 *v:mouse_win* *mouse_win-variable* |
| 1538 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
| 1539 First window has number 1, like with |winnr()|. The value is | |
| 1540 zero when there was no mouse button click. | |
| 1541 | |
| 1542 *v:mouse_lnum* *mouse_lnum-variable* | |
| 1543 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
| 1544 This is the text line number, not the screen line number. The | |
| 1545 value is zero when there was no mouse button click. | |
| 1546 | |
| 1547 *v:mouse_col* *mouse_col-variable* | |
| 1548 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
| 1549 This is the screen column number, like with |virtcol()|. The | |
| 1550 value is zero when there was no mouse button click. | |
| 1551 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1552 *v:none* *none-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1553 v:none An empty String. Used to put an empty item in JSON. See |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1554 |jsonencode()|. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1555 When used as a number this evaluates to zero. |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1556 When used as a string this evaluates to "none". > |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1557 echo v:none |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1558 < none ~ |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1559 |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1560 *v:null* *null-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1561 v:null An empty String. Used to put "null" in JSON. See |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1562 |jsonencode()|. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1563 When used as a number this evaluates to zero. |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1564 When used as a string this evaluates to "null". > |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1565 echo v:null |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1566 < null ~ |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1567 |
| 1733 | 1568 *v:oldfiles* *oldfiles-variable* |
| 1569 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
| 1570 startup. These are the files that Vim remembers marks for. | |
| 1571 The length of the List is limited by the ' argument of the | |
| 1572 'viminfo' option (default is 100). | |
| 5618 | 1573 When the |viminfo| file is not used the List is empty. |
| 1733 | 1574 Also see |:oldfiles| and |c_#<|. |
| 1575 The List can be modified, but this has no effect on what is | |
| 1576 stored in the |viminfo| file later. If you use values other | |
| 1577 than String this will cause trouble. | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
1578 {only when compiled with the |+viminfo| feature} |
| 1733 | 1579 |
| 6935 | 1580 *v:option_new* |
| 1581 v:option_new New value of the option. Valid while executing an |OptionSet| | |
| 1582 autocommand. | |
| 1583 *v:option_old* | |
| 1584 v:option_old Old value of the option. Valid while executing an |OptionSet| | |
| 1585 autocommand. | |
| 1586 *v:option_type* | |
| 1587 v:option_type Scope of the set command. Valid while executing an | |
| 1588 |OptionSet| autocommand. Can be either "global" or "local" | |
| 1490 | 1589 *v:operator* *operator-variable* |
| 1590 v:operator The last operator given in Normal mode. This is a single | |
| 1591 character except for commands starting with <g> or <z>, | |
| 1592 in which case it is two characters. Best used alongside | |
| 1593 |v:prevcount| and |v:register|. Useful if you want to cancel | |
| 1594 Operator-pending mode and then use the operator, e.g.: > | |
| 1595 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
| 1596 < The value remains set until another operator is entered, thus | |
| 1597 don't expect it to be empty. | |
| 1598 v:operator is not set for |:delete|, |:yank| or other Ex | |
| 1599 commands. | |
| 1600 Read-only. | |
| 1601 | |
| 7 | 1602 *v:prevcount* *prevcount-variable* |
| 1603 v:prevcount The count given for the last but one Normal mode command. | |
| 1604 This is the v:count value of the previous command. Useful if | |
| 1490 | 1605 you want to cancel Visual or Operator-pending mode and then |
| 1606 use the count, e.g.: > | |
| 7 | 1607 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
| 1608 < Read-only. | |
| 1609 | |
| 170 | 1610 *v:profiling* *profiling-variable* |
| 1621 | 1611 v:profiling Normally zero. Set to one after using ":profile start". |
| 170 | 1612 See |profiling|. |
| 1613 | |
| 7 | 1614 *v:progname* *progname-variable* |
| 1615 v:progname Contains the name (with path removed) with which Vim was | |
| 3492 | 1616 invoked. Allows you to do special initialisations for |view|, |
| 1617 |evim| etc., or any other name you might symlink to Vim. | |
| 7 | 1618 Read-only. |
| 1619 | |
| 5780 | 1620 *v:progpath* *progpath-variable* |
| 1621 v:progpath Contains the command with which Vim was invoked, including the | |
| 1622 path. Useful if you want to message a Vim server using a | |
| 1623 |--remote-expr|. | |
| 5782 | 1624 To get the full path use: > |
| 1625 echo exepath(v:progpath) | |
| 1626 < NOTE: This does not work when the command is a relative path | |
| 1627 and the current directory has changed. | |
| 5780 | 1628 Read-only. |
| 1629 | |
| 7 | 1630 *v:register* *register-variable* |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1631 v:register The name of the register in effect for the current normal mode |
| 3492 | 1632 command (regardless of whether that command actually used a |
| 1633 register). Or for the currently executing normal mode mapping | |
| 1634 (use this in custom commands that take a register). | |
| 1635 If none is supplied it is the default register '"', unless | |
| 1636 'clipboard' contains "unnamed" or "unnamedplus", then it is | |
| 1637 '*' or '+'. | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1638 Also see |getreg()| and |setreg()| |
| 7 | 1639 |
| 540 | 1640 *v:scrollstart* *scrollstart-variable* |
| 1641 v:scrollstart String describing the script or function that caused the | |
| 1642 screen to scroll up. It's only set when it is empty, thus the | |
| 1643 first reason is remembered. It is set to "Unknown" for a | |
| 1644 typed command. | |
| 1645 This can be used to find out why your script causes the | |
| 1646 hit-enter prompt. | |
| 1647 | |
| 7 | 1648 *v:servername* *servername-variable* |
| 1649 v:servername The resulting registered |x11-clientserver| name if any. | |
| 1650 Read-only. | |
| 1651 | |
| 1621 | 1652 |
| 1653 v:searchforward *v:searchforward* *searchforward-variable* | |
| 1654 Search direction: 1 after a forward search, 0 after a | |
| 1655 backward search. It is reset to forward when directly setting | |
| 1656 the last search pattern, see |quote/|. | |
| 1657 Note that the value is restored when returning from a | |
| 1658 function. |function-search-undo|. | |
| 1659 Read-write. | |
| 1660 | |
| 7 | 1661 *v:shell_error* *shell_error-variable* |
| 1662 v:shell_error Result of the last shell command. When non-zero, the last | |
| 1663 shell command had an error. When zero, there was no problem. | |
| 1664 This only works when the shell returns the error code to Vim. | |
| 1665 The value -1 is often used when the command could not be | |
| 1666 executed. Read-only. | |
| 1667 Example: > | |
| 1668 :!mv foo bar | |
| 1669 :if v:shell_error | |
| 1670 : echo 'could not rename "foo" to "bar"!' | |
| 1671 :endif | |
| 1672 < "shell_error" also works, for backwards compatibility. | |
| 1673 | |
| 1674 *v:statusmsg* *statusmsg-variable* | |
| 1675 v:statusmsg Last given status message. It's allowed to set this variable. | |
| 1676 | |
| 579 | 1677 *v:swapname* *swapname-variable* |
| 1678 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
| 1679 the swap file found. Read-only. | |
| 1680 | |
| 1681 *v:swapchoice* *swapchoice-variable* | |
| 1682 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
| 1683 for handling an existing swap file: | |
| 1684 'o' Open read-only | |
| 1685 'e' Edit anyway | |
| 1686 'r' Recover | |
| 1687 'd' Delete swapfile | |
| 1688 'q' Quit | |
| 1689 'a' Abort | |
| 1621 | 1690 The value should be a single-character string. An empty value |
| 579 | 1691 results in the user being asked, as would happen when there is |
| 1692 no SwapExists autocommand. The default is empty. | |
| 1693 | |
| 590 | 1694 *v:swapcommand* *swapcommand-variable* |
| 625 | 1695 v:swapcommand Normal mode command to be executed after a file has been |
| 590 | 1696 opened. Can be used for a |SwapExists| autocommand to have |
| 1621 | 1697 another Vim open the file and jump to the right place. For |
| 590 | 1698 example, when jumping to a tag the value is ":tag tagname\r". |
| 716 | 1699 For ":edit +cmd file" the value is ":cmd\r". |
| 590 | 1700 |
| 7 | 1701 *v:termresponse* *termresponse-variable* |
| 1702 v:termresponse The escape sequence returned by the terminal for the |t_RV| | |
| 1621 | 1703 termcap entry. It is set when Vim receives an escape sequence |
| 7 | 1704 that starts with ESC [ or CSI and ends in a 'c', with only |
| 1705 digits, ';' and '.' in between. | |
| 1706 When this option is set, the TermResponse autocommand event is | |
| 1707 fired, so that you can react to the response from the | |
| 1708 terminal. | |
| 1709 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp | |
| 1710 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the | |
| 1711 patch level (since this was introduced in patch 95, it's | |
| 1712 always 95 or bigger). Pc is always zero. | |
| 1713 {only when compiled with |+termresponse| feature} | |
| 1714 | |
| 1715 *v:this_session* *this_session-variable* | |
| 1716 v:this_session Full filename of the last loaded or saved session file. See | |
| 1717 |:mksession|. It is allowed to set this variable. When no | |
| 1718 session file has been saved, this variable is empty. | |
| 1719 "this_session" also works, for backwards compatibility. | |
| 1720 | |
| 1721 *v:throwpoint* *throwpoint-variable* | |
| 1722 v:throwpoint The point where the exception most recently caught and not | |
| 1621 | 1723 finished was thrown. Not set when commands are typed. See |
| 7 | 1724 also |v:exception| and |throw-variables|. |
| 1725 Example: > | |
| 1726 :try | |
| 1727 : throw "oops" | |
| 1728 :catch /.*/ | |
| 1729 : echo "Exception from" v:throwpoint | |
| 1730 :endtry | |
| 1731 < Output: "Exception from test.vim, line 2" | |
| 1732 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1733 *v:true* *true-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1734 v:true A Number with value one. Used to put "true" in JSON. See |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1735 |jsonencode()|. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1736 When used as a string this evaluates to "true". > |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1737 echo v:true |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1738 < true ~ |
| 102 | 1739 *v:val* *val-variable* |
| 1621 | 1740 v:val Value of the current item of a |List| or |Dictionary|. Only |
| 685 | 1741 valid while evaluating the expression used with |map()| and |
| 102 | 1742 |filter()|. Read-only. |
| 1743 | |
| 7 | 1744 *v:version* *version-variable* |
| 1745 v:version Version number of Vim: Major version number times 100 plus | |
| 1746 minor version number. Version 5.0 is 500. Version 5.1 (5.01) | |
| 1747 is 501. Read-only. "version" also works, for backwards | |
| 1748 compatibility. | |
| 1749 Use |has()| to check if a certain patch was included, e.g.: > | |
| 5786 | 1750 if has("patch-7.4.123") |
| 7 | 1751 < Note that patch numbers are specific to the version, thus both |
| 1752 version 5.0 and 5.1 may have a patch 123, but these are | |
| 1753 completely different. | |
| 1754 | |
| 1755 *v:warningmsg* *warningmsg-variable* | |
| 1756 v:warningmsg Last given warning message. It's allowed to set this variable. | |
| 1757 | |
| 2609 | 1758 *v:windowid* *windowid-variable* |
| 1759 v:windowid When any X11 based GUI is running or when running in a | |
| 1760 terminal and Vim connects to the X server (|-X|) this will be | |
| 2616 | 1761 set to the window ID. |
| 1762 When an MS-Windows GUI is running this will be set to the | |
| 1763 window handle. | |
| 1764 Otherwise the value is zero. | |
| 1765 Note: for windows inside Vim use |winnr()|. | |
| 2609 | 1766 |
| 7 | 1767 ============================================================================== |
| 1768 4. Builtin Functions *functions* | |
| 1769 | |
| 1770 See |function-list| for a list grouped by what the function is used for. | |
| 1771 | |
| 236 | 1772 (Use CTRL-] on the function name to jump to the full explanation.) |
| 7 | 1773 |
| 1774 USAGE RESULT DESCRIPTION ~ | |
| 1775 | |
| 1621 | 1776 abs( {expr}) Float or Number absolute value of {expr} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1777 acos( {expr}) Float arc cosine of {expr} |
| 685 | 1778 add( {list}, {item}) List append {item} to |List| {list} |
|
7557
502ca0a62fd8
commit https://github.com/vim/vim/commit/acb4f221c715a333f4c49a2235a8006c6ac6e4d5
Christian Brabandt <cb@256bit.org>
parents:
7513
diff
changeset
|
1779 alloc_fail( {id}, {countdown}, {repeat}) |
|
502ca0a62fd8
commit https://github.com/vim/vim/commit/acb4f221c715a333f4c49a2235a8006c6ac6e4d5
Christian Brabandt <cb@256bit.org>
parents:
7513
diff
changeset
|
1780 none make memory allocation fail |
| 3214 | 1781 and( {expr}, {expr}) Number bitwise AND |
| 55 | 1782 append( {lnum}, {string}) Number append {string} below line {lnum} |
| 161 | 1783 append( {lnum}, {list}) Number append lines {list} below line {lnum} |
| 7 | 1784 argc() Number number of files in the argument list |
| 55 | 1785 argidx() Number current index in the argument list |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
1786 arglistid( [{winnr} [, {tabnr}]]) |
| 5942 | 1787 Number argument list id |
| 7 | 1788 argv( {nr}) String {nr} entry of the argument list |
| 818 | 1789 argv( ) List the argument list |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
1790 assert_equal( {exp}, {act} [, {msg}]) none assert {exp} equals {act} |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
1791 assert_exception({error} [, {msg}]) none assert {error} is in v:exception |
|
7593
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
1792 assert_fails( {cmd} [, {error}]) none assert {cmd} fails |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
1793 assert_false( {actual} [, {msg}]) none assert {actual} is false |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
1794 assert_true( {actual} [, {msg}]) none assert {actual} is true |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1795 asin( {expr}) Float arc sine of {expr} |
| 1621 | 1796 atan( {expr}) Float arc tangent of {expr} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1797 atan2( {expr}, {expr}) Float arc tangent of {expr1} / {expr2} |
| 7 | 1798 browse( {save}, {title}, {initdir}, {default}) |
| 1799 String put up a file requester | |
| 1621 | 1800 browsedir( {title}, {initdir}) String put up a directory requester |
| 7 | 1801 bufexists( {expr}) Number TRUE if buffer {expr} exists |
| 55 | 1802 buflisted( {expr}) Number TRUE if buffer {expr} is listed |
| 1803 bufloaded( {expr}) Number TRUE if buffer {expr} is loaded | |
| 7 | 1804 bufname( {expr}) String Name of the buffer {expr} |
|
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
1805 bufnr( {expr} [, {create}]) Number Number of the buffer {expr} |
| 7 | 1806 bufwinnr( {expr}) Number window number of buffer {expr} |
| 1807 byte2line( {byte}) Number line number at byte count {byte} | |
| 55 | 1808 byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr} |
| 5413 | 1809 byteidxcomp( {expr}, {nr}) Number byte index of {nr}'th char in {expr} |
| 102 | 1810 call( {func}, {arglist} [, {dict}]) |
| 1811 any call {func} with arguments {arglist} | |
| 1621 | 1812 ceil( {expr}) Float round {expr} up |
| 1813 changenr() Number current change number | |
| 4051 | 1814 char2nr( {expr}[, {utf8}]) Number ASCII/UTF8 value of first char in {expr} |
| 55 | 1815 cindent( {lnum}) Number C indent for line {lnum} |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1816 clearmatches() none clear all matches |
| 7 | 1817 col( {expr}) Number column nr of cursor or mark |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1818 complete( {startcol}, {matches}) none set Insert mode completion |
| 464 | 1819 complete_add( {expr}) Number add completion match |
| 1621 | 1820 complete_check() Number check for key typed during completion |
| 7 | 1821 confirm( {msg} [, {choices} [, {default} [, {type}]]]) |
| 1822 Number number of choice picked by user | |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
1823 connect( {address}, {mode} [, {callback}]) |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
1824 Number open a channel |
| 55 | 1825 copy( {expr}) any make a shallow copy of {expr} |
| 1621 | 1826 cos( {expr}) Float cosine of {expr} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1827 cosh( {expr}) Float hyperbolic cosine of {expr} |
| 6259 | 1828 count( {list}, {expr} [, {ic} [, {start}]]) |
| 95 | 1829 Number count how many {expr} are in {list} |
| 7 | 1830 cscope_connection( [{num} , {dbpath} [, {prepend}]]) |
| 1831 Number checks existence of cscope connection | |
| 6385 | 1832 cursor( {lnum}, {col} [, {off}]) |
| 1833 Number move cursor to {lnum}, {col}, {off} | |
| 703 | 1834 cursor( {list}) Number move cursor to position in {list} |
|
5663
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5618
diff
changeset
|
1835 deepcopy( {expr} [, {noref}]) any make a full copy of {expr} |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1836 delete( {fname} [, {flags}]) Number delete the file or directory {fname} |
| 7 | 1837 did_filetype() Number TRUE if FileType autocommand event used |
| 55 | 1838 diff_filler( {lnum}) Number diff filler lines about {lnum} |
| 1839 diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col} | |
| 85 | 1840 empty( {expr}) Number TRUE if {expr} is empty |
| 7 | 1841 escape( {string}, {chars}) String escape {chars} in {string} with '\' |
| 205 | 1842 eval( {string}) any evaluate {string} into its value |
| 55 | 1843 eventhandler( ) Number TRUE if inside an event handler |
| 7 | 1844 executable( {expr}) Number 1 if executable {expr} exists |
| 5782 | 1845 exepath( {expr}) String full path of the command {expr} |
| 7 | 1846 exists( {expr}) Number TRUE if {expr} exists |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1847 extend( {expr1}, {expr2} [, {expr3}]) |
| 824 | 1848 List/Dict insert items of {expr2} into {expr1} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1849 exp( {expr}) Float exponential of {expr} |
| 3398 | 1850 expand( {expr} [, {nosuf} [, {list}]]) |
| 1851 any expand special keywords in {expr} | |
| 1621 | 1852 feedkeys( {string} [, {mode}]) Number add key sequence to typeahead buffer |
| 7 | 1853 filereadable( {file}) Number TRUE if {file} is a readable file |
| 824 | 1854 filewritable( {file}) Number TRUE if {file} is a writable file |
| 102 | 1855 filter( {expr}, {string}) List/Dict remove items from {expr} where |
| 1856 {string} is 0 | |
| 95 | 1857 finddir( {name}[, {path}[, {count}]]) |
| 824 | 1858 String find directory {name} in {path} |
| 19 | 1859 findfile( {name}[, {path}[, {count}]]) |
| 824 | 1860 String find file {name} in {path} |
| 1621 | 1861 float2nr( {expr}) Number convert Float {expr} to a Number |
| 1862 floor( {expr}) Float round {expr} down | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1863 fmod( {expr1}, {expr2}) Float remainder of {expr1} / {expr2} |
| 1586 | 1864 fnameescape( {fname}) String escape special characters in {fname} |
| 7 | 1865 fnamemodify( {fname}, {mods}) String modify file name |
| 55 | 1866 foldclosed( {lnum}) Number first line of fold at {lnum} if closed |
| 1867 foldclosedend( {lnum}) Number last line of fold at {lnum} if closed | |
| 7 | 1868 foldlevel( {lnum}) Number fold level at {lnum} |
| 55 | 1869 foldtext( ) String line displayed for closed fold |
| 824 | 1870 foldtextresult( {lnum}) String text for closed fold at {lnum} |
| 7 | 1871 foreground( ) Number bring the Vim window to the foreground |
| 55 | 1872 function( {name}) Funcref reference to function {name} |
| 3224 | 1873 garbagecollect( [{atexit}]) none free memory, breaking cyclic references |
| 82 | 1874 get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def} |
| 102 | 1875 get( {dict}, {key} [, {def}]) any get item {key} from {dict} or {def} |
| 435 | 1876 getbufline( {expr}, {lnum} [, {end}]) |
| 1877 List lines {lnum} to {end} of buffer {expr} | |
| 4157 | 1878 getbufvar( {expr}, {varname} [, {def}]) |
| 1879 any variable {varname} in buffer {expr} | |
| 55 | 1880 getchar( [expr]) Number get one character from the user |
| 1881 getcharmod( ) Number modifiers for the last typed character | |
| 7013 | 1882 getcharsearch() Dict last character search |
| 7 | 1883 getcmdline() String return the current command-line |
| 1884 getcmdpos() Number return cursor position in command-line | |
| 6153 | 1885 getcmdtype() String return current command-line type |
| 1886 getcmdwintype() String return current command-line window type | |
| 5944 | 1887 getcurpos() List position of the cursor |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
1888 getcwd( [{winnr} [, {tabnr}]]) String get the current working directory |
| 5944 | 1889 getfontname( [{name}]) String name of font being used |
| 20 | 1890 getfperm( {fname}) String file permissions of file {fname} |
| 1891 getfsize( {fname}) Number size in bytes of file {fname} | |
| 7 | 1892 getftime( {fname}) Number last modification time of file |
| 20 | 1893 getftype( {fname}) String description of type of file {fname} |
| 161 | 1894 getline( {lnum}) String line {lnum} of current buffer |
| 1895 getline( {lnum}, {end}) List lines {lnum} to {end} of current buffer | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1896 getloclist( {nr}) List list of location list items |
| 1326 | 1897 getmatches() List list of current matches |
| 1548 | 1898 getpid() Number process ID of Vim |
| 703 | 1899 getpos( {expr}) List position of cursor, mark, etc. |
| 230 | 1900 getqflist() List list of quickfix items |
| 5796 | 1901 getreg( [{regname} [, 1 [, {list}]]]) |
| 1902 String or List contents of register | |
| 55 | 1903 getregtype( [{regname}]) String type of register |
| 4157 | 1904 gettabvar( {nr}, {varname} [, {def}]) |
| 1905 any variable {varname} in tab {nr} or {def} | |
| 1906 gettabwinvar( {tabnr}, {winnr}, {name} [, {def}]) | |
| 831 | 1907 any {name} in {winnr} in tab page {tabnr} |
| 7 | 1908 getwinposx() Number X coord in pixels of GUI Vim window |
| 1909 getwinposy() Number Y coord in pixels of GUI Vim window | |
| 4157 | 1910 getwinvar( {nr}, {varname} [, {def}]) |
| 1911 any variable {varname} in window {nr} | |
| 6663 | 1912 glob( {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 3398 | 1913 any expand file wildcards in {expr} |
| 6697 | 1914 glob2regpat( {expr}) String convert a glob pat into a search pat |
| 6663 | 1915 globpath( {path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 1754 | 1916 String do glob({expr}) for all dirs in {path} |
| 7 | 1917 has( {feature}) Number TRUE if feature {feature} supported |
| 102 | 1918 has_key( {dict}, {key}) Number TRUE if {dict} has entry {key} |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
1919 haslocaldir( [{winnr} [, {tabnr}]]) |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
1920 Number TRUE if the window executed |:lcd| |
| 782 | 1921 hasmapto( {what} [, {mode} [, {abbr}]]) |
| 1922 Number TRUE if mapping to {what} exists | |
| 7 | 1923 histadd( {history},{item}) String add an item to a history |
| 1924 histdel( {history} [, {item}]) String remove an item from a history | |
| 1925 histget( {history} [, {index}]) String get the item {index} from a history | |
| 1926 histnr( {history}) Number highest index of a history | |
| 1927 hlexists( {name}) Number TRUE if highlight group {name} exists | |
| 1928 hlID( {name}) Number syntax ID of highlight group {name} | |
| 1929 hostname() String name of the machine Vim is running on | |
| 55 | 1930 iconv( {expr}, {from}, {to}) String convert encoding of {expr} |
| 1931 indent( {lnum}) Number indent of line {lnum} | |
| 95 | 1932 index( {list}, {expr} [, {start} [, {ic}]]) |
| 1933 Number index in {list} where {expr} appears | |
| 531 | 1934 input( {prompt} [, {text} [, {completion}]]) |
| 1935 String get input from the user | |
| 7 | 1936 inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog |
| 824 | 1937 inputlist( {textlist}) Number let the user pick from a choice list |
| 55 | 1938 inputrestore() Number restore typeahead |
| 1939 inputsave() Number save and clear typeahead | |
| 7 | 1940 inputsecret( {prompt} [, {text}]) String like input() but hiding the text |
| 55 | 1941 insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}] |
| 3214 | 1942 invert( {expr}) Number bitwise invert |
| 7 | 1943 isdirectory( {directory}) Number TRUE if {directory} is a directory |
| 148 | 1944 islocked( {expr}) Number TRUE if {expr} is locked |
| 685 | 1945 items( {dict}) List key-value pairs in {dict} |
| 95 | 1946 join( {list} [, {sep}]) String join {list} items into one String |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1947 jsondecode( {string}) any decode JSON |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1948 jsonencode( {expr}) String encode JSON |
| 685 | 1949 keys( {dict}) List keys in {dict} |
| 55 | 1950 len( {expr}) Number the length of {expr} |
| 1951 libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg} | |
| 7 | 1952 libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number |
| 1953 line( {expr}) Number line nr of cursor, last line or mark | |
| 1954 line2byte( {lnum}) Number byte count of line {lnum} | |
| 55 | 1955 lispindent( {lnum}) Number Lisp indent for line {lnum} |
| 7 | 1956 localtime() Number current time |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1957 log( {expr}) Float natural logarithm (base e) of {expr} |
| 1621 | 1958 log10( {expr}) Float logarithm of Float {expr} to base 10 |
| 3492 | 1959 luaeval( {expr}[, {expr}]) any evaluate |Lua| expression |
| 102 | 1960 map( {expr}, {string}) List/Dict change each item in {expr} to {expr} |
| 2610 | 1961 maparg( {name}[, {mode} [, {abbr} [, {dict}]]]) |
| 3224 | 1962 String or Dict |
| 1963 rhs of mapping {name} in mode {mode} | |
| 782 | 1964 mapcheck( {name}[, {mode} [, {abbr}]]) |
| 1965 String check for mappings matching {name} | |
| 19 | 1966 match( {expr}, {pat}[, {start}[, {count}]]) |
| 7 | 1967 Number position where {pat} matches in {expr} |
| 1326 | 1968 matchadd( {group}, {pattern}[, {priority}[, {id}]]) |
| 1969 Number highlight {pattern} with {group} | |
| 5979 | 1970 matchaddpos( {group}, {list}[, {priority}[, {id}]]) |
| 1971 Number highlight positions with {group} | |
| 819 | 1972 matcharg( {nr}) List arguments of |:match| |
| 1326 | 1973 matchdelete( {id}) Number delete match identified by {id} |
| 19 | 1974 matchend( {expr}, {pat}[, {start}[, {count}]]) |
| 7 | 1975 Number position where {pat} ends in {expr} |
| 158 | 1976 matchlist( {expr}, {pat}[, {start}[, {count}]]) |
| 1977 List match and submatches of {pat} in {expr} | |
| 19 | 1978 matchstr( {expr}, {pat}[, {start}[, {count}]]) |
| 1979 String {count}'th match of {pat} in {expr} | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1980 max( {list}) Number maximum value of items in {list} |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1981 min( {list}) Number minimum value of items in {list} |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1982 mkdir( {name} [, {path} [, {prot}]]) |
| 168 | 1983 Number create directory {name} |
| 1621 | 1984 mode( [expr]) String current editing mode |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
1985 mzeval( {expr}) any evaluate |MzScheme| expression |
| 7 | 1986 nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum} |
| 4051 | 1987 nr2char( {expr}[, {utf8}]) String single char with ASCII/UTF8 value {expr} |
| 3214 | 1988 or( {expr}, {expr}) Number bitwise OR |
| 819 | 1989 pathshorten( {expr}) String shorten directory names in a path |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
1990 perleval( {expr}) any evaluate |Perl| expression |
| 1621 | 1991 pow( {x}, {y}) Float {x} to the power of {y} |
| 7 | 1992 prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum} |
| 1621 | 1993 printf( {fmt}, {expr1}...) String format text |
| 1994 pumvisible() Number whether popup menu is visible | |
| 3682 | 1995 pyeval( {expr}) any evaluate |Python| expression |
| 1996 py3eval( {expr}) any evaluate |python3| expression | |
| 99 | 1997 range( {expr} [, {max} [, {stride}]]) |
| 1998 List items from {expr} to {max} | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1999 readfile( {fname} [, {binary} [, {max}]]) |
| 168 | 2000 List get list of lines from file {fname} |
| 794 | 2001 reltime( [{start} [, {end}]]) List get time value |
| 2002 reltimestr( {time}) String turn time value into a String | |
| 7 | 2003 remote_expr( {server}, {string} [, {idvar}]) |
| 2004 String send expression | |
| 2005 remote_foreground( {server}) Number bring Vim server to the foreground | |
| 2006 remote_peek( {serverid} [, {retvar}]) | |
| 2007 Number check for reply string | |
| 2008 remote_read( {serverid}) String read reply string | |
| 2009 remote_send( {server}, {string} [, {idvar}]) | |
| 2010 String send key sequence | |
| 79 | 2011 remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list} |
| 856 | 2012 remove( {dict}, {key}) any remove entry {key} from {dict} |
| 55 | 2013 rename( {from}, {to}) Number rename (move) file from {from} to {to} |
| 2014 repeat( {expr}, {count}) String repeat {expr} {count} times | |
| 2015 resolve( {filename}) String get filename a shortcut points to | |
| 82 | 2016 reverse( {list}) List reverse {list} in-place |
| 1621 | 2017 round( {expr}) Float round off {expr} |
|
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
2018 screenattr( {row}, {col}) Number attribute at screen position |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
2019 screenchar( {row}, {col}) Number character at screen position |
| 3986 | 2020 screencol() Number current cursor column |
| 2021 screenrow() Number current cursor row | |
| 1496 | 2022 search( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
| 2023 Number search for {pattern} | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2024 searchdecl( {name} [, {global} [, {thisblock}]]) |
| 1621 | 2025 Number search for variable declaration |
| 1496 | 2026 searchpair( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 55 | 2027 Number search for other end of start/end pair |
| 1496 | 2028 searchpairpos( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 667 | 2029 List search for other end of start/end pair |
| 1496 | 2030 searchpos( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
| 667 | 2031 List search for {pattern} |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2032 sendexpr( {handle}, {expr} [, {callback}]) |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2033 any send {expr} over JSON channel {handle} |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2034 sendraw( {handle}, {string} [, {callback}]) |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2035 any send {string} over raw channel {handle} |
| 7 | 2036 server2client( {clientid}, {string}) |
| 2037 Number send reply string | |
| 2038 serverlist() String get a list of available servers | |
| 2039 setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val} | |
| 6991 | 2040 setcharsearch( {dict}) Dict set character search from {dict} |
| 7 | 2041 setcmdpos( {pos}) Number set cursor position in command-line |
| 2042 setline( {lnum}, {line}) Number set line {lnum} to {line} | |
| 647 | 2043 setloclist( {nr}, {list}[, {action}]) |
| 2044 Number modify location list using {list} | |
| 1326 | 2045 setmatches( {list}) Number restore a list of matches |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2046 setpos( {expr}, {list}) Number set the {expr} position to {list} |
| 647 | 2047 setqflist( {list}[, {action}]) Number modify quickfix list using {list} |
| 55 | 2048 setreg( {n}, {v}[, {opt}]) Number set register to value and type |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
2049 settabvar( {nr}, {varname}, {val}) set {varname} in tab page {nr} to {val} |
| 831 | 2050 settabwinvar( {tabnr}, {winnr}, {varname}, {val}) set {varname} in window |
| 2051 {winnr} in tab page {tabnr} to {val} | |
| 7 | 2052 setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val} |
| 4126 | 2053 sha256( {string}) String SHA256 checksum of {string} |
| 1661 | 2054 shellescape( {string} [, {special}]) |
| 2055 String escape {string} for use as shell | |
| 985 | 2056 command argument |
| 3875 | 2057 shiftwidth() Number effective value of 'shiftwidth' |
| 55 | 2058 simplify( {filename}) String simplify filename as much as possible |
| 1621 | 2059 sin( {expr}) Float sine of {expr} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2060 sinh( {expr}) Float hyperbolic sine of {expr} |
| 2902 | 2061 sort( {list} [, {func} [, {dict}]]) |
| 2062 List sort {list}, using {func} to compare | |
| 374 | 2063 soundfold( {word}) String sound-fold {word} |
| 344 | 2064 spellbadword() String badly spelled word at cursor |
| 537 | 2065 spellsuggest( {word} [, {max} [, {capital}]]) |
| 2066 List spelling suggestions | |
| 282 | 2067 split( {expr} [, {pat} [, {keepempty}]]) |
| 685 | 2068 List make |List| from {pat} separated {expr} |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2069 sqrt( {expr}) Float square root of {expr} |
| 1621 | 2070 str2float( {expr}) Float convert String to Float |
| 2071 str2nr( {expr} [, {base}]) Number convert String to Number | |
| 6870 | 2072 strchars( {expr} [, {skipcc}]) Number character length of the String {expr} |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
2073 strdisplaywidth( {expr} [, {col}]) Number display length of the String {expr} |
| 7 | 2074 strftime( {format}[, {time}]) String time in specified format |
| 133 | 2075 stridx( {haystack}, {needle}[, {start}]) |
| 2076 Number index of {needle} in {haystack} | |
| 95 | 2077 string( {expr}) String String representation of {expr} value |
| 7 | 2078 strlen( {expr}) Number length of the String {expr} |
| 2079 strpart( {src}, {start}[, {len}]) | |
| 2080 String {len} characters of {src} at {start} | |
| 140 | 2081 strridx( {haystack}, {needle} [, {start}]) |
| 2082 Number last index of {needle} in {haystack} | |
| 7 | 2083 strtrans( {expr}) String translate string to make it printable |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
2084 strwidth( {expr}) Number display cell length of the String {expr} |
| 5794 | 2085 submatch( {nr}[, {list}]) String or List |
| 2086 specific match in ":s" or substitute() | |
| 7 | 2087 substitute( {expr}, {pat}, {sub}, {flags}) |
| 2088 String all {pat} in {expr} replaced with {sub} | |
| 32 | 2089 synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col} |
| 7 | 2090 synIDattr( {synID}, {what} [, {mode}]) |
| 2091 String attribute {what} of syntax ID {synID} | |
| 2092 synIDtrans( {synID}) Number translated syntax ID of {synID} | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
2093 synconcealed( {lnum}, {col}) List info about concealing |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2094 synstack( {lnum}, {col}) List stack of syntax IDs at {lnum} and {col} |
| 24 | 2095 system( {expr} [, {input}]) String output of shell command/filter {expr} |
| 5808 | 2096 systemlist( {expr} [, {input}]) List output of shell command/filter {expr} |
| 677 | 2097 tabpagebuflist( [{arg}]) List list of buffer numbers in tab page |
| 2098 tabpagenr( [{arg}]) Number number of current or last tab page | |
| 2099 tabpagewinnr( {tabarg}[, {arg}]) | |
| 2100 Number number of current window in tab page | |
| 2101 taglist( {expr}) List list of tags matching {expr} | |
| 1621 | 2102 tagfiles() List tags files used |
| 7 | 2103 tempname() String name for a temporary file |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2104 tan( {expr}) Float tangent of {expr} |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2105 tanh( {expr}) Float hyperbolic tangent of {expr} |
| 7 | 2106 tolower( {expr}) String the String {expr} switched to lowercase |
| 2107 toupper( {expr}) String the String {expr} switched to uppercase | |
| 15 | 2108 tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
| 2109 to chars in {tostr} | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2110 trunc( {expr}) Float truncate Float {expr} |
| 7 | 2111 type( {name}) Number type of variable {name} |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
2112 undofile( {name}) String undo file name for {name} |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2113 undotree() List undo file tree |
| 5747 | 2114 uniq( {list} [, {func} [, {dict}]]) |
| 2115 List remove adjacent duplicates from a list | |
| 685 | 2116 values( {dict}) List values in {dict} |
| 7 | 2117 virtcol( {expr}) Number screen column of cursor or mark |
| 2118 visualmode( [expr]) String last visual mode used | |
| 4151 | 2119 wildmenumode() Number whether 'wildmenu' mode is active |
| 7 | 2120 winbufnr( {nr}) Number buffer number of window {nr} |
| 2121 wincol() Number window column of the cursor | |
| 2122 winheight( {nr}) Number height of window {nr} | |
| 2123 winline() Number window line of the cursor | |
| 674 | 2124 winnr( [{expr}]) Number number of current window |
| 55 | 2125 winrestcmd() String returns command to restore window sizes |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2126 winrestview( {dict}) none restore view of current window |
| 712 | 2127 winsaveview() Dict save view of current window |
| 7 | 2128 winwidth( {nr}) Number width of window {nr} |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
2129 wordcount() Dict get byte/char/word statistics |
| 6341 | 2130 writefile( {list}, {fname} [, {flags}]) |
| 158 | 2131 Number write list of lines to file {fname} |
| 3214 | 2132 xor( {expr}, {expr}) Number bitwise XOR |
| 7 | 2133 |
| 1621 | 2134 abs({expr}) *abs()* |
| 2135 Return the absolute value of {expr}. When {expr} evaluates to | |
| 2136 a |Float| abs() returns a |Float|. When {expr} can be | |
| 2137 converted to a |Number| abs() returns a |Number|. Otherwise | |
| 2138 abs() gives an error message and returns -1. | |
| 2139 Examples: > | |
| 2140 echo abs(1.456) | |
| 2141 < 1.456 > | |
| 2142 echo abs(-5.456) | |
| 2143 < 5.456 > | |
| 2144 echo abs(-4) | |
| 2145 < 4 | |
| 2146 {only available when compiled with the |+float| feature} | |
| 2147 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2148 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2149 acos({expr}) *acos()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2150 Return the arc cosine of {expr} measured in radians, as a |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2151 |Float| in the range of [0, pi]. |
|
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2152 {expr} must evaluate to a |Float| or a |Number| in the range |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2153 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2154 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2155 :echo acos(0) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2156 < 1.570796 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2157 :echo acos(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2158 < 2.094395 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
2159 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2160 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2161 |
| 82 | 2162 add({list}, {expr}) *add()* |
| 685 | 2163 Append the item {expr} to |List| {list}. Returns the |
| 2164 resulting |List|. Examples: > | |
| 82 | 2165 :let alist = add([1, 2, 3], item) |
| 2166 :call add(mylist, "woodstock") | |
| 685 | 2167 < Note that when {expr} is a |List| it is appended as a single |
| 692 | 2168 item. Use |extend()| to concatenate |Lists|. |
| 85 | 2169 Use |insert()| to add an item at another position. |
| 55 | 2170 |
| 82 | 2171 |
|
7513
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2172 alloc_fail({id}, {countdown}, {repeat}) *alloc_fail()* |
|
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2173 This is for testing: If the memory allocation with {id} is |
|
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2174 called, then decrement {countdown}, and when it reaches zero |
|
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2175 let memory allocation fail {repeat} times. When {repeat} is |
|
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2176 smaller than one it fails one time. |
|
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2177 |
|
37e061ec063c
commit https://github.com/vim/vim/commit/75bdf6aa30a5c99d67c42886cf7a4a000bbaa422
Christian Brabandt <cb@256bit.org>
parents:
7480
diff
changeset
|
2178 |
| 3214 | 2179 and({expr}, {expr}) *and()* |
| 2180 Bitwise AND on the two arguments. The arguments are converted | |
| 2181 to a number. A List, Dict or Float argument causes an error. | |
| 2182 Example: > | |
| 2183 :let flag = and(bits, 0x80) | |
| 2184 | |
| 2185 | |
| 82 | 2186 append({lnum}, {expr}) *append()* |
| 685 | 2187 When {expr} is a |List|: Append each item of the |List| as a |
| 2188 text line below line {lnum} in the current buffer. | |
| 153 | 2189 Otherwise append {expr} as one text line below line {lnum} in |
| 2190 the current buffer. | |
| 2191 {lnum} can be zero to insert a line before the first one. | |
| 82 | 2192 Returns 1 for failure ({lnum} out of range or out of memory), |
| 1621 | 2193 0 for success. Example: > |
| 55 | 2194 :let failed = append(line('$'), "# THE END") |
| 82 | 2195 :let failed = append(0, ["Chapter 1", "the beginning"]) |
| 55 | 2196 < |
| 7 | 2197 *argc()* |
| 2198 argc() The result is the number of files in the argument list of the | |
| 2199 current window. See |arglist|. | |
| 2200 | |
| 2201 *argidx()* | |
| 2202 argidx() The result is the current index in the argument list. 0 is | |
| 2203 the first file. argc() - 1 is the last one. See |arglist|. | |
| 2204 | |
| 5942 | 2205 *arglistid()* |
| 2206 arglistid([{winnr}, [ {tabnr} ]]) | |
| 2207 Return the argument list ID. This is a number which | |
| 2208 identifies the argument list being used. Zero is used for the | |
| 6153 | 2209 global argument list. See |arglist|. |
| 2210 Return -1 if the arguments are invalid. | |
| 5942 | 2211 |
| 2212 Without arguments use the current window. | |
| 2213 With {winnr} only use this window in the current tab page. | |
| 2214 With {winnr} and {tabnr} use the window in the specified tab | |
| 2215 page. | |
| 2216 | |
| 7 | 2217 *argv()* |
| 818 | 2218 argv([{nr}]) The result is the {nr}th file in the argument list of the |
| 7 | 2219 current window. See |arglist|. "argv(0)" is the first one. |
| 2220 Example: > | |
| 2221 :let i = 0 | |
| 2222 :while i < argc() | |
| 1621 | 2223 : let f = escape(fnameescape(argv(i)), '.') |
| 7 | 2224 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
| 2225 : let i = i + 1 | |
| 2226 :endwhile | |
| 818 | 2227 < Without the {nr} argument a |List| with the whole |arglist| is |
| 2228 returned. | |
| 2229 | |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2230 *assert_equal()* |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2231 assert_equal({expected}, {actual} [, {msg}]) |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2232 When {expected} and {actual} are not equal an error message is |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2233 added to |v:errors|. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2234 There is no automatic conversion, the String "4" is different |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2235 from the Number 4. And the number 4 is different from the |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2236 Float 4.0. The value of 'ignorecase' is not used here, case |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2237 always matters. |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2238 When {msg} is omitted an error in the form "Expected |
|
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2239 {expected} but got {actual}" is produced. |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2240 Example: > |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2241 assert_equal('foo', 'bar') |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2242 < Will result in a string to be added to |v:errors|: |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2243 test.vim line 12: Expected 'foo' but got 'bar' ~ |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2244 |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2245 assert_exception({error} [, {msg}]) *assert_exception()* |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2246 When v:exception does not contain the string {error} an error |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2247 message is added to |v:errors|. |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2248 This can be used to assert that a command throws an exception. |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2249 Using the error number, followed by a colon, avoids problems |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2250 with translations: > |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2251 try |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2252 commandthatfails |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2253 call assert_false(1, 'command should have failed') |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2254 catch |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2255 call assert_exception('E492:') |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2256 endtry |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2257 |
|
7593
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2258 assert_fails({cmd} [, {error}]) *assert_fails()* |
|
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2259 Run {cmd} and add an error message to |v:errors| if it does |
|
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2260 NOT produce an error. |
|
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2261 When {error} is given it must match |v:errmsg|. |
|
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2262 |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2263 assert_false({actual} [, {msg}]) *assert_false()* |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2264 When {actual} is not false an error message is added to |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2265 |v:errors|, like with |assert_equal()|. |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2266 A value is false when it is zero. When "{actual}" is not a |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2267 number the assert fails. |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2268 When {msg} is omitted an error in the form "Expected False but |
|
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2269 got {actual}" is produced. |
|
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2270 |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2271 assert_true({actual} [, {msg}]) *assert_true()* |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2272 When {actual} is not true an error message is added to |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2273 |v:errors|, like with |assert_equal()|. |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2274 A value is true when it is a non-zero number. When {actual} |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2275 is not a number the assert fails. |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2276 When {msg} is omitted an error in the form "Expected True but |
|
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2277 got {actual}" is produced. |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2278 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2279 asin({expr}) *asin()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2280 Return the arc sine of {expr} measured in radians, as a |Float| |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2281 in the range of [-pi/2, pi/2]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2282 {expr} must evaluate to a |Float| or a |Number| in the range |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2283 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2284 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2285 :echo asin(0.8) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2286 < 0.927295 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2287 :echo asin(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2288 < -0.523599 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
2289 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2290 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2291 |
| 1621 | 2292 atan({expr}) *atan()* |
| 2293 Return the principal value of the arc tangent of {expr}, in | |
| 2294 the range [-pi/2, +pi/2] radians, as a |Float|. | |
| 2295 {expr} must evaluate to a |Float| or a |Number|. | |
| 2296 Examples: > | |
| 2297 :echo atan(100) | |
| 2298 < 1.560797 > | |
| 2299 :echo atan(-4.01) | |
| 2300 < -1.326405 | |
| 2301 {only available when compiled with the |+float| feature} | |
| 2302 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2303 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2304 atan2({expr1}, {expr2}) *atan2()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2305 Return the arc tangent of {expr1} / {expr2}, measured in |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2306 radians, as a |Float| in the range [-pi, pi]. |
|
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2307 {expr1} and {expr2} must evaluate to a |Float| or a |Number|. |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2308 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2309 :echo atan2(-1, 1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2310 < -0.785398 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2311 :echo atan2(1, -1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2312 < 2.356194 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
2313 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2314 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2315 |
| 7 | 2316 *browse()* |
| 2317 browse({save}, {title}, {initdir}, {default}) | |
| 2318 Put up a file requester. This only works when "has("browse")" | |
| 2319 returns non-zero (only in some GUI versions). | |
| 2320 The input fields are: | |
| 2321 {save} when non-zero, select file to write | |
| 2322 {title} title for the requester | |
| 2323 {initdir} directory to start browsing in | |
| 2324 {default} default file name | |
| 2325 When the "Cancel" button is hit, something went wrong, or | |
| 2326 browsing is not possible, an empty string is returned. | |
| 2327 | |
| 29 | 2328 *browsedir()* |
| 2329 browsedir({title}, {initdir}) | |
| 2330 Put up a directory requester. This only works when | |
| 2331 "has("browse")" returns non-zero (only in some GUI versions). | |
| 2332 On systems where a directory browser is not supported a file | |
| 2333 browser is used. In that case: select a file in the directory | |
| 2334 to be used. | |
| 2335 The input fields are: | |
| 2336 {title} title for the requester | |
| 2337 {initdir} directory to start browsing in | |
| 2338 When the "Cancel" button is hit, something went wrong, or | |
| 2339 browsing is not possible, an empty string is returned. | |
| 2340 | |
| 7 | 2341 bufexists({expr}) *bufexists()* |
| 2342 The result is a Number, which is non-zero if a buffer called | |
| 2343 {expr} exists. | |
| 9 | 2344 If the {expr} argument is a number, buffer numbers are used. |
| 7 | 2345 If the {expr} argument is a string it must match a buffer name |
| 9 | 2346 exactly. The name can be: |
| 2347 - Relative to the current directory. | |
| 2348 - A full path. | |
| 1621 | 2349 - The name of a buffer with 'buftype' set to "nofile". |
| 9 | 2350 - A URL name. |
| 7 | 2351 Unlisted buffers will be found. |
| 2352 Note that help files are listed by their short name in the | |
| 2353 output of |:buffers|, but bufexists() requires using their | |
| 2354 long name to be able to find them. | |
| 1621 | 2355 bufexists() may report a buffer exists, but to use the name |
| 2356 with a |:buffer| command you may need to use |expand()|. Esp | |
| 2357 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
| 7 | 2358 Use "bufexists(0)" to test for the existence of an alternate |
| 2359 file name. | |
| 2360 *buffer_exists()* | |
| 2361 Obsolete name: buffer_exists(). | |
| 2362 | |
| 2363 buflisted({expr}) *buflisted()* | |
| 2364 The result is a Number, which is non-zero if a buffer called | |
| 2365 {expr} exists and is listed (has the 'buflisted' option set). | |
| 9 | 2366 The {expr} argument is used like with |bufexists()|. |
| 7 | 2367 |
| 2368 bufloaded({expr}) *bufloaded()* | |
| 2369 The result is a Number, which is non-zero if a buffer called | |
| 2370 {expr} exists and is loaded (shown in a window or hidden). | |
| 9 | 2371 The {expr} argument is used like with |bufexists()|. |
| 7 | 2372 |
| 2373 bufname({expr}) *bufname()* | |
| 2374 The result is the name of a buffer, as it is displayed by the | |
| 2375 ":ls" command. | |
| 2376 If {expr} is a Number, that buffer number's name is given. | |
| 2377 Number zero is the alternate buffer for the current window. | |
| 2378 If {expr} is a String, it is used as a |file-pattern| to match | |
| 1621 | 2379 with the buffer names. This is always done like 'magic' is |
| 7 | 2380 set and 'cpoptions' is empty. When there is more than one |
| 2381 match an empty string is returned. | |
| 2382 "" or "%" can be used for the current buffer, "#" for the | |
| 2383 alternate buffer. | |
| 2384 A full match is preferred, otherwise a match at the start, end | |
| 1156 | 2385 or middle of the buffer name is accepted. If you only want a |
| 2386 full match then put "^" at the start and "$" at the end of the | |
| 2387 pattern. | |
| 7 | 2388 Listed buffers are found first. If there is a single match |
| 2389 with a listed buffer, that one is returned. Next unlisted | |
| 2390 buffers are searched for. | |
| 2391 If the {expr} is a String, but you want to use it as a buffer | |
| 2392 number, force it to be a Number by adding zero to it: > | |
| 2393 :echo bufname("3" + 0) | |
| 2394 < If the buffer doesn't exist, or doesn't have a name, an empty | |
| 2395 string is returned. > | |
| 2396 bufname("#") alternate buffer name | |
| 2397 bufname(3) name of buffer 3 | |
| 2398 bufname("%") name of current buffer | |
| 2399 bufname("file2") name of buffer where "file2" matches. | |
| 2400 < *buffer_name()* | |
| 2401 Obsolete name: buffer_name(). | |
| 2402 | |
| 2403 *bufnr()* | |
| 707 | 2404 bufnr({expr} [, {create}]) |
| 2405 The result is the number of a buffer, as it is displayed by | |
| 7 | 2406 the ":ls" command. For the use of {expr}, see |bufname()| |
| 707 | 2407 above. |
| 2408 If the buffer doesn't exist, -1 is returned. Or, if the | |
| 2409 {create} argument is present and not zero, a new, unlisted, | |
| 2410 buffer is created and its number is returned. | |
| 7 | 2411 bufnr("$") is the last buffer: > |
| 2412 :let last_buffer = bufnr("$") | |
| 2413 < The result is a Number, which is the highest buffer number | |
| 2414 of existing buffers. Note that not all buffers with a smaller | |
| 2415 number necessarily exist, because ":bwipeout" may have removed | |
| 2416 them. Use bufexists() to test for the existence of a buffer. | |
| 2417 *buffer_number()* | |
| 2418 Obsolete name: buffer_number(). | |
| 2419 *last_buffer_nr()* | |
| 2420 Obsolete name for bufnr("$"): last_buffer_nr(). | |
| 2421 | |
| 2422 bufwinnr({expr}) *bufwinnr()* | |
| 2423 The result is a Number, which is the number of the first | |
| 2424 window associated with buffer {expr}. For the use of {expr}, | |
| 1621 | 2425 see |bufname()| above. If buffer {expr} doesn't exist or |
| 7 | 2426 there is no such window, -1 is returned. Example: > |
| 2427 | |
| 2428 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
| 2429 | |
| 2430 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
| 2431 |:wincmd|. | |
| 1156 | 2432 Only deals with the current tab page. |
| 7 | 2433 |
| 2434 | |
| 2435 byte2line({byte}) *byte2line()* | |
| 2436 Return the line number that contains the character at byte | |
| 2437 count {byte} in the current buffer. This includes the | |
| 2438 end-of-line character, depending on the 'fileformat' option | |
| 2439 for the current buffer. The first character has byte count | |
| 2440 one. | |
| 2441 Also see |line2byte()|, |go| and |:goto|. | |
| 2442 {not available when compiled without the |+byte_offset| | |
| 2443 feature} | |
| 2444 | |
| 18 | 2445 byteidx({expr}, {nr}) *byteidx()* |
| 2446 Return byte index of the {nr}'th character in the string | |
| 2447 {expr}. Use zero for the first character, it returns zero. | |
| 2448 This function is only useful when there are multibyte | |
| 2449 characters, otherwise the returned value is equal to {nr}. | |
| 5413 | 2450 Composing characters are not counted separately, their byte |
| 2451 length is added to the preceding base character. See | |
| 2452 |byteidxcomp()| below for counting composing characters | |
| 2453 separately. | |
| 18 | 2454 Example : > |
| 2455 echo matchstr(str, ".", byteidx(str, 3)) | |
| 2456 < will display the fourth character. Another way to do the | |
| 2457 same: > | |
| 2458 let s = strpart(str, byteidx(str, 3)) | |
| 2459 echo strpart(s, 0, byteidx(s, 1)) | |
| 2460 < If there are less than {nr} characters -1 is returned. | |
| 2461 If there are exactly {nr} characters the length of the string | |
| 5413 | 2462 in bytes is returned. |
| 2463 | |
| 2464 byteidxcomp({expr}, {nr}) *byteidxcomp()* | |
| 2465 Like byteidx(), except that a composing character is counted | |
| 2466 as a separate character. Example: > | |
| 2467 let s = 'e' . nr2char(0x301) | |
| 2468 echo byteidx(s, 1) | |
| 2469 echo byteidxcomp(s, 1) | |
| 2470 echo byteidxcomp(s, 2) | |
| 2471 < The first and third echo result in 3 ('e' plus composing | |
| 2472 character is 3 bytes), the second echo results in 1 ('e' is | |
| 2473 one byte). | |
| 2474 Only works different from byteidx() when 'encoding' is set to | |
| 2475 a Unicode encoding. | |
| 18 | 2476 |
| 102 | 2477 call({func}, {arglist} [, {dict}]) *call()* *E699* |
| 685 | 2478 Call function {func} with the items in |List| {arglist} as |
| 79 | 2479 arguments. |
| 685 | 2480 {func} can either be a |Funcref| or the name of a function. |
| 79 | 2481 a:firstline and a:lastline are set to the cursor line. |
| 2482 Returns the return value of the called function. | |
| 102 | 2483 {dict} is for functions with the "dict" attribute. It will be |
| 2484 used to set the local variable "self". |Dictionary-function| | |
| 79 | 2485 |
| 1621 | 2486 ceil({expr}) *ceil()* |
| 2487 Return the smallest integral value greater than or equal to | |
| 2488 {expr} as a |Float| (round up). | |
| 2489 {expr} must evaluate to a |Float| or a |Number|. | |
| 2490 Examples: > | |
| 2491 echo ceil(1.456) | |
| 2492 < 2.0 > | |
| 2493 echo ceil(-5.456) | |
| 2494 < -5.0 > | |
| 2495 echo ceil(4.0) | |
| 2496 < 4.0 | |
| 2497 {only available when compiled with the |+float| feature} | |
| 2498 | |
| 777 | 2499 changenr() *changenr()* |
| 2500 Return the number of the most recent change. This is the same | |
| 2501 number as what is displayed with |:undolist| and can be used | |
| 2502 with the |:undo| command. | |
| 2503 When a change was made it is the number of that change. After | |
| 2504 redo it is the number of the redone change. After undo it is | |
| 2505 one less than the number of the undone change. | |
| 2506 | |
| 4051 | 2507 char2nr({expr}[, {utf8}]) *char2nr()* |
| 7 | 2508 Return number value of the first char in {expr}. Examples: > |
| 2509 char2nr(" ") returns 32 | |
| 2510 char2nr("ABC") returns 65 | |
| 4051 | 2511 < When {utf8} is omitted or zero, the current 'encoding' is used. |
| 2512 Example for "utf-8": > | |
| 1156 | 2513 char2nr("á") returns 225 |
| 2514 char2nr("á"[0]) returns 195 | |
| 4051 | 2515 < With {utf8} set to 1, always treat as utf-8 characters. |
| 2516 A combining character is a separate character. | |
| 2965 | 2517 |nr2char()| does the opposite. |
| 7 | 2518 |
| 2519 cindent({lnum}) *cindent()* | |
| 2520 Get the amount of indent for line {lnum} according the C | |
| 2521 indenting rules, as with 'cindent'. | |
| 2522 The indent is counted in spaces, the value of 'tabstop' is | |
| 2523 relevant. {lnum} is used just like in |getline()|. | |
| 2524 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
| 2525 feature, -1 is returned. | |
| 548 | 2526 See |C-indenting|. |
| 7 | 2527 |
| 1326 | 2528 clearmatches() *clearmatches()* |
| 2529 Clears all matches previously defined by |matchadd()| and the | |
| 2530 |:match| commands. | |
| 2531 | |
| 7 | 2532 *col()* |
| 24 | 2533 col({expr}) The result is a Number, which is the byte index of the column |
| 7 | 2534 position given with {expr}. The accepted positions are: |
| 2535 . the cursor position | |
| 2536 $ the end of the cursor line (the result is the | |
| 3513 | 2537 number of bytes in the cursor line plus one) |
| 7 | 2538 'x position of mark x (if the mark is not set, 0 is |
| 2539 returned) | |
| 6447 | 2540 v In Visual mode: the start of the Visual area (the |
| 2541 cursor is the end). When not in Visual mode | |
| 2542 returns the cursor position. Differs from |'<| in | |
| 2543 that it's updated right away. | |
| 1317 | 2544 Additionally {expr} can be [lnum, col]: a |List| with the line |
| 2545 and column number. Most useful when the column is "$", to get | |
| 1621 | 2546 the last column of a specific line. When "lnum" or "col" is |
| 1317 | 2547 out of range then col() returns zero. |
| 1156 | 2548 To get the line number use |line()|. To get both use |
| 703 | 2549 |getpos()|. |
| 7 | 2550 For the screen column position use |virtcol()|. |
| 2551 Note that only marks in the current file can be used. | |
| 2552 Examples: > | |
| 2553 col(".") column of cursor | |
| 2554 col("$") length of cursor line plus one | |
| 2555 col("'t") column of mark t | |
| 2556 col("'" . markname) column of mark markname | |
| 1621 | 2557 < The first column is 1. 0 is returned for an error. |
| 1156 | 2558 For an uppercase mark the column may actually be in another |
| 2559 buffer. | |
| 7 | 2560 For the cursor position, when 'virtualedit' is active, the |
| 2561 column is one higher if the cursor is after the end of the | |
| 2562 line. This can be used to obtain the column in Insert mode: > | |
| 2563 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
| 2564 \<C-O>:set ve=all<CR> | |
| 2565 \<C-O>:echo col(".") . "\n" <Bar> | |
| 2566 \let &ve = save_ve<CR> | |
| 2567 < | |
| 464 | 2568 |
| 724 | 2569 complete({startcol}, {matches}) *complete()* *E785* |
| 2570 Set the matches for Insert mode completion. | |
| 2571 Can only be used in Insert mode. You need to use a mapping | |
| 1156 | 2572 with CTRL-R = |i_CTRL-R|. It does not work after CTRL-O or |
| 2573 with an expression mapping. | |
| 724 | 2574 {startcol} is the byte offset in the line where the completed |
| 2575 text start. The text up to the cursor is the original text | |
| 2576 that will be replaced by the matches. Use col('.') for an | |
| 2577 empty string. "col('.') - 1" will replace one character by a | |
| 2578 match. | |
| 2579 {matches} must be a |List|. Each |List| item is one match. | |
| 2580 See |complete-items| for the kind of items that are possible. | |
| 2581 Note that the after calling this function you need to avoid | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2582 inserting anything that would cause completion to stop. |
| 724 | 2583 The match can be selected with CTRL-N and CTRL-P as usual with |
| 2584 Insert mode completion. The popup menu will appear if | |
| 2585 specified, see |ins-completion-menu|. | |
| 2586 Example: > | |
| 1156 | 2587 inoremap <F5> <C-R>=ListMonths()<CR> |
| 724 | 2588 |
| 2589 func! ListMonths() | |
| 2590 call complete(col('.'), ['January', 'February', 'March', | |
| 2591 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
| 2592 \ 'October', 'November', 'December']) | |
| 2593 return '' | |
| 2594 endfunc | |
| 2595 < This isn't very useful, but it shows how it works. Note that | |
| 2596 an empty string is returned to avoid a zero being inserted. | |
| 2597 | |
| 464 | 2598 complete_add({expr}) *complete_add()* |
| 2599 Add {expr} to the list of matches. Only to be used by the | |
| 2600 function specified with the 'completefunc' option. | |
| 2601 Returns 0 for failure (empty string or out of memory), | |
| 2602 1 when the match was added, 2 when the match was already in | |
| 2603 the list. | |
| 1621 | 2604 See |complete-functions| for an explanation of {expr}. It is |
| 786 | 2605 the same as one item in the list that 'omnifunc' would return. |
| 464 | 2606 |
| 2607 complete_check() *complete_check()* | |
| 2608 Check for a key typed while looking for completion matches. | |
| 2609 This is to be used when looking for matches takes some time. | |
| 2610 Returns non-zero when searching for matches is to be aborted, | |
| 2611 zero otherwise. | |
| 2612 Only to be used by the function specified with the | |
| 2613 'completefunc' option. | |
| 2614 | |
| 7 | 2615 *confirm()* |
| 2616 confirm({msg} [, {choices} [, {default} [, {type}]]]) | |
| 2617 Confirm() offers the user a dialog, from which a choice can be | |
| 2618 made. It returns the number of the choice. For the first | |
| 2619 choice this is 1. | |
| 2620 Note: confirm() is only supported when compiled with dialog | |
| 2621 support, see |+dialog_con| and |+dialog_gui|. | |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2622 |
| 7 | 2623 {msg} is displayed in a |dialog| with {choices} as the |
| 2624 alternatives. When {choices} is missing or empty, "&OK" is | |
| 2625 used (and translated). | |
| 2626 {msg} is a String, use '\n' to include a newline. Only on | |
| 2627 some systems the string is wrapped when it doesn't fit. | |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2628 |
| 7 | 2629 {choices} is a String, with the individual choices separated |
| 2630 by '\n', e.g. > | |
| 2631 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
| 2632 < The letter after the '&' is the shortcut key for that choice. | |
| 2633 Thus you can type 'c' to select "Cancel". The shortcut does | |
| 2634 not need to be the first letter: > | |
| 2635 confirm("file has been modified", "&Save\nSave &All") | |
| 2636 < For the console, the first letter of each choice is used as | |
| 2637 the default shortcut key. | |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2638 |
| 7 | 2639 The optional {default} argument is the number of the choice |
| 2640 that is made if the user hits <CR>. Use 1 to make the first | |
| 2641 choice the default one. Use 0 to not set a default. If | |
| 2642 {default} is omitted, 1 is used. | |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2643 |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2644 The optional {type} argument gives the type of dialog. This |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2645 is only used for the icon of the GTK, Mac, Motif and Win32 |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2646 GUI. It can be one of these values: "Error", "Question", |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2647 "Info", "Warning" or "Generic". Only the first character is |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2648 relevant. When {type} is omitted, "Generic" is used. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2649 |
| 7 | 2650 If the user aborts the dialog by pressing <Esc>, CTRL-C, |
| 2651 or another valid interrupt key, confirm() returns 0. | |
| 2652 | |
| 2653 An example: > | |
| 2654 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
| 2655 :if choice == 0 | |
| 2656 : echo "make up your mind!" | |
| 2657 :elseif choice == 3 | |
| 2658 : echo "tasteful" | |
| 2659 :else | |
| 2660 : echo "I prefer bananas myself." | |
| 2661 :endif | |
| 2662 < In a GUI dialog, buttons are used. The layout of the buttons | |
| 2663 depends on the 'v' flag in 'guioptions'. If it is included, | |
| 1621 | 2664 the buttons are always put vertically. Otherwise, confirm() |
| 7 | 2665 tries to put the buttons in one horizontal line. If they |
| 2666 don't fit, a vertical layout is used anyway. For some systems | |
| 2667 the horizontal layout is always used. | |
| 2668 | |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2669 connect({address}, {mode} [, {callback}]) *connect()* |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2670 Open a channel to {address}. See |channel|. |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2671 |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2672 {address} has the form "hostname:port", e.g., |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2673 "localhost:8765". |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2674 |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2675 {mode} is either "json" or "raw". See |channel-mode| for the |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2676 meaning. |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2677 |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2678 {callback} is a function that handles received messages on the |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2679 channel. See |channel-callback|. |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
2680 |
| 55 | 2681 *copy()* |
| 1621 | 2682 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 2683 different from using {expr} directly. |
| 685 | 2684 When {expr} is a |List| a shallow copy is created. This means |
| 2685 that the original |List| can be changed without changing the | |
| 1621 | 2686 copy, and vice versa. But the items are identical, thus |
| 2687 changing an item changes the contents of both |Lists|. Also | |
| 685 | 2688 see |deepcopy()|. |
| 55 | 2689 |
| 1621 | 2690 cos({expr}) *cos()* |
| 2691 Return the cosine of {expr}, measured in radians, as a |Float|. | |
| 2692 {expr} must evaluate to a |Float| or a |Number|. | |
| 2693 Examples: > | |
| 2694 :echo cos(100) | |
| 2695 < 0.862319 > | |
| 2696 :echo cos(-4.01) | |
| 2697 < -0.646043 | |
| 2698 {only available when compiled with the |+float| feature} | |
| 2699 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2700 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2701 cosh({expr}) *cosh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2702 Return the hyperbolic cosine of {expr} as a |Float| in the range |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2703 [1, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2704 {expr} must evaluate to a |Float| or a |Number|. |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2705 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2706 :echo cosh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2707 < 1.127626 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2708 :echo cosh(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2709 < -1.127626 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
2710 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2711 |
| 1621 | 2712 |
| 102 | 2713 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
| 79 | 2714 Return the number of times an item with value {expr} appears |
| 685 | 2715 in |List| or |Dictionary| {comp}. |
| 102 | 2716 If {start} is given then start with the item with this index. |
| 685 | 2717 {start} can only be used with a |List|. |
| 79 | 2718 When {ic} is given and it's non-zero then case is ignored. |
| 2719 | |
| 2720 | |
| 7 | 2721 *cscope_connection()* |
| 2722 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
| 2723 Checks for the existence of a |cscope| connection. If no | |
| 2724 parameters are specified, then the function returns: | |
| 2725 0, if cscope was not available (not compiled in), or | |
| 2726 if there are no cscope connections; | |
| 2727 1, if there is at least one cscope connection. | |
| 2728 | |
| 2729 If parameters are specified, then the value of {num} | |
| 2730 determines how existence of a cscope connection is checked: | |
| 2731 | |
| 2732 {num} Description of existence check | |
| 2733 ----- ------------------------------ | |
| 2734 0 Same as no parameters (e.g., "cscope_connection()"). | |
| 2735 1 Ignore {prepend}, and use partial string matches for | |
| 2736 {dbpath}. | |
| 2737 2 Ignore {prepend}, and use exact string matches for | |
| 2738 {dbpath}. | |
| 2739 3 Use {prepend}, use partial string matches for both | |
| 2740 {dbpath} and {prepend}. | |
| 2741 4 Use {prepend}, use exact string matches for both | |
| 2742 {dbpath} and {prepend}. | |
| 2743 | |
| 2744 Note: All string comparisons are case sensitive! | |
| 2745 | |
| 2746 Examples. Suppose we had the following (from ":cs show"): > | |
| 2747 | |
| 2748 # pid database name prepend path | |
| 2749 0 27664 cscope.out /usr/local | |
| 2750 < | |
| 2751 Invocation Return Val ~ | |
| 2752 ---------- ---------- > | |
| 2753 cscope_connection() 1 | |
| 2754 cscope_connection(1, "out") 1 | |
| 2755 cscope_connection(2, "out") 0 | |
| 2756 cscope_connection(3, "out") 0 | |
| 2757 cscope_connection(3, "out", "local") 1 | |
| 2758 cscope_connection(4, "out") 0 | |
| 2759 cscope_connection(4, "out", "local") 0 | |
| 2760 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
| 2761 < | |
| 703 | 2762 cursor({lnum}, {col} [, {off}]) *cursor()* |
| 2763 cursor({list}) | |
| 1156 | 2764 Positions the cursor at the column (byte count) {col} in the |
| 2765 line {lnum}. The first column is one. | |
| 5938 | 2766 |
| 703 | 2767 When there is one argument {list} this is used as a |List| |
| 5938 | 2768 with two, three or four item: |
| 2769 [{lnum}, {col}, {off}] | |
| 2770 [{lnum}, {col}, {off}, {curswant}] | |
| 6009 | 2771 This is like the return value of |getpos()| or |getcurpos()|, |
| 5944 | 2772 but without the first item. |
| 5938 | 2773 |
| 7 | 2774 Does not change the jumplist. |
| 2775 If {lnum} is greater than the number of lines in the buffer, | |
| 2776 the cursor will be positioned at the last line in the buffer. | |
| 2777 If {lnum} is zero, the cursor will stay in the current line. | |
| 493 | 2778 If {col} is greater than the number of bytes in the line, |
| 7 | 2779 the cursor will be positioned at the last character in the |
| 2780 line. | |
| 2781 If {col} is zero, the cursor will stay in the current column. | |
| 5944 | 2782 If {curswant} is given it is used to set the preferred column |
| 6180 | 2783 for vertical movement. Otherwise {col} is used. |
| 6385 | 2784 |
| 703 | 2785 When 'virtualedit' is used {off} specifies the offset in |
| 2786 screen columns from the start of the character. E.g., a | |
| 1266 | 2787 position within a <Tab> or after the last character. |
| 1851 | 2788 Returns 0 when the position could be set, -1 otherwise. |
| 7 | 2789 |
| 55 | 2790 |
| 164 | 2791 deepcopy({expr}[, {noref}]) *deepcopy()* *E698* |
| 1621 | 2792 Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 2793 different from using {expr} directly. |
| 685 | 2794 When {expr} is a |List| a full copy is created. This means |
| 2795 that the original |List| can be changed without changing the | |
| 1621 | 2796 copy, and vice versa. When an item is a |List|, a copy for it |
| 55 | 2797 is made, recursively. Thus changing an item in the copy does |
| 685 | 2798 not change the contents of the original |List|. |
| 2799 When {noref} is omitted or zero a contained |List| or | |
| 2800 |Dictionary| is only copied once. All references point to | |
| 2801 this single copy. With {noref} set to 1 every occurrence of a | |
| 2802 |List| or |Dictionary| results in a new copy. This also means | |
| 2803 that a cyclic reference causes deepcopy() to fail. | |
| 114 | 2804 *E724* |
| 2805 Nesting is possible up to 100 levels. When there is an item | |
| 164 | 2806 that refers back to a higher level making a deep copy with |
| 2807 {noref} set to 1 will fail. | |
| 55 | 2808 Also see |copy()|. |
| 2809 | |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2810 delete({fname} [, {flags}]) *delete()* |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2811 Without {flags} or with {flags} empty: Deletes the file by the |
|
7629
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
2812 name {fname}. This also works when {fname} is a symbolic link. |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2813 |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2814 When {flags} is "d": Deletes the directory by the name |
|
7629
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
2815 {fname}. This fails when directory {fname} is not empty. |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2816 |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2817 When {flags} is "rf": Deletes the directory by the name |
|
7629
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
2818 {fname} and everything in it, recursively. BE CAREFUL! |
|
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
2819 A symbolic link itself is deleted, not what it points to. |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2820 |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2821 The result is a Number, which is 0 if the delete operation was |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2822 successful and -1 when the deletion failed or partly failed. |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
2823 |
| 685 | 2824 Use |remove()| to delete an item from a |List|. |
| 4229 | 2825 To delete a line from the buffer use |:delete|. Use |:exe| |
| 2826 when the line number is in a variable. | |
| 7 | 2827 |
| 2828 *did_filetype()* | |
| 2829 did_filetype() Returns non-zero when autocommands are being executed and the | |
| 2830 FileType event has been triggered at least once. Can be used | |
| 2831 to avoid triggering the FileType event again in the scripts | |
| 2832 that detect the file type. |FileType| | |
| 2833 When editing another file, the counter is reset, thus this | |
| 2834 really checks if the FileType event has been triggered for the | |
| 2835 current buffer. This allows an autocommand that starts | |
| 2836 editing another buffer to set 'filetype' and load a syntax | |
| 2837 file. | |
| 2838 | |
| 32 | 2839 diff_filler({lnum}) *diff_filler()* |
| 2840 Returns the number of filler lines above line {lnum}. | |
| 2841 These are the lines that were inserted at this point in | |
| 2842 another diff'ed window. These filler lines are shown in the | |
| 2843 display but don't exist in the buffer. | |
| 2844 {lnum} is used like with |getline()|. Thus "." is the current | |
| 2845 line, "'m" mark m, etc. | |
| 2846 Returns 0 if the current window is not in diff mode. | |
| 2847 | |
| 2848 diff_hlID({lnum}, {col}) *diff_hlID()* | |
| 2849 Returns the highlight ID for diff mode at line {lnum} column | |
| 2850 {col} (byte index). When the current line does not have a | |
| 2851 diff change zero is returned. | |
| 2852 {lnum} is used like with |getline()|. Thus "." is the current | |
| 2853 line, "'m" mark m, etc. | |
| 2854 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
| 2855 line. | |
| 2856 The highlight ID can be used with |synIDattr()| to obtain | |
| 2857 syntax information about the highlighting. | |
| 2858 | |
| 85 | 2859 empty({expr}) *empty()* |
| 2860 Return the Number 1 if {expr} is empty, zero otherwise. | |
| 685 | 2861 A |List| or |Dictionary| is empty when it does not have any |
| 1621 | 2862 items. A Number is empty when its value is zero. |
|
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
2863 |v:false|, |v:none| and |v:null| are empty, |v:true| is not. |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2864 For a long |List| this is much faster than comparing the |
| 685 | 2865 length with zero. |
| 85 | 2866 |
| 7 | 2867 escape({string}, {chars}) *escape()* |
| 2868 Escape the characters in {chars} that occur in {string} with a | |
| 2869 backslash. Example: > | |
| 2870 :echo escape('c:\program files\vim', ' \') | |
| 2871 < results in: > | |
| 2872 c:\\program\ files\\vim | |
| 1621 | 2873 < Also see |shellescape()|. |
| 2874 | |
| 2875 *eval()* | |
| 95 | 2876 eval({string}) Evaluate {string} and return the result. Especially useful to |
| 2877 turn the result of |string()| back into the original value. | |
| 1621 | 2878 This works for Numbers, Floats, Strings and composites of |
| 2879 them. Also works for |Funcref|s that refer to existing | |
| 2880 functions. | |
| 95 | 2881 |
| 7 | 2882 eventhandler() *eventhandler()* |
| 2883 Returns 1 when inside an event handler. That is that Vim got | |
| 2884 interrupted while waiting for the user to type a character, | |
| 2885 e.g., when dropping a file on Vim. This means interactive | |
| 2886 commands cannot be used. Otherwise zero is returned. | |
| 2887 | |
| 2888 executable({expr}) *executable()* | |
| 2889 This function checks if an executable with the name {expr} | |
| 2890 exists. {expr} must be the name of the program without any | |
| 10 | 2891 arguments. |
| 2892 executable() uses the value of $PATH and/or the normal | |
| 2893 searchpath for programs. *PATHEXT* | |
| 2894 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can | |
| 2895 optionally be included. Then the extensions in $PATHEXT are | |
| 1621 | 2896 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be |
| 2897 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is | |
| 10 | 2898 used. A dot by itself can be used in $PATHEXT to try using |
| 1621 | 2899 the name without an extension. When 'shell' looks like a |
| 10 | 2900 Unix shell, then the name is also tried without adding an |
| 2901 extension. | |
| 2902 On MS-DOS and MS-Windows it only checks if the file exists and | |
| 2903 is not a directory, not if it's really executable. | |
| 819 | 2904 On MS-Windows an executable in the same directory as Vim is |
| 2905 always found. Since this directory is added to $PATH it | |
| 2906 should also work to execute it |win32-PATH|. | |
| 7 | 2907 The result is a Number: |
| 2908 1 exists | |
| 2909 0 does not exist | |
| 2910 -1 not implemented on this system | |
| 2911 | |
| 5782 | 2912 exepath({expr}) *exepath()* |
| 2913 If {expr} is an executable and is either an absolute path, a | |
| 2914 relative path or found in $PATH, return the full path. | |
| 2915 Note that the current directory is used when {expr} starts | |
| 2916 with "./", which may be a problem for Vim: > | |
| 2917 echo exepath(v:progpath) | |
| 5814 | 2918 < If {expr} cannot be found in $PATH or is not executable then |
| 5782 | 2919 an empty string is returned. |
| 2920 | |
| 7 | 2921 *exists()* |
| 2922 exists({expr}) The result is a Number, which is non-zero if {expr} is | |
| 2923 defined, zero otherwise. The {expr} argument is a string, | |
| 2924 which contains one of these: | |
| 2925 &option-name Vim option (only checks if it exists, | |
| 2926 not if it really works) | |
| 2927 +option-name Vim option that works. | |
| 2928 $ENVNAME environment variable (could also be | |
| 2929 done by comparing with an empty | |
| 2930 string) | |
| 2931 *funcname built-in function (see |functions|) | |
| 2932 or user defined function (see | |
| 5862 | 2933 |user-functions|). Also works for a |
| 2934 variable that is a Funcref. | |
| 7 | 2935 varname internal variable (see |
| 1621 | 2936 |internal-variables|). Also works |
| 685 | 2937 for |curly-braces-names|, |Dictionary| |
| 2938 entries, |List| items, etc. Beware | |
| 1668 | 2939 that evaluating an index may cause an |
| 2940 error message for an invalid | |
| 2941 expression. E.g.: > | |
| 2942 :let l = [1, 2, 3] | |
| 2943 :echo exists("l[5]") | |
| 2944 < 0 > | |
| 2945 :echo exists("l[xx]") | |
| 2946 < E121: Undefined variable: xx | |
| 2947 0 | |
| 7 | 2948 :cmdname Ex command: built-in command, user |
| 2949 command or command modifier |:command|. | |
| 2950 Returns: | |
| 2951 1 for match with start of a command | |
| 2952 2 full match with a command | |
| 2953 3 matches several user commands | |
| 2954 To check for a supported command | |
| 2955 always check the return value to be 2. | |
| 864 | 2956 :2match The |:2match| command. |
| 2957 :3match The |:3match| command. | |
| 7 | 2958 #event autocommand defined for this event |
| 2959 #event#pattern autocommand defined for this event and | |
| 2960 pattern (the pattern is taken | |
| 2961 literally and compared to the | |
| 2962 autocommand patterns character by | |
| 2963 character) | |
| 613 | 2964 #group autocommand group exists |
| 2965 #group#event autocommand defined for this group and | |
| 2966 event. | |
| 2967 #group#event#pattern | |
| 856 | 2968 autocommand defined for this group, |
| 613 | 2969 event and pattern. |
| 615 | 2970 ##event autocommand for this event is |
| 2971 supported. | |
| 7 | 2972 For checking for a supported feature use |has()|. |
| 2973 | |
| 2974 Examples: > | |
| 2975 exists("&shortname") | |
| 2976 exists("$HOSTNAME") | |
| 2977 exists("*strftime") | |
| 2978 exists("*s:MyFunc") | |
| 2979 exists("bufcount") | |
| 2980 exists(":Make") | |
| 613 | 2981 exists("#CursorHold") |
| 7 | 2982 exists("#BufReadPre#*.gz") |
| 613 | 2983 exists("#filetypeindent") |
| 2984 exists("#filetypeindent#FileType") | |
| 2985 exists("#filetypeindent#FileType#*") | |
| 615 | 2986 exists("##ColorScheme") |
| 7 | 2987 < There must be no space between the symbol (&/$/*/#) and the |
| 2988 name. | |
| 867 | 2989 There must be no extra characters after the name, although in |
| 2990 a few cases this is ignored. That may become more strict in | |
| 2991 the future, thus don't count on it! | |
| 2992 Working example: > | |
| 2993 exists(":make") | |
| 2994 < NOT working example: > | |
| 2995 exists(":make install") | |
| 859 | 2996 |
| 2997 < Note that the argument must be a string, not the name of the | |
| 2998 variable itself. For example: > | |
| 7 | 2999 exists(bufcount) |
| 3000 < This doesn't check for existence of the "bufcount" variable, | |
| 853 | 3001 but gets the value of "bufcount", and checks if that exists. |
| 7 | 3002 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3003 exp({expr}) *exp()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3004 Return the exponential of {expr} as a |Float| in the range |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3005 [0, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3006 {expr} must evaluate to a |Float| or a |Number|. |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3007 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3008 :echo exp(2) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3009 < 7.389056 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3010 :echo exp(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3011 < 0.367879 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
3012 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3013 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3014 |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3015 expand({expr} [, {nosuf} [, {list}]]) *expand()* |
| 7 | 3016 Expand wildcards and the following special keywords in {expr}. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3017 'wildignorecase' applies. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3018 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3019 If {list} is given and it is non-zero, a List will be returned. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3020 Otherwise the result is a String and when there are several |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3021 matches, they are separated by <NL> characters. [Note: in |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3022 version 5.0 a space was used, which caused problems when a |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3023 file name contains a space] |
| 7 | 3024 |
| 1621 | 3025 If the expansion fails, the result is an empty string. A name |
| 4869 | 3026 for a non-existing file is not included, unless {expr} does |
| 3027 not start with '%', '#' or '<', see below. | |
| 7 | 3028 |
| 3029 When {expr} starts with '%', '#' or '<', the expansion is done | |
| 3030 like for the |cmdline-special| variables with their associated | |
| 3031 modifiers. Here is a short overview: | |
| 3032 | |
| 3033 % current file name | |
| 3034 # alternate file name | |
| 3035 #n alternate file name n | |
| 3036 <cfile> file name under the cursor | |
| 3037 <afile> autocmd file name | |
| 3038 <abuf> autocmd buffer number (as a String!) | |
| 3039 <amatch> autocmd matched name | |
| 5734 | 3040 <sfile> sourced script file or function name |
| 2662 | 3041 <slnum> sourced script file line number |
| 7 | 3042 <cword> word under the cursor |
| 3043 <cWORD> WORD under the cursor | |
| 3044 <client> the {clientid} of the last received | |
| 3045 message |server2client()| | |
| 3046 Modifiers: | |
| 3047 :p expand to full path | |
| 3048 :h head (last path component removed) | |
| 3049 :t tail (last path component only) | |
| 3050 :r root (one extension removed) | |
| 3051 :e extension only | |
| 3052 | |
| 3053 Example: > | |
| 3054 :let &tags = expand("%:p:h") . "/tags" | |
| 3055 < Note that when expanding a string that starts with '%', '#' or | |
| 3056 '<', any following text is ignored. This does NOT work: > | |
| 3057 :let doesntwork = expand("%:h.bak") | |
| 3058 < Use this: > | |
| 3059 :let doeswork = expand("%:h") . ".bak" | |
| 3060 < Also note that expanding "<cfile>" and others only returns the | |
| 3061 referenced file name without further expansion. If "<cfile>" | |
| 3062 is "~/.cshrc", you need to do another expand() to have the | |
| 3063 "~/" expanded into the path of the home directory: > | |
| 3064 :echo expand(expand("<cfile>")) | |
| 3065 < | |
| 3066 There cannot be white space between the variables and the | |
| 3067 following modifier. The |fnamemodify()| function can be used | |
| 3068 to modify normal file names. | |
| 3069 | |
| 3070 When using '%' or '#', and the current or alternate file name | |
| 3071 is not defined, an empty string is used. Using "%:p" in a | |
| 3072 buffer with no name, results in the current directory, with a | |
| 3073 '/' added. | |
| 3074 | |
| 3075 When {expr} does not start with '%', '#' or '<', it is | |
| 3076 expanded like a file name is expanded on the command line. | |
| 3077 'suffixes' and 'wildignore' are used, unless the optional | |
| 3398 | 3078 {nosuf} argument is given and it is non-zero. |
| 3079 Names for non-existing files are included. The "**" item can | |
| 3080 be used to search in a directory tree. For example, to find | |
| 3081 all "README" files in the current directory and below: > | |
| 444 | 3082 :echo expand("**/README") |
| 3083 < | |
| 7 | 3084 Expand() can also be used to expand variables and environment |
| 3085 variables that are only known in a shell. But this can be | |
| 6180 | 3086 slow, because a shell may be used to do the expansion. See |
| 3087 |expr-env-expand|. | |
| 7 | 3088 The expanded variable is still handled like a list of file |
| 1621 | 3089 names. When an environment variable cannot be expanded, it is |
| 7 | 3090 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
| 3091 "$FOOBAR". | |
| 3092 | |
| 3093 See |glob()| for finding existing files. See |system()| for | |
| 3094 getting the raw output of an external command. | |
| 3095 | |
| 102 | 3096 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
| 692 | 3097 {expr1} and {expr2} must be both |Lists| or both |
| 3098 |Dictionaries|. | |
| 3099 | |
| 3100 If they are |Lists|: Append {expr2} to {expr1}. | |
| 102 | 3101 If {expr3} is given insert the items of {expr2} before item |
| 3102 {expr3} in {expr1}. When {expr3} is zero insert before the | |
| 3103 first item. When {expr3} is equal to len({expr1}) then | |
| 3104 {expr2} is appended. | |
| 79 | 3105 Examples: > |
| 3106 :echo sort(extend(mylist, [7, 5])) | |
| 3107 :call extend(mylist, [2, 3], 1) | |
| 1699 | 3108 < When {expr1} is the same List as {expr2} then the number of |
| 3109 items copied is equal to the original length of the List. | |
| 3110 E.g., when {expr3} is 1 you get N new copies of the first item | |
| 3111 (where N is the original length of the List). | |
| 3112 Use |add()| to concatenate one item to a list. To concatenate | |
| 82 | 3113 two lists into a new list use the + operator: > |
| 79 | 3114 :let newlist = [1, 2, 3] + [4, 5] |
| 102 | 3115 < |
| 692 | 3116 If they are |Dictionaries|: |
| 102 | 3117 Add all entries from {expr2} to {expr1}. |
| 3118 If a key exists in both {expr1} and {expr2} then {expr3} is | |
| 3119 used to decide what to do: | |
| 3120 {expr3} = "keep": keep the value of {expr1} | |
| 3121 {expr3} = "force": use the value of {expr2} | |
| 856 | 3122 {expr3} = "error": give an error message *E737* |
| 102 | 3123 When {expr3} is omitted then "force" is assumed. |
| 3124 | |
| 3125 {expr1} is changed when {expr2} is not empty. If necessary | |
| 3126 make a copy of {expr1} first. | |
| 3127 {expr2} remains unchanged. | |
| 6823 | 3128 When {expr1} is locked and {expr2} is not empty the operation |
| 3129 fails. | |
| 102 | 3130 Returns {expr1}. |
| 3131 | |
| 79 | 3132 |
| 842 | 3133 feedkeys({string} [, {mode}]) *feedkeys()* |
| 3134 Characters in {string} are queued for processing as if they | |
| 6549 | 3135 come from a mapping or were typed by the user. |
| 3136 By default the string is added to the end of the typeahead | |
| 3137 buffer, thus if a mapping is still being executed the | |
| 3138 characters come after them. Use the 'i' flag to insert before | |
| 3139 other characters, they will be executed next, before any | |
| 3140 characters from a mapping. | |
| 842 | 3141 The function does not wait for processing of keys contained in |
| 3142 {string}. | |
| 3143 To include special keys into {string}, use double-quotes | |
| 3144 and "\..." notation |expr-quote|. For example, | |
| 1215 | 3145 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
| 842 | 3146 feedkeys('\<CR>') pushes 5 characters. |
| 3147 If {mode} is absent, keys are remapped. | |
| 3148 {mode} is a String, which can contain these character flags: | |
| 843 | 3149 'm' Remap keys. This is default. |
| 3150 'n' Do not remap keys. | |
| 3151 't' Handle keys as if typed; otherwise they are handled as | |
| 3152 if coming from a mapping. This matters for undo, | |
| 3153 opening folds, etc. | |
| 6549 | 3154 'i' Insert the string instead of appending (see above). |
|
7703
39251e981d1f
commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
3155 'x' Execute commands until typeahead is empty. This is |
|
39251e981d1f
commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
3156 similar to using ":normal!". You can call feedkeys() |
|
39251e981d1f
commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
3157 several times without 'x' and then one time with 'x' |
|
39251e981d1f
commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
3158 (possibly with an empty {string}) to execute all the |
|
39251e981d1f
commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
3159 typeahead. |
| 842 | 3160 Return value is always 0. |
| 3161 | |
| 7 | 3162 filereadable({file}) *filereadable()* |
| 3163 The result is a Number, which is TRUE when a file with the | |
| 3164 name {file} exists, and can be read. If {file} doesn't exist, | |
| 3165 or is a directory, the result is FALSE. {file} is any | |
| 3166 expression, which is used as a String. | |
| 1156 | 3167 If you don't care about the file being readable you can use |
| 3168 |glob()|. | |
| 7 | 3169 *file_readable()* |
| 3170 Obsolete name: file_readable(). | |
| 3171 | |
| 95 | 3172 |
| 1156 | 3173 filewritable({file}) *filewritable()* |
| 3174 The result is a Number, which is 1 when a file with the | |
| 3175 name {file} exists, and can be written. If {file} doesn't | |
| 1621 | 3176 exist, or is not writable, the result is 0. If {file} is a |
| 1156 | 3177 directory, and we can write to it, the result is 2. |
| 3178 | |
| 3179 | |
| 102 | 3180 filter({expr}, {string}) *filter()* |
| 685 | 3181 {expr} must be a |List| or a |Dictionary|. |
| 102 | 3182 For each item in {expr} evaluate {string} and when the result |
| 685 | 3183 is zero remove the item from the |List| or |Dictionary|. |
| 102 | 3184 Inside {string} |v:val| has the value of the current item. |
| 685 | 3185 For a |Dictionary| |v:key| has the key of the current item. |
| 102 | 3186 Examples: > |
| 3187 :call filter(mylist, 'v:val !~ "OLD"') | |
| 3188 < Removes the items where "OLD" appears. > | |
| 3189 :call filter(mydict, 'v:key >= 8') | |
| 3190 < Removes the items with a key below 8. > | |
| 3191 :call filter(var, 0) | |
| 685 | 3192 < Removes all the items, thus clears the |List| or |Dictionary|. |
| 99 | 3193 |
| 102 | 3194 Note that {string} is the result of expression and is then |
| 3195 used as an expression again. Often it is good to use a | |
| 3196 |literal-string| to avoid having to double backslashes. | |
| 3197 | |
| 685 | 3198 The operation is done in-place. If you want a |List| or |
| 3199 |Dictionary| to remain unmodified make a copy first: > | |
| 650 | 3200 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
| 102 | 3201 |
| 685 | 3202 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
| 648 | 3203 When an error is encountered while evaluating {string} no |
| 3204 further items in {expr} are processed. | |
| 95 | 3205 |
| 3206 | |
| 19 | 3207 finddir({name}[, {path}[, {count}]]) *finddir()* |
| 1095 | 3208 Find directory {name} in {path}. Supports both downwards and |
| 3209 upwards recursive directory searches. See |file-searching| | |
| 3210 for the syntax of {path}. | |
| 3211 Returns the path of the first found match. When the found | |
| 3212 directory is below the current directory a relative path is | |
| 3213 returned. Otherwise a full path is returned. | |
| 19 | 3214 If {path} is omitted or empty then 'path' is used. |
| 3215 If the optional {count} is given, find {count}'s occurrence of | |
| 794 | 3216 {name} in {path} instead of the first one. |
| 809 | 3217 When {count} is negative return all the matches in a |List|. |
| 19 | 3218 This is quite similar to the ex-command |:find|. |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
3219 {only available when compiled with the |+file_in_path| |
|
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
3220 feature} |
| 794 | 3221 |
| 3222 findfile({name}[, {path}[, {count}]]) *findfile()* | |
| 3223 Just like |finddir()|, but find a file instead of a directory. | |
| 3224 Uses 'suffixesadd'. | |
| 19 | 3225 Example: > |
| 3226 :echo findfile("tags.vim", ".;") | |
| 1156 | 3227 < Searches from the directory of the current file upwards until |
| 3228 it finds the file "tags.vim". | |
| 7 | 3229 |
| 1621 | 3230 float2nr({expr}) *float2nr()* |
| 3231 Convert {expr} to a Number by omitting the part after the | |
| 3232 decimal point. | |
| 3233 {expr} must evaluate to a |Float| or a Number. | |
| 3234 When the value of {expr} is out of range for a |Number| the | |
| 3235 result is truncated to 0x7fffffff or -0x7fffffff. NaN results | |
| 3236 in -0x80000000. | |
| 3237 Examples: > | |
| 3238 echo float2nr(3.95) | |
| 3239 < 3 > | |
| 3240 echo float2nr(-23.45) | |
| 3241 < -23 > | |
| 3242 echo float2nr(1.0e100) | |
| 3243 < 2147483647 > | |
| 3244 echo float2nr(-1.0e150) | |
| 3245 < -2147483647 > | |
| 3246 echo float2nr(1.0e-100) | |
| 3247 < 0 | |
| 3248 {only available when compiled with the |+float| feature} | |
| 3249 | |
| 3250 | |
| 3251 floor({expr}) *floor()* | |
| 3252 Return the largest integral value less than or equal to | |
| 3253 {expr} as a |Float| (round down). | |
| 3254 {expr} must evaluate to a |Float| or a |Number|. | |
| 3255 Examples: > | |
| 3256 echo floor(1.856) | |
| 3257 < 1.0 > | |
| 3258 echo floor(-5.456) | |
| 3259 < -6.0 > | |
| 3260 echo floor(4.0) | |
| 3261 < 4.0 | |
| 3262 {only available when compiled with the |+float| feature} | |
| 3263 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3264 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3265 fmod({expr1}, {expr2}) *fmod()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3266 Return the remainder of {expr1} / {expr2}, even if the |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3267 division is not representable. Returns {expr1} - i * {expr2} |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3268 for some integer i such that if {expr2} is non-zero, the |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3269 result has the same sign as {expr1} and magnitude less than |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3270 the magnitude of {expr2}. If {expr2} is zero, the value |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3271 returned is zero. The value returned is a |Float|. |
|
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3272 {expr1} and {expr2} must evaluate to a |Float| or a |Number|. |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3273 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3274 :echo fmod(12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3275 < 0.13 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3276 :echo fmod(-12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3277 < -0.13 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
3278 {only available when compiled with |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3279 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3280 |
| 1586 | 3281 fnameescape({string}) *fnameescape()* |
| 1621 | 3282 Escape {string} for use as file name command argument. All |
| 1586 | 3283 characters that have a special meaning, such as '%' and '|' |
| 3284 are escaped with a backslash. | |
| 1621 | 3285 For most systems the characters escaped are |
| 3286 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
| 3287 appears in a filename, it depends on the value of 'isfname'. | |
| 1700 | 3288 A leading '+' and '>' is also escaped (special after |:edit| |
| 3289 and |:write|). And a "-" by itself (special after |:cd|). | |
| 1586 | 3290 Example: > |
| 1700 | 3291 :let fname = '+some str%nge|name' |
| 1586 | 3292 :exe "edit " . fnameescape(fname) |
| 3293 < results in executing: > | |
| 1700 | 3294 edit \+some\ str\%nge\|name |
| 1586 | 3295 |
| 7 | 3296 fnamemodify({fname}, {mods}) *fnamemodify()* |
| 3297 Modify file name {fname} according to {mods}. {mods} is a | |
| 3298 string of characters like it is used for file names on the | |
| 3299 command line. See |filename-modifiers|. | |
| 3300 Example: > | |
| 3301 :echo fnamemodify("main.c", ":p:h") | |
| 3302 < results in: > | |
| 3303 /home/mool/vim/vim/src | |
| 1621 | 3304 < Note: Environment variables don't work in {fname}, use |
| 7 | 3305 |expand()| first then. |
| 3306 | |
| 3307 foldclosed({lnum}) *foldclosed()* | |
| 3308 The result is a Number. If the line {lnum} is in a closed | |
| 3309 fold, the result is the number of the first line in that fold. | |
| 3310 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 3311 | |
| 3312 foldclosedend({lnum}) *foldclosedend()* | |
| 3313 The result is a Number. If the line {lnum} is in a closed | |
| 3314 fold, the result is the number of the last line in that fold. | |
| 3315 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 3316 | |
| 3317 foldlevel({lnum}) *foldlevel()* | |
| 3318 The result is a Number, which is the foldlevel of line {lnum} | |
| 1621 | 3319 in the current buffer. For nested folds the deepest level is |
| 7 | 3320 returned. If there is no fold at line {lnum}, zero is |
| 3321 returned. It doesn't matter if the folds are open or closed. | |
| 3322 When used while updating folds (from 'foldexpr') -1 is | |
| 3323 returned for lines where folds are still to be updated and the | |
| 3324 foldlevel is unknown. As a special case the level of the | |
| 3325 previous line is usually available. | |
| 3326 | |
| 3327 *foldtext()* | |
| 3328 foldtext() Returns a String, to be displayed for a closed fold. This is | |
| 3329 the default function used for the 'foldtext' option and should | |
| 3330 only be called from evaluating 'foldtext'. It uses the | |
| 3331 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
| 3332 The returned string looks like this: > | |
| 3333 +-- 45 lines: abcdef | |
| 1621 | 3334 < The number of dashes depends on the foldlevel. The "45" is |
| 7 | 3335 the number of lines in the fold. "abcdef" is the text in the |
| 3336 first non-blank line of the fold. Leading white space, "//" | |
| 3337 or "/*" and the text from the 'foldmarker' and 'commentstring' | |
| 3338 options is removed. | |
| 3339 {not available when compiled without the |+folding| feature} | |
| 3340 | |
| 29 | 3341 foldtextresult({lnum}) *foldtextresult()* |
| 3342 Returns the text that is displayed for the closed fold at line | |
| 3343 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
| 3344 When there is no closed fold at {lnum} an empty string is | |
| 3345 returned. | |
| 3346 {lnum} is used like with |getline()|. Thus "." is the current | |
| 3347 line, "'m" mark m, etc. | |
| 3348 Useful when exporting folded text, e.g., to HTML. | |
| 3349 {not available when compiled without the |+folding| feature} | |
| 3350 | |
| 7 | 3351 *foreground()* |
| 1621 | 3352 foreground() Move the Vim window to the foreground. Useful when sent from |
| 7 | 3353 a client to a Vim server. |remote_send()| |
| 3354 On Win32 systems this might not work, the OS does not always | |
| 3355 allow a window to bring itself to the foreground. Use | |
| 3356 |remote_foreground()| instead. | |
| 3357 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 3358 Win32 console version} | |
| 3359 | |
| 82 | 3360 |
| 85 | 3361 function({name}) *function()* *E700* |
| 685 | 3362 Return a |Funcref| variable that refers to function {name}. |
| 55 | 3363 {name} can be a user defined function or an internal function. |
| 3364 | |
| 82 | 3365 |
| 3224 | 3366 garbagecollect([{atexit}]) *garbagecollect()* |
| 692 | 3367 Cleanup unused |Lists| and |Dictionaries| that have circular |
| 370 | 3368 references. There is hardly ever a need to invoke this |
| 3369 function, as it is automatically done when Vim runs out of | |
| 3370 memory or is waiting for the user to press a key after | |
| 3371 'updatetime'. Items without circular references are always | |
| 3372 freed when they become unused. | |
| 685 | 3373 This is useful if you have deleted a very big |List| and/or |
| 3374 |Dictionary| with circular references in a script that runs | |
| 3375 for a long time. | |
| 3224 | 3376 When the optional {atexit} argument is one, garbage |
| 1405 | 3377 collection will also be done when exiting Vim, if it wasn't |
| 3378 done before. This is useful when checking for memory leaks. | |
| 370 | 3379 |
| 140 | 3380 get({list}, {idx} [, {default}]) *get()* |
| 685 | 3381 Get item {idx} from |List| {list}. When this item is not |
| 82 | 3382 available return {default}. Return zero when {default} is |
| 3383 omitted. | |
| 102 | 3384 get({dict}, {key} [, {default}]) |
| 685 | 3385 Get item with key {key} from |Dictionary| {dict}. When this |
| 102 | 3386 item is not available return {default}. Return zero when |
| 3387 {default} is omitted. | |
| 3388 | |
| 435 | 3389 *getbufline()* |
| 3390 getbufline({expr}, {lnum} [, {end}]) | |
| 685 | 3391 Return a |List| with the lines starting from {lnum} to {end} |
| 3392 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
| 3393 |List| with only the line {lnum} is returned. | |
| 435 | 3394 |
| 3395 For the use of {expr}, see |bufname()| above. | |
| 3396 | |
| 448 | 3397 For {lnum} and {end} "$" can be used for the last line of the |
| 3398 buffer. Otherwise a number must be used. | |
| 435 | 3399 |
| 3400 When {lnum} is smaller than 1 or bigger than the number of | |
| 685 | 3401 lines in the buffer, an empty |List| is returned. |
| 435 | 3402 |
| 3403 When {end} is greater than the number of lines in the buffer, | |
| 3404 it is treated as {end} is set to the number of lines in the | |
| 685 | 3405 buffer. When {end} is before {lnum} an empty |List| is |
| 435 | 3406 returned. |
| 3407 | |
| 448 | 3408 This function works only for loaded buffers. For unloaded and |
| 685 | 3409 non-existing buffers, an empty |List| is returned. |
| 435 | 3410 |
| 3411 Example: > | |
| 3412 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
| 82 | 3413 |
| 4157 | 3414 getbufvar({expr}, {varname} [, {def}]) *getbufvar()* |
| 82 | 3415 The result is the value of option or local buffer variable |
| 3416 {varname} in buffer {expr}. Note that the name without "b:" | |
| 3417 must be used. | |
| 1668 | 3418 When {varname} is empty returns a dictionary with all the |
| 3419 buffer-local variables. | |
| 216 | 3420 This also works for a global or buffer-local option, but it |
| 3421 doesn't work for a global variable, window-local variable or | |
| 3422 window-local option. | |
| 82 | 3423 For the use of {expr}, see |bufname()| above. |
| 4157 | 3424 When the buffer or variable doesn't exist {def} or an empty |
| 3425 string is returned, there is no error message. | |
| 82 | 3426 Examples: > |
| 3427 :let bufmodified = getbufvar(1, "&mod") | |
| 3428 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
| 3429 < | |
| 7 | 3430 getchar([expr]) *getchar()* |
| 867 | 3431 Get a single character from the user or input stream. |
| 7 | 3432 If [expr] is omitted, wait until a character is available. |
| 3433 If [expr] is 0, only get a character when one is available. | |
| 867 | 3434 Return zero otherwise. |
| 7 | 3435 If [expr] is 1, only check if a character is available, it is |
| 867 | 3436 not consumed. Return zero if no character available. |
| 3437 | |
| 5555 | 3438 Without [expr] and when [expr] is 0 a whole character or |
| 867 | 3439 special key is returned. If it is an 8-bit character, the |
| 3440 result is a number. Use nr2char() to convert it to a String. | |
| 3441 Otherwise a String is returned with the encoded character. | |
| 3442 For a special key it's a sequence of bytes starting with 0x80 | |
| 872 | 3443 (decimal: 128). This is the same value as the string |
| 3444 "\<Key>", e.g., "\<Left>". The returned value is also a | |
| 3445 String when a modifier (shift, control, alt) was used that is | |
| 3446 not included in the character. | |
| 867 | 3447 |
| 5968 | 3448 When [expr] is 0 and Esc is typed, there will be a short delay |
| 3449 while Vim waits to see if this is the start of an escape | |
| 3450 sequence. | |
| 3451 | |
| 5555 | 3452 When [expr] is 1 only the first byte is returned. For a |
| 872 | 3453 one-byte character it is the character itself as a number. |
| 3454 Use nr2char() to convert it to a String. | |
| 867 | 3455 |
| 3224 | 3456 Use getcharmod() to obtain any additional modifiers. |
| 3457 | |
| 1029 | 3458 When the user clicks a mouse button, the mouse event will be |
| 3459 returned. The position can then be found in |v:mouse_col|, | |
| 3460 |v:mouse_lnum| and |v:mouse_win|. This example positions the | |
| 3461 mouse as it would normally happen: > | |
| 3462 let c = getchar() | |
| 1621 | 3463 if c == "\<LeftMouse>" && v:mouse_win > 0 |
| 1029 | 3464 exe v:mouse_win . "wincmd w" |
| 3465 exe v:mouse_lnum | |
| 3466 exe "normal " . v:mouse_col . "|" | |
| 3467 endif | |
| 3468 < | |
| 7 | 3469 There is no prompt, you will somehow have to make clear to the |
| 3470 user that a character has to be typed. | |
| 3471 There is no mapping for the character. | |
| 3472 Key codes are replaced, thus when the user presses the <Del> | |
| 3473 key you get the code for the <Del> key, not the raw character | |
| 3474 sequence. Examples: > | |
| 3475 getchar() == "\<Del>" | |
| 3476 getchar() == "\<S-Left>" | |
| 3477 < This example redefines "f" to ignore case: > | |
| 3478 :nmap f :call FindChar()<CR> | |
| 3479 :function FindChar() | |
| 3480 : let c = nr2char(getchar()) | |
| 3481 : while col('.') < col('$') - 1 | |
| 3482 : normal l | |
| 3483 : if getline('.')[col('.') - 1] ==? c | |
| 3484 : break | |
| 3485 : endif | |
| 3486 : endwhile | |
| 3487 :endfunction | |
| 6421 | 3488 < |
| 6647 | 3489 You may also receive synthetic characters, such as |
| 6421 | 3490 |<CursorHold>|. Often you will want to ignore this and get |
| 3491 another character: > | |
| 3492 :function GetKey() | |
| 3493 : let c = getchar() | |
| 3494 : while c == "\<CursorHold>" | |
| 3495 : let c = getchar() | |
| 3496 : endwhile | |
| 3497 : return c | |
| 3498 :endfunction | |
| 7 | 3499 |
| 3500 getcharmod() *getcharmod()* | |
| 3501 The result is a Number which is the state of the modifiers for | |
| 3502 the last obtained character with getchar() or in another way. | |
| 3503 These values are added together: | |
| 3504 2 shift | |
| 3505 4 control | |
| 3506 8 alt (meta) | |
| 3224 | 3507 16 meta (when it's different from ALT) |
| 3508 32 mouse double click | |
| 3509 64 mouse triple click | |
| 3510 96 mouse quadruple click (== 32 + 64) | |
| 3511 128 command (Macintosh only) | |
| 7 | 3512 Only the modifiers that have not been included in the |
| 1621 | 3513 character itself are obtained. Thus Shift-a results in "A" |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3514 without a modifier. |
| 7 | 3515 |
| 6991 | 3516 getcharsearch() *getcharsearch()* |
| 3517 Return the current character search information as a {dict} | |
| 3518 with the following entries: | |
| 3519 | |
| 3520 char character previously used for a character | |
| 3521 search (|t|, |f|, |T|, or |F|); empty string | |
| 3522 if no character search has been performed | |
| 3523 forward direction of character search; 1 for forward, | |
| 3524 0 for backward | |
| 3525 until type of character search; 1 for a |t| or |T| | |
| 3526 character search, 0 for an |f| or |F| | |
| 3527 character search | |
| 3528 | |
| 3529 This can be useful to always have |;| and |,| search | |
| 3530 forward/backward regardless of the direction of the previous | |
| 3531 character search: > | |
| 3532 :nnoremap <expr> ; getcharsearch().forward ? ';' : ',' | |
| 3533 :nnoremap <expr> , getcharsearch().forward ? ',' : ';' | |
| 3534 < Also see |setcharsearch()|. | |
| 3535 | |
| 7 | 3536 getcmdline() *getcmdline()* |
| 3537 Return the current command-line. Only works when the command | |
| 3538 line is being edited, thus requires use of |c_CTRL-\_e| or | |
| 3539 |c_CTRL-R_=|. | |
| 3540 Example: > | |
| 3541 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
| 531 | 3542 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
| 7 | 3543 |
| 95 | 3544 getcmdpos() *getcmdpos()* |
| 7 | 3545 Return the position of the cursor in the command line as a |
| 3546 byte count. The first column is 1. | |
| 3547 Only works when editing the command line, thus requires use of | |
| 3456 | 3548 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 3549 Returns 0 otherwise. | |
| 531 | 3550 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
| 3551 | |
| 3552 getcmdtype() *getcmdtype()* | |
| 3553 Return the current command-line type. Possible return values | |
| 3554 are: | |
| 532 | 3555 : normal Ex command |
| 3556 > debug mode command |debug-mode| | |
| 3557 / forward search command | |
| 3558 ? backward search command | |
| 3559 @ |input()| command | |
| 3560 - |:insert| or |:append| command | |
| 6213 | 3561 = |i_CTRL-R_=| |
| 531 | 3562 Only works when editing the command line, thus requires use of |
| 3456 | 3563 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 3564 Returns an empty string otherwise. | |
| 531 | 3565 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. |
| 7 | 3566 |
| 6153 | 3567 getcmdwintype() *getcmdwintype()* |
| 3568 Return the current |command-line-window| type. Possible return | |
| 3569 values are the same as |getcmdtype()|. Returns an empty string | |
| 3570 when not in the command-line window. | |
| 3571 | |
| 5944 | 3572 *getcurpos()* |
| 3573 getcurpos() Get the position of the cursor. This is like getpos('.'), but | |
| 3574 includes an extra item in the list: | |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
7593
diff
changeset
|
3575 [bufnum, lnum, col, off, curswant] ~ |
| 5944 | 3576 The "curswant" number is the preferred column when moving the |
| 3577 cursor vertically. | |
| 3578 This can be used to save and restore the cursor position: > | |
| 3579 let save_cursor = getcurpos() | |
| 3580 MoveTheCursorAround | |
| 3581 call setpos('.', save_cursor) | |
| 6153 | 3582 < |
| 7 | 3583 *getcwd()* |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3584 getcwd([{winnr} [, {tabnr}]]) |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3585 The result is a String, which is the name of the current |
| 7 | 3586 working directory. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3587 Without arguments, for the current window. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3588 |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3589 With {winnr} return the local current directory of this window |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3590 in the current tab page. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3591 With {winnr} and {tabnr} return the local current directory of |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3592 the window in the specified tab page. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3593 Return an empty string if the arguments are invalid. |
| 7 | 3594 |
| 3595 getfsize({fname}) *getfsize()* | |
| 3596 The result is a Number, which is the size in bytes of the | |
| 3597 given file {fname}. | |
| 3598 If {fname} is a directory, 0 is returned. | |
| 3599 If the file {fname} can't be found, -1 is returned. | |
| 1293 | 3600 If the size of {fname} is too big to fit in a Number then -2 |
| 3601 is returned. | |
| 7 | 3602 |
| 37 | 3603 getfontname([{name}]) *getfontname()* |
| 3604 Without an argument returns the name of the normal font being | |
| 3605 used. Like what is used for the Normal highlight group | |
| 3606 |hl-Normal|. | |
| 3607 With an argument a check is done whether {name} is a valid | |
| 3608 font name. If not then an empty string is returned. | |
| 3609 Otherwise the actual font name is returned, or {name} if the | |
| 3610 GUI does not support obtaining the real name. | |
| 824 | 3611 Only works when the GUI is running, thus not in your vimrc or |
| 819 | 3612 gvimrc file. Use the |GUIEnter| autocommand to use this |
| 3613 function just after the GUI has started. | |
| 37 | 3614 Note that the GTK 2 GUI accepts any font name, thus checking |
| 3615 for a valid name does not work. | |
| 3616 | |
| 20 | 3617 getfperm({fname}) *getfperm()* |
| 3618 The result is a String, which is the read, write, and execute | |
| 3619 permissions of the given file {fname}. | |
| 3620 If {fname} does not exist or its directory cannot be read, an | |
| 3621 empty string is returned. | |
| 3622 The result is of the form "rwxrwxrwx", where each group of | |
| 3623 "rwx" flags represent, in turn, the permissions of the owner | |
| 3624 of the file, the group the file belongs to, and other users. | |
| 3625 If a user does not have a given permission the flag for this | |
| 3750 | 3626 is replaced with the string "-". Examples: > |
| 20 | 3627 :echo getfperm("/etc/passwd") |
| 3750 | 3628 :echo getfperm(expand("~/.vimrc")) |
| 20 | 3629 < This will hopefully (from a security point of view) display |
| 3630 the string "rw-r--r--" or even "rw-------". | |
| 205 | 3631 |
| 7 | 3632 getftime({fname}) *getftime()* |
| 3633 The result is a Number, which is the last modification time of | |
| 3634 the given file {fname}. The value is measured as seconds | |
| 3635 since 1st Jan 1970, and may be passed to strftime(). See also | |
| 3636 |localtime()| and |strftime()|. | |
| 3637 If the file {fname} can't be found -1 is returned. | |
| 3638 | |
| 20 | 3639 getftype({fname}) *getftype()* |
| 3640 The result is a String, which is a description of the kind of | |
| 3641 file of the given file {fname}. | |
| 3642 If {fname} does not exist an empty string is returned. | |
| 3643 Here is a table over different kinds of files and their | |
| 3644 results: | |
| 3645 Normal file "file" | |
| 3646 Directory "dir" | |
| 3647 Symbolic link "link" | |
| 3648 Block device "bdev" | |
| 3649 Character device "cdev" | |
| 3650 Socket "socket" | |
| 3651 FIFO "fifo" | |
| 3652 All other "other" | |
| 3653 Example: > | |
| 3654 getftype("/home") | |
| 3655 < Note that a type such as "link" will only be returned on | |
| 3656 systems that support it. On some systems only "dir" and | |
|
7707
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
3657 "file" are returned. On MS-Windows a symbolic link to a |
|
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
3658 directory returns "dir" instead of "link". |
| 20 | 3659 |
| 7 | 3660 *getline()* |
| 82 | 3661 getline({lnum} [, {end}]) |
| 3662 Without {end} the result is a String, which is line {lnum} | |
| 3663 from the current buffer. Example: > | |
| 7 | 3664 getline(1) |
| 3665 < When {lnum} is a String that doesn't start with a | |
| 3666 digit, line() is called to translate the String into a Number. | |
| 3667 To get the line under the cursor: > | |
| 3668 getline(".") | |
| 3669 < When {lnum} is smaller than 1 or bigger than the number of | |
| 3670 lines in the buffer, an empty string is returned. | |
| 3671 | |
| 685 | 3672 When {end} is given the result is a |List| where each item is |
| 3673 a line from the current buffer in the range {lnum} to {end}, | |
| 82 | 3674 including line {end}. |
| 3675 {end} is used in the same way as {lnum}. | |
| 3676 Non-existing lines are silently omitted. | |
| 685 | 3677 When {end} is before {lnum} an empty |List| is returned. |
| 82 | 3678 Example: > |
| 3679 :let start = line('.') | |
| 3680 :let end = search("^$") - 1 | |
| 3681 :let lines = getline(start, end) | |
| 3682 | |
| 1156 | 3683 < To get lines from another buffer see |getbufline()| |
| 3684 | |
| 647 | 3685 getloclist({nr}) *getloclist()* |
| 3686 Returns a list with all the entries in the location list for | |
| 3687 window {nr}. When {nr} is zero the current window is used. | |
| 3688 For a location list window, the displayed location list is | |
| 648 | 3689 returned. For an invalid window number {nr}, an empty list is |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3690 returned. Otherwise, same as |getqflist()|. |
| 82 | 3691 |
| 1326 | 3692 getmatches() *getmatches()* |
| 3693 Returns a |List| with all matches previously defined by | |
| 3694 |matchadd()| and the |:match| commands. |getmatches()| is | |
| 3695 useful in combination with |setmatches()|, as |setmatches()| | |
| 3696 can restore a list of matches saved by |getmatches()|. | |
| 3697 Example: > | |
| 3698 :echo getmatches() | |
| 3699 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 3700 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 3701 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 3702 :let m = getmatches() | |
| 3703 :call clearmatches() | |
| 3704 :echo getmatches() | |
| 3705 < [] > | |
| 3706 :call setmatches(m) | |
| 3707 :echo getmatches() | |
| 3708 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 3709 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 3710 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 3711 :unlet m | |
| 3712 < | |
| 5968 | 3713 *getpid()* |
| 3714 getpid() Return a Number which is the process ID of the Vim process. | |
| 3715 On Unix and MS-Windows this is a unique number, until Vim | |
| 3716 exits. On MS-DOS it's always zero. | |
| 3717 | |
| 3718 *getpos()* | |
| 3719 getpos({expr}) Get the position for {expr}. For possible values of {expr} | |
| 3720 see |line()|. For getting the cursor position see | |
| 3721 |getcurpos()|. | |
| 3722 The result is a |List| with four numbers: | |
| 3723 [bufnum, lnum, col, off] | |
| 3724 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
| 3725 is the buffer number of the mark. | |
| 3726 "lnum" and "col" are the position in the buffer. The first | |
| 3727 column is 1. | |
| 3728 The "off" number is zero, unless 'virtualedit' is used. Then | |
| 3729 it is the offset in screen columns from the start of the | |
| 3730 character. E.g., a position within a <Tab> or after the last | |
| 3731 character. | |
| 3732 Note that for '< and '> Visual mode matters: when it is "V" | |
| 3733 (visual line mode) the column of '< is zero and the column of | |
| 3734 '> is a large number. | |
| 3735 This can be used to save and restore the position of a mark: > | |
| 3736 let save_a_mark = getpos("'a") | |
| 3737 ... | |
| 6421 | 3738 call setpos("'a", save_a_mark) |
| 5968 | 3739 < Also see |getcurpos()| and |setpos()|. |
| 3740 | |
| 1326 | 3741 |
| 230 | 3742 getqflist() *getqflist()* |
| 3743 Returns a list with all the current quickfix errors. Each | |
| 3744 list item is a dictionary with these entries: | |
| 3745 bufnr number of buffer that has the file name, use | |
| 3746 bufname() to get the name | |
| 3747 lnum line number in the buffer (first line is 1) | |
| 3748 col column number (first column is 1) | |
| 233 | 3749 vcol non-zero: "col" is visual column |
| 3750 zero: "col" is byte index | |
| 230 | 3751 nr error number |
| 1065 | 3752 pattern search pattern used to locate the error |
| 230 | 3753 text description of the error |
| 3754 type type of the error, 'E', '1', etc. | |
| 3755 valid non-zero: recognized error message | |
| 3756 | |
| 515 | 3757 When there is no error list or it's empty an empty list is |
| 1065 | 3758 returned. Quickfix list entries with non-existing buffer |
| 3759 number are returned with "bufnr" set to zero. | |
| 515 | 3760 |
| 230 | 3761 Useful application: Find pattern matches in multiple files and |
| 3762 do something with them: > | |
| 3763 :vimgrep /theword/jg *.c | |
| 3764 :for d in getqflist() | |
| 3765 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
| 3766 :endfor | |
| 3767 | |
| 3768 | |
| 5796 | 3769 getreg([{regname} [, 1 [, {list}]]]) *getreg()* |
| 7 | 3770 The result is a String, which is the contents of register |
| 236 | 3771 {regname}. Example: > |
| 7 | 3772 :let cliptext = getreg('*') |
| 3773 < getreg('=') returns the last evaluated value of the expression | |
| 236 | 3774 register. (For use in maps.) |
| 282 | 3775 getreg('=', 1) returns the expression itself, so that it can |
| 3776 be restored with |setreg()|. For other registers the extra | |
| 3777 argument is ignored, thus you can always give it. | |
| 5796 | 3778 If {list} is present and non-zero result type is changed to |
| 3779 |List|. Each list item is one text line. Use it if you care | |
| 3780 about zero bytes possibly present inside register: without | |
| 3781 third argument both NLs and zero bytes are represented as NLs | |
| 3782 (see |NL-used-for-Nul|). | |
| 7 | 3783 If {regname} is not specified, |v:register| is used. |
| 3784 | |
| 82 | 3785 |
| 7 | 3786 getregtype([{regname}]) *getregtype()* |
| 3787 The result is a String, which is type of register {regname}. | |
| 3788 The value will be one of: | |
| 3789 "v" for |characterwise| text | |
| 3790 "V" for |linewise| text | |
| 3791 "<CTRL-V>{width}" for |blockwise-visual| text | |
| 5596 | 3792 "" for an empty or unknown register |
| 7 | 3793 <CTRL-V> is one character with value 0x16. |
| 3794 If {regname} is not specified, |v:register| is used. | |
| 3795 | |
| 4157 | 3796 gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()* |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3797 Get the value of a tab-local variable {varname} in tab page |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3798 {tabnr}. |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3799 Tabs are numbered starting with one. |
| 6197 | 3800 When {varname} is empty a dictionary with all tab-local |
| 3801 variables is returned. | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3802 Note that the name without "t:" must be used. |
| 4157 | 3803 When the tab or variable doesn't exist {def} or an empty |
| 3804 string is returned, there is no error message. | |
| 3805 | |
| 3806 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()* | |
| 1156 | 3807 Get the value of window-local variable {varname} in window |
| 3808 {winnr} in tab page {tabnr}. | |
| 3809 When {varname} starts with "&" get the value of a window-local | |
| 3810 option. | |
| 4157 | 3811 When {varname} is empty a dictionary with all window-local |
| 3812 variables is returned. | |
| 3813 Note that {varname} must be the name without "w:". | |
| 831 | 3814 Tabs are numbered starting with one. For the current tabpage |
| 3815 use |getwinvar()|. | |
| 3816 When {winnr} is zero the current window is used. | |
| 3817 This also works for a global option, buffer-local option and | |
| 3818 window-local option, but it doesn't work for a global variable | |
| 3819 or buffer-local variable. | |
| 4157 | 3820 When the tab, window or variable doesn't exist {def} or an |
| 3821 empty string is returned, there is no error message. | |
| 831 | 3822 Examples: > |
| 3823 :let list_is_on = gettabwinvar(1, 2, '&list') | |
| 3824 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
| 1266 | 3825 < |
| 7 | 3826 *getwinposx()* |
| 3827 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
| 3828 the left hand side of the GUI Vim window. The result will be | |
| 3829 -1 if the information is not available. | |
| 3830 | |
| 3831 *getwinposy()* | |
| 3832 getwinposy() The result is a Number, which is the Y coordinate in pixels of | |
| 1621 | 3833 the top of the GUI Vim window. The result will be -1 if the |
| 7 | 3834 information is not available. |
| 3835 | |
| 4157 | 3836 getwinvar({winnr}, {varname} [, {def}]) *getwinvar()* |
| 831 | 3837 Like |gettabwinvar()| for the current tabpage. |
| 7 | 3838 Examples: > |
| 3839 :let list_is_on = getwinvar(2, '&list') | |
| 3840 :echo "myvar = " . getwinvar(1, 'myvar') | |
| 3841 < | |
| 6663 | 3842 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()* |
| 1754 | 3843 Expand the file wildcards in {expr}. See |wildcards| for the |
| 1156 | 3844 use of special characters. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3845 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3846 Unless the optional {nosuf} argument is given and is non-zero, |
| 1754 | 3847 the 'suffixes' and 'wildignore' options apply: Names matching |
| 3848 one of the patterns in 'wildignore' will be skipped and | |
| 3849 'suffixes' affect the ordering of matches. | |
| 2662 | 3850 'wildignorecase' always applies. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3851 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3852 When {list} is present and it is non-zero the result is a List |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3853 with all matching files. The advantage of using a List is, |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3854 you also get filenames containing newlines correctly. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3855 Otherwise the result is a String and when there are several |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3856 matches, they are separated by <NL> characters. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3857 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3858 If the expansion fails, the result is an empty String or List. |
| 6663 | 3859 |
| 3445 | 3860 A name for a non-existing file is not included. A symbolic |
| 3861 link is only included if it points to an existing file. | |
| 6663 | 3862 However, when the {alllinks} argument is present and it is |
| 3863 non-zero then all symbolic links are included. | |
| 7 | 3864 |
| 3865 For most systems backticks can be used to get files names from | |
| 3866 any external command. Example: > | |
| 3867 :let tagfiles = glob("`find . -name tags -print`") | |
| 3868 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
| 3869 < The result of the program inside the backticks should be one | |
| 1621 | 3870 item per line. Spaces inside an item are allowed. |
| 7 | 3871 |
| 3872 See |expand()| for expanding special Vim variables. See | |
| 3873 |system()| for getting the raw output of an external command. | |
| 3874 | |
| 6697 | 3875 glob2regpat({expr}) *glob2regpat()* |
| 3876 Convert a file pattern, as used by glob(), into a search | |
| 3877 pattern. The result can be used to match with a string that | |
| 3878 is a file name. E.g. > | |
| 3879 if filename =~ glob2regpat('Make*.mak') | |
| 3880 < This is equivalent to: > | |
| 3881 if filename =~ '^Make.*\.mak$' | |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3882 < When {expr} is an empty string the result is "^$", match an |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3883 empty string. |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3884 |
| 6663 | 3885 *globpath()* |
| 3886 globpath({path}, {expr} [, {nosuf} [, {list} [, {allinks}]]]) | |
| 7 | 3887 Perform glob() on all directories in {path} and concatenate |
| 3888 the results. Example: > | |
| 3889 :echo globpath(&rtp, "syntax/c.vim") | |
| 5873 | 3890 < |
| 3891 {path} is a comma-separated list of directory names. Each | |
| 7 | 3892 directory name is prepended to {expr} and expanded like with |
| 1754 | 3893 |glob()|. A path separator is inserted when needed. |
| 7 | 3894 To add a comma inside a directory name escape it with a |
| 3895 backslash. Note that on MS-Windows a directory may have a | |
| 3896 trailing backslash, remove it if you put a comma after it. | |
| 3897 If the expansion fails for one of the directories, there is no | |
| 3898 error message. | |
| 5873 | 3899 |
| 3900 Unless the optional {nosuf} argument is given and is non-zero, | |
| 1754 | 3901 the 'suffixes' and 'wildignore' options apply: Names matching |
| 3902 one of the patterns in 'wildignore' will be skipped and | |
| 3903 'suffixes' affect the ordering of matches. | |
| 7 | 3904 |
| 5873 | 3905 When {list} is present and it is non-zero the result is a List |
| 3906 with all matching files. The advantage of using a List is, you | |
| 3907 also get filenames containing newlines correctly. Otherwise | |
| 3908 the result is a String and when there are several matches, | |
| 3909 they are separated by <NL> characters. Example: > | |
| 3910 :echo globpath(&rtp, "syntax/c.vim", 0, 1) | |
| 3911 < | |
| 6663 | 3912 {allinks} is used as with |glob()|. |
| 3913 | |
| 444 | 3914 The "**" item can be used to search in a directory tree. |
| 3915 For example, to find all "README.txt" files in the directories | |
| 3916 in 'runtimepath' and below: > | |
| 3917 :echo globpath(&rtp, "**/README.txt") | |
| 1668 | 3918 < Upwards search and limiting the depth of "**" is not |
| 3919 supported, thus using 'path' will not always work properly. | |
| 3920 | |
| 7 | 3921 *has()* |
| 3922 has({feature}) The result is a Number, which is 1 if the feature {feature} is | |
| 3923 supported, zero otherwise. The {feature} argument is a | |
| 3924 string. See |feature-list| below. | |
| 3925 Also see |exists()|. | |
| 3926 | |
| 102 | 3927 |
| 3928 has_key({dict}, {key}) *has_key()* | |
| 685 | 3929 The result is a Number, which is 1 if |Dictionary| {dict} has |
| 3930 an entry with key {key}. Zero otherwise. | |
| 102 | 3931 |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3932 haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()* |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3933 The result is a Number, which is 1 when the window has set a |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3934 local path via |:lcd|, and 0 otherwise. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3935 |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3936 Without arguments use the current window. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3937 With {winnr} use this window in the current tab page. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3938 With {winnr} and {tabnr} use the window in the specified tab |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3939 page. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
3940 Return 0 if the arguments are invalid. |
| 102 | 3941 |
| 782 | 3942 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
| 7 | 3943 The result is a Number, which is 1 if there is a mapping that |
| 3944 contains {what} in somewhere in the rhs (what it is mapped to) | |
| 3945 and this mapping exists in one of the modes indicated by | |
| 3946 {mode}. | |
| 782 | 3947 When {abbr} is there and it is non-zero use abbreviations |
| 786 | 3948 instead of mappings. Don't forget to specify Insert and/or |
| 3949 Command-line mode. | |
| 7 | 3950 Both the global mappings and the mappings local to the current |
| 3951 buffer are checked for a match. | |
| 3952 If no matching mapping is found 0 is returned. | |
| 3953 The following characters are recognized in {mode}: | |
| 3954 n Normal mode | |
| 3955 v Visual mode | |
| 3956 o Operator-pending mode | |
| 3957 i Insert mode | |
| 3958 l Language-Argument ("r", "f", "t", etc.) | |
| 3959 c Command-line mode | |
| 3960 When {mode} is omitted, "nvo" is used. | |
| 3961 | |
| 3962 This function is useful to check if a mapping already exists | |
| 1621 | 3963 to a function in a Vim script. Example: > |
| 7 | 3964 :if !hasmapto('\ABCdoit') |
| 3965 : map <Leader>d \ABCdoit | |
| 3966 :endif | |
| 3967 < This installs the mapping to "\ABCdoit" only if there isn't | |
| 3968 already a mapping to "\ABCdoit". | |
| 3969 | |
| 3970 histadd({history}, {item}) *histadd()* | |
| 3971 Add the String {item} to the history {history} which can be | |
| 3972 one of: *hist-names* | |
| 3973 "cmd" or ":" command line history | |
| 3974 "search" or "/" search pattern history | |
| 1621 | 3975 "expr" or "=" typed expression history |
| 7 | 3976 "input" or "@" input line history |
| 3682 | 3977 "debug" or ">" debug command history |
| 3978 The {history} string does not need to be the whole name, one | |
| 3979 character is sufficient. | |
| 7 | 3980 If {item} does already exist in the history, it will be |
| 3981 shifted to become the newest entry. | |
| 3982 The result is a Number: 1 if the operation was successful, | |
| 3983 otherwise 0 is returned. | |
| 3984 | |
| 3985 Example: > | |
| 3986 :call histadd("input", strftime("%Y %b %d")) | |
| 3987 :let date=input("Enter date: ") | |
| 3988 < This function is not available in the |sandbox|. | |
| 3989 | |
| 3990 histdel({history} [, {item}]) *histdel()* | |
| 236 | 3991 Clear {history}, i.e. delete all its entries. See |hist-names| |
| 7 | 3992 for the possible values of {history}. |
| 3993 | |
| 1668 | 3994 If the parameter {item} evaluates to a String, it is used as a |
| 3995 regular expression. All entries matching that expression will | |
| 3996 be removed from the history (if there are any). | |
| 7 | 3997 Upper/lowercase must match, unless "\c" is used |/\c|. |
| 1668 | 3998 If {item} evaluates to a Number, it will be interpreted as |
| 3999 an index, see |:history-indexing|. The respective entry will | |
| 4000 be removed if it exists. | |
| 7 | 4001 |
| 4002 The result is a Number: 1 for a successful operation, | |
| 4003 otherwise 0 is returned. | |
| 4004 | |
| 4005 Examples: | |
| 4006 Clear expression register history: > | |
| 4007 :call histdel("expr") | |
| 4008 < | |
| 4009 Remove all entries starting with "*" from the search history: > | |
| 4010 :call histdel("/", '^\*') | |
| 4011 < | |
| 4012 The following three are equivalent: > | |
| 4013 :call histdel("search", histnr("search")) | |
| 4014 :call histdel("search", -1) | |
| 4015 :call histdel("search", '^'.histget("search", -1).'$') | |
| 4016 < | |
| 4017 To delete the last search pattern and use the last-but-one for | |
| 4018 the "n" command and 'hlsearch': > | |
| 4019 :call histdel("search", -1) | |
| 4020 :let @/ = histget("search", -1) | |
| 4021 | |
| 4022 histget({history} [, {index}]) *histget()* | |
| 4023 The result is a String, the entry with Number {index} from | |
| 4024 {history}. See |hist-names| for the possible values of | |
| 4025 {history}, and |:history-indexing| for {index}. If there is | |
| 4026 no such entry, an empty String is returned. When {index} is | |
| 4027 omitted, the most recent item from the history is used. | |
| 4028 | |
| 4029 Examples: | |
| 4030 Redo the second last search from history. > | |
| 4031 :execute '/' . histget("search", -2) | |
| 4032 | |
| 4033 < Define an Ex command ":H {num}" that supports re-execution of | |
| 4034 the {num}th entry from the output of |:history|. > | |
| 4035 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
| 4036 < | |
| 4037 histnr({history}) *histnr()* | |
| 4038 The result is the Number of the current entry in {history}. | |
| 4039 See |hist-names| for the possible values of {history}. | |
| 4040 If an error occurred, -1 is returned. | |
| 4041 | |
| 4042 Example: > | |
| 4043 :let inp_index = histnr("expr") | |
| 4044 < | |
| 4045 hlexists({name}) *hlexists()* | |
| 4046 The result is a Number, which is non-zero if a highlight group | |
| 4047 called {name} exists. This is when the group has been | |
| 4048 defined in some way. Not necessarily when highlighting has | |
| 4049 been defined for it, it may also have been used for a syntax | |
| 4050 item. | |
| 4051 *highlight_exists()* | |
| 4052 Obsolete name: highlight_exists(). | |
| 4053 | |
| 4054 *hlID()* | |
| 4055 hlID({name}) The result is a Number, which is the ID of the highlight group | |
| 4056 with name {name}. When the highlight group doesn't exist, | |
| 4057 zero is returned. | |
| 4058 This can be used to retrieve information about the highlight | |
| 1621 | 4059 group. For example, to get the background color of the |
| 7 | 4060 "Comment" group: > |
| 4061 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
| 4062 < *highlightID()* | |
| 4063 Obsolete name: highlightID(). | |
| 4064 | |
| 4065 hostname() *hostname()* | |
| 4066 The result is a String, which is the name of the machine on | |
| 236 | 4067 which Vim is currently running. Machine names greater than |
| 7 | 4068 256 characters long are truncated. |
| 4069 | |
| 4070 iconv({expr}, {from}, {to}) *iconv()* | |
| 4071 The result is a String, which is the text {expr} converted | |
| 4072 from encoding {from} to encoding {to}. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4073 When the conversion completely fails an empty string is |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4074 returned. When some characters could not be converted they |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4075 are replaced with "?". |
| 7 | 4076 The encoding names are whatever the iconv() library function |
| 4077 can accept, see ":!man 3 iconv". | |
| 4078 Most conversions require Vim to be compiled with the |+iconv| | |
| 4079 feature. Otherwise only UTF-8 to latin1 conversion and back | |
| 4080 can be done. | |
| 4081 This can be used to display messages with special characters, | |
| 4082 no matter what 'encoding' is set to. Write the message in | |
| 4083 UTF-8 and use: > | |
| 4084 echo iconv(utf8_str, "utf-8", &enc) | |
| 4085 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
| 4086 from/to UCS-2 is automatically changed to use UTF-8. You | |
| 4087 cannot use UCS-2 in a string anyway, because of the NUL bytes. | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
4088 {only available when compiled with the |+multi_byte| feature} |
| 7 | 4089 |
| 4090 *indent()* | |
| 4091 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
| 4092 current buffer. The indent is counted in spaces, the value | |
| 4093 of 'tabstop' is relevant. {lnum} is used just like in | |
| 4094 |getline()|. | |
| 4095 When {lnum} is invalid -1 is returned. | |
| 4096 | |
| 79 | 4097 |
| 95 | 4098 index({list}, {expr} [, {start} [, {ic}]]) *index()* |
| 685 | 4099 Return the lowest index in |List| {list} where the item has a |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4100 value equal to {expr}. There is no automatic conversion, so |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4101 the String "4" is different from the Number 4. And the number |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4102 4 is different from the Float 4.0. The value of 'ignorecase' |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4103 is not used here, case always matters. |
| 153 | 4104 If {start} is given then start looking at the item with index |
| 4105 {start} (may be negative for an item relative to the end). | |
| 79 | 4106 When {ic} is given and it is non-zero, ignore case. Otherwise |
| 4107 case must match. | |
| 4108 -1 is returned when {expr} is not found in {list}. | |
| 4109 Example: > | |
| 4110 :let idx = index(words, "the") | |
| 87 | 4111 :if index(numbers, 123) >= 0 |
| 79 | 4112 |
| 4113 | |
| 531 | 4114 input({prompt} [, {text} [, {completion}]]) *input()* |
| 7 | 4115 The result is a String, which is whatever the user typed on |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4116 the command-line. The {prompt} argument is either a prompt |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4117 string, or a blank string (for no prompt). A '\n' can be used |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4118 in the prompt to start a new line. |
| 531 | 4119 The highlighting set with |:echohl| is used for the prompt. |
| 4120 The input is entered just like a command-line, with the same | |
| 1621 | 4121 editing commands and mappings. There is a separate history |
| 531 | 4122 for lines typed for input(). |
| 4123 Example: > | |
| 4124 :if input("Coffee or beer? ") == "beer" | |
| 4125 : echo "Cheers!" | |
| 4126 :endif | |
| 4127 < | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4128 If the optional {text} argument is present and not empty, this |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4129 is used for the default reply, as if the user typed this. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4130 Example: > |
| 531 | 4131 :let color = input("Color? ", "white") |
| 4132 | |
| 4133 < The optional {completion} argument specifies the type of | |
| 4134 completion supported for the input. Without it completion is | |
| 1621 | 4135 not performed. The supported completion types are the same as |
| 531 | 4136 that can be supplied to a user-defined command using the |
| 1621 | 4137 "-complete=" argument. Refer to |:command-completion| for |
| 531 | 4138 more information. Example: > |
| 4139 let fname = input("File: ", "", "file") | |
| 4140 < | |
| 4141 NOTE: This function must not be used in a startup file, for | |
| 4142 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
| 7 | 4143 Note: When input() is called from within a mapping it will |
| 4144 consume remaining characters from that mapping, because a | |
| 4145 mapping is handled like the characters were typed. | |
| 4146 Use |inputsave()| before input() and |inputrestore()| | |
| 4147 after input() to avoid that. Another solution is to avoid | |
| 4148 that further characters follow in the mapping, e.g., by using | |
| 4149 |:execute| or |:normal|. | |
| 4150 | |
| 531 | 4151 Example with a mapping: > |
| 7 | 4152 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
| 4153 :function GetFoo() | |
| 4154 : call inputsave() | |
| 4155 : let g:Foo = input("enter search pattern: ") | |
| 4156 : call inputrestore() | |
| 4157 :endfunction | |
| 4158 | |
| 4159 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4160 Like |input()|, but when the GUI is running and text dialogs |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4161 are supported, a dialog window pops up to input the text. |
| 7 | 4162 Example: > |
| 3875 | 4163 :let n = inputdialog("value for shiftwidth", shiftwidth()) |
| 4164 :if n != "" | |
| 4165 : let &sw = n | |
| 4166 :endif | |
| 7 | 4167 < When the dialog is cancelled {cancelreturn} is returned. When |
| 4168 omitted an empty string is returned. | |
| 4169 Hitting <Enter> works like pressing the OK button. Hitting | |
| 4170 <Esc> works like pressing the Cancel button. | |
| 531 | 4171 NOTE: Command-line completion is not supported. |
| 7 | 4172 |
| 519 | 4173 inputlist({textlist}) *inputlist()* |
| 819 | 4174 {textlist} must be a |List| of strings. This |List| is |
| 4175 displayed, one string per line. The user will be prompted to | |
| 4176 enter a number, which is returned. | |
| 519 | 4177 The user can also select an item by clicking on it with the |
| 1621 | 4178 mouse. For the first string 0 is returned. When clicking |
| 519 | 4179 above the first item a negative number is returned. When |
| 4180 clicking on the prompt one more than the length of {textlist} | |
| 4181 is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4182 Make sure {textlist} has less than 'lines' entries, otherwise |
| 1621 | 4183 it won't work. It's a good idea to put the entry number at |
| 1156 | 4184 the start of the string. And put a prompt in the first item. |
| 4185 Example: > | |
| 519 | 4186 let color = inputlist(['Select color:', '1. red', |
| 4187 \ '2. green', '3. blue']) | |
| 4188 | |
| 7 | 4189 inputrestore() *inputrestore()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4190 Restore typeahead that was saved with a previous |inputsave()|. |
| 7 | 4191 Should be called the same number of times inputsave() is |
| 4192 called. Calling it more often is harmless though. | |
| 4193 Returns 1 when there is nothing to restore, 0 otherwise. | |
| 4194 | |
| 4195 inputsave() *inputsave()* | |
| 4196 Preserve typeahead (also from mappings) and clear it, so that | |
| 4197 a following prompt gets input from the user. Should be | |
| 4198 followed by a matching inputrestore() after the prompt. Can | |
| 4199 be used several times, in which case there must be just as | |
| 4200 many inputrestore() calls. | |
| 4201 Returns 1 when out of memory, 0 otherwise. | |
| 4202 | |
| 4203 inputsecret({prompt} [, {text}]) *inputsecret()* | |
| 4204 This function acts much like the |input()| function with but | |
| 4205 two exceptions: | |
| 4206 a) the user's response will be displayed as a sequence of | |
| 4207 asterisks ("*") thereby keeping the entry secret, and | |
| 4208 b) the user's response will not be recorded on the input | |
| 4209 |history| stack. | |
| 4210 The result is a String, which is whatever the user actually | |
| 4211 typed on the command-line in response to the issued prompt. | |
| 531 | 4212 NOTE: Command-line completion is not supported. |
| 7 | 4213 |
| 55 | 4214 insert({list}, {item} [, {idx}]) *insert()* |
| 685 | 4215 Insert {item} at the start of |List| {list}. |
| 55 | 4216 If {idx} is specified insert {item} before the item with index |
| 1621 | 4217 {idx}. If {idx} is zero it goes before the first item, just |
| 55 | 4218 like omitting {idx}. A negative {idx} is also possible, see |
| 4219 |list-index|. -1 inserts just before the last item. | |
| 685 | 4220 Returns the resulting |List|. Examples: > |
| 55 | 4221 :let mylist = insert([2, 3, 5], 1) |
| 4222 :call insert(mylist, 4, -1) | |
| 4223 :call insert(mylist, 6, len(mylist)) | |
| 82 | 4224 < The last example can be done simpler with |add()|. |
| 685 | 4225 Note that when {item} is a |List| it is inserted as a single |
| 692 | 4226 item. Use |extend()| to concatenate |Lists|. |
| 55 | 4227 |
| 3214 | 4228 invert({expr}) *invert()* |
| 4229 Bitwise invert. The argument is converted to a number. A | |
| 4230 List, Dict or Float argument causes an error. Example: > | |
| 4231 :let bits = invert(bits) | |
| 4232 | |
| 7 | 4233 isdirectory({directory}) *isdirectory()* |
| 4234 The result is a Number, which is non-zero when a directory | |
| 4235 with the name {directory} exists. If {directory} doesn't | |
| 4236 exist, or isn't a directory, the result is FALSE. {directory} | |
| 4237 is any expression, which is used as a String. | |
| 4238 | |
| 819 | 4239 islocked({expr}) *islocked()* *E786* |
| 148 | 4240 The result is a Number, which is non-zero when {expr} is the |
| 4241 name of a locked variable. | |
| 685 | 4242 {expr} must be the name of a variable, |List| item or |
| 4243 |Dictionary| entry, not the variable itself! Example: > | |
| 148 | 4244 :let alist = [0, ['a', 'b'], 2, 3] |
| 4245 :lockvar 1 alist | |
| 4246 :echo islocked('alist') " 1 | |
| 4247 :echo islocked('alist[1]') " 0 | |
| 4248 | |
| 4249 < When {expr} is a variable that does not exist you get an error | |
| 843 | 4250 message. Use |exists()| to check for existence. |
| 148 | 4251 |
| 140 | 4252 items({dict}) *items()* |
| 685 | 4253 Return a |List| with all the key-value pairs of {dict}. Each |
| 4254 |List| item is a list with two items: the key of a {dict} | |
| 4255 entry and the value of this entry. The |List| is in arbitrary | |
| 4256 order. | |
| 140 | 4257 |
| 95 | 4258 |
| 4259 join({list} [, {sep}]) *join()* | |
| 4260 Join the items in {list} together into one String. | |
| 4261 When {sep} is specified it is put in between the items. If | |
| 4262 {sep} is omitted a single space is used. | |
| 4263 Note that {sep} is not added at the end. You might want to | |
| 4264 add it there too: > | |
| 4265 let lines = join(mylist, "\n") . "\n" | |
| 692 | 4266 < String items are used as-is. |Lists| and |Dictionaries| are |
| 95 | 4267 converted into a string like with |string()|. |
| 4268 The opposite function is |split()|. | |
| 4269 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4270 jsondecode({string}) *jsondecode()* |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4271 This parses a JSON formatted string and returns the equivalent |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4272 in Vim values. See |jsonencode()| for the relation between |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4273 JSON and Vim values. |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4274 The decoding is permissive: |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4275 - A trailing comma in an array and object is ignored. |
|
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
4276 - An empty item in an array, two commas with nothing or white |
|
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
4277 space in between, results in v:none. |
|
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
4278 - When an object member name is not a string it is converted |
|
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
4279 to a string. E.g. the number 123 is used as the string |
|
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
4280 "123". |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4281 - More floating point numbers are recognized, e.g. "1." for |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4282 "1.0". |
|
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
4283 The result must be a valid Vim type: |
|
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
4284 - An empty object member name is not allowed. |
|
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
4285 - Duplicate object member names are not allowed. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4286 |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4287 jsonencode({expr}) *jsonencode()* |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4288 Encode {expr} as JSON and return this as a string. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4289 The encoding is specified in: |
|
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
4290 https://tools.ietf.org/html/rfc7159.html |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4291 Vim values are converted as follows: |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4292 Number decimal number |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4293 Float floating point number |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4294 String in double quotes (possibly null) |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4295 Funcref not possible, error |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4296 List as an array (possibly null); when |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4297 used recursively: [] |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4298 Dict as an object (possibly null); when |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4299 used recursively: {} |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4300 v:false "false" |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4301 v:true "true" |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4302 v:none nothing |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4303 v:null "null" |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4304 Note that using v:none is permitted, although the JSON |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4305 standard does not allow empty items. This can be useful for |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4306 omitting items in an array: |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4307 [0,,,,,5] ~ |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4308 This is much more efficient than: |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4309 [0,null,null,null,null,5] ~ |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
4310 But a strict JSON parser will not accept it. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
4311 |
| 99 | 4312 keys({dict}) *keys()* |
| 685 | 4313 Return a |List| with all the keys of {dict}. The |List| is in |
| 99 | 4314 arbitrary order. |
| 4315 | |
| 85 | 4316 *len()* *E701* |
| 55 | 4317 len({expr}) The result is a Number, which is the length of the argument. |
| 4318 When {expr} is a String or a Number the length in bytes is | |
| 4319 used, as with |strlen()|. | |
| 685 | 4320 When {expr} is a |List| the number of items in the |List| is |
| 55 | 4321 returned. |
| 685 | 4322 When {expr} is a |Dictionary| the number of entries in the |
| 4323 |Dictionary| is returned. | |
| 55 | 4324 Otherwise an error is given. |
| 4325 | |
| 7 | 4326 *libcall()* *E364* *E368* |
| 4327 libcall({libname}, {funcname}, {argument}) | |
| 4328 Call function {funcname} in the run-time library {libname} | |
| 4329 with single argument {argument}. | |
| 4330 This is useful to call functions in a library that you | |
| 4331 especially made to be used with Vim. Since only one argument | |
| 4332 is possible, calling standard library functions is rather | |
| 4333 limited. | |
| 4334 The result is the String returned by the function. If the | |
| 4335 function returns NULL, this will appear as an empty string "" | |
| 4336 to Vim. | |
| 4337 If the function returns a number, use libcallnr()! | |
| 4338 If {argument} is a number, it is passed to the function as an | |
| 4339 int; if {argument} is a string, it is passed as a | |
| 4340 null-terminated string. | |
| 4341 This function will fail in |restricted-mode|. | |
| 4342 | |
| 4343 libcall() allows you to write your own 'plug-in' extensions to | |
| 4344 Vim without having to recompile the program. It is NOT a | |
| 4345 means to call system functions! If you try to do so Vim will | |
| 4346 very probably crash. | |
| 4347 | |
| 4348 For Win32, the functions you write must be placed in a DLL | |
| 4349 and use the normal C calling convention (NOT Pascal which is | |
| 4350 used in Windows System DLLs). The function must take exactly | |
| 4351 one parameter, either a character pointer or a long integer, | |
| 4352 and must return a character pointer or NULL. The character | |
| 4353 pointer returned must point to memory that will remain valid | |
| 4354 after the function has returned (e.g. in static data in the | |
| 4355 DLL). If it points to allocated memory, that memory will | |
| 4356 leak away. Using a static buffer in the function should work, | |
| 4357 it's then freed when the DLL is unloaded. | |
| 4358 | |
| 4359 WARNING: If the function returns a non-valid pointer, Vim may | |
| 1621 | 4360 crash! This also happens if the function returns a number, |
| 7 | 4361 because Vim thinks it's a pointer. |
| 4362 For Win32 systems, {libname} should be the filename of the DLL | |
| 4363 without the ".DLL" suffix. A full path is only required if | |
| 4364 the DLL is not in the usual places. | |
| 4365 For Unix: When compiling your own plugins, remember that the | |
| 4366 object code must be compiled as position-independent ('PIC'). | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4367 {only in Win32 and some Unix versions, when the |+libcall| |
| 7 | 4368 feature is present} |
| 4369 Examples: > | |
| 4370 :echo libcall("libc.so", "getenv", "HOME") | |
| 4371 < | |
| 4372 *libcallnr()* | |
| 4373 libcallnr({libname}, {funcname}, {argument}) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4374 Just like |libcall()|, but used for a function that returns an |
| 7 | 4375 int instead of a string. |
| 4376 {only in Win32 on some Unix versions, when the |+libcall| | |
| 4377 feature is present} | |
| 1621 | 4378 Examples: > |
| 4379 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
| 7 | 4380 :call libcallnr("libc.so", "printf", "Hello World!\n") |
| 4381 :call libcallnr("libc.so", "sleep", 10) | |
| 4382 < | |
| 4383 *line()* | |
| 4384 line({expr}) The result is a Number, which is the line number of the file | |
| 4385 position given with {expr}. The accepted positions are: | |
| 4386 . the cursor position | |
| 4387 $ the last line in the current buffer | |
| 4388 'x position of mark x (if the mark is not set, 0 is | |
| 4389 returned) | |
| 665 | 4390 w0 first line visible in current window |
| 4391 w$ last line visible in current window | |
| 1609 | 4392 v In Visual mode: the start of the Visual area (the |
| 4393 cursor is the end). When not in Visual mode | |
| 4394 returns the cursor position. Differs from |'<| in | |
| 4395 that it's updated right away. | |
| 1156 | 4396 Note that a mark in another file can be used. The line number |
| 4397 then applies to another buffer. | |
| 703 | 4398 To get the column number use |col()|. To get both use |
| 4399 |getpos()|. | |
| 7 | 4400 Examples: > |
| 4401 line(".") line number of the cursor | |
| 4402 line("'t") line number of mark t | |
| 4403 line("'" . marker) line number of mark marker | |
| 4404 < *last-position-jump* | |
| 4405 This autocommand jumps to the last known position in a file | |
| 4406 just after opening it, if the '" mark is set: > | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4407 :au BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g`\"" | endif |
| 9 | 4408 |
| 7 | 4409 line2byte({lnum}) *line2byte()* |
| 4410 Return the byte count from the start of the buffer for line | |
| 4411 {lnum}. This includes the end-of-line character, depending on | |
| 4412 the 'fileformat' option for the current buffer. The first | |
| 3237 | 4413 line returns 1. 'encoding' matters, 'fileencoding' is ignored. |
| 7 | 4414 This can also be used to get the byte count for the line just |
| 4415 below the last line: > | |
| 4416 line2byte(line("$") + 1) | |
| 3237 | 4417 < This is the buffer size plus one. If 'fileencoding' is empty |
| 4418 it is the file size plus one. | |
| 7 | 4419 When {lnum} is invalid, or the |+byte_offset| feature has been |
| 4420 disabled at compile time, -1 is returned. | |
| 4421 Also see |byte2line()|, |go| and |:goto|. | |
| 4422 | |
| 4423 lispindent({lnum}) *lispindent()* | |
| 4424 Get the amount of indent for line {lnum} according the lisp | |
| 4425 indenting rules, as with 'lisp'. | |
| 4426 The indent is counted in spaces, the value of 'tabstop' is | |
| 4427 relevant. {lnum} is used just like in |getline()|. | |
| 4428 When {lnum} is invalid or Vim was not compiled the | |
| 4429 |+lispindent| feature, -1 is returned. | |
| 4430 | |
| 4431 localtime() *localtime()* | |
| 4432 Return the current time, measured as seconds since 1st Jan | |
| 4433 1970. See also |strftime()| and |getftime()|. | |
| 4434 | |
| 95 | 4435 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4436 log({expr}) *log()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
4437 Return the natural logarithm (base e) of {expr} as a |Float|. |
|
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
4438 {expr} must evaluate to a |Float| or a |Number| in the range |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4439 (0, inf]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4440 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4441 :echo log(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4442 < 2.302585 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4443 :echo log(exp(5)) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4444 < 5.0 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
4445 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4446 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4447 |
| 1621 | 4448 log10({expr}) *log10()* |
| 4449 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
| 4450 {expr} must evaluate to a |Float| or a |Number|. | |
| 4451 Examples: > | |
| 4452 :echo log10(1000) | |
| 4453 < 3.0 > | |
| 4454 :echo log10(0.01) | |
| 4455 < -2.0 | |
| 4456 {only available when compiled with the |+float| feature} | |
| 4457 | |
| 3492 | 4458 luaeval({expr}[, {expr}]) *luaeval()* |
| 4459 Evaluate Lua expression {expr} and return its result converted | |
| 4460 to Vim data structures. Second {expr} may hold additional | |
| 4461 argument accessible as _A inside first {expr}. | |
| 4462 Strings are returned as they are. | |
| 4463 Boolean objects are converted to numbers. | |
| 4464 Numbers are converted to |Float| values if vim was compiled | |
| 4465 with |+float| and to numbers otherwise. | |
| 4466 Dictionaries and lists obtained by vim.eval() are returned | |
| 4467 as-is. | |
| 4468 Other objects are returned as zero without any errors. | |
| 4469 See |lua-luaeval| for more details. | |
| 4470 {only available when compiled with the |+lua| feature} | |
| 4471 | |
| 102 | 4472 map({expr}, {string}) *map()* |
| 685 | 4473 {expr} must be a |List| or a |Dictionary|. |
| 102 | 4474 Replace each item in {expr} with the result of evaluating |
| 4475 {string}. | |
| 4476 Inside {string} |v:val| has the value of the current item. | |
| 1998 | 4477 For a |Dictionary| |v:key| has the key of the current item |
| 4478 and for a |List| |v:key| has the index of the current item. | |
| 102 | 4479 Example: > |
| 4480 :call map(mylist, '"> " . v:val . " <"') | |
| 95 | 4481 < This puts "> " before and " <" after each item in "mylist". |
| 102 | 4482 |
| 158 | 4483 Note that {string} is the result of an expression and is then |
| 102 | 4484 used as an expression again. Often it is good to use a |
| 158 | 4485 |literal-string| to avoid having to double backslashes. You |
| 4486 still have to double ' quotes | |
| 102 | 4487 |
| 685 | 4488 The operation is done in-place. If you want a |List| or |
| 4489 |Dictionary| to remain unmodified make a copy first: > | |
| 3682 | 4490 :let tlist = map(copy(mylist), ' v:val . "\t"') |
| 102 | 4491 |
| 685 | 4492 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
| 648 | 4493 When an error is encountered while evaluating {string} no |
| 4494 further items in {expr} are processed. | |
| 95 | 4495 |
| 4496 | |
| 2610 | 4497 maparg({name}[, {mode} [, {abbr} [, {dict}]]]) *maparg()* |
| 4498 When {dict} is omitted or zero: Return the rhs of mapping | |
| 4499 {name} in mode {mode}. The returned String has special | |
| 4500 characters translated like in the output of the ":map" command | |
| 4501 listing. | |
| 4502 | |
| 4503 When there is no mapping for {name}, an empty String is | |
| 4504 returned. | |
| 4505 | |
| 4506 The {name} can have special key names, like in the ":map" | |
| 4507 command. | |
| 4508 | |
| 644 | 4509 {mode} can be one of these strings: |
| 7 | 4510 "n" Normal |
| 2610 | 4511 "v" Visual (including Select) |
| 7 | 4512 "o" Operator-pending |
| 4513 "i" Insert | |
| 4514 "c" Cmd-line | |
| 2610 | 4515 "s" Select |
| 4516 "x" Visual | |
| 7 | 4517 "l" langmap |language-mapping| |
| 4518 "" Normal, Visual and Operator-pending | |
| 644 | 4519 When {mode} is omitted, the modes for "" are used. |
| 2610 | 4520 |
| 782 | 4521 When {abbr} is there and it is non-zero use abbreviations |
| 4522 instead of mappings. | |
| 2610 | 4523 |
| 4524 When {dict} is there and it is non-zero return a dictionary | |
| 4525 containing all the information of the mapping with the | |
| 4526 following items: | |
| 4527 "lhs" The {lhs} of the mapping. | |
| 4528 "rhs" The {rhs} of the mapping as typed. | |
| 4529 "silent" 1 for a |:map-silent| mapping, else 0. | |
| 2625 | 4530 "noremap" 1 if the {rhs} of the mapping is not remappable. |
| 2610 | 4531 "expr" 1 for an expression mapping (|:map-<expr>|). |
| 4532 "buffer" 1 for a buffer local mapping (|:map-local|). | |
| 4533 "mode" Modes for which the mapping is defined. In | |
| 4534 addition to the modes mentioned above, these | |
| 4535 characters will be used: | |
| 4536 " " Normal, Visual and Operator-pending | |
| 4537 "!" Insert and Commandline mode | |
| 2642 | 4538 (|mapmode-ic|) |
| 2625 | 4539 "sid" The script local ID, used for <sid> mappings |
| 4540 (|<SID>|). | |
| 5555 | 4541 "nowait" Do not wait for other, longer mappings. |
| 4542 (|:map-<nowait>|). | |
| 2610 | 4543 |
| 7 | 4544 The mappings local to the current buffer are checked first, |
| 4545 then the global mappings. | |
| 626 | 4546 This function can be used to map a key even when it's already |
| 4547 mapped, and have it do the original mapping too. Sketch: > | |
| 4548 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
| 4549 | |
| 7 | 4550 |
| 782 | 4551 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()* |
| 7 | 4552 Check if there is a mapping that matches with {name} in mode |
| 4553 {mode}. See |maparg()| for {mode} and special names in | |
| 4554 {name}. | |
| 782 | 4555 When {abbr} is there and it is non-zero use abbreviations |
| 4556 instead of mappings. | |
| 7 | 4557 A match happens with a mapping that starts with {name} and |
| 4558 with a mapping which is equal to the start of {name}. | |
| 4559 | |
| 1621 | 4560 matches mapping "a" "ab" "abc" ~ |
| 7 | 4561 mapcheck("a") yes yes yes |
| 4562 mapcheck("abc") yes yes yes | |
| 4563 mapcheck("ax") yes no no | |
| 4564 mapcheck("b") no no no | |
| 4565 | |
| 4566 The difference with maparg() is that mapcheck() finds a | |
| 4567 mapping that matches with {name}, while maparg() only finds a | |
| 4568 mapping for {name} exactly. | |
| 4569 When there is no mapping that starts with {name}, an empty | |
| 4570 String is returned. If there is one, the rhs of that mapping | |
| 4571 is returned. If there are several mappings that start with | |
| 4572 {name}, the rhs of one of them is returned. | |
| 4573 The mappings local to the current buffer are checked first, | |
| 4574 then the global mappings. | |
| 4575 This function can be used to check if a mapping can be added | |
| 4576 without being ambiguous. Example: > | |
| 4577 :if mapcheck("_vv") == "" | |
| 4578 : map _vv :set guifont=7x13<CR> | |
| 4579 :endif | |
| 4580 < This avoids adding the "_vv" mapping when there already is a | |
| 4581 mapping for "_v" or for "_vvv". | |
| 4582 | |
| 19 | 4583 match({expr}, {pat}[, {start}[, {count}]]) *match()* |
| 685 | 4584 When {expr} is a |List| then this returns the index of the |
| 4585 first item where {pat} matches. Each item is used as a | |
| 692 | 4586 String, |Lists| and |Dictionaries| are used as echoed. |
| 1621 | 4587 Otherwise, {expr} is used as a String. The result is a |
| 95 | 4588 Number, which gives the index (byte offset) in {expr} where |
| 4589 {pat} matches. | |
| 685 | 4590 A match at the first character or |List| item returns zero. |
| 19 | 4591 If there is no match -1 is returned. |
| 2833 | 4592 For getting submatches see |matchlist()|. |
| 19 | 4593 Example: > |
| 95 | 4594 :echo match("testing", "ing") " results in 4 |
| 714 | 4595 :echo match([1, 'x'], '\a') " results in 1 |
| 95 | 4596 < See |string-match| for how {pat} is used. |
| 170 | 4597 *strpbrk()* |
| 1621 | 4598 Vim doesn't have a strpbrk() function. But you can do: > |
| 170 | 4599 :let sepidx = match(line, '[.,;: \t]') |
| 4600 < *strcasestr()* | |
| 4601 Vim doesn't have a strcasestr() function. But you can add | |
| 4602 "\c" to the pattern to ignore case: > | |
| 4603 :let idx = match(haystack, '\cneedle') | |
| 4604 < | |
| 95 | 4605 If {start} is given, the search starts from byte index |
| 685 | 4606 {start} in a String or item {start} in a |List|. |
| 7 | 4607 The result, however, is still the index counted from the |
| 236 | 4608 first character/item. Example: > |
| 7 | 4609 :echo match("testing", "ing", 2) |
| 4610 < result is again "4". > | |
| 4611 :echo match("testing", "ing", 4) | |
| 4612 < result is again "4". > | |
| 4613 :echo match("testing", "t", 2) | |
| 4614 < result is "3". | |
| 694 | 4615 For a String, if {start} > 0 then it is like the string starts |
| 703 | 4616 {start} bytes later, thus "^" will match at {start}. Except |
| 4617 when {count} is given, then it's like matches before the | |
| 4618 {start} byte are ignored (this is a bit complicated to keep it | |
| 4619 backwards compatible). | |
| 95 | 4620 For a String, if {start} < 0, it will be set to 0. For a list |
| 4621 the index is counted from the end. | |
| 697 | 4622 If {start} is out of range ({start} > strlen({expr}) for a |
| 4623 String or {start} > len({expr}) for a |List|) -1 is returned. | |
| 95 | 4624 |
| 694 | 4625 When {count} is given use the {count}'th match. When a match |
| 697 | 4626 is found in a String the search for the next one starts one |
| 694 | 4627 character further. Thus this example results in 1: > |
| 4628 echo match("testing", "..", 0, 2) | |
| 4629 < In a |List| the search continues in the next item. | |
| 703 | 4630 Note that when {count} is added the way {start} works changes, |
| 4631 see above. | |
| 694 | 4632 |
| 7 | 4633 See |pattern| for the patterns that are accepted. |
| 4634 The 'ignorecase' option is used to set the ignore-caseness of | |
| 1621 | 4635 the pattern. 'smartcase' is NOT used. The matching is always |
| 7 | 4636 done like 'magic' is set and 'cpoptions' is empty. |
| 4637 | |
| 1326 | 4638 *matchadd()* *E798* *E799* *E801* |
|
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
4639 matchadd({group}, {pattern}[, {priority}[, {id} [, {dict}]]]) |
| 1326 | 4640 Defines a pattern to be highlighted in the current window (a |
| 4641 "match"). It will be highlighted with {group}. Returns an | |
| 4642 identification number (ID), which can be used to delete the | |
| 4643 match using |matchdelete()|. | |
| 5466 | 4644 Matching is case sensitive and magic, unless case sensitivity |
| 4645 or magicness are explicitly overridden in {pattern}. The | |
| 4646 'magic', 'smartcase' and 'ignorecase' options are not used. | |
|
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
4647 The "Conceal" value is special, it causes the match to be |
|
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
4648 concealed. |
| 1326 | 4649 |
| 4650 The optional {priority} argument assigns a priority to the | |
| 1621 | 4651 match. A match with a high priority will have its |
| 1326 | 4652 highlighting overrule that of a match with a lower priority. |
| 4653 A priority is specified as an integer (negative numbers are no | |
| 4654 exception). If the {priority} argument is not specified, the | |
| 4655 default priority is 10. The priority of 'hlsearch' is zero, | |
| 4656 hence all matches with a priority greater than zero will | |
| 4657 overrule it. Syntax highlighting (see 'syntax') is a separate | |
| 4658 mechanism, and regardless of the chosen priority a match will | |
| 4659 always overrule syntax highlighting. | |
| 4660 | |
| 4661 The optional {id} argument allows the request for a specific | |
| 4662 match ID. If a specified ID is already taken, an error | |
| 4663 message will appear and the match will not be added. An ID | |
| 4664 is specified as a positive integer (zero excluded). IDs 1, 2 | |
| 4665 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
| 6947 | 4666 respectively. If the {id} argument is not specified or -1, |
| 1326 | 4667 |matchadd()| automatically chooses a free ID. |
| 4668 | |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
4669 The optional {dict} argument allows for further custom |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
4670 values. Currently this is used to specify a match specific |
| 6947 | 4671 conceal character that will be shown for |hl-Conceal| |
| 4672 highlighted matches. The dict can have the following members: | |
| 4673 | |
| 4674 conceal Special character to show instead of the | |
| 4675 match (only for |hl-Conceal| highlighed | |
| 4676 matches, see |:syn-cchar|) | |
| 4677 | |
| 1326 | 4678 The number of matches is not limited, as it is the case with |
| 4679 the |:match| commands. | |
| 4680 | |
| 4681 Example: > | |
| 4682 :highlight MyGroup ctermbg=green guibg=green | |
| 4683 :let m = matchadd("MyGroup", "TODO") | |
| 4684 < Deletion of the pattern: > | |
| 4685 :call matchdelete(m) | |
| 4686 | |
| 4687 < A list of matches defined by |matchadd()| and |:match| are | |
| 1621 | 4688 available from |getmatches()|. All matches can be deleted in |
| 1326 | 4689 one operation by |clearmatches()|. |
| 819 | 4690 |
| 6947 | 4691 matchaddpos({group}, {pos}[, {priority}[, {id}[, {dict}]]]) *matchaddpos()* |
| 5979 | 4692 Same as |matchadd()|, but requires a list of positions {pos} |
| 4693 instead of a pattern. This command is faster than |matchadd()| | |
| 4694 because it does not require to handle regular expressions and | |
| 4695 sets buffer line boundaries to redraw screen. It is supposed | |
| 4696 to be used when fast match additions and deletions are | |
| 4697 required, for example to highlight matching parentheses. | |
| 4698 | |
| 4699 The list {pos} can contain one of these items: | |
| 6007 | 4700 - A number. This whole line will be highlighted. The first |
| 5979 | 4701 line has number 1. |
| 4702 - A list with one number, e.g., [23]. The whole line with this | |
| 4703 number will be highlighted. | |
| 4704 - A list with two numbers, e.g., [23, 11]. The first number is | |
| 6007 | 4705 the line number, the second one is the column number (first |
| 4706 column is 1, the value must correspond to the byte index as | |
| 4707 |col()| would return). The character at this position will | |
| 4708 be highlighted. | |
| 5979 | 4709 - A list with three numbers, e.g., [23, 11, 3]. As above, but |
| 6007 | 4710 the third number gives the length of the highlight in bytes. |
| 5979 | 4711 |
| 4712 The maximum number of positions is 8. | |
| 4713 | |
| 4714 Example: > | |
| 4715 :highlight MyGroup ctermbg=green guibg=green | |
| 4716 :let m = matchaddpos("MyGroup", [[23, 24], 34]) | |
| 4717 < Deletion of the pattern: > | |
| 4718 :call matchdelete(m) | |
| 4719 | |
| 4720 < Matches added by |matchaddpos()| are returned by | |
| 4721 |getmatches()| with an entry "pos1", "pos2", etc., with the | |
| 4722 value a list like the {pos} item. | |
| 4723 These matches cannot be set via |setmatches()|, however they | |
| 4724 can still be deleted by |clearmatches()|. | |
| 4725 | |
| 819 | 4726 matcharg({nr}) *matcharg()* |
| 856 | 4727 Selects the {nr} match item, as set with a |:match|, |
| 819 | 4728 |:2match| or |:3match| command. |
| 4729 Return a |List| with two elements: | |
| 4730 The name of the highlight group used | |
| 4731 The pattern used. | |
| 4732 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
| 4733 When there is no match item set returns ['', '']. | |
| 1326 | 4734 This is useful to save and restore a |:match|. |
| 4735 Highlighting matches using the |:match| commands are limited | |
| 4736 to three matches. |matchadd()| does not have this limitation. | |
| 4737 | |
| 4738 matchdelete({id}) *matchdelete()* *E802* *E803* | |
| 4739 Deletes a match with ID {id} previously defined by |matchadd()| | |
| 1621 | 4740 or one of the |:match| commands. Returns 0 if successful, |
| 1326 | 4741 otherwise -1. See example for |matchadd()|. All matches can |
| 4742 be deleted in one operation by |clearmatches()|. | |
| 819 | 4743 |
| 19 | 4744 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4745 Same as |match()|, but return the index of first character |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4746 after the match. Example: > |
| 7 | 4747 :echo matchend("testing", "ing") |
| 4748 < results in "7". | |
| 170 | 4749 *strspn()* *strcspn()* |
| 4750 Vim doesn't have a strspn() or strcspn() function, but you can | |
| 4751 do it with matchend(): > | |
| 4752 :let span = matchend(line, '[a-zA-Z]') | |
| 4753 :let span = matchend(line, '[^a-zA-Z]') | |
| 4754 < Except that -1 is returned when there are no matches. | |
| 4755 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4756 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 4757 :echo matchend("testing", "ing", 2) |
| 4758 < results in "7". > | |
| 4759 :echo matchend("testing", "ing", 5) | |
| 4760 < result is "-1". | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4761 When {expr} is a |List| the result is equal to |match()|. |
| 7 | 4762 |
| 158 | 4763 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4764 Same as |match()|, but return a |List|. The first item in the |
| 158 | 4765 list is the matched string, same as what matchstr() would |
| 4766 return. Following items are submatches, like "\1", "\2", etc. | |
| 842 | 4767 in |:substitute|. When an optional submatch didn't match an |
| 4768 empty string is used. Example: > | |
| 4769 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
| 4770 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
| 158 | 4771 When there is no match an empty list is returned. |
| 4772 | |
| 19 | 4773 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()* |
| 1621 | 4774 Same as |match()|, but return the matched string. Example: > |
| 7 | 4775 :echo matchstr("testing", "ing") |
| 4776 < results in "ing". | |
| 4777 When there is no match "" is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4778 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 4779 :echo matchstr("testing", "ing", 2) |
| 4780 < results in "ing". > | |
| 4781 :echo matchstr("testing", "ing", 5) | |
| 4782 < result is "". | |
| 685 | 4783 When {expr} is a |List| then the matching item is returned. |
| 95 | 4784 The type isn't changed, it's not necessarily a String. |
| 7 | 4785 |
| 87 | 4786 *max()* |
| 4787 max({list}) Return the maximum value of all items in {list}. | |
| 4788 If {list} is not a list or one of the items in {list} cannot | |
| 4789 be used as a Number this results in an error. | |
| 685 | 4790 An empty |List| results in zero. |
| 87 | 4791 |
| 4792 *min()* | |
| 1215 | 4793 min({list}) Return the minimum value of all items in {list}. |
| 87 | 4794 If {list} is not a list or one of the items in {list} cannot |
| 4795 be used as a Number this results in an error. | |
| 685 | 4796 An empty |List| results in zero. |
| 87 | 4797 |
| 843 | 4798 *mkdir()* *E739* |
| 168 | 4799 mkdir({name} [, {path} [, {prot}]]) |
| 4800 Create directory {name}. | |
| 4801 If {path} is "p" then intermediate directories are created as | |
| 4802 necessary. Otherwise it must be "". | |
| 4803 If {prot} is given it is used to set the protection bits of | |
| 4804 the new directory. The default is 0755 (rwxr-xr-x: r/w for | |
| 1621 | 4805 the user readable for others). Use 0700 to make it unreadable |
| 1702 | 4806 for others. This is only used for the last part of {name}. |
| 4807 Thus if you create /tmp/foo/bar then /tmp/foo will be created | |
| 4808 with 0755. | |
| 4809 Example: > | |
| 4810 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700) | |
| 4811 < This function is not available in the |sandbox|. | |
| 168 | 4812 Not available on all systems. To check use: > |
| 4813 :if exists("*mkdir") | |
| 4814 < | |
| 7 | 4815 *mode()* |
| 1621 | 4816 mode([expr]) Return a string that indicates the current mode. |
| 1661 | 4817 If [expr] is supplied and it evaluates to a non-zero Number or |
| 4818 a non-empty String (|non-zero-arg|), then the full mode is | |
| 4819 returned, otherwise only the first letter is returned. Note | |
| 4820 that " " and "0" are also non-empty strings. | |
| 1621 | 4821 |
| 7 | 4822 n Normal |
| 1621 | 4823 no Operator-pending |
| 7 | 4824 v Visual by character |
| 4825 V Visual by line | |
| 4826 CTRL-V Visual blockwise | |
| 4827 s Select by character | |
| 4828 S Select by line | |
| 4829 CTRL-S Select blockwise | |
| 4830 i Insert | |
| 1621 | 4831 R Replace |R| |
| 4832 Rv Virtual Replace |gR| | |
| 7 | 4833 c Command-line |
| 1621 | 4834 cv Vim Ex mode |gQ| |
| 4835 ce Normal Ex mode |Q| | |
| 7 | 4836 r Hit-enter prompt |
| 1621 | 4837 rm The -- more -- prompt |
| 4838 r? A |:confirm| query of some sort | |
| 4839 ! Shell or external command is executing | |
| 4840 This is useful in the 'statusline' option or when used | |
| 4841 with |remote_expr()| In most other places it always returns | |
| 4842 "c" or "n". | |
| 4843 Also see |visualmode()|. | |
| 7 | 4844 |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4845 mzeval({expr}) *mzeval()* |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4846 Evaluate MzScheme expression {expr} and return its result |
| 3492 | 4847 converted to Vim data structures. |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4848 Numbers and strings are returned as they are. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4849 Pairs (including lists and improper lists) and vectors are |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4850 returned as Vim |Lists|. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4851 Hash tables are represented as Vim |Dictionary| type with keys |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4852 converted to strings. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4853 All other types are converted to string with display function. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4854 Examples: > |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4855 :mz (define l (list 1 2 3)) |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4856 :mz (define h (make-hash)) (hash-set! h "list" l) |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4857 :echo mzeval("l") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4858 :echo mzeval("h") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4859 < |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4860 {only available when compiled with the |+mzscheme| feature} |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4861 |
| 7 | 4862 nextnonblank({lnum}) *nextnonblank()* |
| 4863 Return the line number of the first line at or below {lnum} | |
| 4864 that is not blank. Example: > | |
| 4865 if getline(nextnonblank(1)) =~ "Java" | |
| 4866 < When {lnum} is invalid or there is no non-blank line at or | |
| 4867 below it, zero is returned. | |
| 4868 See also |prevnonblank()|. | |
| 4869 | |
| 4051 | 4870 nr2char({expr}[, {utf8}]) *nr2char()* |
| 7 | 4871 Return a string with a single character, which has the number |
| 4872 value {expr}. Examples: > | |
| 4873 nr2char(64) returns "@" | |
| 4874 nr2char(32) returns " " | |
| 4051 | 4875 < When {utf8} is omitted or zero, the current 'encoding' is used. |
| 4876 Example for "utf-8": > | |
| 7 | 4877 nr2char(300) returns I with bow character |
| 4051 | 4878 < With {utf8} set to 1, always return utf-8 characters. |
| 4879 Note that a NUL character in the file is specified with | |
| 7 | 4880 nr2char(10), because NULs are represented with newline |
| 4881 characters. nr2char(0) is a real NUL and terminates the | |
| 119 | 4882 string, thus results in an empty string. |
| 7 | 4883 |
| 3214 | 4884 or({expr}, {expr}) *or()* |
| 4885 Bitwise OR on the two arguments. The arguments are converted | |
| 4886 to a number. A List, Dict or Float argument causes an error. | |
| 4887 Example: > | |
| 4888 :let bits = or(bits, 0x80) | |
| 4889 | |
| 4890 | |
| 819 | 4891 pathshorten({expr}) *pathshorten()* |
| 4892 Shorten directory names in the path {expr} and return the | |
| 4893 result. The tail, the file name, is kept as-is. The other | |
| 4894 components in the path are reduced to single letters. Leading | |
| 4895 '~' and '.' characters are kept. Example: > | |
| 4896 :echo pathshorten('~/.vim/autoload/myfile.vim') | |
| 4897 < ~/.v/a/myfile.vim ~ | |
| 4898 It doesn't matter if the path exists or not. | |
| 4899 | |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4900 perleval({expr}) *perleval()* |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4901 Evaluate Perl expression {expr} in scalar context and return |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4902 its result converted to Vim data structures. If value can't be |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
4903 converted, it is returned as a string Perl representation. |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
4904 Note: If you want an array or hash, {expr} must return a |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
4905 reference to it. |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4906 Example: > |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4907 :echo perleval('[1 .. 4]') |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4908 < [1, 2, 3, 4] |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4909 {only available when compiled with the |+perl| feature} |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
4910 |
| 1621 | 4911 pow({x}, {y}) *pow()* |
| 4912 Return the power of {x} to the exponent {y} as a |Float|. | |
| 4913 {x} and {y} must evaluate to a |Float| or a |Number|. | |
| 4914 Examples: > | |
| 4915 :echo pow(3, 3) | |
| 4916 < 27.0 > | |
| 4917 :echo pow(2, 16) | |
| 4918 < 65536.0 > | |
| 4919 :echo pow(32, 0.20) | |
| 4920 < 2.0 | |
| 4921 {only available when compiled with the |+float| feature} | |
| 4922 | |
| 667 | 4923 prevnonblank({lnum}) *prevnonblank()* |
| 4924 Return the line number of the first line at or above {lnum} | |
| 4925 that is not blank. Example: > | |
| 4926 let ind = indent(prevnonblank(v:lnum - 1)) | |
| 4927 < When {lnum} is invalid or there is no non-blank line at or | |
| 4928 above it, zero is returned. | |
| 4929 Also see |nextnonblank()|. | |
| 4930 | |
| 4931 | |
| 449 | 4932 printf({fmt}, {expr1} ...) *printf()* |
| 4933 Return a String with {fmt}, where "%" items are replaced by | |
| 4934 the formatted form of their respective arguments. Example: > | |
| 452 | 4935 printf("%4d: E%d %.30s", lnum, errno, msg) |
| 449 | 4936 < May result in: |
| 452 | 4937 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
| 449 | 4938 |
| 4939 Often used items are: | |
| 856 | 4940 %s string |
| 3914 | 4941 %6S string right-aligned in 6 display cells |
| 653 | 4942 %6s string right-aligned in 6 bytes |
| 1621 | 4943 %.9s string truncated to 9 bytes |
| 4944 %c single byte | |
| 4945 %d decimal number | |
| 4946 %5d decimal number padded with spaces to 5 characters | |
| 4947 %x hex number | |
| 4948 %04x hex number padded with zeros to at least 4 characters | |
| 4949 %X hex number using upper case letters | |
| 4950 %o octal number | |
| 4951 %f floating point number in the form 123.456 | |
| 4952 %e floating point number in the form 1.234e3 | |
| 4953 %E floating point number in the form 1.234E3 | |
| 4954 %g floating point number, as %f or %e depending on value | |
| 4955 %G floating point number, as %f or %E depending on value | |
| 4956 %% the % character itself | |
| 449 | 4957 |
| 4958 Conversion specifications start with '%' and end with the | |
| 4959 conversion type. All other characters are copied unchanged to | |
| 4960 the result. | |
| 4961 | |
| 4962 The "%" starts a conversion specification. The following | |
| 452 | 4963 arguments appear in sequence: |
| 4964 | |
| 4965 % [flags] [field-width] [.precision] type | |
| 4966 | |
| 856 | 4967 flags |
| 452 | 4968 Zero or more of the following flags: |
| 4969 | |
| 449 | 4970 # The value should be converted to an "alternate |
| 4971 form". For c, d, and s conversions, this option | |
| 4972 has no effect. For o conversions, the precision | |
| 4973 of the number is increased to force the first | |
| 4974 character of the output string to a zero (except | |
| 4975 if a zero value is printed with an explicit | |
| 4976 precision of zero). | |
| 4977 For x and X conversions, a non-zero result has | |
| 4978 the string "0x" (or "0X" for X conversions) | |
| 4979 prepended to it. | |
| 452 | 4980 |
| 449 | 4981 0 (zero) Zero padding. For all conversions the converted |
| 4982 value is padded on the left with zeros rather | |
| 4983 than blanks. If a precision is given with a | |
| 4984 numeric conversion (d, o, x, and X), the 0 flag | |
| 4985 is ignored. | |
| 452 | 4986 |
| 449 | 4987 - A negative field width flag; the converted value |
| 4988 is to be left adjusted on the field boundary. | |
| 4989 The converted value is padded on the right with | |
| 4990 blanks, rather than on the left with blanks or | |
| 4991 zeros. A - overrides a 0 if both are given. | |
| 452 | 4992 |
| 449 | 4993 ' ' (space) A blank should be left before a positive |
| 4994 number produced by a signed conversion (d). | |
| 452 | 4995 |
| 449 | 4996 + A sign must always be placed before a number |
| 1621 | 4997 produced by a signed conversion. A + overrides |
| 449 | 4998 a space if both are used. |
| 452 | 4999 |
| 5000 field-width | |
| 5001 An optional decimal digit string specifying a minimum | |
| 653 | 5002 field width. If the converted value has fewer bytes |
| 5003 than the field width, it will be padded with spaces on | |
| 5004 the left (or right, if the left-adjustment flag has | |
| 5005 been given) to fill out the field width. | |
| 452 | 5006 |
| 5007 .precision | |
| 5008 An optional precision, in the form of a period '.' | |
| 5009 followed by an optional digit string. If the digit | |
| 5010 string is omitted, the precision is taken as zero. | |
| 5011 This gives the minimum number of digits to appear for | |
| 5012 d, o, x, and X conversions, or the maximum number of | |
| 653 | 5013 bytes to be printed from a string for s conversions. |
| 1621 | 5014 For floating point it is the number of digits after |
| 5015 the decimal point. | |
| 452 | 5016 |
| 5017 type | |
| 5018 A character that specifies the type of conversion to | |
| 5019 be applied, see below. | |
| 5020 | |
| 449 | 5021 A field width or precision, or both, may be indicated by an |
| 5022 asterisk '*' instead of a digit string. In this case, a | |
| 1621 | 5023 Number argument supplies the field width or precision. A |
| 449 | 5024 negative field width is treated as a left adjustment flag |
| 5025 followed by a positive field width; a negative precision is | |
| 5026 treated as though it were missing. Example: > | |
| 452 | 5027 :echo printf("%d: %.*s", nr, width, line) |
| 449 | 5028 < This limits the length of the text used from "line" to |
| 452 | 5029 "width" bytes. |
| 449 | 5030 |
| 856 | 5031 The conversion specifiers and their meanings are: |
| 452 | 5032 |
| 1621 | 5033 *printf-d* *printf-o* *printf-x* *printf-X* |
| 5034 doxX The Number argument is converted to signed decimal | |
| 449 | 5035 (d), unsigned octal (o), or unsigned hexadecimal (x |
| 5036 and X) notation. The letters "abcdef" are used for | |
| 5037 x conversions; the letters "ABCDEF" are used for X | |
| 452 | 5038 conversions. |
| 5039 The precision, if any, gives the minimum number of | |
| 5040 digits that must appear; if the converted value | |
| 5041 requires fewer digits, it is padded on the left with | |
| 5042 zeros. | |
| 5043 In no case does a non-existent or small field width | |
| 5044 cause truncation of a numeric field; if the result of | |
| 5045 a conversion is wider than the field width, the field | |
| 5046 is expanded to contain the conversion result. | |
| 5047 | |
| 1621 | 5048 *printf-c* |
| 452 | 5049 c The Number argument is converted to a byte, and the |
| 5050 resulting character is written. | |
| 5051 | |
| 1621 | 5052 *printf-s* |
| 452 | 5053 s The text of the String argument is used. If a |
| 5054 precision is specified, no more bytes than the number | |
| 5055 specified are used. | |
| 6583 | 5056 *printf-S* |
| 3914 | 5057 S The text of the String argument is used. If a |
| 5058 precision is specified, no more display cells than the | |
| 5059 number specified are used. Without the |+multi_byte| | |
| 5060 feature works just like 's'. | |
| 452 | 5061 |
| 1621 | 5062 *printf-f* *E807* |
| 5063 f The Float argument is converted into a string of the | |
| 5064 form 123.456. The precision specifies the number of | |
| 5065 digits after the decimal point. When the precision is | |
| 5066 zero the decimal point is omitted. When the precision | |
| 5067 is not specified 6 is used. A really big number | |
| 5068 (out of range or dividing by zero) results in "inf". | |
| 5069 "0.0 / 0.0" results in "nan". | |
| 5070 Example: > | |
| 5071 echo printf("%.2f", 12.115) | |
| 5072 < 12.12 | |
| 5073 Note that roundoff depends on the system libraries. | |
| 5074 Use |round()| when in doubt. | |
| 5075 | |
| 5076 *printf-e* *printf-E* | |
| 5077 e E The Float argument is converted into a string of the | |
| 5078 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
| 5079 precision specifies the number of digits after the | |
| 5080 decimal point, like with 'f'. | |
| 5081 | |
| 5082 *printf-g* *printf-G* | |
| 5083 g G The Float argument is converted like with 'f' if the | |
| 5084 value is between 0.001 (inclusive) and 10000000.0 | |
| 5085 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
| 5086 for 'G'. When no precision is specified superfluous | |
| 5087 zeroes and '+' signs are removed, except for the zero | |
| 5088 immediately after the decimal point. Thus 10000000.0 | |
| 5089 results in 1.0e7. | |
| 5090 | |
| 5091 *printf-%* | |
| 449 | 5092 % A '%' is written. No argument is converted. The |
| 5093 complete conversion specification is "%%". | |
| 452 | 5094 |
| 1668 | 5095 When a Number argument is expected a String argument is also |
| 5096 accepted and automatically converted. | |
| 5097 When a Float or String argument is expected a Number argument | |
| 5098 is also accepted and automatically converted. | |
| 5099 Any other argument type results in an error message. | |
| 449 | 5100 |
| 459 | 5101 *E766* *E767* |
| 449 | 5102 The number of {exprN} arguments must exactly match the number |
| 5103 of "%" items. If there are not sufficient or too many | |
| 452 | 5104 arguments an error is given. Up to 18 arguments can be used. |
| 449 | 5105 |
| 5106 | |
| 667 | 5107 pumvisible() *pumvisible()* |
| 5108 Returns non-zero when the popup menu is visible, zero | |
| 5109 otherwise. See |ins-completion-menu|. | |
| 712 | 5110 This can be used to avoid some things that would remove the |
| 5111 popup menu. | |
| 7 | 5112 |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4437
diff
changeset
|
5113 *E860* |
| 3682 | 5114 py3eval({expr}) *py3eval()* |
| 5115 Evaluate Python expression {expr} and return its result | |
| 5116 converted to Vim data structures. | |
| 5117 Numbers and strings are returned as they are (strings are | |
| 6647 | 5118 copied though, Unicode strings are additionally converted to |
| 3682 | 5119 'encoding'). |
| 5120 Lists are represented as Vim |List| type. | |
| 5121 Dictionaries are represented as Vim |Dictionary| type with | |
| 5122 keys converted to strings. | |
| 5123 {only available when compiled with the |+python3| feature} | |
| 5124 | |
| 5125 *E858* *E859* | |
| 5126 pyeval({expr}) *pyeval()* | |
| 5127 Evaluate Python expression {expr} and return its result | |
| 5128 converted to Vim data structures. | |
| 5129 Numbers and strings are returned as they are (strings are | |
| 5130 copied though). | |
| 5131 Lists are represented as Vim |List| type. | |
| 3830 | 5132 Dictionaries are represented as Vim |Dictionary| type, |
| 5133 non-string keys result in error. | |
| 3682 | 5134 {only available when compiled with the |+python| feature} |
| 5135 | |
| 114 | 5136 *E726* *E727* |
| 99 | 5137 range({expr} [, {max} [, {stride}]]) *range()* |
| 685 | 5138 Returns a |List| with Numbers: |
| 99 | 5139 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
| 5140 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
| 5141 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
| 5142 {max}] (increasing {expr} with {stride} each time, not | |
| 5143 producing a value past {max}). | |
| 336 | 5144 When the maximum is one before the start the result is an |
| 5145 empty list. When the maximum is more than one before the | |
| 5146 start this is an error. | |
| 99 | 5147 Examples: > |
| 856 | 5148 range(4) " [0, 1, 2, 3] |
| 99 | 5149 range(2, 4) " [2, 3, 4] |
| 5150 range(2, 9, 3) " [2, 5, 8] | |
| 856 | 5151 range(2, -2, -1) " [2, 1, 0, -1, -2] |
| 336 | 5152 range(0) " [] |
| 5153 range(2, 0) " error! | |
| 99 | 5154 < |
| 158 | 5155 *readfile()* |
| 168 | 5156 readfile({fname} [, {binary} [, {max}]]) |
| 685 | 5157 Read file {fname} and return a |List|, each line of the file |
| 5158 as an item. Lines broken at NL characters. Macintosh files | |
| 158 | 5159 separated with CR will result in a single long line (unless a |
| 5160 NL appears somewhere). | |
|
2513
a88237afdb20
Change readfile() to ignore byte order marks, unless in binary mode.
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
5161 All NUL characters are replaced with a NL character. |
| 6918 | 5162 When {binary} contains "b" binary mode is used: |
| 158 | 5163 - When the last line ends in a NL an extra empty list item is |
| 5164 added. | |
| 5165 - No CR characters are removed. | |
| 5166 Otherwise: | |
| 5167 - CR characters that appear before a NL are removed. | |
| 5168 - Whether the last line ends in a NL or not does not matter. | |
|
2513
a88237afdb20
Change readfile() to ignore byte order marks, unless in binary mode.
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
5169 - When 'encoding' is Unicode any UTF-8 byte order mark is |
|
a88237afdb20
Change readfile() to ignore byte order marks, unless in binary mode.
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
5170 removed from the text. |
| 168 | 5171 When {max} is given this specifies the maximum number of lines |
| 5172 to be read. Useful if you only want to check the first ten | |
| 5173 lines of a file: > | |
| 5174 :for line in readfile(fname, '', 10) | |
| 5175 : if line =~ 'Date' | echo line | endif | |
| 5176 :endfor | |
| 233 | 5177 < When {max} is negative -{max} lines from the end of the file |
| 5178 are returned, or as many as there are. | |
| 5179 When {max} is zero the result is an empty list. | |
| 168 | 5180 Note that without {max} the whole file is read into memory. |
| 5181 Also note that there is no recognition of encoding. Read a | |
| 5182 file into a buffer if you need to. | |
| 158 | 5183 When the file can't be opened an error message is given and |
| 5184 the result is an empty list. | |
| 5185 Also see |writefile()|. | |
| 5186 | |
| 794 | 5187 reltime([{start} [, {end}]]) *reltime()* |
| 5188 Return an item that represents a time value. The format of | |
| 5189 the item depends on the system. It can be passed to | |
| 5190 |reltimestr()| to convert it to a string. | |
| 5191 Without an argument it returns the current time. | |
| 5192 With one argument is returns the time passed since the time | |
| 5193 specified in the argument. | |
| 843 | 5194 With two arguments it returns the time passed between {start} |
| 794 | 5195 and {end}. |
| 5196 The {start} and {end} arguments must be values returned by | |
| 5197 reltime(). | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
5198 {only available when compiled with the |+reltime| feature} |
| 794 | 5199 |
| 5200 reltimestr({time}) *reltimestr()* | |
| 5201 Return a String that represents the time value of {time}. | |
| 5202 This is the number of seconds, a dot and the number of | |
| 5203 microseconds. Example: > | |
| 5204 let start = reltime() | |
| 5205 call MyFunction() | |
| 5206 echo reltimestr(reltime(start)) | |
| 5207 < Note that overhead for the commands will be added to the time. | |
| 5208 The accuracy depends on the system. | |
| 1156 | 5209 Leading spaces are used to make the string align nicely. You |
| 5210 can use split() to remove it. > | |
| 5211 echo split(reltimestr(reltime(start)))[0] | |
| 5212 < Also see |profiling|. | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
5213 {only available when compiled with the |+reltime| feature} |
| 794 | 5214 |
| 7 | 5215 *remote_expr()* *E449* |
| 5216 remote_expr({server}, {string} [, {idvar}]) | |
| 1621 | 5217 Send the {string} to {server}. The string is sent as an |
| 7 | 5218 expression and the result is returned after evaluation. |
| 714 | 5219 The result must be a String or a |List|. A |List| is turned |
| 5220 into a String by joining the items with a line break in | |
| 5221 between (not at the end), like with join(expr, "\n"). | |
| 7 | 5222 If {idvar} is present, it is taken as the name of a |
| 5223 variable and a {serverid} for later use with | |
| 5224 remote_read() is stored there. | |
| 5225 See also |clientserver| |RemoteReply|. | |
| 5226 This function is not available in the |sandbox|. | |
| 5227 {only available when compiled with the |+clientserver| feature} | |
| 5228 Note: Any errors will cause a local error message to be issued | |
| 5229 and the result will be the empty string. | |
| 5230 Examples: > | |
| 5231 :echo remote_expr("gvim", "2+2") | |
| 5232 :echo remote_expr("gvim1", "b:current_syntax") | |
| 5233 < | |
| 5234 | |
| 5235 remote_foreground({server}) *remote_foreground()* | |
| 5236 Move the Vim server with the name {server} to the foreground. | |
| 5237 This works like: > | |
| 5238 remote_expr({server}, "foreground()") | |
| 5239 < Except that on Win32 systems the client does the work, to work | |
| 5240 around the problem that the OS doesn't always allow the server | |
| 5241 to bring itself to the foreground. | |
| 574 | 5242 Note: This does not restore the window if it was minimized, |
| 5243 like foreground() does. | |
| 7 | 5244 This function is not available in the |sandbox|. |
| 5245 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 5246 Win32 console version} | |
| 5247 | |
| 5248 | |
| 5249 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
| 5250 Returns a positive number if there are available strings | |
| 5251 from {serverid}. Copies any reply string into the variable | |
| 1621 | 5252 {retvar} if specified. {retvar} must be a string with the |
| 7 | 5253 name of a variable. |
| 5254 Returns zero if none are available. | |
| 5255 Returns -1 if something is wrong. | |
| 5256 See also |clientserver|. | |
| 5257 This function is not available in the |sandbox|. | |
| 5258 {only available when compiled with the |+clientserver| feature} | |
| 5259 Examples: > | |
| 5260 :let repl = "" | |
| 5261 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
| 5262 | |
| 5263 remote_read({serverid}) *remote_read()* | |
| 5264 Return the oldest available reply from {serverid} and consume | |
| 5265 it. It blocks until a reply is available. | |
| 5266 See also |clientserver|. | |
| 5267 This function is not available in the |sandbox|. | |
| 5268 {only available when compiled with the |+clientserver| feature} | |
| 5269 Example: > | |
| 5270 :echo remote_read(id) | |
| 5271 < | |
| 5272 *remote_send()* *E241* | |
| 5273 remote_send({server}, {string} [, {idvar}]) | |
| 1621 | 5274 Send the {string} to {server}. The string is sent as input |
| 22 | 5275 keys and the function returns immediately. At the Vim server |
| 5276 the keys are not mapped |:map|. | |
| 667 | 5277 If {idvar} is present, it is taken as the name of a variable |
| 5278 and a {serverid} for later use with remote_read() is stored | |
| 5279 there. | |
| 7 | 5280 See also |clientserver| |RemoteReply|. |
| 5281 This function is not available in the |sandbox|. | |
| 5282 {only available when compiled with the |+clientserver| feature} | |
| 5283 Note: Any errors will be reported in the server and may mess | |
| 5284 up the display. | |
| 5285 Examples: > | |
| 5286 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
| 5287 \ remote_read(serverid) | |
| 5288 | |
| 5289 :autocmd NONE RemoteReply * | |
| 5290 \ echo remote_read(expand("<amatch>")) | |
| 5291 :echo remote_send("gvim", ":sleep 10 | echo ". | |
| 5292 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
| 82 | 5293 < |
| 79 | 5294 remove({list}, {idx} [, {end}]) *remove()* |
| 685 | 5295 Without {end}: Remove the item at {idx} from |List| {list} and |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5296 return the item. |
| 79 | 5297 With {end}: Remove items from {idx} to {end} (inclusive) and |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5298 return a List with these items. When {idx} points to the same |
| 79 | 5299 item as {end} a list with one item is returned. When {end} |
| 5300 points to an item before {idx} this is an error. | |
| 5301 See |list-index| for possible values of {idx} and {end}. | |
| 55 | 5302 Example: > |
| 5303 :echo "last item: " . remove(mylist, -1) | |
| 79 | 5304 :call remove(mylist, 0, 9) |
| 99 | 5305 remove({dict}, {key}) |
| 5306 Remove the entry from {dict} with key {key}. Example: > | |
| 5307 :echo "removed " . remove(dict, "one") | |
| 5308 < If there is no {key} in {dict} this is an error. | |
| 5309 | |
| 5310 Use |delete()| to remove a file. | |
| 55 | 5311 |
| 7 | 5312 rename({from}, {to}) *rename()* |
| 5313 Rename the file by the name {from} to the name {to}. This | |
| 5314 should also work to move files across file systems. The | |
| 5315 result is a Number, which is 0 if the file was renamed | |
| 5316 successfully, and non-zero when the renaming failed. | |
| 1851 | 5317 NOTE: If {to} exists it is overwritten without warning. |
| 7 | 5318 This function is not available in the |sandbox|. |
| 5319 | |
| 18 | 5320 repeat({expr}, {count}) *repeat()* |
| 5321 Repeat {expr} {count} times and return the concatenated | |
| 5322 result. Example: > | |
| 843 | 5323 :let separator = repeat('-', 80) |
| 18 | 5324 < When {count} is zero or negative the result is empty. |
| 685 | 5325 When {expr} is a |List| the result is {expr} concatenated |
| 1621 | 5326 {count} times. Example: > |
| 79 | 5327 :let longlist = repeat(['a', 'b'], 3) |
| 5328 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
| 18 | 5329 |
| 82 | 5330 |
| 7 | 5331 resolve({filename}) *resolve()* *E655* |
| 5332 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
| 5333 returns the path the shortcut points to in a simplified form. | |
| 5334 On Unix, repeat resolving symbolic links in all path | |
| 5335 components of {filename} and return the simplified result. | |
| 5336 To cope with link cycles, resolving of symbolic links is | |
| 5337 stopped after 100 iterations. | |
| 5338 On other systems, return the simplified {filename}. | |
| 5339 The simplification step is done as by |simplify()|. | |
| 5340 resolve() keeps a leading path component specifying the | |
| 5341 current directory (provided the result is still a relative | |
| 5342 path name) and also keeps a trailing path separator. | |
| 5343 | |
| 82 | 5344 *reverse()* |
| 1621 | 5345 reverse({list}) Reverse the order of items in {list} in-place. Returns |
| 82 | 5346 {list}. |
| 5347 If you want a list to remain unmodified make a copy first: > | |
| 5348 :let revlist = reverse(copy(mylist)) | |
| 5349 | |
| 1621 | 5350 round({expr}) *round()* |
| 1668 | 5351 Round off {expr} to the nearest integral value and return it |
| 1621 | 5352 as a |Float|. If {expr} lies halfway between two integral |
| 5353 values, then use the larger one (away from zero). | |
| 5354 {expr} must evaluate to a |Float| or a |Number|. | |
| 5355 Examples: > | |
| 5356 echo round(0.456) | |
| 5357 < 0.0 > | |
| 5358 echo round(4.5) | |
| 5359 < 5.0 > | |
| 5360 echo round(-4.5) | |
| 5361 < -5.0 | |
| 5362 {only available when compiled with the |+float| feature} | |
| 3996 | 5363 |
|
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5364 screenattr(row, col) *screenattr()* |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5365 Like screenchar(), but return the attribute. This is a rather |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5366 arbitrary number that can only be used to compare to the |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5367 attribute at other positions. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5368 |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5369 screenchar(row, col) *screenchar()* |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5370 The result is a Number, which is the character at position |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5371 [row, col] on the screen. This works for every possible |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5372 screen position, also status lines, window separators and the |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5373 command line. The top left position is row one, column one |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5374 The character excludes composing characters. For double-byte |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5375 encodings it may only be the first byte. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5376 This is mainly to be used for testing. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5377 Returns -1 when row or col is out of range. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5378 |
| 3996 | 5379 screencol() *screencol()* |
| 5380 The result is a Number, which is the current screen column of | |
| 5381 the cursor. The leftmost column has number 1. | |
| 5382 This function is mainly used for testing. | |
| 5383 | |
| 5384 Note: Always returns the current screen column, thus if used | |
| 5385 in a command (e.g. ":echo screencol()") it will return the | |
| 5386 column inside the command line, which is 1 when the command is | |
| 5387 executed. To get the cursor position in the file use one of | |
| 5388 the following mappings: > | |
| 5389 nnoremap <expr> GG ":echom ".screencol()."\n" | |
| 5390 nnoremap <silent> GG :echom screencol()<CR> | |
| 5391 < | |
| 5392 screenrow() *screenrow()* | |
| 5393 The result is a Number, which is the current screen row of the | |
| 5394 cursor. The top line has number one. | |
| 5395 This function is mainly used for testing. | |
| 5396 | |
| 5397 Note: Same restrictions as with |screencol()|. | |
| 5398 | |
| 1496 | 5399 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()* |
| 7 | 5400 Search for regexp pattern {pattern}. The search starts at the |
| 119 | 5401 cursor position (you can use |cursor()| to set it). |
| 707 | 5402 |
| 3967 | 5403 When a match has been found its line number is returned. |
| 3312 | 5404 If there is no match a 0 is returned and the cursor doesn't |
| 5405 move. No error message is given. | |
| 5406 | |
| 7 | 5407 {flags} is a String, which can contain these character flags: |
|
7358
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5408 'b' search Backward instead of forward |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5409 'c' accept a match at the Cursor position |
| 712 | 5410 'e' move to the End of the match |
| 20 | 5411 'n' do Not move the cursor |
|
7358
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5412 'p' return number of matching sub-Pattern (see below) |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5413 's' Set the ' mark at the previous location of the cursor |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5414 'w' Wrap around the end of the file |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5415 'W' don't Wrap around the end of the file |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5416 'z' start searching at the cursor column instead of zero |
| 7 | 5417 If neither 'w' or 'W' is given, the 'wrapscan' option applies. |
| 5418 | |
| 444 | 5419 If the 's' flag is supplied, the ' mark is set, only if the |
| 5420 cursor is moved. The 's' flag cannot be combined with the 'n' | |
| 5421 flag. | |
| 5422 | |
| 1156 | 5423 'ignorecase', 'smartcase' and 'magic' are used. |
|
7358
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5424 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5425 When the 'z' flag is not given, searching always starts in |
|
7358
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5426 column zero and then matches before the cursor are skipped. |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5427 When the 'c' flag is present in 'cpo' the next search starts |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5428 after the match. Without the 'c' flag the next search starts |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
5429 one column further. |
| 1156 | 5430 |
| 692 | 5431 When the {stopline} argument is given then the search stops |
| 5432 after searching this line. This is useful to restrict the | |
| 5433 search to a range of lines. Examples: > | |
| 5434 let match = search('(', 'b', line("w0")) | |
| 5435 let end = search('END', '', line("w$")) | |
| 5436 < When {stopline} is used and it is not zero this also implies | |
| 5437 that the search does not wrap around the end of the file. | |
| 1496 | 5438 A zero value is equal to not giving the argument. |
| 5439 | |
| 5440 When the {timeout} argument is given the search stops when | |
| 3513 | 5441 more than this many milliseconds have passed. Thus when |
| 1496 | 5442 {timeout} is 500 the search stops after half a second. |
| 5443 The value must not be negative. A zero value is like not | |
| 5444 giving the argument. | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
5445 {only available when compiled with the |+reltime| feature} |
| 692 | 5446 |
| 714 | 5447 *search()-sub-match* |
| 5448 With the 'p' flag the returned value is one more than the | |
| 5449 first sub-match in \(\). One if none of them matched but the | |
| 5450 whole pattern did match. | |
| 712 | 5451 To get the column number too use |searchpos()|. |
| 5452 | |
| 20 | 5453 The cursor will be positioned at the match, unless the 'n' |
| 707 | 5454 flag is used. |
| 7 | 5455 |
| 5456 Example (goes over all files in the argument list): > | |
| 5457 :let n = 1 | |
| 5458 :while n <= argc() " loop over all files in arglist | |
| 5459 : exe "argument " . n | |
| 5460 : " start at the last char in the file and wrap for the | |
| 5461 : " first search to find match at start of file | |
| 5462 : normal G$ | |
| 5463 : let flags = "w" | |
| 5464 : while search("foo", flags) > 0 | |
| 1621 | 5465 : s/foo/bar/g |
| 7 | 5466 : let flags = "W" |
| 5467 : endwhile | |
| 5468 : update " write the file if modified | |
| 5469 : let n = n + 1 | |
| 5470 :endwhile | |
| 5471 < | |
| 712 | 5472 Example for using some flags: > |
| 5473 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
| 5474 < This will search for the keywords "if", "else", and "endif" | |
| 5475 under or after the cursor. Because of the 'p' flag, it | |
| 5476 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
| 5477 if the search fails. With the cursor on the first word of the | |
| 5478 line: | |
| 5479 if (foo == 0) | let foo = foo + 1 | endif ~ | |
| 5480 the function returns 1. Without the 'c' flag, the function | |
| 5481 finds the "endif" and returns 3. The same thing happens | |
| 5482 without the 'e' flag if the cursor is on the "f" of "if". | |
| 5483 The 'n' flag tells the function not to move the cursor. | |
| 5484 | |
| 504 | 5485 |
| 523 | 5486 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
| 5487 Search for the declaration of {name}. | |
| 856 | 5488 |
| 523 | 5489 With a non-zero {global} argument it works like |gD|, find |
| 5490 first match in the file. Otherwise it works like |gd|, find | |
| 5491 first match in the function. | |
| 5492 | |
| 5493 With a non-zero {thisblock} argument matches in a {} block | |
| 5494 that ends before the cursor position are ignored. Avoids | |
| 5495 finding variable declarations only valid in another scope. | |
| 5496 | |
| 504 | 5497 Moves the cursor to the found match. |
| 5498 Returns zero for success, non-zero for failure. | |
| 5499 Example: > | |
| 5500 if searchdecl('myvar') == 0 | |
| 5501 echo getline('.') | |
| 5502 endif | |
| 5503 < | |
| 7 | 5504 *searchpair()* |
| 1496 | 5505 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
| 5506 [, {stopline} [, {timeout}]]]]) | |
| 7 | 5507 Search for the match of a nested start-end pair. This can be |
| 5508 used to find the "endif" that matches an "if", while other | |
| 5509 if/endif pairs in between are ignored. | |
| 677 | 5510 The search starts at the cursor. The default is to search |
| 5511 forward, include 'b' in {flags} to search backward. | |
| 5512 If a match is found, the cursor is positioned at it and the | |
| 5513 line number is returned. If no match is found 0 or -1 is | |
| 5514 returned and the cursor doesn't move. No error message is | |
| 5515 given. | |
| 7 | 5516 |
| 5517 {start}, {middle} and {end} are patterns, see |pattern|. They | |
| 5518 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
| 5519 {middle} is not empty, it is found when searching from either | |
| 5520 direction, but only when not in a nested start-end pair. A | |
| 5521 typical use is: > | |
| 5522 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
| 5523 < By leaving {middle} empty the "else" is skipped. | |
| 5524 | |
| 712 | 5525 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
| 5526 |search()|. Additionally: | |
| 7 | 5527 'r' Repeat until no more matches found; will find the |
| 1621 | 5528 outer pair. Implies the 'W' flag. |
| 5529 'm' Return number of matches instead of line number with | |
| 712 | 5530 the match; will be > 1 when 'r' is used. |
| 1621 | 5531 Note: it's nearly always a good idea to use the 'W' flag, to |
| 5532 avoid wrapping around the end of the file. | |
| 7 | 5533 |
| 5534 When a match for {start}, {middle} or {end} is found, the | |
| 5535 {skip} expression is evaluated with the cursor positioned on | |
| 5536 the start of the match. It should return non-zero if this | |
| 5537 match is to be skipped. E.g., because it is inside a comment | |
| 5538 or a string. | |
| 5539 When {skip} is omitted or empty, every match is accepted. | |
| 5540 When evaluating {skip} causes an error the search is aborted | |
| 5541 and -1 returned. | |
| 5542 | |
| 1496 | 5543 For {stopline} and {timeout} see |search()|. |
| 692 | 5544 |
| 7 | 5545 The value of 'ignorecase' is used. 'magic' is ignored, the |
| 5546 patterns are used like it's on. | |
| 5547 | |
| 5548 The search starts exactly at the cursor. A match with | |
| 5549 {start}, {middle} or {end} at the next character, in the | |
| 5550 direction of searching, is the first one found. Example: > | |
| 5551 if 1 | |
| 5552 if 2 | |
| 5553 endif 2 | |
| 5554 endif 1 | |
| 5555 < When starting at the "if 2", with the cursor on the "i", and | |
| 5556 searching forwards, the "endif 2" is found. When starting on | |
| 5557 the character just before the "if 2", the "endif 1" will be | |
| 1621 | 5558 found. That's because the "if 2" will be found first, and |
| 7 | 5559 then this is considered to be a nested if/endif from "if 2" to |
| 5560 "endif 2". | |
| 5561 When searching backwards and {end} is more than one character, | |
| 5562 it may be useful to put "\zs" at the end of the pattern, so | |
| 5563 that when the cursor is inside a match with the end it finds | |
| 5564 the matching start. | |
| 5565 | |
| 5566 Example, to find the "endif" command in a Vim script: > | |
| 5567 | |
| 5568 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
| 5569 \ 'getline(".") =~ "^\\s*\""') | |
| 5570 | |
| 5571 < The cursor must be at or after the "if" for which a match is | |
| 5572 to be found. Note that single-quote strings are used to avoid | |
| 5573 having to double the backslashes. The skip expression only | |
| 5574 catches comments at the start of a line, not after a command. | |
| 5575 Also, a word "en" or "if" halfway a line is considered a | |
| 5576 match. | |
| 5577 Another example, to search for the matching "{" of a "}": > | |
| 5578 | |
| 5579 :echo searchpair('{', '', '}', 'bW') | |
| 5580 | |
| 5581 < This works when the cursor is at or before the "}" for which a | |
| 5582 match is to be found. To reject matches that syntax | |
| 5583 highlighting recognized as strings: > | |
| 5584 | |
| 5585 :echo searchpair('{', '', '}', 'bW', | |
| 5586 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
| 5587 < | |
| 667 | 5588 *searchpairpos()* |
| 1496 | 5589 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
| 5590 [, {stopline} [, {timeout}]]]]) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5591 Same as |searchpair()|, but returns a |List| with the line and |
| 685 | 5592 column position of the match. The first element of the |List| |
| 5593 is the line number and the second element is the byte index of | |
| 667 | 5594 the column position of the match. If no match is found, |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5595 returns [0, 0]. > |
|
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5596 |
| 667 | 5597 :let [lnum,col] = searchpairpos('{', '', '}', 'n') |
| 5598 < | |
| 5599 See |match-parens| for a bigger and more useful example. | |
| 5600 | |
| 1496 | 5601 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()* |
| 692 | 5602 Same as |search()|, but returns a |List| with the line and |
| 685 | 5603 column position of the match. The first element of the |List| |
| 5604 is the line number and the second element is the byte index of | |
| 5605 the column position of the match. If no match is found, | |
| 5606 returns [0, 0]. | |
| 714 | 5607 Example: > |
| 5608 :let [lnum, col] = searchpos('mypattern', 'n') | |
| 5609 | |
| 5610 < When the 'p' flag is given then there is an extra item with | |
| 5611 the sub-pattern match number |search()-sub-match|. Example: > | |
| 5612 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
| 5613 < In this example "submatch" is 2 when a lowercase letter is | |
| 5614 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
| 5615 | |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5616 sendexpr({handle}, {expr} [, {callback}]) *sendexpr()* |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5617 Send {expr} over JSON channel {handle}. See |channel-use|. |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5618 |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5619 When {callback} is given returns immediately. Without |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5620 {callback} waits for a JSON response and returns the decoded |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5621 expression. When there is an error or timeout returns an |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5622 empty string. |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5623 |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5624 When {callback} is zero no response is expected. |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5625 Otherwise {callback} must be a Funcref or the name of a |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5626 function. It is called when the response is received. See |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5627 |channel-callback|. |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5628 |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5629 sendraw({handle}, {string} [, {callback}]) *sendraw()* |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5630 Send {string} over raw channel {handle}. See |channel-raw|. |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5631 Works like |sendexpr()|, but does not decode the response. |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5632 |
| 7 | 5633 server2client( {clientid}, {string}) *server2client()* |
| 5634 Send a reply string to {clientid}. The most recent {clientid} | |
| 5635 that sent a string can be retrieved with expand("<client>"). | |
| 5636 {only available when compiled with the |+clientserver| feature} | |
| 5637 Note: | |
| 5638 This id has to be stored before the next command can be | |
| 236 | 5639 received. I.e. before returning from the received command and |
| 7 | 5640 before calling any commands that waits for input. |
| 5641 See also |clientserver|. | |
| 5642 Example: > | |
| 5643 :echo server2client(expand("<client>"), "HELLO") | |
| 5644 < | |
| 5645 serverlist() *serverlist()* | |
| 5646 Return a list of available server names, one per line. | |
| 5647 When there are no servers or the information is not available | |
| 5648 an empty string is returned. See also |clientserver|. | |
| 5649 {only available when compiled with the |+clientserver| feature} | |
| 5650 Example: > | |
| 5651 :echo serverlist() | |
| 5652 < | |
| 5653 setbufvar({expr}, {varname}, {val}) *setbufvar()* | |
| 5654 Set option or local variable {varname} in buffer {expr} to | |
| 5655 {val}. | |
| 5656 This also works for a global or local window option, but it | |
| 5657 doesn't work for a global or local window variable. | |
| 5658 For a local window option the global value is unchanged. | |
| 5659 For the use of {expr}, see |bufname()| above. | |
| 5660 Note that the variable name without "b:" must be used. | |
| 5661 Examples: > | |
| 5662 :call setbufvar(1, "&mod", 1) | |
| 5663 :call setbufvar("todo", "myvar", "foobar") | |
| 5664 < This function is not available in the |sandbox|. | |
| 5665 | |
|
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
5666 setcharsearch({dict}) *setcharsearch()* |
| 6991 | 5667 Set the current character search information to {dict}, |
| 5668 which contains one or more of the following entries: | |
| 5669 | |
| 5670 char character which will be used for a subsequent | |
| 5671 |,| or |;| command; an empty string clears the | |
| 5672 character search | |
| 5673 forward direction of character search; 1 for forward, | |
| 5674 0 for backward | |
| 5675 until type of character search; 1 for a |t| or |T| | |
| 5676 character search, 0 for an |f| or |F| | |
| 5677 character search | |
| 5678 | |
| 5679 This can be useful to save/restore a user's character search | |
| 5680 from a script: > | |
| 5681 :let prevsearch = getcharsearch() | |
| 5682 :" Perform a command which clobbers user's search | |
| 5683 :call setcharsearch(prevsearch) | |
| 5684 < Also see |getcharsearch()|. | |
| 5685 | |
| 7 | 5686 setcmdpos({pos}) *setcmdpos()* |
| 5687 Set the cursor position in the command line to byte position | |
| 1621 | 5688 {pos}. The first position is 1. |
| 7 | 5689 Use |getcmdpos()| to obtain the current position. |
| 5690 Only works while editing the command line, thus you must use | |
| 99 | 5691 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
| 5692 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
| 5693 set after the command line is set to the expression. For | |
| 5694 |c_CTRL-R_=| it is set after evaluating the expression but | |
| 5695 before inserting the resulting text. | |
| 7 | 5696 When the number is too big the cursor is put at the end of the |
| 5697 line. A number smaller than one has undefined results. | |
| 5698 Returns 0 when successful, 1 when not editing the command | |
| 5699 line. | |
| 5700 | |
| 1621 | 5701 setline({lnum}, {text}) *setline()* |
| 3312 | 5702 Set line {lnum} of the current buffer to {text}. To insert |
| 5703 lines use |append()|. | |
| 236 | 5704 {lnum} is used like with |getline()|. |
| 1621 | 5705 When {lnum} is just below the last line the {text} will be |
| 282 | 5706 added as a new line. |
| 236 | 5707 If this succeeds, 0 is returned. If this fails (most likely |
| 5708 because {lnum} is invalid) 1 is returned. Example: > | |
| 7 | 5709 :call setline(5, strftime("%c")) |
| 1621 | 5710 < When {text} is a |List| then line {lnum} and following lines |
| 282 | 5711 will be set to the items in the list. Example: > |
| 5712 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
| 5713 < This is equivalent to: > | |
| 3465 | 5714 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']] |
| 282 | 5715 : call setline(n, l) |
| 5716 :endfor | |
| 7 | 5717 < Note: The '[ and '] marks are not set. |
| 5718 | |
| 647 | 5719 setloclist({nr}, {list} [, {action}]) *setloclist()* |
| 5720 Create or replace or add to the location list for window {nr}. | |
| 5721 When {nr} is zero the current window is used. For a location | |
| 648 | 5722 list window, the displayed location list is modified. For an |
| 5723 invalid window number {nr}, -1 is returned. | |
| 1326 | 5724 Otherwise, same as |setqflist()|. |
| 5725 Also see |location-list|. | |
| 5726 | |
| 5727 setmatches({list}) *setmatches()* | |
| 5728 Restores a list of matches saved by |getmatches()|. Returns 0 | |
| 1621 | 5729 if successful, otherwise -1. All current matches are cleared |
| 1326 | 5730 before the list is restored. See example for |getmatches()|. |
| 230 | 5731 |
| 707 | 5732 *setpos()* |
| 5733 setpos({expr}, {list}) | |
| 5734 Set the position for {expr}. Possible values: | |
| 5735 . the cursor | |
| 5736 'x mark x | |
| 5737 | |
| 5938 | 5738 {list} must be a |List| with four or five numbers: |
| 707 | 5739 [bufnum, lnum, col, off] |
| 5938 | 5740 [bufnum, lnum, col, off, curswant] |
| 707 | 5741 |
| 1621 | 5742 "bufnum" is the buffer number. Zero can be used for the |
| 856 | 5743 current buffer. Setting the cursor is only possible for |
| 707 | 5744 the current buffer. To set a mark in another buffer you can |
| 5745 use the |bufnr()| function to turn a file name into a buffer | |
| 5746 number. | |
| 798 | 5747 Does not change the jumplist. |
| 707 | 5748 |
| 5749 "lnum" and "col" are the position in the buffer. The first | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5750 column is 1. Use a zero "lnum" to delete a mark. If "col" is |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5751 smaller than 1 then 1 is used. |
| 707 | 5752 |
| 5753 The "off" number is only used when 'virtualedit' is set. Then | |
| 5754 it is the offset in screen columns from the start of the | |
| 1266 | 5755 character. E.g., a position within a <Tab> or after the last |
| 707 | 5756 character. |
| 5757 | |
| 5938 | 5758 The "curswant" number is only used when setting the cursor |
| 5759 position. It sets the preferred column for when moving the | |
| 5760 cursor vertically. When the "curswant" number is missing the | |
| 5761 preferred column is not set. When it is present and setting a | |
| 5762 mark position it is not used. | |
| 5763 | |
| 5555 | 5764 Note that for '< and '> changing the line number may result in |
| 5765 the marks to be effectively be swapped, so that '< is always | |
| 5766 before '>. | |
| 5767 | |
| 1533 | 5768 Returns 0 when the position could be set, -1 otherwise. |
| 5769 An error message is given if {expr} is invalid. | |
| 5770 | |
| 5944 | 5771 Also see |getpos()| and |getcurpos()|. |
| 707 | 5772 |
| 1156 | 5773 This does not restore the preferred column for moving |
| 5938 | 5774 vertically; if you set the cursor position with this, |j| and |
| 5775 |k| motions will jump to previous columns! Use |cursor()| to | |
| 5776 also set the preferred column. Also see the "curswant" key in | |
| 5777 |winrestview()|. | |
| 1156 | 5778 |
| 707 | 5779 |
| 277 | 5780 setqflist({list} [, {action}]) *setqflist()* |
| 647 | 5781 Create or replace or add to the quickfix list using the items |
| 5782 in {list}. Each item in {list} is a dictionary. | |
| 5783 Non-dictionary items in {list} are ignored. Each dictionary | |
| 5784 item can contain the following entries: | |
| 230 | 5785 |
| 1065 | 5786 bufnr buffer number; must be the number of a valid |
| 1621 | 5787 buffer |
| 1065 | 5788 filename name of a file; only used when "bufnr" is not |
| 1621 | 5789 present or it is invalid. |
| 230 | 5790 lnum line number in the file |
| 233 | 5791 pattern search pattern used to locate the error |
| 230 | 5792 col column number |
| 233 | 5793 vcol when non-zero: "col" is visual column |
| 856 | 5794 when zero: "col" is byte index |
| 233 | 5795 nr error number |
| 230 | 5796 text description of the error |
| 233 | 5797 type single-character error type, 'E', 'W', etc. |
| 5798 | |
| 5799 The "col", "vcol", "nr", "type" and "text" entries are | |
| 5800 optional. Either "lnum" or "pattern" entry can be used to | |
| 5801 locate a matching error line. | |
| 1065 | 5802 If the "filename" and "bufnr" entries are not present or |
| 5803 neither the "lnum" or "pattern" entries are present, then the | |
| 5804 item will not be handled as an error line. | |
| 230 | 5805 If both "pattern" and "lnum" are present then "pattern" will |
| 5806 be used. | |
| 2152 | 5807 If you supply an empty {list}, the quickfix list will be |
| 5808 cleared. | |
| 1065 | 5809 Note that the list is not exactly the same as what |
| 5810 |getqflist()| returns. | |
| 230 | 5811 |
| 277 | 5812 If {action} is set to 'a', then the items from {list} are |
| 5813 added to the existing quickfix list. If there is no existing | |
| 5814 list, then a new list is created. If {action} is set to 'r', | |
| 5815 then the items from the current quickfix list are replaced | |
| 5816 with the items from {list}. If {action} is not present or is | |
| 5817 set to ' ', then a new list is created. | |
| 5818 | |
| 230 | 5819 Returns zero for success, -1 for failure. |
| 5820 | |
| 5821 This function can be used to create a quickfix list | |
| 5822 independent of the 'errorformat' setting. Use a command like | |
| 5823 ":cc 1" to jump to the first position. | |
| 5824 | |
| 5825 | |
| 7 | 5826 *setreg()* |
| 5827 setreg({regname}, {value} [,{options}]) | |
| 5828 Set the register {regname} to {value}. | |
| 5798 | 5829 {value} may be any value returned by |getreg()|, including |
| 5830 a |List|. | |
| 7 | 5831 If {options} contains "a" or {regname} is upper case, |
| 5832 then the value is appended. | |
| 2423 | 5833 {options} can also contain a register type specification: |
| 7 | 5834 "c" or "v" |characterwise| mode |
| 5835 "l" or "V" |linewise| mode | |
| 5836 "b" or "<CTRL-V>" |blockwise-visual| mode | |
| 5837 If a number immediately follows "b" or "<CTRL-V>" then this is | |
| 5838 used as the width of the selection - if it is not specified | |
| 5839 then the width of the block is set to the number of characters | |
| 1266 | 5840 in the longest line (counting a <Tab> as 1 character). |
| 7 | 5841 |
| 5842 If {options} contains no register settings, then the default | |
| 5798 | 5843 is to use character mode unless {value} ends in a <NL> for |
| 5844 string {value} and linewise mode for list {value}. Blockwise | |
| 5845 mode is never selected automatically. | |
| 5846 Returns zero for success, non-zero for failure. | |
| 5847 | |
| 5848 *E883* | |
| 6180 | 5849 Note: you may not use |List| containing more than one item to |
| 5798 | 5850 set search and expression registers. Lists containing no |
| 5851 items act like empty strings. | |
| 7 | 5852 |
| 5853 Examples: > | |
| 5854 :call setreg(v:register, @*) | |
| 5855 :call setreg('*', @%, 'ac') | |
| 5856 :call setreg('a', "1\n2\n3", 'b5') | |
| 5857 | |
| 5858 < This example shows using the functions to save and restore a | |
| 5798 | 5859 register (note: you may not reliably restore register value |
| 5860 without using the third argument to |getreg()| as without it | |
| 5861 newlines are represented as newlines AND Nul bytes are | |
| 5862 represented as newlines as well, see |NL-used-for-Nul|). > | |
| 5863 :let var_a = getreg('a', 1, 1) | |
| 7 | 5864 :let var_amode = getregtype('a') |
| 5865 .... | |
| 5866 :call setreg('a', var_a, var_amode) | |
| 5867 | |
| 5868 < You can also change the type of a register by appending | |
| 5869 nothing: > | |
| 5870 :call setreg('a', '', 'al') | |
| 5871 | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5872 settabvar({tabnr}, {varname}, {val}) *settabvar()* |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5873 Set tab-local variable {varname} to {val} in tab page {tabnr}. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5874 |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5875 Note that the variable name without "t:" must be used. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5876 Tabs are numbered starting with one. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5877 This function is not available in the |sandbox|. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5878 |
| 831 | 5879 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
| 5880 Set option or local variable {varname} in window {winnr} to | |
| 5881 {val}. | |
| 5882 Tabs are numbered starting with one. For the current tabpage | |
| 5883 use |setwinvar()|. | |
| 5884 When {winnr} is zero the current window is used. | |
| 7 | 5885 This also works for a global or local buffer option, but it |
| 5886 doesn't work for a global or local buffer variable. | |
| 5887 For a local buffer option the global value is unchanged. | |
| 5888 Note that the variable name without "w:" must be used. | |
| 831 | 5889 Examples: > |
| 5890 :call settabwinvar(1, 1, "&list", 0) | |
| 5891 :call settabwinvar(3, 2, "myvar", "foobar") | |
| 5892 < This function is not available in the |sandbox|. | |
| 5893 | |
| 5894 setwinvar({nr}, {varname}, {val}) *setwinvar()* | |
| 5895 Like |settabwinvar()| for the current tab page. | |
| 7 | 5896 Examples: > |
| 5897 :call setwinvar(1, "&list", 0) | |
| 5898 :call setwinvar(2, "myvar", "foobar") | |
| 5899 | |
| 4126 | 5900 sha256({string}) *sha256()* |
| 6647 | 5901 Returns a String with 64 hex characters, which is the SHA256 |
| 4126 | 5902 checksum of {string}. |
| 5903 {only available when compiled with the |+cryptv| feature} | |
| 5904 | |
| 1661 | 5905 shellescape({string} [, {special}]) *shellescape()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5906 Escape {string} for use as a shell command argument. |
| 985 | 5907 On MS-Windows and MS-DOS, when 'shellslash' is not set, it |
| 1661 | 5908 will enclose {string} in double quotes and double all double |
| 985 | 5909 quotes within {string}. |
| 5910 For other systems, it will enclose {string} in single quotes | |
| 5911 and replace all "'" with "'\''". | |
| 1661 | 5912 When the {special} argument is present and it's a non-zero |
| 5913 Number or a non-empty String (|non-zero-arg|), then special | |
| 1698 | 5914 items such as "!", "%", "#" and "<cword>" will be preceded by |
| 5915 a backslash. This backslash will be removed again by the |:!| | |
| 1661 | 5916 command. |
| 1698 | 5917 The "!" character will be escaped (again with a |non-zero-arg| |
| 5918 {special}) when 'shell' contains "csh" in the tail. That is | |
| 5919 because for csh and tcsh "!" is used for history replacement | |
| 5920 even when inside single quotes. | |
| 5921 The <NL> character is also escaped. With a |non-zero-arg| | |
| 5922 {special} and 'shell' containing "csh" in the tail it's | |
| 5923 escaped a second time. | |
| 1661 | 5924 Example of use with a |:!| command: > |
| 5925 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
| 5926 < This results in a directory listing for the file under the | |
| 5927 cursor. Example of use with |system()|: > | |
| 5928 :call system("chmod +w -- " . shellescape(expand("%"))) | |
| 5690 | 5929 < See also |::S|. |
| 985 | 5930 |
| 5931 | |
| 3875 | 5932 shiftwidth() *shiftwidth()* |
| 5933 Returns the effective value of 'shiftwidth'. This is the | |
| 5934 'shiftwidth' value unless it is zero, in which case it is the | |
|
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
5935 'tabstop' value. This function was introduced with patch |
|
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
5936 7.3.694 in 2012, everybody should have it by now. |
| 3875 | 5937 |
| 5938 | |
| 7 | 5939 simplify({filename}) *simplify()* |
| 5940 Simplify the file name as much as possible without changing | |
| 5941 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
| 5942 Unix) are not resolved. If the first path component in | |
| 5943 {filename} designates the current directory, this will be | |
| 5944 valid for the result as well. A trailing path separator is | |
| 5945 not removed either. | |
| 5946 Example: > | |
| 5947 simplify("./dir/.././/file/") == "./file/" | |
| 5948 < Note: The combination "dir/.." is only removed if "dir" is | |
| 5949 a searchable directory or does not exist. On Unix, it is also | |
| 5950 removed when "dir" is a symbolic link within the same | |
| 5951 directory. In order to resolve all the involved symbolic | |
| 5952 links before simplifying the path name, use |resolve()|. | |
| 5953 | |
| 82 | 5954 |
| 1621 | 5955 sin({expr}) *sin()* |
| 5956 Return the sine of {expr}, measured in radians, as a |Float|. | |
| 5957 {expr} must evaluate to a |Float| or a |Number|. | |
| 5958 Examples: > | |
| 5959 :echo sin(100) | |
| 5960 < -0.506366 > | |
| 5961 :echo sin(-4.01) | |
| 5962 < 0.763301 | |
| 5963 {only available when compiled with the |+float| feature} | |
| 5964 | |
| 5965 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5966 sinh({expr}) *sinh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5967 Return the hyperbolic sine of {expr} as a |Float| in the range |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5968 [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5969 {expr} must evaluate to a |Float| or a |Number|. |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5970 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5971 :echo sinh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5972 < 0.521095 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5973 :echo sinh(-0.9) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5974 < -1.026517 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
5975 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5976 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5977 |
| 2902 | 5978 sort({list} [, {func} [, {dict}]]) *sort()* *E702* |
| 5747 | 5979 Sort the items in {list} in-place. Returns {list}. |
| 5980 | |
| 5981 If you want a list to remain unmodified make a copy first: > | |
| 82 | 5982 :let sortedlist = sort(copy(mylist)) |
| 5968 | 5983 |
| 6009 | 5984 < When {func} is omitted, is empty or zero, then sort() uses the |
| 5985 string representation of each item to sort on. Numbers sort | |
| 5986 after Strings, |Lists| after Numbers. For sorting text in the | |
| 5987 current buffer use |:sort|. | |
| 5988 | |
| 6180 | 5989 When {func} is given and it is '1' or 'i' then case is |
| 6009 | 5990 ignored. |
| 5991 | |
| 5992 When {func} is given and it is 'n' then all items will be | |
| 5993 sorted numerical (Implementation detail: This uses the | |
| 5994 strtod() function to parse numbers, Strings, Lists, Dicts and | |
| 5995 Funcrefs will be considered as being 0). | |
| 5996 | |
|
7291
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
5997 When {func} is given and it is 'N' then all items will be |
|
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
5998 sorted numerical. This is like 'n' but a string containing |
|
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
5999 digits will be used as the number they represent. |
|
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
6000 |
|
7707
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
6001 When {func} is given and it is 'f' then all items will be |
|
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
6002 sorted numerical. All values must be a Number or a Float. |
|
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
6003 |
| 685 | 6004 When {func} is a |Funcref| or a function name, this function |
| 6005 is called to compare items. The function is invoked with two | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6006 items as argument and must return zero if they are equal, 1 or |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6007 bigger if the first one sorts after the second one, -1 or |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6008 smaller if the first one sorts before the second one. |
| 5747 | 6009 |
| 6010 {dict} is for functions with the "dict" attribute. It will be | |
| 6011 used to set the local variable "self". |Dictionary-function| | |
| 6012 | |
|
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
6013 The sort is stable, items which compare equal (as number or as |
|
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
6014 string) will keep their relative position. E.g., when sorting |
| 6051 | 6015 on numbers, text strings will sort next to each other, in the |
|
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
6016 same order as they were originally. |
|
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
6017 |
| 5747 | 6018 Also see |uniq()|. |
| 6019 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6020 Example: > |
| 82 | 6021 func MyCompare(i1, i2) |
| 6022 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
| 6023 endfunc | |
| 6024 let sortedlist = sort(mylist, "MyCompare") | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6025 < A shorter compare version for this specific simple case, which |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6026 ignores overflow: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6027 func MyCompare(i1, i2) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6028 return a:i1 - a:i2 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6029 endfunc |
| 344 | 6030 < |
| 374 | 6031 *soundfold()* |
| 6032 soundfold({word}) | |
| 6033 Return the sound-folded equivalent of {word}. Uses the first | |
| 1621 | 6034 language in 'spelllang' for the current window that supports |
| 375 | 6035 soundfolding. 'spell' must be set. When no sound folding is |
| 6036 possible the {word} is returned unmodified. | |
| 374 | 6037 This can be used for making spelling suggestions. Note that |
| 6038 the method can be quite slow. | |
| 6039 | |
| 344 | 6040 *spellbadword()* |
| 532 | 6041 spellbadword([{sentence}]) |
| 6042 Without argument: The result is the badly spelled word under | |
| 6043 or after the cursor. The cursor is moved to the start of the | |
| 6044 bad word. When no bad word is found in the cursor line the | |
| 6045 result is an empty string and the cursor doesn't move. | |
| 6046 | |
| 6047 With argument: The result is the first word in {sentence} that | |
| 6048 is badly spelled. If there are no spelling mistakes the | |
| 6049 result is an empty string. | |
| 6050 | |
| 6051 The return value is a list with two items: | |
| 6052 - The badly spelled word or an empty string. | |
| 6053 - The type of the spelling error: | |
| 856 | 6054 "bad" spelling mistake |
| 532 | 6055 "rare" rare word |
| 6056 "local" word only valid in another region | |
| 6057 "caps" word should start with Capital | |
| 6058 Example: > | |
| 6059 echo spellbadword("the quik brown fox") | |
| 6060 < ['quik', 'bad'] ~ | |
| 6061 | |
| 6062 The spelling information for the current window is used. The | |
| 6063 'spell' option must be set and the value of 'spelllang' is | |
| 6064 used. | |
| 344 | 6065 |
| 6066 *spellsuggest()* | |
| 537 | 6067 spellsuggest({word} [, {max} [, {capital}]]) |
| 685 | 6068 Return a |List| with spelling suggestions to replace {word}. |
| 344 | 6069 When {max} is given up to this number of suggestions are |
| 6070 returned. Otherwise up to 25 suggestions are returned. | |
| 6071 | |
| 537 | 6072 When the {capital} argument is given and it's non-zero only |
| 6073 suggestions with a leading capital will be given. Use this | |
| 6074 after a match with 'spellcapcheck'. | |
| 6075 | |
| 344 | 6076 {word} can be a badly spelled word followed by other text. |
| 6077 This allows for joining two words that were split. The | |
| 359 | 6078 suggestions also include the following text, thus you can |
| 6079 replace a line. | |
| 6080 | |
| 6081 {word} may also be a good word. Similar words will then be | |
| 537 | 6082 returned. {word} itself is not included in the suggestions, |
| 6083 although it may appear capitalized. | |
| 344 | 6084 |
| 6085 The spelling information for the current window is used. The | |
| 375 | 6086 'spell' option must be set and the values of 'spelllang' and |
| 6087 'spellsuggest' are used. | |
| 344 | 6088 |
| 82 | 6089 |
| 282 | 6090 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
| 685 | 6091 Make a |List| out of {expr}. When {pattern} is omitted or |
| 6092 empty each white-separated sequence of characters becomes an | |
| 6093 item. | |
| 82 | 6094 Otherwise the string is split where {pattern} matches, |
| 3920 | 6095 removing the matched characters. 'ignorecase' is not used |
| 6096 here, add \c to ignore case. |/\c| | |
| 282 | 6097 When the first or last item is empty it is omitted, unless the |
| 6098 {keepempty} argument is given and it's non-zero. | |
| 293 | 6099 Other empty items are kept when {pattern} matches at least one |
| 6100 character or when {keepempty} is non-zero. | |
| 82 | 6101 Example: > |
| 95 | 6102 :let words = split(getline('.'), '\W\+') |
| 282 | 6103 < To split a string in individual characters: > |
| 236 | 6104 :for c in split(mystring, '\zs') |
|
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
6105 < If you want to keep the separator you can also use '\zs' at |
|
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
6106 the end of the pattern: > |
| 258 | 6107 :echo split('abc:def:ghi', ':\zs') |
| 6108 < ['abc:', 'def:', 'ghi'] ~ | |
| 282 | 6109 Splitting a table where the first element can be empty: > |
| 6110 :let items = split(line, ':', 1) | |
| 6111 < The opposite function is |join()|. | |
| 82 | 6112 |
| 6113 | |
| 1621 | 6114 sqrt({expr}) *sqrt()* |
| 6115 Return the non-negative square root of Float {expr} as a | |
| 6116 |Float|. | |
| 6117 {expr} must evaluate to a |Float| or a |Number|. When {expr} | |
| 6118 is negative the result is NaN (Not a Number). | |
| 6119 Examples: > | |
| 6120 :echo sqrt(100) | |
| 6121 < 10.0 > | |
| 6122 :echo sqrt(-4.01) | |
| 6123 < nan | |
| 1668 | 6124 "nan" may be different, it depends on system libraries. |
| 1621 | 6125 {only available when compiled with the |+float| feature} |
| 6126 | |
| 6127 | |
| 6128 str2float( {expr}) *str2float()* | |
| 6129 Convert String {expr} to a Float. This mostly works the same | |
| 6130 as when using a floating point number in an expression, see | |
| 6131 |floating-point-format|. But it's a bit more permissive. | |
| 6132 E.g., "1e40" is accepted, while in an expression you need to | |
| 6133 write "1.0e40". | |
| 6134 Text after the number is silently ignored. | |
| 6135 The decimal point is always '.', no matter what the locale is | |
| 6136 set to. A comma ends the number: "12,345.67" is converted to | |
| 6137 12.0. You can strip out thousands separators with | |
| 6138 |substitute()|: > | |
| 6139 let f = str2float(substitute(text, ',', '', 'g')) | |
| 6140 < {only available when compiled with the |+float| feature} | |
| 6141 | |
| 6142 | |
| 782 | 6143 str2nr( {expr} [, {base}]) *str2nr()* |
| 6144 Convert string {expr} to a number. | |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
6145 {base} is the conversion base, it can be 2, 8, 10 or 16. |
| 782 | 6146 When {base} is omitted base 10 is used. This also means that |
| 6147 a leading zero doesn't cause octal conversion to be used, as | |
| 6148 with the default String to Number conversion. | |
| 6149 When {base} is 16 a leading "0x" or "0X" is ignored. With a | |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
6150 different base the result will be zero. Similarly, when |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
6151 {base} is 8 a leading "0" is ignored, and when {base} is 2 a |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
6152 leading "0b" or "0B" is ignored. |
| 782 | 6153 Text after the number is silently ignored. |
| 856 | 6154 |
| 782 | 6155 |
| 6884 | 6156 strchars({expr} [, {skipcc}]) *strchars()* |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6157 The result is a Number, which is the number of characters |
| 6884 | 6158 in String {expr}. |
| 6159 When {skipcc} is omitted or zero, composing characters are | |
| 6160 counted separately. | |
| 6161 When {skipcc} set to 1, Composing characters are ignored. | |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6162 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6163 |
| 6918 | 6164 |
| 6165 {skipcc} is only available after 7.4.755. For backward | |
| 6166 compatibility, you can define a wrapper function: > | |
| 6167 if has("patch-7.4.755") | |
| 6168 function s:strchars(str, skipcc) | |
| 6169 return strchars(a:str, a:skipcc) | |
| 6170 endfunction | |
| 6171 else | |
| 6172 function s:strchars(str, skipcc) | |
| 6173 if a:skipcc | |
| 6174 return strlen(substitute(a:str, ".", "x", "g")) | |
| 6175 else | |
| 6176 return strchars(a:str) | |
| 6177 endif | |
| 6178 endfunction | |
| 6179 endif | |
| 6180 < | |
| 6181 | |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6182 strdisplaywidth({expr}[, {col}]) *strdisplaywidth()* |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6183 The result is a Number, which is the number of display cells |
| 6884 | 6184 String {expr} occupies on the screen when it starts at {col}. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6185 When {col} is omitted zero is used. Otherwise it is the |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6186 screen column where to start. This matters for Tab |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6187 characters. |
|
2343
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
6188 The option settings of the current window are used. This |
|
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
6189 matters for anything that's displayed differently, such as |
|
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
6190 'tabstop' and 'display'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6191 When {expr} contains characters with East Asian Width Class |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6192 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6193 Also see |strlen()|, |strwidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6194 |
| 7 | 6195 strftime({format} [, {time}]) *strftime()* |
| 6196 The result is a String, which is a formatted date and time, as | |
| 6197 specified by the {format} string. The given {time} is used, | |
| 6198 or the current time if no time is given. The accepted | |
| 6199 {format} depends on your system, thus this is not portable! | |
| 6200 See the manual page of the C function strftime() for the | |
| 6201 format. The maximum length of the result is 80 characters. | |
| 6202 See also |localtime()| and |getftime()|. | |
| 6203 The language can be changed with the |:language| command. | |
| 6204 Examples: > | |
| 6205 :echo strftime("%c") Sun Apr 27 11:49:23 1997 | |
| 6206 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 | |
| 6207 :echo strftime("%y%m%d %T") 970427 11:53:55 | |
| 6208 :echo strftime("%H:%M") 11:55 | |
| 6209 :echo strftime("%c", getftime("file.c")) | |
| 6210 Show mod time of file.c. | |
| 82 | 6211 < Not available on all systems. To check use: > |
| 6212 :if exists("*strftime") | |
| 6213 | |
| 133 | 6214 stridx({haystack}, {needle} [, {start}]) *stridx()* |
| 6215 The result is a Number, which gives the byte index in | |
| 6216 {haystack} of the first occurrence of the String {needle}. | |
| 140 | 6217 If {start} is specified, the search starts at index {start}. |
| 6218 This can be used to find a second match: > | |
| 2662 | 6219 :let colon1 = stridx(line, ":") |
| 6220 :let colon2 = stridx(line, ":", colon1 + 1) | |
| 140 | 6221 < The search is done case-sensitive. |
| 205 | 6222 For pattern searches use |match()|. |
| 133 | 6223 -1 is returned if the {needle} does not occur in {haystack}. |
| 140 | 6224 See also |strridx()|. |
| 6225 Examples: > | |
| 7 | 6226 :echo stridx("An Example", "Example") 3 |
| 6227 :echo stridx("Starting point", "Start") 0 | |
| 6228 :echo stridx("Starting point", "start") -1 | |
| 856 | 6229 < *strstr()* *strchr()* |
| 170 | 6230 stridx() works similar to the C function strstr(). When used |
| 6231 with a single character it works similar to strchr(). | |
| 6232 | |
| 55 | 6233 *string()* |
| 95 | 6234 string({expr}) Return {expr} converted to a String. If {expr} is a Number, |
| 1621 | 6235 Float, String or a composition of them, then the result can be |
| 6236 parsed back with |eval()|. | |
| 55 | 6237 {expr} type result ~ |
| 99 | 6238 String 'string' |
| 95 | 6239 Number 123 |
| 1621 | 6240 Float 123.123456 or 1.123456e8 |
| 99 | 6241 Funcref function('name') |
| 95 | 6242 List [item, item] |
| 323 | 6243 Dictionary {key: value, key: value} |
| 99 | 6244 Note that in String values the ' character is doubled. |
| 1156 | 6245 Also see |strtrans()|. |
| 55 | 6246 |
| 7 | 6247 *strlen()* |
| 6248 strlen({expr}) The result is a Number, which is the length of the String | |
| 502 | 6249 {expr} in bytes. |
| 55 | 6250 If the argument is a Number it is first converted to a String. |
| 6251 For other types an error is given. | |
| 6870 | 6252 If you want to count the number of multi-byte characters use |
| 6253 |strchars()|. | |
| 6254 Also see |len()|, |strdisplaywidth()| and |strwidth()|. | |
| 7 | 6255 |
| 6256 strpart({src}, {start}[, {len}]) *strpart()* | |
| 6257 The result is a String, which is part of {src}, starting from | |
| 574 | 6258 byte {start}, with the byte length {len}. |
| 7 | 6259 When non-existing bytes are included, this doesn't result in |
| 6260 an error, the bytes are simply omitted. | |
| 6261 If {len} is missing, the copy continues from {start} till the | |
| 6262 end of the {src}. > | |
| 6263 strpart("abcdefg", 3, 2) == "de" | |
| 6264 strpart("abcdefg", -2, 4) == "ab" | |
| 6265 strpart("abcdefg", 5, 4) == "fg" | |
| 1621 | 6266 strpart("abcdefg", 3) == "defg" |
| 7 | 6267 < Note: To get the first character, {start} must be 0. For |
| 6268 example, to get three bytes under and after the cursor: > | |
| 823 | 6269 strpart(getline("."), col(".") - 1, 3) |
| 7 | 6270 < |
| 140 | 6271 strridx({haystack}, {needle} [, {start}]) *strridx()* |
| 6272 The result is a Number, which gives the byte index in | |
| 6273 {haystack} of the last occurrence of the String {needle}. | |
| 6274 When {start} is specified, matches beyond this index are | |
| 6275 ignored. This can be used to find a match before a previous | |
| 6276 match: > | |
| 6277 :let lastcomma = strridx(line, ",") | |
| 6278 :let comma2 = strridx(line, ",", lastcomma - 1) | |
| 6279 < The search is done case-sensitive. | |
| 133 | 6280 For pattern searches use |match()|. |
| 6281 -1 is returned if the {needle} does not occur in {haystack}. | |
| 22 | 6282 If the {needle} is empty the length of {haystack} is returned. |
| 236 | 6283 See also |stridx()|. Examples: > |
| 7 | 6284 :echo strridx("an angry armadillo", "an") 3 |
| 856 | 6285 < *strrchr()* |
| 170 | 6286 When used with a single character it works similar to the C |
| 6287 function strrchr(). | |
| 6288 | |
| 7 | 6289 strtrans({expr}) *strtrans()* |
| 6290 The result is a String, which is {expr} with all unprintable | |
| 6291 characters translated into printable characters |'isprint'|. | |
| 6292 Like they are shown in a window. Example: > | |
| 6293 echo strtrans(@a) | |
| 6294 < This displays a newline in register a as "^@" instead of | |
| 6295 starting a new line. | |
| 6296 | |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6297 strwidth({expr}) *strwidth()* |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6298 The result is a Number, which is the number of display cells |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6299 String {expr} occupies. A Tab character is counted as one |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6300 cell, alternatively use |strdisplaywidth()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6301 When {expr} contains characters with East Asian Width Class |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6302 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6303 Also see |strlen()|, |strdisplaywidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6304 |
| 5794 | 6305 submatch({nr}[, {list}]) *submatch()* |
| 2908 | 6306 Only for an expression in a |:substitute| command or |
| 6307 substitute() function. | |
| 6308 Returns the {nr}'th submatch of the matched text. When {nr} | |
| 6309 is 0 the whole matched text is returned. | |
| 5794 | 6310 Note that a NL in the string can stand for a line break of a |
| 6311 multi-line match or a NUL character in the text. | |
| 2908 | 6312 Also see |sub-replace-expression|. |
| 5794 | 6313 |
| 6314 If {list} is present and non-zero then submatch() returns | |
| 6315 a list of strings, similar to |getline()| with two arguments. | |
| 6316 NL characters in the text represent NUL characters in the | |
| 6317 text. | |
| 6318 Only returns more than one item for |:substitute|, inside | |
| 6319 |substitute()| this list will always contain one or zero | |
| 6320 items, since there are no real line breaks. | |
| 6321 | |
| 7 | 6322 Example: > |
| 6323 :s/\d\+/\=submatch(0) + 1/ | |
| 6324 < This finds the first number in the line and adds one to it. | |
| 6325 A line break is included as a newline character. | |
| 6326 | |
| 6327 substitute({expr}, {pat}, {sub}, {flags}) *substitute()* | |
| 6328 The result is a String, which is a copy of {expr}, in which | |
| 2908 | 6329 the first match of {pat} is replaced with {sub}. |
| 6330 When {flags} is "g", all matches of {pat} in {expr} are | |
| 6331 replaced. Otherwise {flags} should be "". | |
| 6332 | |
| 6333 This works like the ":substitute" command (without any flags). | |
| 6334 But the matching with {pat} is always done like the 'magic' | |
| 6335 option is set and 'cpoptions' is empty (to make scripts | |
| 3967 | 6336 portable). 'ignorecase' is still relevant, use |/\c| or |/\C| |
| 6337 if you want to ignore or match case and ignore 'ignorecase'. | |
| 6338 'smartcase' is not used. See |string-match| for how {pat} is | |
| 6339 used. | |
| 2908 | 6340 |
| 6341 A "~" in {sub} is not replaced with the previous {sub}. | |
| 7 | 6342 Note that some codes in {sub} have a special meaning |
| 1621 | 6343 |sub-replace-special|. For example, to replace something with |
| 7 | 6344 "\n" (two characters), use "\\\\n" or '\\n'. |
| 2908 | 6345 |
| 7 | 6346 When {pat} does not match in {expr}, {expr} is returned |
| 6347 unmodified. | |
| 2908 | 6348 |
| 7 | 6349 Example: > |
| 6350 :let &path = substitute(&path, ",\\=[^,]*$", "", "") | |
| 6351 < This removes the last component of the 'path' option. > | |
| 6352 :echo substitute("testing", ".*", "\\U\\0", "") | |
| 6353 < results in "TESTING". | |
| 2908 | 6354 |
| 6355 When {sub} starts with "\=", the remainder is interpreted as | |
| 6356 an expression. See |sub-replace-expression|. Example: > | |
| 2833 | 6357 :echo substitute(s, '%\(\x\x\)', |
| 6358 \ '\=nr2char("0x" . submatch(1))', 'g') | |
| 7 | 6359 |
| 32 | 6360 synID({lnum}, {col}, {trans}) *synID()* |
| 7 | 6361 The result is a Number, which is the syntax ID at the position |
| 32 | 6362 {lnum} and {col} in the current window. |
| 7 | 6363 The syntax ID can be used with |synIDattr()| and |
| 6364 |synIDtrans()| to obtain syntax information about text. | |
| 419 | 6365 |
| 32 | 6366 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
| 419 | 6367 line. 'synmaxcol' applies, in a longer line zero is returned. |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
6368 Note that when the position is after the last character, |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
6369 that's where the cursor can be in Insert mode, synID() returns |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
6370 zero. |
| 419 | 6371 |
| 7 | 6372 When {trans} is non-zero, transparent items are reduced to the |
| 1621 | 6373 item that they reveal. This is useful when wanting to know |
| 7 | 6374 the effective color. When {trans} is zero, the transparent |
| 6375 item is returned. This is useful when wanting to know which | |
| 6376 syntax item is effective (e.g. inside parens). | |
| 6377 Warning: This function can be very slow. Best speed is | |
| 6378 obtained by going through the file in forward direction. | |
| 6379 | |
| 6380 Example (echoes the name of the syntax item under the cursor): > | |
| 6381 :echo synIDattr(synID(line("."), col("."), 1), "name") | |
| 6382 < | |
|
2401
e7751177126b
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
6383 |
| 7 | 6384 synIDattr({synID}, {what} [, {mode}]) *synIDattr()* |
| 6385 The result is a String, which is the {what} attribute of | |
| 6386 syntax ID {synID}. This can be used to obtain information | |
| 6387 about a syntax item. | |
| 6388 {mode} can be "gui", "cterm" or "term", to get the attributes | |
| 1621 | 6389 for that mode. When {mode} is omitted, or an invalid value is |
| 7 | 6390 used, the attributes for the currently active highlighting are |
| 6391 used (GUI, cterm or term). | |
| 6392 Use synIDtrans() to follow linked highlight groups. | |
| 6393 {what} result | |
| 6394 "name" the name of the syntax item | |
| 6395 "fg" foreground color (GUI: color name used to set | |
| 6396 the color, cterm: color number as a string, | |
| 6397 term: empty string) | |
| 1755 | 6398 "bg" background color (as with "fg") |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6399 "font" font name (only available in the GUI) |
|
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6400 |highlight-font| |
| 1755 | 6401 "sp" special color (as with "fg") |highlight-guisp| |
| 7 | 6402 "fg#" like "fg", but for the GUI and the GUI is |
| 6403 running the name in "#RRGGBB" form | |
| 6404 "bg#" like "fg#" for "bg" | |
| 1755 | 6405 "sp#" like "fg#" for "sp" |
| 7 | 6406 "bold" "1" if bold |
| 6407 "italic" "1" if italic | |
| 6408 "reverse" "1" if reverse | |
| 6409 "inverse" "1" if inverse (= reverse) | |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6410 "standout" "1" if standout |
| 7 | 6411 "underline" "1" if underlined |
| 205 | 6412 "undercurl" "1" if undercurled |
| 7 | 6413 |
| 6414 Example (echoes the color of the syntax item under the | |
| 6415 cursor): > | |
| 6416 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
| 6417 < | |
| 6418 synIDtrans({synID}) *synIDtrans()* | |
| 6419 The result is a Number, which is the translated syntax ID of | |
| 6420 {synID}. This is the syntax group ID of what is being used to | |
| 6421 highlight the character. Highlight links given with | |
| 6422 ":highlight link" are followed. | |
| 6423 | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6424 synconcealed({lnum}, {col}) *synconcealed()* |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6425 The result is a List. The first item in the list is 0 if the |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6426 character at the position {lnum} and {col} is not part of a |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6427 concealable region, 1 if it is. The second item in the list is |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6428 a string. If the first item is 1, the second item contains the |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6429 text which will be displayed in place of the concealed text, |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6430 depending on the current setting of 'conceallevel'. The third |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6431 and final item in the list is a unique number representing the |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6432 specific syntax region matched. This allows detection of the |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6433 beginning of a new concealable region if there are two |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6434 consecutive regions with the same replacement character. |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6435 For an example use see $VIMRUNTIME/syntax/2html.vim . |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6436 |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6437 |
| 1500 | 6438 synstack({lnum}, {col}) *synstack()* |
| 6439 Return a |List|, which is the stack of syntax items at the | |
| 6440 position {lnum} and {col} in the current window. Each item in | |
| 6441 the List is an ID like what |synID()| returns. | |
| 6442 The first item in the List is the outer region, following are | |
| 6443 items contained in that one. The last one is what |synID()| | |
| 6444 returns, unless not the whole item is highlighted or it is a | |
| 6445 transparent item. | |
| 6446 This function is useful for debugging a syntax file. | |
| 6447 Example that shows the syntax stack under the cursor: > | |
| 6448 for id in synstack(line("."), col(".")) | |
| 6449 echo synIDattr(id, "name") | |
| 6450 endfor | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6451 < When the position specified with {lnum} and {col} is invalid |
|
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6452 nothing is returned. The position just after the last |
|
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6453 character in a line and the first column in an empty line are |
|
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6454 valid positions. |
| 1500 | 6455 |
| 24 | 6456 system({expr} [, {input}]) *system()* *E677* |
| 5808 | 6457 Get the output of the shell command {expr} as a string. See |
| 6458 |systemlist()| to get the output as a List. | |
| 5806 | 6459 |
| 6460 When {input} is given and is a string this string is written | |
| 6461 to a file and passed as stdin to the command. The string is | |
| 6462 written as-is, you need to take care of using the correct line | |
| 6463 separators yourself. | |
| 6464 If {input} is given and is a |List| it is written to the file | |
| 6465 in a way |writefile()| does with {binary} set to "b" (i.e. | |
| 6466 with a newline between each list item with newlines inside | |
| 6467 list items converted to NULs). | |
| 6468 Pipes are not used. | |
| 6469 | |
| 6183 | 6470 When prepended by |:silent| the shell will not be set to |
| 6471 cooked mode. This is meant to be used for commands that do | |
| 6472 not need the user to type. It avoids stray characters showing | |
| 6473 up on the screen which require |CTRL-L| to remove. > | |
| 6474 :silent let f = system('ls *.vim') | |
| 6475 < | |
| 5690 | 6476 Note: Use |shellescape()| or |::S| with |expand()| or |
| 6477 |fnamemodify()| to escape special characters in a command | |
| 6478 argument. Newlines in {expr} may cause the command to fail. | |
| 6479 The characters in 'shellquote' and 'shellxquote' may also | |
| 6480 cause trouble. | |
| 7 | 6481 This is not to be used for interactive commands. |
| 1661 | 6482 |
| 7 | 6483 The result is a String. Example: > |
| 1661 | 6484 :let files = system("ls " . shellescape(expand('%:h'))) |
| 5690 | 6485 :let files = system('ls ' . expand('%:h:S')) |
| 7 | 6486 |
| 6487 < To make the result more system-independent, the shell output | |
| 6488 is filtered to replace <CR> with <NL> for Macintosh, and | |
| 6489 <CR><NL> with <NL> for DOS-like systems. | |
| 5277 | 6490 To avoid the string being truncated at a NUL, all NUL |
| 6491 characters are replaced with SOH (0x01). | |
| 6492 | |
| 7 | 6493 The command executed is constructed using several options: |
| 6494 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
| 6495 ({tmp} is an automatically generated file name). | |
| 6496 For Unix and OS/2 braces are put around {expr} to allow for | |
| 6497 concatenated commands. | |
| 6498 | |
| 794 | 6499 The command will be executed in "cooked" mode, so that a |
| 6500 CTRL-C will interrupt the command (on Unix at least). | |
| 6501 | |
| 7 | 6502 The resulting error code can be found in |v:shell_error|. |
| 6503 This function will fail in |restricted-mode|. | |
| 625 | 6504 |
| 6505 Note that any wrong value in the options mentioned above may | |
| 6506 make the function fail. It has also been reported to fail | |
| 6507 when using a security agent application. | |
| 7 | 6508 Unlike ":!cmd" there is no automatic check for changed files. |
| 6509 Use |:checktime| to force a check. | |
| 6510 | |
| 205 | 6511 |
| 5808 | 6512 systemlist({expr} [, {input}]) *systemlist()* |
| 6513 Same as |system()|, but returns a |List| with lines (parts of | |
| 6514 output separated by NL) with NULs transformed into NLs. Output | |
| 6515 is the same as |readfile()| will output with {binary} argument | |
| 6516 set to "b". | |
| 6517 | |
| 6518 Returns an empty string on error, so be careful not to run | |
| 6519 into |E706|. | |
| 6520 | |
| 6521 | |
| 677 | 6522 tabpagebuflist([{arg}]) *tabpagebuflist()* |
| 685 | 6523 The result is a |List|, where each item is the number of the |
| 677 | 6524 buffer associated with each window in the current tab page. |
| 6525 {arg} specifies the number of tab page to be used. When | |
| 6526 omitted the current tab page is used. | |
| 6527 When {arg} is invalid the number zero is returned. | |
| 6528 To get a list of all buffers in all tabs use this: > | |
| 3445 | 6529 let buflist = [] |
| 677 | 6530 for i in range(tabpagenr('$')) |
| 3445 | 6531 call extend(buflist, tabpagebuflist(i + 1)) |
| 677 | 6532 endfor |
| 6533 < Note that a buffer may appear in more than one window. | |
| 6534 | |
| 6535 | |
| 6536 tabpagenr([{arg}]) *tabpagenr()* | |
| 674 | 6537 The result is a Number, which is the number of the current |
| 6538 tab page. The first tab page has number 1. | |
| 6539 When the optional argument is "$", the number of the last tab | |
| 6540 page is returned (the tab page count). | |
| 6541 The number can be used with the |:tab| command. | |
| 6542 | |
| 6543 | |
| 5763 | 6544 tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()* |
|
2569
f612f6b0b883
Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6545 Like |winnr()| but for tab page {tabarg}. |
| 677 | 6546 {tabarg} specifies the number of tab page to be used. |
| 6547 {arg} is used like with |winnr()|: | |
| 6548 - When omitted the current window number is returned. This is | |
| 6549 the window which will be used when going to this tab page. | |
| 6550 - When "$" the number of windows is returned. | |
| 6551 - When "#" the previous window nr is returned. | |
| 6552 Useful examples: > | |
| 6553 tabpagewinnr(1) " current window of tab page 1 | |
| 6554 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
| 6555 < When {tabarg} is invalid zero is returned. | |
| 6556 | |
| 805 | 6557 *tagfiles()* |
| 6558 tagfiles() Returns a |List| with the file names used to search for tags | |
| 6559 for the current buffer. This is the 'tags' option expanded. | |
| 6560 | |
| 6561 | |
| 205 | 6562 taglist({expr}) *taglist()* |
| 6563 Returns a list of tags matching the regular expression {expr}. | |
| 438 | 6564 Each list item is a dictionary with at least the following |
| 6565 entries: | |
| 648 | 6566 name Name of the tag. |
| 6567 filename Name of the file where the tag is | |
| 1156 | 6568 defined. It is either relative to the |
| 6569 current directory or a full path. | |
| 205 | 6570 cmd Ex command used to locate the tag in |
| 6571 the file. | |
| 648 | 6572 kind Type of the tag. The value for this |
| 205 | 6573 entry depends on the language specific |
| 1156 | 6574 kind values. Only available when |
| 6575 using a tags file generated by | |
| 6576 Exuberant ctags or hdrtag. | |
| 648 | 6577 static A file specific tag. Refer to |
| 205 | 6578 |static-tag| for more information. |
| 1156 | 6579 More entries may be present, depending on the content of the |
| 6580 tags file: access, implementation, inherits and signature. | |
| 6581 Refer to the ctags documentation for information about these | |
| 6582 fields. For C code the fields "struct", "class" and "enum" | |
| 6583 may appear, they give the name of the entity the tag is | |
| 6584 contained in. | |
| 452 | 6585 |
| 216 | 6586 The ex-command 'cmd' can be either an ex search pattern, a |
| 6587 line number or a line number followed by a byte number. | |
| 205 | 6588 |
| 6589 If there are no matching tags, then an empty list is returned. | |
| 6590 | |
| 6591 To get an exact tag match, the anchors '^' and '$' should be | |
| 4073 | 6592 used in {expr}. This also make the function work faster. |
| 6593 Refer to |tag-regexp| for more information about the tag | |
| 6594 search regular expression pattern. | |
| 205 | 6595 |
| 6596 Refer to |'tags'| for information about how the tags file is | |
| 6597 located by Vim. Refer to |tags-file-format| for the format of | |
| 6598 the tags file generated by the different ctags tools. | |
| 6599 | |
| 7 | 6600 tempname() *tempname()* *temp-file-name* |
| 6601 The result is a String, which is the name of a file that | |
| 1621 | 6602 doesn't exist. It can be used for a temporary file. The name |
| 7 | 6603 is different for at least 26 consecutive calls. Example: > |
| 6604 :let tmpfile = tempname() | |
| 6605 :exe "redir > " . tmpfile | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6606 < For Unix, the file will be in a private directory |tempfile|. |
| 7 | 6607 For MS-Windows forward slashes are used when the 'shellslash' |
| 6608 option is set or when 'shellcmdflag' starts with '-'. | |
| 6609 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6610 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6611 tan({expr}) *tan()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6612 Return the tangent of {expr}, measured in radians, as a |Float| |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6613 in the range [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6614 {expr} must evaluate to a |Float| or a |Number|. |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6615 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6616 :echo tan(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6617 < 0.648361 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6618 :echo tan(-4.01) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6619 < -1.181502 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
6620 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6621 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6622 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6623 tanh({expr}) *tanh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6624 Return the hyperbolic tangent of {expr} as a |Float| in the |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6625 range [-1, 1]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6626 {expr} must evaluate to a |Float| or a |Number|. |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6627 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6628 :echo tanh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6629 < 0.462117 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6630 :echo tanh(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6631 < -0.761594 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
6632 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6633 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6634 |
| 7 | 6635 tolower({expr}) *tolower()* |
| 6636 The result is a copy of the String given, with all uppercase | |
| 6637 characters turned into lowercase (just like applying |gu| to | |
| 6638 the string). | |
| 6639 | |
| 6640 toupper({expr}) *toupper()* | |
| 6641 The result is a copy of the String given, with all lowercase | |
| 6642 characters turned into uppercase (just like applying |gU| to | |
| 6643 the string). | |
| 6644 | |
| 15 | 6645 tr({src}, {fromstr}, {tostr}) *tr()* |
| 6646 The result is a copy of the {src} string with all characters | |
| 6647 which appear in {fromstr} replaced by the character in that | |
| 6648 position in the {tostr} string. Thus the first character in | |
| 6649 {fromstr} is translated into the first character in {tostr} | |
| 6650 and so on. Exactly like the unix "tr" command. | |
| 6651 This code also deals with multibyte characters properly. | |
| 6652 | |
| 6653 Examples: > | |
| 6654 echo tr("hello there", "ht", "HT") | |
| 6655 < returns "Hello THere" > | |
| 6656 echo tr("<blob>", "<>", "{}") | |
| 6657 < returns "{blob}" | |
| 6658 | |
| 1621 | 6659 trunc({expr}) *trunc()* |
| 1668 | 6660 Return the largest integral value with magnitude less than or |
| 1621 | 6661 equal to {expr} as a |Float| (truncate towards zero). |
| 6662 {expr} must evaluate to a |Float| or a |Number|. | |
| 6663 Examples: > | |
| 6664 echo trunc(1.456) | |
| 6665 < 1.0 > | |
| 6666 echo trunc(-5.456) | |
| 6667 < -5.0 > | |
| 6668 echo trunc(4.0) | |
| 6669 < 4.0 | |
| 6670 {only available when compiled with the |+float| feature} | |
| 6671 | |
| 87 | 6672 *type()* |
| 6673 type({expr}) The result is a Number, depending on the type of {expr}: | |
| 153 | 6674 Number: 0 |
| 6675 String: 1 | |
| 6676 Funcref: 2 | |
| 6677 List: 3 | |
| 6678 Dictionary: 4 | |
| 1621 | 6679 Float: 5 |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6680 Boolean: 6 (v:false and v:true) |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6681 None 7 (v:null and v:none) |
| 153 | 6682 To avoid the magic numbers it should be used this way: > |
| 87 | 6683 :if type(myvar) == type(0) |
| 6684 :if type(myvar) == type("") | |
| 6685 :if type(myvar) == type(function("tr")) | |
| 6686 :if type(myvar) == type([]) | |
| 153 | 6687 :if type(myvar) == type({}) |
| 1621 | 6688 :if type(myvar) == type(0.0) |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6689 :if type(myvar) == type(v:false) |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6690 :if type(myvar) == type(v:none |
| 7 | 6691 |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6692 undofile({name}) *undofile()* |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6693 Return the name of the undo file that would be used for a file |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6694 with name {name} when writing. This uses the 'undodir' |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6695 option, finding directories that exist. It does not check if |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
6696 the undo file exists. |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
6697 {name} is always expanded to the full path, since that is what |
|
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
6698 is used internally. |
|
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
6699 If {name} is empty undofile() returns an empty string, since a |
|
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
6700 buffer without a file name will not write an undo file. |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6701 Useful in combination with |:wundo| and |:rundo|. |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6702 When compiled without the +persistent_undo option this always |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6703 returns an empty string. |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6704 |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6705 undotree() *undotree()* |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6706 Return the current state of the undo tree in a dictionary with |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6707 the following items: |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6708 "seq_last" The highest undo sequence number used. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6709 "seq_cur" The sequence number of the current position in |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6710 the undo tree. This differs from "seq_last" |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6711 when some changes were undone. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6712 "time_cur" Time last used for |:earlier| and related |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6713 commands. Use |strftime()| to convert to |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6714 something readable. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6715 "save_last" Number of the last file write. Zero when no |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6716 write yet. |
|
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
6717 "save_cur" Number of the current position in the undo |
|
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
6718 tree. |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6719 "synced" Non-zero when the last undo block was synced. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6720 This happens when waiting from input from the |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6721 user. See |undo-blocks|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6722 "entries" A list of dictionaries with information about |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6723 undo blocks. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6724 |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6725 The first item in the "entries" list is the oldest undo item. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6726 Each List item is a Dictionary with these items: |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6727 "seq" Undo sequence number. Same as what appears in |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6728 |:undolist|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6729 "time" Timestamp when the change happened. Use |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6730 |strftime()| to convert to something readable. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6731 "newhead" Only appears in the item that is the last one |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6732 that was added. This marks the last change |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6733 and where further changes will be added. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6734 "curhead" Only appears in the item that is the last one |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6735 that was undone. This marks the current |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6736 position in the undo tree, the block that will |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6737 be used by a redo command. When nothing was |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6738 undone after the last change this item will |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6739 not appear anywhere. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6740 "save" Only appears on the last block before a file |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6741 write. The number is the write count. The |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6742 first write has number 1, the last one the |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6743 "save_last" mentioned above. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6744 "alt" Alternate entry. This is again a List of undo |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6745 blocks. Each item may again have an "alt" |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6746 item. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6747 |
| 5747 | 6748 uniq({list} [, {func} [, {dict}]]) *uniq()* *E882* |
| 6749 Remove second and succeeding copies of repeated adjacent | |
| 6750 {list} items in-place. Returns {list}. If you want a list | |
| 6751 to remain unmodified make a copy first: > | |
| 6752 :let newlist = uniq(copy(mylist)) | |
| 6753 < The default compare function uses the string representation of | |
| 6754 each item. For the use of {func} and {dict} see |sort()|. | |
| 6755 | |
| 140 | 6756 values({dict}) *values()* |
| 1621 | 6757 Return a |List| with all the values of {dict}. The |List| is |
| 685 | 6758 in arbitrary order. |
| 140 | 6759 |
| 6760 | |
| 7 | 6761 virtcol({expr}) *virtcol()* |
| 6762 The result is a Number, which is the screen column of the file | |
| 6763 position given with {expr}. That is, the last screen position | |
| 6764 occupied by the character at that position, when the screen | |
| 6765 would be of unlimited width. When there is a <Tab> at the | |
| 6766 position, the returned Number will be the column at the end of | |
| 6767 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
| 3445 | 6768 set to 8, it returns 8. |conceal| is ignored. |
| 1317 | 6769 For the byte position use |col()|. |
| 6770 For the use of {expr} see |col()|. | |
| 6771 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
| 703 | 6772 "off" is the offset in screen columns from the start of the |
| 1266 | 6773 character. E.g., a position within a <Tab> or after the last |
| 2965 | 6774 character. When "off" is omitted zero is used. |
| 7 | 6775 When Virtual editing is active in the current mode, a position |
| 6776 beyond the end of the line can be returned. |'virtualedit'| | |
| 6777 The accepted positions are: | |
| 6778 . the cursor position | |
| 6779 $ the end of the cursor line (the result is the | |
| 6780 number of displayed characters in the cursor line | |
| 6781 plus one) | |
| 6782 'x position of mark x (if the mark is not set, 0 is | |
| 6783 returned) | |
| 6447 | 6784 v In Visual mode: the start of the Visual area (the |
| 6785 cursor is the end). When not in Visual mode | |
| 6786 returns the cursor position. Differs from |'<| in | |
| 6787 that it's updated right away. | |
| 7 | 6788 Note that only marks in the current file can be used. |
| 6789 Examples: > | |
| 6790 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
| 6791 virtcol("$") with text "foo^Lbar", returns 9 | |
| 1621 | 6792 virtcol("'t") with text " there", with 't at 'h', returns 6 |
| 6793 < The first column is 1. 0 is returned for an error. | |
| 1156 | 6794 A more advanced example that echoes the maximum length of |
| 6795 all lines: > | |
| 6796 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
| 6797 | |
| 7 | 6798 |
| 6799 visualmode([expr]) *visualmode()* | |
| 6800 The result is a String, which describes the last Visual mode | |
| 856 | 6801 used in the current buffer. Initially it returns an empty |
| 6802 string, but once Visual mode has been used, it returns "v", | |
| 6803 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
| 6804 character-wise, line-wise, or block-wise Visual mode | |
| 6805 respectively. | |
| 7 | 6806 Example: > |
| 6807 :exe "normal " . visualmode() | |
| 6808 < This enters the same Visual mode as before. It is also useful | |
| 6809 in scripts if you wish to act differently depending on the | |
| 6810 Visual mode that was used. | |
| 1621 | 6811 If Visual mode is active, use |mode()| to get the Visual mode |
| 6812 (e.g., in a |:vmap|). | |
| 1661 | 6813 *non-zero-arg* |
| 6814 If [expr] is supplied and it evaluates to a non-zero Number or | |
| 6815 a non-empty String, then the Visual mode will be cleared and | |
| 1621 | 6816 the old value is returned. Note that " " and "0" are also |
| 1661 | 6817 non-empty strings, thus cause the mode to be cleared. A List, |
| 6818 Dictionary or Float is not a Number or String, thus does not | |
| 6819 cause the mode to be cleared. | |
| 7 | 6820 |
| 4151 | 6821 wildmenumode() *wildmenumode()* |
| 6822 Returns non-zero when the wildmenu is active and zero | |
| 6823 otherwise. See 'wildmenu' and 'wildmode'. | |
| 6824 This can be used in mappings to handle the 'wildcharm' option | |
| 6825 gracefully. (Makes only sense with |mapmode-c| mappings). | |
| 6826 | |
| 6827 For example to make <c-j> work like <down> in wildmode, use: > | |
| 6828 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>" | |
| 6829 < | |
| 6830 (Note, this needs the 'wildcharm' option set appropriately). | |
| 6831 | |
| 6832 | |
| 7 | 6833 *winbufnr()* |
| 6834 winbufnr({nr}) The result is a Number, which is the number of the buffer | |
| 236 | 6835 associated with window {nr}. When {nr} is zero, the number of |
| 7 | 6836 the buffer in the current window is returned. When window |
| 6837 {nr} doesn't exist, -1 is returned. | |
| 6838 Example: > | |
| 6839 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
| 6840 < | |
| 6841 *wincol()* | |
| 6842 wincol() The result is a Number, which is the virtual column of the | |
| 6843 cursor in the window. This is counting screen cells from the | |
| 6844 left side of the window. The leftmost column is one. | |
| 6845 | |
| 6846 winheight({nr}) *winheight()* | |
| 6847 The result is a Number, which is the height of window {nr}. | |
| 6848 When {nr} is zero, the height of the current window is | |
| 6849 returned. When window {nr} doesn't exist, -1 is returned. | |
| 6850 An existing window always has a height of zero or more. | |
| 6851 Examples: > | |
| 6852 :echo "The current window has " . winheight(0) . " lines." | |
| 6853 < | |
| 6854 *winline()* | |
| 6855 winline() The result is a Number, which is the screen line of the cursor | |
| 1621 | 6856 in the window. This is counting screen lines from the top of |
| 7 | 6857 the window. The first line is one. |
| 531 | 6858 If the cursor was moved the view on the file will be updated |
| 6859 first, this may cause a scroll. | |
| 7 | 6860 |
| 6861 *winnr()* | |
| 20 | 6862 winnr([{arg}]) The result is a Number, which is the number of the current |
| 6863 window. The top window has number 1. | |
| 6864 When the optional argument is "$", the number of the | |
| 3967 | 6865 last window is returned (the window count). > |
| 6866 let window_count = winnr('$') | |
| 6867 < When the optional argument is "#", the number of the last | |
| 20 | 6868 accessed window is returned (where |CTRL-W_p| goes to). |
| 1156 | 6869 If there is no previous window or it is in another tab page 0 |
| 6870 is returned. | |
| 20 | 6871 The number can be used with |CTRL-W_w| and ":wincmd w" |
| 6872 |:wincmd|. | |
| 1156 | 6873 Also see |tabpagewinnr()|. |
| 7 | 6874 |
| 6875 *winrestcmd()* | |
| 6876 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
| 6877 the current window sizes. Only works properly when no windows | |
| 712 | 6878 are opened or closed and the current window and tab page is |
| 6879 unchanged. | |
| 7 | 6880 Example: > |
| 6881 :let cmd = winrestcmd() | |
| 6882 :call MessWithWindowSizes() | |
| 6883 :exe cmd | |
| 712 | 6884 < |
| 6885 *winrestview()* | |
| 6886 winrestview({dict}) | |
| 6887 Uses the |Dictionary| returned by |winsaveview()| to restore | |
| 6888 the view of the current window. | |
| 5940 | 6889 Note: The {dict} does not have to contain all values, that are |
| 6890 returned by |winsaveview()|. If values are missing, those | |
| 6891 settings won't be restored. So you can use: > | |
| 6892 :call winrestview({'curswant': 4}) | |
| 6893 < | |
| 6894 This will only set the curswant value (the column the cursor | |
| 6895 wants to move on vertical movements) of the cursor to column 5 | |
| 6896 (yes, that is 5), while all other settings will remain the | |
| 6897 same. This is useful, if you set the cursor position manually. | |
| 6898 | |
| 712 | 6899 If you have changed the values the result is unpredictable. |
| 6900 If the window size changed the result won't be the same. | |
| 6901 | |
| 6902 *winsaveview()* | |
| 6903 winsaveview() Returns a |Dictionary| that contains information to restore | |
| 6904 the view of the current window. Use |winrestview()| to | |
| 6905 restore the view. | |
| 6906 This is useful if you have a mapping that jumps around in the | |
| 6907 buffer and you want to go back to the original view. | |
| 6908 This does not save fold information. Use the 'foldenable' | |
| 798 | 6909 option to temporarily switch off folding, so that folds are |
|
6070
32a77cc160d9
Update runtime files. Make matchparen plugin backwards compatible.
Bram Moolenaar <bram@vim.org>
parents:
6051
diff
changeset
|
6910 not opened when moving around. This may have side effects. |
| 712 | 6911 The return value includes: |
| 6912 lnum cursor line number | |
| 5940 | 6913 col cursor column (Note: the first column |
| 6914 zero, as opposed to what getpos() | |
| 6915 returns) | |
| 712 | 6916 coladd cursor column offset for 'virtualedit' |
| 6917 curswant column for vertical movement | |
| 6918 topline first line in the window | |
| 6919 topfill filler lines, only in diff mode | |
| 6920 leftcol first column displayed | |
| 6921 skipcol columns skipped | |
| 6922 Note that no option values are saved. | |
| 6923 | |
| 7 | 6924 |
| 6925 winwidth({nr}) *winwidth()* | |
| 6926 The result is a Number, which is the width of window {nr}. | |
| 6927 When {nr} is zero, the width of the current window is | |
| 6928 returned. When window {nr} doesn't exist, -1 is returned. | |
| 6929 An existing window always has a width of zero or more. | |
| 6930 Examples: > | |
| 6931 :echo "The current window has " . winwidth(0) . " columns." | |
| 6932 :if winwidth(0) <= 50 | |
| 6933 : exe "normal 50\<C-W>|" | |
| 6934 :endif | |
| 6935 < | |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6936 wordcount() *wordcount()* |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6937 The result is a dictionary of byte/chars/word statistics for |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6938 the current buffer. This is the same info as provided by |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6939 |g_CTRL-G| |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6940 The return value includes: |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6941 bytes Number of bytes in the buffer |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6942 chars Number of chars in the buffer |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6943 words Number of words in the buffer |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6944 cursor_bytes Number of bytes before cursor position |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6945 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6946 cursor_chars Number of chars before cursor position |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6947 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6948 cursor_words Number of words before cursor position |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6949 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6950 visual_bytes Number of bytes visually selected |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6951 (only in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6952 visual_chars Number of chars visually selected |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6953 (only in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6954 visual_words Number of chars visually selected |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6955 (only in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6956 |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6957 |
| 158 | 6958 *writefile()* |
| 6341 | 6959 writefile({list}, {fname} [, {flags}]) |
| 685 | 6960 Write |List| {list} to file {fname}. Each list item is |
| 158 | 6961 separated with a NL. Each list item must be a String or |
| 6962 Number. | |
| 6341 | 6963 When {flags} contains "b" then binary mode is used: There will |
| 158 | 6964 not be a NL after the last list item. An empty item at the |
| 6965 end does cause the last line in the file to end in a NL. | |
| 6341 | 6966 |
| 6967 When {flags} contains "a" then append mode is used, lines are | |
| 6968 append to the file: > | |
| 6969 :call writefile(["foo"], "event.log", "a") | |
| 6970 :call writefile(["bar"], "event.log", "a") | |
| 6971 > | |
| 6972 < All NL characters are replaced with a NUL character. | |
| 158 | 6973 Inserting CR characters needs to be done before passing {list} |
| 6974 to writefile(). | |
| 6975 An existing file is overwritten, if possible. | |
| 6976 When the write fails -1 is returned, otherwise 0. There is an | |
| 6977 error message if the file can't be created or when writing | |
| 6978 fails. | |
| 6979 Also see |readfile()|. | |
| 6980 To copy a file byte for byte: > | |
| 6981 :let fl = readfile("foo", "b") | |
| 6982 :call writefile(fl, "foocopy", "b") | |
| 3214 | 6983 |
| 6984 | |
| 6985 xor({expr}, {expr}) *xor()* | |
| 6986 Bitwise XOR on the two arguments. The arguments are converted | |
| 6987 to a number. A List, Dict or Float argument causes an error. | |
| 6988 Example: > | |
| 6989 :let bits = xor(bits, 0x80) | |
| 3256 | 6990 < |
| 3214 | 6991 |
| 7 | 6992 |
| 6993 *feature-list* | |
| 6009 | 6994 There are four types of features: |
| 7 | 6995 1. Features that are only supported when they have been enabled when Vim |
| 6996 was compiled |+feature-list|. Example: > | |
| 6997 :if has("cindent") | |
| 6998 2. Features that are only supported when certain conditions have been met. | |
| 6999 Example: > | |
| 7000 :if has("gui_running") | |
| 7001 < *has-patch* | |
| 5814 | 7002 3. Included patches. The "patch123" feature means that patch 123 has been |
| 7003 included. Note that this form does not check the version of Vim, you need | |
| 7004 to inspect |v:version| for that. | |
| 7005 Example (checking version 6.2.148 or later): > | |
| 7 | 7006 :if v:version > 602 || v:version == 602 && has("patch148") |
| 5814 | 7007 < Note that it's possible for patch 147 to be omitted even though 148 is |
| 7008 included. | |
| 7009 | |
| 7010 4. Beyond a certain version or at a certain version and including a specific | |
| 5862 | 7011 patch. The "patch-7.4.237" feature means that the Vim version is 7.5 or |
| 7012 later, or it is version 7.4 and patch 237 was included. | |
| 7013 Note that this only works for patch 7.4.237 and later, before that you | |
| 7014 need to use the example above that checks v:version. Example: > | |
| 7015 :if has("patch-7.4.248") | |
| 5814 | 7016 < Note that it's possible for patch 147 to be omitted even though 148 is |
| 1156 | 7017 included. |
| 7 | 7018 |
| 5340 | 7019 acl Compiled with |ACL| support. |
| 7 | 7020 all_builtin_terms Compiled with all builtin terminals enabled. |
| 7021 amiga Amiga version of Vim. | |
| 7022 arabic Compiled with Arabic support |Arabic|. | |
| 7023 arp Compiled with ARP support (Amiga). | |
| 613 | 7024 autocmd Compiled with autocommand support. |autocommand| |
| 7 | 7025 balloon_eval Compiled with |balloon-eval| support. |
| 435 | 7026 balloon_multiline GUI supports multiline balloons. |
| 7 | 7027 beos BeOS version of Vim. |
| 7028 browse Compiled with |:browse| support, and browse() will | |
| 7029 work. | |
| 3682 | 7030 browsefilter Compiled with support for |browsefilter|. |
| 7 | 7031 builtin_terms Compiled with some builtin terminals. |
| 7032 byte_offset Compiled with support for 'o' in 'statusline' | |
| 7033 cindent Compiled with 'cindent' support. | |
| 7034 clientserver Compiled with remote invocation support |clientserver|. | |
| 7035 clipboard Compiled with 'clipboard' support. | |
| 7036 cmdline_compl Compiled with |cmdline-completion| support. | |
| 7037 cmdline_hist Compiled with |cmdline-history| support. | |
| 7038 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
| 7039 comments Compiled with |'comments'| support. | |
| 2681 | 7040 compatible Compiled to be very Vi compatible. |
| 7 | 7041 cryptv Compiled with encryption support |encryption|. |
| 7042 cscope Compiled with |cscope| support. | |
| 7043 debug Compiled with "DEBUG" defined. | |
| 7044 dialog_con Compiled with console dialog support. | |
| 7045 dialog_gui Compiled with GUI dialog support. | |
| 7046 diff Compiled with |vimdiff| and 'diff' support. | |
| 7047 digraphs Compiled with support for digraphs. | |
| 6110 | 7048 directx Compiled with support for Direct-X and 'renderoptions'. |
| 7 | 7049 dnd Compiled with support for the "~ register |quote_~|. |
| 2681 | 7050 dos16 16 bits DOS version of Vim. |
| 7 | 7051 dos32 32 bits DOS (DJGPP) version of Vim. |
| 7052 ebcdic Compiled on a machine with ebcdic character set. | |
| 7053 emacs_tags Compiled with support for Emacs tags. | |
| 7054 eval Compiled with expression evaluation support. Always | |
| 7055 true, of course! | |
| 7056 ex_extra Compiled with extra Ex commands |+ex_extra|. | |
| 7057 extra_search Compiled with support for |'incsearch'| and | |
| 7058 |'hlsearch'| | |
| 7059 farsi Compiled with Farsi support |farsi|. | |
| 7060 file_in_path Compiled with support for |gf| and |<cfile>| | |
| 168 | 7061 filterpipe When 'shelltemp' is off pipes are used for shell |
| 7062 read/write/filter commands | |
| 7 | 7063 find_in_path Compiled with support for include file searches |
| 7064 |+find_in_path|. | |
| 1621 | 7065 float Compiled with support for |Float|. |
| 7 | 7066 fname_case Case in file names matters (for Amiga, MS-DOS, and |
| 7067 Windows this is not present). | |
| 7068 folding Compiled with |folding| support. | |
| 7069 footer Compiled with GUI footer support. |gui-footer| | |
| 7070 fork Compiled to use fork()/exec() instead of system(). | |
| 7071 gettext Compiled with message translation |multi-lang| | |
| 7072 gui Compiled with GUI enabled. | |
| 7073 gui_athena Compiled with Athena GUI. | |
| 2681 | 7074 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
| 7 | 7075 gui_gtk Compiled with GTK+ GUI (any version). |
| 7076 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined). | |
| 7077 gui_mac Compiled with Macintosh GUI. | |
| 7078 gui_motif Compiled with Motif GUI. | |
| 7079 gui_photon Compiled with Photon GUI. | |
| 2681 | 7080 gui_running Vim is running in the GUI, or it will start soon. |
| 7 | 7081 gui_win32 Compiled with MS Windows Win32 GUI. |
| 7082 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
| 7083 hangul_input Compiled with Hangul input support. |hangul| | |
| 7084 iconv Can use iconv() for conversion. | |
| 7085 insert_expand Compiled with support for CTRL-X expansion commands in | |
| 7086 Insert mode. | |
| 7087 jumplist Compiled with |jumplist| support. | |
| 7088 keymap Compiled with 'keymap' support. | |
| 7089 langmap Compiled with 'langmap' support. | |
| 7090 libcall Compiled with |libcall()| support. | |
| 5995 | 7091 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and |
| 7092 'breakindent' support. | |
| 7 | 7093 lispindent Compiled with support for lisp indenting. |
| 7094 listcmds Compiled with commands for the buffer list |:files| | |
| 7095 and the argument list |arglist|. | |
| 7096 localmap Compiled with local mappings and abbr. |:map-local| | |
|
2320
966a5609669e
Added Lua interfae. (Luis Carvalho)
Bram Moolenaar <bram@vim.org>
parents:
2290
diff
changeset
|
7097 lua Compiled with Lua interface |Lua|. |
| 7 | 7098 mac Macintosh version of Vim. |
| 7099 macunix Macintosh version of Vim, using Unix files (OS-X). | |
| 7100 menu Compiled with support for |:menu|. | |
| 7101 mksession Compiled with support for |:mksession|. | |
| 7102 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
| 7103 mouse Compiled with support mouse. | |
| 7104 mouse_dec Compiled with support for Dec terminal mouse. | |
| 7105 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
| 7106 mouse_netterm Compiled with support for netterm mouse. | |
| 7107 mouse_pterm Compiled with support for qnx pterm mouse. | |
| 1621 | 7108 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
| 3750 | 7109 mouse_sgr Compiled with support for sgr mouse. |
| 3224 | 7110 mouse_urxvt Compiled with support for urxvt mouse. |
| 7 | 7111 mouse_xterm Compiled with support for xterm mouse. |
| 2681 | 7112 mouseshape Compiled with support for 'mouseshape'. |
| 1768 | 7113 multi_byte Compiled with support for 'encoding' |
| 7114 multi_byte_encoding 'encoding' is set to a multi-byte encoding. | |
| 7 | 7115 multi_byte_ime Compiled with support for IME input method. |
| 7116 multi_lang Compiled with support for multiple languages. | |
| 14 | 7117 mzscheme Compiled with MzScheme interface |mzscheme|. |
| 2681 | 7118 netbeans_enabled Compiled with support for |netbeans| and connected. |
| 7 | 7119 netbeans_intg Compiled with support for |netbeans|. |
| 7120 ole Compiled with OLE automation support for Win32. | |
| 7121 os2 OS/2 version of Vim. | |
| 7122 path_extra Compiled with up/downwards search in 'path' and 'tags' | |
| 7123 perl Compiled with Perl interface. | |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2210
diff
changeset
|
7124 persistent_undo Compiled with support for persistent undo history. |
| 7 | 7125 postscript Compiled with PostScript file printing. |
| 7126 printer Compiled with |:hardcopy| support. | |
| 170 | 7127 profile Compiled with |:profile| support. |
| 2826 | 7128 python Compiled with Python 2.x interface. |has-python| |
| 7129 python3 Compiled with Python 3.x interface. |has-python| | |
| 7 | 7130 qnx QNX version of Vim. |
| 7131 quickfix Compiled with |quickfix| support. | |
| 857 | 7132 reltime Compiled with |reltime()| support. |
| 7 | 7133 rightleft Compiled with 'rightleft' support. |
| 7134 ruby Compiled with Ruby interface |ruby|. | |
| 7135 scrollbind Compiled with 'scrollbind' support. | |
| 7136 showcmd Compiled with 'showcmd' support. | |
| 7137 signs Compiled with |:sign| support. | |
| 7138 smartindent Compiled with 'smartindent' support. | |
| 9 | 7139 sniff Compiled with SNiFF interface support. |
| 2681 | 7140 spell Compiled with spell checking support |spell|. |
| 1989 | 7141 startuptime Compiled with |--startuptime| support. |
| 7 | 7142 statusline Compiled with support for 'statusline', 'rulerformat' |
| 7143 and special formats of 'titlestring' and 'iconstring'. | |
| 7144 sun_workshop Compiled with support for Sun |workshop|. | |
| 314 | 7145 syntax Compiled with syntax highlighting support |syntax|. |
| 7 | 7146 syntax_items There are active syntax highlighting items for the |
| 7147 current buffer. | |
| 7148 system Compiled to use system() instead of fork()/exec(). | |
| 7149 tag_binary Compiled with binary searching in tags files | |
| 7150 |tag-binary-search|. | |
| 7151 tag_old_static Compiled with support for old static tags | |
| 7152 |tag-old-static|. | |
| 7153 tag_any_white Compiled with support for any white characters in tags | |
| 7154 files |tag-any-white|. | |
| 7155 tcl Compiled with Tcl interface. | |
| 7156 terminfo Compiled with terminfo instead of termcap. | |
| 7157 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
| 7158 textobjects Compiled with support for |text-objects|. | |
| 7159 tgetent Compiled with tgetent support, able to use a termcap | |
| 7160 or terminfo file. | |
| 7161 title Compiled with window title support |'title'|. | |
| 7162 toolbar Compiled with support for |gui-toolbar|. | |
| 7163 unix Unix version of Vim. | |
| 7164 user_commands User-defined commands. | |
| 2681 | 7165 vertsplit Compiled with vertically split windows |:vsplit|. |
| 2581 | 7166 vim_starting True while initial source'ing takes place. |startup| |
| 2681 | 7167 viminfo Compiled with viminfo support. |
| 7 | 7168 virtualedit Compiled with 'virtualedit' option. |
| 7169 visual Compiled with Visual mode. | |
| 7170 visualextra Compiled with extra Visual mode commands. | |
| 7171 |blockwise-operators|. | |
| 7172 vms VMS version of Vim. | |
| 7173 vreplace Compiled with |gR| and |gr| commands. | |
| 7174 wildignore Compiled with 'wildignore' option. | |
| 7175 wildmenu Compiled with 'wildmenu' option. | |
| 7176 win16 Win16 version of Vim (MS-Windows 3.1). | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
7177 win32 Win32 version of Vim (MS-Windows 95 and later, 32 or |
|
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
7178 64 bits) |
| 2681 | 7179 win32unix Win32 version of Vim, using Unix files (Cygwin) |
| 7 | 7180 win64 Win64 version of Vim (MS-Windows 64 bit). |
| 7181 win95 Win32 version for MS-Windows 95/98/ME. | |
| 2681 | 7182 winaltkeys Compiled with 'winaltkeys' option. |
| 7183 windows Compiled with support for more than one window. | |
| 7 | 7184 writebackup Compiled with 'writebackup' default on. |
| 7185 xfontset Compiled with X fontset support |xfontset|. | |
| 7186 xim Compiled with X input method support |xim|. | |
| 5340 | 7187 xpm Compiled with pixmap support. |
| 7188 xpm_w32 Compiled with pixmap support for Win32. (Only for | |
| 7189 backward compatibility. Use "xpm" instead.) | |
| 7 | 7190 xsmp Compiled with X session management support. |
| 7191 xsmp_interact Compiled with interactive X session management support. | |
| 7192 xterm_clipboard Compiled with support for xterm clipboard. | |
| 7193 xterm_save Compiled with support for saving and restoring the | |
| 7194 xterm screen. | |
| 7195 x11 Compiled with X11 support. | |
| 7196 | |
| 7197 *string-match* | |
| 7198 Matching a pattern in a String | |
| 7199 | |
| 7200 A regexp pattern as explained at |pattern| is normally used to find a match in | |
| 7201 the buffer lines. When a pattern is used to find a match in a String, almost | |
| 7202 everything works in the same way. The difference is that a String is handled | |
| 7203 like it is one line. When it contains a "\n" character, this is not seen as a | |
| 7204 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
| 7205 with ".". Example: > | |
| 7206 :let a = "aaaa\nxxxx" | |
| 7207 :echo matchstr(a, "..\n..") | |
| 7208 aa | |
| 7209 xx | |
| 7210 :echo matchstr(a, "a.x") | |
| 7211 a | |
| 7212 x | |
| 7213 | |
| 7214 Don't forget that "^" will only match at the first character of the String and | |
| 7215 "$" at the last character of the string. They don't match after or before a | |
| 7216 "\n". | |
| 7217 | |
| 7218 ============================================================================== | |
| 7219 5. Defining functions *user-functions* | |
| 7220 | |
| 7221 New functions can be defined. These can be called just like builtin | |
| 7222 functions. The function executes a sequence of Ex commands. Normal mode | |
| 7223 commands can be executed with the |:normal| command. | |
| 7224 | |
| 7225 The function name must start with an uppercase letter, to avoid confusion with | |
| 7226 builtin functions. To prevent from using the same name in different scripts | |
| 7227 avoid obvious, short names. A good habit is to start the function name with | |
| 7228 the name of the script, e.g., "HTMLcolor()". | |
| 7229 | |
| 504 | 7230 It's also possible to use curly braces, see |curly-braces-names|. And the |
| 7231 |autoload| facility is useful to define a function only when it's called. | |
| 7 | 7232 |
| 7233 *local-function* | |
| 7234 A function local to a script must start with "s:". A local script function | |
| 7235 can only be called from within the script and from functions, user commands | |
| 7236 and autocommands defined in the script. It is also possible to call the | |
| 1698 | 7237 function from a mapping defined in the script, but then |<SID>| must be used |
| 7 | 7238 instead of "s:" when the mapping is expanded outside of the script. |
| 5862 | 7239 There are only script-local functions, no buffer-local or window-local |
| 7240 functions. | |
| 7 | 7241 |
| 7242 *:fu* *:function* *E128* *E129* *E123* | |
| 7243 :fu[nction] List all functions and their arguments. | |
| 7244 | |
| 7245 :fu[nction] {name} List function {name}. | |
| 685 | 7246 {name} can also be a |Dictionary| entry that is a |
| 7247 |Funcref|: > | |
| 114 | 7248 :function dict.init |
| 504 | 7249 |
| 7250 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
| 7251 Example that lists all functions ending with "File": > | |
| 7252 :function /File$ | |
| 482 | 7253 < |
| 7254 *:function-verbose* | |
| 7255 When 'verbose' is non-zero, listing a function will also display where it was | |
| 7256 last defined. Example: > | |
| 7257 | |
| 7258 :verbose function SetFileTypeSH | |
| 7259 function SetFileTypeSH(name) | |
| 7260 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
| 7261 < | |
| 484 | 7262 See |:verbose-cmd| for more information. |
| 482 | 7263 |
| 5862 | 7264 *E124* *E125* *E853* *E884* |
| 102 | 7265 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] |
| 7 | 7266 Define a new function by the name {name}. The name |
| 7267 must be made of alphanumeric characters and '_', and | |
| 5862 | 7268 must start with a capital or "s:" (see above). Note |
| 7269 that using "b:" or "g:" is not allowed. (since patch | |
| 7270 7.4.260 E884 is given if the function name has a colon | |
| 7271 in the name, e.g. for "foo:bar()". Before that patch | |
| 7272 no error was given). | |
| 114 | 7273 |
| 685 | 7274 {name} can also be a |Dictionary| entry that is a |
| 7275 |Funcref|: > | |
| 114 | 7276 :function dict.init(arg) |
| 1621 | 7277 < "dict" must be an existing dictionary. The entry |
| 114 | 7278 "init" is added if it didn't exist yet. Otherwise [!] |
| 1621 | 7279 is required to overwrite an existing function. The |
| 114 | 7280 result is a |Funcref| to a numbered function. The |
| 7281 function can only be used with a |Funcref| and will be | |
| 7282 deleted if there are no more references to it. | |
| 7 | 7283 *E127* *E122* |
| 7284 When a function by this name already exists and [!] is | |
| 7285 not used an error message is given. When [!] is used, | |
| 7286 an existing function is silently replaced. Unless it | |
| 7287 is currently being executed, that is an error. | |
| 133 | 7288 |
| 7289 For the {arguments} see |function-argument|. | |
| 7290 | |
| 5618 | 7291 *:func-range* *a:firstline* *a:lastline* |
| 7 | 7292 When the [range] argument is added, the function is |
| 7293 expected to take care of a range itself. The range is | |
| 7294 passed as "a:firstline" and "a:lastline". If [range] | |
| 7295 is excluded, ":{range}call" will call the function for | |
| 7296 each line in the range, with the cursor on the start | |
| 7297 of each line. See |function-range-example|. | |
| 3967 | 7298 The cursor is still moved to the first line of the |
| 7299 range, as is the case with all Ex commands. | |
| 5618 | 7300 *:func-abort* |
| 7 | 7301 When the [abort] argument is added, the function will |
| 7302 abort as soon as an error is detected. | |
| 5618 | 7303 *:func-dict* |
| 102 | 7304 When the [dict] argument is added, the function must |
| 1621 | 7305 be invoked through an entry in a |Dictionary|. The |
| 102 | 7306 local variable "self" will then be set to the |
| 7307 dictionary. See |Dictionary-function|. | |
| 7 | 7308 |
| 1621 | 7309 *function-search-undo* |
| 653 | 7310 The last used search pattern and the redo command "." |
| 1621 | 7311 will not be changed by the function. This also |
| 7312 implies that the effect of |:nohlsearch| is undone | |
| 7313 when the function returns. | |
| 653 | 7314 |
| 7 | 7315 *:endf* *:endfunction* *E126* *E193* |
| 7316 :endf[unction] The end of a function definition. Must be on a line | |
| 7317 by its own, without other commands. | |
| 7318 | |
| 7319 *:delf* *:delfunction* *E130* *E131* | |
| 7320 :delf[unction] {name} Delete function {name}. | |
| 685 | 7321 {name} can also be a |Dictionary| entry that is a |
| 7322 |Funcref|: > | |
| 114 | 7323 :delfunc dict.init |
| 1621 | 7324 < This will remove the "init" entry from "dict". The |
| 114 | 7325 function is deleted if there are no more references to |
| 7326 it. | |
| 7 | 7327 *:retu* *:return* *E133* |
| 7328 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
| 7329 evaluated and returned as the result of the function. | |
| 7330 If "[expr]" is not given, the number 0 is returned. | |
| 7331 When a function ends without an explicit ":return", | |
| 7332 the number 0 is returned. | |
| 7333 Note that there is no check for unreachable lines, | |
| 7334 thus there is no warning if commands follow ":return". | |
| 7335 | |
| 7336 If the ":return" is used after a |:try| but before the | |
| 7337 matching |:finally| (if present), the commands | |
| 7338 following the ":finally" up to the matching |:endtry| | |
| 7339 are executed first. This process applies to all | |
| 7340 nested ":try"s inside the function. The function | |
| 7341 returns at the outermost ":endtry". | |
| 7342 | |
| 133 | 7343 *function-argument* *a:var* |
| 1621 | 7344 An argument can be defined by giving its name. In the function this can then |
| 133 | 7345 be used as "a:name" ("a:" for argument). |
| 1156 | 7346 *a:0* *a:1* *a:000* *E740* *...* |
| 133 | 7347 Up to 20 arguments can be given, separated by commas. After the named |
| 7348 arguments an argument "..." can be specified, which means that more arguments | |
| 7349 may optionally be following. In the function the extra arguments can be used | |
| 7350 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
| 685 | 7351 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
| 7352 that "a:1" is the same as "a:000[0]". | |
| 148 | 7353 *E742* |
| 7354 The a: scope and the variables in it cannot be changed, they are fixed. | |
| 1698 | 7355 However, if a |List| or |Dictionary| is used, you can change their contents. |
| 685 | 7356 Thus you can pass a |List| to a function and have the function add an item to |
| 7357 it. If you want to make sure the function cannot change a |List| or | |
| 7358 |Dictionary| use |:lockvar|. | |
| 133 | 7359 |
| 7360 When not using "...", the number of arguments in a function call must be equal | |
| 7361 to the number of named arguments. When using "...", the number of arguments | |
| 7362 may be larger. | |
| 7363 | |
| 7364 It is also possible to define a function without any arguments. You must | |
| 7365 still supply the () then. The body of the function follows in the next lines, | |
| 7366 until the matching |:endfunction|. It is allowed to define another function | |
| 7367 inside a function body. | |
| 7368 | |
| 7369 *local-variables* | |
| 7 | 7370 Inside a function variables can be used. These are local variables, which |
| 7371 will disappear when the function returns. Global variables need to be | |
| 7372 accessed with "g:". | |
| 7373 | |
| 7374 Example: > | |
| 7375 :function Table(title, ...) | |
| 7376 : echohl Title | |
| 7377 : echo a:title | |
| 7378 : echohl None | |
| 140 | 7379 : echo a:0 . " items:" |
| 7380 : for s in a:000 | |
| 7381 : echon ' ' . s | |
| 7382 : endfor | |
| 7 | 7383 :endfunction |
| 7384 | |
| 7385 This function can then be called with: > | |
| 140 | 7386 call Table("Table", "line1", "line2") |
| 7387 call Table("Empty Table") | |
| 7 | 7388 |
| 1156 | 7389 To return more than one value, return a |List|: > |
| 7390 :function Compute(n1, n2) | |
| 7 | 7391 : if a:n2 == 0 |
| 1156 | 7392 : return ["fail", 0] |
| 7 | 7393 : endif |
| 1156 | 7394 : return ["ok", a:n1 / a:n2] |
| 7 | 7395 :endfunction |
| 7396 | |
| 7397 This function can then be called with: > | |
| 1156 | 7398 :let [success, div] = Compute(102, 6) |
| 7 | 7399 :if success == "ok" |
| 7400 : echo div | |
| 7401 :endif | |
| 1156 | 7402 < |
| 786 | 7403 *:cal* *:call* *E107* *E117* |
| 7 | 7404 :[range]cal[l] {name}([arguments]) |
| 7405 Call a function. The name of the function and its arguments | |
| 7406 are as specified with |:function|. Up to 20 arguments can be | |
| 1156 | 7407 used. The returned value is discarded. |
| 7 | 7408 Without a range and for functions that accept a range, the |
| 7409 function is called once. When a range is given the cursor is | |
| 7410 positioned at the start of the first line before executing the | |
| 7411 function. | |
| 7412 When a range is given and the function doesn't handle it | |
| 7413 itself, the function is executed for each line in the range, | |
| 7414 with the cursor in the first column of that line. The cursor | |
| 7415 is left at the last line (possibly moved by the last function | |
| 1621 | 7416 call). The arguments are re-evaluated for each line. Thus |
| 7 | 7417 this works: |
| 7418 *function-range-example* > | |
| 7419 :function Mynumber(arg) | |
| 7420 : echo line(".") . " " . a:arg | |
| 7421 :endfunction | |
| 7422 :1,5call Mynumber(getline(".")) | |
| 7423 < | |
| 7424 The "a:firstline" and "a:lastline" are defined anyway, they | |
| 7425 can be used to do something different at the start or end of | |
| 7426 the range. | |
| 7427 | |
| 7428 Example of a function that handles the range itself: > | |
| 7429 | |
| 7430 :function Cont() range | |
| 7431 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
| 7432 :endfunction | |
| 7433 :4,8call Cont() | |
| 7434 < | |
| 7435 This function inserts the continuation character "\" in front | |
| 7436 of all the lines in the range, except the first one. | |
| 7437 | |
| 1156 | 7438 When the function returns a composite value it can be further |
| 7439 dereferenced, but the range will not be used then. Example: > | |
| 7440 :4,8call GetDict().method() | |
| 7441 < Here GetDict() gets the range but method() does not. | |
| 7442 | |
| 7 | 7443 *E132* |
| 7444 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
| 7445 option. | |
| 7446 | |
| 161 | 7447 |
| 7448 AUTOMATICALLY LOADING FUNCTIONS ~ | |
| 7 | 7449 *autoload-functions* |
| 7450 When using many or large functions, it's possible to automatically define them | |
| 161 | 7451 only when they are used. There are two methods: with an autocommand and with |
| 7452 the "autoload" directory in 'runtimepath'. | |
| 7453 | |
| 7454 | |
| 7455 Using an autocommand ~ | |
| 7456 | |
| 170 | 7457 This is introduced in the user manual, section |41.14|. |
| 7458 | |
| 161 | 7459 The autocommand is useful if you have a plugin that is a long Vim script file. |
| 7460 You can define the autocommand and quickly quit the script with |:finish|. | |
| 1621 | 7461 That makes Vim startup faster. The autocommand should then load the same file |
| 161 | 7462 again, setting a variable to skip the |:finish| command. |
| 7463 | |
| 7464 Use the FuncUndefined autocommand event with a pattern that matches the | |
| 7465 function(s) to be defined. Example: > | |
| 7 | 7466 |
| 7467 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
| 7468 | |
| 7469 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
| 7470 "BufNet". Also see |FuncUndefined|. | |
| 7471 | |
| 161 | 7472 |
| 7473 Using an autoload script ~ | |
| 168 | 7474 *autoload* *E746* |
| 170 | 7475 This is introduced in the user manual, section |41.15|. |
| 7476 | |
| 161 | 7477 Using a script in the "autoload" directory is simpler, but requires using |
| 7478 exactly the right file name. A function that can be autoloaded has a name | |
| 7479 like this: > | |
| 7480 | |
| 270 | 7481 :call filename#funcname() |
| 161 | 7482 |
| 7483 When such a function is called, and it is not defined yet, Vim will search the | |
| 7484 "autoload" directories in 'runtimepath' for a script file called | |
| 7485 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
| 7486 then define the function like this: > | |
| 7487 | |
| 270 | 7488 function filename#funcname() |
| 161 | 7489 echo "Done!" |
| 7490 endfunction | |
| 7491 | |
| 530 | 7492 The file name and the name used before the # in the function must match |
| 161 | 7493 exactly, and the defined function must have the name exactly as it will be |
| 7494 called. | |
| 7495 | |
| 270 | 7496 It is possible to use subdirectories. Every # in the function name works like |
| 7497 a path separator. Thus when calling a function: > | |
| 7498 | |
| 7499 :call foo#bar#func() | |
| 161 | 7500 |
| 7501 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
| 7502 | |
| 168 | 7503 This also works when reading a variable that has not been set yet: > |
| 7504 | |
| 270 | 7505 :let l = foo#bar#lvar |
| 168 | 7506 |
| 557 | 7507 However, when the autoload script was already loaded it won't be loaded again |
| 7508 for an unknown variable. | |
| 7509 | |
| 168 | 7510 When assigning a value to such a variable nothing special happens. This can |
| 7511 be used to pass settings to the autoload script before it's loaded: > | |
| 7512 | |
| 270 | 7513 :let foo#bar#toggle = 1 |
| 7514 :call foo#bar#func() | |
| 168 | 7515 |
| 164 | 7516 Note that when you make a mistake and call a function that is supposed to be |
| 7517 defined in an autoload script, but the script doesn't actually define the | |
| 7518 function, the script will be sourced every time you try to call the function. | |
| 168 | 7519 And you will get an error message every time. |
| 7520 | |
| 7521 Also note that if you have two script files, and one calls a function in the | |
| 1621 | 7522 other and vice versa, before the used function is defined, it won't work. |
| 168 | 7523 Avoid using the autoload functionality at the toplevel. |
| 161 | 7524 |
| 794 | 7525 Hint: If you distribute a bunch of scripts you can pack them together with the |
| 7526 |vimball| utility. Also read the user manual |distribute-script|. | |
| 7527 | |
| 7 | 7528 ============================================================================== |
| 7529 6. Curly braces names *curly-braces-names* | |
| 7530 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7531 In most places where you can use a variable, you can use a "curly braces name" |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7532 variable. This is a regular variable name with one or more expressions |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7533 wrapped in braces {} like this: > |
| 7 | 7534 my_{adjective}_variable |
| 7535 | |
| 7536 When Vim encounters this, it evaluates the expression inside the braces, puts | |
| 7537 that in place of the expression, and re-interprets the whole as a variable | |
| 7538 name. So in the above example, if the variable "adjective" was set to | |
| 7539 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
| 7540 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
| 7541 | |
| 7542 One application for this is to create a set of variables governed by an option | |
| 1621 | 7543 value. For example, the statement > |
| 7 | 7544 echo my_{&background}_message |
| 7545 | |
| 7546 would output the contents of "my_dark_message" or "my_light_message" depending | |
| 7547 on the current value of 'background'. | |
| 7548 | |
| 7549 You can use multiple brace pairs: > | |
| 7550 echo my_{adverb}_{adjective}_message | |
| 7551 ..or even nest them: > | |
| 7552 echo my_{ad{end_of_word}}_message | |
| 7553 where "end_of_word" is either "verb" or "jective". | |
| 7554 | |
| 7555 However, the expression inside the braces must evaluate to a valid single | |
| 236 | 7556 variable name, e.g. this is invalid: > |
| 7 | 7557 :let foo='a + b' |
| 7558 :echo c{foo}d | |
| 7559 .. since the result of expansion is "ca + bd", which is not a variable name. | |
| 7560 | |
| 7561 *curly-braces-function-names* | |
| 7562 You can call and define functions by an evaluated name in a similar way. | |
| 7563 Example: > | |
| 7564 :let func_end='whizz' | |
| 7565 :call my_func_{func_end}(parameter) | |
| 7566 | |
| 7567 This would call the function "my_func_whizz(parameter)". | |
| 7568 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7569 This does NOT work: > |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7570 :let i = 3 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7571 :let @{i} = '' " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7572 :echo @{i} " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7573 |
| 7 | 7574 ============================================================================== |
| 7575 7. Commands *expression-commands* | |
| 7576 | |
| 7577 :let {var-name} = {expr1} *:let* *E18* | |
| 7578 Set internal variable {var-name} to the result of the | |
| 7579 expression {expr1}. The variable will get the type | |
| 7580 from the {expr}. If {var-name} didn't exist yet, it | |
| 7581 is created. | |
| 7582 | |
| 85 | 7583 :let {var-name}[{idx}] = {expr1} *E689* |
| 7584 Set a list item to the result of the expression | |
| 7585 {expr1}. {var-name} must refer to a list and {idx} | |
| 7586 must be a valid index in that list. For nested list | |
| 7587 the index can be repeated. | |
| 1621 | 7588 This cannot be used to add an item to a |List|. |
| 7589 This cannot be used to set a byte in a String. You | |
| 7590 can do that like this: > | |
| 7591 :let var = var[0:2] . 'X' . var[4:] | |
| 7592 < | |
| 114 | 7593 *E711* *E719* |
| 7594 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
| 685 | 7595 Set a sequence of items in a |List| to the result of |
| 7596 the expression {expr1}, which must be a list with the | |
| 87 | 7597 correct number of items. |
| 7598 {idx1} can be omitted, zero is used instead. | |
| 7599 {idx2} can be omitted, meaning the end of the list. | |
| 7600 When the selected range of items is partly past the | |
| 7601 end of the list, items will be added. | |
| 7602 | |
| 153 | 7603 *:let+=* *:let-=* *:let.=* *E734* |
| 114 | 7604 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
| 7605 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
| 7606 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". | |
| 7607 These fail if {var} was not set yet and when the type | |
| 7608 of {var} and {expr1} don't fit the operator. | |
| 7609 | |
| 7610 | |
| 7 | 7611 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
| 7612 Set environment variable {env-name} to the result of | |
| 7613 the expression {expr1}. The type is always String. | |
| 114 | 7614 :let ${env-name} .= {expr1} |
| 7615 Append {expr1} to the environment variable {env-name}. | |
| 7616 If the environment variable didn't exist yet this | |
| 7617 works like "=". | |
| 7 | 7618 |
| 7619 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
| 7620 Write the result of the expression {expr1} in register | |
| 7621 {reg-name}. {reg-name} must be a single letter, and | |
| 7622 must be the name of a writable register (see | |
| 7623 |registers|). "@@" can be used for the unnamed | |
| 7624 register, "@/" for the search pattern. | |
| 7625 If the result of {expr1} ends in a <CR> or <NL>, the | |
| 7626 register will be linewise, otherwise it will be set to | |
| 7627 characterwise. | |
| 7628 This can be used to clear the last search pattern: > | |
| 7629 :let @/ = "" | |
| 7630 < This is different from searching for an empty string, | |
| 7631 that would match everywhere. | |
| 7632 | |
| 114 | 7633 :let @{reg-name} .= {expr1} |
| 1621 | 7634 Append {expr1} to register {reg-name}. If the |
| 114 | 7635 register was empty it's like setting it to {expr1}. |
| 7636 | |
| 1156 | 7637 :let &{option-name} = {expr1} *:let-option* *:let-&* |
| 7 | 7638 Set option {option-name} to the result of the |
| 68 | 7639 expression {expr1}. A String or Number value is |
| 7640 always converted to the type of the option. | |
| 7 | 7641 For an option local to a window or buffer the effect |
| 7642 is just like using the |:set| command: both the local | |
| 555 | 7643 value and the global value are changed. |
| 68 | 7644 Example: > |
| 7645 :let &path = &path . ',/usr/local/include' | |
| 7 | 7646 |
| 114 | 7647 :let &{option-name} .= {expr1} |
| 7648 For a string option: Append {expr1} to the value. | |
| 7649 Does not insert a comma like |:set+=|. | |
| 7650 | |
| 7651 :let &{option-name} += {expr1} | |
| 7652 :let &{option-name} -= {expr1} | |
| 7653 For a number or boolean option: Add or subtract | |
| 7654 {expr1}. | |
| 7655 | |
| 7 | 7656 :let &l:{option-name} = {expr1} |
| 114 | 7657 :let &l:{option-name} .= {expr1} |
| 7658 :let &l:{option-name} += {expr1} | |
| 7659 :let &l:{option-name} -= {expr1} | |
| 7 | 7660 Like above, but only set the local value of an option |
| 7661 (if there is one). Works like |:setlocal|. | |
| 7662 | |
| 7663 :let &g:{option-name} = {expr1} | |
| 114 | 7664 :let &g:{option-name} .= {expr1} |
| 7665 :let &g:{option-name} += {expr1} | |
| 7666 :let &g:{option-name} -= {expr1} | |
| 7 | 7667 Like above, but only set the global value of an option |
| 7668 (if there is one). Works like |:setglobal|. | |
| 7669 | |
| 85 | 7670 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
| 685 | 7671 {expr1} must evaluate to a |List|. The first item in |
| 68 | 7672 the list is assigned to {name1}, the second item to |
| 7673 {name2}, etc. | |
| 7674 The number of names must match the number of items in | |
| 685 | 7675 the |List|. |
| 68 | 7676 Each name can be one of the items of the ":let" |
| 7677 command as mentioned above. | |
| 7678 Example: > | |
| 7679 :let [s, item] = GetItem(s) | |
| 114 | 7680 < Detail: {expr1} is evaluated first, then the |
| 7681 assignments are done in sequence. This matters if | |
| 7682 {name2} depends on {name1}. Example: > | |
| 7683 :let x = [0, 1] | |
| 7684 :let i = 0 | |
| 7685 :let [i, x[i]] = [1, 2] | |
| 7686 :echo x | |
| 7687 < The result is [0, 2]. | |
| 7688 | |
| 7689 :let [{name1}, {name2}, ...] .= {expr1} | |
| 7690 :let [{name1}, {name2}, ...] += {expr1} | |
| 7691 :let [{name1}, {name2}, ...] -= {expr1} | |
| 7692 Like above, but append/add/subtract the value for each | |
| 685 | 7693 |List| item. |
| 68 | 7694 |
| 7695 :let [{name}, ..., ; {lastname}] = {expr1} | |
| 685 | 7696 Like |:let-unpack| above, but the |List| may have more |
| 114 | 7697 items than there are names. A list of the remaining |
| 7698 items is assigned to {lastname}. If there are no | |
| 7699 remaining items {lastname} is set to an empty list. | |
| 68 | 7700 Example: > |
| 7701 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
| 7702 < | |
| 114 | 7703 :let [{name}, ..., ; {lastname}] .= {expr1} |
| 7704 :let [{name}, ..., ; {lastname}] += {expr1} | |
| 7705 :let [{name}, ..., ; {lastname}] -= {expr1} | |
| 7706 Like above, but append/add/subtract the value for each | |
| 685 | 7707 |List| item. |
| 2596 | 7708 |
| 7709 *E121* | |
| 1621 | 7710 :let {var-name} .. List the value of variable {var-name}. Multiple |
| 123 | 7711 variable names may be given. Special names recognized |
| 7712 here: *E738* | |
| 777 | 7713 g: global variables |
| 7714 b: local buffer variables | |
| 7715 w: local window variables | |
| 819 | 7716 t: local tab page variables |
| 777 | 7717 s: script-local variables |
| 7718 l: local function variables | |
| 123 | 7719 v: Vim variables. |
| 7 | 7720 |
| 55 | 7721 :let List the values of all variables. The type of the |
| 7722 variable is indicated before the value: | |
| 7723 <nothing> String | |
| 7724 # Number | |
| 856 | 7725 * Funcref |
| 7 | 7726 |
| 148 | 7727 |
| 1156 | 7728 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
| 148 | 7729 Remove the internal variable {name}. Several variable |
| 7730 names can be given, they are all removed. The name | |
| 685 | 7731 may also be a |List| or |Dictionary| item. |
| 7 | 7732 With [!] no error message is given for non-existing |
| 7733 variables. | |
| 685 | 7734 One or more items from a |List| can be removed: > |
| 108 | 7735 :unlet list[3] " remove fourth item |
| 7736 :unlet list[3:] " remove fourth item to last | |
| 685 | 7737 < One item from a |Dictionary| can be removed at a time: > |
| 108 | 7738 :unlet dict['two'] |
| 7739 :unlet dict.two | |
| 1668 | 7740 < This is especially useful to clean up used global |
| 7741 variables and script-local variables (these are not | |
| 7742 deleted when the script ends). Function-local | |
| 7743 variables are automatically deleted when the function | |
| 7744 ends. | |
| 7 | 7745 |
| 148 | 7746 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
| 7747 Lock the internal variable {name}. Locking means that | |
| 7748 it can no longer be changed (until it is unlocked). | |
| 7749 A locked variable can be deleted: > | |
| 7750 :lockvar v | |
| 7751 :let v = 'asdf' " fails! | |
| 7752 :unlet v | |
| 7753 < *E741* | |
| 7754 If you try to change a locked variable you get an | |
| 6530 | 7755 error message: "E741: Value is locked: {name}" |
| 148 | 7756 |
| 685 | 7757 [depth] is relevant when locking a |List| or |
| 7758 |Dictionary|. It specifies how deep the locking goes: | |
| 7759 1 Lock the |List| or |Dictionary| itself, | |
| 148 | 7760 cannot add or remove items, but can |
| 7761 still change their values. | |
| 7762 2 Also lock the values, cannot change | |
| 685 | 7763 the items. If an item is a |List| or |
| 7764 |Dictionary|, cannot add or remove | |
| 148 | 7765 items, but can still change the |
| 7766 values. | |
| 685 | 7767 3 Like 2 but for the |List| / |
| 7768 |Dictionary| in the |List| / | |
| 7769 |Dictionary|, one level deeper. | |
| 7770 The default [depth] is 2, thus when {name} is a |List| | |
| 7771 or |Dictionary| the values cannot be changed. | |
| 148 | 7772 *E743* |
| 7773 For unlimited depth use [!] and omit [depth]. | |
| 7774 However, there is a maximum depth of 100 to catch | |
| 7775 loops. | |
| 7776 | |
| 685 | 7777 Note that when two variables refer to the same |List| |
| 7778 and you lock one of them, the |List| will also be | |
| 819 | 7779 locked when used through the other variable. |
| 7780 Example: > | |
| 148 | 7781 :let l = [0, 1, 2, 3] |
| 7782 :let cl = l | |
| 7783 :lockvar l | |
| 7784 :let cl[1] = 99 " won't work! | |
| 7785 < You may want to make a copy of a list to avoid this. | |
| 7786 See |deepcopy()|. | |
| 7787 | |
| 7788 | |
| 7789 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
| 7790 Unlock the internal variable {name}. Does the | |
| 7791 opposite of |:lockvar|. | |
| 7792 | |
| 7793 | |
| 7 | 7794 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580* |
| 7795 :en[dif] Execute the commands until the next matching ":else" | |
| 7796 or ":endif" if {expr1} evaluates to non-zero. | |
| 7797 | |
| 7798 From Vim version 4.5 until 5.0, every Ex command in | |
| 7799 between the ":if" and ":endif" is ignored. These two | |
| 7800 commands were just to allow for future expansions in a | |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
7801 backward compatible way. Nesting was allowed. Note |
| 7 | 7802 that any ":else" or ":elseif" was ignored, the "else" |
| 7803 part was not executed either. | |
| 7804 | |
| 7805 You can use this to remain compatible with older | |
| 7806 versions: > | |
| 7807 :if version >= 500 | |
| 7808 : version-5-specific-commands | |
| 7809 :endif | |
| 7810 < The commands still need to be parsed to find the | |
| 7811 "endif". Sometimes an older Vim has a problem with a | |
| 7812 new command. For example, ":silent" is recognized as | |
| 7813 a ":substitute" command. In that case ":execute" can | |
| 7814 avoid problems: > | |
| 7815 :if version >= 600 | |
| 7816 : execute "silent 1,$delete" | |
| 7817 :endif | |
| 7818 < | |
| 7819 NOTE: The ":append" and ":insert" commands don't work | |
| 7820 properly in between ":if" and ":endif". | |
| 7821 | |
| 7822 *:else* *:el* *E581* *E583* | |
| 7823 :el[se] Execute the commands until the next matching ":else" | |
| 7824 or ":endif" if they previously were not being | |
| 7825 executed. | |
| 7826 | |
| 7827 *:elseif* *:elsei* *E582* *E584* | |
| 7828 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
| 7829 is no extra ":endif". | |
| 7830 | |
| 7831 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
| 114 | 7832 *E170* *E585* *E588* *E733* |
| 7 | 7833 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
| 7834 as long as {expr1} evaluates to non-zero. | |
| 7835 When an error is detected from a command inside the | |
| 7836 loop, execution continues after the "endwhile". | |
| 75 | 7837 Example: > |
| 7838 :let lnum = 1 | |
| 7839 :while lnum <= line("$") | |
| 7840 :call FixLine(lnum) | |
| 7841 :let lnum = lnum + 1 | |
| 7842 :endwhile | |
| 7843 < | |
| 7 | 7844 NOTE: The ":append" and ":insert" commands don't work |
| 99 | 7845 properly inside a ":while" and ":for" loop. |
| 75 | 7846 |
| 114 | 7847 :for {var} in {list} *:for* *E690* *E732* |
| 75 | 7848 :endfo[r] *:endfo* *:endfor* |
| 7849 Repeat the commands between ":for" and ":endfor" for | |
| 158 | 7850 each item in {list}. Variable {var} is set to the |
| 79 | 7851 value of each item. |
| 7852 When an error is detected for a command inside the | |
| 75 | 7853 loop, execution continues after the "endfor". |
| 464 | 7854 Changing {list} inside the loop affects what items are |
| 7855 used. Make a copy if this is unwanted: > | |
| 79 | 7856 :for item in copy(mylist) |
| 7857 < When not making a copy, Vim stores a reference to the | |
| 7858 next item in the list, before executing the commands | |
| 1621 | 7859 with the current item. Thus the current item can be |
| 79 | 7860 removed without effect. Removing any later item means |
| 7861 it will not be found. Thus the following example | |
| 7862 works (an inefficient way to make a list empty): > | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7863 for item in mylist |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7864 call remove(mylist, 0) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7865 endfor |
| 87 | 7866 < Note that reordering the list (e.g., with sort() or |
| 7867 reverse()) may have unexpected effects. | |
| 7868 Note that the type of each list item should be | |
| 75 | 7869 identical to avoid errors for the type of {var} |
| 7870 changing. Unlet the variable at the end of the loop | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7871 to allow multiple item types: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7872 for item in ["foo", ["bar"]] |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7873 echo item |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7874 unlet item " E706 without this |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7875 endfor |
| 75 | 7876 |
| 7877 :for [{var1}, {var2}, ...] in {listlist} | |
| 7878 :endfo[r] | |
| 7879 Like ":for" above, but each item in {listlist} must be | |
| 7880 a list, of which each item is assigned to {var1}, | |
| 7881 {var2}, etc. Example: > | |
| 7882 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
| 7883 :echo getline(lnum)[col] | |
| 7884 :endfor | |
| 7885 < | |
| 7 | 7886 *:continue* *:con* *E586* |
| 75 | 7887 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
| 7888 to the start of the loop. | |
| 7889 If it is used after a |:try| inside the loop but | |
| 7890 before the matching |:finally| (if present), the | |
| 7891 commands following the ":finally" up to the matching | |
| 7892 |:endtry| are executed first. This process applies to | |
| 7893 all nested ":try"s inside the loop. The outermost | |
| 7894 ":endtry" then jumps back to the start of the loop. | |
| 7 | 7895 |
| 7896 *:break* *:brea* *E587* | |
| 75 | 7897 :brea[k] When used inside a ":while" or ":for" loop, skips to |
| 7898 the command after the matching ":endwhile" or | |
| 7899 ":endfor". | |
| 7900 If it is used after a |:try| inside the loop but | |
| 7901 before the matching |:finally| (if present), the | |
| 7902 commands following the ":finally" up to the matching | |
| 7903 |:endtry| are executed first. This process applies to | |
| 7904 all nested ":try"s inside the loop. The outermost | |
| 7905 ":endtry" then jumps to the command after the loop. | |
| 7 | 7906 |
| 7907 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
| 7908 :endt[ry] Change the error handling for the commands between | |
| 7909 ":try" and ":endtry" including everything being | |
| 7910 executed across ":source" commands, function calls, | |
| 7911 or autocommand invocations. | |
| 7912 | |
| 7913 When an error or interrupt is detected and there is | |
| 7914 a |:finally| command following, execution continues | |
| 7915 after the ":finally". Otherwise, or when the | |
| 7916 ":endtry" is reached thereafter, the next | |
| 7917 (dynamically) surrounding ":try" is checked for | |
| 7918 a corresponding ":finally" etc. Then the script | |
| 7919 processing is terminated. (Whether a function | |
| 7920 definition has an "abort" argument does not matter.) | |
| 7921 Example: > | |
| 7922 :try | edit too much | finally | echo "cleanup" | endtry | |
| 7923 :echo "impossible" " not reached, script terminated above | |
| 7924 < | |
| 7925 Moreover, an error or interrupt (dynamically) inside | |
| 7926 ":try" and ":endtry" is converted to an exception. It | |
| 7927 can be caught as if it were thrown by a |:throw| | |
| 7928 command (see |:catch|). In this case, the script | |
| 7929 processing is not terminated. | |
| 7930 | |
| 7931 The value "Vim:Interrupt" is used for an interrupt | |
| 7932 exception. An error in a Vim command is converted | |
| 7933 to a value of the form "Vim({command}):{errmsg}", | |
| 7934 other errors are converted to a value of the form | |
| 7935 "Vim:{errmsg}". {command} is the full command name, | |
| 7936 and {errmsg} is the message that is displayed if the | |
| 7937 error exception is not caught, always beginning with | |
| 7938 the error number. | |
| 7939 Examples: > | |
| 7940 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry | |
| 7941 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
| 7942 < | |
| 7943 *:cat* *:catch* *E603* *E604* *E605* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7944 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
| 7 | 7945 |:finally|, or |:endtry| that belongs to the same |
| 7946 |:try| as the ":catch" are executed when an exception | |
| 7947 matching {pattern} is being thrown and has not yet | |
| 7948 been caught by a previous ":catch". Otherwise, these | |
| 7949 commands are skipped. | |
| 7950 When {pattern} is omitted all errors are caught. | |
| 7951 Examples: > | |
| 7952 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) | |
| 7953 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors | |
| 7954 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts | |
| 7955 :catch /^Vim(write):/ " catch all errors in :write | |
| 7956 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123 | |
| 7957 :catch /my-exception/ " catch user exception | |
| 7958 :catch /.*/ " catch everything | |
| 7959 :catch " same as /.*/ | |
| 7960 < | |
| 7961 Another character can be used instead of / around the | |
| 7962 {pattern}, so long as it does not have a special | |
| 7963 meaning (e.g., '|' or '"') and doesn't occur inside | |
| 7964 {pattern}. | |
| 5814 | 7965 Information about the exception is available in |
| 7966 |v:exception|. Also see |throw-variables|. | |
| 7 | 7967 NOTE: It is not reliable to ":catch" the TEXT of |
| 7968 an error message because it may vary in different | |
| 7969 locales. | |
| 7970 | |
| 7971 *:fina* *:finally* *E606* *E607* | |
| 7972 :fina[lly] The following commands until the matching |:endtry| | |
| 7973 are executed whenever the part between the matching | |
| 7974 |:try| and the ":finally" is left: either by falling | |
| 7975 through to the ":finally" or by a |:continue|, | |
| 7976 |:break|, |:finish|, or |:return|, or by an error or | |
| 7977 interrupt or exception (see |:throw|). | |
| 7978 | |
| 7979 *:th* *:throw* *E608* | |
| 7980 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
| 7981 If the ":throw" is used after a |:try| but before the | |
| 7982 first corresponding |:catch|, commands are skipped | |
| 7983 until the first ":catch" matching {expr1} is reached. | |
| 7984 If there is no such ":catch" or if the ":throw" is | |
| 7985 used after a ":catch" but before the |:finally|, the | |
| 7986 commands following the ":finally" (if present) up to | |
| 7987 the matching |:endtry| are executed. If the ":throw" | |
| 7988 is after the ":finally", commands up to the ":endtry" | |
| 7989 are skipped. At the ":endtry", this process applies | |
| 7990 again for the next dynamically surrounding ":try" | |
| 7991 (which may be found in a calling function or sourcing | |
| 7992 script), until a matching ":catch" has been found. | |
| 7993 If the exception is not caught, the command processing | |
| 7994 is terminated. | |
| 7995 Example: > | |
| 7996 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
| 2725 | 7997 < Note that "catch" may need to be on a separate line |
| 7998 for when an error causes the parsing to skip the whole | |
| 7999 line and not see the "|" that separates the commands. | |
| 7 | 8000 |
| 8001 *:ec* *:echo* | |
| 8002 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
| 8003 first {expr1} starts on a new line. | |
| 8004 Also see |:comment|. | |
| 8005 Use "\n" to start a new line. Use "\r" to move the | |
| 8006 cursor to the first column. | |
| 8007 Uses the highlighting set by the |:echohl| command. | |
| 8008 Cannot be followed by a comment. | |
| 8009 Example: > | |
| 8010 :echo "the value of 'shell' is" &shell | |
| 1156 | 8011 < *:echo-redraw* |
| 8012 A later redraw may make the message disappear again. | |
| 8013 And since Vim mostly postpones redrawing until it's | |
| 8014 finished with a sequence of commands this happens | |
| 8015 quite often. To avoid that a command from before the | |
| 8016 ":echo" causes a redraw afterwards (redraws are often | |
| 8017 postponed until you type something), force a redraw | |
| 8018 with the |:redraw| command. Example: > | |
| 7 | 8019 :new | redraw | echo "there is a new window" |
| 8020 < | |
| 8021 *:echon* | |
| 8022 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
| 8023 |:comment|. | |
| 8024 Uses the highlighting set by the |:echohl| command. | |
| 8025 Cannot be followed by a comment. | |
| 8026 Example: > | |
| 8027 :echon "the value of 'shell' is " &shell | |
| 8028 < | |
| 8029 Note the difference between using ":echo", which is a | |
| 8030 Vim command, and ":!echo", which is an external shell | |
| 8031 command: > | |
| 8032 :!echo % --> filename | |
| 8033 < The arguments of ":!" are expanded, see |:_%|. > | |
| 8034 :!echo "%" --> filename or "filename" | |
| 8035 < Like the previous example. Whether you see the double | |
| 8036 quotes or not depends on your 'shell'. > | |
| 8037 :echo % --> nothing | |
| 8038 < The '%' is an illegal character in an expression. > | |
| 8039 :echo "%" --> % | |
| 8040 < This just echoes the '%' character. > | |
| 8041 :echo expand("%") --> filename | |
| 8042 < This calls the expand() function to expand the '%'. | |
| 8043 | |
| 8044 *:echoh* *:echohl* | |
| 8045 :echoh[l] {name} Use the highlight group {name} for the following | |
| 8046 |:echo|, |:echon| and |:echomsg| commands. Also used | |
| 8047 for the |input()| prompt. Example: > | |
| 8048 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
| 8049 < Don't forget to set the group back to "None", | |
| 8050 otherwise all following echo's will be highlighted. | |
| 8051 | |
| 8052 *:echom* *:echomsg* | |
| 8053 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
| 8054 message in the |message-history|. | |
| 8055 Spaces are placed between the arguments as with the | |
| 8056 |:echo| command. But unprintable characters are | |
| 8057 displayed, not interpreted. | |
| 1156 | 8058 The parsing works slightly different from |:echo|, |
| 8059 more like |:execute|. All the expressions are first | |
| 8060 evaluated and concatenated before echoing anything. | |
| 8061 The expressions must evaluate to a Number or String, a | |
| 8062 Dictionary or List causes an error. | |
| 7 | 8063 Uses the highlighting set by the |:echohl| command. |
| 8064 Example: > | |
| 8065 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
| 1156 | 8066 < See |:echo-redraw| to avoid the message disappearing |
| 8067 when the screen is redrawn. | |
| 7 | 8068 *:echoe* *:echoerr* |
| 8069 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
| 8070 message in the |message-history|. When used in a | |
| 8071 script or function the line number will be added. | |
| 8072 Spaces are placed between the arguments as with the | |
| 1621 | 8073 :echo command. When used inside a try conditional, |
| 7 | 8074 the message is raised as an error exception instead |
| 8075 (see |try-echoerr|). | |
| 8076 Example: > | |
| 8077 :echoerr "This script just failed!" | |
| 8078 < If you just want a highlighted message use |:echohl|. | |
| 8079 And to get a beep: > | |
| 8080 :exe "normal \<Esc>" | |
| 8081 < | |
| 8082 *:exe* *:execute* | |
| 8083 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
| 2152 | 8084 of {expr1} as an Ex command. |
| 8085 Multiple arguments are concatenated, with a space in | |
| 8086 between. To avoid the extra space use the "." | |
| 8087 operator to concatenate strings into one argument. | |
| 8088 {expr1} is used as the processed command, command line | |
| 8089 editing keys are not recognized. | |
| 7 | 8090 Cannot be followed by a comment. |
| 8091 Examples: > | |
| 2152 | 8092 :execute "buffer" nextbuf |
| 8093 :execute "normal" count . "w" | |
| 7 | 8094 < |
| 8095 ":execute" can be used to append a command to commands | |
| 8096 that don't accept a '|'. Example: > | |
| 8097 :execute '!ls' | echo "theend" | |
| 8098 | |
| 8099 < ":execute" is also a nice way to avoid having to type | |
| 8100 control characters in a Vim script for a ":normal" | |
| 8101 command: > | |
| 8102 :execute "normal ixxx\<Esc>" | |
| 8103 < This has an <Esc> character, see |expr-string|. | |
| 8104 | |
| 1621 | 8105 Be careful to correctly escape special characters in |
| 8106 file names. The |fnameescape()| function can be used | |
| 1661 | 8107 for Vim commands, |shellescape()| for |:!| commands. |
| 8108 Examples: > | |
| 1621 | 8109 :execute "e " . fnameescape(filename) |
|
5692
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5690
diff
changeset
|
8110 :execute "!ls " . shellescape(filename, 1) |
| 1621 | 8111 < |
| 7 | 8112 Note: The executed string may be any command-line, but |
| 5763 | 8113 starting or ending "if", "while" and "for" does not |
| 8114 always work, because when commands are skipped the | |
| 8115 ":execute" is not evaluated and Vim loses track of | |
| 8116 where blocks start and end. Also "break" and | |
| 8117 "continue" should not be inside ":execute". | |
| 8118 This example does not work, because the ":execute" is | |
| 8119 not evaluated and Vim does not see the "while", and | |
| 8120 gives an error for finding an ":endwhile": > | |
| 8121 :if 0 | |
| 8122 : execute 'while i > 5' | |
| 8123 : echo "test" | |
| 8124 : endwhile | |
| 8125 :endif | |
| 7 | 8126 < |
| 8127 It is allowed to have a "while" or "if" command | |
| 8128 completely in the executed string: > | |
| 8129 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
| 8130 < | |
| 8131 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8132 *:exe-comment* |
| 7 | 8133 ":execute", ":echo" and ":echon" cannot be followed by |
| 8134 a comment directly, because they see the '"' as the | |
| 8135 start of a string. But, you can use '|' followed by a | |
| 8136 comment. Example: > | |
| 8137 :echo "foo" | "this is a comment | |
| 8138 | |
| 8139 ============================================================================== | |
| 8140 8. Exception handling *exception-handling* | |
| 8141 | |
| 8142 The Vim script language comprises an exception handling feature. This section | |
| 8143 explains how it can be used in a Vim script. | |
| 8144 | |
| 8145 Exceptions may be raised by Vim on an error or on interrupt, see | |
| 8146 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
| 8147 exception by using the ":throw" command, see |throw-catch|. | |
| 8148 | |
| 8149 | |
| 8150 TRY CONDITIONALS *try-conditionals* | |
| 8151 | |
| 8152 Exceptions can be caught or can cause cleanup code to be executed. You can | |
| 8153 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
| 8154 a finally clause (to be executed for cleanup). | |
| 8155 A try conditional begins with a |:try| command and ends at the matching | |
| 8156 |:endtry| command. In between, you can use a |:catch| command to start | |
| 8157 a catch clause, or a |:finally| command to start a finally clause. There may | |
| 8158 be none or multiple catch clauses, but there is at most one finally clause, | |
| 8159 which must not be followed by any catch clauses. The lines before the catch | |
| 8160 clauses and the finally clause is called a try block. > | |
| 8161 | |
| 8162 :try | |
| 1621 | 8163 : ... |
| 8164 : ... TRY BLOCK | |
| 8165 : ... | |
| 7 | 8166 :catch /{pattern}/ |
| 1621 | 8167 : ... |
| 8168 : ... CATCH CLAUSE | |
| 8169 : ... | |
| 7 | 8170 :catch /{pattern}/ |
| 1621 | 8171 : ... |
| 8172 : ... CATCH CLAUSE | |
| 8173 : ... | |
| 7 | 8174 :finally |
| 1621 | 8175 : ... |
| 8176 : ... FINALLY CLAUSE | |
| 8177 : ... | |
| 7 | 8178 :endtry |
| 8179 | |
| 8180 The try conditional allows to watch code for exceptions and to take the | |
| 8181 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
| 8182 from the try block and also the catch clauses may cause cleanup actions. | |
| 8183 When no exception is thrown during execution of the try block, the control | |
| 8184 is transferred to the finally clause, if present. After its execution, the | |
| 8185 script continues with the line following the ":endtry". | |
| 8186 When an exception occurs during execution of the try block, the remaining | |
| 8187 lines in the try block are skipped. The exception is matched against the | |
| 8188 patterns specified as arguments to the ":catch" commands. The catch clause | |
| 8189 after the first matching ":catch" is taken, other catch clauses are not | |
| 8190 executed. The catch clause ends when the next ":catch", ":finally", or | |
| 8191 ":endtry" command is reached - whatever is first. Then, the finally clause | |
| 8192 (if present) is executed. When the ":endtry" is reached, the script execution | |
| 8193 continues in the following line as usual. | |
| 8194 When an exception that does not match any of the patterns specified by the | |
| 8195 ":catch" commands is thrown in the try block, the exception is not caught by | |
| 8196 that try conditional and none of the catch clauses is executed. Only the | |
| 8197 finally clause, if present, is taken. The exception pends during execution of | |
| 8198 the finally clause. It is resumed at the ":endtry", so that commands after | |
| 8199 the ":endtry" are not executed and the exception might be caught elsewhere, | |
| 8200 see |try-nesting|. | |
| 8201 When during execution of a catch clause another exception is thrown, the | |
| 1621 | 8202 remaining lines in that catch clause are not executed. The new exception is |
| 7 | 8203 not matched against the patterns in any of the ":catch" commands of the same |
| 8204 try conditional and none of its catch clauses is taken. If there is, however, | |
| 8205 a finally clause, it is executed, and the exception pends during its | |
| 8206 execution. The commands following the ":endtry" are not executed. The new | |
| 8207 exception might, however, be caught elsewhere, see |try-nesting|. | |
| 8208 When during execution of the finally clause (if present) an exception is | |
| 1621 | 8209 thrown, the remaining lines in the finally clause are skipped. If the finally |
| 7 | 8210 clause has been taken because of an exception from the try block or one of the |
| 8211 catch clauses, the original (pending) exception is discarded. The commands | |
| 8212 following the ":endtry" are not executed, and the exception from the finally | |
| 8213 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
| 8214 | |
| 8215 The finally clause is also executed, when a ":break" or ":continue" for | |
| 8216 a ":while" loop enclosing the complete try conditional is executed from the | |
| 8217 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
| 8218 from the try block or a catch clause of a try conditional in a function or | |
| 8219 sourced script, respectively. The ":break", ":continue", ":return", or | |
| 8220 ":finish" pends during execution of the finally clause and is resumed when the | |
| 8221 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
| 8222 from the finally clause. | |
| 8223 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
| 8224 try conditional or when a ":return" or ":finish" is encountered in the finally | |
| 8225 clause, the rest of the finally clause is skipped, and the ":break", | |
| 8226 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
| 8227 clause has been taken because of an exception or an earlier ":break", | |
| 8228 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
| 8229 this pending exception or command is discarded. | |
| 8230 | |
| 8231 For examples see |throw-catch| and |try-finally|. | |
| 8232 | |
| 8233 | |
| 8234 NESTING OF TRY CONDITIONALS *try-nesting* | |
| 8235 | |
| 8236 Try conditionals can be nested arbitrarily. That is, a complete try | |
| 8237 conditional can be put into the try block, a catch clause, or the finally | |
| 8238 clause of another try conditional. If the inner try conditional does not | |
| 8239 catch an exception thrown in its try block or throws a new exception from one | |
| 8240 of its catch clauses or its finally clause, the outer try conditional is | |
| 8241 checked according to the rules above. If the inner try conditional is in the | |
| 8242 try block of the outer try conditional, its catch clauses are checked, but | |
| 1621 | 8243 otherwise only the finally clause is executed. It does not matter for |
| 7 | 8244 nesting, whether the inner try conditional is directly contained in the outer |
| 8245 one, or whether the outer one sources a script or calls a function containing | |
| 8246 the inner try conditional. | |
| 8247 | |
| 8248 When none of the active try conditionals catches an exception, just their | |
| 8249 finally clauses are executed. Thereafter, the script processing terminates. | |
| 8250 An error message is displayed in case of an uncaught exception explicitly | |
| 8251 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
| 8252 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
| 8253 as usual. | |
| 8254 | |
| 8255 For examples see |throw-catch|. | |
| 8256 | |
| 8257 | |
| 8258 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
| 8259 | |
| 8260 Exception handling code can get tricky. If you are in doubt what happens, set | |
| 8261 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
| 8262 script file. Then you see when an exception is thrown, discarded, caught, or | |
| 8263 finished. When using a verbosity level of at least 14, things pending in | |
| 8264 a finally clause are also shown. This information is also given in debug mode | |
| 8265 (see |debug-scripts|). | |
| 8266 | |
| 8267 | |
| 8268 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
| 8269 | |
| 8270 You can throw any number or string as an exception. Use the |:throw| command | |
| 8271 and pass the value to be thrown as argument: > | |
| 8272 :throw 4711 | |
| 8273 :throw "string" | |
| 8274 < *throw-expression* | |
| 8275 You can also specify an expression argument. The expression is then evaluated | |
| 8276 first, and the result is thrown: > | |
| 8277 :throw 4705 + strlen("string") | |
| 8278 :throw strpart("strings", 0, 6) | |
| 8279 | |
| 8280 An exception might be thrown during evaluation of the argument of the ":throw" | |
| 8281 command. Unless it is caught there, the expression evaluation is abandoned. | |
| 8282 The ":throw" command then does not throw a new exception. | |
| 8283 Example: > | |
| 8284 | |
| 8285 :function! Foo(arg) | |
| 8286 : try | |
| 8287 : throw a:arg | |
| 8288 : catch /foo/ | |
| 8289 : endtry | |
| 8290 : return 1 | |
| 8291 :endfunction | |
| 8292 : | |
| 8293 :function! Bar() | |
| 8294 : echo "in Bar" | |
| 8295 : return 4710 | |
| 8296 :endfunction | |
| 8297 : | |
| 8298 :throw Foo("arrgh") + Bar() | |
| 8299 | |
| 8300 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
| 8301 executed. > | |
| 8302 :throw Foo("foo") + Bar() | |
| 8303 however displays "in Bar" and throws 4711. | |
| 8304 | |
| 8305 Any other command that takes an expression as argument might also be | |
| 1621 | 8306 abandoned by an (uncaught) exception during the expression evaluation. The |
| 7 | 8307 exception is then propagated to the caller of the command. |
| 8308 Example: > | |
| 8309 | |
| 8310 :if Foo("arrgh") | |
| 8311 : echo "then" | |
| 8312 :else | |
| 8313 : echo "else" | |
| 8314 :endif | |
| 8315 | |
| 8316 Here neither of "then" or "else" is displayed. | |
| 8317 | |
| 8318 *catch-order* | |
| 8319 Exceptions can be caught by a try conditional with one or more |:catch| | |
| 8320 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
| 8321 command can be specified as a pattern argument. The subsequent catch clause | |
| 8322 gets executed when a matching exception is caught. | |
| 8323 Example: > | |
| 8324 | |
| 8325 :function! Foo(value) | |
| 8326 : try | |
| 8327 : throw a:value | |
| 8328 : catch /^\d\+$/ | |
| 8329 : echo "Number thrown" | |
| 8330 : catch /.*/ | |
| 8331 : echo "String thrown" | |
| 8332 : endtry | |
| 8333 :endfunction | |
| 8334 : | |
| 8335 :call Foo(0x1267) | |
| 8336 :call Foo('string') | |
| 8337 | |
| 8338 The first call to Foo() displays "Number thrown", the second "String thrown". | |
| 8339 An exception is matched against the ":catch" commands in the order they are | |
| 8340 specified. Only the first match counts. So you should place the more | |
| 8341 specific ":catch" first. The following order does not make sense: > | |
| 8342 | |
| 8343 : catch /.*/ | |
| 8344 : echo "String thrown" | |
| 8345 : catch /^\d\+$/ | |
| 8346 : echo "Number thrown" | |
| 8347 | |
| 8348 The first ":catch" here matches always, so that the second catch clause is | |
| 8349 never taken. | |
| 8350 | |
| 8351 *throw-variables* | |
| 8352 If you catch an exception by a general pattern, you may access the exact value | |
| 8353 in the variable |v:exception|: > | |
| 8354 | |
| 8355 : catch /^\d\+$/ | |
| 8356 : echo "Number thrown. Value is" v:exception | |
| 8357 | |
| 8358 You may also be interested where an exception was thrown. This is stored in | |
| 8359 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
| 8360 exception most recently caught as long it is not finished. | |
| 8361 Example: > | |
| 8362 | |
| 8363 :function! Caught() | |
| 8364 : if v:exception != "" | |
| 8365 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
| 8366 : else | |
| 8367 : echo 'Nothing caught' | |
| 8368 : endif | |
| 8369 :endfunction | |
| 8370 : | |
| 8371 :function! Foo() | |
| 8372 : try | |
| 8373 : try | |
| 8374 : try | |
| 8375 : throw 4711 | |
| 8376 : finally | |
| 8377 : call Caught() | |
| 8378 : endtry | |
| 8379 : catch /.*/ | |
| 8380 : call Caught() | |
| 8381 : throw "oops" | |
| 8382 : endtry | |
| 8383 : catch /.*/ | |
| 8384 : call Caught() | |
| 8385 : finally | |
| 8386 : call Caught() | |
| 8387 : endtry | |
| 8388 :endfunction | |
| 8389 : | |
| 8390 :call Foo() | |
| 8391 | |
| 8392 This displays > | |
| 8393 | |
| 8394 Nothing caught | |
| 8395 Caught "4711" in function Foo, line 4 | |
| 8396 Caught "oops" in function Foo, line 10 | |
| 8397 Nothing caught | |
| 8398 | |
| 8399 A practical example: The following command ":LineNumber" displays the line | |
| 8400 number in the script or function where it has been used: > | |
| 8401 | |
| 8402 :function! LineNumber() | |
| 8403 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
| 8404 :endfunction | |
| 8405 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
| 8406 < | |
| 8407 *try-nested* | |
| 8408 An exception that is not caught by a try conditional can be caught by | |
| 8409 a surrounding try conditional: > | |
| 8410 | |
| 8411 :try | |
| 8412 : try | |
| 8413 : throw "foo" | |
| 8414 : catch /foobar/ | |
| 8415 : echo "foobar" | |
| 8416 : finally | |
| 8417 : echo "inner finally" | |
| 8418 : endtry | |
| 8419 :catch /foo/ | |
| 8420 : echo "foo" | |
| 8421 :endtry | |
| 8422 | |
| 8423 The inner try conditional does not catch the exception, just its finally | |
| 8424 clause is executed. The exception is then caught by the outer try | |
| 8425 conditional. The example displays "inner finally" and then "foo". | |
| 8426 | |
| 8427 *throw-from-catch* | |
| 8428 You can catch an exception and throw a new one to be caught elsewhere from the | |
| 8429 catch clause: > | |
| 8430 | |
| 8431 :function! Foo() | |
| 8432 : throw "foo" | |
| 8433 :endfunction | |
| 8434 : | |
| 8435 :function! Bar() | |
| 8436 : try | |
| 8437 : call Foo() | |
| 8438 : catch /foo/ | |
| 8439 : echo "Caught foo, throw bar" | |
| 8440 : throw "bar" | |
| 8441 : endtry | |
| 8442 :endfunction | |
| 8443 : | |
| 8444 :try | |
| 8445 : call Bar() | |
| 8446 :catch /.*/ | |
| 8447 : echo "Caught" v:exception | |
| 8448 :endtry | |
| 8449 | |
| 8450 This displays "Caught foo, throw bar" and then "Caught bar". | |
| 8451 | |
| 8452 *rethrow* | |
| 8453 There is no real rethrow in the Vim script language, but you may throw | |
| 8454 "v:exception" instead: > | |
| 8455 | |
| 8456 :function! Bar() | |
| 8457 : try | |
| 8458 : call Foo() | |
| 8459 : catch /.*/ | |
| 8460 : echo "Rethrow" v:exception | |
| 8461 : throw v:exception | |
| 8462 : endtry | |
| 8463 :endfunction | |
| 8464 < *try-echoerr* | |
| 8465 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
| 8466 exceptions, because it is not possible to fake Vim internal exceptions. | |
| 8467 Trying so causes an error exception. You should throw your own exception | |
| 8468 denoting the situation. If you want to cause a Vim error exception containing | |
| 8469 the original error exception value, you can use the |:echoerr| command: > | |
| 8470 | |
| 8471 :try | |
| 8472 : try | |
| 8473 : asdf | |
| 8474 : catch /.*/ | |
| 8475 : echoerr v:exception | |
| 8476 : endtry | |
| 8477 :catch /.*/ | |
| 8478 : echo v:exception | |
| 8479 :endtry | |
| 8480 | |
| 8481 This code displays | |
| 8482 | |
| 1621 | 8483 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
| 7 | 8484 |
| 8485 | |
| 8486 CLEANUP CODE *try-finally* | |
| 8487 | |
| 8488 Scripts often change global settings and restore them at their end. If the | |
| 8489 user however interrupts the script by pressing CTRL-C, the settings remain in | |
| 1621 | 8490 an inconsistent state. The same may happen to you in the development phase of |
| 7 | 8491 a script when an error occurs or you explicitly throw an exception without |
| 8492 catching it. You can solve these problems by using a try conditional with | |
| 8493 a finally clause for restoring the settings. Its execution is guaranteed on | |
| 8494 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
| 8495 (Note that errors and interrupts from inside the try conditional are converted | |
| 1621 | 8496 to exceptions. When not caught, they terminate the script after the finally |
| 7 | 8497 clause has been executed.) |
| 8498 Example: > | |
| 8499 | |
| 8500 :try | |
| 8501 : let s:saved_ts = &ts | |
| 8502 : set ts=17 | |
| 8503 : | |
| 8504 : " Do the hard work here. | |
| 8505 : | |
| 8506 :finally | |
| 8507 : let &ts = s:saved_ts | |
| 8508 : unlet s:saved_ts | |
| 8509 :endtry | |
| 8510 | |
| 8511 This method should be used locally whenever a function or part of a script | |
| 8512 changes global settings which need to be restored on failure or normal exit of | |
| 8513 that function or script part. | |
| 8514 | |
| 8515 *break-finally* | |
| 8516 Cleanup code works also when the try block or a catch clause is left by | |
| 8517 a ":continue", ":break", ":return", or ":finish". | |
| 8518 Example: > | |
| 8519 | |
| 8520 :let first = 1 | |
| 8521 :while 1 | |
| 8522 : try | |
| 8523 : if first | |
| 8524 : echo "first" | |
| 8525 : let first = 0 | |
| 8526 : continue | |
| 8527 : else | |
| 8528 : throw "second" | |
| 8529 : endif | |
| 8530 : catch /.*/ | |
| 8531 : echo v:exception | |
| 8532 : break | |
| 8533 : finally | |
| 8534 : echo "cleanup" | |
| 8535 : endtry | |
| 8536 : echo "still in while" | |
| 8537 :endwhile | |
| 8538 :echo "end" | |
| 8539 | |
| 8540 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
| 8541 | |
| 8542 :function! Foo() | |
| 8543 : try | |
| 8544 : return 4711 | |
| 8545 : finally | |
| 8546 : echo "cleanup\n" | |
| 8547 : endtry | |
| 8548 : echo "Foo still active" | |
| 8549 :endfunction | |
| 8550 : | |
| 8551 :echo Foo() "returned by Foo" | |
| 8552 | |
| 8553 This displays "cleanup" and "4711 returned by Foo". You don't need to add an | |
| 1621 | 8554 extra ":return" in the finally clause. (Above all, this would override the |
| 7 | 8555 return value.) |
| 8556 | |
| 8557 *except-from-finally* | |
| 8558 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
| 8559 a finally clause is possible, but not recommended since it abandons the | |
| 8560 cleanup actions for the try conditional. But, of course, interrupt and error | |
| 8561 exceptions might get raised from a finally clause. | |
| 8562 Example where an error in the finally clause stops an interrupt from | |
| 8563 working correctly: > | |
| 8564 | |
| 8565 :try | |
| 8566 : try | |
| 8567 : echo "Press CTRL-C for interrupt" | |
| 8568 : while 1 | |
| 8569 : endwhile | |
| 8570 : finally | |
| 8571 : unlet novar | |
| 8572 : endtry | |
| 8573 :catch /novar/ | |
| 8574 :endtry | |
| 8575 :echo "Script still running" | |
| 8576 :sleep 1 | |
| 8577 | |
| 8578 If you need to put commands that could fail into a finally clause, you should | |
| 8579 think about catching or ignoring the errors in these commands, see | |
| 8580 |catch-errors| and |ignore-errors|. | |
| 8581 | |
| 8582 | |
| 8583 CATCHING ERRORS *catch-errors* | |
| 8584 | |
| 8585 If you want to catch specific errors, you just have to put the code to be | |
| 8586 watched in a try block and add a catch clause for the error message. The | |
| 8587 presence of the try conditional causes all errors to be converted to an | |
| 8588 exception. No message is displayed and |v:errmsg| is not set then. To find | |
| 8589 the right pattern for the ":catch" command, you have to know how the format of | |
| 8590 the error exception is. | |
| 8591 Error exceptions have the following format: > | |
| 8592 | |
| 8593 Vim({cmdname}):{errmsg} | |
| 8594 or > | |
| 8595 Vim:{errmsg} | |
| 8596 | |
| 8597 {cmdname} is the name of the command that failed; the second form is used when | |
| 1621 | 8598 the command name is not known. {errmsg} is the error message usually produced |
| 7 | 8599 when the error occurs outside try conditionals. It always begins with |
| 8600 a capital "E", followed by a two or three-digit error number, a colon, and | |
| 8601 a space. | |
| 8602 | |
| 8603 Examples: | |
| 8604 | |
| 8605 The command > | |
| 8606 :unlet novar | |
| 8607 normally produces the error message > | |
| 8608 E108: No such variable: "novar" | |
| 8609 which is converted inside try conditionals to an exception > | |
| 8610 Vim(unlet):E108: No such variable: "novar" | |
| 8611 | |
| 8612 The command > | |
| 8613 :dwim | |
| 8614 normally produces the error message > | |
| 8615 E492: Not an editor command: dwim | |
| 8616 which is converted inside try conditionals to an exception > | |
| 8617 Vim:E492: Not an editor command: dwim | |
| 8618 | |
| 8619 You can catch all ":unlet" errors by a > | |
| 8620 :catch /^Vim(unlet):/ | |
| 8621 or all errors for misspelled command names by a > | |
| 8622 :catch /^Vim:E492:/ | |
| 8623 | |
| 8624 Some error messages may be produced by different commands: > | |
| 8625 :function nofunc | |
| 8626 and > | |
| 8627 :delfunction nofunc | |
| 8628 both produce the error message > | |
| 8629 E128: Function name must start with a capital: nofunc | |
| 8630 which is converted inside try conditionals to an exception > | |
| 8631 Vim(function):E128: Function name must start with a capital: nofunc | |
| 8632 or > | |
| 8633 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
| 8634 respectively. You can catch the error by its number independently on the | |
| 8635 command that caused it if you use the following pattern: > | |
| 8636 :catch /^Vim(\a\+):E128:/ | |
| 8637 | |
| 8638 Some commands like > | |
| 8639 :let x = novar | |
| 8640 produce multiple error messages, here: > | |
| 8641 E121: Undefined variable: novar | |
| 8642 E15: Invalid expression: novar | |
| 8643 Only the first is used for the exception value, since it is the most specific | |
| 8644 one (see |except-several-errors|). So you can catch it by > | |
| 8645 :catch /^Vim(\a\+):E121:/ | |
| 8646 | |
| 8647 You can catch all errors related to the name "nofunc" by > | |
| 8648 :catch /\<nofunc\>/ | |
| 8649 | |
| 8650 You can catch all Vim errors in the ":write" and ":read" commands by > | |
| 8651 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
| 8652 | |
| 8653 You can catch all Vim errors by the pattern > | |
| 8654 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
| 8655 < | |
| 8656 *catch-text* | |
| 8657 NOTE: You should never catch the error message text itself: > | |
| 8658 :catch /No such variable/ | |
| 6647 | 8659 only works in the English locale, but not when the user has selected |
| 7 | 8660 a different language by the |:language| command. It is however helpful to |
| 8661 cite the message text in a comment: > | |
| 8662 :catch /^Vim(\a\+):E108:/ " No such variable | |
| 8663 | |
| 8664 | |
| 8665 IGNORING ERRORS *ignore-errors* | |
| 8666 | |
| 8667 You can ignore errors in a specific Vim command by catching them locally: > | |
| 8668 | |
| 8669 :try | |
| 8670 : write | |
| 8671 :catch | |
| 8672 :endtry | |
| 8673 | |
| 8674 But you are strongly recommended NOT to use this simple form, since it could | |
| 8675 catch more than you want. With the ":write" command, some autocommands could | |
| 8676 be executed and cause errors not related to writing, for instance: > | |
| 8677 | |
| 8678 :au BufWritePre * unlet novar | |
| 8679 | |
| 8680 There could even be such errors you are not responsible for as a script | |
| 8681 writer: a user of your script might have defined such autocommands. You would | |
| 8682 then hide the error from the user. | |
| 8683 It is much better to use > | |
| 8684 | |
| 8685 :try | |
| 8686 : write | |
| 8687 :catch /^Vim(write):/ | |
| 8688 :endtry | |
| 8689 | |
| 8690 which only catches real write errors. So catch only what you'd like to ignore | |
| 8691 intentionally. | |
| 8692 | |
| 8693 For a single command that does not cause execution of autocommands, you could | |
| 8694 even suppress the conversion of errors to exceptions by the ":silent!" | |
| 8695 command: > | |
| 8696 :silent! nunmap k | |
| 8697 This works also when a try conditional is active. | |
| 8698 | |
| 8699 | |
| 8700 CATCHING INTERRUPTS *catch-interrupt* | |
| 8701 | |
| 8702 When there are active try conditionals, an interrupt (CTRL-C) is converted to | |
| 1621 | 8703 the exception "Vim:Interrupt". You can catch it like every exception. The |
| 7 | 8704 script is not terminated, then. |
| 8705 Example: > | |
| 8706 | |
| 8707 :function! TASK1() | |
| 8708 : sleep 10 | |
| 8709 :endfunction | |
| 8710 | |
| 8711 :function! TASK2() | |
| 8712 : sleep 20 | |
| 8713 :endfunction | |
| 8714 | |
| 8715 :while 1 | |
| 8716 : let command = input("Type a command: ") | |
| 8717 : try | |
| 8718 : if command == "" | |
| 8719 : continue | |
| 8720 : elseif command == "END" | |
| 8721 : break | |
| 8722 : elseif command == "TASK1" | |
| 8723 : call TASK1() | |
| 8724 : elseif command == "TASK2" | |
| 8725 : call TASK2() | |
| 8726 : else | |
| 8727 : echo "\nIllegal command:" command | |
| 8728 : continue | |
| 8729 : endif | |
| 8730 : catch /^Vim:Interrupt$/ | |
| 8731 : echo "\nCommand interrupted" | |
| 8732 : " Caught the interrupt. Continue with next prompt. | |
| 8733 : endtry | |
| 8734 :endwhile | |
| 8735 | |
| 8736 You can interrupt a task here by pressing CTRL-C; the script then asks for | |
| 1621 | 8737 a new command. If you press CTRL-C at the prompt, the script is terminated. |
| 7 | 8738 |
| 8739 For testing what happens when CTRL-C would be pressed on a specific line in | |
| 8740 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
| 8741 command on that line. See |debug-scripts|. | |
| 8742 | |
| 8743 | |
| 8744 CATCHING ALL *catch-all* | |
| 8745 | |
| 8746 The commands > | |
| 8747 | |
| 8748 :catch /.*/ | |
| 8749 :catch // | |
| 8750 :catch | |
| 8751 | |
| 8752 catch everything, error exceptions, interrupt exceptions and exceptions | |
| 8753 explicitly thrown by the |:throw| command. This is useful at the top level of | |
| 8754 a script in order to catch unexpected things. | |
| 8755 Example: > | |
| 8756 | |
| 8757 :try | |
| 8758 : | |
| 8759 : " do the hard work here | |
| 8760 : | |
| 8761 :catch /MyException/ | |
| 8762 : | |
| 8763 : " handle known problem | |
| 8764 : | |
| 8765 :catch /^Vim:Interrupt$/ | |
| 8766 : echo "Script interrupted" | |
| 8767 :catch /.*/ | |
| 8768 : echo "Internal error (" . v:exception . ")" | |
| 8769 : echo " - occurred at " . v:throwpoint | |
| 8770 :endtry | |
| 8771 :" end of script | |
| 8772 | |
| 8773 Note: Catching all might catch more things than you want. Thus, you are | |
| 8774 strongly encouraged to catch only for problems that you can really handle by | |
| 8775 specifying a pattern argument to the ":catch". | |
| 8776 Example: Catching all could make it nearly impossible to interrupt a script | |
| 8777 by pressing CTRL-C: > | |
| 8778 | |
| 8779 :while 1 | |
| 8780 : try | |
| 8781 : sleep 1 | |
| 8782 : catch | |
| 8783 : endtry | |
| 8784 :endwhile | |
| 8785 | |
| 8786 | |
| 8787 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
| 8788 | |
| 8789 Exceptions may be used during execution of autocommands. Example: > | |
| 8790 | |
| 8791 :autocmd User x try | |
| 8792 :autocmd User x throw "Oops!" | |
| 8793 :autocmd User x catch | |
| 8794 :autocmd User x echo v:exception | |
| 8795 :autocmd User x endtry | |
| 8796 :autocmd User x throw "Arrgh!" | |
| 8797 :autocmd User x echo "Should not be displayed" | |
| 8798 : | |
| 8799 :try | |
| 8800 : doautocmd User x | |
| 8801 :catch | |
| 8802 : echo v:exception | |
| 8803 :endtry | |
| 8804 | |
| 8805 This displays "Oops!" and "Arrgh!". | |
| 8806 | |
| 8807 *except-autocmd-Pre* | |
| 8808 For some commands, autocommands get executed before the main action of the | |
| 8809 command takes place. If an exception is thrown and not caught in the sequence | |
| 8810 of autocommands, the sequence and the command that caused its execution are | |
| 8811 abandoned and the exception is propagated to the caller of the command. | |
| 8812 Example: > | |
| 8813 | |
| 8814 :autocmd BufWritePre * throw "FAIL" | |
| 8815 :autocmd BufWritePre * echo "Should not be displayed" | |
| 8816 : | |
| 8817 :try | |
| 8818 : write | |
| 8819 :catch | |
| 8820 : echo "Caught:" v:exception "from" v:throwpoint | |
| 8821 :endtry | |
| 8822 | |
| 8823 Here, the ":write" command does not write the file currently being edited (as | |
| 8824 you can see by checking 'modified'), since the exception from the BufWritePre | |
| 8825 autocommand abandons the ":write". The exception is then caught and the | |
| 8826 script displays: > | |
| 8827 | |
| 8828 Caught: FAIL from BufWrite Auto commands for "*" | |
| 8829 < | |
| 8830 *except-autocmd-Post* | |
| 8831 For some commands, autocommands get executed after the main action of the | |
| 8832 command has taken place. If this main action fails and the command is inside | |
| 8833 an active try conditional, the autocommands are skipped and an error exception | |
| 8834 is thrown that can be caught by the caller of the command. | |
| 8835 Example: > | |
| 8836 | |
| 8837 :autocmd BufWritePost * echo "File successfully written!" | |
| 8838 : | |
| 8839 :try | |
| 8840 : write /i/m/p/o/s/s/i/b/l/e | |
| 8841 :catch | |
| 8842 : echo v:exception | |
| 8843 :endtry | |
| 8844 | |
| 8845 This just displays: > | |
| 8846 | |
| 8847 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
| 8848 | |
| 8849 If you really need to execute the autocommands even when the main action | |
| 8850 fails, trigger the event from the catch clause. | |
| 8851 Example: > | |
| 8852 | |
| 8853 :autocmd BufWritePre * set noreadonly | |
| 8854 :autocmd BufWritePost * set readonly | |
| 8855 : | |
| 8856 :try | |
| 8857 : write /i/m/p/o/s/s/i/b/l/e | |
| 8858 :catch | |
| 8859 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
| 8860 :endtry | |
| 8861 < | |
| 8862 You can also use ":silent!": > | |
| 8863 | |
| 8864 :let x = "ok" | |
| 8865 :let v:errmsg = "" | |
| 8866 :autocmd BufWritePost * if v:errmsg != "" | |
| 8867 :autocmd BufWritePost * let x = "after fail" | |
| 8868 :autocmd BufWritePost * endif | |
| 8869 :try | |
| 8870 : silent! write /i/m/p/o/s/s/i/b/l/e | |
| 8871 :catch | |
| 8872 :endtry | |
| 8873 :echo x | |
| 8874 | |
| 8875 This displays "after fail". | |
| 8876 | |
| 8877 If the main action of the command does not fail, exceptions from the | |
| 8878 autocommands will be catchable by the caller of the command: > | |
| 8879 | |
| 8880 :autocmd BufWritePost * throw ":-(" | |
| 8881 :autocmd BufWritePost * echo "Should not be displayed" | |
| 8882 : | |
| 8883 :try | |
| 8884 : write | |
| 8885 :catch | |
| 8886 : echo v:exception | |
| 8887 :endtry | |
| 8888 < | |
| 8889 *except-autocmd-Cmd* | |
| 8890 For some commands, the normal action can be replaced by a sequence of | |
| 8891 autocommands. Exceptions from that sequence will be catchable by the caller | |
| 8892 of the command. | |
| 8893 Example: For the ":write" command, the caller cannot know whether the file | |
| 1621 | 8894 had actually been written when the exception occurred. You need to tell it in |
| 7 | 8895 some way. > |
| 8896 | |
| 8897 :if !exists("cnt") | |
| 8898 : let cnt = 0 | |
| 8899 : | |
| 8900 : autocmd BufWriteCmd * if &modified | |
| 8901 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
| 8902 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
| 8903 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 8904 : autocmd BufWriteCmd * endif | |
| 8905 : autocmd BufWriteCmd * write | set nomodified | |
| 8906 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
| 8907 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 8908 : autocmd BufWriteCmd * endif | |
| 8909 : autocmd BufWriteCmd * echo "File successfully written!" | |
| 8910 : autocmd BufWriteCmd * endif | |
| 8911 :endif | |
| 8912 : | |
| 8913 :try | |
| 8914 : write | |
| 8915 :catch /^BufWriteCmdError$/ | |
| 8916 : if &modified | |
| 8917 : echo "Error on writing (file contents not changed)" | |
| 8918 : else | |
| 8919 : echo "Error after writing" | |
| 8920 : endif | |
| 8921 :catch /^Vim(write):/ | |
| 8922 : echo "Error on writing" | |
| 8923 :endtry | |
| 8924 | |
| 8925 When this script is sourced several times after making changes, it displays | |
| 8926 first > | |
| 8927 File successfully written! | |
| 8928 then > | |
| 8929 Error on writing (file contents not changed) | |
| 8930 then > | |
| 8931 Error after writing | |
| 8932 etc. | |
| 8933 | |
| 8934 *except-autocmd-ill* | |
| 8935 You cannot spread a try conditional over autocommands for different events. | |
| 8936 The following code is ill-formed: > | |
| 8937 | |
| 8938 :autocmd BufWritePre * try | |
| 8939 : | |
| 8940 :autocmd BufWritePost * catch | |
| 8941 :autocmd BufWritePost * echo v:exception | |
| 8942 :autocmd BufWritePost * endtry | |
| 8943 : | |
| 8944 :write | |
| 8945 | |
| 8946 | |
| 8947 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
| 8948 | |
| 8949 Some programming languages allow to use hierarchies of exception classes or to | |
| 8950 pass additional information with the object of an exception class. You can do | |
| 8951 similar things in Vim. | |
| 8952 In order to throw an exception from a hierarchy, just throw the complete | |
| 8953 class name with the components separated by a colon, for instance throw the | |
| 8954 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
| 8955 When you want to pass additional information with your exception class, add | |
| 8956 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
| 8957 for an error when writing "myfile". | |
| 8958 With the appropriate patterns in the ":catch" command, you can catch for | |
| 8959 base classes or derived classes of your hierarchy. Additional information in | |
| 8960 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
| 8961 Example: > | |
| 8962 | |
| 8963 :function! CheckRange(a, func) | |
| 8964 : if a:a < 0 | |
| 8965 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
| 8966 : endif | |
| 8967 :endfunction | |
| 8968 : | |
| 8969 :function! Add(a, b) | |
| 8970 : call CheckRange(a:a, "Add") | |
| 8971 : call CheckRange(a:b, "Add") | |
| 8972 : let c = a:a + a:b | |
| 8973 : if c < 0 | |
| 8974 : throw "EXCEPT:MATHERR:OVERFLOW" | |
| 8975 : endif | |
| 8976 : return c | |
| 8977 :endfunction | |
| 8978 : | |
| 8979 :function! Div(a, b) | |
| 8980 : call CheckRange(a:a, "Div") | |
| 8981 : call CheckRange(a:b, "Div") | |
| 8982 : if (a:b == 0) | |
| 8983 : throw "EXCEPT:MATHERR:ZERODIV" | |
| 8984 : endif | |
| 8985 : return a:a / a:b | |
| 8986 :endfunction | |
| 8987 : | |
| 8988 :function! Write(file) | |
| 8989 : try | |
| 1621 | 8990 : execute "write" fnameescape(a:file) |
| 7 | 8991 : catch /^Vim(write):/ |
| 8992 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
| 8993 : endtry | |
| 8994 :endfunction | |
| 8995 : | |
| 8996 :try | |
| 8997 : | |
| 8998 : " something with arithmetics and I/O | |
| 8999 : | |
| 9000 :catch /^EXCEPT:MATHERR:RANGE/ | |
| 9001 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
| 9002 : echo "Range error in" function | |
| 9003 : | |
| 9004 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
| 9005 : echo "Math error" | |
| 9006 : | |
| 9007 :catch /^EXCEPT:IO/ | |
| 9008 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
| 9009 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
| 9010 : if file !~ '^/' | |
| 9011 : let file = dir . "/" . file | |
| 9012 : endif | |
| 9013 : echo 'I/O error for "' . file . '"' | |
| 9014 : | |
| 9015 :catch /^EXCEPT/ | |
| 9016 : echo "Unspecified error" | |
| 9017 : | |
| 9018 :endtry | |
| 9019 | |
| 9020 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
| 9021 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
| 9022 exceptions with the "Vim" prefix; they are reserved for Vim. | |
| 9023 Vim error exceptions are parameterized with the name of the command that | |
| 9024 failed, if known. See |catch-errors|. | |
| 9025 | |
| 9026 | |
| 9027 PECULIARITIES | |
| 9028 *except-compat* | |
| 9029 The exception handling concept requires that the command sequence causing the | |
| 9030 exception is aborted immediately and control is transferred to finally clauses | |
| 9031 and/or a catch clause. | |
| 9032 | |
| 9033 In the Vim script language there are cases where scripts and functions | |
| 9034 continue after an error: in functions without the "abort" flag or in a command | |
| 9035 after ":silent!", control flow goes to the following line, and outside | |
| 9036 functions, control flow goes to the line following the outermost ":endwhile" | |
| 9037 or ":endif". On the other hand, errors should be catchable as exceptions | |
| 9038 (thus, requiring the immediate abortion). | |
| 9039 | |
| 9040 This problem has been solved by converting errors to exceptions and using | |
| 9041 immediate abortion (if not suppressed by ":silent!") only when a try | |
| 1621 | 9042 conditional is active. This is no restriction since an (error) exception can |
| 9043 be caught only from an active try conditional. If you want an immediate | |
| 7 | 9044 termination without catching the error, just use a try conditional without |
| 9045 catch clause. (You can cause cleanup code being executed before termination | |
| 9046 by specifying a finally clause.) | |
| 9047 | |
| 9048 When no try conditional is active, the usual abortion and continuation | |
| 9049 behavior is used instead of immediate abortion. This ensures compatibility of | |
| 9050 scripts written for Vim 6.1 and earlier. | |
| 9051 | |
| 9052 However, when sourcing an existing script that does not use exception handling | |
| 9053 commands (or when calling one of its functions) from inside an active try | |
| 9054 conditional of a new script, you might change the control flow of the existing | |
| 9055 script on error. You get the immediate abortion on error and can catch the | |
| 9056 error in the new script. If however the sourced script suppresses error | |
| 9057 messages by using the ":silent!" command (checking for errors by testing | |
| 1621 | 9058 |v:errmsg| if appropriate), its execution path is not changed. The error is |
| 9059 not converted to an exception. (See |:silent|.) So the only remaining cause | |
| 7 | 9060 where this happens is for scripts that don't care about errors and produce |
| 9061 error messages. You probably won't want to use such code from your new | |
| 9062 scripts. | |
| 9063 | |
| 9064 *except-syntax-err* | |
| 9065 Syntax errors in the exception handling commands are never caught by any of | |
| 9066 the ":catch" commands of the try conditional they belong to. Its finally | |
| 9067 clauses, however, is executed. | |
| 9068 Example: > | |
| 9069 | |
| 9070 :try | |
| 9071 : try | |
| 9072 : throw 4711 | |
| 9073 : catch /\(/ | |
| 9074 : echo "in catch with syntax error" | |
| 9075 : catch | |
| 9076 : echo "inner catch-all" | |
| 9077 : finally | |
| 9078 : echo "inner finally" | |
| 9079 : endtry | |
| 9080 :catch | |
| 9081 : echo 'outer catch-all caught "' . v:exception . '"' | |
| 9082 : finally | |
| 9083 : echo "outer finally" | |
| 9084 :endtry | |
| 9085 | |
| 9086 This displays: > | |
| 9087 inner finally | |
| 9088 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
| 9089 outer finally | |
| 9090 The original exception is discarded and an error exception is raised, instead. | |
| 9091 | |
| 9092 *except-single-line* | |
| 9093 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
| 9094 a single line, but then syntax errors may make it difficult to recognize the | |
| 9095 "catch" line, thus you better avoid this. | |
| 9096 Example: > | |
| 9097 :try | unlet! foo # | catch | endtry | |
| 9098 raises an error exception for the trailing characters after the ":unlet!" | |
| 9099 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
| 9100 error exception is discarded and the "E488: Trailing characters" message gets | |
| 9101 displayed. | |
| 9102 | |
| 9103 *except-several-errors* | |
| 9104 When several errors appear in a single command, the first error message is | |
| 9105 usually the most specific one and therefor converted to the error exception. | |
| 9106 Example: > | |
| 9107 echo novar | |
| 9108 causes > | |
| 9109 E121: Undefined variable: novar | |
| 9110 E15: Invalid expression: novar | |
| 9111 The value of the error exception inside try conditionals is: > | |
| 9112 Vim(echo):E121: Undefined variable: novar | |
| 9113 < *except-syntax-error* | |
| 9114 But when a syntax error is detected after a normal error in the same command, | |
| 9115 the syntax error is used for the exception being thrown. | |
| 9116 Example: > | |
| 9117 unlet novar # | |
| 9118 causes > | |
| 9119 E108: No such variable: "novar" | |
| 9120 E488: Trailing characters | |
| 9121 The value of the error exception inside try conditionals is: > | |
| 9122 Vim(unlet):E488: Trailing characters | |
| 9123 This is done because the syntax error might change the execution path in a way | |
| 9124 not intended by the user. Example: > | |
| 9125 try | |
| 9126 try | unlet novar # | catch | echo v:exception | endtry | |
| 9127 catch /.*/ | |
| 9128 echo "outer catch:" v:exception | |
| 9129 endtry | |
| 9130 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
| 9131 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
| 9132 | |
| 9133 ============================================================================== | |
| 9134 9. Examples *eval-examples* | |
| 9135 | |
| 1156 | 9136 Printing in Binary ~ |
| 7 | 9137 > |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9138 :" The function Nr2Bin() returns the binary string representation of a number. |
| 1156 | 9139 :func Nr2Bin(nr) |
| 7 | 9140 : let n = a:nr |
| 9141 : let r = "" | |
| 9142 : while n | |
| 1156 | 9143 : let r = '01'[n % 2] . r |
| 9144 : let n = n / 2 | |
| 7 | 9145 : endwhile |
| 9146 : return r | |
| 9147 :endfunc | |
| 9148 | |
| 1156 | 9149 :" The function String2Bin() converts each character in a string to a |
| 9150 :" binary string, separated with dashes. | |
| 9151 :func String2Bin(str) | |
| 7 | 9152 : let out = '' |
| 1156 | 9153 : for ix in range(strlen(a:str)) |
| 9154 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
| 9155 : endfor | |
| 9156 : return out[1:] | |
| 7 | 9157 :endfunc |
| 9158 | |
| 9159 Example of its use: > | |
| 1156 | 9160 :echo Nr2Bin(32) |
| 9161 result: "100000" > | |
| 9162 :echo String2Bin("32") | |
| 9163 result: "110011-110010" | |
| 9164 | |
| 9165 | |
| 9166 Sorting lines ~ | |
| 9167 | |
| 9168 This example sorts lines with a specific compare function. > | |
| 9169 | |
| 9170 :func SortBuffer() | |
| 9171 : let lines = getline(1, '$') | |
| 9172 : call sort(lines, function("Strcmp")) | |
| 9173 : call setline(1, lines) | |
| 7 | 9174 :endfunction |
| 9175 | |
| 1156 | 9176 As a one-liner: > |
| 9177 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
| 9178 | |
| 9179 | |
| 9180 scanf() replacement ~ | |
| 7 | 9181 *sscanf* |
| 9182 There is no sscanf() function in Vim. If you need to extract parts from a | |
| 9183 line, you can use matchstr() and substitute() to do it. This example shows | |
| 9184 how to get the file name, line number and column number out of a line like | |
| 9185 "foobar.txt, 123, 45". > | |
| 9186 :" Set up the match bit | |
| 9187 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
| 9188 :"get the part matching the whole expression | |
| 9189 :let l = matchstr(line, mx) | |
| 9190 :"get each item out of the match | |
| 9191 :let file = substitute(l, mx, '\1', '') | |
| 9192 :let lnum = substitute(l, mx, '\2', '') | |
| 9193 :let col = substitute(l, mx, '\3', '') | |
| 9194 | |
| 9195 The input is in the variable "line", the results in the variables "file", | |
| 9196 "lnum" and "col". (idea from Michael Geddes) | |
| 9197 | |
| 1156 | 9198 |
| 9199 getting the scriptnames in a Dictionary ~ | |
| 9200 *scriptnames-dictionary* | |
| 9201 The |:scriptnames| command can be used to get a list of all script files that | |
| 9202 have been sourced. There is no equivalent function or variable for this | |
| 9203 (because it's rarely needed). In case you need to manipulate the list this | |
| 9204 code can be used: > | |
| 9205 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
| 9206 let scriptnames_output = '' | |
| 9207 redir => scriptnames_output | |
| 9208 silent scriptnames | |
| 9209 redir END | |
| 9210 | |
| 1621 | 9211 " Split the output into lines and parse each line. Add an entry to the |
| 1156 | 9212 " "scripts" dictionary. |
| 9213 let scripts = {} | |
| 9214 for line in split(scriptnames_output, "\n") | |
| 9215 " Only do non-blank lines. | |
| 9216 if line =~ '\S' | |
| 9217 " Get the first number in the line. | |
| 1621 | 9218 let nr = matchstr(line, '\d\+') |
| 1156 | 9219 " Get the file name, remove the script number " 123: ". |
| 1621 | 9220 let name = substitute(line, '.\+:\s*', '', '') |
| 1156 | 9221 " Add an item to the Dictionary |
| 1621 | 9222 let scripts[nr] = name |
| 1156 | 9223 endif |
| 9224 endfor | |
| 9225 unlet scriptnames_output | |
| 9226 | |
| 7 | 9227 ============================================================================== |
| 9228 10. No +eval feature *no-eval-feature* | |
| 9229 | |
| 9230 When the |+eval| feature was disabled at compile time, none of the expression | |
| 9231 evaluation commands are available. To prevent this from causing Vim scripts | |
| 9232 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
| 9233 recognized, though the argument of the ":if" and everything between the ":if" | |
| 9234 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
| 9235 only if the commands are at the start of the line. The ":else" command is not | |
| 9236 recognized. | |
| 9237 | |
| 9238 Example of how to avoid executing commands when the |+eval| feature is | |
| 9239 missing: > | |
| 9240 | |
| 9241 :if 1 | |
| 9242 : echo "Expression evaluation is compiled in" | |
| 9243 :else | |
| 9244 : echo "You will _never_ see this message" | |
| 9245 :endif | |
| 9246 | |
| 9247 ============================================================================== | |
| 9248 11. The sandbox *eval-sandbox* *sandbox* *E48* | |
| 9249 | |
|
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
9250 The 'foldexpr', 'formatexpr', 'includeexpr', 'indentexpr', 'statusline' and |
|
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
9251 'foldtext' options may be evaluated in a sandbox. This means that you are |
|
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
9252 protected from these expressions having nasty side effects. This gives some |
|
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
9253 safety for when these options are set from a modeline. It is also used when |
|
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
9254 the command from a tags file is executed and for CTRL-R = in the command line. |
| 29 | 9255 The sandbox is also used for the |:sandbox| command. |
| 7 | 9256 |
| 9257 These items are not allowed in the sandbox: | |
| 9258 - changing the buffer text | |
| 9259 - defining or changing mapping, autocommands, functions, user commands | |
| 9260 - setting certain options (see |option-summary|) | |
| 1156 | 9261 - setting certain v: variables (see |v:var|) *E794* |
| 7 | 9262 - executing a shell command |
| 9263 - reading or writing a file | |
| 9264 - jumping to another buffer or editing a file | |
| 625 | 9265 - executing Python, Perl, etc. commands |
| 29 | 9266 This is not guaranteed 100% secure, but it should block most attacks. |
| 9267 | |
| 9268 *:san* *:sandbox* | |
| 401 | 9269 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
| 29 | 9270 option that may have been set from a modeline, e.g. |
| 9271 'foldexpr'. | |
| 9272 | |
| 634 | 9273 *sandbox-option* |
| 9274 A few options contain an expression. When this expression is evaluated it may | |
| 790 | 9275 have to be done in the sandbox to avoid a security risk. But the sandbox is |
| 634 | 9276 restrictive, thus this only happens when the option was set from an insecure |
| 9277 location. Insecure in this context are: | |
| 843 | 9278 - sourcing a .vimrc or .exrc in the current directory |
| 634 | 9279 - while executing in the sandbox |
| 9280 - value coming from a modeline | |
| 9281 | |
| 9282 Note that when in the sandbox and saving an option value and restoring it, the | |
| 9283 option will still be marked as it was set in the sandbox. | |
| 9284 | |
| 9285 ============================================================================== | |
| 9286 12. Textlock *textlock* | |
| 9287 | |
| 9288 In a few situations it is not allowed to change the text in the buffer, jump | |
| 9289 to another window and some other things that might confuse or break what Vim | |
| 9290 is currently doing. This mostly applies to things that happen when Vim is | |
| 1621 | 9291 actually doing something else. For example, evaluating the 'balloonexpr' may |
| 634 | 9292 happen any moment the mouse cursor is resting at some position. |
| 9293 | |
| 9294 This is not allowed when the textlock is active: | |
| 9295 - changing the buffer text | |
| 9296 - jumping to another buffer or window | |
| 9297 - editing another file | |
| 9298 - closing a window or quitting Vim | |
| 9299 - etc. | |
| 9300 | |
| 7 | 9301 |
| 9302 vim:tw=78:ts=8:ft=help:norl: |