Mercurial > vim
annotate runtime/doc/eval.txt @ 6991:814f1f569e4a v7.4.813
patch 7.4.813
Problem: It is not possible to save and restore character search state.
Solution: Add getcharsearch() and setcharsearch(). (James McCoy)
| author | Bram Moolenaar <bram@vim.org> |
|---|---|
| date | Tue, 11 Aug 2015 14:26:19 +0200 |
| parents | b2673982c625 |
| children | 349e6c01f35d |
| rev | line source |
|---|---|
|
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
1 *eval.txt* For Vim version 7.4. Last change: 2015 Jul 21 |
| 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* |
| 7 | 71 Conversion from a String to a Number is done by converting the first digits |
| 72 to a number. Hexadecimal "0xf9" and Octal "017" numbers are recognized. If | |
| 2581 | 73 the String doesn't start with digits, the result is zero. Examples: |
| 74 String "456" --> Number 456 ~ | |
| 75 String "6bar" --> Number 6 ~ | |
| 76 String "foo" --> Number 0 ~ | |
| 77 String "0xf1" --> Number 241 ~ | |
| 78 String "0100" --> Number 64 ~ | |
| 79 String "-8" --> Number -8 ~ | |
| 80 String "+8" --> Number 0 ~ | |
| 7 | 81 |
| 82 To force conversion from String to Number, add zero to it: > | |
| 83 :echo "0100" + 0 | |
| 782 | 84 < 64 ~ |
| 85 | |
| 86 To avoid a leading zero to cause octal conversion, or for using a different | |
| 87 base, use |str2nr()|. | |
| 7 | 88 |
| 89 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE. | |
| 90 | |
| 91 Note that in the command > | |
| 92 :if "foo" | |
| 93 "foo" is converted to 0, which means FALSE. To test for a non-empty string, | |
| 3893 | 94 use empty(): > |
| 95 :if !empty("foo") | |
| 153 | 96 < *E745* *E728* *E703* *E729* *E730* *E731* |
| 97 List, Dictionary and Funcref types are not automatically converted. | |
| 85 | 98 |
| 1621 | 99 *E805* *E806* *E808* |
| 100 When mixing Number and Float the Number is converted to Float. Otherwise | |
| 101 there is no automatic conversion of Float. You can use str2float() for String | |
| 102 to Float, printf() for Float to String and float2nr() for Float to Number. | |
| 103 | |
| 104 *E706* *sticky-type-checking* | |
| 85 | 105 You will get an error if you try to change the type of a variable. You need |
| 106 to |:unlet| it first to avoid this error. String and Number are considered | |
| 1621 | 107 equivalent though, as well are Float and Number. Consider this sequence of |
| 108 commands: > | |
| 85 | 109 :let l = "string" |
| 87 | 110 :let l = 44 " changes type from String to Number |
| 1621 | 111 :let l = [1, 2, 3] " error! l is still a Number |
| 112 :let l = 4.4 " changes type from Number to Float | |
| 113 :let l = "string" " error! | |
| 85 | 114 |
| 115 | |
| 87 | 116 1.2 Function references ~ |
| 153 | 117 *Funcref* *E695* *E718* |
| 1621 | 118 A Funcref variable is obtained with the |function()| function. It can be used |
| 114 | 119 in an expression in the place of a function name, before the parenthesis |
| 120 around the arguments, to invoke the function it refers to. Example: > | |
| 55 | 121 |
| 122 :let Fn = function("MyFunc") | |
| 123 :echo Fn() | |
| 114 | 124 < *E704* *E705* *E707* |
| 819 | 125 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You |
| 5340 | 126 can use "g:" but the following name must still start with a capital. You |
| 819 | 127 cannot have both a Funcref variable and a function with the same name. |
| 85 | 128 |
| 114 | 129 A special case is defining a function and directly assigning its Funcref to a |
| 130 Dictionary entry. Example: > | |
| 131 :function dict.init() dict | |
| 132 : let self.val = 0 | |
| 133 :endfunction | |
| 134 | |
| 135 The key of the Dictionary can start with a lower case letter. The actual | |
| 136 function name is not used here. Also see |numbered-function|. | |
| 137 | |
| 138 A Funcref can also be used with the |:call| command: > | |
| 139 :call Fn() | |
| 140 :call dict.init() | |
| 85 | 141 |
| 142 The name of the referenced function can be obtained with |string()|. > | |
| 119 | 143 :let func = string(Fn) |
| 85 | 144 |
| 145 You can use |call()| to invoke a Funcref and use a list variable for the | |
| 146 arguments: > | |
| 119 | 147 :let r = call(Fn, mylist) |
| 85 | 148 |
| 149 | |
| 87 | 150 1.3 Lists ~ |
| 5814 | 151 *list* *List* *Lists* *E686* |
| 55 | 152 A List is an ordered sequence of items. An item can be of any type. Items |
| 1621 | 153 can be accessed by their index number. Items can be added and removed at any |
| 55 | 154 position in the sequence. |
| 155 | |
| 85 | 156 |
| 157 List creation ~ | |
| 158 *E696* *E697* | |
| 55 | 159 A List is created with a comma separated list of items in square brackets. |
| 85 | 160 Examples: > |
| 161 :let mylist = [1, two, 3, "four"] | |
| 162 :let emptylist = [] | |
| 55 | 163 |
| 1621 | 164 An item can be any expression. Using a List for an item creates a |
| 842 | 165 List of Lists: > |
| 85 | 166 :let nestlist = [[11, 12], [21, 22], [31, 32]] |
| 55 | 167 |
| 168 An extra comma after the last item is ignored. | |
| 169 | |
| 85 | 170 |
| 171 List index ~ | |
| 172 *list-index* *E684* | |
| 55 | 173 An item in the List can be accessed by putting the index in square brackets |
| 85 | 174 after the List. Indexes are zero-based, thus the first item has index zero. > |
| 175 :let item = mylist[0] " get the first item: 1 | |
| 55 | 176 :let item = mylist[2] " get the third item: 3 |
| 85 | 177 |
| 87 | 178 When the resulting item is a list this can be repeated: > |
| 85 | 179 :let item = nestlist[0][1] " get the first list, second item: 12 |
| 55 | 180 < |
| 85 | 181 A negative index is counted from the end. Index -1 refers to the last item in |
| 182 the List, -2 to the last but one item, etc. > | |
| 55 | 183 :let last = mylist[-1] " get the last item: "four" |
| 184 | |
| 85 | 185 To avoid an error for an invalid index use the |get()| function. When an item |
| 87 | 186 is not available it returns zero or the default value you specify: > |
| 85 | 187 :echo get(mylist, idx) |
| 188 :echo get(mylist, idx, "NONE") | |
| 189 | |
| 190 | |
| 191 List concatenation ~ | |
| 192 | |
| 193 Two lists can be concatenated with the "+" operator: > | |
| 194 :let longlist = mylist + [5, 6] | |
| 119 | 195 :let mylist += [7, 8] |
| 85 | 196 |
| 197 To prepend or append an item turn the item into a list by putting [] around | |
| 198 it. To change a list in-place see |list-modification| below. | |
| 199 | |
| 200 | |
| 201 Sublist ~ | |
| 202 | |
| 55 | 203 A part of the List can be obtained by specifying the first and last index, |
| 204 separated by a colon in square brackets: > | |
| 85 | 205 :let shortlist = mylist[2:-1] " get List [3, "four"] |
| 55 | 206 |
| 207 Omitting the first index is similar to zero. Omitting the last index is | |
| 1156 | 208 similar to -1. > |
| 90 | 209 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"] |
| 210 :let shortlist = mylist[2:2] " List with one item: [3] | |
| 211 :let otherlist = mylist[:] " make a copy of the List | |
| 85 | 212 |
| 842 | 213 If the first index is beyond the last item of the List or the second item is |
| 214 before the first item, the result is an empty list. There is no error | |
| 215 message. | |
| 216 | |
| 217 If the second index is equal to or greater than the length of the list the | |
| 218 length minus one is used: > | |
| 829 | 219 :let mylist = [0, 1, 2, 3] |
| 220 :echo mylist[2:8] " result: [2, 3] | |
| 221 | |
| 270 | 222 NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for |
| 1621 | 223 using a single letter variable before the ":". Insert a space when needed: |
| 270 | 224 mylist[s : e]. |
| 225 | |
| 85 | 226 |
| 227 List identity ~ | |
| 99 | 228 *list-identity* |
| 85 | 229 When variable "aa" is a list and you assign it to another variable "bb", both |
| 230 variables refer to the same list. Thus changing the list "aa" will also | |
| 231 change "bb": > | |
| 232 :let aa = [1, 2, 3] | |
| 233 :let bb = aa | |
| 234 :call add(aa, 4) | |
| 235 :echo bb | |
| 114 | 236 < [1, 2, 3, 4] |
| 85 | 237 |
| 238 Making a copy of a list is done with the |copy()| function. Using [:] also | |
| 239 works, as explained above. This creates a shallow copy of the list: Changing | |
| 87 | 240 a list item in the list will also change the item in the copied list: > |
| 85 | 241 :let aa = [[1, 'a'], 2, 3] |
| 242 :let bb = copy(aa) | |
| 114 | 243 :call add(aa, 4) |
| 85 | 244 :let aa[0][1] = 'aaa' |
| 245 :echo aa | |
| 114 | 246 < [[1, aaa], 2, 3, 4] > |
| 85 | 247 :echo bb |
| 114 | 248 < [[1, aaa], 2, 3] |
| 85 | 249 |
| 87 | 250 To make a completely independent list use |deepcopy()|. This also makes a |
| 114 | 251 copy of the values in the list, recursively. Up to a hundred levels deep. |
| 85 | 252 |
| 253 The operator "is" can be used to check if two variables refer to the same | |
| 114 | 254 List. "isnot" does the opposite. In contrast "==" compares if two lists have |
| 87 | 255 the same value. > |
| 256 :let alist = [1, 2, 3] | |
| 257 :let blist = [1, 2, 3] | |
| 258 :echo alist is blist | |
| 114 | 259 < 0 > |
| 87 | 260 :echo alist == blist |
| 114 | 261 < 1 |
| 85 | 262 |
| 323 | 263 Note about comparing lists: Two lists are considered equal if they have the |
| 264 same length and all items compare equal, as with using "==". There is one | |
| 388 | 265 exception: When comparing a number with a string they are considered |
| 266 different. There is no automatic type conversion, as with using "==" on | |
| 267 variables. Example: > | |
| 268 echo 4 == "4" | |
| 323 | 269 < 1 > |
| 388 | 270 echo [4] == ["4"] |
| 323 | 271 < 0 |
| 272 | |
| 388 | 273 Thus comparing Lists is more strict than comparing numbers and strings. You |
| 1621 | 274 can compare simple values this way too by putting them in a list: > |
| 388 | 275 |
| 276 :let a = 5 | |
| 277 :let b = "5" | |
| 1621 | 278 :echo a == b |
| 388 | 279 < 1 > |
| 1621 | 280 :echo [a] == [b] |
| 388 | 281 < 0 |
| 323 | 282 |
| 85 | 283 |
| 284 List unpack ~ | |
| 285 | |
| 286 To unpack the items in a list to individual variables, put the variables in | |
| 287 square brackets, like list items: > | |
| 288 :let [var1, var2] = mylist | |
| 289 | |
| 290 When the number of variables does not match the number of items in the list | |
| 291 this produces an error. To handle any extra items from the list append ";" | |
| 292 and a variable name: > | |
| 293 :let [var1, var2; rest] = mylist | |
| 294 | |
| 295 This works like: > | |
| 296 :let var1 = mylist[0] | |
| 297 :let var2 = mylist[1] | |
| 95 | 298 :let rest = mylist[2:] |
| 85 | 299 |
| 300 Except that there is no error if there are only two items. "rest" will be an | |
| 301 empty list then. | |
| 302 | |
| 303 | |
| 304 List modification ~ | |
| 305 *list-modification* | |
| 87 | 306 To change a specific item of a list use |:let| this way: > |
| 85 | 307 :let list[4] = "four" |
| 308 :let listlist[0][3] = item | |
| 309 | |
| 87 | 310 To change part of a list you can specify the first and last item to be |
| 114 | 311 modified. The value must at least have the number of items in the range: > |
| 87 | 312 :let list[3:5] = [3, 4, 5] |
| 313 | |
| 85 | 314 Adding and removing items from a list is done with functions. Here are a few |
| 315 examples: > | |
| 316 :call insert(list, 'a') " prepend item 'a' | |
| 317 :call insert(list, 'a', 3) " insert item 'a' before list[3] | |
| 318 :call add(list, "new") " append String item | |
| 114 | 319 :call add(list, [1, 2]) " append a List as one new item |
| 85 | 320 :call extend(list, [1, 2]) " extend the list with two more items |
| 321 :let i = remove(list, 3) " remove item 3 | |
| 108 | 322 :unlet list[3] " idem |
| 85 | 323 :let l = remove(list, 3, -1) " remove items 3 to last item |
| 108 | 324 :unlet list[3 : ] " idem |
| 114 | 325 :call filter(list, 'v:val !~ "x"') " remove items with an 'x' |
| 326 | |
| 327 Changing the order of items in a list: > | |
| 87 | 328 :call sort(list) " sort a list alphabetically |
| 329 :call reverse(list) " reverse the order of items | |
| 5747 | 330 :call uniq(sort(list)) " sort and remove duplicates |
| 87 | 331 |
| 85 | 332 |
| 333 For loop ~ | |
| 334 | |
| 87 | 335 The |:for| loop executes commands for each item in a list. A variable is set |
| 336 to each item in the list in sequence. Example: > | |
| 114 | 337 :for item in mylist |
| 338 : call Doit(item) | |
| 85 | 339 :endfor |
| 340 | |
| 341 This works like: > | |
| 342 :let index = 0 | |
| 343 :while index < len(mylist) | |
| 114 | 344 : let item = mylist[index] |
| 345 : :call Doit(item) | |
| 85 | 346 : let index = index + 1 |
| 347 :endwhile | |
| 348 | |
| 349 Note that all items in the list should be of the same type, otherwise this | |
| 114 | 350 results in error |E706|. To avoid this |:unlet| the variable at the end of |
| 87 | 351 the loop. |
| 85 | 352 |
| 95 | 353 If all you want to do is modify each item in the list then the |map()| |
| 114 | 354 function will be a simpler method than a for loop. |
| 95 | 355 |
| 1621 | 356 Just like the |:let| command, |:for| also accepts a list of variables. This |
| 85 | 357 requires the argument to be a list of lists. > |
| 358 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]] | |
| 359 : call Doit(lnum, col) | |
| 360 :endfor | |
| 361 | |
| 362 This works like a |:let| command is done for each list item. Again, the types | |
| 363 must remain the same to avoid an error. | |
| 364 | |
| 114 | 365 It is also possible to put remaining items in a List variable: > |
| 85 | 366 :for [i, j; rest] in listlist |
| 367 : call Doit(i, j) | |
| 368 : if !empty(rest) | |
| 369 : echo "remainder: " . string(rest) | |
| 370 : endif | |
| 371 :endfor | |
| 372 | |
| 373 | |
| 374 List functions ~ | |
| 114 | 375 *E714* |
| 85 | 376 Functions that are useful with a List: > |
| 87 | 377 :let r = call(funcname, list) " call a function with an argument list |
| 85 | 378 :if empty(list) " check if list is empty |
| 102 | 379 :let l = len(list) " number of items in list |
| 380 :let big = max(list) " maximum value in list | |
| 381 :let small = min(list) " minimum value in list | |
| 87 | 382 :let xs = count(list, 'x') " count nr of times 'x' appears in list |
| 383 :let i = index(list, 'x') " index of first 'x' in list | |
| 85 | 384 :let lines = getline(1, 10) " get ten text lines from buffer |
| 385 :call append('$', lines) " append text lines in buffer | |
| 95 | 386 :let list = split("a b c") " create list from items in a string |
| 387 :let string = join(list, ', ') " create string from list items | |
| 102 | 388 :let s = string(list) " String representation of list |
| 389 :call map(list, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 390 |
| 258 | 391 Don't forget that a combination of features can make things simple. For |
| 392 example, to add up all the numbers in a list: > | |
| 393 :exe 'let sum = ' . join(nrlist, '+') | |
| 394 | |
| 99 | 395 |
| 396 1.4 Dictionaries ~ | |
| 5814 | 397 *dict* *Dictionaries* *Dictionary* |
| 99 | 398 A Dictionary is an associative array: Each entry has a key and a value. The |
| 114 | 399 entry can be located with the key. The entries are stored without a specific |
| 400 ordering. | |
| 99 | 401 |
| 402 | |
| 403 Dictionary creation ~ | |
| 114 | 404 *E720* *E721* *E722* *E723* |
| 99 | 405 A Dictionary is created with a comma separated list of entries in curly |
| 114 | 406 braces. Each entry has a key and a value, separated by a colon. Each key can |
| 407 only appear once. Examples: > | |
| 99 | 408 :let mydict = {1: 'one', 2: 'two', 3: 'three'} |
| 409 :let emptydict = {} | |
| 114 | 410 < *E713* *E716* *E717* |
| 99 | 411 A key is always a String. You can use a Number, it will be converted to a |
| 412 String automatically. Thus the String '4' and the number 4 will find the same | |
| 1621 | 413 entry. Note that the String '04' and the Number 04 are different, since the |
| 114 | 414 Number will be converted to the String '4'. |
| 415 | |
| 1621 | 416 A value can be any expression. Using a Dictionary for a value creates a |
| 99 | 417 nested Dictionary: > |
| 418 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}} | |
| 419 | |
| 420 An extra comma after the last entry is ignored. | |
| 421 | |
| 422 | |
| 423 Accessing entries ~ | |
| 424 | |
| 425 The normal way to access an entry is by putting the key in square brackets: > | |
| 426 :let val = mydict["one"] | |
| 427 :let mydict["four"] = 4 | |
| 428 | |
| 114 | 429 You can add new entries to an existing Dictionary this way, unlike Lists. |
| 99 | 430 |
| 431 For keys that consist entirely of letters, digits and underscore the following | |
| 432 form can be used |expr-entry|: > | |
| 433 :let val = mydict.one | |
| 434 :let mydict.four = 4 | |
| 435 | |
| 436 Since an entry can be any type, also a List and a Dictionary, the indexing and | |
| 437 key lookup can be repeated: > | |
| 114 | 438 :echo dict.key[idx].key |
| 99 | 439 |
| 440 | |
| 441 Dictionary to List conversion ~ | |
| 442 | |
| 1621 | 443 You may want to loop over the entries in a dictionary. For this you need to |
| 99 | 444 turn the Dictionary into a List and pass it to |:for|. |
| 445 | |
| 446 Most often you want to loop over the keys, using the |keys()| function: > | |
| 447 :for key in keys(mydict) | |
| 448 : echo key . ': ' . mydict[key] | |
| 449 :endfor | |
| 450 | |
| 451 The List of keys is unsorted. You may want to sort them first: > | |
| 452 :for key in sort(keys(mydict)) | |
| 453 | |
| 454 To loop over the values use the |values()| function: > | |
| 455 :for v in values(mydict) | |
| 456 : echo "value: " . v | |
| 457 :endfor | |
| 458 | |
| 459 If you want both the key and the value use the |items()| function. It returns | |
| 1621 | 460 a List in which each item is a List with two items, the key and the value: > |
| 1156 | 461 :for [key, value] in items(mydict) |
| 462 : echo key . ': ' . value | |
| 99 | 463 :endfor |
| 464 | |
| 465 | |
| 466 Dictionary identity ~ | |
| 161 | 467 *dict-identity* |
| 99 | 468 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a |
| 469 Dictionary. Otherwise, assignment results in referring to the same | |
| 470 Dictionary: > | |
| 471 :let onedict = {'a': 1, 'b': 2} | |
| 472 :let adict = onedict | |
| 473 :let adict['a'] = 11 | |
| 474 :echo onedict['a'] | |
| 475 11 | |
| 476 | |
| 327 | 477 Two Dictionaries compare equal if all the key-value pairs compare equal. For |
| 478 more info see |list-identity|. | |
| 99 | 479 |
| 480 | |
| 481 Dictionary modification ~ | |
| 482 *dict-modification* | |
| 483 To change an already existing entry of a Dictionary, or to add a new entry, | |
| 484 use |:let| this way: > | |
| 485 :let dict[4] = "four" | |
| 486 :let dict['one'] = item | |
| 487 | |
| 108 | 488 Removing an entry from a Dictionary is done with |remove()| or |:unlet|. |
| 489 Three ways to remove the entry with key "aaa" from dict: > | |
| 490 :let i = remove(dict, 'aaa') | |
| 491 :unlet dict.aaa | |
| 492 :unlet dict['aaa'] | |
| 99 | 493 |
| 494 Merging a Dictionary with another is done with |extend()|: > | |
| 114 | 495 :call extend(adict, bdict) |
| 496 This extends adict with all entries from bdict. Duplicate keys cause entries | |
| 497 in adict to be overwritten. An optional third argument can change this. | |
| 119 | 498 Note that the order of entries in a Dictionary is irrelevant, thus don't |
| 499 expect ":echo adict" to show the items from bdict after the older entries in | |
| 500 adict. | |
| 99 | 501 |
| 502 Weeding out entries from a Dictionary can be done with |filter()|: > | |
| 1156 | 503 :call filter(dict, 'v:val =~ "x"') |
| 114 | 504 This removes all entries from "dict" with a value not matching 'x'. |
| 102 | 505 |
| 506 | |
| 507 Dictionary function ~ | |
| 4159 | 508 *Dictionary-function* *self* *E725* *E862* |
| 102 | 509 When a function is defined with the "dict" attribute it can be used in a |
| 1621 | 510 special way with a dictionary. Example: > |
| 102 | 511 :function Mylen() dict |
| 114 | 512 : return len(self.data) |
| 102 | 513 :endfunction |
| 114 | 514 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")} |
| 515 :echo mydict.len() | |
| 102 | 516 |
| 517 This is like a method in object oriented programming. The entry in the | |
| 518 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary | |
| 519 the function was invoked from. | |
| 520 | |
| 114 | 521 It is also possible to add a function without the "dict" attribute as a |
| 522 Funcref to a Dictionary, but the "self" variable is not available then. | |
| 523 | |
| 819 | 524 *numbered-function* *anonymous-function* |
| 102 | 525 To avoid the extra name for the function it can be defined and directly |
| 526 assigned to a Dictionary in this way: > | |
| 114 | 527 :let mydict = {'data': [0, 1, 2, 3]} |
| 6741 | 528 :function mydict.len() |
| 114 | 529 : return len(self.data) |
| 102 | 530 :endfunction |
| 114 | 531 :echo mydict.len() |
| 532 | |
| 533 The function will then get a number and the value of dict.len is a |Funcref| | |
| 1621 | 534 that references this function. The function can only be used through a |
| 114 | 535 |Funcref|. It will automatically be deleted when there is no |Funcref| |
| 536 remaining that refers to it. | |
| 537 | |
| 538 It is not necessary to use the "dict" attribute for a numbered function. | |
| 102 | 539 |
|
2488
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
540 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
|
541 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
|
542 :function {42} |
|
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
543 |
| 102 | 544 |
| 545 Functions for Dictionaries ~ | |
| 114 | 546 *E715* |
| 547 Functions that can be used with a Dictionary: > | |
| 102 | 548 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo" |
| 549 :if empty(dict) " TRUE if dict is empty | |
| 550 :let l = len(dict) " number of items in dict | |
| 551 :let big = max(dict) " maximum value in dict | |
| 552 :let small = min(dict) " minimum value in dict | |
| 553 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict | |
| 554 :let s = string(dict) " String representation of dict | |
| 555 :call map(dict, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 556 |
| 557 | |
| 558 1.5 More about variables ~ | |
| 85 | 559 *more-variables* |
| 7 | 560 If you need to know the type of a variable or expression, use the |type()| |
| 561 function. | |
| 562 | |
| 563 When the '!' flag is included in the 'viminfo' option, global variables that | |
| 564 start with an uppercase letter, and don't contain a lowercase letter, are | |
| 565 stored in the viminfo file |viminfo-file|. | |
| 566 | |
| 567 When the 'sessionoptions' option contains "global", global variables that | |
| 568 start with an uppercase letter and contain at least one lowercase letter are | |
| 569 stored in the session file |session-file|. | |
| 570 | |
| 571 variable name can be stored where ~ | |
| 572 my_var_6 not | |
| 573 My_Var_6 session file | |
| 574 MY_VAR_6 viminfo file | |
| 575 | |
| 576 | |
| 577 It's possible to form a variable name with curly braces, see | |
| 578 |curly-braces-names|. | |
| 579 | |
| 580 ============================================================================== | |
| 581 2. Expression syntax *expression-syntax* | |
| 582 | |
| 583 Expression syntax summary, from least to most significant: | |
| 584 | |
| 585 |expr1| expr2 ? expr1 : expr1 if-then-else | |
| 586 | |
| 587 |expr2| expr3 || expr3 .. logical OR | |
| 588 | |
| 589 |expr3| expr4 && expr4 .. logical AND | |
| 590 | |
| 591 |expr4| expr5 == expr5 equal | |
| 592 expr5 != expr5 not equal | |
| 593 expr5 > expr5 greater than | |
| 594 expr5 >= expr5 greater than or equal | |
| 595 expr5 < expr5 smaller than | |
| 596 expr5 <= expr5 smaller than or equal | |
| 597 expr5 =~ expr5 regexp matches | |
| 598 expr5 !~ expr5 regexp doesn't match | |
| 599 | |
| 600 expr5 ==? expr5 equal, ignoring case | |
| 601 expr5 ==# expr5 equal, match case | |
| 602 etc. As above, append ? for ignoring case, # for | |
| 603 matching case | |
| 604 | |
| 685 | 605 expr5 is expr5 same |List| instance |
| 606 expr5 isnot expr5 different |List| instance | |
| 79 | 607 |
| 608 |expr5| expr6 + expr6 .. number addition or list concatenation | |
| 7 | 609 expr6 - expr6 .. number subtraction |
| 610 expr6 . expr6 .. string concatenation | |
| 611 | |
| 612 |expr6| expr7 * expr7 .. number multiplication | |
| 613 expr7 / expr7 .. number division | |
| 614 expr7 % expr7 .. number modulo | |
| 615 | |
| 616 |expr7| ! expr7 logical NOT | |
| 617 - expr7 unary minus | |
| 618 + expr7 unary plus | |
| 102 | 619 |
| 685 | 620 |expr8| expr8[expr1] byte of a String or item of a |List| |
| 621 expr8[expr1 : expr1] substring of a String or sublist of a |List| | |
| 622 expr8.name entry in a |Dictionary| | |
| 623 expr8(expr1, ...) function call with |Funcref| variable | |
| 102 | 624 |
| 625 |expr9| number number constant | |
| 26 | 626 "string" string constant, backslash is special |
| 99 | 627 'string' string constant, ' is doubled |
| 685 | 628 [expr1, ...] |List| |
| 629 {expr1: expr1, ...} |Dictionary| | |
| 7 | 630 &option option value |
| 631 (expr1) nested expression | |
| 632 variable internal variable | |
| 633 va{ria}ble internal variable with curly braces | |
| 634 $VAR environment variable | |
| 635 @r contents of register 'r' | |
| 636 function(expr1, ...) function call | |
| 637 func{ti}on(expr1, ...) function call with curly braces | |
| 638 | |
| 639 | |
| 640 ".." indicates that the operations in this level can be concatenated. | |
| 641 Example: > | |
| 642 &nu || &list && &shell == "csh" | |
| 643 | |
| 644 All expressions within one level are parsed from left to right. | |
| 645 | |
| 646 | |
| 647 expr1 *expr1* *E109* | |
| 648 ----- | |
| 649 | |
| 650 expr2 ? expr1 : expr1 | |
| 651 | |
| 652 The expression before the '?' is evaluated to a number. If it evaluates to | |
| 653 non-zero, the result is the value of the expression between the '?' and ':', | |
| 654 otherwise the result is the value of the expression after the ':'. | |
| 655 Example: > | |
| 656 :echo lnum == 1 ? "top" : lnum | |
| 657 | |
| 658 Since the first expression is an "expr2", it cannot contain another ?:. The | |
| 659 other two expressions can, thus allow for recursive use of ?:. | |
| 660 Example: > | |
| 661 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum | |
| 662 | |
| 663 To keep this readable, using |line-continuation| is suggested: > | |
| 664 :echo lnum == 1 | |
| 665 :\ ? "top" | |
| 666 :\ : lnum == 1000 | |
| 667 :\ ? "last" | |
| 668 :\ : lnum | |
| 669 | |
| 1156 | 670 You should always put a space before the ':', otherwise it can be mistaken for |
| 671 use in a variable such as "a:1". | |
| 672 | |
| 7 | 673 |
| 674 expr2 and expr3 *expr2* *expr3* | |
| 675 --------------- | |
| 676 | |
| 677 *expr-barbar* *expr-&&* | |
| 678 The "||" and "&&" operators take one argument on each side. The arguments | |
| 679 are (converted to) Numbers. The result is: | |
| 680 | |
| 681 input output ~ | |
| 682 n1 n2 n1 || n2 n1 && n2 ~ | |
| 683 zero zero zero zero | |
| 684 zero non-zero non-zero zero | |
| 685 non-zero zero non-zero zero | |
| 686 non-zero non-zero non-zero non-zero | |
| 687 | |
| 688 The operators can be concatenated, for example: > | |
| 689 | |
| 690 &nu || &list && &shell == "csh" | |
| 691 | |
| 692 Note that "&&" takes precedence over "||", so this has the meaning of: > | |
| 693 | |
| 694 &nu || (&list && &shell == "csh") | |
| 695 | |
| 696 Once the result is known, the expression "short-circuits", that is, further | |
| 697 arguments are not evaluated. This is like what happens in C. For example: > | |
| 698 | |
| 699 let a = 1 | |
| 700 echo a || b | |
| 701 | |
| 702 This is valid even if there is no variable called "b" because "a" is non-zero, | |
| 703 so the result must be non-zero. Similarly below: > | |
| 704 | |
| 705 echo exists("b") && b == "yes" | |
| 706 | |
| 707 This is valid whether "b" has been defined or not. The second clause will | |
| 708 only be evaluated if "b" has been defined. | |
| 709 | |
| 710 | |
| 711 expr4 *expr4* | |
| 712 ----- | |
| 713 | |
| 714 expr5 {cmp} expr5 | |
| 715 | |
| 716 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1 | |
| 717 if it evaluates to true. | |
| 718 | |
| 1621 | 719 *expr-==* *expr-!=* *expr->* *expr->=* |
| 7 | 720 *expr-<* *expr-<=* *expr-=~* *expr-!~* |
| 721 *expr-==#* *expr-!=#* *expr->#* *expr->=#* | |
| 722 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#* | |
| 723 *expr-==?* *expr-!=?* *expr->?* *expr->=?* | |
| 724 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?* | |
| 2908 | 725 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#* |
| 726 *expr-is?* *expr-isnot?* | |
| 7 | 727 use 'ignorecase' match case ignore case ~ |
| 728 equal == ==# ==? | |
| 729 not equal != !=# !=? | |
| 730 greater than > ># >? | |
| 731 greater than or equal >= >=# >=? | |
| 732 smaller than < <# <? | |
| 733 smaller than or equal <= <=# <=? | |
| 734 regexp matches =~ =~# =~? | |
| 735 regexp doesn't match !~ !~# !~? | |
| 2908 | 736 same instance is is# is? |
| 737 different instance isnot isnot# isnot? | |
| 7 | 738 |
| 739 Examples: | |
| 740 "abc" ==# "Abc" evaluates to 0 | |
| 741 "abc" ==? "Abc" evaluates to 1 | |
| 742 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise | |
| 743 | |
| 85 | 744 *E691* *E692* |
| 685 | 745 A |List| can only be compared with a |List| and only "equal", "not equal" and |
| 746 "is" can be used. This compares the values of the list, recursively. | |
| 747 Ignoring case means case is ignored when comparing item values. | |
| 79 | 748 |
| 114 | 749 *E735* *E736* |
| 685 | 750 A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not |
| 751 equal" and "is" can be used. This compares the key/values of the |Dictionary| | |
| 114 | 752 recursively. Ignoring case means case is ignored when comparing item values. |
| 753 | |
| 85 | 754 *E693* *E694* |
| 685 | 755 A |Funcref| can only be compared with a |Funcref| and only "equal" and "not |
| 756 equal" can be used. Case is never ignored. | |
| 757 | |
| 2908 | 758 When using "is" or "isnot" with a |List| or a |Dictionary| this checks if the |
| 759 expressions are referring to the same |List| or |Dictionary| instance. A copy | |
| 760 of a |List| is different from the original |List|. When using "is" without | |
| 761 a |List| or a |Dictionary| it is equivalent to using "equal", using "isnot" | |
| 762 equivalent to using "not equal". Except that a different type means the | |
| 763 values are different: "4 == '4'" is true, "4 is '4'" is false and "0 is []" is | |
| 3830 | 764 false and not an error. "is#"/"isnot#" and "is?"/"isnot?" can be used to match |
| 2908 | 765 and ignore case. |
| 79 | 766 |
| 7 | 767 When comparing a String with a Number, the String is converted to a Number, |
| 1621 | 768 and the comparison is done on Numbers. This means that "0 == 'x'" is TRUE, |
| 7 | 769 because 'x' converted to a Number is zero. |
| 770 | |
| 771 When comparing two Strings, this is done with strcmp() or stricmp(). This | |
| 772 results in the mathematical difference (comparing byte values), not | |
| 773 necessarily the alphabetical difference in the local language. | |
| 774 | |
| 1621 | 775 When using the operators with a trailing '#', or the short version and |
| 1156 | 776 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
| 7 | 777 |
| 778 When using the operators with a trailing '?', or the short version and | |
| 1156 | 779 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
| 780 | |
| 781 'smartcase' is not used. | |
| 7 | 782 |
| 783 The "=~" and "!~" operators match the lefthand argument with the righthand | |
| 784 argument, which is used as a pattern. See |pattern| for what a pattern is. | |
| 785 This matching is always done like 'magic' was set and 'cpoptions' is empty, no | |
| 786 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts | |
| 787 portable. To avoid backslashes in the regexp pattern to be doubled, use a | |
| 788 single-quote string, see |literal-string|. | |
| 789 Since a string is considered to be a single line, a multi-line pattern | |
| 790 (containing \n, backslash-n) will not match. However, a literal NL character | |
| 791 can be matched like an ordinary character. Examples: | |
| 792 "foo\nbar" =~ "\n" evaluates to 1 | |
| 793 "foo\nbar" =~ "\\n" evaluates to 0 | |
| 794 | |
| 795 | |
| 796 expr5 and expr6 *expr5* *expr6* | |
| 797 --------------- | |
| 685 | 798 expr6 + expr6 .. Number addition or |List| concatenation *expr-+* |
| 79 | 799 expr6 - expr6 .. Number subtraction *expr--* |
| 800 expr6 . expr6 .. String concatenation *expr-.* | |
| 801 | |
| 692 | 802 For |Lists| only "+" is possible and then both expr6 must be a list. The |
| 685 | 803 result is a new list with the two lists Concatenated. |
| 79 | 804 |
| 3214 | 805 expr7 * expr7 .. Number multiplication *expr-star* |
| 806 expr7 / expr7 .. Number division *expr-/* | |
| 807 expr7 % expr7 .. Number modulo *expr-%* | |
| 7 | 808 |
| 809 For all, except ".", Strings are converted to Numbers. | |
| 3214 | 810 For bitwise operators see |and()|, |or()| and |xor()|. |
| 7 | 811 |
| 812 Note the difference between "+" and ".": | |
| 813 "123" + "456" = 579 | |
| 814 "123" . "456" = "123456" | |
| 815 | |
| 1621 | 816 Since '.' has the same precedence as '+' and '-', you need to read: > |
| 817 1 . 90 + 90.0 | |
| 818 As: > | |
| 819 (1 . 90) + 90.0 | |
| 820 That works, since the String "190" is automatically converted to the Number | |
| 821 190, which can be added to the Float 90.0. However: > | |
| 822 1 . 90 * 90.0 | |
| 823 Should be read as: > | |
| 824 1 . (90 * 90.0) | |
| 825 Since '.' has lower precedence than '*'. This does NOT work, since this | |
| 826 attempts to concatenate a Float and a String. | |
| 827 | |
| 828 When dividing a Number by zero the result depends on the value: | |
| 829 0 / 0 = -0x80000000 (like NaN for Float) | |
| 830 >0 / 0 = 0x7fffffff (like positive infinity) | |
| 831 <0 / 0 = -0x7fffffff (like negative infinity) | |
| 832 (before Vim 7.2 it was always 0x7fffffff) | |
| 833 | |
| 7 | 834 When the righthand side of '%' is zero, the result is 0. |
| 835 | |
| 685 | 836 None of these work for |Funcref|s. |
| 79 | 837 |
| 1621 | 838 . and % do not work for Float. *E804* |
| 839 | |
| 7 | 840 |
| 841 expr7 *expr7* | |
| 842 ----- | |
| 843 ! expr7 logical NOT *expr-!* | |
| 844 - expr7 unary minus *expr-unary--* | |
| 845 + expr7 unary plus *expr-unary-+* | |
| 846 | |
| 847 For '!' non-zero becomes zero, zero becomes one. | |
| 848 For '-' the sign of the number is changed. | |
| 849 For '+' the number is unchanged. | |
| 850 | |
| 851 A String will be converted to a Number first. | |
| 852 | |
| 1621 | 853 These three can be repeated and mixed. Examples: |
| 7 | 854 !-1 == 0 |
| 855 !!8 == 1 | |
| 856 --9 == 9 | |
| 857 | |
| 858 | |
| 859 expr8 *expr8* | |
| 860 ----- | |
| 685 | 861 expr8[expr1] item of String or |List| *expr-[]* *E111* |
| 102 | 862 |
| 863 If expr8 is a Number or String this results in a String that contains the | |
| 864 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
|
865 Number. This doesn't recognize multi-byte encodings, see |byteidx()| for |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
866 an alternative. |
| 55 | 867 |
| 868 Index zero gives the first character. This is like it works in C. Careful: | |
| 869 text column numbers start with one! Example, to get the character under the | |
| 870 cursor: > | |
| 823 | 871 :let c = getline(".")[col(".") - 1] |
| 7 | 872 |
| 873 If the length of the String is less than the index, the result is an empty | |
| 55 | 874 String. A negative index always results in an empty string (reason: backwards |
| 875 compatibility). Use [-1:] to get the last byte. | |
| 876 | |
| 685 | 877 If expr8 is a |List| then it results the item at index expr1. See |list-index| |
| 55 | 878 for possible index values. If the index is out of range this results in an |
| 1621 | 879 error. Example: > |
| 55 | 880 :let item = mylist[-1] " get last item |
| 881 | |
| 685 | 882 Generally, if a |List| index is equal to or higher than the length of the |
| 883 |List|, or more negative than the length of the |List|, this results in an | |
| 884 error. | |
| 55 | 885 |
| 99 | 886 |
| 102 | 887 expr8[expr1a : expr1b] substring or sublist *expr-[:]* |
| 888 | |
| 889 If expr8 is a Number or String this results in the substring with the bytes | |
| 890 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
|
891 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
|
892 |byteidx()| for computing the indexes. |
| 55 | 893 |
| 894 If expr1a is omitted zero is used. If expr1b is omitted the length of the | |
| 895 string minus one is used. | |
| 896 | |
| 897 A negative number can be used to measure from the end of the string. -1 is | |
| 898 the last character, -2 the last but one, etc. | |
| 899 | |
| 900 If an index goes out of range for the string characters are omitted. If | |
| 901 expr1b is smaller than expr1a the result is an empty string. | |
| 902 | |
| 903 Examples: > | |
| 904 :let c = name[-1:] " last byte of a string | |
| 905 :let c = name[-2:-2] " last but one byte of a string | |
| 906 :let s = line(".")[4:] " from the fifth byte to the end | |
| 907 :let s = s[:-3] " remove last two bytes | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
908 < |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
909 *sublist* *slice* |
| 685 | 910 If expr8 is a |List| this results in a new |List| with the items indicated by |
| 1621 | 911 the indexes expr1a and expr1b. This works like with a String, as explained |
| 685 | 912 just above, except that indexes out of range cause an error. Examples: > |
| 55 | 913 :let l = mylist[:3] " first four items |
| 914 :let l = mylist[4:4] " List with one item | |
| 915 :let l = mylist[:] " shallow copy of a List | |
| 916 | |
| 685 | 917 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an |
| 918 error. | |
| 919 | |
| 920 | |
| 921 expr8.name entry in a |Dictionary| *expr-entry* | |
| 922 | |
| 923 If expr8 is a |Dictionary| and it is followed by a dot, then the following | |
| 924 name will be used as a key in the |Dictionary|. This is just like: | |
| 925 expr8[name]. | |
| 99 | 926 |
| 927 The name must consist of alphanumeric characters, just like a variable name, | |
| 928 but it may start with a number. Curly braces cannot be used. | |
| 929 | |
| 930 There must not be white space before or after the dot. | |
| 931 | |
| 932 Examples: > | |
| 933 :let dict = {"one": 1, 2: "two"} | |
| 934 :echo dict.one | |
| 935 :echo dict .2 | |
| 936 | |
| 937 Note that the dot is also used for String concatenation. To avoid confusion | |
| 938 always put spaces around the dot for String concatenation. | |
| 939 | |
| 940 | |
| 685 | 941 expr8(expr1, ...) |Funcref| function call |
| 102 | 942 |
| 943 When expr8 is a |Funcref| type variable, invoke the function it refers to. | |
| 944 | |
| 945 | |
| 946 | |
| 947 *expr9* | |
| 7 | 948 number |
| 949 ------ | |
| 3224 | 950 number number constant *expr-number* |
| 951 *hex-number* *octal-number* | |
| 7 | 952 |
| 953 Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0). | |
| 954 | |
| 1621 | 955 *floating-point-format* |
| 956 Floating point numbers can be written in two forms: | |
| 957 | |
| 958 [-+]{N}.{M} | |
| 6530 | 959 [-+]{N}.{M}[eE][-+]{exp} |
| 1621 | 960 |
| 961 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
| 962 contain digits. | |
| 963 [-+] means there is an optional plus or minus sign. | |
| 964 {exp} is the exponent, power of 10. | |
| 965 Only a decimal point is accepted, not a comma. No matter what the current | |
| 966 locale is. | |
| 967 {only when compiled with the |+float| feature} | |
| 968 | |
| 969 Examples: | |
| 970 123.456 | |
| 971 +0.0001 | |
| 972 55.0 | |
| 973 -0.123 | |
| 974 1.234e03 | |
| 975 1.0E-6 | |
| 976 -3.1416e+88 | |
| 977 | |
| 978 These are INVALID: | |
| 979 3. empty {M} | |
| 980 1e40 missing .{M} | |
| 981 | |
| 1698 | 982 *float-pi* *float-e* |
| 983 A few useful values to copy&paste: > | |
| 984 :let pi = 3.14159265359 | |
| 985 :let e = 2.71828182846 | |
| 986 | |
| 1621 | 987 Rationale: |
| 988 Before floating point was introduced, the text "123.456" was interpreted as | |
| 989 the two numbers "123" and "456", both converted to a string and concatenated, | |
| 990 resulting in the string "123456". Since this was considered pointless, and we | |
| 1698 | 991 could not find it intentionally being used in Vim scripts, this backwards |
| 1621 | 992 incompatibility was accepted in favor of being able to use the normal notation |
| 993 for floating point numbers. | |
| 994 | |
| 995 *floating-point-precision* | |
| 996 The precision and range of floating points numbers depends on what "double" | |
| 997 means in the library Vim was compiled with. There is no way to change this at | |
| 998 runtime. | |
| 999 | |
| 1000 The default for displaying a |Float| is to use 6 decimal places, like using | |
| 1001 printf("%g", f). You can select something else when using the |printf()| | |
| 1002 function. Example: > | |
| 1003 :echo printf('%.15e', atan(1)) | |
| 1004 < 7.853981633974483e-01 | |
| 1005 | |
| 1006 | |
| 7 | 1007 |
| 6884 | 1008 string *string* *String* *expr-string* *E114* |
| 7 | 1009 ------ |
| 1010 "string" string constant *expr-quote* | |
| 1011 | |
| 1012 Note that double quotes are used. | |
| 1013 | |
| 1014 A string constant accepts these special characters: | |
| 1015 \... three-digit octal number (e.g., "\316") | |
| 1016 \.. two-digit octal number (must be followed by non-digit) | |
| 1017 \. one-digit octal number (must be followed by non-digit) | |
| 1018 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
| 1019 \x. byte specified with one hex number (must be followed by non-hex char) | |
| 1020 \X.. same as \x.. | |
| 1021 \X. same as \x. | |
| 1621 | 1022 \u.... character specified with up to 4 hex numbers, stored according to the |
| 7 | 1023 current value of 'encoding' (e.g., "\u02a4") |
| 6840 | 1024 \U.... same as \u but allows up to 8 hex numbers. |
| 7 | 1025 \b backspace <BS> |
| 1026 \e escape <Esc> | |
| 1027 \f formfeed <FF> | |
| 1028 \n newline <NL> | |
| 1029 \r return <CR> | |
| 1030 \t tab <Tab> | |
| 1031 \\ backslash | |
| 1032 \" double quote | |
| 2152 | 1033 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use |
| 1034 in mappings, the 0x80 byte is escaped. Don't use <Char-xxxx> to get a | |
| 1035 utf-8 character, use \uxxxx as mentioned above. | |
| 7 | 1036 |
| 1156 | 1037 Note that "\xff" is stored as the byte 255, which may be invalid in some |
| 1038 encodings. Use "\u00ff" to store character 255 according to the current value | |
| 1039 of 'encoding'. | |
| 1040 | |
| 7 | 1041 Note that "\000" and "\x00" force the end of the string. |
| 1042 | |
| 1043 | |
| 1044 literal-string *literal-string* *E115* | |
| 1045 --------------- | |
| 26 | 1046 'string' string constant *expr-'* |
| 7 | 1047 |
| 1048 Note that single quotes are used. | |
| 1049 | |
| 1621 | 1050 This string is taken as it is. No backslashes are removed or have a special |
| 99 | 1051 meaning. The only exception is that two quotes stand for one quote. |
| 26 | 1052 |
| 1053 Single quoted strings are useful for patterns, so that backslashes do not need | |
| 1621 | 1054 to be doubled. These two commands are equivalent: > |
| 26 | 1055 if a =~ "\\s*" |
| 1056 if a =~ '\s*' | |
| 7 | 1057 |
| 1058 | |
| 1059 option *expr-option* *E112* *E113* | |
| 1060 ------ | |
| 1061 &option option value, local value if possible | |
| 1062 &g:option global option value | |
| 1063 &l:option local option value | |
| 1064 | |
| 1065 Examples: > | |
| 1066 echo "tabstop is " . &tabstop | |
| 1067 if &insertmode | |
| 1068 | |
| 1069 Any option name can be used here. See |options|. When using the local value | |
| 1070 and there is no buffer-local or window-local value, the global value is used | |
| 1071 anyway. | |
| 1072 | |
| 1073 | |
| 1156 | 1074 register *expr-register* *@r* |
| 7 | 1075 -------- |
| 1076 @r contents of register 'r' | |
| 1077 | |
| 1078 The result is the contents of the named register, as a single string. | |
| 1079 Newlines are inserted where required. To get the contents of the unnamed | |
| 1621 | 1080 register use @" or @@. See |registers| for an explanation of the available |
| 336 | 1081 registers. |
| 1082 | |
| 1083 When using the '=' register you get the expression itself, not what it | |
| 1084 evaluates to. Use |eval()| to evaluate it. | |
| 7 | 1085 |
| 1086 | |
| 1087 nesting *expr-nesting* *E110* | |
| 1088 ------- | |
| 1089 (expr1) nested expression | |
| 1090 | |
| 1091 | |
| 1092 environment variable *expr-env* | |
| 1093 -------------------- | |
| 1094 $VAR environment variable | |
| 1095 | |
| 1096 The String value of any environment variable. When it is not defined, the | |
| 1097 result is an empty string. | |
| 1098 *expr-env-expand* | |
| 1099 Note that there is a difference between using $VAR directly and using | |
| 1100 expand("$VAR"). Using it directly will only expand environment variables that | |
| 1101 are known inside the current Vim session. Using expand() will first try using | |
| 1102 the environment variables known inside the current Vim session. If that | |
| 1103 fails, a shell will be used to expand the variable. This can be slow, but it | |
| 1104 does expand all variables that the shell knows about. Example: > | |
| 6180 | 1105 :echo $shell |
| 1106 :echo expand("$shell") | |
| 1107 The first one probably doesn't echo anything, the second echoes the $shell | |
| 7 | 1108 variable (if your shell supports it). |
| 1109 | |
| 1110 | |
| 1111 internal variable *expr-variable* | |
| 1112 ----------------- | |
| 1113 variable internal variable | |
| 1114 See below |internal-variables|. | |
| 1115 | |
| 1116 | |
| 170 | 1117 function call *expr-function* *E116* *E118* *E119* *E120* |
| 7 | 1118 ------------- |
| 1119 function(expr1, ...) function call | |
| 1120 See below |functions|. | |
| 1121 | |
| 1122 | |
| 1123 ============================================================================== | |
| 2596 | 1124 3. Internal variable *internal-variables* *E461* |
| 1125 | |
| 7 | 1126 An internal variable name can be made up of letters, digits and '_'. But it |
| 1127 cannot start with a digit. It's also possible to use curly braces, see | |
| 1128 |curly-braces-names|. | |
| 1129 | |
| 1130 An internal variable is created with the ":let" command |:let|. | |
| 87 | 1131 An internal variable is explicitly destroyed with the ":unlet" command |
| 1132 |:unlet|. | |
| 1133 Using a name that is not an internal variable or refers to a variable that has | |
| 1134 been destroyed results in an error. | |
| 7 | 1135 |
| 1136 There are several name spaces for variables. Which one is to be used is | |
| 1137 specified by what is prepended: | |
| 1138 | |
| 1139 (nothing) In a function: local to a function; otherwise: global | |
| 1140 |buffer-variable| b: Local to the current buffer. | |
| 1141 |window-variable| w: Local to the current window. | |
| 819 | 1142 |tabpage-variable| t: Local to the current tab page. |
| 7 | 1143 |global-variable| g: Global. |
| 1144 |local-variable| l: Local to a function. | |
| 1145 |script-variable| s: Local to a |:source|'ed Vim script. | |
| 1146 |function-argument| a: Function argument (only inside a function). | |
| 5815 | 1147 |vim-variable| v: Global, predefined by Vim. |
| 7 | 1148 |
| 685 | 1149 The scope name by itself can be used as a |Dictionary|. For example, to |
| 1150 delete all script-local variables: > | |
| 133 | 1151 :for k in keys(s:) |
| 1152 : unlet s:[k] | |
| 1153 :endfor | |
| 1154 < | |
| 4358 | 1155 *buffer-variable* *b:var* *b:* |
| 7 | 1156 A variable name that is preceded with "b:" is local to the current buffer. |
| 1157 Thus you can have several "b:foo" variables, one for each buffer. | |
| 1158 This kind of variable is deleted when the buffer is wiped out or deleted with | |
| 1159 |:bdelete|. | |
| 1160 | |
| 1161 One local buffer variable is predefined: | |
| 4264 | 1162 *b:changedtick* *changetick* |
| 7 | 1163 b:changedtick The total number of changes to the current buffer. It is |
| 1164 incremented for each change. An undo command is also a change | |
| 1165 in this case. This can be used to perform an action only when | |
| 1166 the buffer has changed. Example: > | |
| 1167 :if my_changedtick != b:changedtick | |
| 1621 | 1168 : let my_changedtick = b:changedtick |
| 1169 : call My_Update() | |
| 7 | 1170 :endif |
| 1171 < | |
| 4358 | 1172 *window-variable* *w:var* *w:* |
| 7 | 1173 A variable name that is preceded with "w:" is local to the current window. It |
| 1174 is deleted when the window is closed. | |
| 1175 | |
| 4437 | 1176 *tabpage-variable* *t:var* *t:* |
| 819 | 1177 A variable name that is preceded with "t:" is local to the current tab page, |
| 1178 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
|
1179 without the |+windows| feature} |
| 819 | 1180 |
| 4358 | 1181 *global-variable* *g:var* *g:* |
| 7 | 1182 Inside functions global variables are accessed with "g:". Omitting this will |
| 1621 | 1183 access a variable local to a function. But "g:" can also be used in any other |
| 7 | 1184 place if you like. |
| 1185 | |
| 4358 | 1186 *local-variable* *l:var* *l:* |
| 7 | 1187 Inside functions local variables are accessed without prepending anything. |
| 1156 | 1188 But you can also prepend "l:" if you like. However, without prepending "l:" |
| 1189 you may run into reserved variable names. For example "count". By itself it | |
| 1190 refers to "v:count". Using "l:count" you can have a local variable with the | |
| 1191 same name. | |
| 7 | 1192 |
| 1193 *script-variable* *s:var* | |
| 1194 In a Vim script variables starting with "s:" can be used. They cannot be | |
| 1195 accessed from outside of the scripts, thus are local to the script. | |
| 1196 | |
| 1197 They can be used in: | |
| 1198 - commands executed while the script is sourced | |
| 1199 - functions defined in the script | |
| 1200 - autocommands defined in the script | |
| 1201 - functions and autocommands defined in functions and autocommands which were | |
| 1202 defined in the script (recursively) | |
| 1203 - user defined commands defined in the script | |
| 1204 Thus not in: | |
| 1205 - other scripts sourced from this one | |
| 1206 - mappings | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1207 - menus |
| 7 | 1208 - etc. |
| 1209 | |
| 1156 | 1210 Script variables can be used to avoid conflicts with global variable names. |
| 1211 Take this example: > | |
| 7 | 1212 |
| 1213 let s:counter = 0 | |
| 1214 function MyCounter() | |
| 1215 let s:counter = s:counter + 1 | |
| 1216 echo s:counter | |
| 1217 endfunction | |
| 1218 command Tick call MyCounter() | |
| 1219 | |
| 1220 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
| 1221 that script will not be changed, only the "s:counter" in the script where | |
| 1222 "Tick" was defined is used. | |
| 1223 | |
| 1224 Another example that does the same: > | |
| 1225 | |
| 1226 let s:counter = 0 | |
| 1227 command Tick let s:counter = s:counter + 1 | echo s:counter | |
| 1228 | |
| 1229 When calling a function and invoking a user-defined command, the context for | |
| 9 | 1230 script variables is set to the script where the function or command was |
| 7 | 1231 defined. |
| 1232 | |
| 1233 The script variables are also available when a function is defined inside a | |
| 1234 function that is defined in a script. Example: > | |
| 1235 | |
| 1236 let s:counter = 0 | |
| 1237 function StartCounting(incr) | |
| 1238 if a:incr | |
| 1239 function MyCounter() | |
| 1240 let s:counter = s:counter + 1 | |
| 1241 endfunction | |
| 1242 else | |
| 1243 function MyCounter() | |
| 1244 let s:counter = s:counter - 1 | |
| 1245 endfunction | |
| 1246 endif | |
| 1247 endfunction | |
| 1248 | |
| 1249 This defines the MyCounter() function either for counting up or counting down | |
| 1250 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
| 1251 called, the s:counter variable will be accessible in MyCounter(). | |
| 1252 | |
| 1253 When the same script is sourced again it will use the same script variables. | |
| 1254 They will remain valid as long as Vim is running. This can be used to | |
| 1255 maintain a counter: > | |
| 1256 | |
| 1257 if !exists("s:counter") | |
| 1258 let s:counter = 1 | |
| 1259 echo "script executed for the first time" | |
| 1260 else | |
| 1261 let s:counter = s:counter + 1 | |
| 1262 echo "script executed " . s:counter . " times now" | |
| 1263 endif | |
| 1264 | |
| 1265 Note that this means that filetype plugins don't get a different set of script | |
| 1266 variables for each buffer. Use local buffer variables instead |b:var|. | |
| 1267 | |
| 1268 | |
| 4358 | 1269 Predefined Vim variables: *vim-variable* *v:var* *v:* |
| 7 | 1270 |
| 189 | 1271 *v:beval_col* *beval_col-variable* |
| 1272 v:beval_col The number of the column, over which the mouse pointer is. | |
| 1273 This is the byte index in the |v:beval_lnum| line. | |
| 1274 Only valid while evaluating the 'balloonexpr' option. | |
| 1275 | |
| 1276 *v:beval_bufnr* *beval_bufnr-variable* | |
| 1277 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
| 1278 valid while evaluating the 'balloonexpr' option. | |
| 1279 | |
| 1280 *v:beval_lnum* *beval_lnum-variable* | |
| 1281 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
| 1282 valid while evaluating the 'balloonexpr' option. | |
| 1283 | |
| 1284 *v:beval_text* *beval_text-variable* | |
| 374 | 1285 v:beval_text The text under or after the mouse pointer. Usually a word as |
| 1286 it is useful for debugging a C program. 'iskeyword' applies, | |
| 1287 but a dot and "->" before the position is included. When on a | |
| 1288 ']' the text before it is used, including the matching '[' and | |
| 189 | 1289 word before it. When on a Visual area within one line the |
| 1290 highlighted text is used. | |
| 1291 Only valid while evaluating the 'balloonexpr' option. | |
| 1292 | |
| 1293 *v:beval_winnr* *beval_winnr-variable* | |
| 1294 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
| 2709 | 1295 valid while evaluating the 'balloonexpr' option. The first |
| 1296 window has number zero (unlike most other places where a | |
| 1297 window gets a number). | |
| 189 | 1298 |
| 844 | 1299 *v:char* *char-variable* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1300 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
|
1301 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
|
1302 It is also used by the |InsertCharPre| and |InsertEnter| events. |
| 844 | 1303 |
| 7 | 1304 *v:charconvert_from* *charconvert_from-variable* |
| 1305 v:charconvert_from | |
| 1306 The name of the character encoding of a file to be converted. | |
| 1307 Only valid while evaluating the 'charconvert' option. | |
| 1308 | |
| 1309 *v:charconvert_to* *charconvert_to-variable* | |
| 1310 v:charconvert_to | |
| 1311 The name of the character encoding of a file after conversion. | |
| 1312 Only valid while evaluating the 'charconvert' option. | |
| 1313 | |
| 1314 *v:cmdarg* *cmdarg-variable* | |
| 1315 v:cmdarg This variable is used for two purposes: | |
| 1316 1. The extra arguments given to a file read/write command. | |
| 1317 Currently these are "++enc=" and "++ff=". This variable is | |
| 1318 set before an autocommand event for a file read/write | |
| 1319 command is triggered. There is a leading space to make it | |
| 1320 possible to append this variable directly after the | |
| 1621 | 1321 read/write command. Note: The "+cmd" argument isn't |
| 7 | 1322 included here, because it will be executed anyway. |
| 1323 2. When printing a PostScript file with ":hardcopy" this is | |
| 1324 the argument for the ":hardcopy" command. This can be used | |
| 1325 in 'printexpr'. | |
| 1326 | |
| 1327 *v:cmdbang* *cmdbang-variable* | |
| 1328 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
| 1329 was used the value is 1, otherwise it is 0. Note that this | |
| 1330 can only be used in autocommands. For user commands |<bang>| | |
| 1331 can be used. | |
| 1332 | |
| 6909 | 1333 *v:completed_item* *completed_item-variable* |
| 1334 v:completed_item | |
| 1335 |Dictionary| containing the |complete-items| for the most | |
| 1336 recently completed word after |CompleteDone|. The | |
| 1337 |Dictionary| is empty if the completion failed. | |
| 1338 | |
| 7 | 1339 *v:count* *count-variable* |
| 1340 v:count The count given for the last Normal mode command. Can be used | |
| 1621 | 1341 to get the count before a mapping. Read-only. Example: > |
| 7 | 1342 :map _x :<C-U>echo "the count is " . v:count<CR> |
| 1343 < Note: The <C-U> is required to remove the line range that you | |
| 1344 get when typing ':' after a count. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1345 When there are two counts, as in "3d2w", they are multiplied, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1346 just like what happens in the command, "d6w" for the example. |
| 667 | 1347 Also used for evaluating the 'formatexpr' option. |
| 7 | 1348 "count" also works, for backwards compatibility. |
| 1349 | |
| 1350 *v:count1* *count1-variable* | |
| 1351 v:count1 Just like "v:count", but defaults to one when no count is | |
| 1352 used. | |
| 1353 | |
| 1354 *v:ctype* *ctype-variable* | |
| 1355 v:ctype The current locale setting for characters of the runtime | |
| 1356 environment. This allows Vim scripts to be aware of the | |
| 1357 current locale encoding. Technical: it's the value of | |
| 1358 LC_CTYPE. When not using a locale the value is "C". | |
| 1359 This variable can not be set directly, use the |:language| | |
| 1360 command. | |
| 1361 See |multi-lang|. | |
| 1362 | |
| 1363 *v:dying* *dying-variable* | |
| 1621 | 1364 v:dying Normally zero. When a deadly signal is caught it's set to |
| 7 | 1365 one. When multiple signals are caught the number increases. |
| 1366 Can be used in an autocommand to check if Vim didn't | |
| 1367 terminate normally. {only works on Unix} | |
| 1368 Example: > | |
| 1369 :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
|
1370 < 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
|
1371 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
|
1372 |
| 7 | 1373 *v:errmsg* *errmsg-variable* |
| 1374 v:errmsg Last given error message. It's allowed to set this variable. | |
| 1375 Example: > | |
| 1376 :let v:errmsg = "" | |
| 1377 :silent! next | |
| 1378 :if v:errmsg != "" | |
| 1379 : ... handle error | |
| 1380 < "errmsg" also works, for backwards compatibility. | |
| 1381 | |
| 1382 *v:exception* *exception-variable* | |
| 1383 v:exception The value of the exception most recently caught and not | |
| 1384 finished. See also |v:throwpoint| and |throw-variables|. | |
| 1385 Example: > | |
| 1386 :try | |
| 1387 : throw "oops" | |
| 1388 :catch /.*/ | |
| 1389 : echo "caught" v:exception | |
| 1390 :endtry | |
| 1391 < Output: "caught oops". | |
| 1392 | |
| 179 | 1393 *v:fcs_reason* *fcs_reason-variable* |
| 1394 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
| 1395 Can be used in an autocommand to decide what to do and/or what | |
| 1396 to set v:fcs_choice to. Possible values: | |
| 1397 deleted file no longer exists | |
| 1398 conflict file contents, mode or timestamp was | |
| 1399 changed and buffer is modified | |
| 1400 changed file contents has changed | |
| 1401 mode mode of file changed | |
| 1402 time only file timestamp changed | |
| 1403 | |
| 1404 *v:fcs_choice* *fcs_choice-variable* | |
| 1405 v:fcs_choice What should happen after a |FileChangedShell| event was | |
| 1406 triggered. Can be used in an autocommand to tell Vim what to | |
| 1407 do with the affected buffer: | |
| 1408 reload Reload the buffer (does not work if | |
| 1409 the file was deleted). | |
| 1410 ask Ask the user what to do, as if there | |
| 1411 was no autocommand. Except that when | |
| 1412 only the timestamp changed nothing | |
| 1413 will happen. | |
| 1414 <empty> Nothing, the autocommand should do | |
| 1415 everything that needs to be done. | |
| 1416 The default is empty. If another (invalid) value is used then | |
| 1417 Vim behaves like it is empty, there is no warning message. | |
| 1418 | |
| 7 | 1419 *v:fname_in* *fname_in-variable* |
| 579 | 1420 v:fname_in The name of the input file. Valid while evaluating: |
| 7 | 1421 option used for ~ |
| 1422 'charconvert' file to be converted | |
| 1423 'diffexpr' original file | |
| 1424 'patchexpr' original file | |
| 1425 'printexpr' file to be printed | |
| 593 | 1426 And set to the swap file name for |SwapExists|. |
| 7 | 1427 |
| 1428 *v:fname_out* *fname_out-variable* | |
| 1429 v:fname_out The name of the output file. Only valid while | |
| 1430 evaluating: | |
| 1431 option used for ~ | |
| 1432 'charconvert' resulting converted file (*) | |
| 1433 'diffexpr' output of diff | |
| 1434 'patchexpr' resulting patched file | |
| 1435 (*) When doing conversion for a write command (e.g., ":w | |
| 1621 | 1436 file") it will be equal to v:fname_in. When doing conversion |
| 7 | 1437 for a read command (e.g., ":e file") it will be a temporary |
| 1438 file and different from v:fname_in. | |
| 1439 | |
| 1440 *v:fname_new* *fname_new-variable* | |
| 1441 v:fname_new The name of the new version of the file. Only valid while | |
| 1442 evaluating 'diffexpr'. | |
| 1443 | |
| 1444 *v:fname_diff* *fname_diff-variable* | |
| 1445 v:fname_diff The name of the diff (patch) file. Only valid while | |
| 1446 evaluating 'patchexpr'. | |
| 1447 | |
| 1448 *v:folddashes* *folddashes-variable* | |
| 1449 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
| 1450 fold. | |
| 29 | 1451 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1452 |
| 1453 *v:foldlevel* *foldlevel-variable* | |
| 1454 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
| 29 | 1455 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1456 |
| 1457 *v:foldend* *foldend-variable* | |
| 1458 v:foldend Used for 'foldtext': last line of closed fold. | |
| 29 | 1459 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1460 |
| 1461 *v:foldstart* *foldstart-variable* | |
| 1462 v:foldstart Used for 'foldtext': first line of closed fold. | |
| 29 | 1463 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1464 |
| 5460 | 1465 *v:hlsearch* *hlsearch-variable* |
| 6413 | 1466 v:hlsearch Variable that indicates whether search highlighting is on. |
| 1467 Setting it makes sense only if 'hlsearch' is enabled which | |
| 1468 requires |+extra_search|. Setting this variable to zero acts | |
| 1469 the like |:nohlsearch| command, setting it to one acts like > | |
| 5460 | 1470 let &hlsearch = &hlsearch |
| 6918 | 1471 < Note that the value is restored when returning from a |
| 1472 function. |function-search-undo|. | |
| 1473 | |
| 11 | 1474 *v:insertmode* *insertmode-variable* |
| 1475 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
| 1476 events. Values: | |
| 1477 i Insert mode | |
| 1478 r Replace mode | |
| 1479 v Virtual Replace mode | |
| 1480 | |
| 102 | 1481 *v:key* *key-variable* |
| 685 | 1482 v:key Key of the current item of a |Dictionary|. Only valid while |
| 102 | 1483 evaluating the expression used with |map()| and |filter()|. |
| 1484 Read-only. | |
| 1485 | |
| 7 | 1486 *v:lang* *lang-variable* |
| 1487 v:lang The current locale setting for messages of the runtime | |
| 1488 environment. This allows Vim scripts to be aware of the | |
| 1489 current language. Technical: it's the value of LC_MESSAGES. | |
| 1490 The value is system dependent. | |
| 1491 This variable can not be set directly, use the |:language| | |
| 1492 command. | |
| 1493 It can be different from |v:ctype| when messages are desired | |
| 1494 in a different language than what is used for character | |
| 1495 encoding. See |multi-lang|. | |
| 1496 | |
| 1497 *v:lc_time* *lc_time-variable* | |
| 1498 v:lc_time The current locale setting for time messages of the runtime | |
| 1499 environment. This allows Vim scripts to be aware of the | |
| 1500 current language. Technical: it's the value of LC_TIME. | |
| 1501 This variable can not be set directly, use the |:language| | |
| 1502 command. See |multi-lang|. | |
| 1503 | |
| 1504 *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
|
1505 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
|
1506 '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
|
1507 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
|
1508 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
|
1509 |sandbox|. |
| 7 | 1510 |
| 1029 | 1511 *v:mouse_win* *mouse_win-variable* |
| 1512 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
| 1513 First window has number 1, like with |winnr()|. The value is | |
| 1514 zero when there was no mouse button click. | |
| 1515 | |
| 1516 *v:mouse_lnum* *mouse_lnum-variable* | |
| 1517 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
| 1518 This is the text line number, not the screen line number. The | |
| 1519 value is zero when there was no mouse button click. | |
| 1520 | |
| 1521 *v:mouse_col* *mouse_col-variable* | |
| 1522 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
| 1523 This is the screen column number, like with |virtcol()|. The | |
| 1524 value is zero when there was no mouse button click. | |
| 1525 | |
| 1733 | 1526 *v:oldfiles* *oldfiles-variable* |
| 1527 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
| 1528 startup. These are the files that Vim remembers marks for. | |
| 1529 The length of the List is limited by the ' argument of the | |
| 1530 'viminfo' option (default is 100). | |
| 5618 | 1531 When the |viminfo| file is not used the List is empty. |
| 1733 | 1532 Also see |:oldfiles| and |c_#<|. |
| 1533 The List can be modified, but this has no effect on what is | |
| 1534 stored in the |viminfo| file later. If you use values other | |
| 1535 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
|
1536 {only when compiled with the |+viminfo| feature} |
| 1733 | 1537 |
| 6935 | 1538 *v:option_new* |
| 1539 v:option_new New value of the option. Valid while executing an |OptionSet| | |
| 1540 autocommand. | |
| 1541 *v:option_old* | |
| 1542 v:option_old Old value of the option. Valid while executing an |OptionSet| | |
| 1543 autocommand. | |
| 1544 *v:option_type* | |
| 1545 v:option_type Scope of the set command. Valid while executing an | |
| 1546 |OptionSet| autocommand. Can be either "global" or "local" | |
| 1490 | 1547 *v:operator* *operator-variable* |
| 1548 v:operator The last operator given in Normal mode. This is a single | |
| 1549 character except for commands starting with <g> or <z>, | |
| 1550 in which case it is two characters. Best used alongside | |
| 1551 |v:prevcount| and |v:register|. Useful if you want to cancel | |
| 1552 Operator-pending mode and then use the operator, e.g.: > | |
| 1553 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
| 1554 < The value remains set until another operator is entered, thus | |
| 1555 don't expect it to be empty. | |
| 1556 v:operator is not set for |:delete|, |:yank| or other Ex | |
| 1557 commands. | |
| 1558 Read-only. | |
| 1559 | |
| 7 | 1560 *v:prevcount* *prevcount-variable* |
| 1561 v:prevcount The count given for the last but one Normal mode command. | |
| 1562 This is the v:count value of the previous command. Useful if | |
| 1490 | 1563 you want to cancel Visual or Operator-pending mode and then |
| 1564 use the count, e.g.: > | |
| 7 | 1565 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
| 1566 < Read-only. | |
| 1567 | |
| 170 | 1568 *v:profiling* *profiling-variable* |
| 1621 | 1569 v:profiling Normally zero. Set to one after using ":profile start". |
| 170 | 1570 See |profiling|. |
| 1571 | |
| 7 | 1572 *v:progname* *progname-variable* |
| 1573 v:progname Contains the name (with path removed) with which Vim was | |
| 3492 | 1574 invoked. Allows you to do special initialisations for |view|, |
| 1575 |evim| etc., or any other name you might symlink to Vim. | |
| 7 | 1576 Read-only. |
| 1577 | |
| 5780 | 1578 *v:progpath* *progpath-variable* |
| 1579 v:progpath Contains the command with which Vim was invoked, including the | |
| 1580 path. Useful if you want to message a Vim server using a | |
| 1581 |--remote-expr|. | |
| 5782 | 1582 To get the full path use: > |
| 1583 echo exepath(v:progpath) | |
| 1584 < NOTE: This does not work when the command is a relative path | |
| 1585 and the current directory has changed. | |
| 5780 | 1586 Read-only. |
| 1587 | |
| 7 | 1588 *v:register* *register-variable* |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1589 v:register The name of the register in effect for the current normal mode |
| 3492 | 1590 command (regardless of whether that command actually used a |
| 1591 register). Or for the currently executing normal mode mapping | |
| 1592 (use this in custom commands that take a register). | |
| 1593 If none is supplied it is the default register '"', unless | |
| 1594 'clipboard' contains "unnamed" or "unnamedplus", then it is | |
| 1595 '*' or '+'. | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1596 Also see |getreg()| and |setreg()| |
| 7 | 1597 |
| 540 | 1598 *v:scrollstart* *scrollstart-variable* |
| 1599 v:scrollstart String describing the script or function that caused the | |
| 1600 screen to scroll up. It's only set when it is empty, thus the | |
| 1601 first reason is remembered. It is set to "Unknown" for a | |
| 1602 typed command. | |
| 1603 This can be used to find out why your script causes the | |
| 1604 hit-enter prompt. | |
| 1605 | |
| 7 | 1606 *v:servername* *servername-variable* |
| 1607 v:servername The resulting registered |x11-clientserver| name if any. | |
| 1608 Read-only. | |
| 1609 | |
| 1621 | 1610 |
| 1611 v:searchforward *v:searchforward* *searchforward-variable* | |
| 1612 Search direction: 1 after a forward search, 0 after a | |
| 1613 backward search. It is reset to forward when directly setting | |
| 1614 the last search pattern, see |quote/|. | |
| 1615 Note that the value is restored when returning from a | |
| 1616 function. |function-search-undo|. | |
| 1617 Read-write. | |
| 1618 | |
| 7 | 1619 *v:shell_error* *shell_error-variable* |
| 1620 v:shell_error Result of the last shell command. When non-zero, the last | |
| 1621 shell command had an error. When zero, there was no problem. | |
| 1622 This only works when the shell returns the error code to Vim. | |
| 1623 The value -1 is often used when the command could not be | |
| 1624 executed. Read-only. | |
| 1625 Example: > | |
| 1626 :!mv foo bar | |
| 1627 :if v:shell_error | |
| 1628 : echo 'could not rename "foo" to "bar"!' | |
| 1629 :endif | |
| 1630 < "shell_error" also works, for backwards compatibility. | |
| 1631 | |
| 1632 *v:statusmsg* *statusmsg-variable* | |
| 1633 v:statusmsg Last given status message. It's allowed to set this variable. | |
| 1634 | |
| 579 | 1635 *v:swapname* *swapname-variable* |
| 1636 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
| 1637 the swap file found. Read-only. | |
| 1638 | |
| 1639 *v:swapchoice* *swapchoice-variable* | |
| 1640 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
| 1641 for handling an existing swap file: | |
| 1642 'o' Open read-only | |
| 1643 'e' Edit anyway | |
| 1644 'r' Recover | |
| 1645 'd' Delete swapfile | |
| 1646 'q' Quit | |
| 1647 'a' Abort | |
| 1621 | 1648 The value should be a single-character string. An empty value |
| 579 | 1649 results in the user being asked, as would happen when there is |
| 1650 no SwapExists autocommand. The default is empty. | |
| 1651 | |
| 590 | 1652 *v:swapcommand* *swapcommand-variable* |
| 625 | 1653 v:swapcommand Normal mode command to be executed after a file has been |
| 590 | 1654 opened. Can be used for a |SwapExists| autocommand to have |
| 1621 | 1655 another Vim open the file and jump to the right place. For |
| 590 | 1656 example, when jumping to a tag the value is ":tag tagname\r". |
| 716 | 1657 For ":edit +cmd file" the value is ":cmd\r". |
| 590 | 1658 |
| 7 | 1659 *v:termresponse* *termresponse-variable* |
| 1660 v:termresponse The escape sequence returned by the terminal for the |t_RV| | |
| 1621 | 1661 termcap entry. It is set when Vim receives an escape sequence |
| 7 | 1662 that starts with ESC [ or CSI and ends in a 'c', with only |
| 1663 digits, ';' and '.' in between. | |
| 1664 When this option is set, the TermResponse autocommand event is | |
| 1665 fired, so that you can react to the response from the | |
| 1666 terminal. | |
| 1667 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp | |
| 1668 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the | |
| 1669 patch level (since this was introduced in patch 95, it's | |
| 1670 always 95 or bigger). Pc is always zero. | |
| 1671 {only when compiled with |+termresponse| feature} | |
| 1672 | |
| 1673 *v:this_session* *this_session-variable* | |
| 1674 v:this_session Full filename of the last loaded or saved session file. See | |
| 1675 |:mksession|. It is allowed to set this variable. When no | |
| 1676 session file has been saved, this variable is empty. | |
| 1677 "this_session" also works, for backwards compatibility. | |
| 1678 | |
| 1679 *v:throwpoint* *throwpoint-variable* | |
| 1680 v:throwpoint The point where the exception most recently caught and not | |
| 1621 | 1681 finished was thrown. Not set when commands are typed. See |
| 7 | 1682 also |v:exception| and |throw-variables|. |
| 1683 Example: > | |
| 1684 :try | |
| 1685 : throw "oops" | |
| 1686 :catch /.*/ | |
| 1687 : echo "Exception from" v:throwpoint | |
| 1688 :endtry | |
| 1689 < Output: "Exception from test.vim, line 2" | |
| 1690 | |
| 102 | 1691 *v:val* *val-variable* |
| 1621 | 1692 v:val Value of the current item of a |List| or |Dictionary|. Only |
| 685 | 1693 valid while evaluating the expression used with |map()| and |
| 102 | 1694 |filter()|. Read-only. |
| 1695 | |
| 7 | 1696 *v:version* *version-variable* |
| 1697 v:version Version number of Vim: Major version number times 100 plus | |
| 1698 minor version number. Version 5.0 is 500. Version 5.1 (5.01) | |
| 1699 is 501. Read-only. "version" also works, for backwards | |
| 1700 compatibility. | |
| 1701 Use |has()| to check if a certain patch was included, e.g.: > | |
| 5786 | 1702 if has("patch-7.4.123") |
| 7 | 1703 < Note that patch numbers are specific to the version, thus both |
| 1704 version 5.0 and 5.1 may have a patch 123, but these are | |
| 1705 completely different. | |
| 1706 | |
| 1707 *v:warningmsg* *warningmsg-variable* | |
| 1708 v:warningmsg Last given warning message. It's allowed to set this variable. | |
| 1709 | |
| 2609 | 1710 *v:windowid* *windowid-variable* |
| 1711 v:windowid When any X11 based GUI is running or when running in a | |
| 1712 terminal and Vim connects to the X server (|-X|) this will be | |
| 2616 | 1713 set to the window ID. |
| 1714 When an MS-Windows GUI is running this will be set to the | |
| 1715 window handle. | |
| 1716 Otherwise the value is zero. | |
| 1717 Note: for windows inside Vim use |winnr()|. | |
| 2609 | 1718 |
| 7 | 1719 ============================================================================== |
| 1720 4. Builtin Functions *functions* | |
| 1721 | |
| 1722 See |function-list| for a list grouped by what the function is used for. | |
| 1723 | |
| 236 | 1724 (Use CTRL-] on the function name to jump to the full explanation.) |
| 7 | 1725 |
| 1726 USAGE RESULT DESCRIPTION ~ | |
| 1727 | |
| 1621 | 1728 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
|
1729 acos( {expr}) Float arc cosine of {expr} |
| 685 | 1730 add( {list}, {item}) List append {item} to |List| {list} |
| 3214 | 1731 and( {expr}, {expr}) Number bitwise AND |
| 55 | 1732 append( {lnum}, {string}) Number append {string} below line {lnum} |
| 161 | 1733 append( {lnum}, {list}) Number append lines {list} below line {lnum} |
| 7 | 1734 argc() Number number of files in the argument list |
| 55 | 1735 argidx() Number current index in the argument list |
| 5942 | 1736 arglistid( [{winnr}, [ {tabnr}]]) |
| 1737 Number argument list id | |
| 7 | 1738 argv( {nr}) String {nr} entry of the argument list |
| 818 | 1739 argv( ) List the argument list |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1740 asin( {expr}) Float arc sine of {expr} |
| 1621 | 1741 atan( {expr}) Float arc tangent of {expr} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1742 atan2( {expr}, {expr}) Float arc tangent of {expr1} / {expr2} |
| 7 | 1743 browse( {save}, {title}, {initdir}, {default}) |
| 1744 String put up a file requester | |
| 1621 | 1745 browsedir( {title}, {initdir}) String put up a directory requester |
| 7 | 1746 bufexists( {expr}) Number TRUE if buffer {expr} exists |
| 55 | 1747 buflisted( {expr}) Number TRUE if buffer {expr} is listed |
| 1748 bufloaded( {expr}) Number TRUE if buffer {expr} is loaded | |
| 7 | 1749 bufname( {expr}) String Name of the buffer {expr} |
| 1750 bufnr( {expr}) Number Number of the buffer {expr} | |
| 1751 bufwinnr( {expr}) Number window number of buffer {expr} | |
| 1752 byte2line( {byte}) Number line number at byte count {byte} | |
| 55 | 1753 byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr} |
| 5413 | 1754 byteidxcomp( {expr}, {nr}) Number byte index of {nr}'th char in {expr} |
| 102 | 1755 call( {func}, {arglist} [, {dict}]) |
| 1756 any call {func} with arguments {arglist} | |
| 1621 | 1757 ceil( {expr}) Float round {expr} up |
| 1758 changenr() Number current change number | |
| 4051 | 1759 char2nr( {expr}[, {utf8}]) Number ASCII/UTF8 value of first char in {expr} |
| 55 | 1760 cindent( {lnum}) Number C indent for line {lnum} |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1761 clearmatches() none clear all matches |
| 7 | 1762 col( {expr}) Number column nr of cursor or mark |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1763 complete( {startcol}, {matches}) none set Insert mode completion |
| 464 | 1764 complete_add( {expr}) Number add completion match |
| 1621 | 1765 complete_check() Number check for key typed during completion |
| 7 | 1766 confirm( {msg} [, {choices} [, {default} [, {type}]]]) |
| 1767 Number number of choice picked by user | |
| 55 | 1768 copy( {expr}) any make a shallow copy of {expr} |
| 1621 | 1769 cos( {expr}) Float cosine of {expr} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1770 cosh( {expr}) Float hyperbolic cosine of {expr} |
| 6259 | 1771 count( {list}, {expr} [, {ic} [, {start}]]) |
| 95 | 1772 Number count how many {expr} are in {list} |
| 7 | 1773 cscope_connection( [{num} , {dbpath} [, {prepend}]]) |
| 1774 Number checks existence of cscope connection | |
| 6385 | 1775 cursor( {lnum}, {col} [, {off}]) |
| 1776 Number move cursor to {lnum}, {col}, {off} | |
| 703 | 1777 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
|
1778 deepcopy( {expr} [, {noref}]) any make a full copy of {expr} |
| 7 | 1779 delete( {fname}) Number delete file {fname} |
| 1780 did_filetype() Number TRUE if FileType autocommand event used | |
| 55 | 1781 diff_filler( {lnum}) Number diff filler lines about {lnum} |
| 1782 diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col} | |
| 85 | 1783 empty( {expr}) Number TRUE if {expr} is empty |
| 7 | 1784 escape( {string}, {chars}) String escape {chars} in {string} with '\' |
| 205 | 1785 eval( {string}) any evaluate {string} into its value |
| 55 | 1786 eventhandler( ) Number TRUE if inside an event handler |
| 7 | 1787 executable( {expr}) Number 1 if executable {expr} exists |
| 5782 | 1788 exepath( {expr}) String full path of the command {expr} |
| 7 | 1789 exists( {expr}) Number TRUE if {expr} exists |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1790 extend( {expr1}, {expr2} [, {expr3}]) |
| 824 | 1791 List/Dict insert items of {expr2} into {expr1} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1792 exp( {expr}) Float exponential of {expr} |
| 3398 | 1793 expand( {expr} [, {nosuf} [, {list}]]) |
| 1794 any expand special keywords in {expr} | |
| 1621 | 1795 feedkeys( {string} [, {mode}]) Number add key sequence to typeahead buffer |
| 7 | 1796 filereadable( {file}) Number TRUE if {file} is a readable file |
| 824 | 1797 filewritable( {file}) Number TRUE if {file} is a writable file |
| 102 | 1798 filter( {expr}, {string}) List/Dict remove items from {expr} where |
| 1799 {string} is 0 | |
| 95 | 1800 finddir( {name}[, {path}[, {count}]]) |
| 824 | 1801 String find directory {name} in {path} |
| 19 | 1802 findfile( {name}[, {path}[, {count}]]) |
| 824 | 1803 String find file {name} in {path} |
| 1621 | 1804 float2nr( {expr}) Number convert Float {expr} to a Number |
| 1805 floor( {expr}) Float round {expr} down | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1806 fmod( {expr1}, {expr2}) Float remainder of {expr1} / {expr2} |
| 1586 | 1807 fnameescape( {fname}) String escape special characters in {fname} |
| 7 | 1808 fnamemodify( {fname}, {mods}) String modify file name |
| 55 | 1809 foldclosed( {lnum}) Number first line of fold at {lnum} if closed |
| 1810 foldclosedend( {lnum}) Number last line of fold at {lnum} if closed | |
| 7 | 1811 foldlevel( {lnum}) Number fold level at {lnum} |
| 55 | 1812 foldtext( ) String line displayed for closed fold |
| 824 | 1813 foldtextresult( {lnum}) String text for closed fold at {lnum} |
| 7 | 1814 foreground( ) Number bring the Vim window to the foreground |
| 55 | 1815 function( {name}) Funcref reference to function {name} |
| 3224 | 1816 garbagecollect( [{atexit}]) none free memory, breaking cyclic references |
| 82 | 1817 get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def} |
| 102 | 1818 get( {dict}, {key} [, {def}]) any get item {key} from {dict} or {def} |
| 435 | 1819 getbufline( {expr}, {lnum} [, {end}]) |
| 1820 List lines {lnum} to {end} of buffer {expr} | |
| 4157 | 1821 getbufvar( {expr}, {varname} [, {def}]) |
| 1822 any variable {varname} in buffer {expr} | |
| 55 | 1823 getchar( [expr]) Number get one character from the user |
| 1824 getcharmod( ) Number modifiers for the last typed character | |
| 7 | 1825 getcmdline() String return the current command-line |
| 1826 getcmdpos() Number return cursor position in command-line | |
| 6153 | 1827 getcmdtype() String return current command-line type |
| 1828 getcmdwintype() String return current command-line window type | |
| 5944 | 1829 getcurpos() List position of the cursor |
| 7 | 1830 getcwd() String the current working directory |
| 5944 | 1831 getfontname( [{name}]) String name of font being used |
| 20 | 1832 getfperm( {fname}) String file permissions of file {fname} |
| 1833 getfsize( {fname}) Number size in bytes of file {fname} | |
| 7 | 1834 getftime( {fname}) Number last modification time of file |
| 20 | 1835 getftype( {fname}) String description of type of file {fname} |
| 161 | 1836 getline( {lnum}) String line {lnum} of current buffer |
| 1837 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
|
1838 getloclist( {nr}) List list of location list items |
| 1326 | 1839 getmatches() List list of current matches |
| 1548 | 1840 getpid() Number process ID of Vim |
| 703 | 1841 getpos( {expr}) List position of cursor, mark, etc. |
| 230 | 1842 getqflist() List list of quickfix items |
| 5796 | 1843 getreg( [{regname} [, 1 [, {list}]]]) |
| 1844 String or List contents of register | |
| 55 | 1845 getregtype( [{regname}]) String type of register |
| 4157 | 1846 gettabvar( {nr}, {varname} [, {def}]) |
| 1847 any variable {varname} in tab {nr} or {def} | |
| 1848 gettabwinvar( {tabnr}, {winnr}, {name} [, {def}]) | |
| 831 | 1849 any {name} in {winnr} in tab page {tabnr} |
| 7 | 1850 getwinposx() Number X coord in pixels of GUI Vim window |
| 1851 getwinposy() Number Y coord in pixels of GUI Vim window | |
| 4157 | 1852 getwinvar( {nr}, {varname} [, {def}]) |
| 1853 any variable {varname} in window {nr} | |
| 6663 | 1854 glob( {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 3398 | 1855 any expand file wildcards in {expr} |
| 6697 | 1856 glob2regpat( {expr}) String convert a glob pat into a search pat |
| 6663 | 1857 globpath( {path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 1754 | 1858 String do glob({expr}) for all dirs in {path} |
| 7 | 1859 has( {feature}) Number TRUE if feature {feature} supported |
| 102 | 1860 has_key( {dict}, {key}) Number TRUE if {dict} has entry {key} |
| 1104 | 1861 haslocaldir() Number TRUE if current window executed |:lcd| |
| 782 | 1862 hasmapto( {what} [, {mode} [, {abbr}]]) |
| 1863 Number TRUE if mapping to {what} exists | |
| 7 | 1864 histadd( {history},{item}) String add an item to a history |
| 1865 histdel( {history} [, {item}]) String remove an item from a history | |
| 1866 histget( {history} [, {index}]) String get the item {index} from a history | |
| 1867 histnr( {history}) Number highest index of a history | |
| 1868 hlexists( {name}) Number TRUE if highlight group {name} exists | |
| 1869 hlID( {name}) Number syntax ID of highlight group {name} | |
| 1870 hostname() String name of the machine Vim is running on | |
| 55 | 1871 iconv( {expr}, {from}, {to}) String convert encoding of {expr} |
| 1872 indent( {lnum}) Number indent of line {lnum} | |
| 95 | 1873 index( {list}, {expr} [, {start} [, {ic}]]) |
| 1874 Number index in {list} where {expr} appears | |
| 531 | 1875 input( {prompt} [, {text} [, {completion}]]) |
| 1876 String get input from the user | |
| 7 | 1877 inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog |
| 824 | 1878 inputlist( {textlist}) Number let the user pick from a choice list |
| 55 | 1879 inputrestore() Number restore typeahead |
| 1880 inputsave() Number save and clear typeahead | |
| 7 | 1881 inputsecret( {prompt} [, {text}]) String like input() but hiding the text |
| 55 | 1882 insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}] |
| 3214 | 1883 invert( {expr}) Number bitwise invert |
| 7 | 1884 isdirectory( {directory}) Number TRUE if {directory} is a directory |
| 148 | 1885 islocked( {expr}) Number TRUE if {expr} is locked |
| 685 | 1886 items( {dict}) List key-value pairs in {dict} |
| 95 | 1887 join( {list} [, {sep}]) String join {list} items into one String |
| 685 | 1888 keys( {dict}) List keys in {dict} |
| 55 | 1889 len( {expr}) Number the length of {expr} |
| 1890 libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg} | |
| 7 | 1891 libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number |
| 1892 line( {expr}) Number line nr of cursor, last line or mark | |
| 1893 line2byte( {lnum}) Number byte count of line {lnum} | |
| 55 | 1894 lispindent( {lnum}) Number Lisp indent for line {lnum} |
| 7 | 1895 localtime() Number current time |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1896 log( {expr}) Float natural logarithm (base e) of {expr} |
| 1621 | 1897 log10( {expr}) Float logarithm of Float {expr} to base 10 |
| 3492 | 1898 luaeval( {expr}[, {expr}]) any evaluate |Lua| expression |
| 102 | 1899 map( {expr}, {string}) List/Dict change each item in {expr} to {expr} |
| 2610 | 1900 maparg( {name}[, {mode} [, {abbr} [, {dict}]]]) |
| 3224 | 1901 String or Dict |
| 1902 rhs of mapping {name} in mode {mode} | |
| 782 | 1903 mapcheck( {name}[, {mode} [, {abbr}]]) |
| 1904 String check for mappings matching {name} | |
| 19 | 1905 match( {expr}, {pat}[, {start}[, {count}]]) |
| 7 | 1906 Number position where {pat} matches in {expr} |
| 1326 | 1907 matchadd( {group}, {pattern}[, {priority}[, {id}]]) |
| 1908 Number highlight {pattern} with {group} | |
| 5979 | 1909 matchaddpos( {group}, {list}[, {priority}[, {id}]]) |
| 1910 Number highlight positions with {group} | |
| 819 | 1911 matcharg( {nr}) List arguments of |:match| |
| 1326 | 1912 matchdelete( {id}) Number delete match identified by {id} |
| 19 | 1913 matchend( {expr}, {pat}[, {start}[, {count}]]) |
| 7 | 1914 Number position where {pat} ends in {expr} |
| 158 | 1915 matchlist( {expr}, {pat}[, {start}[, {count}]]) |
| 1916 List match and submatches of {pat} in {expr} | |
| 19 | 1917 matchstr( {expr}, {pat}[, {start}[, {count}]]) |
| 1918 String {count}'th match of {pat} in {expr} | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1919 max( {list}) Number maximum value of items in {list} |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1920 min( {list}) Number minimum value of items in {list} |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1921 mkdir( {name} [, {path} [, {prot}]]) |
| 168 | 1922 Number create directory {name} |
| 1621 | 1923 mode( [expr]) String current editing mode |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
1924 mzeval( {expr}) any evaluate |MzScheme| expression |
| 7 | 1925 nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum} |
| 4051 | 1926 nr2char( {expr}[, {utf8}]) String single char with ASCII/UTF8 value {expr} |
| 3214 | 1927 or( {expr}, {expr}) Number bitwise OR |
| 819 | 1928 pathshorten( {expr}) String shorten directory names in a path |
| 1621 | 1929 pow( {x}, {y}) Float {x} to the power of {y} |
| 7 | 1930 prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum} |
| 1621 | 1931 printf( {fmt}, {expr1}...) String format text |
| 1932 pumvisible() Number whether popup menu is visible | |
| 3682 | 1933 pyeval( {expr}) any evaluate |Python| expression |
| 1934 py3eval( {expr}) any evaluate |python3| expression | |
| 99 | 1935 range( {expr} [, {max} [, {stride}]]) |
| 1936 List items from {expr} to {max} | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1937 readfile( {fname} [, {binary} [, {max}]]) |
| 168 | 1938 List get list of lines from file {fname} |
| 794 | 1939 reltime( [{start} [, {end}]]) List get time value |
| 1940 reltimestr( {time}) String turn time value into a String | |
| 7 | 1941 remote_expr( {server}, {string} [, {idvar}]) |
| 1942 String send expression | |
| 1943 remote_foreground( {server}) Number bring Vim server to the foreground | |
| 1944 remote_peek( {serverid} [, {retvar}]) | |
| 1945 Number check for reply string | |
| 1946 remote_read( {serverid}) String read reply string | |
| 1947 remote_send( {server}, {string} [, {idvar}]) | |
| 1948 String send key sequence | |
| 79 | 1949 remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list} |
| 856 | 1950 remove( {dict}, {key}) any remove entry {key} from {dict} |
| 55 | 1951 rename( {from}, {to}) Number rename (move) file from {from} to {to} |
| 1952 repeat( {expr}, {count}) String repeat {expr} {count} times | |
| 1953 resolve( {filename}) String get filename a shortcut points to | |
| 82 | 1954 reverse( {list}) List reverse {list} in-place |
| 1621 | 1955 round( {expr}) Float round off {expr} |
|
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
1956 screenattr( {row}, {col}) Number attribute at screen position |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
1957 screenchar( {row}, {col}) Number character at screen position |
| 3986 | 1958 screencol() Number current cursor column |
| 1959 screenrow() Number current cursor row | |
| 1496 | 1960 search( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
| 1961 Number search for {pattern} | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1962 searchdecl( {name} [, {global} [, {thisblock}]]) |
| 1621 | 1963 Number search for variable declaration |
| 1496 | 1964 searchpair( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 55 | 1965 Number search for other end of start/end pair |
| 1496 | 1966 searchpairpos( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 667 | 1967 List search for other end of start/end pair |
| 1496 | 1968 searchpos( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
| 667 | 1969 List search for {pattern} |
| 7 | 1970 server2client( {clientid}, {string}) |
| 1971 Number send reply string | |
| 1972 serverlist() String get a list of available servers | |
| 1973 setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val} | |
| 6991 | 1974 setcharsearch( {dict}) Dict set character search from {dict} |
| 7 | 1975 setcmdpos( {pos}) Number set cursor position in command-line |
| 1976 setline( {lnum}, {line}) Number set line {lnum} to {line} | |
| 647 | 1977 setloclist( {nr}, {list}[, {action}]) |
| 1978 Number modify location list using {list} | |
| 1326 | 1979 setmatches( {list}) Number restore a list of matches |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1980 setpos( {expr}, {list}) Number set the {expr} position to {list} |
| 647 | 1981 setqflist( {list}[, {action}]) Number modify quickfix list using {list} |
| 55 | 1982 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
|
1983 settabvar( {nr}, {varname}, {val}) set {varname} in tab page {nr} to {val} |
| 831 | 1984 settabwinvar( {tabnr}, {winnr}, {varname}, {val}) set {varname} in window |
| 1985 {winnr} in tab page {tabnr} to {val} | |
| 7 | 1986 setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val} |
| 4126 | 1987 sha256( {string}) String SHA256 checksum of {string} |
| 1661 | 1988 shellescape( {string} [, {special}]) |
| 1989 String escape {string} for use as shell | |
| 985 | 1990 command argument |
| 3875 | 1991 shiftwidth() Number effective value of 'shiftwidth' |
| 55 | 1992 simplify( {filename}) String simplify filename as much as possible |
| 1621 | 1993 sin( {expr}) Float sine of {expr} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1994 sinh( {expr}) Float hyperbolic sine of {expr} |
| 2902 | 1995 sort( {list} [, {func} [, {dict}]]) |
| 1996 List sort {list}, using {func} to compare | |
| 374 | 1997 soundfold( {word}) String sound-fold {word} |
| 344 | 1998 spellbadword() String badly spelled word at cursor |
| 537 | 1999 spellsuggest( {word} [, {max} [, {capital}]]) |
| 2000 List spelling suggestions | |
| 282 | 2001 split( {expr} [, {pat} [, {keepempty}]]) |
| 685 | 2002 List make |List| from {pat} separated {expr} |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2003 sqrt( {expr}) Float square root of {expr} |
| 1621 | 2004 str2float( {expr}) Float convert String to Float |
| 2005 str2nr( {expr} [, {base}]) Number convert String to Number | |
| 6870 | 2006 strchars( {expr} [, {skipcc}]) Number character length of the String {expr} |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
2007 strdisplaywidth( {expr} [, {col}]) Number display length of the String {expr} |
| 7 | 2008 strftime( {format}[, {time}]) String time in specified format |
| 133 | 2009 stridx( {haystack}, {needle}[, {start}]) |
| 2010 Number index of {needle} in {haystack} | |
| 95 | 2011 string( {expr}) String String representation of {expr} value |
| 7 | 2012 strlen( {expr}) Number length of the String {expr} |
| 2013 strpart( {src}, {start}[, {len}]) | |
| 2014 String {len} characters of {src} at {start} | |
| 140 | 2015 strridx( {haystack}, {needle} [, {start}]) |
| 2016 Number last index of {needle} in {haystack} | |
| 7 | 2017 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
|
2018 strwidth( {expr}) Number display cell length of the String {expr} |
| 5794 | 2019 submatch( {nr}[, {list}]) String or List |
| 2020 specific match in ":s" or substitute() | |
| 7 | 2021 substitute( {expr}, {pat}, {sub}, {flags}) |
| 2022 String all {pat} in {expr} replaced with {sub} | |
| 32 | 2023 synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col} |
| 7 | 2024 synIDattr( {synID}, {what} [, {mode}]) |
| 2025 String attribute {what} of syntax ID {synID} | |
| 2026 synIDtrans( {synID}) Number translated syntax ID of {synID} | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
2027 synconcealed( {lnum}, {col}) List info about concealing |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2028 synstack( {lnum}, {col}) List stack of syntax IDs at {lnum} and {col} |
| 24 | 2029 system( {expr} [, {input}]) String output of shell command/filter {expr} |
| 5808 | 2030 systemlist( {expr} [, {input}]) List output of shell command/filter {expr} |
| 677 | 2031 tabpagebuflist( [{arg}]) List list of buffer numbers in tab page |
| 2032 tabpagenr( [{arg}]) Number number of current or last tab page | |
| 2033 tabpagewinnr( {tabarg}[, {arg}]) | |
| 2034 Number number of current window in tab page | |
| 2035 taglist( {expr}) List list of tags matching {expr} | |
| 1621 | 2036 tagfiles() List tags files used |
| 7 | 2037 tempname() String name for a temporary file |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2038 tan( {expr}) Float tangent of {expr} |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2039 tanh( {expr}) Float hyperbolic tangent of {expr} |
| 7 | 2040 tolower( {expr}) String the String {expr} switched to lowercase |
| 2041 toupper( {expr}) String the String {expr} switched to uppercase | |
| 15 | 2042 tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
| 2043 to chars in {tostr} | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2044 trunc( {expr}) Float truncate Float {expr} |
| 7 | 2045 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
|
2046 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
|
2047 undotree() List undo file tree |
| 5747 | 2048 uniq( {list} [, {func} [, {dict}]]) |
| 2049 List remove adjacent duplicates from a list | |
| 685 | 2050 values( {dict}) List values in {dict} |
| 7 | 2051 virtcol( {expr}) Number screen column of cursor or mark |
| 2052 visualmode( [expr]) String last visual mode used | |
| 4151 | 2053 wildmenumode() Number whether 'wildmenu' mode is active |
| 7 | 2054 winbufnr( {nr}) Number buffer number of window {nr} |
| 2055 wincol() Number window column of the cursor | |
| 2056 winheight( {nr}) Number height of window {nr} | |
| 2057 winline() Number window line of the cursor | |
| 674 | 2058 winnr( [{expr}]) Number number of current window |
| 55 | 2059 winrestcmd() String returns command to restore window sizes |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2060 winrestview( {dict}) none restore view of current window |
| 712 | 2061 winsaveview() Dict save view of current window |
| 7 | 2062 winwidth( {nr}) Number width of window {nr} |
| 6341 | 2063 writefile( {list}, {fname} [, {flags}]) |
| 158 | 2064 Number write list of lines to file {fname} |
| 3214 | 2065 xor( {expr}, {expr}) Number bitwise XOR |
| 7 | 2066 |
| 1621 | 2067 abs({expr}) *abs()* |
| 2068 Return the absolute value of {expr}. When {expr} evaluates to | |
| 2069 a |Float| abs() returns a |Float|. When {expr} can be | |
| 2070 converted to a |Number| abs() returns a |Number|. Otherwise | |
| 2071 abs() gives an error message and returns -1. | |
| 2072 Examples: > | |
| 2073 echo abs(1.456) | |
| 2074 < 1.456 > | |
| 2075 echo abs(-5.456) | |
| 2076 < 5.456 > | |
| 2077 echo abs(-4) | |
| 2078 < 4 | |
| 2079 {only available when compiled with the |+float| feature} | |
| 2080 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2081 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2082 acos({expr}) *acos()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2083 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
|
2084 |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
|
2085 {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
|
2086 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2087 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2088 :echo acos(0) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2089 < 1.570796 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2090 :echo acos(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2091 < 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
|
2092 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2093 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2094 |
| 82 | 2095 add({list}, {expr}) *add()* |
| 685 | 2096 Append the item {expr} to |List| {list}. Returns the |
| 2097 resulting |List|. Examples: > | |
| 82 | 2098 :let alist = add([1, 2, 3], item) |
| 2099 :call add(mylist, "woodstock") | |
| 685 | 2100 < Note that when {expr} is a |List| it is appended as a single |
| 692 | 2101 item. Use |extend()| to concatenate |Lists|. |
| 85 | 2102 Use |insert()| to add an item at another position. |
| 55 | 2103 |
| 82 | 2104 |
| 3214 | 2105 and({expr}, {expr}) *and()* |
| 2106 Bitwise AND on the two arguments. The arguments are converted | |
| 2107 to a number. A List, Dict or Float argument causes an error. | |
| 2108 Example: > | |
| 2109 :let flag = and(bits, 0x80) | |
| 2110 | |
| 2111 | |
| 82 | 2112 append({lnum}, {expr}) *append()* |
| 685 | 2113 When {expr} is a |List|: Append each item of the |List| as a |
| 2114 text line below line {lnum} in the current buffer. | |
| 153 | 2115 Otherwise append {expr} as one text line below line {lnum} in |
| 2116 the current buffer. | |
| 2117 {lnum} can be zero to insert a line before the first one. | |
| 82 | 2118 Returns 1 for failure ({lnum} out of range or out of memory), |
| 1621 | 2119 0 for success. Example: > |
| 55 | 2120 :let failed = append(line('$'), "# THE END") |
| 82 | 2121 :let failed = append(0, ["Chapter 1", "the beginning"]) |
| 55 | 2122 < |
| 7 | 2123 *argc()* |
| 2124 argc() The result is the number of files in the argument list of the | |
| 2125 current window. See |arglist|. | |
| 2126 | |
| 2127 *argidx()* | |
| 2128 argidx() The result is the current index in the argument list. 0 is | |
| 2129 the first file. argc() - 1 is the last one. See |arglist|. | |
| 2130 | |
| 5942 | 2131 *arglistid()* |
| 2132 arglistid([{winnr}, [ {tabnr} ]]) | |
| 2133 Return the argument list ID. This is a number which | |
| 2134 identifies the argument list being used. Zero is used for the | |
| 6153 | 2135 global argument list. See |arglist|. |
| 2136 Return -1 if the arguments are invalid. | |
| 5942 | 2137 |
| 2138 Without arguments use the current window. | |
| 2139 With {winnr} only use this window in the current tab page. | |
| 2140 With {winnr} and {tabnr} use the window in the specified tab | |
| 2141 page. | |
| 2142 | |
| 7 | 2143 *argv()* |
| 818 | 2144 argv([{nr}]) The result is the {nr}th file in the argument list of the |
| 7 | 2145 current window. See |arglist|. "argv(0)" is the first one. |
| 2146 Example: > | |
| 2147 :let i = 0 | |
| 2148 :while i < argc() | |
| 1621 | 2149 : let f = escape(fnameescape(argv(i)), '.') |
| 7 | 2150 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
| 2151 : let i = i + 1 | |
| 2152 :endwhile | |
| 818 | 2153 < Without the {nr} argument a |List| with the whole |arglist| is |
| 2154 returned. | |
| 2155 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2156 asin({expr}) *asin()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2157 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
|
2158 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
|
2159 {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
|
2160 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2161 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2162 :echo asin(0.8) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2163 < 0.927295 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2164 :echo asin(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2165 < -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
|
2166 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2167 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2168 |
| 1621 | 2169 atan({expr}) *atan()* |
| 2170 Return the principal value of the arc tangent of {expr}, in | |
| 2171 the range [-pi/2, +pi/2] radians, as a |Float|. | |
| 2172 {expr} must evaluate to a |Float| or a |Number|. | |
| 2173 Examples: > | |
| 2174 :echo atan(100) | |
| 2175 < 1.560797 > | |
| 2176 :echo atan(-4.01) | |
| 2177 < -1.326405 | |
| 2178 {only available when compiled with the |+float| feature} | |
| 2179 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2180 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2181 atan2({expr1}, {expr2}) *atan2()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2182 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
|
2183 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
|
2184 {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
|
2185 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2186 :echo atan2(-1, 1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2187 < -0.785398 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2188 :echo atan2(1, -1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2189 < 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
|
2190 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2191 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2192 |
| 7 | 2193 *browse()* |
| 2194 browse({save}, {title}, {initdir}, {default}) | |
| 2195 Put up a file requester. This only works when "has("browse")" | |
| 2196 returns non-zero (only in some GUI versions). | |
| 2197 The input fields are: | |
| 2198 {save} when non-zero, select file to write | |
| 2199 {title} title for the requester | |
| 2200 {initdir} directory to start browsing in | |
| 2201 {default} default file name | |
| 2202 When the "Cancel" button is hit, something went wrong, or | |
| 2203 browsing is not possible, an empty string is returned. | |
| 2204 | |
| 29 | 2205 *browsedir()* |
| 2206 browsedir({title}, {initdir}) | |
| 2207 Put up a directory requester. This only works when | |
| 2208 "has("browse")" returns non-zero (only in some GUI versions). | |
| 2209 On systems where a directory browser is not supported a file | |
| 2210 browser is used. In that case: select a file in the directory | |
| 2211 to be used. | |
| 2212 The input fields are: | |
| 2213 {title} title for the requester | |
| 2214 {initdir} directory to start browsing in | |
| 2215 When the "Cancel" button is hit, something went wrong, or | |
| 2216 browsing is not possible, an empty string is returned. | |
| 2217 | |
| 7 | 2218 bufexists({expr}) *bufexists()* |
| 2219 The result is a Number, which is non-zero if a buffer called | |
| 2220 {expr} exists. | |
| 9 | 2221 If the {expr} argument is a number, buffer numbers are used. |
| 7 | 2222 If the {expr} argument is a string it must match a buffer name |
| 9 | 2223 exactly. The name can be: |
| 2224 - Relative to the current directory. | |
| 2225 - A full path. | |
| 1621 | 2226 - The name of a buffer with 'buftype' set to "nofile". |
| 9 | 2227 - A URL name. |
| 7 | 2228 Unlisted buffers will be found. |
| 2229 Note that help files are listed by their short name in the | |
| 2230 output of |:buffers|, but bufexists() requires using their | |
| 2231 long name to be able to find them. | |
| 1621 | 2232 bufexists() may report a buffer exists, but to use the name |
| 2233 with a |:buffer| command you may need to use |expand()|. Esp | |
| 2234 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
| 7 | 2235 Use "bufexists(0)" to test for the existence of an alternate |
| 2236 file name. | |
| 2237 *buffer_exists()* | |
| 2238 Obsolete name: buffer_exists(). | |
| 2239 | |
| 2240 buflisted({expr}) *buflisted()* | |
| 2241 The result is a Number, which is non-zero if a buffer called | |
| 2242 {expr} exists and is listed (has the 'buflisted' option set). | |
| 9 | 2243 The {expr} argument is used like with |bufexists()|. |
| 7 | 2244 |
| 2245 bufloaded({expr}) *bufloaded()* | |
| 2246 The result is a Number, which is non-zero if a buffer called | |
| 2247 {expr} exists and is loaded (shown in a window or hidden). | |
| 9 | 2248 The {expr} argument is used like with |bufexists()|. |
| 7 | 2249 |
| 2250 bufname({expr}) *bufname()* | |
| 2251 The result is the name of a buffer, as it is displayed by the | |
| 2252 ":ls" command. | |
| 2253 If {expr} is a Number, that buffer number's name is given. | |
| 2254 Number zero is the alternate buffer for the current window. | |
| 2255 If {expr} is a String, it is used as a |file-pattern| to match | |
| 1621 | 2256 with the buffer names. This is always done like 'magic' is |
| 7 | 2257 set and 'cpoptions' is empty. When there is more than one |
| 2258 match an empty string is returned. | |
| 2259 "" or "%" can be used for the current buffer, "#" for the | |
| 2260 alternate buffer. | |
| 2261 A full match is preferred, otherwise a match at the start, end | |
| 1156 | 2262 or middle of the buffer name is accepted. If you only want a |
| 2263 full match then put "^" at the start and "$" at the end of the | |
| 2264 pattern. | |
| 7 | 2265 Listed buffers are found first. If there is a single match |
| 2266 with a listed buffer, that one is returned. Next unlisted | |
| 2267 buffers are searched for. | |
| 2268 If the {expr} is a String, but you want to use it as a buffer | |
| 2269 number, force it to be a Number by adding zero to it: > | |
| 2270 :echo bufname("3" + 0) | |
| 2271 < If the buffer doesn't exist, or doesn't have a name, an empty | |
| 2272 string is returned. > | |
| 2273 bufname("#") alternate buffer name | |
| 2274 bufname(3) name of buffer 3 | |
| 2275 bufname("%") name of current buffer | |
| 2276 bufname("file2") name of buffer where "file2" matches. | |
| 2277 < *buffer_name()* | |
| 2278 Obsolete name: buffer_name(). | |
| 2279 | |
| 2280 *bufnr()* | |
| 707 | 2281 bufnr({expr} [, {create}]) |
| 2282 The result is the number of a buffer, as it is displayed by | |
| 7 | 2283 the ":ls" command. For the use of {expr}, see |bufname()| |
| 707 | 2284 above. |
| 2285 If the buffer doesn't exist, -1 is returned. Or, if the | |
| 2286 {create} argument is present and not zero, a new, unlisted, | |
| 2287 buffer is created and its number is returned. | |
| 7 | 2288 bufnr("$") is the last buffer: > |
| 2289 :let last_buffer = bufnr("$") | |
| 2290 < The result is a Number, which is the highest buffer number | |
| 2291 of existing buffers. Note that not all buffers with a smaller | |
| 2292 number necessarily exist, because ":bwipeout" may have removed | |
| 2293 them. Use bufexists() to test for the existence of a buffer. | |
| 2294 *buffer_number()* | |
| 2295 Obsolete name: buffer_number(). | |
| 2296 *last_buffer_nr()* | |
| 2297 Obsolete name for bufnr("$"): last_buffer_nr(). | |
| 2298 | |
| 2299 bufwinnr({expr}) *bufwinnr()* | |
| 2300 The result is a Number, which is the number of the first | |
| 2301 window associated with buffer {expr}. For the use of {expr}, | |
| 1621 | 2302 see |bufname()| above. If buffer {expr} doesn't exist or |
| 7 | 2303 there is no such window, -1 is returned. Example: > |
| 2304 | |
| 2305 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
| 2306 | |
| 2307 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
| 2308 |:wincmd|. | |
| 1156 | 2309 Only deals with the current tab page. |
| 7 | 2310 |
| 2311 | |
| 2312 byte2line({byte}) *byte2line()* | |
| 2313 Return the line number that contains the character at byte | |
| 2314 count {byte} in the current buffer. This includes the | |
| 2315 end-of-line character, depending on the 'fileformat' option | |
| 2316 for the current buffer. The first character has byte count | |
| 2317 one. | |
| 2318 Also see |line2byte()|, |go| and |:goto|. | |
| 2319 {not available when compiled without the |+byte_offset| | |
| 2320 feature} | |
| 2321 | |
| 18 | 2322 byteidx({expr}, {nr}) *byteidx()* |
| 2323 Return byte index of the {nr}'th character in the string | |
| 2324 {expr}. Use zero for the first character, it returns zero. | |
| 2325 This function is only useful when there are multibyte | |
| 2326 characters, otherwise the returned value is equal to {nr}. | |
| 5413 | 2327 Composing characters are not counted separately, their byte |
| 2328 length is added to the preceding base character. See | |
| 2329 |byteidxcomp()| below for counting composing characters | |
| 2330 separately. | |
| 18 | 2331 Example : > |
| 2332 echo matchstr(str, ".", byteidx(str, 3)) | |
| 2333 < will display the fourth character. Another way to do the | |
| 2334 same: > | |
| 2335 let s = strpart(str, byteidx(str, 3)) | |
| 2336 echo strpart(s, 0, byteidx(s, 1)) | |
| 2337 < If there are less than {nr} characters -1 is returned. | |
| 2338 If there are exactly {nr} characters the length of the string | |
| 5413 | 2339 in bytes is returned. |
| 2340 | |
| 2341 byteidxcomp({expr}, {nr}) *byteidxcomp()* | |
| 2342 Like byteidx(), except that a composing character is counted | |
| 2343 as a separate character. Example: > | |
| 2344 let s = 'e' . nr2char(0x301) | |
| 2345 echo byteidx(s, 1) | |
| 2346 echo byteidxcomp(s, 1) | |
| 2347 echo byteidxcomp(s, 2) | |
| 2348 < The first and third echo result in 3 ('e' plus composing | |
| 2349 character is 3 bytes), the second echo results in 1 ('e' is | |
| 2350 one byte). | |
| 2351 Only works different from byteidx() when 'encoding' is set to | |
| 2352 a Unicode encoding. | |
| 18 | 2353 |
| 102 | 2354 call({func}, {arglist} [, {dict}]) *call()* *E699* |
| 685 | 2355 Call function {func} with the items in |List| {arglist} as |
| 79 | 2356 arguments. |
| 685 | 2357 {func} can either be a |Funcref| or the name of a function. |
| 79 | 2358 a:firstline and a:lastline are set to the cursor line. |
| 2359 Returns the return value of the called function. | |
| 102 | 2360 {dict} is for functions with the "dict" attribute. It will be |
| 2361 used to set the local variable "self". |Dictionary-function| | |
| 79 | 2362 |
| 1621 | 2363 ceil({expr}) *ceil()* |
| 2364 Return the smallest integral value greater than or equal to | |
| 2365 {expr} as a |Float| (round up). | |
| 2366 {expr} must evaluate to a |Float| or a |Number|. | |
| 2367 Examples: > | |
| 2368 echo ceil(1.456) | |
| 2369 < 2.0 > | |
| 2370 echo ceil(-5.456) | |
| 2371 < -5.0 > | |
| 2372 echo ceil(4.0) | |
| 2373 < 4.0 | |
| 2374 {only available when compiled with the |+float| feature} | |
| 2375 | |
| 777 | 2376 changenr() *changenr()* |
| 2377 Return the number of the most recent change. This is the same | |
| 2378 number as what is displayed with |:undolist| and can be used | |
| 2379 with the |:undo| command. | |
| 2380 When a change was made it is the number of that change. After | |
| 2381 redo it is the number of the redone change. After undo it is | |
| 2382 one less than the number of the undone change. | |
| 2383 | |
| 4051 | 2384 char2nr({expr}[, {utf8}]) *char2nr()* |
| 7 | 2385 Return number value of the first char in {expr}. Examples: > |
| 2386 char2nr(" ") returns 32 | |
| 2387 char2nr("ABC") returns 65 | |
| 4051 | 2388 < When {utf8} is omitted or zero, the current 'encoding' is used. |
| 2389 Example for "utf-8": > | |
| 1156 | 2390 char2nr("á") returns 225 |
| 2391 char2nr("á"[0]) returns 195 | |
| 4051 | 2392 < With {utf8} set to 1, always treat as utf-8 characters. |
| 2393 A combining character is a separate character. | |
| 2965 | 2394 |nr2char()| does the opposite. |
| 7 | 2395 |
| 2396 cindent({lnum}) *cindent()* | |
| 2397 Get the amount of indent for line {lnum} according the C | |
| 2398 indenting rules, as with 'cindent'. | |
| 2399 The indent is counted in spaces, the value of 'tabstop' is | |
| 2400 relevant. {lnum} is used just like in |getline()|. | |
| 2401 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
| 2402 feature, -1 is returned. | |
| 548 | 2403 See |C-indenting|. |
| 7 | 2404 |
| 1326 | 2405 clearmatches() *clearmatches()* |
| 2406 Clears all matches previously defined by |matchadd()| and the | |
| 2407 |:match| commands. | |
| 2408 | |
| 7 | 2409 *col()* |
| 24 | 2410 col({expr}) The result is a Number, which is the byte index of the column |
| 7 | 2411 position given with {expr}. The accepted positions are: |
| 2412 . the cursor position | |
| 2413 $ the end of the cursor line (the result is the | |
| 3513 | 2414 number of bytes in the cursor line plus one) |
| 7 | 2415 'x position of mark x (if the mark is not set, 0 is |
| 2416 returned) | |
| 6447 | 2417 v In Visual mode: the start of the Visual area (the |
| 2418 cursor is the end). When not in Visual mode | |
| 2419 returns the cursor position. Differs from |'<| in | |
| 2420 that it's updated right away. | |
| 1317 | 2421 Additionally {expr} can be [lnum, col]: a |List| with the line |
| 2422 and column number. Most useful when the column is "$", to get | |
| 1621 | 2423 the last column of a specific line. When "lnum" or "col" is |
| 1317 | 2424 out of range then col() returns zero. |
| 1156 | 2425 To get the line number use |line()|. To get both use |
| 703 | 2426 |getpos()|. |
| 7 | 2427 For the screen column position use |virtcol()|. |
| 2428 Note that only marks in the current file can be used. | |
| 2429 Examples: > | |
| 2430 col(".") column of cursor | |
| 2431 col("$") length of cursor line plus one | |
| 2432 col("'t") column of mark t | |
| 2433 col("'" . markname) column of mark markname | |
| 1621 | 2434 < The first column is 1. 0 is returned for an error. |
| 1156 | 2435 For an uppercase mark the column may actually be in another |
| 2436 buffer. | |
| 7 | 2437 For the cursor position, when 'virtualedit' is active, the |
| 2438 column is one higher if the cursor is after the end of the | |
| 2439 line. This can be used to obtain the column in Insert mode: > | |
| 2440 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
| 2441 \<C-O>:set ve=all<CR> | |
| 2442 \<C-O>:echo col(".") . "\n" <Bar> | |
| 2443 \let &ve = save_ve<CR> | |
| 2444 < | |
| 464 | 2445 |
| 724 | 2446 complete({startcol}, {matches}) *complete()* *E785* |
| 2447 Set the matches for Insert mode completion. | |
| 2448 Can only be used in Insert mode. You need to use a mapping | |
| 1156 | 2449 with CTRL-R = |i_CTRL-R|. It does not work after CTRL-O or |
| 2450 with an expression mapping. | |
| 724 | 2451 {startcol} is the byte offset in the line where the completed |
| 2452 text start. The text up to the cursor is the original text | |
| 2453 that will be replaced by the matches. Use col('.') for an | |
| 2454 empty string. "col('.') - 1" will replace one character by a | |
| 2455 match. | |
| 2456 {matches} must be a |List|. Each |List| item is one match. | |
| 2457 See |complete-items| for the kind of items that are possible. | |
| 2458 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
|
2459 inserting anything that would cause completion to stop. |
| 724 | 2460 The match can be selected with CTRL-N and CTRL-P as usual with |
| 2461 Insert mode completion. The popup menu will appear if | |
| 2462 specified, see |ins-completion-menu|. | |
| 2463 Example: > | |
| 1156 | 2464 inoremap <F5> <C-R>=ListMonths()<CR> |
| 724 | 2465 |
| 2466 func! ListMonths() | |
| 2467 call complete(col('.'), ['January', 'February', 'March', | |
| 2468 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
| 2469 \ 'October', 'November', 'December']) | |
| 2470 return '' | |
| 2471 endfunc | |
| 2472 < This isn't very useful, but it shows how it works. Note that | |
| 2473 an empty string is returned to avoid a zero being inserted. | |
| 2474 | |
| 464 | 2475 complete_add({expr}) *complete_add()* |
| 2476 Add {expr} to the list of matches. Only to be used by the | |
| 2477 function specified with the 'completefunc' option. | |
| 2478 Returns 0 for failure (empty string or out of memory), | |
| 2479 1 when the match was added, 2 when the match was already in | |
| 2480 the list. | |
| 1621 | 2481 See |complete-functions| for an explanation of {expr}. It is |
| 786 | 2482 the same as one item in the list that 'omnifunc' would return. |
| 464 | 2483 |
| 2484 complete_check() *complete_check()* | |
| 2485 Check for a key typed while looking for completion matches. | |
| 2486 This is to be used when looking for matches takes some time. | |
| 2487 Returns non-zero when searching for matches is to be aborted, | |
| 2488 zero otherwise. | |
| 2489 Only to be used by the function specified with the | |
| 2490 'completefunc' option. | |
| 2491 | |
| 7 | 2492 *confirm()* |
| 2493 confirm({msg} [, {choices} [, {default} [, {type}]]]) | |
| 2494 Confirm() offers the user a dialog, from which a choice can be | |
| 2495 made. It returns the number of the choice. For the first | |
| 2496 choice this is 1. | |
| 2497 Note: confirm() is only supported when compiled with dialog | |
| 2498 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
|
2499 |
| 7 | 2500 {msg} is displayed in a |dialog| with {choices} as the |
| 2501 alternatives. When {choices} is missing or empty, "&OK" is | |
| 2502 used (and translated). | |
| 2503 {msg} is a String, use '\n' to include a newline. Only on | |
| 2504 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
|
2505 |
| 7 | 2506 {choices} is a String, with the individual choices separated |
| 2507 by '\n', e.g. > | |
| 2508 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
| 2509 < The letter after the '&' is the shortcut key for that choice. | |
| 2510 Thus you can type 'c' to select "Cancel". The shortcut does | |
| 2511 not need to be the first letter: > | |
| 2512 confirm("file has been modified", "&Save\nSave &All") | |
| 2513 < For the console, the first letter of each choice is used as | |
| 2514 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
|
2515 |
| 7 | 2516 The optional {default} argument is the number of the choice |
| 2517 that is made if the user hits <CR>. Use 1 to make the first | |
| 2518 choice the default one. Use 0 to not set a default. If | |
| 2519 {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
|
2520 |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2521 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
|
2522 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
|
2523 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
|
2524 "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
|
2525 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
|
2526 |
| 7 | 2527 If the user aborts the dialog by pressing <Esc>, CTRL-C, |
| 2528 or another valid interrupt key, confirm() returns 0. | |
| 2529 | |
| 2530 An example: > | |
| 2531 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
| 2532 :if choice == 0 | |
| 2533 : echo "make up your mind!" | |
| 2534 :elseif choice == 3 | |
| 2535 : echo "tasteful" | |
| 2536 :else | |
| 2537 : echo "I prefer bananas myself." | |
| 2538 :endif | |
| 2539 < In a GUI dialog, buttons are used. The layout of the buttons | |
| 2540 depends on the 'v' flag in 'guioptions'. If it is included, | |
| 1621 | 2541 the buttons are always put vertically. Otherwise, confirm() |
| 7 | 2542 tries to put the buttons in one horizontal line. If they |
| 2543 don't fit, a vertical layout is used anyway. For some systems | |
| 2544 the horizontal layout is always used. | |
| 2545 | |
| 55 | 2546 *copy()* |
| 1621 | 2547 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 2548 different from using {expr} directly. |
| 685 | 2549 When {expr} is a |List| a shallow copy is created. This means |
| 2550 that the original |List| can be changed without changing the | |
| 1621 | 2551 copy, and vice versa. But the items are identical, thus |
| 2552 changing an item changes the contents of both |Lists|. Also | |
| 685 | 2553 see |deepcopy()|. |
| 55 | 2554 |
| 1621 | 2555 cos({expr}) *cos()* |
| 2556 Return the cosine of {expr}, measured in radians, as a |Float|. | |
| 2557 {expr} must evaluate to a |Float| or a |Number|. | |
| 2558 Examples: > | |
| 2559 :echo cos(100) | |
| 2560 < 0.862319 > | |
| 2561 :echo cos(-4.01) | |
| 2562 < -0.646043 | |
| 2563 {only available when compiled with the |+float| feature} | |
| 2564 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2565 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2566 cosh({expr}) *cosh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2567 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
|
2568 [1, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2569 {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
|
2570 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2571 :echo cosh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2572 < 1.127626 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2573 :echo cosh(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2574 < -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
|
2575 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2576 |
| 1621 | 2577 |
| 102 | 2578 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
| 79 | 2579 Return the number of times an item with value {expr} appears |
| 685 | 2580 in |List| or |Dictionary| {comp}. |
| 102 | 2581 If {start} is given then start with the item with this index. |
| 685 | 2582 {start} can only be used with a |List|. |
| 79 | 2583 When {ic} is given and it's non-zero then case is ignored. |
| 2584 | |
| 2585 | |
| 7 | 2586 *cscope_connection()* |
| 2587 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
| 2588 Checks for the existence of a |cscope| connection. If no | |
| 2589 parameters are specified, then the function returns: | |
| 2590 0, if cscope was not available (not compiled in), or | |
| 2591 if there are no cscope connections; | |
| 2592 1, if there is at least one cscope connection. | |
| 2593 | |
| 2594 If parameters are specified, then the value of {num} | |
| 2595 determines how existence of a cscope connection is checked: | |
| 2596 | |
| 2597 {num} Description of existence check | |
| 2598 ----- ------------------------------ | |
| 2599 0 Same as no parameters (e.g., "cscope_connection()"). | |
| 2600 1 Ignore {prepend}, and use partial string matches for | |
| 2601 {dbpath}. | |
| 2602 2 Ignore {prepend}, and use exact string matches for | |
| 2603 {dbpath}. | |
| 2604 3 Use {prepend}, use partial string matches for both | |
| 2605 {dbpath} and {prepend}. | |
| 2606 4 Use {prepend}, use exact string matches for both | |
| 2607 {dbpath} and {prepend}. | |
| 2608 | |
| 2609 Note: All string comparisons are case sensitive! | |
| 2610 | |
| 2611 Examples. Suppose we had the following (from ":cs show"): > | |
| 2612 | |
| 2613 # pid database name prepend path | |
| 2614 0 27664 cscope.out /usr/local | |
| 2615 < | |
| 2616 Invocation Return Val ~ | |
| 2617 ---------- ---------- > | |
| 2618 cscope_connection() 1 | |
| 2619 cscope_connection(1, "out") 1 | |
| 2620 cscope_connection(2, "out") 0 | |
| 2621 cscope_connection(3, "out") 0 | |
| 2622 cscope_connection(3, "out", "local") 1 | |
| 2623 cscope_connection(4, "out") 0 | |
| 2624 cscope_connection(4, "out", "local") 0 | |
| 2625 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
| 2626 < | |
| 703 | 2627 cursor({lnum}, {col} [, {off}]) *cursor()* |
| 2628 cursor({list}) | |
| 1156 | 2629 Positions the cursor at the column (byte count) {col} in the |
| 2630 line {lnum}. The first column is one. | |
| 5938 | 2631 |
| 703 | 2632 When there is one argument {list} this is used as a |List| |
| 5938 | 2633 with two, three or four item: |
| 2634 [{lnum}, {col}, {off}] | |
| 2635 [{lnum}, {col}, {off}, {curswant}] | |
| 6009 | 2636 This is like the return value of |getpos()| or |getcurpos()|, |
| 5944 | 2637 but without the first item. |
| 5938 | 2638 |
| 7 | 2639 Does not change the jumplist. |
| 2640 If {lnum} is greater than the number of lines in the buffer, | |
| 2641 the cursor will be positioned at the last line in the buffer. | |
| 2642 If {lnum} is zero, the cursor will stay in the current line. | |
| 493 | 2643 If {col} is greater than the number of bytes in the line, |
| 7 | 2644 the cursor will be positioned at the last character in the |
| 2645 line. | |
| 2646 If {col} is zero, the cursor will stay in the current column. | |
| 5944 | 2647 If {curswant} is given it is used to set the preferred column |
| 6180 | 2648 for vertical movement. Otherwise {col} is used. |
| 6385 | 2649 |
| 703 | 2650 When 'virtualedit' is used {off} specifies the offset in |
| 2651 screen columns from the start of the character. E.g., a | |
| 1266 | 2652 position within a <Tab> or after the last character. |
| 1851 | 2653 Returns 0 when the position could be set, -1 otherwise. |
| 7 | 2654 |
| 55 | 2655 |
| 164 | 2656 deepcopy({expr}[, {noref}]) *deepcopy()* *E698* |
| 1621 | 2657 Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 2658 different from using {expr} directly. |
| 685 | 2659 When {expr} is a |List| a full copy is created. This means |
| 2660 that the original |List| can be changed without changing the | |
| 1621 | 2661 copy, and vice versa. When an item is a |List|, a copy for it |
| 55 | 2662 is made, recursively. Thus changing an item in the copy does |
| 685 | 2663 not change the contents of the original |List|. |
| 2664 When {noref} is omitted or zero a contained |List| or | |
| 2665 |Dictionary| is only copied once. All references point to | |
| 2666 this single copy. With {noref} set to 1 every occurrence of a | |
| 2667 |List| or |Dictionary| results in a new copy. This also means | |
| 2668 that a cyclic reference causes deepcopy() to fail. | |
| 114 | 2669 *E724* |
| 2670 Nesting is possible up to 100 levels. When there is an item | |
| 164 | 2671 that refers back to a higher level making a deep copy with |
| 2672 {noref} set to 1 will fail. | |
| 55 | 2673 Also see |copy()|. |
| 2674 | |
| 2675 delete({fname}) *delete()* | |
| 2676 Deletes the file by the name {fname}. The result is a Number, | |
| 7 | 2677 which is 0 if the file was deleted successfully, and non-zero |
| 2678 when the deletion failed. | |
| 685 | 2679 Use |remove()| to delete an item from a |List|. |
| 4229 | 2680 To delete a line from the buffer use |:delete|. Use |:exe| |
| 2681 when the line number is in a variable. | |
| 7 | 2682 |
| 2683 *did_filetype()* | |
| 2684 did_filetype() Returns non-zero when autocommands are being executed and the | |
| 2685 FileType event has been triggered at least once. Can be used | |
| 2686 to avoid triggering the FileType event again in the scripts | |
| 2687 that detect the file type. |FileType| | |
| 2688 When editing another file, the counter is reset, thus this | |
| 2689 really checks if the FileType event has been triggered for the | |
| 2690 current buffer. This allows an autocommand that starts | |
| 2691 editing another buffer to set 'filetype' and load a syntax | |
| 2692 file. | |
| 2693 | |
| 32 | 2694 diff_filler({lnum}) *diff_filler()* |
| 2695 Returns the number of filler lines above line {lnum}. | |
| 2696 These are the lines that were inserted at this point in | |
| 2697 another diff'ed window. These filler lines are shown in the | |
| 2698 display but don't exist in the buffer. | |
| 2699 {lnum} is used like with |getline()|. Thus "." is the current | |
| 2700 line, "'m" mark m, etc. | |
| 2701 Returns 0 if the current window is not in diff mode. | |
| 2702 | |
| 2703 diff_hlID({lnum}, {col}) *diff_hlID()* | |
| 2704 Returns the highlight ID for diff mode at line {lnum} column | |
| 2705 {col} (byte index). When the current line does not have a | |
| 2706 diff change zero is returned. | |
| 2707 {lnum} is used like with |getline()|. Thus "." is the current | |
| 2708 line, "'m" mark m, etc. | |
| 2709 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
| 2710 line. | |
| 2711 The highlight ID can be used with |synIDattr()| to obtain | |
| 2712 syntax information about the highlighting. | |
| 2713 | |
| 85 | 2714 empty({expr}) *empty()* |
| 2715 Return the Number 1 if {expr} is empty, zero otherwise. | |
| 685 | 2716 A |List| or |Dictionary| is empty when it does not have any |
| 1621 | 2717 items. A Number is empty when its value is zero. |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2718 For a long |List| this is much faster than comparing the |
| 685 | 2719 length with zero. |
| 85 | 2720 |
| 7 | 2721 escape({string}, {chars}) *escape()* |
| 2722 Escape the characters in {chars} that occur in {string} with a | |
| 2723 backslash. Example: > | |
| 2724 :echo escape('c:\program files\vim', ' \') | |
| 2725 < results in: > | |
| 2726 c:\\program\ files\\vim | |
| 1621 | 2727 < Also see |shellescape()|. |
| 2728 | |
| 2729 *eval()* | |
| 95 | 2730 eval({string}) Evaluate {string} and return the result. Especially useful to |
| 2731 turn the result of |string()| back into the original value. | |
| 1621 | 2732 This works for Numbers, Floats, Strings and composites of |
| 2733 them. Also works for |Funcref|s that refer to existing | |
| 2734 functions. | |
| 95 | 2735 |
| 7 | 2736 eventhandler() *eventhandler()* |
| 2737 Returns 1 when inside an event handler. That is that Vim got | |
| 2738 interrupted while waiting for the user to type a character, | |
| 2739 e.g., when dropping a file on Vim. This means interactive | |
| 2740 commands cannot be used. Otherwise zero is returned. | |
| 2741 | |
| 2742 executable({expr}) *executable()* | |
| 2743 This function checks if an executable with the name {expr} | |
| 2744 exists. {expr} must be the name of the program without any | |
| 10 | 2745 arguments. |
| 2746 executable() uses the value of $PATH and/or the normal | |
| 2747 searchpath for programs. *PATHEXT* | |
| 2748 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can | |
| 2749 optionally be included. Then the extensions in $PATHEXT are | |
| 1621 | 2750 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be |
| 2751 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is | |
| 10 | 2752 used. A dot by itself can be used in $PATHEXT to try using |
| 1621 | 2753 the name without an extension. When 'shell' looks like a |
| 10 | 2754 Unix shell, then the name is also tried without adding an |
| 2755 extension. | |
| 2756 On MS-DOS and MS-Windows it only checks if the file exists and | |
| 2757 is not a directory, not if it's really executable. | |
| 819 | 2758 On MS-Windows an executable in the same directory as Vim is |
| 2759 always found. Since this directory is added to $PATH it | |
| 2760 should also work to execute it |win32-PATH|. | |
| 7 | 2761 The result is a Number: |
| 2762 1 exists | |
| 2763 0 does not exist | |
| 2764 -1 not implemented on this system | |
| 2765 | |
| 5782 | 2766 exepath({expr}) *exepath()* |
| 2767 If {expr} is an executable and is either an absolute path, a | |
| 2768 relative path or found in $PATH, return the full path. | |
| 2769 Note that the current directory is used when {expr} starts | |
| 2770 with "./", which may be a problem for Vim: > | |
| 2771 echo exepath(v:progpath) | |
| 5814 | 2772 < If {expr} cannot be found in $PATH or is not executable then |
| 5782 | 2773 an empty string is returned. |
| 2774 | |
| 7 | 2775 *exists()* |
| 2776 exists({expr}) The result is a Number, which is non-zero if {expr} is | |
| 2777 defined, zero otherwise. The {expr} argument is a string, | |
| 2778 which contains one of these: | |
| 2779 &option-name Vim option (only checks if it exists, | |
| 2780 not if it really works) | |
| 2781 +option-name Vim option that works. | |
| 2782 $ENVNAME environment variable (could also be | |
| 2783 done by comparing with an empty | |
| 2784 string) | |
| 2785 *funcname built-in function (see |functions|) | |
| 2786 or user defined function (see | |
| 5862 | 2787 |user-functions|). Also works for a |
| 2788 variable that is a Funcref. | |
| 7 | 2789 varname internal variable (see |
| 1621 | 2790 |internal-variables|). Also works |
| 685 | 2791 for |curly-braces-names|, |Dictionary| |
| 2792 entries, |List| items, etc. Beware | |
| 1668 | 2793 that evaluating an index may cause an |
| 2794 error message for an invalid | |
| 2795 expression. E.g.: > | |
| 2796 :let l = [1, 2, 3] | |
| 2797 :echo exists("l[5]") | |
| 2798 < 0 > | |
| 2799 :echo exists("l[xx]") | |
| 2800 < E121: Undefined variable: xx | |
| 2801 0 | |
| 7 | 2802 :cmdname Ex command: built-in command, user |
| 2803 command or command modifier |:command|. | |
| 2804 Returns: | |
| 2805 1 for match with start of a command | |
| 2806 2 full match with a command | |
| 2807 3 matches several user commands | |
| 2808 To check for a supported command | |
| 2809 always check the return value to be 2. | |
| 864 | 2810 :2match The |:2match| command. |
| 2811 :3match The |:3match| command. | |
| 7 | 2812 #event autocommand defined for this event |
| 2813 #event#pattern autocommand defined for this event and | |
| 2814 pattern (the pattern is taken | |
| 2815 literally and compared to the | |
| 2816 autocommand patterns character by | |
| 2817 character) | |
| 613 | 2818 #group autocommand group exists |
| 2819 #group#event autocommand defined for this group and | |
| 2820 event. | |
| 2821 #group#event#pattern | |
| 856 | 2822 autocommand defined for this group, |
| 613 | 2823 event and pattern. |
| 615 | 2824 ##event autocommand for this event is |
| 2825 supported. | |
| 7 | 2826 For checking for a supported feature use |has()|. |
| 2827 | |
| 2828 Examples: > | |
| 2829 exists("&shortname") | |
| 2830 exists("$HOSTNAME") | |
| 2831 exists("*strftime") | |
| 2832 exists("*s:MyFunc") | |
| 2833 exists("bufcount") | |
| 2834 exists(":Make") | |
| 613 | 2835 exists("#CursorHold") |
| 7 | 2836 exists("#BufReadPre#*.gz") |
| 613 | 2837 exists("#filetypeindent") |
| 2838 exists("#filetypeindent#FileType") | |
| 2839 exists("#filetypeindent#FileType#*") | |
| 615 | 2840 exists("##ColorScheme") |
| 7 | 2841 < There must be no space between the symbol (&/$/*/#) and the |
| 2842 name. | |
| 867 | 2843 There must be no extra characters after the name, although in |
| 2844 a few cases this is ignored. That may become more strict in | |
| 2845 the future, thus don't count on it! | |
| 2846 Working example: > | |
| 2847 exists(":make") | |
| 2848 < NOT working example: > | |
| 2849 exists(":make install") | |
| 859 | 2850 |
| 2851 < Note that the argument must be a string, not the name of the | |
| 2852 variable itself. For example: > | |
| 7 | 2853 exists(bufcount) |
| 2854 < This doesn't check for existence of the "bufcount" variable, | |
| 853 | 2855 but gets the value of "bufcount", and checks if that exists. |
| 7 | 2856 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2857 exp({expr}) *exp()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2858 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
|
2859 [0, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2860 {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
|
2861 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2862 :echo exp(2) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2863 < 7.389056 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2864 :echo exp(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2865 < 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
|
2866 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2867 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2868 |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
2869 expand({expr} [, {nosuf} [, {list}]]) *expand()* |
| 7 | 2870 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
|
2871 'wildignorecase' applies. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
2872 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
2873 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
|
2874 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
|
2875 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
|
2876 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
|
2877 file name contains a space] |
| 7 | 2878 |
| 1621 | 2879 If the expansion fails, the result is an empty string. A name |
| 4869 | 2880 for a non-existing file is not included, unless {expr} does |
| 2881 not start with '%', '#' or '<', see below. | |
| 7 | 2882 |
| 2883 When {expr} starts with '%', '#' or '<', the expansion is done | |
| 2884 like for the |cmdline-special| variables with their associated | |
| 2885 modifiers. Here is a short overview: | |
| 2886 | |
| 2887 % current file name | |
| 2888 # alternate file name | |
| 2889 #n alternate file name n | |
| 2890 <cfile> file name under the cursor | |
| 2891 <afile> autocmd file name | |
| 2892 <abuf> autocmd buffer number (as a String!) | |
| 2893 <amatch> autocmd matched name | |
| 5734 | 2894 <sfile> sourced script file or function name |
| 2662 | 2895 <slnum> sourced script file line number |
| 7 | 2896 <cword> word under the cursor |
| 2897 <cWORD> WORD under the cursor | |
| 2898 <client> the {clientid} of the last received | |
| 2899 message |server2client()| | |
| 2900 Modifiers: | |
| 2901 :p expand to full path | |
| 2902 :h head (last path component removed) | |
| 2903 :t tail (last path component only) | |
| 2904 :r root (one extension removed) | |
| 2905 :e extension only | |
| 2906 | |
| 2907 Example: > | |
| 2908 :let &tags = expand("%:p:h") . "/tags" | |
| 2909 < Note that when expanding a string that starts with '%', '#' or | |
| 2910 '<', any following text is ignored. This does NOT work: > | |
| 2911 :let doesntwork = expand("%:h.bak") | |
| 2912 < Use this: > | |
| 2913 :let doeswork = expand("%:h") . ".bak" | |
| 2914 < Also note that expanding "<cfile>" and others only returns the | |
| 2915 referenced file name without further expansion. If "<cfile>" | |
| 2916 is "~/.cshrc", you need to do another expand() to have the | |
| 2917 "~/" expanded into the path of the home directory: > | |
| 2918 :echo expand(expand("<cfile>")) | |
| 2919 < | |
| 2920 There cannot be white space between the variables and the | |
| 2921 following modifier. The |fnamemodify()| function can be used | |
| 2922 to modify normal file names. | |
| 2923 | |
| 2924 When using '%' or '#', and the current or alternate file name | |
| 2925 is not defined, an empty string is used. Using "%:p" in a | |
| 2926 buffer with no name, results in the current directory, with a | |
| 2927 '/' added. | |
| 2928 | |
| 2929 When {expr} does not start with '%', '#' or '<', it is | |
| 2930 expanded like a file name is expanded on the command line. | |
| 2931 'suffixes' and 'wildignore' are used, unless the optional | |
| 3398 | 2932 {nosuf} argument is given and it is non-zero. |
| 2933 Names for non-existing files are included. The "**" item can | |
| 2934 be used to search in a directory tree. For example, to find | |
| 2935 all "README" files in the current directory and below: > | |
| 444 | 2936 :echo expand("**/README") |
| 2937 < | |
| 7 | 2938 Expand() can also be used to expand variables and environment |
| 2939 variables that are only known in a shell. But this can be | |
| 6180 | 2940 slow, because a shell may be used to do the expansion. See |
| 2941 |expr-env-expand|. | |
| 7 | 2942 The expanded variable is still handled like a list of file |
| 1621 | 2943 names. When an environment variable cannot be expanded, it is |
| 7 | 2944 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
| 2945 "$FOOBAR". | |
| 2946 | |
| 2947 See |glob()| for finding existing files. See |system()| for | |
| 2948 getting the raw output of an external command. | |
| 2949 | |
| 102 | 2950 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
| 692 | 2951 {expr1} and {expr2} must be both |Lists| or both |
| 2952 |Dictionaries|. | |
| 2953 | |
| 2954 If they are |Lists|: Append {expr2} to {expr1}. | |
| 102 | 2955 If {expr3} is given insert the items of {expr2} before item |
| 2956 {expr3} in {expr1}. When {expr3} is zero insert before the | |
| 2957 first item. When {expr3} is equal to len({expr1}) then | |
| 2958 {expr2} is appended. | |
| 79 | 2959 Examples: > |
| 2960 :echo sort(extend(mylist, [7, 5])) | |
| 2961 :call extend(mylist, [2, 3], 1) | |
| 1699 | 2962 < When {expr1} is the same List as {expr2} then the number of |
| 2963 items copied is equal to the original length of the List. | |
| 2964 E.g., when {expr3} is 1 you get N new copies of the first item | |
| 2965 (where N is the original length of the List). | |
| 2966 Use |add()| to concatenate one item to a list. To concatenate | |
| 82 | 2967 two lists into a new list use the + operator: > |
| 79 | 2968 :let newlist = [1, 2, 3] + [4, 5] |
| 102 | 2969 < |
| 692 | 2970 If they are |Dictionaries|: |
| 102 | 2971 Add all entries from {expr2} to {expr1}. |
| 2972 If a key exists in both {expr1} and {expr2} then {expr3} is | |
| 2973 used to decide what to do: | |
| 2974 {expr3} = "keep": keep the value of {expr1} | |
| 2975 {expr3} = "force": use the value of {expr2} | |
| 856 | 2976 {expr3} = "error": give an error message *E737* |
| 102 | 2977 When {expr3} is omitted then "force" is assumed. |
| 2978 | |
| 2979 {expr1} is changed when {expr2} is not empty. If necessary | |
| 2980 make a copy of {expr1} first. | |
| 2981 {expr2} remains unchanged. | |
| 6823 | 2982 When {expr1} is locked and {expr2} is not empty the operation |
| 2983 fails. | |
| 102 | 2984 Returns {expr1}. |
| 2985 | |
| 79 | 2986 |
| 842 | 2987 feedkeys({string} [, {mode}]) *feedkeys()* |
| 2988 Characters in {string} are queued for processing as if they | |
| 6549 | 2989 come from a mapping or were typed by the user. |
| 2990 By default the string is added to the end of the typeahead | |
| 2991 buffer, thus if a mapping is still being executed the | |
| 2992 characters come after them. Use the 'i' flag to insert before | |
| 2993 other characters, they will be executed next, before any | |
| 2994 characters from a mapping. | |
| 842 | 2995 The function does not wait for processing of keys contained in |
| 2996 {string}. | |
| 2997 To include special keys into {string}, use double-quotes | |
| 2998 and "\..." notation |expr-quote|. For example, | |
| 1215 | 2999 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
| 842 | 3000 feedkeys('\<CR>') pushes 5 characters. |
| 3001 If {mode} is absent, keys are remapped. | |
| 3002 {mode} is a String, which can contain these character flags: | |
| 843 | 3003 'm' Remap keys. This is default. |
| 3004 'n' Do not remap keys. | |
| 3005 't' Handle keys as if typed; otherwise they are handled as | |
| 3006 if coming from a mapping. This matters for undo, | |
| 3007 opening folds, etc. | |
| 6549 | 3008 'i' Insert the string instead of appending (see above). |
| 842 | 3009 Return value is always 0. |
| 3010 | |
| 7 | 3011 filereadable({file}) *filereadable()* |
| 3012 The result is a Number, which is TRUE when a file with the | |
| 3013 name {file} exists, and can be read. If {file} doesn't exist, | |
| 3014 or is a directory, the result is FALSE. {file} is any | |
| 3015 expression, which is used as a String. | |
| 1156 | 3016 If you don't care about the file being readable you can use |
| 3017 |glob()|. | |
| 7 | 3018 *file_readable()* |
| 3019 Obsolete name: file_readable(). | |
| 3020 | |
| 95 | 3021 |
| 1156 | 3022 filewritable({file}) *filewritable()* |
| 3023 The result is a Number, which is 1 when a file with the | |
| 3024 name {file} exists, and can be written. If {file} doesn't | |
| 1621 | 3025 exist, or is not writable, the result is 0. If {file} is a |
| 1156 | 3026 directory, and we can write to it, the result is 2. |
| 3027 | |
| 3028 | |
| 102 | 3029 filter({expr}, {string}) *filter()* |
| 685 | 3030 {expr} must be a |List| or a |Dictionary|. |
| 102 | 3031 For each item in {expr} evaluate {string} and when the result |
| 685 | 3032 is zero remove the item from the |List| or |Dictionary|. |
| 102 | 3033 Inside {string} |v:val| has the value of the current item. |
| 685 | 3034 For a |Dictionary| |v:key| has the key of the current item. |
| 102 | 3035 Examples: > |
| 3036 :call filter(mylist, 'v:val !~ "OLD"') | |
| 3037 < Removes the items where "OLD" appears. > | |
| 3038 :call filter(mydict, 'v:key >= 8') | |
| 3039 < Removes the items with a key below 8. > | |
| 3040 :call filter(var, 0) | |
| 685 | 3041 < Removes all the items, thus clears the |List| or |Dictionary|. |
| 99 | 3042 |
| 102 | 3043 Note that {string} is the result of expression and is then |
| 3044 used as an expression again. Often it is good to use a | |
| 3045 |literal-string| to avoid having to double backslashes. | |
| 3046 | |
| 685 | 3047 The operation is done in-place. If you want a |List| or |
| 3048 |Dictionary| to remain unmodified make a copy first: > | |
| 650 | 3049 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
| 102 | 3050 |
| 685 | 3051 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
| 648 | 3052 When an error is encountered while evaluating {string} no |
| 3053 further items in {expr} are processed. | |
| 95 | 3054 |
| 3055 | |
| 19 | 3056 finddir({name}[, {path}[, {count}]]) *finddir()* |
| 1095 | 3057 Find directory {name} in {path}. Supports both downwards and |
| 3058 upwards recursive directory searches. See |file-searching| | |
| 3059 for the syntax of {path}. | |
| 3060 Returns the path of the first found match. When the found | |
| 3061 directory is below the current directory a relative path is | |
| 3062 returned. Otherwise a full path is returned. | |
| 19 | 3063 If {path} is omitted or empty then 'path' is used. |
| 3064 If the optional {count} is given, find {count}'s occurrence of | |
| 794 | 3065 {name} in {path} instead of the first one. |
| 809 | 3066 When {count} is negative return all the matches in a |List|. |
| 19 | 3067 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
|
3068 {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
|
3069 feature} |
| 794 | 3070 |
| 3071 findfile({name}[, {path}[, {count}]]) *findfile()* | |
| 3072 Just like |finddir()|, but find a file instead of a directory. | |
| 3073 Uses 'suffixesadd'. | |
| 19 | 3074 Example: > |
| 3075 :echo findfile("tags.vim", ".;") | |
| 1156 | 3076 < Searches from the directory of the current file upwards until |
| 3077 it finds the file "tags.vim". | |
| 7 | 3078 |
| 1621 | 3079 float2nr({expr}) *float2nr()* |
| 3080 Convert {expr} to a Number by omitting the part after the | |
| 3081 decimal point. | |
| 3082 {expr} must evaluate to a |Float| or a Number. | |
| 3083 When the value of {expr} is out of range for a |Number| the | |
| 3084 result is truncated to 0x7fffffff or -0x7fffffff. NaN results | |
| 3085 in -0x80000000. | |
| 3086 Examples: > | |
| 3087 echo float2nr(3.95) | |
| 3088 < 3 > | |
| 3089 echo float2nr(-23.45) | |
| 3090 < -23 > | |
| 3091 echo float2nr(1.0e100) | |
| 3092 < 2147483647 > | |
| 3093 echo float2nr(-1.0e150) | |
| 3094 < -2147483647 > | |
| 3095 echo float2nr(1.0e-100) | |
| 3096 < 0 | |
| 3097 {only available when compiled with the |+float| feature} | |
| 3098 | |
| 3099 | |
| 3100 floor({expr}) *floor()* | |
| 3101 Return the largest integral value less than or equal to | |
| 3102 {expr} as a |Float| (round down). | |
| 3103 {expr} must evaluate to a |Float| or a |Number|. | |
| 3104 Examples: > | |
| 3105 echo floor(1.856) | |
| 3106 < 1.0 > | |
| 3107 echo floor(-5.456) | |
| 3108 < -6.0 > | |
| 3109 echo floor(4.0) | |
| 3110 < 4.0 | |
| 3111 {only available when compiled with the |+float| feature} | |
| 3112 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3113 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3114 fmod({expr1}, {expr2}) *fmod()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3115 Return the remainder of {expr1} / {expr2}, even if the |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3116 division is not representable. Returns {expr1} - i * {expr2} |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3117 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
|
3118 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
|
3119 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
|
3120 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
|
3121 {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
|
3122 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3123 :echo fmod(12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3124 < 0.13 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3125 :echo fmod(-12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3126 < -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
|
3127 {only available when compiled with |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3128 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3129 |
| 1586 | 3130 fnameescape({string}) *fnameescape()* |
| 1621 | 3131 Escape {string} for use as file name command argument. All |
| 1586 | 3132 characters that have a special meaning, such as '%' and '|' |
| 3133 are escaped with a backslash. | |
| 1621 | 3134 For most systems the characters escaped are |
| 3135 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
| 3136 appears in a filename, it depends on the value of 'isfname'. | |
| 1700 | 3137 A leading '+' and '>' is also escaped (special after |:edit| |
| 3138 and |:write|). And a "-" by itself (special after |:cd|). | |
| 1586 | 3139 Example: > |
| 1700 | 3140 :let fname = '+some str%nge|name' |
| 1586 | 3141 :exe "edit " . fnameescape(fname) |
| 3142 < results in executing: > | |
| 1700 | 3143 edit \+some\ str\%nge\|name |
| 1586 | 3144 |
| 7 | 3145 fnamemodify({fname}, {mods}) *fnamemodify()* |
| 3146 Modify file name {fname} according to {mods}. {mods} is a | |
| 3147 string of characters like it is used for file names on the | |
| 3148 command line. See |filename-modifiers|. | |
| 3149 Example: > | |
| 3150 :echo fnamemodify("main.c", ":p:h") | |
| 3151 < results in: > | |
| 3152 /home/mool/vim/vim/src | |
| 1621 | 3153 < Note: Environment variables don't work in {fname}, use |
| 7 | 3154 |expand()| first then. |
| 3155 | |
| 3156 foldclosed({lnum}) *foldclosed()* | |
| 3157 The result is a Number. If the line {lnum} is in a closed | |
| 3158 fold, the result is the number of the first line in that fold. | |
| 3159 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 3160 | |
| 3161 foldclosedend({lnum}) *foldclosedend()* | |
| 3162 The result is a Number. If the line {lnum} is in a closed | |
| 3163 fold, the result is the number of the last line in that fold. | |
| 3164 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 3165 | |
| 3166 foldlevel({lnum}) *foldlevel()* | |
| 3167 The result is a Number, which is the foldlevel of line {lnum} | |
| 1621 | 3168 in the current buffer. For nested folds the deepest level is |
| 7 | 3169 returned. If there is no fold at line {lnum}, zero is |
| 3170 returned. It doesn't matter if the folds are open or closed. | |
| 3171 When used while updating folds (from 'foldexpr') -1 is | |
| 3172 returned for lines where folds are still to be updated and the | |
| 3173 foldlevel is unknown. As a special case the level of the | |
| 3174 previous line is usually available. | |
| 3175 | |
| 3176 *foldtext()* | |
| 3177 foldtext() Returns a String, to be displayed for a closed fold. This is | |
| 3178 the default function used for the 'foldtext' option and should | |
| 3179 only be called from evaluating 'foldtext'. It uses the | |
| 3180 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
| 3181 The returned string looks like this: > | |
| 3182 +-- 45 lines: abcdef | |
| 1621 | 3183 < The number of dashes depends on the foldlevel. The "45" is |
| 7 | 3184 the number of lines in the fold. "abcdef" is the text in the |
| 3185 first non-blank line of the fold. Leading white space, "//" | |
| 3186 or "/*" and the text from the 'foldmarker' and 'commentstring' | |
| 3187 options is removed. | |
| 3188 {not available when compiled without the |+folding| feature} | |
| 3189 | |
| 29 | 3190 foldtextresult({lnum}) *foldtextresult()* |
| 3191 Returns the text that is displayed for the closed fold at line | |
| 3192 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
| 3193 When there is no closed fold at {lnum} an empty string is | |
| 3194 returned. | |
| 3195 {lnum} is used like with |getline()|. Thus "." is the current | |
| 3196 line, "'m" mark m, etc. | |
| 3197 Useful when exporting folded text, e.g., to HTML. | |
| 3198 {not available when compiled without the |+folding| feature} | |
| 3199 | |
| 7 | 3200 *foreground()* |
| 1621 | 3201 foreground() Move the Vim window to the foreground. Useful when sent from |
| 7 | 3202 a client to a Vim server. |remote_send()| |
| 3203 On Win32 systems this might not work, the OS does not always | |
| 3204 allow a window to bring itself to the foreground. Use | |
| 3205 |remote_foreground()| instead. | |
| 3206 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 3207 Win32 console version} | |
| 3208 | |
| 82 | 3209 |
| 85 | 3210 function({name}) *function()* *E700* |
| 685 | 3211 Return a |Funcref| variable that refers to function {name}. |
| 55 | 3212 {name} can be a user defined function or an internal function. |
| 3213 | |
| 82 | 3214 |
| 3224 | 3215 garbagecollect([{atexit}]) *garbagecollect()* |
| 692 | 3216 Cleanup unused |Lists| and |Dictionaries| that have circular |
| 370 | 3217 references. There is hardly ever a need to invoke this |
| 3218 function, as it is automatically done when Vim runs out of | |
| 3219 memory or is waiting for the user to press a key after | |
| 3220 'updatetime'. Items without circular references are always | |
| 3221 freed when they become unused. | |
| 685 | 3222 This is useful if you have deleted a very big |List| and/or |
| 3223 |Dictionary| with circular references in a script that runs | |
| 3224 for a long time. | |
| 3224 | 3225 When the optional {atexit} argument is one, garbage |
| 1405 | 3226 collection will also be done when exiting Vim, if it wasn't |
| 3227 done before. This is useful when checking for memory leaks. | |
| 370 | 3228 |
| 140 | 3229 get({list}, {idx} [, {default}]) *get()* |
| 685 | 3230 Get item {idx} from |List| {list}. When this item is not |
| 82 | 3231 available return {default}. Return zero when {default} is |
| 3232 omitted. | |
| 102 | 3233 get({dict}, {key} [, {default}]) |
| 685 | 3234 Get item with key {key} from |Dictionary| {dict}. When this |
| 102 | 3235 item is not available return {default}. Return zero when |
| 3236 {default} is omitted. | |
| 3237 | |
| 435 | 3238 *getbufline()* |
| 3239 getbufline({expr}, {lnum} [, {end}]) | |
| 685 | 3240 Return a |List| with the lines starting from {lnum} to {end} |
| 3241 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
| 3242 |List| with only the line {lnum} is returned. | |
| 435 | 3243 |
| 3244 For the use of {expr}, see |bufname()| above. | |
| 3245 | |
| 448 | 3246 For {lnum} and {end} "$" can be used for the last line of the |
| 3247 buffer. Otherwise a number must be used. | |
| 435 | 3248 |
| 3249 When {lnum} is smaller than 1 or bigger than the number of | |
| 685 | 3250 lines in the buffer, an empty |List| is returned. |
| 435 | 3251 |
| 3252 When {end} is greater than the number of lines in the buffer, | |
| 3253 it is treated as {end} is set to the number of lines in the | |
| 685 | 3254 buffer. When {end} is before {lnum} an empty |List| is |
| 435 | 3255 returned. |
| 3256 | |
| 448 | 3257 This function works only for loaded buffers. For unloaded and |
| 685 | 3258 non-existing buffers, an empty |List| is returned. |
| 435 | 3259 |
| 3260 Example: > | |
| 3261 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
| 82 | 3262 |
| 4157 | 3263 getbufvar({expr}, {varname} [, {def}]) *getbufvar()* |
| 82 | 3264 The result is the value of option or local buffer variable |
| 3265 {varname} in buffer {expr}. Note that the name without "b:" | |
| 3266 must be used. | |
| 1668 | 3267 When {varname} is empty returns a dictionary with all the |
| 3268 buffer-local variables. | |
| 216 | 3269 This also works for a global or buffer-local option, but it |
| 3270 doesn't work for a global variable, window-local variable or | |
| 3271 window-local option. | |
| 82 | 3272 For the use of {expr}, see |bufname()| above. |
| 4157 | 3273 When the buffer or variable doesn't exist {def} or an empty |
| 3274 string is returned, there is no error message. | |
| 82 | 3275 Examples: > |
| 3276 :let bufmodified = getbufvar(1, "&mod") | |
| 3277 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
| 3278 < | |
| 7 | 3279 getchar([expr]) *getchar()* |
| 867 | 3280 Get a single character from the user or input stream. |
| 7 | 3281 If [expr] is omitted, wait until a character is available. |
| 3282 If [expr] is 0, only get a character when one is available. | |
| 867 | 3283 Return zero otherwise. |
| 7 | 3284 If [expr] is 1, only check if a character is available, it is |
| 867 | 3285 not consumed. Return zero if no character available. |
| 3286 | |
| 5555 | 3287 Without [expr] and when [expr] is 0 a whole character or |
| 867 | 3288 special key is returned. If it is an 8-bit character, the |
| 3289 result is a number. Use nr2char() to convert it to a String. | |
| 3290 Otherwise a String is returned with the encoded character. | |
| 3291 For a special key it's a sequence of bytes starting with 0x80 | |
| 872 | 3292 (decimal: 128). This is the same value as the string |
| 3293 "\<Key>", e.g., "\<Left>". The returned value is also a | |
| 3294 String when a modifier (shift, control, alt) was used that is | |
| 3295 not included in the character. | |
| 867 | 3296 |
| 5968 | 3297 When [expr] is 0 and Esc is typed, there will be a short delay |
| 3298 while Vim waits to see if this is the start of an escape | |
| 3299 sequence. | |
| 3300 | |
| 5555 | 3301 When [expr] is 1 only the first byte is returned. For a |
| 872 | 3302 one-byte character it is the character itself as a number. |
| 3303 Use nr2char() to convert it to a String. | |
| 867 | 3304 |
| 3224 | 3305 Use getcharmod() to obtain any additional modifiers. |
| 3306 | |
| 1029 | 3307 When the user clicks a mouse button, the mouse event will be |
| 3308 returned. The position can then be found in |v:mouse_col|, | |
| 3309 |v:mouse_lnum| and |v:mouse_win|. This example positions the | |
| 3310 mouse as it would normally happen: > | |
| 3311 let c = getchar() | |
| 1621 | 3312 if c == "\<LeftMouse>" && v:mouse_win > 0 |
| 1029 | 3313 exe v:mouse_win . "wincmd w" |
| 3314 exe v:mouse_lnum | |
| 3315 exe "normal " . v:mouse_col . "|" | |
| 3316 endif | |
| 3317 < | |
| 7 | 3318 There is no prompt, you will somehow have to make clear to the |
| 3319 user that a character has to be typed. | |
| 3320 There is no mapping for the character. | |
| 3321 Key codes are replaced, thus when the user presses the <Del> | |
| 3322 key you get the code for the <Del> key, not the raw character | |
| 3323 sequence. Examples: > | |
| 3324 getchar() == "\<Del>" | |
| 3325 getchar() == "\<S-Left>" | |
| 3326 < This example redefines "f" to ignore case: > | |
| 3327 :nmap f :call FindChar()<CR> | |
| 3328 :function FindChar() | |
| 3329 : let c = nr2char(getchar()) | |
| 3330 : while col('.') < col('$') - 1 | |
| 3331 : normal l | |
| 3332 : if getline('.')[col('.') - 1] ==? c | |
| 3333 : break | |
| 3334 : endif | |
| 3335 : endwhile | |
| 3336 :endfunction | |
| 6421 | 3337 < |
| 6647 | 3338 You may also receive synthetic characters, such as |
| 6421 | 3339 |<CursorHold>|. Often you will want to ignore this and get |
| 3340 another character: > | |
| 3341 :function GetKey() | |
| 3342 : let c = getchar() | |
| 3343 : while c == "\<CursorHold>" | |
| 3344 : let c = getchar() | |
| 3345 : endwhile | |
| 3346 : return c | |
| 3347 :endfunction | |
| 7 | 3348 |
| 3349 getcharmod() *getcharmod()* | |
| 3350 The result is a Number which is the state of the modifiers for | |
| 3351 the last obtained character with getchar() or in another way. | |
| 3352 These values are added together: | |
| 3353 2 shift | |
| 3354 4 control | |
| 3355 8 alt (meta) | |
| 3224 | 3356 16 meta (when it's different from ALT) |
| 3357 32 mouse double click | |
| 3358 64 mouse triple click | |
| 3359 96 mouse quadruple click (== 32 + 64) | |
| 3360 128 command (Macintosh only) | |
| 7 | 3361 Only the modifiers that have not been included in the |
| 1621 | 3362 character itself are obtained. Thus Shift-a results in "A" |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3363 without a modifier. |
| 7 | 3364 |
| 6991 | 3365 getcharsearch() *getcharsearch()* |
| 3366 Return the current character search information as a {dict} | |
| 3367 with the following entries: | |
| 3368 | |
| 3369 char character previously used for a character | |
| 3370 search (|t|, |f|, |T|, or |F|); empty string | |
| 3371 if no character search has been performed | |
| 3372 forward direction of character search; 1 for forward, | |
| 3373 0 for backward | |
| 3374 until type of character search; 1 for a |t| or |T| | |
| 3375 character search, 0 for an |f| or |F| | |
| 3376 character search | |
| 3377 | |
| 3378 This can be useful to always have |;| and |,| search | |
| 3379 forward/backward regardless of the direction of the previous | |
| 3380 character search: > | |
| 3381 :nnoremap <expr> ; getcharsearch().forward ? ';' : ',' | |
| 3382 :nnoremap <expr> , getcharsearch().forward ? ',' : ';' | |
| 3383 < Also see |setcharsearch()|. | |
| 3384 | |
| 7 | 3385 getcmdline() *getcmdline()* |
| 3386 Return the current command-line. Only works when the command | |
| 3387 line is being edited, thus requires use of |c_CTRL-\_e| or | |
| 3388 |c_CTRL-R_=|. | |
| 3389 Example: > | |
| 3390 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
| 531 | 3391 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
| 7 | 3392 |
| 95 | 3393 getcmdpos() *getcmdpos()* |
| 7 | 3394 Return the position of the cursor in the command line as a |
| 3395 byte count. The first column is 1. | |
| 3396 Only works when editing the command line, thus requires use of | |
| 3456 | 3397 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 3398 Returns 0 otherwise. | |
| 531 | 3399 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
| 3400 | |
| 3401 getcmdtype() *getcmdtype()* | |
| 3402 Return the current command-line type. Possible return values | |
| 3403 are: | |
| 532 | 3404 : normal Ex command |
| 3405 > debug mode command |debug-mode| | |
| 3406 / forward search command | |
| 3407 ? backward search command | |
| 3408 @ |input()| command | |
| 3409 - |:insert| or |:append| command | |
| 6213 | 3410 = |i_CTRL-R_=| |
| 531 | 3411 Only works when editing the command line, thus requires use of |
| 3456 | 3412 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 3413 Returns an empty string otherwise. | |
| 531 | 3414 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. |
| 7 | 3415 |
| 6153 | 3416 getcmdwintype() *getcmdwintype()* |
| 3417 Return the current |command-line-window| type. Possible return | |
| 3418 values are the same as |getcmdtype()|. Returns an empty string | |
| 3419 when not in the command-line window. | |
| 3420 | |
| 5944 | 3421 *getcurpos()* |
| 3422 getcurpos() Get the position of the cursor. This is like getpos('.'), but | |
| 3423 includes an extra item in the list: | |
| 3424 [bufnum, lnum, col, off, curswant] | |
| 3425 The "curswant" number is the preferred column when moving the | |
| 3426 cursor vertically. | |
| 3427 This can be used to save and restore the cursor position: > | |
| 3428 let save_cursor = getcurpos() | |
| 3429 MoveTheCursorAround | |
| 3430 call setpos('.', save_cursor) | |
| 6153 | 3431 < |
| 7 | 3432 *getcwd()* |
| 3433 getcwd() The result is a String, which is the name of the current | |
| 3434 working directory. | |
| 3435 | |
| 3436 getfsize({fname}) *getfsize()* | |
| 3437 The result is a Number, which is the size in bytes of the | |
| 3438 given file {fname}. | |
| 3439 If {fname} is a directory, 0 is returned. | |
| 3440 If the file {fname} can't be found, -1 is returned. | |
| 1293 | 3441 If the size of {fname} is too big to fit in a Number then -2 |
| 3442 is returned. | |
| 7 | 3443 |
| 37 | 3444 getfontname([{name}]) *getfontname()* |
| 3445 Without an argument returns the name of the normal font being | |
| 3446 used. Like what is used for the Normal highlight group | |
| 3447 |hl-Normal|. | |
| 3448 With an argument a check is done whether {name} is a valid | |
| 3449 font name. If not then an empty string is returned. | |
| 3450 Otherwise the actual font name is returned, or {name} if the | |
| 3451 GUI does not support obtaining the real name. | |
| 824 | 3452 Only works when the GUI is running, thus not in your vimrc or |
| 819 | 3453 gvimrc file. Use the |GUIEnter| autocommand to use this |
| 3454 function just after the GUI has started. | |
| 37 | 3455 Note that the GTK 2 GUI accepts any font name, thus checking |
| 3456 for a valid name does not work. | |
| 3457 | |
| 20 | 3458 getfperm({fname}) *getfperm()* |
| 3459 The result is a String, which is the read, write, and execute | |
| 3460 permissions of the given file {fname}. | |
| 3461 If {fname} does not exist or its directory cannot be read, an | |
| 3462 empty string is returned. | |
| 3463 The result is of the form "rwxrwxrwx", where each group of | |
| 3464 "rwx" flags represent, in turn, the permissions of the owner | |
| 3465 of the file, the group the file belongs to, and other users. | |
| 3466 If a user does not have a given permission the flag for this | |
| 3750 | 3467 is replaced with the string "-". Examples: > |
| 20 | 3468 :echo getfperm("/etc/passwd") |
| 3750 | 3469 :echo getfperm(expand("~/.vimrc")) |
| 20 | 3470 < This will hopefully (from a security point of view) display |
| 3471 the string "rw-r--r--" or even "rw-------". | |
| 205 | 3472 |
| 7 | 3473 getftime({fname}) *getftime()* |
| 3474 The result is a Number, which is the last modification time of | |
| 3475 the given file {fname}. The value is measured as seconds | |
| 3476 since 1st Jan 1970, and may be passed to strftime(). See also | |
| 3477 |localtime()| and |strftime()|. | |
| 3478 If the file {fname} can't be found -1 is returned. | |
| 3479 | |
| 20 | 3480 getftype({fname}) *getftype()* |
| 3481 The result is a String, which is a description of the kind of | |
| 3482 file of the given file {fname}. | |
| 3483 If {fname} does not exist an empty string is returned. | |
| 3484 Here is a table over different kinds of files and their | |
| 3485 results: | |
| 3486 Normal file "file" | |
| 3487 Directory "dir" | |
| 3488 Symbolic link "link" | |
| 3489 Block device "bdev" | |
| 3490 Character device "cdev" | |
| 3491 Socket "socket" | |
| 3492 FIFO "fifo" | |
| 3493 All other "other" | |
| 3494 Example: > | |
| 3495 getftype("/home") | |
| 3496 < Note that a type such as "link" will only be returned on | |
| 3497 systems that support it. On some systems only "dir" and | |
| 3498 "file" are returned. | |
| 3499 | |
| 7 | 3500 *getline()* |
| 82 | 3501 getline({lnum} [, {end}]) |
| 3502 Without {end} the result is a String, which is line {lnum} | |
| 3503 from the current buffer. Example: > | |
| 7 | 3504 getline(1) |
| 3505 < When {lnum} is a String that doesn't start with a | |
| 3506 digit, line() is called to translate the String into a Number. | |
| 3507 To get the line under the cursor: > | |
| 3508 getline(".") | |
| 3509 < When {lnum} is smaller than 1 or bigger than the number of | |
| 3510 lines in the buffer, an empty string is returned. | |
| 3511 | |
| 685 | 3512 When {end} is given the result is a |List| where each item is |
| 3513 a line from the current buffer in the range {lnum} to {end}, | |
| 82 | 3514 including line {end}. |
| 3515 {end} is used in the same way as {lnum}. | |
| 3516 Non-existing lines are silently omitted. | |
| 685 | 3517 When {end} is before {lnum} an empty |List| is returned. |
| 82 | 3518 Example: > |
| 3519 :let start = line('.') | |
| 3520 :let end = search("^$") - 1 | |
| 3521 :let lines = getline(start, end) | |
| 3522 | |
| 1156 | 3523 < To get lines from another buffer see |getbufline()| |
| 3524 | |
| 647 | 3525 getloclist({nr}) *getloclist()* |
| 3526 Returns a list with all the entries in the location list for | |
| 3527 window {nr}. When {nr} is zero the current window is used. | |
| 3528 For a location list window, the displayed location list is | |
| 648 | 3529 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
|
3530 returned. Otherwise, same as |getqflist()|. |
| 82 | 3531 |
| 1326 | 3532 getmatches() *getmatches()* |
| 3533 Returns a |List| with all matches previously defined by | |
| 3534 |matchadd()| and the |:match| commands. |getmatches()| is | |
| 3535 useful in combination with |setmatches()|, as |setmatches()| | |
| 3536 can restore a list of matches saved by |getmatches()|. | |
| 3537 Example: > | |
| 3538 :echo getmatches() | |
| 3539 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 3540 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 3541 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 3542 :let m = getmatches() | |
| 3543 :call clearmatches() | |
| 3544 :echo getmatches() | |
| 3545 < [] > | |
| 3546 :call setmatches(m) | |
| 3547 :echo getmatches() | |
| 3548 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 3549 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 3550 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 3551 :unlet m | |
| 3552 < | |
| 5968 | 3553 *getpid()* |
| 3554 getpid() Return a Number which is the process ID of the Vim process. | |
| 3555 On Unix and MS-Windows this is a unique number, until Vim | |
| 3556 exits. On MS-DOS it's always zero. | |
| 3557 | |
| 3558 *getpos()* | |
| 3559 getpos({expr}) Get the position for {expr}. For possible values of {expr} | |
| 3560 see |line()|. For getting the cursor position see | |
| 3561 |getcurpos()|. | |
| 3562 The result is a |List| with four numbers: | |
| 3563 [bufnum, lnum, col, off] | |
| 3564 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
| 3565 is the buffer number of the mark. | |
| 3566 "lnum" and "col" are the position in the buffer. The first | |
| 3567 column is 1. | |
| 3568 The "off" number is zero, unless 'virtualedit' is used. Then | |
| 3569 it is the offset in screen columns from the start of the | |
| 3570 character. E.g., a position within a <Tab> or after the last | |
| 3571 character. | |
| 3572 Note that for '< and '> Visual mode matters: when it is "V" | |
| 3573 (visual line mode) the column of '< is zero and the column of | |
| 3574 '> is a large number. | |
| 3575 This can be used to save and restore the position of a mark: > | |
| 3576 let save_a_mark = getpos("'a") | |
| 3577 ... | |
| 6421 | 3578 call setpos("'a", save_a_mark) |
| 5968 | 3579 < Also see |getcurpos()| and |setpos()|. |
| 3580 | |
| 1326 | 3581 |
| 230 | 3582 getqflist() *getqflist()* |
| 3583 Returns a list with all the current quickfix errors. Each | |
| 3584 list item is a dictionary with these entries: | |
| 3585 bufnr number of buffer that has the file name, use | |
| 3586 bufname() to get the name | |
| 3587 lnum line number in the buffer (first line is 1) | |
| 3588 col column number (first column is 1) | |
| 233 | 3589 vcol non-zero: "col" is visual column |
| 3590 zero: "col" is byte index | |
| 230 | 3591 nr error number |
| 1065 | 3592 pattern search pattern used to locate the error |
| 230 | 3593 text description of the error |
| 3594 type type of the error, 'E', '1', etc. | |
| 3595 valid non-zero: recognized error message | |
| 3596 | |
| 515 | 3597 When there is no error list or it's empty an empty list is |
| 1065 | 3598 returned. Quickfix list entries with non-existing buffer |
| 3599 number are returned with "bufnr" set to zero. | |
| 515 | 3600 |
| 230 | 3601 Useful application: Find pattern matches in multiple files and |
| 3602 do something with them: > | |
| 3603 :vimgrep /theword/jg *.c | |
| 3604 :for d in getqflist() | |
| 3605 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
| 3606 :endfor | |
| 3607 | |
| 3608 | |
| 5796 | 3609 getreg([{regname} [, 1 [, {list}]]]) *getreg()* |
| 7 | 3610 The result is a String, which is the contents of register |
| 236 | 3611 {regname}. Example: > |
| 7 | 3612 :let cliptext = getreg('*') |
| 3613 < getreg('=') returns the last evaluated value of the expression | |
| 236 | 3614 register. (For use in maps.) |
| 282 | 3615 getreg('=', 1) returns the expression itself, so that it can |
| 3616 be restored with |setreg()|. For other registers the extra | |
| 3617 argument is ignored, thus you can always give it. | |
| 5796 | 3618 If {list} is present and non-zero result type is changed to |
| 3619 |List|. Each list item is one text line. Use it if you care | |
| 3620 about zero bytes possibly present inside register: without | |
| 3621 third argument both NLs and zero bytes are represented as NLs | |
| 3622 (see |NL-used-for-Nul|). | |
| 7 | 3623 If {regname} is not specified, |v:register| is used. |
| 3624 | |
| 82 | 3625 |
| 7 | 3626 getregtype([{regname}]) *getregtype()* |
| 3627 The result is a String, which is type of register {regname}. | |
| 3628 The value will be one of: | |
| 3629 "v" for |characterwise| text | |
| 3630 "V" for |linewise| text | |
| 3631 "<CTRL-V>{width}" for |blockwise-visual| text | |
| 5596 | 3632 "" for an empty or unknown register |
| 7 | 3633 <CTRL-V> is one character with value 0x16. |
| 3634 If {regname} is not specified, |v:register| is used. | |
| 3635 | |
| 4157 | 3636 gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()* |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3637 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
|
3638 {tabnr}. |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3639 Tabs are numbered starting with one. |
| 6197 | 3640 When {varname} is empty a dictionary with all tab-local |
| 3641 variables is returned. | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3642 Note that the name without "t:" must be used. |
| 4157 | 3643 When the tab or variable doesn't exist {def} or an empty |
| 3644 string is returned, there is no error message. | |
| 3645 | |
| 3646 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()* | |
| 1156 | 3647 Get the value of window-local variable {varname} in window |
| 3648 {winnr} in tab page {tabnr}. | |
| 3649 When {varname} starts with "&" get the value of a window-local | |
| 3650 option. | |
| 4157 | 3651 When {varname} is empty a dictionary with all window-local |
| 3652 variables is returned. | |
| 3653 Note that {varname} must be the name without "w:". | |
| 831 | 3654 Tabs are numbered starting with one. For the current tabpage |
| 3655 use |getwinvar()|. | |
| 3656 When {winnr} is zero the current window is used. | |
| 3657 This also works for a global option, buffer-local option and | |
| 3658 window-local option, but it doesn't work for a global variable | |
| 3659 or buffer-local variable. | |
| 4157 | 3660 When the tab, window or variable doesn't exist {def} or an |
| 3661 empty string is returned, there is no error message. | |
| 831 | 3662 Examples: > |
| 3663 :let list_is_on = gettabwinvar(1, 2, '&list') | |
| 3664 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
| 1266 | 3665 < |
| 7 | 3666 *getwinposx()* |
| 3667 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
| 3668 the left hand side of the GUI Vim window. The result will be | |
| 3669 -1 if the information is not available. | |
| 3670 | |
| 3671 *getwinposy()* | |
| 3672 getwinposy() The result is a Number, which is the Y coordinate in pixels of | |
| 1621 | 3673 the top of the GUI Vim window. The result will be -1 if the |
| 7 | 3674 information is not available. |
| 3675 | |
| 4157 | 3676 getwinvar({winnr}, {varname} [, {def}]) *getwinvar()* |
| 831 | 3677 Like |gettabwinvar()| for the current tabpage. |
| 7 | 3678 Examples: > |
| 3679 :let list_is_on = getwinvar(2, '&list') | |
| 3680 :echo "myvar = " . getwinvar(1, 'myvar') | |
| 3681 < | |
| 6663 | 3682 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()* |
| 1754 | 3683 Expand the file wildcards in {expr}. See |wildcards| for the |
| 1156 | 3684 use of special characters. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3685 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3686 Unless the optional {nosuf} argument is given and is non-zero, |
| 1754 | 3687 the 'suffixes' and 'wildignore' options apply: Names matching |
| 3688 one of the patterns in 'wildignore' will be skipped and | |
| 3689 'suffixes' affect the ordering of matches. | |
| 2662 | 3690 'wildignorecase' always applies. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3691 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3692 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
|
3693 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
|
3694 you also get filenames containing newlines correctly. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3695 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
|
3696 matches, they are separated by <NL> characters. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3697 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3698 If the expansion fails, the result is an empty String or List. |
| 6663 | 3699 |
| 3445 | 3700 A name for a non-existing file is not included. A symbolic |
| 3701 link is only included if it points to an existing file. | |
| 6663 | 3702 However, when the {alllinks} argument is present and it is |
| 3703 non-zero then all symbolic links are included. | |
| 7 | 3704 |
| 3705 For most systems backticks can be used to get files names from | |
| 3706 any external command. Example: > | |
| 3707 :let tagfiles = glob("`find . -name tags -print`") | |
| 3708 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
| 3709 < The result of the program inside the backticks should be one | |
| 1621 | 3710 item per line. Spaces inside an item are allowed. |
| 7 | 3711 |
| 3712 See |expand()| for expanding special Vim variables. See | |
| 3713 |system()| for getting the raw output of an external command. | |
| 3714 | |
| 6697 | 3715 glob2regpat({expr}) *glob2regpat()* |
| 3716 Convert a file pattern, as used by glob(), into a search | |
| 3717 pattern. The result can be used to match with a string that | |
| 3718 is a file name. E.g. > | |
| 3719 if filename =~ glob2regpat('Make*.mak') | |
| 3720 < This is equivalent to: > | |
| 3721 if filename =~ '^Make.*\.mak$' | |
| 3722 < | |
| 6663 | 3723 *globpath()* |
| 3724 globpath({path}, {expr} [, {nosuf} [, {list} [, {allinks}]]]) | |
| 7 | 3725 Perform glob() on all directories in {path} and concatenate |
| 3726 the results. Example: > | |
| 3727 :echo globpath(&rtp, "syntax/c.vim") | |
| 5873 | 3728 < |
| 3729 {path} is a comma-separated list of directory names. Each | |
| 7 | 3730 directory name is prepended to {expr} and expanded like with |
| 1754 | 3731 |glob()|. A path separator is inserted when needed. |
| 7 | 3732 To add a comma inside a directory name escape it with a |
| 3733 backslash. Note that on MS-Windows a directory may have a | |
| 3734 trailing backslash, remove it if you put a comma after it. | |
| 3735 If the expansion fails for one of the directories, there is no | |
| 3736 error message. | |
| 5873 | 3737 |
| 3738 Unless the optional {nosuf} argument is given and is non-zero, | |
| 1754 | 3739 the 'suffixes' and 'wildignore' options apply: Names matching |
| 3740 one of the patterns in 'wildignore' will be skipped and | |
| 3741 'suffixes' affect the ordering of matches. | |
| 7 | 3742 |
| 5873 | 3743 When {list} is present and it is non-zero the result is a List |
| 3744 with all matching files. The advantage of using a List is, you | |
| 3745 also get filenames containing newlines correctly. Otherwise | |
| 3746 the result is a String and when there are several matches, | |
| 3747 they are separated by <NL> characters. Example: > | |
| 3748 :echo globpath(&rtp, "syntax/c.vim", 0, 1) | |
| 3749 < | |
| 6663 | 3750 {allinks} is used as with |glob()|. |
| 3751 | |
| 444 | 3752 The "**" item can be used to search in a directory tree. |
| 3753 For example, to find all "README.txt" files in the directories | |
| 3754 in 'runtimepath' and below: > | |
| 3755 :echo globpath(&rtp, "**/README.txt") | |
| 1668 | 3756 < Upwards search and limiting the depth of "**" is not |
| 3757 supported, thus using 'path' will not always work properly. | |
| 3758 | |
| 7 | 3759 *has()* |
| 3760 has({feature}) The result is a Number, which is 1 if the feature {feature} is | |
| 3761 supported, zero otherwise. The {feature} argument is a | |
| 3762 string. See |feature-list| below. | |
| 3763 Also see |exists()|. | |
| 3764 | |
| 102 | 3765 |
| 3766 has_key({dict}, {key}) *has_key()* | |
| 685 | 3767 The result is a Number, which is 1 if |Dictionary| {dict} has |
| 3768 an entry with key {key}. Zero otherwise. | |
| 102 | 3769 |
| 1104 | 3770 haslocaldir() *haslocaldir()* |
| 3771 The result is a Number, which is 1 when the current | |
| 1621 | 3772 window has set a local path via |:lcd|, and 0 otherwise. |
| 102 | 3773 |
| 782 | 3774 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
| 7 | 3775 The result is a Number, which is 1 if there is a mapping that |
| 3776 contains {what} in somewhere in the rhs (what it is mapped to) | |
| 3777 and this mapping exists in one of the modes indicated by | |
| 3778 {mode}. | |
| 782 | 3779 When {abbr} is there and it is non-zero use abbreviations |
| 786 | 3780 instead of mappings. Don't forget to specify Insert and/or |
| 3781 Command-line mode. | |
| 7 | 3782 Both the global mappings and the mappings local to the current |
| 3783 buffer are checked for a match. | |
| 3784 If no matching mapping is found 0 is returned. | |
| 3785 The following characters are recognized in {mode}: | |
| 3786 n Normal mode | |
| 3787 v Visual mode | |
| 3788 o Operator-pending mode | |
| 3789 i Insert mode | |
| 3790 l Language-Argument ("r", "f", "t", etc.) | |
| 3791 c Command-line mode | |
| 3792 When {mode} is omitted, "nvo" is used. | |
| 3793 | |
| 3794 This function is useful to check if a mapping already exists | |
| 1621 | 3795 to a function in a Vim script. Example: > |
| 7 | 3796 :if !hasmapto('\ABCdoit') |
| 3797 : map <Leader>d \ABCdoit | |
| 3798 :endif | |
| 3799 < This installs the mapping to "\ABCdoit" only if there isn't | |
| 3800 already a mapping to "\ABCdoit". | |
| 3801 | |
| 3802 histadd({history}, {item}) *histadd()* | |
| 3803 Add the String {item} to the history {history} which can be | |
| 3804 one of: *hist-names* | |
| 3805 "cmd" or ":" command line history | |
| 3806 "search" or "/" search pattern history | |
| 1621 | 3807 "expr" or "=" typed expression history |
| 7 | 3808 "input" or "@" input line history |
| 3682 | 3809 "debug" or ">" debug command history |
| 3810 The {history} string does not need to be the whole name, one | |
| 3811 character is sufficient. | |
| 7 | 3812 If {item} does already exist in the history, it will be |
| 3813 shifted to become the newest entry. | |
| 3814 The result is a Number: 1 if the operation was successful, | |
| 3815 otherwise 0 is returned. | |
| 3816 | |
| 3817 Example: > | |
| 3818 :call histadd("input", strftime("%Y %b %d")) | |
| 3819 :let date=input("Enter date: ") | |
| 3820 < This function is not available in the |sandbox|. | |
| 3821 | |
| 3822 histdel({history} [, {item}]) *histdel()* | |
| 236 | 3823 Clear {history}, i.e. delete all its entries. See |hist-names| |
| 7 | 3824 for the possible values of {history}. |
| 3825 | |
| 1668 | 3826 If the parameter {item} evaluates to a String, it is used as a |
| 3827 regular expression. All entries matching that expression will | |
| 3828 be removed from the history (if there are any). | |
| 7 | 3829 Upper/lowercase must match, unless "\c" is used |/\c|. |
| 1668 | 3830 If {item} evaluates to a Number, it will be interpreted as |
| 3831 an index, see |:history-indexing|. The respective entry will | |
| 3832 be removed if it exists. | |
| 7 | 3833 |
| 3834 The result is a Number: 1 for a successful operation, | |
| 3835 otherwise 0 is returned. | |
| 3836 | |
| 3837 Examples: | |
| 3838 Clear expression register history: > | |
| 3839 :call histdel("expr") | |
| 3840 < | |
| 3841 Remove all entries starting with "*" from the search history: > | |
| 3842 :call histdel("/", '^\*') | |
| 3843 < | |
| 3844 The following three are equivalent: > | |
| 3845 :call histdel("search", histnr("search")) | |
| 3846 :call histdel("search", -1) | |
| 3847 :call histdel("search", '^'.histget("search", -1).'$') | |
| 3848 < | |
| 3849 To delete the last search pattern and use the last-but-one for | |
| 3850 the "n" command and 'hlsearch': > | |
| 3851 :call histdel("search", -1) | |
| 3852 :let @/ = histget("search", -1) | |
| 3853 | |
| 3854 histget({history} [, {index}]) *histget()* | |
| 3855 The result is a String, the entry with Number {index} from | |
| 3856 {history}. See |hist-names| for the possible values of | |
| 3857 {history}, and |:history-indexing| for {index}. If there is | |
| 3858 no such entry, an empty String is returned. When {index} is | |
| 3859 omitted, the most recent item from the history is used. | |
| 3860 | |
| 3861 Examples: | |
| 3862 Redo the second last search from history. > | |
| 3863 :execute '/' . histget("search", -2) | |
| 3864 | |
| 3865 < Define an Ex command ":H {num}" that supports re-execution of | |
| 3866 the {num}th entry from the output of |:history|. > | |
| 3867 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
| 3868 < | |
| 3869 histnr({history}) *histnr()* | |
| 3870 The result is the Number of the current entry in {history}. | |
| 3871 See |hist-names| for the possible values of {history}. | |
| 3872 If an error occurred, -1 is returned. | |
| 3873 | |
| 3874 Example: > | |
| 3875 :let inp_index = histnr("expr") | |
| 3876 < | |
| 3877 hlexists({name}) *hlexists()* | |
| 3878 The result is a Number, which is non-zero if a highlight group | |
| 3879 called {name} exists. This is when the group has been | |
| 3880 defined in some way. Not necessarily when highlighting has | |
| 3881 been defined for it, it may also have been used for a syntax | |
| 3882 item. | |
| 3883 *highlight_exists()* | |
| 3884 Obsolete name: highlight_exists(). | |
| 3885 | |
| 3886 *hlID()* | |
| 3887 hlID({name}) The result is a Number, which is the ID of the highlight group | |
| 3888 with name {name}. When the highlight group doesn't exist, | |
| 3889 zero is returned. | |
| 3890 This can be used to retrieve information about the highlight | |
| 1621 | 3891 group. For example, to get the background color of the |
| 7 | 3892 "Comment" group: > |
| 3893 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
| 3894 < *highlightID()* | |
| 3895 Obsolete name: highlightID(). | |
| 3896 | |
| 3897 hostname() *hostname()* | |
| 3898 The result is a String, which is the name of the machine on | |
| 236 | 3899 which Vim is currently running. Machine names greater than |
| 7 | 3900 256 characters long are truncated. |
| 3901 | |
| 3902 iconv({expr}, {from}, {to}) *iconv()* | |
| 3903 The result is a String, which is the text {expr} converted | |
| 3904 from encoding {from} to encoding {to}. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3905 When the conversion completely fails an empty string is |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3906 returned. When some characters could not be converted they |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3907 are replaced with "?". |
| 7 | 3908 The encoding names are whatever the iconv() library function |
| 3909 can accept, see ":!man 3 iconv". | |
| 3910 Most conversions require Vim to be compiled with the |+iconv| | |
| 3911 feature. Otherwise only UTF-8 to latin1 conversion and back | |
| 3912 can be done. | |
| 3913 This can be used to display messages with special characters, | |
| 3914 no matter what 'encoding' is set to. Write the message in | |
| 3915 UTF-8 and use: > | |
| 3916 echo iconv(utf8_str, "utf-8", &enc) | |
| 3917 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
| 3918 from/to UCS-2 is automatically changed to use UTF-8. You | |
| 3919 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
|
3920 {only available when compiled with the |+multi_byte| feature} |
| 7 | 3921 |
| 3922 *indent()* | |
| 3923 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
| 3924 current buffer. The indent is counted in spaces, the value | |
| 3925 of 'tabstop' is relevant. {lnum} is used just like in | |
| 3926 |getline()|. | |
| 3927 When {lnum} is invalid -1 is returned. | |
| 3928 | |
| 79 | 3929 |
| 95 | 3930 index({list}, {expr} [, {start} [, {ic}]]) *index()* |
| 685 | 3931 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
|
3932 value equal to {expr}. There is no automatic conversion, so |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3933 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
|
3934 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
|
3935 is not used here, case always matters. |
| 153 | 3936 If {start} is given then start looking at the item with index |
| 3937 {start} (may be negative for an item relative to the end). | |
| 79 | 3938 When {ic} is given and it is non-zero, ignore case. Otherwise |
| 3939 case must match. | |
| 3940 -1 is returned when {expr} is not found in {list}. | |
| 3941 Example: > | |
| 3942 :let idx = index(words, "the") | |
| 87 | 3943 :if index(numbers, 123) >= 0 |
| 79 | 3944 |
| 3945 | |
| 531 | 3946 input({prompt} [, {text} [, {completion}]]) *input()* |
| 7 | 3947 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
|
3948 the command-line. The {prompt} argument is either a prompt |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3949 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
|
3950 in the prompt to start a new line. |
| 531 | 3951 The highlighting set with |:echohl| is used for the prompt. |
| 3952 The input is entered just like a command-line, with the same | |
| 1621 | 3953 editing commands and mappings. There is a separate history |
| 531 | 3954 for lines typed for input(). |
| 3955 Example: > | |
| 3956 :if input("Coffee or beer? ") == "beer" | |
| 3957 : echo "Cheers!" | |
| 3958 :endif | |
| 3959 < | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3960 If the optional {text} argument is present and not empty, this |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3961 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
|
3962 Example: > |
| 531 | 3963 :let color = input("Color? ", "white") |
| 3964 | |
| 3965 < The optional {completion} argument specifies the type of | |
| 3966 completion supported for the input. Without it completion is | |
| 1621 | 3967 not performed. The supported completion types are the same as |
| 531 | 3968 that can be supplied to a user-defined command using the |
| 1621 | 3969 "-complete=" argument. Refer to |:command-completion| for |
| 531 | 3970 more information. Example: > |
| 3971 let fname = input("File: ", "", "file") | |
| 3972 < | |
| 3973 NOTE: This function must not be used in a startup file, for | |
| 3974 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
| 7 | 3975 Note: When input() is called from within a mapping it will |
| 3976 consume remaining characters from that mapping, because a | |
| 3977 mapping is handled like the characters were typed. | |
| 3978 Use |inputsave()| before input() and |inputrestore()| | |
| 3979 after input() to avoid that. Another solution is to avoid | |
| 3980 that further characters follow in the mapping, e.g., by using | |
| 3981 |:execute| or |:normal|. | |
| 3982 | |
| 531 | 3983 Example with a mapping: > |
| 7 | 3984 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
| 3985 :function GetFoo() | |
| 3986 : call inputsave() | |
| 3987 : let g:Foo = input("enter search pattern: ") | |
| 3988 : call inputrestore() | |
| 3989 :endfunction | |
| 3990 | |
| 3991 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3992 Like |input()|, but when the GUI is running and text dialogs |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3993 are supported, a dialog window pops up to input the text. |
| 7 | 3994 Example: > |
| 3875 | 3995 :let n = inputdialog("value for shiftwidth", shiftwidth()) |
| 3996 :if n != "" | |
| 3997 : let &sw = n | |
| 3998 :endif | |
| 7 | 3999 < When the dialog is cancelled {cancelreturn} is returned. When |
| 4000 omitted an empty string is returned. | |
| 4001 Hitting <Enter> works like pressing the OK button. Hitting | |
| 4002 <Esc> works like pressing the Cancel button. | |
| 531 | 4003 NOTE: Command-line completion is not supported. |
| 7 | 4004 |
| 519 | 4005 inputlist({textlist}) *inputlist()* |
| 819 | 4006 {textlist} must be a |List| of strings. This |List| is |
| 4007 displayed, one string per line. The user will be prompted to | |
| 4008 enter a number, which is returned. | |
| 519 | 4009 The user can also select an item by clicking on it with the |
| 1621 | 4010 mouse. For the first string 0 is returned. When clicking |
| 519 | 4011 above the first item a negative number is returned. When |
| 4012 clicking on the prompt one more than the length of {textlist} | |
| 4013 is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4014 Make sure {textlist} has less than 'lines' entries, otherwise |
| 1621 | 4015 it won't work. It's a good idea to put the entry number at |
| 1156 | 4016 the start of the string. And put a prompt in the first item. |
| 4017 Example: > | |
| 519 | 4018 let color = inputlist(['Select color:', '1. red', |
| 4019 \ '2. green', '3. blue']) | |
| 4020 | |
| 7 | 4021 inputrestore() *inputrestore()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4022 Restore typeahead that was saved with a previous |inputsave()|. |
| 7 | 4023 Should be called the same number of times inputsave() is |
| 4024 called. Calling it more often is harmless though. | |
| 4025 Returns 1 when there is nothing to restore, 0 otherwise. | |
| 4026 | |
| 4027 inputsave() *inputsave()* | |
| 4028 Preserve typeahead (also from mappings) and clear it, so that | |
| 4029 a following prompt gets input from the user. Should be | |
| 4030 followed by a matching inputrestore() after the prompt. Can | |
| 4031 be used several times, in which case there must be just as | |
| 4032 many inputrestore() calls. | |
| 4033 Returns 1 when out of memory, 0 otherwise. | |
| 4034 | |
| 4035 inputsecret({prompt} [, {text}]) *inputsecret()* | |
| 4036 This function acts much like the |input()| function with but | |
| 4037 two exceptions: | |
| 4038 a) the user's response will be displayed as a sequence of | |
| 4039 asterisks ("*") thereby keeping the entry secret, and | |
| 4040 b) the user's response will not be recorded on the input | |
| 4041 |history| stack. | |
| 4042 The result is a String, which is whatever the user actually | |
| 4043 typed on the command-line in response to the issued prompt. | |
| 531 | 4044 NOTE: Command-line completion is not supported. |
| 7 | 4045 |
| 55 | 4046 insert({list}, {item} [, {idx}]) *insert()* |
| 685 | 4047 Insert {item} at the start of |List| {list}. |
| 55 | 4048 If {idx} is specified insert {item} before the item with index |
| 1621 | 4049 {idx}. If {idx} is zero it goes before the first item, just |
| 55 | 4050 like omitting {idx}. A negative {idx} is also possible, see |
| 4051 |list-index|. -1 inserts just before the last item. | |
| 685 | 4052 Returns the resulting |List|. Examples: > |
| 55 | 4053 :let mylist = insert([2, 3, 5], 1) |
| 4054 :call insert(mylist, 4, -1) | |
| 4055 :call insert(mylist, 6, len(mylist)) | |
| 82 | 4056 < The last example can be done simpler with |add()|. |
| 685 | 4057 Note that when {item} is a |List| it is inserted as a single |
| 692 | 4058 item. Use |extend()| to concatenate |Lists|. |
| 55 | 4059 |
| 3214 | 4060 invert({expr}) *invert()* |
| 4061 Bitwise invert. The argument is converted to a number. A | |
| 4062 List, Dict or Float argument causes an error. Example: > | |
| 4063 :let bits = invert(bits) | |
| 4064 | |
| 7 | 4065 isdirectory({directory}) *isdirectory()* |
| 4066 The result is a Number, which is non-zero when a directory | |
| 4067 with the name {directory} exists. If {directory} doesn't | |
| 4068 exist, or isn't a directory, the result is FALSE. {directory} | |
| 4069 is any expression, which is used as a String. | |
| 4070 | |
| 819 | 4071 islocked({expr}) *islocked()* *E786* |
| 148 | 4072 The result is a Number, which is non-zero when {expr} is the |
| 4073 name of a locked variable. | |
| 685 | 4074 {expr} must be the name of a variable, |List| item or |
| 4075 |Dictionary| entry, not the variable itself! Example: > | |
| 148 | 4076 :let alist = [0, ['a', 'b'], 2, 3] |
| 4077 :lockvar 1 alist | |
| 4078 :echo islocked('alist') " 1 | |
| 4079 :echo islocked('alist[1]') " 0 | |
| 4080 | |
| 4081 < When {expr} is a variable that does not exist you get an error | |
| 843 | 4082 message. Use |exists()| to check for existence. |
| 148 | 4083 |
| 140 | 4084 items({dict}) *items()* |
| 685 | 4085 Return a |List| with all the key-value pairs of {dict}. Each |
| 4086 |List| item is a list with two items: the key of a {dict} | |
| 4087 entry and the value of this entry. The |List| is in arbitrary | |
| 4088 order. | |
| 140 | 4089 |
| 95 | 4090 |
| 4091 join({list} [, {sep}]) *join()* | |
| 4092 Join the items in {list} together into one String. | |
| 4093 When {sep} is specified it is put in between the items. If | |
| 4094 {sep} is omitted a single space is used. | |
| 4095 Note that {sep} is not added at the end. You might want to | |
| 4096 add it there too: > | |
| 4097 let lines = join(mylist, "\n") . "\n" | |
| 692 | 4098 < String items are used as-is. |Lists| and |Dictionaries| are |
| 95 | 4099 converted into a string like with |string()|. |
| 4100 The opposite function is |split()|. | |
| 4101 | |
| 99 | 4102 keys({dict}) *keys()* |
| 685 | 4103 Return a |List| with all the keys of {dict}. The |List| is in |
| 99 | 4104 arbitrary order. |
| 4105 | |
| 85 | 4106 *len()* *E701* |
| 55 | 4107 len({expr}) The result is a Number, which is the length of the argument. |
| 4108 When {expr} is a String or a Number the length in bytes is | |
| 4109 used, as with |strlen()|. | |
| 685 | 4110 When {expr} is a |List| the number of items in the |List| is |
| 55 | 4111 returned. |
| 685 | 4112 When {expr} is a |Dictionary| the number of entries in the |
| 4113 |Dictionary| is returned. | |
| 55 | 4114 Otherwise an error is given. |
| 4115 | |
| 7 | 4116 *libcall()* *E364* *E368* |
| 4117 libcall({libname}, {funcname}, {argument}) | |
| 4118 Call function {funcname} in the run-time library {libname} | |
| 4119 with single argument {argument}. | |
| 4120 This is useful to call functions in a library that you | |
| 4121 especially made to be used with Vim. Since only one argument | |
| 4122 is possible, calling standard library functions is rather | |
| 4123 limited. | |
| 4124 The result is the String returned by the function. If the | |
| 4125 function returns NULL, this will appear as an empty string "" | |
| 4126 to Vim. | |
| 4127 If the function returns a number, use libcallnr()! | |
| 4128 If {argument} is a number, it is passed to the function as an | |
| 4129 int; if {argument} is a string, it is passed as a | |
| 4130 null-terminated string. | |
| 4131 This function will fail in |restricted-mode|. | |
| 4132 | |
| 4133 libcall() allows you to write your own 'plug-in' extensions to | |
| 4134 Vim without having to recompile the program. It is NOT a | |
| 4135 means to call system functions! If you try to do so Vim will | |
| 4136 very probably crash. | |
| 4137 | |
| 4138 For Win32, the functions you write must be placed in a DLL | |
| 4139 and use the normal C calling convention (NOT Pascal which is | |
| 4140 used in Windows System DLLs). The function must take exactly | |
| 4141 one parameter, either a character pointer or a long integer, | |
| 4142 and must return a character pointer or NULL. The character | |
| 4143 pointer returned must point to memory that will remain valid | |
| 4144 after the function has returned (e.g. in static data in the | |
| 4145 DLL). If it points to allocated memory, that memory will | |
| 4146 leak away. Using a static buffer in the function should work, | |
| 4147 it's then freed when the DLL is unloaded. | |
| 4148 | |
| 4149 WARNING: If the function returns a non-valid pointer, Vim may | |
| 1621 | 4150 crash! This also happens if the function returns a number, |
| 7 | 4151 because Vim thinks it's a pointer. |
| 4152 For Win32 systems, {libname} should be the filename of the DLL | |
| 4153 without the ".DLL" suffix. A full path is only required if | |
| 4154 the DLL is not in the usual places. | |
| 4155 For Unix: When compiling your own plugins, remember that the | |
| 4156 object code must be compiled as position-independent ('PIC'). | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4157 {only in Win32 and some Unix versions, when the |+libcall| |
| 7 | 4158 feature is present} |
| 4159 Examples: > | |
| 4160 :echo libcall("libc.so", "getenv", "HOME") | |
| 4161 < | |
| 4162 *libcallnr()* | |
| 4163 libcallnr({libname}, {funcname}, {argument}) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4164 Just like |libcall()|, but used for a function that returns an |
| 7 | 4165 int instead of a string. |
| 4166 {only in Win32 on some Unix versions, when the |+libcall| | |
| 4167 feature is present} | |
| 1621 | 4168 Examples: > |
| 4169 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
| 7 | 4170 :call libcallnr("libc.so", "printf", "Hello World!\n") |
| 4171 :call libcallnr("libc.so", "sleep", 10) | |
| 4172 < | |
| 4173 *line()* | |
| 4174 line({expr}) The result is a Number, which is the line number of the file | |
| 4175 position given with {expr}. The accepted positions are: | |
| 4176 . the cursor position | |
| 4177 $ the last line in the current buffer | |
| 4178 'x position of mark x (if the mark is not set, 0 is | |
| 4179 returned) | |
| 665 | 4180 w0 first line visible in current window |
| 4181 w$ last line visible in current window | |
| 1609 | 4182 v In Visual mode: the start of the Visual area (the |
| 4183 cursor is the end). When not in Visual mode | |
| 4184 returns the cursor position. Differs from |'<| in | |
| 4185 that it's updated right away. | |
| 1156 | 4186 Note that a mark in another file can be used. The line number |
| 4187 then applies to another buffer. | |
| 703 | 4188 To get the column number use |col()|. To get both use |
| 4189 |getpos()|. | |
| 7 | 4190 Examples: > |
| 4191 line(".") line number of the cursor | |
| 4192 line("'t") line number of mark t | |
| 4193 line("'" . marker) line number of mark marker | |
| 4194 < *last-position-jump* | |
| 4195 This autocommand jumps to the last known position in a file | |
| 4196 just after opening it, if the '" mark is set: > | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4197 :au BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g`\"" | endif |
| 9 | 4198 |
| 7 | 4199 line2byte({lnum}) *line2byte()* |
| 4200 Return the byte count from the start of the buffer for line | |
| 4201 {lnum}. This includes the end-of-line character, depending on | |
| 4202 the 'fileformat' option for the current buffer. The first | |
| 3237 | 4203 line returns 1. 'encoding' matters, 'fileencoding' is ignored. |
| 7 | 4204 This can also be used to get the byte count for the line just |
| 4205 below the last line: > | |
| 4206 line2byte(line("$") + 1) | |
| 3237 | 4207 < This is the buffer size plus one. If 'fileencoding' is empty |
| 4208 it is the file size plus one. | |
| 7 | 4209 When {lnum} is invalid, or the |+byte_offset| feature has been |
| 4210 disabled at compile time, -1 is returned. | |
| 4211 Also see |byte2line()|, |go| and |:goto|. | |
| 4212 | |
| 4213 lispindent({lnum}) *lispindent()* | |
| 4214 Get the amount of indent for line {lnum} according the lisp | |
| 4215 indenting rules, as with 'lisp'. | |
| 4216 The indent is counted in spaces, the value of 'tabstop' is | |
| 4217 relevant. {lnum} is used just like in |getline()|. | |
| 4218 When {lnum} is invalid or Vim was not compiled the | |
| 4219 |+lispindent| feature, -1 is returned. | |
| 4220 | |
| 4221 localtime() *localtime()* | |
| 4222 Return the current time, measured as seconds since 1st Jan | |
| 4223 1970. See also |strftime()| and |getftime()|. | |
| 4224 | |
| 95 | 4225 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4226 log({expr}) *log()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
4227 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
|
4228 {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
|
4229 (0, inf]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4230 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4231 :echo log(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4232 < 2.302585 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4233 :echo log(exp(5)) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4234 < 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
|
4235 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4236 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4237 |
| 1621 | 4238 log10({expr}) *log10()* |
| 4239 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
| 4240 {expr} must evaluate to a |Float| or a |Number|. | |
| 4241 Examples: > | |
| 4242 :echo log10(1000) | |
| 4243 < 3.0 > | |
| 4244 :echo log10(0.01) | |
| 4245 < -2.0 | |
| 4246 {only available when compiled with the |+float| feature} | |
| 4247 | |
| 3492 | 4248 luaeval({expr}[, {expr}]) *luaeval()* |
| 4249 Evaluate Lua expression {expr} and return its result converted | |
| 4250 to Vim data structures. Second {expr} may hold additional | |
| 4251 argument accessible as _A inside first {expr}. | |
| 4252 Strings are returned as they are. | |
| 4253 Boolean objects are converted to numbers. | |
| 4254 Numbers are converted to |Float| values if vim was compiled | |
| 4255 with |+float| and to numbers otherwise. | |
| 4256 Dictionaries and lists obtained by vim.eval() are returned | |
| 4257 as-is. | |
| 4258 Other objects are returned as zero without any errors. | |
| 4259 See |lua-luaeval| for more details. | |
| 4260 {only available when compiled with the |+lua| feature} | |
| 4261 | |
| 102 | 4262 map({expr}, {string}) *map()* |
| 685 | 4263 {expr} must be a |List| or a |Dictionary|. |
| 102 | 4264 Replace each item in {expr} with the result of evaluating |
| 4265 {string}. | |
| 4266 Inside {string} |v:val| has the value of the current item. | |
| 1998 | 4267 For a |Dictionary| |v:key| has the key of the current item |
| 4268 and for a |List| |v:key| has the index of the current item. | |
| 102 | 4269 Example: > |
| 4270 :call map(mylist, '"> " . v:val . " <"') | |
| 95 | 4271 < This puts "> " before and " <" after each item in "mylist". |
| 102 | 4272 |
| 158 | 4273 Note that {string} is the result of an expression and is then |
| 102 | 4274 used as an expression again. Often it is good to use a |
| 158 | 4275 |literal-string| to avoid having to double backslashes. You |
| 4276 still have to double ' quotes | |
| 102 | 4277 |
| 685 | 4278 The operation is done in-place. If you want a |List| or |
| 4279 |Dictionary| to remain unmodified make a copy first: > | |
| 3682 | 4280 :let tlist = map(copy(mylist), ' v:val . "\t"') |
| 102 | 4281 |
| 685 | 4282 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
| 648 | 4283 When an error is encountered while evaluating {string} no |
| 4284 further items in {expr} are processed. | |
| 95 | 4285 |
| 4286 | |
| 2610 | 4287 maparg({name}[, {mode} [, {abbr} [, {dict}]]]) *maparg()* |
| 4288 When {dict} is omitted or zero: Return the rhs of mapping | |
| 4289 {name} in mode {mode}. The returned String has special | |
| 4290 characters translated like in the output of the ":map" command | |
| 4291 listing. | |
| 4292 | |
| 4293 When there is no mapping for {name}, an empty String is | |
| 4294 returned. | |
| 4295 | |
| 4296 The {name} can have special key names, like in the ":map" | |
| 4297 command. | |
| 4298 | |
| 644 | 4299 {mode} can be one of these strings: |
| 7 | 4300 "n" Normal |
| 2610 | 4301 "v" Visual (including Select) |
| 7 | 4302 "o" Operator-pending |
| 4303 "i" Insert | |
| 4304 "c" Cmd-line | |
| 2610 | 4305 "s" Select |
| 4306 "x" Visual | |
| 7 | 4307 "l" langmap |language-mapping| |
| 4308 "" Normal, Visual and Operator-pending | |
| 644 | 4309 When {mode} is omitted, the modes for "" are used. |
| 2610 | 4310 |
| 782 | 4311 When {abbr} is there and it is non-zero use abbreviations |
| 4312 instead of mappings. | |
| 2610 | 4313 |
| 4314 When {dict} is there and it is non-zero return a dictionary | |
| 4315 containing all the information of the mapping with the | |
| 4316 following items: | |
| 4317 "lhs" The {lhs} of the mapping. | |
| 4318 "rhs" The {rhs} of the mapping as typed. | |
| 4319 "silent" 1 for a |:map-silent| mapping, else 0. | |
| 2625 | 4320 "noremap" 1 if the {rhs} of the mapping is not remappable. |
| 2610 | 4321 "expr" 1 for an expression mapping (|:map-<expr>|). |
| 4322 "buffer" 1 for a buffer local mapping (|:map-local|). | |
| 4323 "mode" Modes for which the mapping is defined. In | |
| 4324 addition to the modes mentioned above, these | |
| 4325 characters will be used: | |
| 4326 " " Normal, Visual and Operator-pending | |
| 4327 "!" Insert and Commandline mode | |
| 2642 | 4328 (|mapmode-ic|) |
| 2625 | 4329 "sid" The script local ID, used for <sid> mappings |
| 4330 (|<SID>|). | |
| 5555 | 4331 "nowait" Do not wait for other, longer mappings. |
| 4332 (|:map-<nowait>|). | |
| 2610 | 4333 |
| 7 | 4334 The mappings local to the current buffer are checked first, |
| 4335 then the global mappings. | |
| 626 | 4336 This function can be used to map a key even when it's already |
| 4337 mapped, and have it do the original mapping too. Sketch: > | |
| 4338 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
| 4339 | |
| 7 | 4340 |
| 782 | 4341 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()* |
| 7 | 4342 Check if there is a mapping that matches with {name} in mode |
| 4343 {mode}. See |maparg()| for {mode} and special names in | |
| 4344 {name}. | |
| 782 | 4345 When {abbr} is there and it is non-zero use abbreviations |
| 4346 instead of mappings. | |
| 7 | 4347 A match happens with a mapping that starts with {name} and |
| 4348 with a mapping which is equal to the start of {name}. | |
| 4349 | |
| 1621 | 4350 matches mapping "a" "ab" "abc" ~ |
| 7 | 4351 mapcheck("a") yes yes yes |
| 4352 mapcheck("abc") yes yes yes | |
| 4353 mapcheck("ax") yes no no | |
| 4354 mapcheck("b") no no no | |
| 4355 | |
| 4356 The difference with maparg() is that mapcheck() finds a | |
| 4357 mapping that matches with {name}, while maparg() only finds a | |
| 4358 mapping for {name} exactly. | |
| 4359 When there is no mapping that starts with {name}, an empty | |
| 4360 String is returned. If there is one, the rhs of that mapping | |
| 4361 is returned. If there are several mappings that start with | |
| 4362 {name}, the rhs of one of them is returned. | |
| 4363 The mappings local to the current buffer are checked first, | |
| 4364 then the global mappings. | |
| 4365 This function can be used to check if a mapping can be added | |
| 4366 without being ambiguous. Example: > | |
| 4367 :if mapcheck("_vv") == "" | |
| 4368 : map _vv :set guifont=7x13<CR> | |
| 4369 :endif | |
| 4370 < This avoids adding the "_vv" mapping when there already is a | |
| 4371 mapping for "_v" or for "_vvv". | |
| 4372 | |
| 19 | 4373 match({expr}, {pat}[, {start}[, {count}]]) *match()* |
| 685 | 4374 When {expr} is a |List| then this returns the index of the |
| 4375 first item where {pat} matches. Each item is used as a | |
| 692 | 4376 String, |Lists| and |Dictionaries| are used as echoed. |
| 1621 | 4377 Otherwise, {expr} is used as a String. The result is a |
| 95 | 4378 Number, which gives the index (byte offset) in {expr} where |
| 4379 {pat} matches. | |
| 685 | 4380 A match at the first character or |List| item returns zero. |
| 19 | 4381 If there is no match -1 is returned. |
| 2833 | 4382 For getting submatches see |matchlist()|. |
| 19 | 4383 Example: > |
| 95 | 4384 :echo match("testing", "ing") " results in 4 |
| 714 | 4385 :echo match([1, 'x'], '\a') " results in 1 |
| 95 | 4386 < See |string-match| for how {pat} is used. |
| 170 | 4387 *strpbrk()* |
| 1621 | 4388 Vim doesn't have a strpbrk() function. But you can do: > |
| 170 | 4389 :let sepidx = match(line, '[.,;: \t]') |
| 4390 < *strcasestr()* | |
| 4391 Vim doesn't have a strcasestr() function. But you can add | |
| 4392 "\c" to the pattern to ignore case: > | |
| 4393 :let idx = match(haystack, '\cneedle') | |
| 4394 < | |
| 95 | 4395 If {start} is given, the search starts from byte index |
| 685 | 4396 {start} in a String or item {start} in a |List|. |
| 7 | 4397 The result, however, is still the index counted from the |
| 236 | 4398 first character/item. Example: > |
| 7 | 4399 :echo match("testing", "ing", 2) |
| 4400 < result is again "4". > | |
| 4401 :echo match("testing", "ing", 4) | |
| 4402 < result is again "4". > | |
| 4403 :echo match("testing", "t", 2) | |
| 4404 < result is "3". | |
| 694 | 4405 For a String, if {start} > 0 then it is like the string starts |
| 703 | 4406 {start} bytes later, thus "^" will match at {start}. Except |
| 4407 when {count} is given, then it's like matches before the | |
| 4408 {start} byte are ignored (this is a bit complicated to keep it | |
| 4409 backwards compatible). | |
| 95 | 4410 For a String, if {start} < 0, it will be set to 0. For a list |
| 4411 the index is counted from the end. | |
| 697 | 4412 If {start} is out of range ({start} > strlen({expr}) for a |
| 4413 String or {start} > len({expr}) for a |List|) -1 is returned. | |
| 95 | 4414 |
| 694 | 4415 When {count} is given use the {count}'th match. When a match |
| 697 | 4416 is found in a String the search for the next one starts one |
| 694 | 4417 character further. Thus this example results in 1: > |
| 4418 echo match("testing", "..", 0, 2) | |
| 4419 < In a |List| the search continues in the next item. | |
| 703 | 4420 Note that when {count} is added the way {start} works changes, |
| 4421 see above. | |
| 694 | 4422 |
| 7 | 4423 See |pattern| for the patterns that are accepted. |
| 4424 The 'ignorecase' option is used to set the ignore-caseness of | |
| 1621 | 4425 the pattern. 'smartcase' is NOT used. The matching is always |
| 7 | 4426 done like 'magic' is set and 'cpoptions' is empty. |
| 4427 | |
| 1326 | 4428 *matchadd()* *E798* *E799* *E801* |
|
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
4429 matchadd({group}, {pattern}[, {priority}[, {id} [, {dict}]]]) |
| 1326 | 4430 Defines a pattern to be highlighted in the current window (a |
| 4431 "match"). It will be highlighted with {group}. Returns an | |
| 4432 identification number (ID), which can be used to delete the | |
| 4433 match using |matchdelete()|. | |
| 5466 | 4434 Matching is case sensitive and magic, unless case sensitivity |
| 4435 or magicness are explicitly overridden in {pattern}. The | |
| 4436 'magic', 'smartcase' and 'ignorecase' options are not used. | |
|
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
4437 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
|
4438 concealed. |
| 1326 | 4439 |
| 4440 The optional {priority} argument assigns a priority to the | |
| 1621 | 4441 match. A match with a high priority will have its |
| 1326 | 4442 highlighting overrule that of a match with a lower priority. |
| 4443 A priority is specified as an integer (negative numbers are no | |
| 4444 exception). If the {priority} argument is not specified, the | |
| 4445 default priority is 10. The priority of 'hlsearch' is zero, | |
| 4446 hence all matches with a priority greater than zero will | |
| 4447 overrule it. Syntax highlighting (see 'syntax') is a separate | |
| 4448 mechanism, and regardless of the chosen priority a match will | |
| 4449 always overrule syntax highlighting. | |
| 4450 | |
| 4451 The optional {id} argument allows the request for a specific | |
| 4452 match ID. If a specified ID is already taken, an error | |
| 4453 message will appear and the match will not be added. An ID | |
| 4454 is specified as a positive integer (zero excluded). IDs 1, 2 | |
| 4455 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
| 6947 | 4456 respectively. If the {id} argument is not specified or -1, |
| 1326 | 4457 |matchadd()| automatically chooses a free ID. |
| 4458 | |
| 6947 | 4459 The optional {dict} argmument allows for further custom |
| 4460 values. Currently this is used to specify a match specifc | |
| 4461 conceal character that will be shown for |hl-Conceal| | |
| 4462 highlighted matches. The dict can have the following members: | |
| 4463 | |
| 4464 conceal Special character to show instead of the | |
| 4465 match (only for |hl-Conceal| highlighed | |
| 4466 matches, see |:syn-cchar|) | |
| 4467 | |
| 1326 | 4468 The number of matches is not limited, as it is the case with |
| 4469 the |:match| commands. | |
| 4470 | |
| 4471 Example: > | |
| 4472 :highlight MyGroup ctermbg=green guibg=green | |
| 4473 :let m = matchadd("MyGroup", "TODO") | |
| 4474 < Deletion of the pattern: > | |
| 4475 :call matchdelete(m) | |
| 4476 | |
| 4477 < A list of matches defined by |matchadd()| and |:match| are | |
| 1621 | 4478 available from |getmatches()|. All matches can be deleted in |
| 1326 | 4479 one operation by |clearmatches()|. |
| 819 | 4480 |
| 6947 | 4481 matchaddpos({group}, {pos}[, {priority}[, {id}[, {dict}]]]) *matchaddpos()* |
| 5979 | 4482 Same as |matchadd()|, but requires a list of positions {pos} |
| 4483 instead of a pattern. This command is faster than |matchadd()| | |
| 4484 because it does not require to handle regular expressions and | |
| 4485 sets buffer line boundaries to redraw screen. It is supposed | |
| 4486 to be used when fast match additions and deletions are | |
| 4487 required, for example to highlight matching parentheses. | |
| 4488 | |
| 4489 The list {pos} can contain one of these items: | |
| 6007 | 4490 - A number. This whole line will be highlighted. The first |
| 5979 | 4491 line has number 1. |
| 4492 - A list with one number, e.g., [23]. The whole line with this | |
| 4493 number will be highlighted. | |
| 4494 - A list with two numbers, e.g., [23, 11]. The first number is | |
| 6007 | 4495 the line number, the second one is the column number (first |
| 4496 column is 1, the value must correspond to the byte index as | |
| 4497 |col()| would return). The character at this position will | |
| 4498 be highlighted. | |
| 5979 | 4499 - A list with three numbers, e.g., [23, 11, 3]. As above, but |
| 6007 | 4500 the third number gives the length of the highlight in bytes. |
| 5979 | 4501 |
| 4502 The maximum number of positions is 8. | |
| 4503 | |
| 4504 Example: > | |
| 4505 :highlight MyGroup ctermbg=green guibg=green | |
| 4506 :let m = matchaddpos("MyGroup", [[23, 24], 34]) | |
| 4507 < Deletion of the pattern: > | |
| 4508 :call matchdelete(m) | |
| 4509 | |
| 4510 < Matches added by |matchaddpos()| are returned by | |
| 4511 |getmatches()| with an entry "pos1", "pos2", etc., with the | |
| 4512 value a list like the {pos} item. | |
| 4513 These matches cannot be set via |setmatches()|, however they | |
| 4514 can still be deleted by |clearmatches()|. | |
| 4515 | |
| 819 | 4516 matcharg({nr}) *matcharg()* |
| 856 | 4517 Selects the {nr} match item, as set with a |:match|, |
| 819 | 4518 |:2match| or |:3match| command. |
| 4519 Return a |List| with two elements: | |
| 4520 The name of the highlight group used | |
| 4521 The pattern used. | |
| 4522 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
| 4523 When there is no match item set returns ['', '']. | |
| 1326 | 4524 This is useful to save and restore a |:match|. |
| 4525 Highlighting matches using the |:match| commands are limited | |
| 4526 to three matches. |matchadd()| does not have this limitation. | |
| 4527 | |
| 4528 matchdelete({id}) *matchdelete()* *E802* *E803* | |
| 4529 Deletes a match with ID {id} previously defined by |matchadd()| | |
| 1621 | 4530 or one of the |:match| commands. Returns 0 if successful, |
| 1326 | 4531 otherwise -1. See example for |matchadd()|. All matches can |
| 4532 be deleted in one operation by |clearmatches()|. | |
| 819 | 4533 |
| 19 | 4534 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4535 Same as |match()|, but return the index of first character |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4536 after the match. Example: > |
| 7 | 4537 :echo matchend("testing", "ing") |
| 4538 < results in "7". | |
| 170 | 4539 *strspn()* *strcspn()* |
| 4540 Vim doesn't have a strspn() or strcspn() function, but you can | |
| 4541 do it with matchend(): > | |
| 4542 :let span = matchend(line, '[a-zA-Z]') | |
| 4543 :let span = matchend(line, '[^a-zA-Z]') | |
| 4544 < Except that -1 is returned when there are no matches. | |
| 4545 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4546 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 4547 :echo matchend("testing", "ing", 2) |
| 4548 < results in "7". > | |
| 4549 :echo matchend("testing", "ing", 5) | |
| 4550 < result is "-1". | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4551 When {expr} is a |List| the result is equal to |match()|. |
| 7 | 4552 |
| 158 | 4553 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4554 Same as |match()|, but return a |List|. The first item in the |
| 158 | 4555 list is the matched string, same as what matchstr() would |
| 4556 return. Following items are submatches, like "\1", "\2", etc. | |
| 842 | 4557 in |:substitute|. When an optional submatch didn't match an |
| 4558 empty string is used. Example: > | |
| 4559 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
| 4560 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
| 158 | 4561 When there is no match an empty list is returned. |
| 4562 | |
| 19 | 4563 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()* |
| 1621 | 4564 Same as |match()|, but return the matched string. Example: > |
| 7 | 4565 :echo matchstr("testing", "ing") |
| 4566 < results in "ing". | |
| 4567 When there is no match "" is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4568 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 4569 :echo matchstr("testing", "ing", 2) |
| 4570 < results in "ing". > | |
| 4571 :echo matchstr("testing", "ing", 5) | |
| 4572 < result is "". | |
| 685 | 4573 When {expr} is a |List| then the matching item is returned. |
| 95 | 4574 The type isn't changed, it's not necessarily a String. |
| 7 | 4575 |
| 87 | 4576 *max()* |
| 4577 max({list}) Return the maximum value of all items in {list}. | |
| 4578 If {list} is not a list or one of the items in {list} cannot | |
| 4579 be used as a Number this results in an error. | |
| 685 | 4580 An empty |List| results in zero. |
| 87 | 4581 |
| 4582 *min()* | |
| 1215 | 4583 min({list}) Return the minimum value of all items in {list}. |
| 87 | 4584 If {list} is not a list or one of the items in {list} cannot |
| 4585 be used as a Number this results in an error. | |
| 685 | 4586 An empty |List| results in zero. |
| 87 | 4587 |
| 843 | 4588 *mkdir()* *E739* |
| 168 | 4589 mkdir({name} [, {path} [, {prot}]]) |
| 4590 Create directory {name}. | |
| 4591 If {path} is "p" then intermediate directories are created as | |
| 4592 necessary. Otherwise it must be "". | |
| 4593 If {prot} is given it is used to set the protection bits of | |
| 4594 the new directory. The default is 0755 (rwxr-xr-x: r/w for | |
| 1621 | 4595 the user readable for others). Use 0700 to make it unreadable |
| 1702 | 4596 for others. This is only used for the last part of {name}. |
| 4597 Thus if you create /tmp/foo/bar then /tmp/foo will be created | |
| 4598 with 0755. | |
| 4599 Example: > | |
| 4600 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700) | |
| 4601 < This function is not available in the |sandbox|. | |
| 168 | 4602 Not available on all systems. To check use: > |
| 4603 :if exists("*mkdir") | |
| 4604 < | |
| 7 | 4605 *mode()* |
| 1621 | 4606 mode([expr]) Return a string that indicates the current mode. |
| 1661 | 4607 If [expr] is supplied and it evaluates to a non-zero Number or |
| 4608 a non-empty String (|non-zero-arg|), then the full mode is | |
| 4609 returned, otherwise only the first letter is returned. Note | |
| 4610 that " " and "0" are also non-empty strings. | |
| 1621 | 4611 |
| 7 | 4612 n Normal |
| 1621 | 4613 no Operator-pending |
| 7 | 4614 v Visual by character |
| 4615 V Visual by line | |
| 4616 CTRL-V Visual blockwise | |
| 4617 s Select by character | |
| 4618 S Select by line | |
| 4619 CTRL-S Select blockwise | |
| 4620 i Insert | |
| 1621 | 4621 R Replace |R| |
| 4622 Rv Virtual Replace |gR| | |
| 7 | 4623 c Command-line |
| 1621 | 4624 cv Vim Ex mode |gQ| |
| 4625 ce Normal Ex mode |Q| | |
| 7 | 4626 r Hit-enter prompt |
| 1621 | 4627 rm The -- more -- prompt |
| 4628 r? A |:confirm| query of some sort | |
| 4629 ! Shell or external command is executing | |
| 4630 This is useful in the 'statusline' option or when used | |
| 4631 with |remote_expr()| In most other places it always returns | |
| 4632 "c" or "n". | |
| 4633 Also see |visualmode()|. | |
| 7 | 4634 |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4635 mzeval({expr}) *mzeval()* |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4636 Evaluate MzScheme expression {expr} and return its result |
| 3492 | 4637 converted to Vim data structures. |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4638 Numbers and strings are returned as they are. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4639 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
|
4640 returned as Vim |Lists|. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4641 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
|
4642 converted to strings. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4643 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
|
4644 Examples: > |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4645 :mz (define l (list 1 2 3)) |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4646 :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
|
4647 :echo mzeval("l") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4648 :echo mzeval("h") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4649 < |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4650 {only available when compiled with the |+mzscheme| feature} |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4651 |
| 7 | 4652 nextnonblank({lnum}) *nextnonblank()* |
| 4653 Return the line number of the first line at or below {lnum} | |
| 4654 that is not blank. Example: > | |
| 4655 if getline(nextnonblank(1)) =~ "Java" | |
| 4656 < When {lnum} is invalid or there is no non-blank line at or | |
| 4657 below it, zero is returned. | |
| 4658 See also |prevnonblank()|. | |
| 4659 | |
| 4051 | 4660 nr2char({expr}[, {utf8}]) *nr2char()* |
| 7 | 4661 Return a string with a single character, which has the number |
| 4662 value {expr}. Examples: > | |
| 4663 nr2char(64) returns "@" | |
| 4664 nr2char(32) returns " " | |
| 4051 | 4665 < When {utf8} is omitted or zero, the current 'encoding' is used. |
| 4666 Example for "utf-8": > | |
| 7 | 4667 nr2char(300) returns I with bow character |
| 4051 | 4668 < With {utf8} set to 1, always return utf-8 characters. |
| 4669 Note that a NUL character in the file is specified with | |
| 7 | 4670 nr2char(10), because NULs are represented with newline |
| 4671 characters. nr2char(0) is a real NUL and terminates the | |
| 119 | 4672 string, thus results in an empty string. |
| 7 | 4673 |
| 3214 | 4674 or({expr}, {expr}) *or()* |
| 4675 Bitwise OR on the two arguments. The arguments are converted | |
| 4676 to a number. A List, Dict or Float argument causes an error. | |
| 4677 Example: > | |
| 4678 :let bits = or(bits, 0x80) | |
| 4679 | |
| 4680 | |
| 819 | 4681 pathshorten({expr}) *pathshorten()* |
| 4682 Shorten directory names in the path {expr} and return the | |
| 4683 result. The tail, the file name, is kept as-is. The other | |
| 4684 components in the path are reduced to single letters. Leading | |
| 4685 '~' and '.' characters are kept. Example: > | |
| 4686 :echo pathshorten('~/.vim/autoload/myfile.vim') | |
| 4687 < ~/.v/a/myfile.vim ~ | |
| 4688 It doesn't matter if the path exists or not. | |
| 4689 | |
| 1621 | 4690 pow({x}, {y}) *pow()* |
| 4691 Return the power of {x} to the exponent {y} as a |Float|. | |
| 4692 {x} and {y} must evaluate to a |Float| or a |Number|. | |
| 4693 Examples: > | |
| 4694 :echo pow(3, 3) | |
| 4695 < 27.0 > | |
| 4696 :echo pow(2, 16) | |
| 4697 < 65536.0 > | |
| 4698 :echo pow(32, 0.20) | |
| 4699 < 2.0 | |
| 4700 {only available when compiled with the |+float| feature} | |
| 4701 | |
| 667 | 4702 prevnonblank({lnum}) *prevnonblank()* |
| 4703 Return the line number of the first line at or above {lnum} | |
| 4704 that is not blank. Example: > | |
| 4705 let ind = indent(prevnonblank(v:lnum - 1)) | |
| 4706 < When {lnum} is invalid or there is no non-blank line at or | |
| 4707 above it, zero is returned. | |
| 4708 Also see |nextnonblank()|. | |
| 4709 | |
| 4710 | |
| 449 | 4711 printf({fmt}, {expr1} ...) *printf()* |
| 4712 Return a String with {fmt}, where "%" items are replaced by | |
| 4713 the formatted form of their respective arguments. Example: > | |
| 452 | 4714 printf("%4d: E%d %.30s", lnum, errno, msg) |
| 449 | 4715 < May result in: |
| 452 | 4716 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
| 449 | 4717 |
| 4718 Often used items are: | |
| 856 | 4719 %s string |
| 3914 | 4720 %6S string right-aligned in 6 display cells |
| 653 | 4721 %6s string right-aligned in 6 bytes |
| 1621 | 4722 %.9s string truncated to 9 bytes |
| 4723 %c single byte | |
| 4724 %d decimal number | |
| 4725 %5d decimal number padded with spaces to 5 characters | |
| 4726 %x hex number | |
| 4727 %04x hex number padded with zeros to at least 4 characters | |
| 4728 %X hex number using upper case letters | |
| 4729 %o octal number | |
| 4730 %f floating point number in the form 123.456 | |
| 4731 %e floating point number in the form 1.234e3 | |
| 4732 %E floating point number in the form 1.234E3 | |
| 4733 %g floating point number, as %f or %e depending on value | |
| 4734 %G floating point number, as %f or %E depending on value | |
| 4735 %% the % character itself | |
| 449 | 4736 |
| 4737 Conversion specifications start with '%' and end with the | |
| 4738 conversion type. All other characters are copied unchanged to | |
| 4739 the result. | |
| 4740 | |
| 4741 The "%" starts a conversion specification. The following | |
| 452 | 4742 arguments appear in sequence: |
| 4743 | |
| 4744 % [flags] [field-width] [.precision] type | |
| 4745 | |
| 856 | 4746 flags |
| 452 | 4747 Zero or more of the following flags: |
| 4748 | |
| 449 | 4749 # The value should be converted to an "alternate |
| 4750 form". For c, d, and s conversions, this option | |
| 4751 has no effect. For o conversions, the precision | |
| 4752 of the number is increased to force the first | |
| 4753 character of the output string to a zero (except | |
| 4754 if a zero value is printed with an explicit | |
| 4755 precision of zero). | |
| 4756 For x and X conversions, a non-zero result has | |
| 4757 the string "0x" (or "0X" for X conversions) | |
| 4758 prepended to it. | |
| 452 | 4759 |
| 449 | 4760 0 (zero) Zero padding. For all conversions the converted |
| 4761 value is padded on the left with zeros rather | |
| 4762 than blanks. If a precision is given with a | |
| 4763 numeric conversion (d, o, x, and X), the 0 flag | |
| 4764 is ignored. | |
| 452 | 4765 |
| 449 | 4766 - A negative field width flag; the converted value |
| 4767 is to be left adjusted on the field boundary. | |
| 4768 The converted value is padded on the right with | |
| 4769 blanks, rather than on the left with blanks or | |
| 4770 zeros. A - overrides a 0 if both are given. | |
| 452 | 4771 |
| 449 | 4772 ' ' (space) A blank should be left before a positive |
| 4773 number produced by a signed conversion (d). | |
| 452 | 4774 |
| 449 | 4775 + A sign must always be placed before a number |
| 1621 | 4776 produced by a signed conversion. A + overrides |
| 449 | 4777 a space if both are used. |
| 452 | 4778 |
| 4779 field-width | |
| 4780 An optional decimal digit string specifying a minimum | |
| 653 | 4781 field width. If the converted value has fewer bytes |
| 4782 than the field width, it will be padded with spaces on | |
| 4783 the left (or right, if the left-adjustment flag has | |
| 4784 been given) to fill out the field width. | |
| 452 | 4785 |
| 4786 .precision | |
| 4787 An optional precision, in the form of a period '.' | |
| 4788 followed by an optional digit string. If the digit | |
| 4789 string is omitted, the precision is taken as zero. | |
| 4790 This gives the minimum number of digits to appear for | |
| 4791 d, o, x, and X conversions, or the maximum number of | |
| 653 | 4792 bytes to be printed from a string for s conversions. |
| 1621 | 4793 For floating point it is the number of digits after |
| 4794 the decimal point. | |
| 452 | 4795 |
| 4796 type | |
| 4797 A character that specifies the type of conversion to | |
| 4798 be applied, see below. | |
| 4799 | |
| 449 | 4800 A field width or precision, or both, may be indicated by an |
| 4801 asterisk '*' instead of a digit string. In this case, a | |
| 1621 | 4802 Number argument supplies the field width or precision. A |
| 449 | 4803 negative field width is treated as a left adjustment flag |
| 4804 followed by a positive field width; a negative precision is | |
| 4805 treated as though it were missing. Example: > | |
| 452 | 4806 :echo printf("%d: %.*s", nr, width, line) |
| 449 | 4807 < This limits the length of the text used from "line" to |
| 452 | 4808 "width" bytes. |
| 449 | 4809 |
| 856 | 4810 The conversion specifiers and their meanings are: |
| 452 | 4811 |
| 1621 | 4812 *printf-d* *printf-o* *printf-x* *printf-X* |
| 4813 doxX The Number argument is converted to signed decimal | |
| 449 | 4814 (d), unsigned octal (o), or unsigned hexadecimal (x |
| 4815 and X) notation. The letters "abcdef" are used for | |
| 4816 x conversions; the letters "ABCDEF" are used for X | |
| 452 | 4817 conversions. |
| 4818 The precision, if any, gives the minimum number of | |
| 4819 digits that must appear; if the converted value | |
| 4820 requires fewer digits, it is padded on the left with | |
| 4821 zeros. | |
| 4822 In no case does a non-existent or small field width | |
| 4823 cause truncation of a numeric field; if the result of | |
| 4824 a conversion is wider than the field width, the field | |
| 4825 is expanded to contain the conversion result. | |
| 4826 | |
| 1621 | 4827 *printf-c* |
| 452 | 4828 c The Number argument is converted to a byte, and the |
| 4829 resulting character is written. | |
| 4830 | |
| 1621 | 4831 *printf-s* |
| 452 | 4832 s The text of the String argument is used. If a |
| 4833 precision is specified, no more bytes than the number | |
| 4834 specified are used. | |
| 6583 | 4835 *printf-S* |
| 3914 | 4836 S The text of the String argument is used. If a |
| 4837 precision is specified, no more display cells than the | |
| 4838 number specified are used. Without the |+multi_byte| | |
| 4839 feature works just like 's'. | |
| 452 | 4840 |
| 1621 | 4841 *printf-f* *E807* |
| 4842 f The Float argument is converted into a string of the | |
| 4843 form 123.456. The precision specifies the number of | |
| 4844 digits after the decimal point. When the precision is | |
| 4845 zero the decimal point is omitted. When the precision | |
| 4846 is not specified 6 is used. A really big number | |
| 4847 (out of range or dividing by zero) results in "inf". | |
| 4848 "0.0 / 0.0" results in "nan". | |
| 4849 Example: > | |
| 4850 echo printf("%.2f", 12.115) | |
| 4851 < 12.12 | |
| 4852 Note that roundoff depends on the system libraries. | |
| 4853 Use |round()| when in doubt. | |
| 4854 | |
| 4855 *printf-e* *printf-E* | |
| 4856 e E The Float argument is converted into a string of the | |
| 4857 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
| 4858 precision specifies the number of digits after the | |
| 4859 decimal point, like with 'f'. | |
| 4860 | |
| 4861 *printf-g* *printf-G* | |
| 4862 g G The Float argument is converted like with 'f' if the | |
| 4863 value is between 0.001 (inclusive) and 10000000.0 | |
| 4864 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
| 4865 for 'G'. When no precision is specified superfluous | |
| 4866 zeroes and '+' signs are removed, except for the zero | |
| 4867 immediately after the decimal point. Thus 10000000.0 | |
| 4868 results in 1.0e7. | |
| 4869 | |
| 4870 *printf-%* | |
| 449 | 4871 % A '%' is written. No argument is converted. The |
| 4872 complete conversion specification is "%%". | |
| 452 | 4873 |
| 1668 | 4874 When a Number argument is expected a String argument is also |
| 4875 accepted and automatically converted. | |
| 4876 When a Float or String argument is expected a Number argument | |
| 4877 is also accepted and automatically converted. | |
| 4878 Any other argument type results in an error message. | |
| 449 | 4879 |
| 459 | 4880 *E766* *E767* |
| 449 | 4881 The number of {exprN} arguments must exactly match the number |
| 4882 of "%" items. If there are not sufficient or too many | |
| 452 | 4883 arguments an error is given. Up to 18 arguments can be used. |
| 449 | 4884 |
| 4885 | |
| 667 | 4886 pumvisible() *pumvisible()* |
| 4887 Returns non-zero when the popup menu is visible, zero | |
| 4888 otherwise. See |ins-completion-menu|. | |
| 712 | 4889 This can be used to avoid some things that would remove the |
| 4890 popup menu. | |
| 7 | 4891 |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4437
diff
changeset
|
4892 *E860* |
| 3682 | 4893 py3eval({expr}) *py3eval()* |
| 4894 Evaluate Python expression {expr} and return its result | |
| 4895 converted to Vim data structures. | |
| 4896 Numbers and strings are returned as they are (strings are | |
| 6647 | 4897 copied though, Unicode strings are additionally converted to |
| 3682 | 4898 'encoding'). |
| 4899 Lists are represented as Vim |List| type. | |
| 4900 Dictionaries are represented as Vim |Dictionary| type with | |
| 4901 keys converted to strings. | |
| 4902 {only available when compiled with the |+python3| feature} | |
| 4903 | |
| 4904 *E858* *E859* | |
| 4905 pyeval({expr}) *pyeval()* | |
| 4906 Evaluate Python expression {expr} and return its result | |
| 4907 converted to Vim data structures. | |
| 4908 Numbers and strings are returned as they are (strings are | |
| 4909 copied though). | |
| 4910 Lists are represented as Vim |List| type. | |
| 3830 | 4911 Dictionaries are represented as Vim |Dictionary| type, |
| 4912 non-string keys result in error. | |
| 3682 | 4913 {only available when compiled with the |+python| feature} |
| 4914 | |
| 114 | 4915 *E726* *E727* |
| 99 | 4916 range({expr} [, {max} [, {stride}]]) *range()* |
| 685 | 4917 Returns a |List| with Numbers: |
| 99 | 4918 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
| 4919 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
| 4920 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
| 4921 {max}] (increasing {expr} with {stride} each time, not | |
| 4922 producing a value past {max}). | |
| 336 | 4923 When the maximum is one before the start the result is an |
| 4924 empty list. When the maximum is more than one before the | |
| 4925 start this is an error. | |
| 99 | 4926 Examples: > |
| 856 | 4927 range(4) " [0, 1, 2, 3] |
| 99 | 4928 range(2, 4) " [2, 3, 4] |
| 4929 range(2, 9, 3) " [2, 5, 8] | |
| 856 | 4930 range(2, -2, -1) " [2, 1, 0, -1, -2] |
| 336 | 4931 range(0) " [] |
| 4932 range(2, 0) " error! | |
| 99 | 4933 < |
| 158 | 4934 *readfile()* |
| 168 | 4935 readfile({fname} [, {binary} [, {max}]]) |
| 685 | 4936 Read file {fname} and return a |List|, each line of the file |
| 4937 as an item. Lines broken at NL characters. Macintosh files | |
| 158 | 4938 separated with CR will result in a single long line (unless a |
| 4939 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
|
4940 All NUL characters are replaced with a NL character. |
| 6918 | 4941 When {binary} contains "b" binary mode is used: |
| 158 | 4942 - When the last line ends in a NL an extra empty list item is |
| 4943 added. | |
| 4944 - No CR characters are removed. | |
| 4945 Otherwise: | |
| 4946 - CR characters that appear before a NL are removed. | |
| 4947 - 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
|
4948 - 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
|
4949 removed from the text. |
| 168 | 4950 When {max} is given this specifies the maximum number of lines |
| 4951 to be read. Useful if you only want to check the first ten | |
| 4952 lines of a file: > | |
| 4953 :for line in readfile(fname, '', 10) | |
| 4954 : if line =~ 'Date' | echo line | endif | |
| 4955 :endfor | |
| 233 | 4956 < When {max} is negative -{max} lines from the end of the file |
| 4957 are returned, or as many as there are. | |
| 4958 When {max} is zero the result is an empty list. | |
| 168 | 4959 Note that without {max} the whole file is read into memory. |
| 4960 Also note that there is no recognition of encoding. Read a | |
| 4961 file into a buffer if you need to. | |
| 158 | 4962 When the file can't be opened an error message is given and |
| 4963 the result is an empty list. | |
| 4964 Also see |writefile()|. | |
| 4965 | |
| 794 | 4966 reltime([{start} [, {end}]]) *reltime()* |
| 4967 Return an item that represents a time value. The format of | |
| 4968 the item depends on the system. It can be passed to | |
| 4969 |reltimestr()| to convert it to a string. | |
| 4970 Without an argument it returns the current time. | |
| 4971 With one argument is returns the time passed since the time | |
| 4972 specified in the argument. | |
| 843 | 4973 With two arguments it returns the time passed between {start} |
| 794 | 4974 and {end}. |
| 4975 The {start} and {end} arguments must be values returned by | |
| 4976 reltime(). | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
4977 {only available when compiled with the |+reltime| feature} |
| 794 | 4978 |
| 4979 reltimestr({time}) *reltimestr()* | |
| 4980 Return a String that represents the time value of {time}. | |
| 4981 This is the number of seconds, a dot and the number of | |
| 4982 microseconds. Example: > | |
| 4983 let start = reltime() | |
| 4984 call MyFunction() | |
| 4985 echo reltimestr(reltime(start)) | |
| 4986 < Note that overhead for the commands will be added to the time. | |
| 4987 The accuracy depends on the system. | |
| 1156 | 4988 Leading spaces are used to make the string align nicely. You |
| 4989 can use split() to remove it. > | |
| 4990 echo split(reltimestr(reltime(start)))[0] | |
| 4991 < 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
|
4992 {only available when compiled with the |+reltime| feature} |
| 794 | 4993 |
| 7 | 4994 *remote_expr()* *E449* |
| 4995 remote_expr({server}, {string} [, {idvar}]) | |
| 1621 | 4996 Send the {string} to {server}. The string is sent as an |
| 7 | 4997 expression and the result is returned after evaluation. |
| 714 | 4998 The result must be a String or a |List|. A |List| is turned |
| 4999 into a String by joining the items with a line break in | |
| 5000 between (not at the end), like with join(expr, "\n"). | |
| 7 | 5001 If {idvar} is present, it is taken as the name of a |
| 5002 variable and a {serverid} for later use with | |
| 5003 remote_read() is stored there. | |
| 5004 See also |clientserver| |RemoteReply|. | |
| 5005 This function is not available in the |sandbox|. | |
| 5006 {only available when compiled with the |+clientserver| feature} | |
| 5007 Note: Any errors will cause a local error message to be issued | |
| 5008 and the result will be the empty string. | |
| 5009 Examples: > | |
| 5010 :echo remote_expr("gvim", "2+2") | |
| 5011 :echo remote_expr("gvim1", "b:current_syntax") | |
| 5012 < | |
| 5013 | |
| 5014 remote_foreground({server}) *remote_foreground()* | |
| 5015 Move the Vim server with the name {server} to the foreground. | |
| 5016 This works like: > | |
| 5017 remote_expr({server}, "foreground()") | |
| 5018 < Except that on Win32 systems the client does the work, to work | |
| 5019 around the problem that the OS doesn't always allow the server | |
| 5020 to bring itself to the foreground. | |
| 574 | 5021 Note: This does not restore the window if it was minimized, |
| 5022 like foreground() does. | |
| 7 | 5023 This function is not available in the |sandbox|. |
| 5024 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 5025 Win32 console version} | |
| 5026 | |
| 5027 | |
| 5028 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
| 5029 Returns a positive number if there are available strings | |
| 5030 from {serverid}. Copies any reply string into the variable | |
| 1621 | 5031 {retvar} if specified. {retvar} must be a string with the |
| 7 | 5032 name of a variable. |
| 5033 Returns zero if none are available. | |
| 5034 Returns -1 if something is wrong. | |
| 5035 See also |clientserver|. | |
| 5036 This function is not available in the |sandbox|. | |
| 5037 {only available when compiled with the |+clientserver| feature} | |
| 5038 Examples: > | |
| 5039 :let repl = "" | |
| 5040 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
| 5041 | |
| 5042 remote_read({serverid}) *remote_read()* | |
| 5043 Return the oldest available reply from {serverid} and consume | |
| 5044 it. It blocks until a reply is available. | |
| 5045 See also |clientserver|. | |
| 5046 This function is not available in the |sandbox|. | |
| 5047 {only available when compiled with the |+clientserver| feature} | |
| 5048 Example: > | |
| 5049 :echo remote_read(id) | |
| 5050 < | |
| 5051 *remote_send()* *E241* | |
| 5052 remote_send({server}, {string} [, {idvar}]) | |
| 1621 | 5053 Send the {string} to {server}. The string is sent as input |
| 22 | 5054 keys and the function returns immediately. At the Vim server |
| 5055 the keys are not mapped |:map|. | |
| 667 | 5056 If {idvar} is present, it is taken as the name of a variable |
| 5057 and a {serverid} for later use with remote_read() is stored | |
| 5058 there. | |
| 7 | 5059 See also |clientserver| |RemoteReply|. |
| 5060 This function is not available in the |sandbox|. | |
| 5061 {only available when compiled with the |+clientserver| feature} | |
| 5062 Note: Any errors will be reported in the server and may mess | |
| 5063 up the display. | |
| 5064 Examples: > | |
| 5065 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
| 5066 \ remote_read(serverid) | |
| 5067 | |
| 5068 :autocmd NONE RemoteReply * | |
| 5069 \ echo remote_read(expand("<amatch>")) | |
| 5070 :echo remote_send("gvim", ":sleep 10 | echo ". | |
| 5071 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
| 82 | 5072 < |
| 79 | 5073 remove({list}, {idx} [, {end}]) *remove()* |
| 685 | 5074 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
|
5075 return the item. |
| 79 | 5076 With {end}: Remove items from {idx} to {end} (inclusive) and |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5077 return a List with these items. When {idx} points to the same |
| 79 | 5078 item as {end} a list with one item is returned. When {end} |
| 5079 points to an item before {idx} this is an error. | |
| 5080 See |list-index| for possible values of {idx} and {end}. | |
| 55 | 5081 Example: > |
| 5082 :echo "last item: " . remove(mylist, -1) | |
| 79 | 5083 :call remove(mylist, 0, 9) |
| 99 | 5084 remove({dict}, {key}) |
| 5085 Remove the entry from {dict} with key {key}. Example: > | |
| 5086 :echo "removed " . remove(dict, "one") | |
| 5087 < If there is no {key} in {dict} this is an error. | |
| 5088 | |
| 5089 Use |delete()| to remove a file. | |
| 55 | 5090 |
| 7 | 5091 rename({from}, {to}) *rename()* |
| 5092 Rename the file by the name {from} to the name {to}. This | |
| 5093 should also work to move files across file systems. The | |
| 5094 result is a Number, which is 0 if the file was renamed | |
| 5095 successfully, and non-zero when the renaming failed. | |
| 1851 | 5096 NOTE: If {to} exists it is overwritten without warning. |
| 7 | 5097 This function is not available in the |sandbox|. |
| 5098 | |
| 18 | 5099 repeat({expr}, {count}) *repeat()* |
| 5100 Repeat {expr} {count} times and return the concatenated | |
| 5101 result. Example: > | |
| 843 | 5102 :let separator = repeat('-', 80) |
| 18 | 5103 < When {count} is zero or negative the result is empty. |
| 685 | 5104 When {expr} is a |List| the result is {expr} concatenated |
| 1621 | 5105 {count} times. Example: > |
| 79 | 5106 :let longlist = repeat(['a', 'b'], 3) |
| 5107 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
| 18 | 5108 |
| 82 | 5109 |
| 7 | 5110 resolve({filename}) *resolve()* *E655* |
| 5111 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
| 5112 returns the path the shortcut points to in a simplified form. | |
| 5113 On Unix, repeat resolving symbolic links in all path | |
| 5114 components of {filename} and return the simplified result. | |
| 5115 To cope with link cycles, resolving of symbolic links is | |
| 5116 stopped after 100 iterations. | |
| 5117 On other systems, return the simplified {filename}. | |
| 5118 The simplification step is done as by |simplify()|. | |
| 5119 resolve() keeps a leading path component specifying the | |
| 5120 current directory (provided the result is still a relative | |
| 5121 path name) and also keeps a trailing path separator. | |
| 5122 | |
| 82 | 5123 *reverse()* |
| 1621 | 5124 reverse({list}) Reverse the order of items in {list} in-place. Returns |
| 82 | 5125 {list}. |
| 5126 If you want a list to remain unmodified make a copy first: > | |
| 5127 :let revlist = reverse(copy(mylist)) | |
| 5128 | |
| 1621 | 5129 round({expr}) *round()* |
| 1668 | 5130 Round off {expr} to the nearest integral value and return it |
| 1621 | 5131 as a |Float|. If {expr} lies halfway between two integral |
| 5132 values, then use the larger one (away from zero). | |
| 5133 {expr} must evaluate to a |Float| or a |Number|. | |
| 5134 Examples: > | |
| 5135 echo round(0.456) | |
| 5136 < 0.0 > | |
| 5137 echo round(4.5) | |
| 5138 < 5.0 > | |
| 5139 echo round(-4.5) | |
| 5140 < -5.0 | |
| 5141 {only available when compiled with the |+float| feature} | |
| 3996 | 5142 |
|
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5143 screenattr(row, col) *screenattr()* |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5144 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
|
5145 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
|
5146 attribute at other positions. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5147 |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5148 screenchar(row, col) *screenchar()* |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5149 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
|
5150 [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
|
5151 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
|
5152 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
|
5153 The character excludes composing characters. For double-byte |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5154 encodings it may only be the first byte. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5155 This is mainly to be used for testing. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5156 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
|
5157 |
| 3996 | 5158 screencol() *screencol()* |
| 5159 The result is a Number, which is the current screen column of | |
| 5160 the cursor. The leftmost column has number 1. | |
| 5161 This function is mainly used for testing. | |
| 5162 | |
| 5163 Note: Always returns the current screen column, thus if used | |
| 5164 in a command (e.g. ":echo screencol()") it will return the | |
| 5165 column inside the command line, which is 1 when the command is | |
| 5166 executed. To get the cursor position in the file use one of | |
| 5167 the following mappings: > | |
| 5168 nnoremap <expr> GG ":echom ".screencol()."\n" | |
| 5169 nnoremap <silent> GG :echom screencol()<CR> | |
| 5170 < | |
| 5171 screenrow() *screenrow()* | |
| 5172 The result is a Number, which is the current screen row of the | |
| 5173 cursor. The top line has number one. | |
| 5174 This function is mainly used for testing. | |
| 5175 | |
| 5176 Note: Same restrictions as with |screencol()|. | |
| 5177 | |
| 1496 | 5178 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()* |
| 7 | 5179 Search for regexp pattern {pattern}. The search starts at the |
| 119 | 5180 cursor position (you can use |cursor()| to set it). |
| 707 | 5181 |
| 3967 | 5182 When a match has been found its line number is returned. |
| 3312 | 5183 If there is no match a 0 is returned and the cursor doesn't |
| 5184 move. No error message is given. | |
| 5185 | |
| 7 | 5186 {flags} is a String, which can contain these character flags: |
| 5187 'b' search backward instead of forward | |
| 1621 | 5188 'c' accept a match at the cursor position |
| 712 | 5189 'e' move to the End of the match |
| 20 | 5190 'n' do Not move the cursor |
| 712 | 5191 'p' return number of matching sub-pattern (see below) |
| 5192 's' set the ' mark at the previous location of the cursor | |
| 7 | 5193 'w' wrap around the end of the file |
| 5194 'W' don't wrap around the end of the file | |
| 5195 If neither 'w' or 'W' is given, the 'wrapscan' option applies. | |
| 5196 | |
| 444 | 5197 If the 's' flag is supplied, the ' mark is set, only if the |
| 5198 cursor is moved. The 's' flag cannot be combined with the 'n' | |
| 5199 flag. | |
| 5200 | |
| 1156 | 5201 'ignorecase', 'smartcase' and 'magic' are used. |
| 5202 | |
| 692 | 5203 When the {stopline} argument is given then the search stops |
| 5204 after searching this line. This is useful to restrict the | |
| 5205 search to a range of lines. Examples: > | |
| 5206 let match = search('(', 'b', line("w0")) | |
| 5207 let end = search('END', '', line("w$")) | |
| 5208 < When {stopline} is used and it is not zero this also implies | |
| 5209 that the search does not wrap around the end of the file. | |
| 1496 | 5210 A zero value is equal to not giving the argument. |
| 5211 | |
| 5212 When the {timeout} argument is given the search stops when | |
| 3513 | 5213 more than this many milliseconds have passed. Thus when |
| 1496 | 5214 {timeout} is 500 the search stops after half a second. |
| 5215 The value must not be negative. A zero value is like not | |
| 5216 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
|
5217 {only available when compiled with the |+reltime| feature} |
| 692 | 5218 |
| 714 | 5219 *search()-sub-match* |
| 5220 With the 'p' flag the returned value is one more than the | |
| 5221 first sub-match in \(\). One if none of them matched but the | |
| 5222 whole pattern did match. | |
| 712 | 5223 To get the column number too use |searchpos()|. |
| 5224 | |
| 20 | 5225 The cursor will be positioned at the match, unless the 'n' |
| 707 | 5226 flag is used. |
| 7 | 5227 |
| 5228 Example (goes over all files in the argument list): > | |
| 5229 :let n = 1 | |
| 5230 :while n <= argc() " loop over all files in arglist | |
| 5231 : exe "argument " . n | |
| 5232 : " start at the last char in the file and wrap for the | |
| 5233 : " first search to find match at start of file | |
| 5234 : normal G$ | |
| 5235 : let flags = "w" | |
| 5236 : while search("foo", flags) > 0 | |
| 1621 | 5237 : s/foo/bar/g |
| 7 | 5238 : let flags = "W" |
| 5239 : endwhile | |
| 5240 : update " write the file if modified | |
| 5241 : let n = n + 1 | |
| 5242 :endwhile | |
| 5243 < | |
| 712 | 5244 Example for using some flags: > |
| 5245 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
| 5246 < This will search for the keywords "if", "else", and "endif" | |
| 5247 under or after the cursor. Because of the 'p' flag, it | |
| 5248 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
| 5249 if the search fails. With the cursor on the first word of the | |
| 5250 line: | |
| 5251 if (foo == 0) | let foo = foo + 1 | endif ~ | |
| 5252 the function returns 1. Without the 'c' flag, the function | |
| 5253 finds the "endif" and returns 3. The same thing happens | |
| 5254 without the 'e' flag if the cursor is on the "f" of "if". | |
| 5255 The 'n' flag tells the function not to move the cursor. | |
| 5256 | |
| 504 | 5257 |
| 523 | 5258 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
| 5259 Search for the declaration of {name}. | |
| 856 | 5260 |
| 523 | 5261 With a non-zero {global} argument it works like |gD|, find |
| 5262 first match in the file. Otherwise it works like |gd|, find | |
| 5263 first match in the function. | |
| 5264 | |
| 5265 With a non-zero {thisblock} argument matches in a {} block | |
| 5266 that ends before the cursor position are ignored. Avoids | |
| 5267 finding variable declarations only valid in another scope. | |
| 5268 | |
| 504 | 5269 Moves the cursor to the found match. |
| 5270 Returns zero for success, non-zero for failure. | |
| 5271 Example: > | |
| 5272 if searchdecl('myvar') == 0 | |
| 5273 echo getline('.') | |
| 5274 endif | |
| 5275 < | |
| 7 | 5276 *searchpair()* |
| 1496 | 5277 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
| 5278 [, {stopline} [, {timeout}]]]]) | |
| 7 | 5279 Search for the match of a nested start-end pair. This can be |
| 5280 used to find the "endif" that matches an "if", while other | |
| 5281 if/endif pairs in between are ignored. | |
| 677 | 5282 The search starts at the cursor. The default is to search |
| 5283 forward, include 'b' in {flags} to search backward. | |
| 5284 If a match is found, the cursor is positioned at it and the | |
| 5285 line number is returned. If no match is found 0 or -1 is | |
| 5286 returned and the cursor doesn't move. No error message is | |
| 5287 given. | |
| 7 | 5288 |
| 5289 {start}, {middle} and {end} are patterns, see |pattern|. They | |
| 5290 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
| 5291 {middle} is not empty, it is found when searching from either | |
| 5292 direction, but only when not in a nested start-end pair. A | |
| 5293 typical use is: > | |
| 5294 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
| 5295 < By leaving {middle} empty the "else" is skipped. | |
| 5296 | |
| 712 | 5297 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
| 5298 |search()|. Additionally: | |
| 7 | 5299 'r' Repeat until no more matches found; will find the |
| 1621 | 5300 outer pair. Implies the 'W' flag. |
| 5301 'm' Return number of matches instead of line number with | |
| 712 | 5302 the match; will be > 1 when 'r' is used. |
| 1621 | 5303 Note: it's nearly always a good idea to use the 'W' flag, to |
| 5304 avoid wrapping around the end of the file. | |
| 7 | 5305 |
| 5306 When a match for {start}, {middle} or {end} is found, the | |
| 5307 {skip} expression is evaluated with the cursor positioned on | |
| 5308 the start of the match. It should return non-zero if this | |
| 5309 match is to be skipped. E.g., because it is inside a comment | |
| 5310 or a string. | |
| 5311 When {skip} is omitted or empty, every match is accepted. | |
| 5312 When evaluating {skip} causes an error the search is aborted | |
| 5313 and -1 returned. | |
| 5314 | |
| 1496 | 5315 For {stopline} and {timeout} see |search()|. |
| 692 | 5316 |
| 7 | 5317 The value of 'ignorecase' is used. 'magic' is ignored, the |
| 5318 patterns are used like it's on. | |
| 5319 | |
| 5320 The search starts exactly at the cursor. A match with | |
| 5321 {start}, {middle} or {end} at the next character, in the | |
| 5322 direction of searching, is the first one found. Example: > | |
| 5323 if 1 | |
| 5324 if 2 | |
| 5325 endif 2 | |
| 5326 endif 1 | |
| 5327 < When starting at the "if 2", with the cursor on the "i", and | |
| 5328 searching forwards, the "endif 2" is found. When starting on | |
| 5329 the character just before the "if 2", the "endif 1" will be | |
| 1621 | 5330 found. That's because the "if 2" will be found first, and |
| 7 | 5331 then this is considered to be a nested if/endif from "if 2" to |
| 5332 "endif 2". | |
| 5333 When searching backwards and {end} is more than one character, | |
| 5334 it may be useful to put "\zs" at the end of the pattern, so | |
| 5335 that when the cursor is inside a match with the end it finds | |
| 5336 the matching start. | |
| 5337 | |
| 5338 Example, to find the "endif" command in a Vim script: > | |
| 5339 | |
| 5340 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
| 5341 \ 'getline(".") =~ "^\\s*\""') | |
| 5342 | |
| 5343 < The cursor must be at or after the "if" for which a match is | |
| 5344 to be found. Note that single-quote strings are used to avoid | |
| 5345 having to double the backslashes. The skip expression only | |
| 5346 catches comments at the start of a line, not after a command. | |
| 5347 Also, a word "en" or "if" halfway a line is considered a | |
| 5348 match. | |
| 5349 Another example, to search for the matching "{" of a "}": > | |
| 5350 | |
| 5351 :echo searchpair('{', '', '}', 'bW') | |
| 5352 | |
| 5353 < This works when the cursor is at or before the "}" for which a | |
| 5354 match is to be found. To reject matches that syntax | |
| 5355 highlighting recognized as strings: > | |
| 5356 | |
| 5357 :echo searchpair('{', '', '}', 'bW', | |
| 5358 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
| 5359 < | |
| 667 | 5360 *searchpairpos()* |
| 1496 | 5361 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
| 5362 [, {stopline} [, {timeout}]]]]) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5363 Same as |searchpair()|, but returns a |List| with the line and |
| 685 | 5364 column position of the match. The first element of the |List| |
| 5365 is the line number and the second element is the byte index of | |
| 667 | 5366 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
|
5367 returns [0, 0]. > |
|
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5368 |
| 667 | 5369 :let [lnum,col] = searchpairpos('{', '', '}', 'n') |
| 5370 < | |
| 5371 See |match-parens| for a bigger and more useful example. | |
| 5372 | |
| 1496 | 5373 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()* |
| 692 | 5374 Same as |search()|, but returns a |List| with the line and |
| 685 | 5375 column position of the match. The first element of the |List| |
| 5376 is the line number and the second element is the byte index of | |
| 5377 the column position of the match. If no match is found, | |
| 5378 returns [0, 0]. | |
| 714 | 5379 Example: > |
| 5380 :let [lnum, col] = searchpos('mypattern', 'n') | |
| 5381 | |
| 5382 < When the 'p' flag is given then there is an extra item with | |
| 5383 the sub-pattern match number |search()-sub-match|. Example: > | |
| 5384 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
| 5385 < In this example "submatch" is 2 when a lowercase letter is | |
| 5386 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
| 5387 | |
| 7 | 5388 server2client( {clientid}, {string}) *server2client()* |
| 5389 Send a reply string to {clientid}. The most recent {clientid} | |
| 5390 that sent a string can be retrieved with expand("<client>"). | |
| 5391 {only available when compiled with the |+clientserver| feature} | |
| 5392 Note: | |
| 5393 This id has to be stored before the next command can be | |
| 236 | 5394 received. I.e. before returning from the received command and |
| 7 | 5395 before calling any commands that waits for input. |
| 5396 See also |clientserver|. | |
| 5397 Example: > | |
| 5398 :echo server2client(expand("<client>"), "HELLO") | |
| 5399 < | |
| 5400 serverlist() *serverlist()* | |
| 5401 Return a list of available server names, one per line. | |
| 5402 When there are no servers or the information is not available | |
| 5403 an empty string is returned. See also |clientserver|. | |
| 5404 {only available when compiled with the |+clientserver| feature} | |
| 5405 Example: > | |
| 5406 :echo serverlist() | |
| 5407 < | |
| 5408 setbufvar({expr}, {varname}, {val}) *setbufvar()* | |
| 5409 Set option or local variable {varname} in buffer {expr} to | |
| 5410 {val}. | |
| 5411 This also works for a global or local window option, but it | |
| 5412 doesn't work for a global or local window variable. | |
| 5413 For a local window option the global value is unchanged. | |
| 5414 For the use of {expr}, see |bufname()| above. | |
| 5415 Note that the variable name without "b:" must be used. | |
| 5416 Examples: > | |
| 5417 :call setbufvar(1, "&mod", 1) | |
| 5418 :call setbufvar("todo", "myvar", "foobar") | |
| 5419 < This function is not available in the |sandbox|. | |
| 5420 | |
| 6991 | 5421 setcharsearch() *setcharsearch()* |
| 5422 Set the current character search information to {dict}, | |
| 5423 which contains one or more of the following entries: | |
| 5424 | |
| 5425 char character which will be used for a subsequent | |
| 5426 |,| or |;| command; an empty string clears the | |
| 5427 character search | |
| 5428 forward direction of character search; 1 for forward, | |
| 5429 0 for backward | |
| 5430 until type of character search; 1 for a |t| or |T| | |
| 5431 character search, 0 for an |f| or |F| | |
| 5432 character search | |
| 5433 | |
| 5434 This can be useful to save/restore a user's character search | |
| 5435 from a script: > | |
| 5436 :let prevsearch = getcharsearch() | |
| 5437 :" Perform a command which clobbers user's search | |
| 5438 :call setcharsearch(prevsearch) | |
| 5439 < Also see |getcharsearch()|. | |
| 5440 | |
| 7 | 5441 setcmdpos({pos}) *setcmdpos()* |
| 5442 Set the cursor position in the command line to byte position | |
| 1621 | 5443 {pos}. The first position is 1. |
| 7 | 5444 Use |getcmdpos()| to obtain the current position. |
| 5445 Only works while editing the command line, thus you must use | |
| 99 | 5446 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
| 5447 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
| 5448 set after the command line is set to the expression. For | |
| 5449 |c_CTRL-R_=| it is set after evaluating the expression but | |
| 5450 before inserting the resulting text. | |
| 7 | 5451 When the number is too big the cursor is put at the end of the |
| 5452 line. A number smaller than one has undefined results. | |
| 5453 Returns 0 when successful, 1 when not editing the command | |
| 5454 line. | |
| 5455 | |
| 1621 | 5456 setline({lnum}, {text}) *setline()* |
| 3312 | 5457 Set line {lnum} of the current buffer to {text}. To insert |
| 5458 lines use |append()|. | |
| 236 | 5459 {lnum} is used like with |getline()|. |
| 1621 | 5460 When {lnum} is just below the last line the {text} will be |
| 282 | 5461 added as a new line. |
| 236 | 5462 If this succeeds, 0 is returned. If this fails (most likely |
| 5463 because {lnum} is invalid) 1 is returned. Example: > | |
| 7 | 5464 :call setline(5, strftime("%c")) |
| 1621 | 5465 < When {text} is a |List| then line {lnum} and following lines |
| 282 | 5466 will be set to the items in the list. Example: > |
| 5467 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
| 5468 < This is equivalent to: > | |
| 3465 | 5469 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']] |
| 282 | 5470 : call setline(n, l) |
| 5471 :endfor | |
| 7 | 5472 < Note: The '[ and '] marks are not set. |
| 5473 | |
| 647 | 5474 setloclist({nr}, {list} [, {action}]) *setloclist()* |
| 5475 Create or replace or add to the location list for window {nr}. | |
| 5476 When {nr} is zero the current window is used. For a location | |
| 648 | 5477 list window, the displayed location list is modified. For an |
| 5478 invalid window number {nr}, -1 is returned. | |
| 1326 | 5479 Otherwise, same as |setqflist()|. |
| 5480 Also see |location-list|. | |
| 5481 | |
| 5482 setmatches({list}) *setmatches()* | |
| 5483 Restores a list of matches saved by |getmatches()|. Returns 0 | |
| 1621 | 5484 if successful, otherwise -1. All current matches are cleared |
| 1326 | 5485 before the list is restored. See example for |getmatches()|. |
| 230 | 5486 |
| 707 | 5487 *setpos()* |
| 5488 setpos({expr}, {list}) | |
| 5489 Set the position for {expr}. Possible values: | |
| 5490 . the cursor | |
| 5491 'x mark x | |
| 5492 | |
| 5938 | 5493 {list} must be a |List| with four or five numbers: |
| 707 | 5494 [bufnum, lnum, col, off] |
| 5938 | 5495 [bufnum, lnum, col, off, curswant] |
| 707 | 5496 |
| 1621 | 5497 "bufnum" is the buffer number. Zero can be used for the |
| 856 | 5498 current buffer. Setting the cursor is only possible for |
| 707 | 5499 the current buffer. To set a mark in another buffer you can |
| 5500 use the |bufnr()| function to turn a file name into a buffer | |
| 5501 number. | |
| 798 | 5502 Does not change the jumplist. |
| 707 | 5503 |
| 5504 "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
|
5505 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
|
5506 smaller than 1 then 1 is used. |
| 707 | 5507 |
| 5508 The "off" number is only used when 'virtualedit' is set. Then | |
| 5509 it is the offset in screen columns from the start of the | |
| 1266 | 5510 character. E.g., a position within a <Tab> or after the last |
| 707 | 5511 character. |
| 5512 | |
| 5938 | 5513 The "curswant" number is only used when setting the cursor |
| 5514 position. It sets the preferred column for when moving the | |
| 5515 cursor vertically. When the "curswant" number is missing the | |
| 5516 preferred column is not set. When it is present and setting a | |
| 5517 mark position it is not used. | |
| 5518 | |
| 5555 | 5519 Note that for '< and '> changing the line number may result in |
| 5520 the marks to be effectively be swapped, so that '< is always | |
| 5521 before '>. | |
| 5522 | |
| 1533 | 5523 Returns 0 when the position could be set, -1 otherwise. |
| 5524 An error message is given if {expr} is invalid. | |
| 5525 | |
| 5944 | 5526 Also see |getpos()| and |getcurpos()|. |
| 707 | 5527 |
| 1156 | 5528 This does not restore the preferred column for moving |
| 5938 | 5529 vertically; if you set the cursor position with this, |j| and |
| 5530 |k| motions will jump to previous columns! Use |cursor()| to | |
| 5531 also set the preferred column. Also see the "curswant" key in | |
| 5532 |winrestview()|. | |
| 1156 | 5533 |
| 707 | 5534 |
| 277 | 5535 setqflist({list} [, {action}]) *setqflist()* |
| 647 | 5536 Create or replace or add to the quickfix list using the items |
| 5537 in {list}. Each item in {list} is a dictionary. | |
| 5538 Non-dictionary items in {list} are ignored. Each dictionary | |
| 5539 item can contain the following entries: | |
| 230 | 5540 |
| 1065 | 5541 bufnr buffer number; must be the number of a valid |
| 1621 | 5542 buffer |
| 1065 | 5543 filename name of a file; only used when "bufnr" is not |
| 1621 | 5544 present or it is invalid. |
| 230 | 5545 lnum line number in the file |
| 233 | 5546 pattern search pattern used to locate the error |
| 230 | 5547 col column number |
| 233 | 5548 vcol when non-zero: "col" is visual column |
| 856 | 5549 when zero: "col" is byte index |
| 233 | 5550 nr error number |
| 230 | 5551 text description of the error |
| 233 | 5552 type single-character error type, 'E', 'W', etc. |
| 5553 | |
| 5554 The "col", "vcol", "nr", "type" and "text" entries are | |
| 5555 optional. Either "lnum" or "pattern" entry can be used to | |
| 5556 locate a matching error line. | |
| 1065 | 5557 If the "filename" and "bufnr" entries are not present or |
| 5558 neither the "lnum" or "pattern" entries are present, then the | |
| 5559 item will not be handled as an error line. | |
| 230 | 5560 If both "pattern" and "lnum" are present then "pattern" will |
| 5561 be used. | |
| 2152 | 5562 If you supply an empty {list}, the quickfix list will be |
| 5563 cleared. | |
| 1065 | 5564 Note that the list is not exactly the same as what |
| 5565 |getqflist()| returns. | |
| 230 | 5566 |
| 277 | 5567 If {action} is set to 'a', then the items from {list} are |
| 5568 added to the existing quickfix list. If there is no existing | |
| 5569 list, then a new list is created. If {action} is set to 'r', | |
| 5570 then the items from the current quickfix list are replaced | |
| 5571 with the items from {list}. If {action} is not present or is | |
| 5572 set to ' ', then a new list is created. | |
| 5573 | |
| 230 | 5574 Returns zero for success, -1 for failure. |
| 5575 | |
| 5576 This function can be used to create a quickfix list | |
| 5577 independent of the 'errorformat' setting. Use a command like | |
| 5578 ":cc 1" to jump to the first position. | |
| 5579 | |
| 5580 | |
| 7 | 5581 *setreg()* |
| 5582 setreg({regname}, {value} [,{options}]) | |
| 5583 Set the register {regname} to {value}. | |
| 5798 | 5584 {value} may be any value returned by |getreg()|, including |
| 5585 a |List|. | |
| 7 | 5586 If {options} contains "a" or {regname} is upper case, |
| 5587 then the value is appended. | |
| 2423 | 5588 {options} can also contain a register type specification: |
| 7 | 5589 "c" or "v" |characterwise| mode |
| 5590 "l" or "V" |linewise| mode | |
| 5591 "b" or "<CTRL-V>" |blockwise-visual| mode | |
| 5592 If a number immediately follows "b" or "<CTRL-V>" then this is | |
| 5593 used as the width of the selection - if it is not specified | |
| 5594 then the width of the block is set to the number of characters | |
| 1266 | 5595 in the longest line (counting a <Tab> as 1 character). |
| 7 | 5596 |
| 5597 If {options} contains no register settings, then the default | |
| 5798 | 5598 is to use character mode unless {value} ends in a <NL> for |
| 5599 string {value} and linewise mode for list {value}. Blockwise | |
| 5600 mode is never selected automatically. | |
| 5601 Returns zero for success, non-zero for failure. | |
| 5602 | |
| 5603 *E883* | |
| 6180 | 5604 Note: you may not use |List| containing more than one item to |
| 5798 | 5605 set search and expression registers. Lists containing no |
| 5606 items act like empty strings. | |
| 7 | 5607 |
| 5608 Examples: > | |
| 5609 :call setreg(v:register, @*) | |
| 5610 :call setreg('*', @%, 'ac') | |
| 5611 :call setreg('a', "1\n2\n3", 'b5') | |
| 5612 | |
| 5613 < This example shows using the functions to save and restore a | |
| 5798 | 5614 register (note: you may not reliably restore register value |
| 5615 without using the third argument to |getreg()| as without it | |
| 5616 newlines are represented as newlines AND Nul bytes are | |
| 5617 represented as newlines as well, see |NL-used-for-Nul|). > | |
| 5618 :let var_a = getreg('a', 1, 1) | |
| 7 | 5619 :let var_amode = getregtype('a') |
| 5620 .... | |
| 5621 :call setreg('a', var_a, var_amode) | |
| 5622 | |
| 5623 < You can also change the type of a register by appending | |
| 5624 nothing: > | |
| 5625 :call setreg('a', '', 'al') | |
| 5626 | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5627 settabvar({tabnr}, {varname}, {val}) *settabvar()* |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5628 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
|
5629 |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5630 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
|
5631 Tabs are numbered starting with one. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5632 This function is not available in the |sandbox|. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5633 |
| 831 | 5634 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
| 5635 Set option or local variable {varname} in window {winnr} to | |
| 5636 {val}. | |
| 5637 Tabs are numbered starting with one. For the current tabpage | |
| 5638 use |setwinvar()|. | |
| 5639 When {winnr} is zero the current window is used. | |
| 7 | 5640 This also works for a global or local buffer option, but it |
| 5641 doesn't work for a global or local buffer variable. | |
| 5642 For a local buffer option the global value is unchanged. | |
| 5643 Note that the variable name without "w:" must be used. | |
| 831 | 5644 Examples: > |
| 5645 :call settabwinvar(1, 1, "&list", 0) | |
| 5646 :call settabwinvar(3, 2, "myvar", "foobar") | |
| 5647 < This function is not available in the |sandbox|. | |
| 5648 | |
| 5649 setwinvar({nr}, {varname}, {val}) *setwinvar()* | |
| 5650 Like |settabwinvar()| for the current tab page. | |
| 7 | 5651 Examples: > |
| 5652 :call setwinvar(1, "&list", 0) | |
| 5653 :call setwinvar(2, "myvar", "foobar") | |
| 5654 | |
| 4126 | 5655 sha256({string}) *sha256()* |
| 6647 | 5656 Returns a String with 64 hex characters, which is the SHA256 |
| 4126 | 5657 checksum of {string}. |
| 5658 {only available when compiled with the |+cryptv| feature} | |
| 5659 | |
| 1661 | 5660 shellescape({string} [, {special}]) *shellescape()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5661 Escape {string} for use as a shell command argument. |
| 985 | 5662 On MS-Windows and MS-DOS, when 'shellslash' is not set, it |
| 1661 | 5663 will enclose {string} in double quotes and double all double |
| 985 | 5664 quotes within {string}. |
| 5665 For other systems, it will enclose {string} in single quotes | |
| 5666 and replace all "'" with "'\''". | |
| 1661 | 5667 When the {special} argument is present and it's a non-zero |
| 5668 Number or a non-empty String (|non-zero-arg|), then special | |
| 1698 | 5669 items such as "!", "%", "#" and "<cword>" will be preceded by |
| 5670 a backslash. This backslash will be removed again by the |:!| | |
| 1661 | 5671 command. |
| 1698 | 5672 The "!" character will be escaped (again with a |non-zero-arg| |
| 5673 {special}) when 'shell' contains "csh" in the tail. That is | |
| 5674 because for csh and tcsh "!" is used for history replacement | |
| 5675 even when inside single quotes. | |
| 5676 The <NL> character is also escaped. With a |non-zero-arg| | |
| 5677 {special} and 'shell' containing "csh" in the tail it's | |
| 5678 escaped a second time. | |
| 1661 | 5679 Example of use with a |:!| command: > |
| 5680 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
| 5681 < This results in a directory listing for the file under the | |
| 5682 cursor. Example of use with |system()|: > | |
| 5683 :call system("chmod +w -- " . shellescape(expand("%"))) | |
| 5690 | 5684 < See also |::S|. |
| 985 | 5685 |
| 5686 | |
| 3875 | 5687 shiftwidth() *shiftwidth()* |
| 5688 Returns the effective value of 'shiftwidth'. This is the | |
| 5689 'shiftwidth' value unless it is zero, in which case it is the | |
| 5690 'tabstop' value. To be backwards compatible in indent | |
| 5691 plugins, use this: > | |
| 5692 if exists('*shiftwidth') | |
| 5693 func s:sw() | |
| 5694 return shiftwidth() | |
| 5695 endfunc | |
| 5696 else | |
| 5697 func s:sw() | |
| 5698 return &sw | |
| 5699 endfunc | |
| 5700 endif | |
| 5701 < And then use s:sw() instead of &sw. | |
| 5702 | |
| 5703 | |
| 7 | 5704 simplify({filename}) *simplify()* |
| 5705 Simplify the file name as much as possible without changing | |
| 5706 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
| 5707 Unix) are not resolved. If the first path component in | |
| 5708 {filename} designates the current directory, this will be | |
| 5709 valid for the result as well. A trailing path separator is | |
| 5710 not removed either. | |
| 5711 Example: > | |
| 5712 simplify("./dir/.././/file/") == "./file/" | |
| 5713 < Note: The combination "dir/.." is only removed if "dir" is | |
| 5714 a searchable directory or does not exist. On Unix, it is also | |
| 5715 removed when "dir" is a symbolic link within the same | |
| 5716 directory. In order to resolve all the involved symbolic | |
| 5717 links before simplifying the path name, use |resolve()|. | |
| 5718 | |
| 82 | 5719 |
| 1621 | 5720 sin({expr}) *sin()* |
| 5721 Return the sine of {expr}, measured in radians, as a |Float|. | |
| 5722 {expr} must evaluate to a |Float| or a |Number|. | |
| 5723 Examples: > | |
| 5724 :echo sin(100) | |
| 5725 < -0.506366 > | |
| 5726 :echo sin(-4.01) | |
| 5727 < 0.763301 | |
| 5728 {only available when compiled with the |+float| feature} | |
| 5729 | |
| 5730 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5731 sinh({expr}) *sinh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5732 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
|
5733 [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5734 {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
|
5735 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5736 :echo sinh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5737 < 0.521095 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5738 :echo sinh(-0.9) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5739 < -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
|
5740 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5741 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5742 |
| 2902 | 5743 sort({list} [, {func} [, {dict}]]) *sort()* *E702* |
| 5747 | 5744 Sort the items in {list} in-place. Returns {list}. |
| 5745 | |
| 5746 If you want a list to remain unmodified make a copy first: > | |
| 82 | 5747 :let sortedlist = sort(copy(mylist)) |
| 5968 | 5748 |
| 6009 | 5749 < When {func} is omitted, is empty or zero, then sort() uses the |
| 5750 string representation of each item to sort on. Numbers sort | |
| 5751 after Strings, |Lists| after Numbers. For sorting text in the | |
| 5752 current buffer use |:sort|. | |
| 5753 | |
| 6180 | 5754 When {func} is given and it is '1' or 'i' then case is |
| 6009 | 5755 ignored. |
| 5756 | |
| 5757 When {func} is given and it is 'n' then all items will be | |
| 5758 sorted numerical (Implementation detail: This uses the | |
| 5759 strtod() function to parse numbers, Strings, Lists, Dicts and | |
| 5760 Funcrefs will be considered as being 0). | |
| 5761 | |
| 685 | 5762 When {func} is a |Funcref| or a function name, this function |
| 5763 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
|
5764 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
|
5765 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
|
5766 smaller if the first one sorts before the second one. |
| 5747 | 5767 |
| 5768 {dict} is for functions with the "dict" attribute. It will be | |
| 5769 used to set the local variable "self". |Dictionary-function| | |
| 5770 | |
|
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
5771 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
|
5772 string) will keep their relative position. E.g., when sorting |
| 6051 | 5773 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
|
5774 same order as they were originally. |
|
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
5775 |
| 5747 | 5776 Also see |uniq()|. |
| 5777 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5778 Example: > |
| 82 | 5779 func MyCompare(i1, i2) |
| 5780 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
| 5781 endfunc | |
| 5782 let sortedlist = sort(mylist, "MyCompare") | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5783 < A shorter compare version for this specific simple case, which |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5784 ignores overflow: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5785 func MyCompare(i1, i2) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5786 return a:i1 - a:i2 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5787 endfunc |
| 344 | 5788 < |
| 374 | 5789 *soundfold()* |
| 5790 soundfold({word}) | |
| 5791 Return the sound-folded equivalent of {word}. Uses the first | |
| 1621 | 5792 language in 'spelllang' for the current window that supports |
| 375 | 5793 soundfolding. 'spell' must be set. When no sound folding is |
| 5794 possible the {word} is returned unmodified. | |
| 374 | 5795 This can be used for making spelling suggestions. Note that |
| 5796 the method can be quite slow. | |
| 5797 | |
| 344 | 5798 *spellbadword()* |
| 532 | 5799 spellbadword([{sentence}]) |
| 5800 Without argument: The result is the badly spelled word under | |
| 5801 or after the cursor. The cursor is moved to the start of the | |
| 5802 bad word. When no bad word is found in the cursor line the | |
| 5803 result is an empty string and the cursor doesn't move. | |
| 5804 | |
| 5805 With argument: The result is the first word in {sentence} that | |
| 5806 is badly spelled. If there are no spelling mistakes the | |
| 5807 result is an empty string. | |
| 5808 | |
| 5809 The return value is a list with two items: | |
| 5810 - The badly spelled word or an empty string. | |
| 5811 - The type of the spelling error: | |
| 856 | 5812 "bad" spelling mistake |
| 532 | 5813 "rare" rare word |
| 5814 "local" word only valid in another region | |
| 5815 "caps" word should start with Capital | |
| 5816 Example: > | |
| 5817 echo spellbadword("the quik brown fox") | |
| 5818 < ['quik', 'bad'] ~ | |
| 5819 | |
| 5820 The spelling information for the current window is used. The | |
| 5821 'spell' option must be set and the value of 'spelllang' is | |
| 5822 used. | |
| 344 | 5823 |
| 5824 *spellsuggest()* | |
| 537 | 5825 spellsuggest({word} [, {max} [, {capital}]]) |
| 685 | 5826 Return a |List| with spelling suggestions to replace {word}. |
| 344 | 5827 When {max} is given up to this number of suggestions are |
| 5828 returned. Otherwise up to 25 suggestions are returned. | |
| 5829 | |
| 537 | 5830 When the {capital} argument is given and it's non-zero only |
| 5831 suggestions with a leading capital will be given. Use this | |
| 5832 after a match with 'spellcapcheck'. | |
| 5833 | |
| 344 | 5834 {word} can be a badly spelled word followed by other text. |
| 5835 This allows for joining two words that were split. The | |
| 359 | 5836 suggestions also include the following text, thus you can |
| 5837 replace a line. | |
| 5838 | |
| 5839 {word} may also be a good word. Similar words will then be | |
| 537 | 5840 returned. {word} itself is not included in the suggestions, |
| 5841 although it may appear capitalized. | |
| 344 | 5842 |
| 5843 The spelling information for the current window is used. The | |
| 375 | 5844 'spell' option must be set and the values of 'spelllang' and |
| 5845 'spellsuggest' are used. | |
| 344 | 5846 |
| 82 | 5847 |
| 282 | 5848 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
| 685 | 5849 Make a |List| out of {expr}. When {pattern} is omitted or |
| 5850 empty each white-separated sequence of characters becomes an | |
| 5851 item. | |
| 82 | 5852 Otherwise the string is split where {pattern} matches, |
| 3920 | 5853 removing the matched characters. 'ignorecase' is not used |
| 5854 here, add \c to ignore case. |/\c| | |
| 282 | 5855 When the first or last item is empty it is omitted, unless the |
| 5856 {keepempty} argument is given and it's non-zero. | |
| 293 | 5857 Other empty items are kept when {pattern} matches at least one |
| 5858 character or when {keepempty} is non-zero. | |
| 82 | 5859 Example: > |
| 95 | 5860 :let words = split(getline('.'), '\W\+') |
| 282 | 5861 < To split a string in individual characters: > |
| 236 | 5862 :for c in split(mystring, '\zs') |
| 258 | 5863 < If you want to keep the separator you can also use '\zs': > |
| 5864 :echo split('abc:def:ghi', ':\zs') | |
| 5865 < ['abc:', 'def:', 'ghi'] ~ | |
| 282 | 5866 Splitting a table where the first element can be empty: > |
| 5867 :let items = split(line, ':', 1) | |
| 5868 < The opposite function is |join()|. | |
| 82 | 5869 |
| 5870 | |
| 1621 | 5871 sqrt({expr}) *sqrt()* |
| 5872 Return the non-negative square root of Float {expr} as a | |
| 5873 |Float|. | |
| 5874 {expr} must evaluate to a |Float| or a |Number|. When {expr} | |
| 5875 is negative the result is NaN (Not a Number). | |
| 5876 Examples: > | |
| 5877 :echo sqrt(100) | |
| 5878 < 10.0 > | |
| 5879 :echo sqrt(-4.01) | |
| 5880 < nan | |
| 1668 | 5881 "nan" may be different, it depends on system libraries. |
| 1621 | 5882 {only available when compiled with the |+float| feature} |
| 5883 | |
| 5884 | |
| 5885 str2float( {expr}) *str2float()* | |
| 5886 Convert String {expr} to a Float. This mostly works the same | |
| 5887 as when using a floating point number in an expression, see | |
| 5888 |floating-point-format|. But it's a bit more permissive. | |
| 5889 E.g., "1e40" is accepted, while in an expression you need to | |
| 5890 write "1.0e40". | |
| 5891 Text after the number is silently ignored. | |
| 5892 The decimal point is always '.', no matter what the locale is | |
| 5893 set to. A comma ends the number: "12,345.67" is converted to | |
| 5894 12.0. You can strip out thousands separators with | |
| 5895 |substitute()|: > | |
| 5896 let f = str2float(substitute(text, ',', '', 'g')) | |
| 5897 < {only available when compiled with the |+float| feature} | |
| 5898 | |
| 5899 | |
| 782 | 5900 str2nr( {expr} [, {base}]) *str2nr()* |
| 5901 Convert string {expr} to a number. | |
| 5902 {base} is the conversion base, it can be 8, 10 or 16. | |
| 5903 When {base} is omitted base 10 is used. This also means that | |
| 5904 a leading zero doesn't cause octal conversion to be used, as | |
| 5905 with the default String to Number conversion. | |
| 5906 When {base} is 16 a leading "0x" or "0X" is ignored. With a | |
| 5907 different base the result will be zero. | |
| 5908 Text after the number is silently ignored. | |
| 856 | 5909 |
| 782 | 5910 |
| 6884 | 5911 strchars({expr} [, {skipcc}]) *strchars()* |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5912 The result is a Number, which is the number of characters |
| 6884 | 5913 in String {expr}. |
| 5914 When {skipcc} is omitted or zero, composing characters are | |
| 5915 counted separately. | |
| 5916 When {skipcc} set to 1, Composing characters are ignored. | |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5917 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5918 |
| 6918 | 5919 |
| 5920 {skipcc} is only available after 7.4.755. For backward | |
| 5921 compatibility, you can define a wrapper function: > | |
| 5922 if has("patch-7.4.755") | |
| 5923 function s:strchars(str, skipcc) | |
| 5924 return strchars(a:str, a:skipcc) | |
| 5925 endfunction | |
| 5926 else | |
| 5927 function s:strchars(str, skipcc) | |
| 5928 if a:skipcc | |
| 5929 return strlen(substitute(a:str, ".", "x", "g")) | |
| 5930 else | |
| 5931 return strchars(a:str) | |
| 5932 endif | |
| 5933 endfunction | |
| 5934 endif | |
| 5935 < | |
| 5936 | |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5937 strdisplaywidth({expr}[, {col}]) *strdisplaywidth()* |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5938 The result is a Number, which is the number of display cells |
| 6884 | 5939 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
|
5940 When {col} is omitted zero is used. Otherwise it is the |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5941 screen column where to start. This matters for Tab |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5942 characters. |
|
2343
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
5943 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
|
5944 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
|
5945 'tabstop' and 'display'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5946 When {expr} contains characters with East Asian Width Class |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5947 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5948 Also see |strlen()|, |strwidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5949 |
| 7 | 5950 strftime({format} [, {time}]) *strftime()* |
| 5951 The result is a String, which is a formatted date and time, as | |
| 5952 specified by the {format} string. The given {time} is used, | |
| 5953 or the current time if no time is given. The accepted | |
| 5954 {format} depends on your system, thus this is not portable! | |
| 5955 See the manual page of the C function strftime() for the | |
| 5956 format. The maximum length of the result is 80 characters. | |
| 5957 See also |localtime()| and |getftime()|. | |
| 5958 The language can be changed with the |:language| command. | |
| 5959 Examples: > | |
| 5960 :echo strftime("%c") Sun Apr 27 11:49:23 1997 | |
| 5961 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 | |
| 5962 :echo strftime("%y%m%d %T") 970427 11:53:55 | |
| 5963 :echo strftime("%H:%M") 11:55 | |
| 5964 :echo strftime("%c", getftime("file.c")) | |
| 5965 Show mod time of file.c. | |
| 82 | 5966 < Not available on all systems. To check use: > |
| 5967 :if exists("*strftime") | |
| 5968 | |
| 133 | 5969 stridx({haystack}, {needle} [, {start}]) *stridx()* |
| 5970 The result is a Number, which gives the byte index in | |
| 5971 {haystack} of the first occurrence of the String {needle}. | |
| 140 | 5972 If {start} is specified, the search starts at index {start}. |
| 5973 This can be used to find a second match: > | |
| 2662 | 5974 :let colon1 = stridx(line, ":") |
| 5975 :let colon2 = stridx(line, ":", colon1 + 1) | |
| 140 | 5976 < The search is done case-sensitive. |
| 205 | 5977 For pattern searches use |match()|. |
| 133 | 5978 -1 is returned if the {needle} does not occur in {haystack}. |
| 140 | 5979 See also |strridx()|. |
| 5980 Examples: > | |
| 7 | 5981 :echo stridx("An Example", "Example") 3 |
| 5982 :echo stridx("Starting point", "Start") 0 | |
| 5983 :echo stridx("Starting point", "start") -1 | |
| 856 | 5984 < *strstr()* *strchr()* |
| 170 | 5985 stridx() works similar to the C function strstr(). When used |
| 5986 with a single character it works similar to strchr(). | |
| 5987 | |
| 55 | 5988 *string()* |
| 95 | 5989 string({expr}) Return {expr} converted to a String. If {expr} is a Number, |
| 1621 | 5990 Float, String or a composition of them, then the result can be |
| 5991 parsed back with |eval()|. | |
| 55 | 5992 {expr} type result ~ |
| 99 | 5993 String 'string' |
| 95 | 5994 Number 123 |
| 1621 | 5995 Float 123.123456 or 1.123456e8 |
| 99 | 5996 Funcref function('name') |
| 95 | 5997 List [item, item] |
| 323 | 5998 Dictionary {key: value, key: value} |
| 99 | 5999 Note that in String values the ' character is doubled. |
| 1156 | 6000 Also see |strtrans()|. |
| 55 | 6001 |
| 7 | 6002 *strlen()* |
| 6003 strlen({expr}) The result is a Number, which is the length of the String | |
| 502 | 6004 {expr} in bytes. |
| 55 | 6005 If the argument is a Number it is first converted to a String. |
| 6006 For other types an error is given. | |
| 6870 | 6007 If you want to count the number of multi-byte characters use |
| 6008 |strchars()|. | |
| 6009 Also see |len()|, |strdisplaywidth()| and |strwidth()|. | |
| 7 | 6010 |
| 6011 strpart({src}, {start}[, {len}]) *strpart()* | |
| 6012 The result is a String, which is part of {src}, starting from | |
| 574 | 6013 byte {start}, with the byte length {len}. |
| 7 | 6014 When non-existing bytes are included, this doesn't result in |
| 6015 an error, the bytes are simply omitted. | |
| 6016 If {len} is missing, the copy continues from {start} till the | |
| 6017 end of the {src}. > | |
| 6018 strpart("abcdefg", 3, 2) == "de" | |
| 6019 strpart("abcdefg", -2, 4) == "ab" | |
| 6020 strpart("abcdefg", 5, 4) == "fg" | |
| 1621 | 6021 strpart("abcdefg", 3) == "defg" |
| 7 | 6022 < Note: To get the first character, {start} must be 0. For |
| 6023 example, to get three bytes under and after the cursor: > | |
| 823 | 6024 strpart(getline("."), col(".") - 1, 3) |
| 7 | 6025 < |
| 140 | 6026 strridx({haystack}, {needle} [, {start}]) *strridx()* |
| 6027 The result is a Number, which gives the byte index in | |
| 6028 {haystack} of the last occurrence of the String {needle}. | |
| 6029 When {start} is specified, matches beyond this index are | |
| 6030 ignored. This can be used to find a match before a previous | |
| 6031 match: > | |
| 6032 :let lastcomma = strridx(line, ",") | |
| 6033 :let comma2 = strridx(line, ",", lastcomma - 1) | |
| 6034 < The search is done case-sensitive. | |
| 133 | 6035 For pattern searches use |match()|. |
| 6036 -1 is returned if the {needle} does not occur in {haystack}. | |
| 22 | 6037 If the {needle} is empty the length of {haystack} is returned. |
| 236 | 6038 See also |stridx()|. Examples: > |
| 7 | 6039 :echo strridx("an angry armadillo", "an") 3 |
| 856 | 6040 < *strrchr()* |
| 170 | 6041 When used with a single character it works similar to the C |
| 6042 function strrchr(). | |
| 6043 | |
| 7 | 6044 strtrans({expr}) *strtrans()* |
| 6045 The result is a String, which is {expr} with all unprintable | |
| 6046 characters translated into printable characters |'isprint'|. | |
| 6047 Like they are shown in a window. Example: > | |
| 6048 echo strtrans(@a) | |
| 6049 < This displays a newline in register a as "^@" instead of | |
| 6050 starting a new line. | |
| 6051 | |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6052 strwidth({expr}) *strwidth()* |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6053 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
|
6054 String {expr} occupies. A Tab character is counted as one |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6055 cell, alternatively use |strdisplaywidth()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6056 When {expr} contains characters with East Asian Width Class |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6057 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
6058 Also see |strlen()|, |strdisplaywidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
6059 |
| 5794 | 6060 submatch({nr}[, {list}]) *submatch()* |
| 2908 | 6061 Only for an expression in a |:substitute| command or |
| 6062 substitute() function. | |
| 6063 Returns the {nr}'th submatch of the matched text. When {nr} | |
| 6064 is 0 the whole matched text is returned. | |
| 5794 | 6065 Note that a NL in the string can stand for a line break of a |
| 6066 multi-line match or a NUL character in the text. | |
| 2908 | 6067 Also see |sub-replace-expression|. |
| 5794 | 6068 |
| 6069 If {list} is present and non-zero then submatch() returns | |
| 6070 a list of strings, similar to |getline()| with two arguments. | |
| 6071 NL characters in the text represent NUL characters in the | |
| 6072 text. | |
| 6073 Only returns more than one item for |:substitute|, inside | |
| 6074 |substitute()| this list will always contain one or zero | |
| 6075 items, since there are no real line breaks. | |
| 6076 | |
| 7 | 6077 Example: > |
| 6078 :s/\d\+/\=submatch(0) + 1/ | |
| 6079 < This finds the first number in the line and adds one to it. | |
| 6080 A line break is included as a newline character. | |
| 6081 | |
| 6082 substitute({expr}, {pat}, {sub}, {flags}) *substitute()* | |
| 6083 The result is a String, which is a copy of {expr}, in which | |
| 2908 | 6084 the first match of {pat} is replaced with {sub}. |
| 6085 When {flags} is "g", all matches of {pat} in {expr} are | |
| 6086 replaced. Otherwise {flags} should be "". | |
| 6087 | |
| 6088 This works like the ":substitute" command (without any flags). | |
| 6089 But the matching with {pat} is always done like the 'magic' | |
| 6090 option is set and 'cpoptions' is empty (to make scripts | |
| 3967 | 6091 portable). 'ignorecase' is still relevant, use |/\c| or |/\C| |
| 6092 if you want to ignore or match case and ignore 'ignorecase'. | |
| 6093 'smartcase' is not used. See |string-match| for how {pat} is | |
| 6094 used. | |
| 2908 | 6095 |
| 6096 A "~" in {sub} is not replaced with the previous {sub}. | |
| 7 | 6097 Note that some codes in {sub} have a special meaning |
| 1621 | 6098 |sub-replace-special|. For example, to replace something with |
| 7 | 6099 "\n" (two characters), use "\\\\n" or '\\n'. |
| 2908 | 6100 |
| 7 | 6101 When {pat} does not match in {expr}, {expr} is returned |
| 6102 unmodified. | |
| 2908 | 6103 |
| 7 | 6104 Example: > |
| 6105 :let &path = substitute(&path, ",\\=[^,]*$", "", "") | |
| 6106 < This removes the last component of the 'path' option. > | |
| 6107 :echo substitute("testing", ".*", "\\U\\0", "") | |
| 6108 < results in "TESTING". | |
| 2908 | 6109 |
| 6110 When {sub} starts with "\=", the remainder is interpreted as | |
| 6111 an expression. See |sub-replace-expression|. Example: > | |
| 2833 | 6112 :echo substitute(s, '%\(\x\x\)', |
| 6113 \ '\=nr2char("0x" . submatch(1))', 'g') | |
| 7 | 6114 |
| 32 | 6115 synID({lnum}, {col}, {trans}) *synID()* |
| 7 | 6116 The result is a Number, which is the syntax ID at the position |
| 32 | 6117 {lnum} and {col} in the current window. |
| 7 | 6118 The syntax ID can be used with |synIDattr()| and |
| 6119 |synIDtrans()| to obtain syntax information about text. | |
| 419 | 6120 |
| 32 | 6121 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
| 419 | 6122 line. 'synmaxcol' applies, in a longer line zero is returned. |
| 6123 | |
| 7 | 6124 When {trans} is non-zero, transparent items are reduced to the |
| 1621 | 6125 item that they reveal. This is useful when wanting to know |
| 7 | 6126 the effective color. When {trans} is zero, the transparent |
| 6127 item is returned. This is useful when wanting to know which | |
| 6128 syntax item is effective (e.g. inside parens). | |
| 6129 Warning: This function can be very slow. Best speed is | |
| 6130 obtained by going through the file in forward direction. | |
| 6131 | |
| 6132 Example (echoes the name of the syntax item under the cursor): > | |
| 6133 :echo synIDattr(synID(line("."), col("."), 1), "name") | |
| 6134 < | |
|
2401
e7751177126b
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
6135 |
| 7 | 6136 synIDattr({synID}, {what} [, {mode}]) *synIDattr()* |
| 6137 The result is a String, which is the {what} attribute of | |
| 6138 syntax ID {synID}. This can be used to obtain information | |
| 6139 about a syntax item. | |
| 6140 {mode} can be "gui", "cterm" or "term", to get the attributes | |
| 1621 | 6141 for that mode. When {mode} is omitted, or an invalid value is |
| 7 | 6142 used, the attributes for the currently active highlighting are |
| 6143 used (GUI, cterm or term). | |
| 6144 Use synIDtrans() to follow linked highlight groups. | |
| 6145 {what} result | |
| 6146 "name" the name of the syntax item | |
| 6147 "fg" foreground color (GUI: color name used to set | |
| 6148 the color, cterm: color number as a string, | |
| 6149 term: empty string) | |
| 1755 | 6150 "bg" background color (as with "fg") |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6151 "font" font name (only available in the GUI) |
|
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6152 |highlight-font| |
| 1755 | 6153 "sp" special color (as with "fg") |highlight-guisp| |
| 7 | 6154 "fg#" like "fg", but for the GUI and the GUI is |
| 6155 running the name in "#RRGGBB" form | |
| 6156 "bg#" like "fg#" for "bg" | |
| 1755 | 6157 "sp#" like "fg#" for "sp" |
| 7 | 6158 "bold" "1" if bold |
| 6159 "italic" "1" if italic | |
| 6160 "reverse" "1" if reverse | |
| 6161 "inverse" "1" if inverse (= reverse) | |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
6162 "standout" "1" if standout |
| 7 | 6163 "underline" "1" if underlined |
| 205 | 6164 "undercurl" "1" if undercurled |
| 7 | 6165 |
| 6166 Example (echoes the color of the syntax item under the | |
| 6167 cursor): > | |
| 6168 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
| 6169 < | |
| 6170 synIDtrans({synID}) *synIDtrans()* | |
| 6171 The result is a Number, which is the translated syntax ID of | |
| 6172 {synID}. This is the syntax group ID of what is being used to | |
| 6173 highlight the character. Highlight links given with | |
| 6174 ":highlight link" are followed. | |
| 6175 | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6176 synconcealed({lnum}, {col}) *synconcealed()* |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6177 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
|
6178 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
|
6179 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
|
6180 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
|
6181 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
|
6182 depending on the current setting of 'conceallevel'. The third |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6183 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
|
6184 specific syntax region matched. This allows detection of the |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6185 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
|
6186 consecutive regions with the same replacement character. |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6187 For an example use see $VIMRUNTIME/syntax/2html.vim . |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6188 |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
6189 |
| 1500 | 6190 synstack({lnum}, {col}) *synstack()* |
| 6191 Return a |List|, which is the stack of syntax items at the | |
| 6192 position {lnum} and {col} in the current window. Each item in | |
| 6193 the List is an ID like what |synID()| returns. | |
| 6194 The first item in the List is the outer region, following are | |
| 6195 items contained in that one. The last one is what |synID()| | |
| 6196 returns, unless not the whole item is highlighted or it is a | |
| 6197 transparent item. | |
| 6198 This function is useful for debugging a syntax file. | |
| 6199 Example that shows the syntax stack under the cursor: > | |
| 6200 for id in synstack(line("."), col(".")) | |
| 6201 echo synIDattr(id, "name") | |
| 6202 endfor | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6203 < 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
|
6204 nothing is returned. The position just after the last |
|
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
6205 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
|
6206 valid positions. |
| 1500 | 6207 |
| 24 | 6208 system({expr} [, {input}]) *system()* *E677* |
| 5808 | 6209 Get the output of the shell command {expr} as a string. See |
| 6210 |systemlist()| to get the output as a List. | |
| 5806 | 6211 |
| 6212 When {input} is given and is a string this string is written | |
| 6213 to a file and passed as stdin to the command. The string is | |
| 6214 written as-is, you need to take care of using the correct line | |
| 6215 separators yourself. | |
| 6216 If {input} is given and is a |List| it is written to the file | |
| 6217 in a way |writefile()| does with {binary} set to "b" (i.e. | |
| 6218 with a newline between each list item with newlines inside | |
| 6219 list items converted to NULs). | |
| 6220 Pipes are not used. | |
| 6221 | |
| 6183 | 6222 When prepended by |:silent| the shell will not be set to |
| 6223 cooked mode. This is meant to be used for commands that do | |
| 6224 not need the user to type. It avoids stray characters showing | |
| 6225 up on the screen which require |CTRL-L| to remove. > | |
| 6226 :silent let f = system('ls *.vim') | |
| 6227 < | |
| 5690 | 6228 Note: Use |shellescape()| or |::S| with |expand()| or |
| 6229 |fnamemodify()| to escape special characters in a command | |
| 6230 argument. Newlines in {expr} may cause the command to fail. | |
| 6231 The characters in 'shellquote' and 'shellxquote' may also | |
| 6232 cause trouble. | |
| 7 | 6233 This is not to be used for interactive commands. |
| 1661 | 6234 |
| 7 | 6235 The result is a String. Example: > |
| 1661 | 6236 :let files = system("ls " . shellescape(expand('%:h'))) |
| 5690 | 6237 :let files = system('ls ' . expand('%:h:S')) |
| 7 | 6238 |
| 6239 < To make the result more system-independent, the shell output | |
| 6240 is filtered to replace <CR> with <NL> for Macintosh, and | |
| 6241 <CR><NL> with <NL> for DOS-like systems. | |
| 5277 | 6242 To avoid the string being truncated at a NUL, all NUL |
| 6243 characters are replaced with SOH (0x01). | |
| 6244 | |
| 7 | 6245 The command executed is constructed using several options: |
| 6246 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
| 6247 ({tmp} is an automatically generated file name). | |
| 6248 For Unix and OS/2 braces are put around {expr} to allow for | |
| 6249 concatenated commands. | |
| 6250 | |
| 794 | 6251 The command will be executed in "cooked" mode, so that a |
| 6252 CTRL-C will interrupt the command (on Unix at least). | |
| 6253 | |
| 7 | 6254 The resulting error code can be found in |v:shell_error|. |
| 6255 This function will fail in |restricted-mode|. | |
| 625 | 6256 |
| 6257 Note that any wrong value in the options mentioned above may | |
| 6258 make the function fail. It has also been reported to fail | |
| 6259 when using a security agent application. | |
| 7 | 6260 Unlike ":!cmd" there is no automatic check for changed files. |
| 6261 Use |:checktime| to force a check. | |
| 6262 | |
| 205 | 6263 |
| 5808 | 6264 systemlist({expr} [, {input}]) *systemlist()* |
| 6265 Same as |system()|, but returns a |List| with lines (parts of | |
| 6266 output separated by NL) with NULs transformed into NLs. Output | |
| 6267 is the same as |readfile()| will output with {binary} argument | |
| 6268 set to "b". | |
| 6269 | |
| 6270 Returns an empty string on error, so be careful not to run | |
| 6271 into |E706|. | |
| 6272 | |
| 6273 | |
| 677 | 6274 tabpagebuflist([{arg}]) *tabpagebuflist()* |
| 685 | 6275 The result is a |List|, where each item is the number of the |
| 677 | 6276 buffer associated with each window in the current tab page. |
| 6277 {arg} specifies the number of tab page to be used. When | |
| 6278 omitted the current tab page is used. | |
| 6279 When {arg} is invalid the number zero is returned. | |
| 6280 To get a list of all buffers in all tabs use this: > | |
| 3445 | 6281 let buflist = [] |
| 677 | 6282 for i in range(tabpagenr('$')) |
| 3445 | 6283 call extend(buflist, tabpagebuflist(i + 1)) |
| 677 | 6284 endfor |
| 6285 < Note that a buffer may appear in more than one window. | |
| 6286 | |
| 6287 | |
| 6288 tabpagenr([{arg}]) *tabpagenr()* | |
| 674 | 6289 The result is a Number, which is the number of the current |
| 6290 tab page. The first tab page has number 1. | |
| 6291 When the optional argument is "$", the number of the last tab | |
| 6292 page is returned (the tab page count). | |
| 6293 The number can be used with the |:tab| command. | |
| 6294 | |
| 6295 | |
| 5763 | 6296 tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()* |
|
2569
f612f6b0b883
Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6297 Like |winnr()| but for tab page {tabarg}. |
| 677 | 6298 {tabarg} specifies the number of tab page to be used. |
| 6299 {arg} is used like with |winnr()|: | |
| 6300 - When omitted the current window number is returned. This is | |
| 6301 the window which will be used when going to this tab page. | |
| 6302 - When "$" the number of windows is returned. | |
| 6303 - When "#" the previous window nr is returned. | |
| 6304 Useful examples: > | |
| 6305 tabpagewinnr(1) " current window of tab page 1 | |
| 6306 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
| 6307 < When {tabarg} is invalid zero is returned. | |
| 6308 | |
| 805 | 6309 *tagfiles()* |
| 6310 tagfiles() Returns a |List| with the file names used to search for tags | |
| 6311 for the current buffer. This is the 'tags' option expanded. | |
| 6312 | |
| 6313 | |
| 205 | 6314 taglist({expr}) *taglist()* |
| 6315 Returns a list of tags matching the regular expression {expr}. | |
| 438 | 6316 Each list item is a dictionary with at least the following |
| 6317 entries: | |
| 648 | 6318 name Name of the tag. |
| 6319 filename Name of the file where the tag is | |
| 1156 | 6320 defined. It is either relative to the |
| 6321 current directory or a full path. | |
| 205 | 6322 cmd Ex command used to locate the tag in |
| 6323 the file. | |
| 648 | 6324 kind Type of the tag. The value for this |
| 205 | 6325 entry depends on the language specific |
| 1156 | 6326 kind values. Only available when |
| 6327 using a tags file generated by | |
| 6328 Exuberant ctags or hdrtag. | |
| 648 | 6329 static A file specific tag. Refer to |
| 205 | 6330 |static-tag| for more information. |
| 1156 | 6331 More entries may be present, depending on the content of the |
| 6332 tags file: access, implementation, inherits and signature. | |
| 6333 Refer to the ctags documentation for information about these | |
| 6334 fields. For C code the fields "struct", "class" and "enum" | |
| 6335 may appear, they give the name of the entity the tag is | |
| 6336 contained in. | |
| 452 | 6337 |
| 216 | 6338 The ex-command 'cmd' can be either an ex search pattern, a |
| 6339 line number or a line number followed by a byte number. | |
| 205 | 6340 |
| 6341 If there are no matching tags, then an empty list is returned. | |
| 6342 | |
| 6343 To get an exact tag match, the anchors '^' and '$' should be | |
| 4073 | 6344 used in {expr}. This also make the function work faster. |
| 6345 Refer to |tag-regexp| for more information about the tag | |
| 6346 search regular expression pattern. | |
| 205 | 6347 |
| 6348 Refer to |'tags'| for information about how the tags file is | |
| 6349 located by Vim. Refer to |tags-file-format| for the format of | |
| 6350 the tags file generated by the different ctags tools. | |
| 6351 | |
| 7 | 6352 tempname() *tempname()* *temp-file-name* |
| 6353 The result is a String, which is the name of a file that | |
| 1621 | 6354 doesn't exist. It can be used for a temporary file. The name |
| 7 | 6355 is different for at least 26 consecutive calls. Example: > |
| 6356 :let tmpfile = tempname() | |
| 6357 :exe "redir > " . tmpfile | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6358 < For Unix, the file will be in a private directory |tempfile|. |
| 7 | 6359 For MS-Windows forward slashes are used when the 'shellslash' |
| 6360 option is set or when 'shellcmdflag' starts with '-'. | |
| 6361 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6362 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6363 tan({expr}) *tan()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6364 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
|
6365 in the range [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6366 {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
|
6367 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6368 :echo tan(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6369 < 0.648361 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6370 :echo tan(-4.01) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6371 < -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
|
6372 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6373 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6374 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6375 tanh({expr}) *tanh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6376 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
|
6377 range [-1, 1]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6378 {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
|
6379 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6380 :echo tanh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6381 < 0.462117 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6382 :echo tanh(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6383 < -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
|
6384 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6385 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6386 |
| 7 | 6387 tolower({expr}) *tolower()* |
| 6388 The result is a copy of the String given, with all uppercase | |
| 6389 characters turned into lowercase (just like applying |gu| to | |
| 6390 the string). | |
| 6391 | |
| 6392 toupper({expr}) *toupper()* | |
| 6393 The result is a copy of the String given, with all lowercase | |
| 6394 characters turned into uppercase (just like applying |gU| to | |
| 6395 the string). | |
| 6396 | |
| 15 | 6397 tr({src}, {fromstr}, {tostr}) *tr()* |
| 6398 The result is a copy of the {src} string with all characters | |
| 6399 which appear in {fromstr} replaced by the character in that | |
| 6400 position in the {tostr} string. Thus the first character in | |
| 6401 {fromstr} is translated into the first character in {tostr} | |
| 6402 and so on. Exactly like the unix "tr" command. | |
| 6403 This code also deals with multibyte characters properly. | |
| 6404 | |
| 6405 Examples: > | |
| 6406 echo tr("hello there", "ht", "HT") | |
| 6407 < returns "Hello THere" > | |
| 6408 echo tr("<blob>", "<>", "{}") | |
| 6409 < returns "{blob}" | |
| 6410 | |
| 1621 | 6411 trunc({expr}) *trunc()* |
| 1668 | 6412 Return the largest integral value with magnitude less than or |
| 1621 | 6413 equal to {expr} as a |Float| (truncate towards zero). |
| 6414 {expr} must evaluate to a |Float| or a |Number|. | |
| 6415 Examples: > | |
| 6416 echo trunc(1.456) | |
| 6417 < 1.0 > | |
| 6418 echo trunc(-5.456) | |
| 6419 < -5.0 > | |
| 6420 echo trunc(4.0) | |
| 6421 < 4.0 | |
| 6422 {only available when compiled with the |+float| feature} | |
| 6423 | |
| 87 | 6424 *type()* |
| 6425 type({expr}) The result is a Number, depending on the type of {expr}: | |
| 153 | 6426 Number: 0 |
| 6427 String: 1 | |
| 6428 Funcref: 2 | |
| 6429 List: 3 | |
| 6430 Dictionary: 4 | |
| 1621 | 6431 Float: 5 |
| 153 | 6432 To avoid the magic numbers it should be used this way: > |
| 87 | 6433 :if type(myvar) == type(0) |
| 6434 :if type(myvar) == type("") | |
| 6435 :if type(myvar) == type(function("tr")) | |
| 6436 :if type(myvar) == type([]) | |
| 153 | 6437 :if type(myvar) == type({}) |
| 1621 | 6438 :if type(myvar) == type(0.0) |
| 7 | 6439 |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6440 undofile({name}) *undofile()* |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6441 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
|
6442 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
|
6443 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
|
6444 the undo file exists. |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
6445 {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
|
6446 is used internally. |
|
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
6447 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
|
6448 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
|
6449 Useful in combination with |:wundo| and |:rundo|. |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6450 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
|
6451 returns an empty string. |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
6452 |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6453 undotree() *undotree()* |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6454 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
|
6455 the following items: |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6456 "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
|
6457 "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
|
6458 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
|
6459 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
|
6460 "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
|
6461 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
|
6462 something readable. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6463 "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
|
6464 write yet. |
|
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
6465 "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
|
6466 tree. |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6467 "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
|
6468 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
|
6469 user. See |undo-blocks|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6470 "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
|
6471 undo blocks. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6472 |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6473 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
|
6474 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
|
6475 "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
|
6476 |:undolist|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6477 "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
|
6478 |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
|
6479 "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
|
6480 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
|
6481 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
|
6482 "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
|
6483 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
|
6484 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
|
6485 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
|
6486 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
|
6487 not appear anywhere. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6488 "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
|
6489 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
|
6490 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
|
6491 "save_last" mentioned above. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6492 "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
|
6493 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
|
6494 item. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
6495 |
| 5747 | 6496 uniq({list} [, {func} [, {dict}]]) *uniq()* *E882* |
| 6497 Remove second and succeeding copies of repeated adjacent | |
| 6498 {list} items in-place. Returns {list}. If you want a list | |
| 6499 to remain unmodified make a copy first: > | |
| 6500 :let newlist = uniq(copy(mylist)) | |
| 6501 < The default compare function uses the string representation of | |
| 6502 each item. For the use of {func} and {dict} see |sort()|. | |
| 6503 | |
| 140 | 6504 values({dict}) *values()* |
| 1621 | 6505 Return a |List| with all the values of {dict}. The |List| is |
| 685 | 6506 in arbitrary order. |
| 140 | 6507 |
| 6508 | |
| 7 | 6509 virtcol({expr}) *virtcol()* |
| 6510 The result is a Number, which is the screen column of the file | |
| 6511 position given with {expr}. That is, the last screen position | |
| 6512 occupied by the character at that position, when the screen | |
| 6513 would be of unlimited width. When there is a <Tab> at the | |
| 6514 position, the returned Number will be the column at the end of | |
| 6515 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
| 3445 | 6516 set to 8, it returns 8. |conceal| is ignored. |
| 1317 | 6517 For the byte position use |col()|. |
| 6518 For the use of {expr} see |col()|. | |
| 6519 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
| 703 | 6520 "off" is the offset in screen columns from the start of the |
| 1266 | 6521 character. E.g., a position within a <Tab> or after the last |
| 2965 | 6522 character. When "off" is omitted zero is used. |
| 7 | 6523 When Virtual editing is active in the current mode, a position |
| 6524 beyond the end of the line can be returned. |'virtualedit'| | |
| 6525 The accepted positions are: | |
| 6526 . the cursor position | |
| 6527 $ the end of the cursor line (the result is the | |
| 6528 number of displayed characters in the cursor line | |
| 6529 plus one) | |
| 6530 'x position of mark x (if the mark is not set, 0 is | |
| 6531 returned) | |
| 6447 | 6532 v In Visual mode: the start of the Visual area (the |
| 6533 cursor is the end). When not in Visual mode | |
| 6534 returns the cursor position. Differs from |'<| in | |
| 6535 that it's updated right away. | |
| 7 | 6536 Note that only marks in the current file can be used. |
| 6537 Examples: > | |
| 6538 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
| 6539 virtcol("$") with text "foo^Lbar", returns 9 | |
| 1621 | 6540 virtcol("'t") with text " there", with 't at 'h', returns 6 |
| 6541 < The first column is 1. 0 is returned for an error. | |
| 1156 | 6542 A more advanced example that echoes the maximum length of |
| 6543 all lines: > | |
| 6544 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
| 6545 | |
| 7 | 6546 |
| 6547 visualmode([expr]) *visualmode()* | |
| 6548 The result is a String, which describes the last Visual mode | |
| 856 | 6549 used in the current buffer. Initially it returns an empty |
| 6550 string, but once Visual mode has been used, it returns "v", | |
| 6551 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
| 6552 character-wise, line-wise, or block-wise Visual mode | |
| 6553 respectively. | |
| 7 | 6554 Example: > |
| 6555 :exe "normal " . visualmode() | |
| 6556 < This enters the same Visual mode as before. It is also useful | |
| 6557 in scripts if you wish to act differently depending on the | |
| 6558 Visual mode that was used. | |
| 1621 | 6559 If Visual mode is active, use |mode()| to get the Visual mode |
| 6560 (e.g., in a |:vmap|). | |
| 1661 | 6561 *non-zero-arg* |
| 6562 If [expr] is supplied and it evaluates to a non-zero Number or | |
| 6563 a non-empty String, then the Visual mode will be cleared and | |
| 1621 | 6564 the old value is returned. Note that " " and "0" are also |
| 1661 | 6565 non-empty strings, thus cause the mode to be cleared. A List, |
| 6566 Dictionary or Float is not a Number or String, thus does not | |
| 6567 cause the mode to be cleared. | |
| 7 | 6568 |
| 4151 | 6569 wildmenumode() *wildmenumode()* |
| 6570 Returns non-zero when the wildmenu is active and zero | |
| 6571 otherwise. See 'wildmenu' and 'wildmode'. | |
| 6572 This can be used in mappings to handle the 'wildcharm' option | |
| 6573 gracefully. (Makes only sense with |mapmode-c| mappings). | |
| 6574 | |
| 6575 For example to make <c-j> work like <down> in wildmode, use: > | |
| 6576 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>" | |
| 6577 < | |
| 6578 (Note, this needs the 'wildcharm' option set appropriately). | |
| 6579 | |
| 6580 | |
| 7 | 6581 *winbufnr()* |
| 6582 winbufnr({nr}) The result is a Number, which is the number of the buffer | |
| 236 | 6583 associated with window {nr}. When {nr} is zero, the number of |
| 7 | 6584 the buffer in the current window is returned. When window |
| 6585 {nr} doesn't exist, -1 is returned. | |
| 6586 Example: > | |
| 6587 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
| 6588 < | |
| 6589 *wincol()* | |
| 6590 wincol() The result is a Number, which is the virtual column of the | |
| 6591 cursor in the window. This is counting screen cells from the | |
| 6592 left side of the window. The leftmost column is one. | |
| 6593 | |
| 6594 winheight({nr}) *winheight()* | |
| 6595 The result is a Number, which is the height of window {nr}. | |
| 6596 When {nr} is zero, the height of the current window is | |
| 6597 returned. When window {nr} doesn't exist, -1 is returned. | |
| 6598 An existing window always has a height of zero or more. | |
| 6599 Examples: > | |
| 6600 :echo "The current window has " . winheight(0) . " lines." | |
| 6601 < | |
| 6602 *winline()* | |
| 6603 winline() The result is a Number, which is the screen line of the cursor | |
| 1621 | 6604 in the window. This is counting screen lines from the top of |
| 7 | 6605 the window. The first line is one. |
| 531 | 6606 If the cursor was moved the view on the file will be updated |
| 6607 first, this may cause a scroll. | |
| 7 | 6608 |
| 6609 *winnr()* | |
| 20 | 6610 winnr([{arg}]) The result is a Number, which is the number of the current |
| 6611 window. The top window has number 1. | |
| 6612 When the optional argument is "$", the number of the | |
| 3967 | 6613 last window is returned (the window count). > |
| 6614 let window_count = winnr('$') | |
| 6615 < When the optional argument is "#", the number of the last | |
| 20 | 6616 accessed window is returned (where |CTRL-W_p| goes to). |
| 1156 | 6617 If there is no previous window or it is in another tab page 0 |
| 6618 is returned. | |
| 20 | 6619 The number can be used with |CTRL-W_w| and ":wincmd w" |
| 6620 |:wincmd|. | |
| 1156 | 6621 Also see |tabpagewinnr()|. |
| 7 | 6622 |
| 6623 *winrestcmd()* | |
| 6624 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
| 6625 the current window sizes. Only works properly when no windows | |
| 712 | 6626 are opened or closed and the current window and tab page is |
| 6627 unchanged. | |
| 7 | 6628 Example: > |
| 6629 :let cmd = winrestcmd() | |
| 6630 :call MessWithWindowSizes() | |
| 6631 :exe cmd | |
| 712 | 6632 < |
| 6633 *winrestview()* | |
| 6634 winrestview({dict}) | |
| 6635 Uses the |Dictionary| returned by |winsaveview()| to restore | |
| 6636 the view of the current window. | |
| 5940 | 6637 Note: The {dict} does not have to contain all values, that are |
| 6638 returned by |winsaveview()|. If values are missing, those | |
| 6639 settings won't be restored. So you can use: > | |
| 6640 :call winrestview({'curswant': 4}) | |
| 6641 < | |
| 6642 This will only set the curswant value (the column the cursor | |
| 6643 wants to move on vertical movements) of the cursor to column 5 | |
| 6644 (yes, that is 5), while all other settings will remain the | |
| 6645 same. This is useful, if you set the cursor position manually. | |
| 6646 | |
| 712 | 6647 If you have changed the values the result is unpredictable. |
| 6648 If the window size changed the result won't be the same. | |
| 6649 | |
| 6650 *winsaveview()* | |
| 6651 winsaveview() Returns a |Dictionary| that contains information to restore | |
| 6652 the view of the current window. Use |winrestview()| to | |
| 6653 restore the view. | |
| 6654 This is useful if you have a mapping that jumps around in the | |
| 6655 buffer and you want to go back to the original view. | |
| 6656 This does not save fold information. Use the 'foldenable' | |
| 798 | 6657 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
|
6658 not opened when moving around. This may have side effects. |
| 712 | 6659 The return value includes: |
| 6660 lnum cursor line number | |
| 5940 | 6661 col cursor column (Note: the first column |
| 6662 zero, as opposed to what getpos() | |
| 6663 returns) | |
| 712 | 6664 coladd cursor column offset for 'virtualedit' |
| 6665 curswant column for vertical movement | |
| 6666 topline first line in the window | |
| 6667 topfill filler lines, only in diff mode | |
| 6668 leftcol first column displayed | |
| 6669 skipcol columns skipped | |
| 6670 Note that no option values are saved. | |
| 6671 | |
| 7 | 6672 |
| 6673 winwidth({nr}) *winwidth()* | |
| 6674 The result is a Number, which is the width of window {nr}. | |
| 6675 When {nr} is zero, the width of the current window is | |
| 6676 returned. When window {nr} doesn't exist, -1 is returned. | |
| 6677 An existing window always has a width of zero or more. | |
| 6678 Examples: > | |
| 6679 :echo "The current window has " . winwidth(0) . " columns." | |
| 6680 :if winwidth(0) <= 50 | |
| 6681 : exe "normal 50\<C-W>|" | |
| 6682 :endif | |
| 6683 < | |
| 158 | 6684 *writefile()* |
| 6341 | 6685 writefile({list}, {fname} [, {flags}]) |
| 685 | 6686 Write |List| {list} to file {fname}. Each list item is |
| 158 | 6687 separated with a NL. Each list item must be a String or |
| 6688 Number. | |
| 6341 | 6689 When {flags} contains "b" then binary mode is used: There will |
| 158 | 6690 not be a NL after the last list item. An empty item at the |
| 6691 end does cause the last line in the file to end in a NL. | |
| 6341 | 6692 |
| 6693 When {flags} contains "a" then append mode is used, lines are | |
| 6694 append to the file: > | |
| 6695 :call writefile(["foo"], "event.log", "a") | |
| 6696 :call writefile(["bar"], "event.log", "a") | |
| 6697 > | |
| 6698 < All NL characters are replaced with a NUL character. | |
| 158 | 6699 Inserting CR characters needs to be done before passing {list} |
| 6700 to writefile(). | |
| 6701 An existing file is overwritten, if possible. | |
| 6702 When the write fails -1 is returned, otherwise 0. There is an | |
| 6703 error message if the file can't be created or when writing | |
| 6704 fails. | |
| 6705 Also see |readfile()|. | |
| 6706 To copy a file byte for byte: > | |
| 6707 :let fl = readfile("foo", "b") | |
| 6708 :call writefile(fl, "foocopy", "b") | |
| 3214 | 6709 |
| 6710 | |
| 6711 xor({expr}, {expr}) *xor()* | |
| 6712 Bitwise XOR on the two arguments. The arguments are converted | |
| 6713 to a number. A List, Dict or Float argument causes an error. | |
| 6714 Example: > | |
| 6715 :let bits = xor(bits, 0x80) | |
| 3256 | 6716 < |
| 3214 | 6717 |
| 7 | 6718 |
| 6719 *feature-list* | |
| 6009 | 6720 There are four types of features: |
| 7 | 6721 1. Features that are only supported when they have been enabled when Vim |
| 6722 was compiled |+feature-list|. Example: > | |
| 6723 :if has("cindent") | |
| 6724 2. Features that are only supported when certain conditions have been met. | |
| 6725 Example: > | |
| 6726 :if has("gui_running") | |
| 6727 < *has-patch* | |
| 5814 | 6728 3. Included patches. The "patch123" feature means that patch 123 has been |
| 6729 included. Note that this form does not check the version of Vim, you need | |
| 6730 to inspect |v:version| for that. | |
| 6731 Example (checking version 6.2.148 or later): > | |
| 7 | 6732 :if v:version > 602 || v:version == 602 && has("patch148") |
| 5814 | 6733 < Note that it's possible for patch 147 to be omitted even though 148 is |
| 6734 included. | |
| 6735 | |
| 6736 4. Beyond a certain version or at a certain version and including a specific | |
| 5862 | 6737 patch. The "patch-7.4.237" feature means that the Vim version is 7.5 or |
| 6738 later, or it is version 7.4 and patch 237 was included. | |
| 6739 Note that this only works for patch 7.4.237 and later, before that you | |
| 6740 need to use the example above that checks v:version. Example: > | |
| 6741 :if has("patch-7.4.248") | |
| 5814 | 6742 < Note that it's possible for patch 147 to be omitted even though 148 is |
| 1156 | 6743 included. |
| 7 | 6744 |
| 5340 | 6745 acl Compiled with |ACL| support. |
| 7 | 6746 all_builtin_terms Compiled with all builtin terminals enabled. |
| 6747 amiga Amiga version of Vim. | |
| 6748 arabic Compiled with Arabic support |Arabic|. | |
| 6749 arp Compiled with ARP support (Amiga). | |
| 613 | 6750 autocmd Compiled with autocommand support. |autocommand| |
| 7 | 6751 balloon_eval Compiled with |balloon-eval| support. |
| 435 | 6752 balloon_multiline GUI supports multiline balloons. |
| 7 | 6753 beos BeOS version of Vim. |
| 6754 browse Compiled with |:browse| support, and browse() will | |
| 6755 work. | |
| 3682 | 6756 browsefilter Compiled with support for |browsefilter|. |
| 7 | 6757 builtin_terms Compiled with some builtin terminals. |
| 6758 byte_offset Compiled with support for 'o' in 'statusline' | |
| 6759 cindent Compiled with 'cindent' support. | |
| 6760 clientserver Compiled with remote invocation support |clientserver|. | |
| 6761 clipboard Compiled with 'clipboard' support. | |
| 6762 cmdline_compl Compiled with |cmdline-completion| support. | |
| 6763 cmdline_hist Compiled with |cmdline-history| support. | |
| 6764 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
| 6765 comments Compiled with |'comments'| support. | |
| 2681 | 6766 compatible Compiled to be very Vi compatible. |
| 7 | 6767 cryptv Compiled with encryption support |encryption|. |
| 6768 cscope Compiled with |cscope| support. | |
| 6769 debug Compiled with "DEBUG" defined. | |
| 6770 dialog_con Compiled with console dialog support. | |
| 6771 dialog_gui Compiled with GUI dialog support. | |
| 6772 diff Compiled with |vimdiff| and 'diff' support. | |
| 6773 digraphs Compiled with support for digraphs. | |
| 6110 | 6774 directx Compiled with support for Direct-X and 'renderoptions'. |
| 7 | 6775 dnd Compiled with support for the "~ register |quote_~|. |
| 2681 | 6776 dos16 16 bits DOS version of Vim. |
| 7 | 6777 dos32 32 bits DOS (DJGPP) version of Vim. |
| 6778 ebcdic Compiled on a machine with ebcdic character set. | |
| 6779 emacs_tags Compiled with support for Emacs tags. | |
| 6780 eval Compiled with expression evaluation support. Always | |
| 6781 true, of course! | |
| 6782 ex_extra Compiled with extra Ex commands |+ex_extra|. | |
| 6783 extra_search Compiled with support for |'incsearch'| and | |
| 6784 |'hlsearch'| | |
| 6785 farsi Compiled with Farsi support |farsi|. | |
| 6786 file_in_path Compiled with support for |gf| and |<cfile>| | |
| 168 | 6787 filterpipe When 'shelltemp' is off pipes are used for shell |
| 6788 read/write/filter commands | |
| 7 | 6789 find_in_path Compiled with support for include file searches |
| 6790 |+find_in_path|. | |
| 1621 | 6791 float Compiled with support for |Float|. |
| 7 | 6792 fname_case Case in file names matters (for Amiga, MS-DOS, and |
| 6793 Windows this is not present). | |
| 6794 folding Compiled with |folding| support. | |
| 6795 footer Compiled with GUI footer support. |gui-footer| | |
| 6796 fork Compiled to use fork()/exec() instead of system(). | |
| 6797 gettext Compiled with message translation |multi-lang| | |
| 6798 gui Compiled with GUI enabled. | |
| 6799 gui_athena Compiled with Athena GUI. | |
| 2681 | 6800 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
| 7 | 6801 gui_gtk Compiled with GTK+ GUI (any version). |
| 6802 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined). | |
| 6803 gui_mac Compiled with Macintosh GUI. | |
| 6804 gui_motif Compiled with Motif GUI. | |
| 6805 gui_photon Compiled with Photon GUI. | |
| 2681 | 6806 gui_running Vim is running in the GUI, or it will start soon. |
| 7 | 6807 gui_win32 Compiled with MS Windows Win32 GUI. |
| 6808 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
| 6809 hangul_input Compiled with Hangul input support. |hangul| | |
| 6810 iconv Can use iconv() for conversion. | |
| 6811 insert_expand Compiled with support for CTRL-X expansion commands in | |
| 6812 Insert mode. | |
| 6813 jumplist Compiled with |jumplist| support. | |
| 6814 keymap Compiled with 'keymap' support. | |
| 6815 langmap Compiled with 'langmap' support. | |
| 6816 libcall Compiled with |libcall()| support. | |
| 5995 | 6817 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and |
| 6818 'breakindent' support. | |
| 7 | 6819 lispindent Compiled with support for lisp indenting. |
| 6820 listcmds Compiled with commands for the buffer list |:files| | |
| 6821 and the argument list |arglist|. | |
| 6822 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
|
6823 lua Compiled with Lua interface |Lua|. |
| 7 | 6824 mac Macintosh version of Vim. |
| 6825 macunix Macintosh version of Vim, using Unix files (OS-X). | |
| 6826 menu Compiled with support for |:menu|. | |
| 6827 mksession Compiled with support for |:mksession|. | |
| 6828 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
| 6829 mouse Compiled with support mouse. | |
| 6830 mouse_dec Compiled with support for Dec terminal mouse. | |
| 6831 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
| 6832 mouse_netterm Compiled with support for netterm mouse. | |
| 6833 mouse_pterm Compiled with support for qnx pterm mouse. | |
| 1621 | 6834 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
| 3750 | 6835 mouse_sgr Compiled with support for sgr mouse. |
| 3224 | 6836 mouse_urxvt Compiled with support for urxvt mouse. |
| 7 | 6837 mouse_xterm Compiled with support for xterm mouse. |
| 2681 | 6838 mouseshape Compiled with support for 'mouseshape'. |
| 1768 | 6839 multi_byte Compiled with support for 'encoding' |
| 6840 multi_byte_encoding 'encoding' is set to a multi-byte encoding. | |
| 7 | 6841 multi_byte_ime Compiled with support for IME input method. |
| 6842 multi_lang Compiled with support for multiple languages. | |
| 14 | 6843 mzscheme Compiled with MzScheme interface |mzscheme|. |
| 2681 | 6844 netbeans_enabled Compiled with support for |netbeans| and connected. |
| 7 | 6845 netbeans_intg Compiled with support for |netbeans|. |
| 6846 ole Compiled with OLE automation support for Win32. | |
| 6847 os2 OS/2 version of Vim. | |
| 6848 path_extra Compiled with up/downwards search in 'path' and 'tags' | |
| 6849 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
|
6850 persistent_undo Compiled with support for persistent undo history. |
| 7 | 6851 postscript Compiled with PostScript file printing. |
| 6852 printer Compiled with |:hardcopy| support. | |
| 170 | 6853 profile Compiled with |:profile| support. |
| 2826 | 6854 python Compiled with Python 2.x interface. |has-python| |
| 6855 python3 Compiled with Python 3.x interface. |has-python| | |
| 7 | 6856 qnx QNX version of Vim. |
| 6857 quickfix Compiled with |quickfix| support. | |
| 857 | 6858 reltime Compiled with |reltime()| support. |
| 7 | 6859 rightleft Compiled with 'rightleft' support. |
| 6860 ruby Compiled with Ruby interface |ruby|. | |
| 6861 scrollbind Compiled with 'scrollbind' support. | |
| 6862 showcmd Compiled with 'showcmd' support. | |
| 6863 signs Compiled with |:sign| support. | |
| 6864 smartindent Compiled with 'smartindent' support. | |
| 9 | 6865 sniff Compiled with SNiFF interface support. |
| 2681 | 6866 spell Compiled with spell checking support |spell|. |
| 1989 | 6867 startuptime Compiled with |--startuptime| support. |
| 7 | 6868 statusline Compiled with support for 'statusline', 'rulerformat' |
| 6869 and special formats of 'titlestring' and 'iconstring'. | |
| 6870 sun_workshop Compiled with support for Sun |workshop|. | |
| 314 | 6871 syntax Compiled with syntax highlighting support |syntax|. |
| 7 | 6872 syntax_items There are active syntax highlighting items for the |
| 6873 current buffer. | |
| 6874 system Compiled to use system() instead of fork()/exec(). | |
| 6875 tag_binary Compiled with binary searching in tags files | |
| 6876 |tag-binary-search|. | |
| 6877 tag_old_static Compiled with support for old static tags | |
| 6878 |tag-old-static|. | |
| 6879 tag_any_white Compiled with support for any white characters in tags | |
| 6880 files |tag-any-white|. | |
| 6881 tcl Compiled with Tcl interface. | |
| 6882 terminfo Compiled with terminfo instead of termcap. | |
| 6883 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
| 6884 textobjects Compiled with support for |text-objects|. | |
| 6885 tgetent Compiled with tgetent support, able to use a termcap | |
| 6886 or terminfo file. | |
| 6887 title Compiled with window title support |'title'|. | |
| 6888 toolbar Compiled with support for |gui-toolbar|. | |
| 6889 unix Unix version of Vim. | |
| 6890 user_commands User-defined commands. | |
| 2681 | 6891 vertsplit Compiled with vertically split windows |:vsplit|. |
| 2581 | 6892 vim_starting True while initial source'ing takes place. |startup| |
| 2681 | 6893 viminfo Compiled with viminfo support. |
| 7 | 6894 virtualedit Compiled with 'virtualedit' option. |
| 6895 visual Compiled with Visual mode. | |
| 6896 visualextra Compiled with extra Visual mode commands. | |
| 6897 |blockwise-operators|. | |
| 6898 vms VMS version of Vim. | |
| 6899 vreplace Compiled with |gR| and |gr| commands. | |
| 6900 wildignore Compiled with 'wildignore' option. | |
| 6901 wildmenu Compiled with 'wildmenu' option. | |
| 6902 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
|
6903 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
|
6904 64 bits) |
| 2681 | 6905 win32unix Win32 version of Vim, using Unix files (Cygwin) |
| 7 | 6906 win64 Win64 version of Vim (MS-Windows 64 bit). |
| 6907 win95 Win32 version for MS-Windows 95/98/ME. | |
| 2681 | 6908 winaltkeys Compiled with 'winaltkeys' option. |
| 6909 windows Compiled with support for more than one window. | |
| 7 | 6910 writebackup Compiled with 'writebackup' default on. |
| 6911 xfontset Compiled with X fontset support |xfontset|. | |
| 6912 xim Compiled with X input method support |xim|. | |
| 5340 | 6913 xpm Compiled with pixmap support. |
| 6914 xpm_w32 Compiled with pixmap support for Win32. (Only for | |
| 6915 backward compatibility. Use "xpm" instead.) | |
| 7 | 6916 xsmp Compiled with X session management support. |
| 6917 xsmp_interact Compiled with interactive X session management support. | |
| 6918 xterm_clipboard Compiled with support for xterm clipboard. | |
| 6919 xterm_save Compiled with support for saving and restoring the | |
| 6920 xterm screen. | |
| 6921 x11 Compiled with X11 support. | |
| 6922 | |
| 6923 *string-match* | |
| 6924 Matching a pattern in a String | |
| 6925 | |
| 6926 A regexp pattern as explained at |pattern| is normally used to find a match in | |
| 6927 the buffer lines. When a pattern is used to find a match in a String, almost | |
| 6928 everything works in the same way. The difference is that a String is handled | |
| 6929 like it is one line. When it contains a "\n" character, this is not seen as a | |
| 6930 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
| 6931 with ".". Example: > | |
| 6932 :let a = "aaaa\nxxxx" | |
| 6933 :echo matchstr(a, "..\n..") | |
| 6934 aa | |
| 6935 xx | |
| 6936 :echo matchstr(a, "a.x") | |
| 6937 a | |
| 6938 x | |
| 6939 | |
| 6940 Don't forget that "^" will only match at the first character of the String and | |
| 6941 "$" at the last character of the string. They don't match after or before a | |
| 6942 "\n". | |
| 6943 | |
| 6944 ============================================================================== | |
| 6945 5. Defining functions *user-functions* | |
| 6946 | |
| 6947 New functions can be defined. These can be called just like builtin | |
| 6948 functions. The function executes a sequence of Ex commands. Normal mode | |
| 6949 commands can be executed with the |:normal| command. | |
| 6950 | |
| 6951 The function name must start with an uppercase letter, to avoid confusion with | |
| 6952 builtin functions. To prevent from using the same name in different scripts | |
| 6953 avoid obvious, short names. A good habit is to start the function name with | |
| 6954 the name of the script, e.g., "HTMLcolor()". | |
| 6955 | |
| 504 | 6956 It's also possible to use curly braces, see |curly-braces-names|. And the |
| 6957 |autoload| facility is useful to define a function only when it's called. | |
| 7 | 6958 |
| 6959 *local-function* | |
| 6960 A function local to a script must start with "s:". A local script function | |
| 6961 can only be called from within the script and from functions, user commands | |
| 6962 and autocommands defined in the script. It is also possible to call the | |
| 1698 | 6963 function from a mapping defined in the script, but then |<SID>| must be used |
| 7 | 6964 instead of "s:" when the mapping is expanded outside of the script. |
| 5862 | 6965 There are only script-local functions, no buffer-local or window-local |
| 6966 functions. | |
| 7 | 6967 |
| 6968 *:fu* *:function* *E128* *E129* *E123* | |
| 6969 :fu[nction] List all functions and their arguments. | |
| 6970 | |
| 6971 :fu[nction] {name} List function {name}. | |
| 685 | 6972 {name} can also be a |Dictionary| entry that is a |
| 6973 |Funcref|: > | |
| 114 | 6974 :function dict.init |
| 504 | 6975 |
| 6976 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
| 6977 Example that lists all functions ending with "File": > | |
| 6978 :function /File$ | |
| 482 | 6979 < |
| 6980 *:function-verbose* | |
| 6981 When 'verbose' is non-zero, listing a function will also display where it was | |
| 6982 last defined. Example: > | |
| 6983 | |
| 6984 :verbose function SetFileTypeSH | |
| 6985 function SetFileTypeSH(name) | |
| 6986 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
| 6987 < | |
| 484 | 6988 See |:verbose-cmd| for more information. |
| 482 | 6989 |
| 5862 | 6990 *E124* *E125* *E853* *E884* |
| 102 | 6991 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] |
| 7 | 6992 Define a new function by the name {name}. The name |
| 6993 must be made of alphanumeric characters and '_', and | |
| 5862 | 6994 must start with a capital or "s:" (see above). Note |
| 6995 that using "b:" or "g:" is not allowed. (since patch | |
| 6996 7.4.260 E884 is given if the function name has a colon | |
| 6997 in the name, e.g. for "foo:bar()". Before that patch | |
| 6998 no error was given). | |
| 114 | 6999 |
| 685 | 7000 {name} can also be a |Dictionary| entry that is a |
| 7001 |Funcref|: > | |
| 114 | 7002 :function dict.init(arg) |
| 1621 | 7003 < "dict" must be an existing dictionary. The entry |
| 114 | 7004 "init" is added if it didn't exist yet. Otherwise [!] |
| 1621 | 7005 is required to overwrite an existing function. The |
| 114 | 7006 result is a |Funcref| to a numbered function. The |
| 7007 function can only be used with a |Funcref| and will be | |
| 7008 deleted if there are no more references to it. | |
| 7 | 7009 *E127* *E122* |
| 7010 When a function by this name already exists and [!] is | |
| 7011 not used an error message is given. When [!] is used, | |
| 7012 an existing function is silently replaced. Unless it | |
| 7013 is currently being executed, that is an error. | |
| 133 | 7014 |
| 7015 For the {arguments} see |function-argument|. | |
| 7016 | |
| 5618 | 7017 *:func-range* *a:firstline* *a:lastline* |
| 7 | 7018 When the [range] argument is added, the function is |
| 7019 expected to take care of a range itself. The range is | |
| 7020 passed as "a:firstline" and "a:lastline". If [range] | |
| 7021 is excluded, ":{range}call" will call the function for | |
| 7022 each line in the range, with the cursor on the start | |
| 7023 of each line. See |function-range-example|. | |
| 3967 | 7024 The cursor is still moved to the first line of the |
| 7025 range, as is the case with all Ex commands. | |
| 5618 | 7026 *:func-abort* |
| 7 | 7027 When the [abort] argument is added, the function will |
| 7028 abort as soon as an error is detected. | |
| 5618 | 7029 *:func-dict* |
| 102 | 7030 When the [dict] argument is added, the function must |
| 1621 | 7031 be invoked through an entry in a |Dictionary|. The |
| 102 | 7032 local variable "self" will then be set to the |
| 7033 dictionary. See |Dictionary-function|. | |
| 7 | 7034 |
| 1621 | 7035 *function-search-undo* |
| 653 | 7036 The last used search pattern and the redo command "." |
| 1621 | 7037 will not be changed by the function. This also |
| 7038 implies that the effect of |:nohlsearch| is undone | |
| 7039 when the function returns. | |
| 653 | 7040 |
| 7 | 7041 *:endf* *:endfunction* *E126* *E193* |
| 7042 :endf[unction] The end of a function definition. Must be on a line | |
| 7043 by its own, without other commands. | |
| 7044 | |
| 7045 *:delf* *:delfunction* *E130* *E131* | |
| 7046 :delf[unction] {name} Delete function {name}. | |
| 685 | 7047 {name} can also be a |Dictionary| entry that is a |
| 7048 |Funcref|: > | |
| 114 | 7049 :delfunc dict.init |
| 1621 | 7050 < This will remove the "init" entry from "dict". The |
| 114 | 7051 function is deleted if there are no more references to |
| 7052 it. | |
| 7 | 7053 *:retu* *:return* *E133* |
| 7054 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
| 7055 evaluated and returned as the result of the function. | |
| 7056 If "[expr]" is not given, the number 0 is returned. | |
| 7057 When a function ends without an explicit ":return", | |
| 7058 the number 0 is returned. | |
| 7059 Note that there is no check for unreachable lines, | |
| 7060 thus there is no warning if commands follow ":return". | |
| 7061 | |
| 7062 If the ":return" is used after a |:try| but before the | |
| 7063 matching |:finally| (if present), the commands | |
| 7064 following the ":finally" up to the matching |:endtry| | |
| 7065 are executed first. This process applies to all | |
| 7066 nested ":try"s inside the function. The function | |
| 7067 returns at the outermost ":endtry". | |
| 7068 | |
| 133 | 7069 *function-argument* *a:var* |
| 1621 | 7070 An argument can be defined by giving its name. In the function this can then |
| 133 | 7071 be used as "a:name" ("a:" for argument). |
| 1156 | 7072 *a:0* *a:1* *a:000* *E740* *...* |
| 133 | 7073 Up to 20 arguments can be given, separated by commas. After the named |
| 7074 arguments an argument "..." can be specified, which means that more arguments | |
| 7075 may optionally be following. In the function the extra arguments can be used | |
| 7076 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
| 685 | 7077 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
| 7078 that "a:1" is the same as "a:000[0]". | |
| 148 | 7079 *E742* |
| 7080 The a: scope and the variables in it cannot be changed, they are fixed. | |
| 1698 | 7081 However, if a |List| or |Dictionary| is used, you can change their contents. |
| 685 | 7082 Thus you can pass a |List| to a function and have the function add an item to |
| 7083 it. If you want to make sure the function cannot change a |List| or | |
| 7084 |Dictionary| use |:lockvar|. | |
| 133 | 7085 |
| 7086 When not using "...", the number of arguments in a function call must be equal | |
| 7087 to the number of named arguments. When using "...", the number of arguments | |
| 7088 may be larger. | |
| 7089 | |
| 7090 It is also possible to define a function without any arguments. You must | |
| 7091 still supply the () then. The body of the function follows in the next lines, | |
| 7092 until the matching |:endfunction|. It is allowed to define another function | |
| 7093 inside a function body. | |
| 7094 | |
| 7095 *local-variables* | |
| 7 | 7096 Inside a function variables can be used. These are local variables, which |
| 7097 will disappear when the function returns. Global variables need to be | |
| 7098 accessed with "g:". | |
| 7099 | |
| 7100 Example: > | |
| 7101 :function Table(title, ...) | |
| 7102 : echohl Title | |
| 7103 : echo a:title | |
| 7104 : echohl None | |
| 140 | 7105 : echo a:0 . " items:" |
| 7106 : for s in a:000 | |
| 7107 : echon ' ' . s | |
| 7108 : endfor | |
| 7 | 7109 :endfunction |
| 7110 | |
| 7111 This function can then be called with: > | |
| 140 | 7112 call Table("Table", "line1", "line2") |
| 7113 call Table("Empty Table") | |
| 7 | 7114 |
| 1156 | 7115 To return more than one value, return a |List|: > |
| 7116 :function Compute(n1, n2) | |
| 7 | 7117 : if a:n2 == 0 |
| 1156 | 7118 : return ["fail", 0] |
| 7 | 7119 : endif |
| 1156 | 7120 : return ["ok", a:n1 / a:n2] |
| 7 | 7121 :endfunction |
| 7122 | |
| 7123 This function can then be called with: > | |
| 1156 | 7124 :let [success, div] = Compute(102, 6) |
| 7 | 7125 :if success == "ok" |
| 7126 : echo div | |
| 7127 :endif | |
| 1156 | 7128 < |
| 786 | 7129 *:cal* *:call* *E107* *E117* |
| 7 | 7130 :[range]cal[l] {name}([arguments]) |
| 7131 Call a function. The name of the function and its arguments | |
| 7132 are as specified with |:function|. Up to 20 arguments can be | |
| 1156 | 7133 used. The returned value is discarded. |
| 7 | 7134 Without a range and for functions that accept a range, the |
| 7135 function is called once. When a range is given the cursor is | |
| 7136 positioned at the start of the first line before executing the | |
| 7137 function. | |
| 7138 When a range is given and the function doesn't handle it | |
| 7139 itself, the function is executed for each line in the range, | |
| 7140 with the cursor in the first column of that line. The cursor | |
| 7141 is left at the last line (possibly moved by the last function | |
| 1621 | 7142 call). The arguments are re-evaluated for each line. Thus |
| 7 | 7143 this works: |
| 7144 *function-range-example* > | |
| 7145 :function Mynumber(arg) | |
| 7146 : echo line(".") . " " . a:arg | |
| 7147 :endfunction | |
| 7148 :1,5call Mynumber(getline(".")) | |
| 7149 < | |
| 7150 The "a:firstline" and "a:lastline" are defined anyway, they | |
| 7151 can be used to do something different at the start or end of | |
| 7152 the range. | |
| 7153 | |
| 7154 Example of a function that handles the range itself: > | |
| 7155 | |
| 7156 :function Cont() range | |
| 7157 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
| 7158 :endfunction | |
| 7159 :4,8call Cont() | |
| 7160 < | |
| 7161 This function inserts the continuation character "\" in front | |
| 7162 of all the lines in the range, except the first one. | |
| 7163 | |
| 1156 | 7164 When the function returns a composite value it can be further |
| 7165 dereferenced, but the range will not be used then. Example: > | |
| 7166 :4,8call GetDict().method() | |
| 7167 < Here GetDict() gets the range but method() does not. | |
| 7168 | |
| 7 | 7169 *E132* |
| 7170 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
| 7171 option. | |
| 7172 | |
| 161 | 7173 |
| 7174 AUTOMATICALLY LOADING FUNCTIONS ~ | |
| 7 | 7175 *autoload-functions* |
| 7176 When using many or large functions, it's possible to automatically define them | |
| 161 | 7177 only when they are used. There are two methods: with an autocommand and with |
| 7178 the "autoload" directory in 'runtimepath'. | |
| 7179 | |
| 7180 | |
| 7181 Using an autocommand ~ | |
| 7182 | |
| 170 | 7183 This is introduced in the user manual, section |41.14|. |
| 7184 | |
| 161 | 7185 The autocommand is useful if you have a plugin that is a long Vim script file. |
| 7186 You can define the autocommand and quickly quit the script with |:finish|. | |
| 1621 | 7187 That makes Vim startup faster. The autocommand should then load the same file |
| 161 | 7188 again, setting a variable to skip the |:finish| command. |
| 7189 | |
| 7190 Use the FuncUndefined autocommand event with a pattern that matches the | |
| 7191 function(s) to be defined. Example: > | |
| 7 | 7192 |
| 7193 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
| 7194 | |
| 7195 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
| 7196 "BufNet". Also see |FuncUndefined|. | |
| 7197 | |
| 161 | 7198 |
| 7199 Using an autoload script ~ | |
| 168 | 7200 *autoload* *E746* |
| 170 | 7201 This is introduced in the user manual, section |41.15|. |
| 7202 | |
| 161 | 7203 Using a script in the "autoload" directory is simpler, but requires using |
| 7204 exactly the right file name. A function that can be autoloaded has a name | |
| 7205 like this: > | |
| 7206 | |
| 270 | 7207 :call filename#funcname() |
| 161 | 7208 |
| 7209 When such a function is called, and it is not defined yet, Vim will search the | |
| 7210 "autoload" directories in 'runtimepath' for a script file called | |
| 7211 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
| 7212 then define the function like this: > | |
| 7213 | |
| 270 | 7214 function filename#funcname() |
| 161 | 7215 echo "Done!" |
| 7216 endfunction | |
| 7217 | |
| 530 | 7218 The file name and the name used before the # in the function must match |
| 161 | 7219 exactly, and the defined function must have the name exactly as it will be |
| 7220 called. | |
| 7221 | |
| 270 | 7222 It is possible to use subdirectories. Every # in the function name works like |
| 7223 a path separator. Thus when calling a function: > | |
| 7224 | |
| 7225 :call foo#bar#func() | |
| 161 | 7226 |
| 7227 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
| 7228 | |
| 168 | 7229 This also works when reading a variable that has not been set yet: > |
| 7230 | |
| 270 | 7231 :let l = foo#bar#lvar |
| 168 | 7232 |
| 557 | 7233 However, when the autoload script was already loaded it won't be loaded again |
| 7234 for an unknown variable. | |
| 7235 | |
| 168 | 7236 When assigning a value to such a variable nothing special happens. This can |
| 7237 be used to pass settings to the autoload script before it's loaded: > | |
| 7238 | |
| 270 | 7239 :let foo#bar#toggle = 1 |
| 7240 :call foo#bar#func() | |
| 168 | 7241 |
| 164 | 7242 Note that when you make a mistake and call a function that is supposed to be |
| 7243 defined in an autoload script, but the script doesn't actually define the | |
| 7244 function, the script will be sourced every time you try to call the function. | |
| 168 | 7245 And you will get an error message every time. |
| 7246 | |
| 7247 Also note that if you have two script files, and one calls a function in the | |
| 1621 | 7248 other and vice versa, before the used function is defined, it won't work. |
| 168 | 7249 Avoid using the autoload functionality at the toplevel. |
| 161 | 7250 |
| 794 | 7251 Hint: If you distribute a bunch of scripts you can pack them together with the |
| 7252 |vimball| utility. Also read the user manual |distribute-script|. | |
| 7253 | |
| 7 | 7254 ============================================================================== |
| 7255 6. Curly braces names *curly-braces-names* | |
| 7256 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7257 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
|
7258 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
|
7259 wrapped in braces {} like this: > |
| 7 | 7260 my_{adjective}_variable |
| 7261 | |
| 7262 When Vim encounters this, it evaluates the expression inside the braces, puts | |
| 7263 that in place of the expression, and re-interprets the whole as a variable | |
| 7264 name. So in the above example, if the variable "adjective" was set to | |
| 7265 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
| 7266 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
| 7267 | |
| 7268 One application for this is to create a set of variables governed by an option | |
| 1621 | 7269 value. For example, the statement > |
| 7 | 7270 echo my_{&background}_message |
| 7271 | |
| 7272 would output the contents of "my_dark_message" or "my_light_message" depending | |
| 7273 on the current value of 'background'. | |
| 7274 | |
| 7275 You can use multiple brace pairs: > | |
| 7276 echo my_{adverb}_{adjective}_message | |
| 7277 ..or even nest them: > | |
| 7278 echo my_{ad{end_of_word}}_message | |
| 7279 where "end_of_word" is either "verb" or "jective". | |
| 7280 | |
| 7281 However, the expression inside the braces must evaluate to a valid single | |
| 236 | 7282 variable name, e.g. this is invalid: > |
| 7 | 7283 :let foo='a + b' |
| 7284 :echo c{foo}d | |
| 7285 .. since the result of expansion is "ca + bd", which is not a variable name. | |
| 7286 | |
| 7287 *curly-braces-function-names* | |
| 7288 You can call and define functions by an evaluated name in a similar way. | |
| 7289 Example: > | |
| 7290 :let func_end='whizz' | |
| 7291 :call my_func_{func_end}(parameter) | |
| 7292 | |
| 7293 This would call the function "my_func_whizz(parameter)". | |
| 7294 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7295 This does NOT work: > |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7296 :let i = 3 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7297 :let @{i} = '' " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7298 :echo @{i} " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
7299 |
| 7 | 7300 ============================================================================== |
| 7301 7. Commands *expression-commands* | |
| 7302 | |
| 7303 :let {var-name} = {expr1} *:let* *E18* | |
| 7304 Set internal variable {var-name} to the result of the | |
| 7305 expression {expr1}. The variable will get the type | |
| 7306 from the {expr}. If {var-name} didn't exist yet, it | |
| 7307 is created. | |
| 7308 | |
| 85 | 7309 :let {var-name}[{idx}] = {expr1} *E689* |
| 7310 Set a list item to the result of the expression | |
| 7311 {expr1}. {var-name} must refer to a list and {idx} | |
| 7312 must be a valid index in that list. For nested list | |
| 7313 the index can be repeated. | |
| 1621 | 7314 This cannot be used to add an item to a |List|. |
| 7315 This cannot be used to set a byte in a String. You | |
| 7316 can do that like this: > | |
| 7317 :let var = var[0:2] . 'X' . var[4:] | |
| 7318 < | |
| 114 | 7319 *E711* *E719* |
| 7320 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
| 685 | 7321 Set a sequence of items in a |List| to the result of |
| 7322 the expression {expr1}, which must be a list with the | |
| 87 | 7323 correct number of items. |
| 7324 {idx1} can be omitted, zero is used instead. | |
| 7325 {idx2} can be omitted, meaning the end of the list. | |
| 7326 When the selected range of items is partly past the | |
| 7327 end of the list, items will be added. | |
| 7328 | |
| 153 | 7329 *:let+=* *:let-=* *:let.=* *E734* |
| 114 | 7330 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
| 7331 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
| 7332 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". | |
| 7333 These fail if {var} was not set yet and when the type | |
| 7334 of {var} and {expr1} don't fit the operator. | |
| 7335 | |
| 7336 | |
| 7 | 7337 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
| 7338 Set environment variable {env-name} to the result of | |
| 7339 the expression {expr1}. The type is always String. | |
| 114 | 7340 :let ${env-name} .= {expr1} |
| 7341 Append {expr1} to the environment variable {env-name}. | |
| 7342 If the environment variable didn't exist yet this | |
| 7343 works like "=". | |
| 7 | 7344 |
| 7345 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
| 7346 Write the result of the expression {expr1} in register | |
| 7347 {reg-name}. {reg-name} must be a single letter, and | |
| 7348 must be the name of a writable register (see | |
| 7349 |registers|). "@@" can be used for the unnamed | |
| 7350 register, "@/" for the search pattern. | |
| 7351 If the result of {expr1} ends in a <CR> or <NL>, the | |
| 7352 register will be linewise, otherwise it will be set to | |
| 7353 characterwise. | |
| 7354 This can be used to clear the last search pattern: > | |
| 7355 :let @/ = "" | |
| 7356 < This is different from searching for an empty string, | |
| 7357 that would match everywhere. | |
| 7358 | |
| 114 | 7359 :let @{reg-name} .= {expr1} |
| 1621 | 7360 Append {expr1} to register {reg-name}. If the |
| 114 | 7361 register was empty it's like setting it to {expr1}. |
| 7362 | |
| 1156 | 7363 :let &{option-name} = {expr1} *:let-option* *:let-&* |
| 7 | 7364 Set option {option-name} to the result of the |
| 68 | 7365 expression {expr1}. A String or Number value is |
| 7366 always converted to the type of the option. | |
| 7 | 7367 For an option local to a window or buffer the effect |
| 7368 is just like using the |:set| command: both the local | |
| 555 | 7369 value and the global value are changed. |
| 68 | 7370 Example: > |
| 7371 :let &path = &path . ',/usr/local/include' | |
| 7 | 7372 |
| 114 | 7373 :let &{option-name} .= {expr1} |
| 7374 For a string option: Append {expr1} to the value. | |
| 7375 Does not insert a comma like |:set+=|. | |
| 7376 | |
| 7377 :let &{option-name} += {expr1} | |
| 7378 :let &{option-name} -= {expr1} | |
| 7379 For a number or boolean option: Add or subtract | |
| 7380 {expr1}. | |
| 7381 | |
| 7 | 7382 :let &l:{option-name} = {expr1} |
| 114 | 7383 :let &l:{option-name} .= {expr1} |
| 7384 :let &l:{option-name} += {expr1} | |
| 7385 :let &l:{option-name} -= {expr1} | |
| 7 | 7386 Like above, but only set the local value of an option |
| 7387 (if there is one). Works like |:setlocal|. | |
| 7388 | |
| 7389 :let &g:{option-name} = {expr1} | |
| 114 | 7390 :let &g:{option-name} .= {expr1} |
| 7391 :let &g:{option-name} += {expr1} | |
| 7392 :let &g:{option-name} -= {expr1} | |
| 7 | 7393 Like above, but only set the global value of an option |
| 7394 (if there is one). Works like |:setglobal|. | |
| 7395 | |
| 85 | 7396 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
| 685 | 7397 {expr1} must evaluate to a |List|. The first item in |
| 68 | 7398 the list is assigned to {name1}, the second item to |
| 7399 {name2}, etc. | |
| 7400 The number of names must match the number of items in | |
| 685 | 7401 the |List|. |
| 68 | 7402 Each name can be one of the items of the ":let" |
| 7403 command as mentioned above. | |
| 7404 Example: > | |
| 7405 :let [s, item] = GetItem(s) | |
| 114 | 7406 < Detail: {expr1} is evaluated first, then the |
| 7407 assignments are done in sequence. This matters if | |
| 7408 {name2} depends on {name1}. Example: > | |
| 7409 :let x = [0, 1] | |
| 7410 :let i = 0 | |
| 7411 :let [i, x[i]] = [1, 2] | |
| 7412 :echo x | |
| 7413 < The result is [0, 2]. | |
| 7414 | |
| 7415 :let [{name1}, {name2}, ...] .= {expr1} | |
| 7416 :let [{name1}, {name2}, ...] += {expr1} | |
| 7417 :let [{name1}, {name2}, ...] -= {expr1} | |
| 7418 Like above, but append/add/subtract the value for each | |
| 685 | 7419 |List| item. |
| 68 | 7420 |
| 7421 :let [{name}, ..., ; {lastname}] = {expr1} | |
| 685 | 7422 Like |:let-unpack| above, but the |List| may have more |
| 114 | 7423 items than there are names. A list of the remaining |
| 7424 items is assigned to {lastname}. If there are no | |
| 7425 remaining items {lastname} is set to an empty list. | |
| 68 | 7426 Example: > |
| 7427 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
| 7428 < | |
| 114 | 7429 :let [{name}, ..., ; {lastname}] .= {expr1} |
| 7430 :let [{name}, ..., ; {lastname}] += {expr1} | |
| 7431 :let [{name}, ..., ; {lastname}] -= {expr1} | |
| 7432 Like above, but append/add/subtract the value for each | |
| 685 | 7433 |List| item. |
| 2596 | 7434 |
| 7435 *E121* | |
| 1621 | 7436 :let {var-name} .. List the value of variable {var-name}. Multiple |
| 123 | 7437 variable names may be given. Special names recognized |
| 7438 here: *E738* | |
| 777 | 7439 g: global variables |
| 7440 b: local buffer variables | |
| 7441 w: local window variables | |
| 819 | 7442 t: local tab page variables |
| 777 | 7443 s: script-local variables |
| 7444 l: local function variables | |
| 123 | 7445 v: Vim variables. |
| 7 | 7446 |
| 55 | 7447 :let List the values of all variables. The type of the |
| 7448 variable is indicated before the value: | |
| 7449 <nothing> String | |
| 7450 # Number | |
| 856 | 7451 * Funcref |
| 7 | 7452 |
| 148 | 7453 |
| 1156 | 7454 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
| 148 | 7455 Remove the internal variable {name}. Several variable |
| 7456 names can be given, they are all removed. The name | |
| 685 | 7457 may also be a |List| or |Dictionary| item. |
| 7 | 7458 With [!] no error message is given for non-existing |
| 7459 variables. | |
| 685 | 7460 One or more items from a |List| can be removed: > |
| 108 | 7461 :unlet list[3] " remove fourth item |
| 7462 :unlet list[3:] " remove fourth item to last | |
| 685 | 7463 < One item from a |Dictionary| can be removed at a time: > |
| 108 | 7464 :unlet dict['two'] |
| 7465 :unlet dict.two | |
| 1668 | 7466 < This is especially useful to clean up used global |
| 7467 variables and script-local variables (these are not | |
| 7468 deleted when the script ends). Function-local | |
| 7469 variables are automatically deleted when the function | |
| 7470 ends. | |
| 7 | 7471 |
| 148 | 7472 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
| 7473 Lock the internal variable {name}. Locking means that | |
| 7474 it can no longer be changed (until it is unlocked). | |
| 7475 A locked variable can be deleted: > | |
| 7476 :lockvar v | |
| 7477 :let v = 'asdf' " fails! | |
| 7478 :unlet v | |
| 7479 < *E741* | |
| 7480 If you try to change a locked variable you get an | |
| 6530 | 7481 error message: "E741: Value is locked: {name}" |
| 148 | 7482 |
| 685 | 7483 [depth] is relevant when locking a |List| or |
| 7484 |Dictionary|. It specifies how deep the locking goes: | |
| 7485 1 Lock the |List| or |Dictionary| itself, | |
| 148 | 7486 cannot add or remove items, but can |
| 7487 still change their values. | |
| 7488 2 Also lock the values, cannot change | |
| 685 | 7489 the items. If an item is a |List| or |
| 7490 |Dictionary|, cannot add or remove | |
| 148 | 7491 items, but can still change the |
| 7492 values. | |
| 685 | 7493 3 Like 2 but for the |List| / |
| 7494 |Dictionary| in the |List| / | |
| 7495 |Dictionary|, one level deeper. | |
| 7496 The default [depth] is 2, thus when {name} is a |List| | |
| 7497 or |Dictionary| the values cannot be changed. | |
| 148 | 7498 *E743* |
| 7499 For unlimited depth use [!] and omit [depth]. | |
| 7500 However, there is a maximum depth of 100 to catch | |
| 7501 loops. | |
| 7502 | |
| 685 | 7503 Note that when two variables refer to the same |List| |
| 7504 and you lock one of them, the |List| will also be | |
| 819 | 7505 locked when used through the other variable. |
| 7506 Example: > | |
| 148 | 7507 :let l = [0, 1, 2, 3] |
| 7508 :let cl = l | |
| 7509 :lockvar l | |
| 7510 :let cl[1] = 99 " won't work! | |
| 7511 < You may want to make a copy of a list to avoid this. | |
| 7512 See |deepcopy()|. | |
| 7513 | |
| 7514 | |
| 7515 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
| 7516 Unlock the internal variable {name}. Does the | |
| 7517 opposite of |:lockvar|. | |
| 7518 | |
| 7519 | |
| 7 | 7520 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580* |
| 7521 :en[dif] Execute the commands until the next matching ":else" | |
| 7522 or ":endif" if {expr1} evaluates to non-zero. | |
| 7523 | |
| 7524 From Vim version 4.5 until 5.0, every Ex command in | |
| 7525 between the ":if" and ":endif" is ignored. These two | |
| 7526 commands were just to allow for future expansions in a | |
| 7527 backwards compatible way. Nesting was allowed. Note | |
| 7528 that any ":else" or ":elseif" was ignored, the "else" | |
| 7529 part was not executed either. | |
| 7530 | |
| 7531 You can use this to remain compatible with older | |
| 7532 versions: > | |
| 7533 :if version >= 500 | |
| 7534 : version-5-specific-commands | |
| 7535 :endif | |
| 7536 < The commands still need to be parsed to find the | |
| 7537 "endif". Sometimes an older Vim has a problem with a | |
| 7538 new command. For example, ":silent" is recognized as | |
| 7539 a ":substitute" command. In that case ":execute" can | |
| 7540 avoid problems: > | |
| 7541 :if version >= 600 | |
| 7542 : execute "silent 1,$delete" | |
| 7543 :endif | |
| 7544 < | |
| 7545 NOTE: The ":append" and ":insert" commands don't work | |
| 7546 properly in between ":if" and ":endif". | |
| 7547 | |
| 7548 *:else* *:el* *E581* *E583* | |
| 7549 :el[se] Execute the commands until the next matching ":else" | |
| 7550 or ":endif" if they previously were not being | |
| 7551 executed. | |
| 7552 | |
| 7553 *:elseif* *:elsei* *E582* *E584* | |
| 7554 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
| 7555 is no extra ":endif". | |
| 7556 | |
| 7557 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
| 114 | 7558 *E170* *E585* *E588* *E733* |
| 7 | 7559 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
| 7560 as long as {expr1} evaluates to non-zero. | |
| 7561 When an error is detected from a command inside the | |
| 7562 loop, execution continues after the "endwhile". | |
| 75 | 7563 Example: > |
| 7564 :let lnum = 1 | |
| 7565 :while lnum <= line("$") | |
| 7566 :call FixLine(lnum) | |
| 7567 :let lnum = lnum + 1 | |
| 7568 :endwhile | |
| 7569 < | |
| 7 | 7570 NOTE: The ":append" and ":insert" commands don't work |
| 99 | 7571 properly inside a ":while" and ":for" loop. |
| 75 | 7572 |
| 114 | 7573 :for {var} in {list} *:for* *E690* *E732* |
| 75 | 7574 :endfo[r] *:endfo* *:endfor* |
| 7575 Repeat the commands between ":for" and ":endfor" for | |
| 158 | 7576 each item in {list}. Variable {var} is set to the |
| 79 | 7577 value of each item. |
| 7578 When an error is detected for a command inside the | |
| 75 | 7579 loop, execution continues after the "endfor". |
| 464 | 7580 Changing {list} inside the loop affects what items are |
| 7581 used. Make a copy if this is unwanted: > | |
| 79 | 7582 :for item in copy(mylist) |
| 7583 < When not making a copy, Vim stores a reference to the | |
| 7584 next item in the list, before executing the commands | |
| 1621 | 7585 with the current item. Thus the current item can be |
| 79 | 7586 removed without effect. Removing any later item means |
| 7587 it will not be found. Thus the following example | |
| 7588 works (an inefficient way to make a list empty): > | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7589 for item in mylist |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7590 call remove(mylist, 0) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7591 endfor |
| 87 | 7592 < Note that reordering the list (e.g., with sort() or |
| 7593 reverse()) may have unexpected effects. | |
| 7594 Note that the type of each list item should be | |
| 75 | 7595 identical to avoid errors for the type of {var} |
| 7596 changing. Unlet the variable at the end of the loop | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7597 to allow multiple item types: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7598 for item in ["foo", ["bar"]] |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7599 echo item |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7600 unlet item " E706 without this |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7601 endfor |
| 75 | 7602 |
| 7603 :for [{var1}, {var2}, ...] in {listlist} | |
| 7604 :endfo[r] | |
| 7605 Like ":for" above, but each item in {listlist} must be | |
| 7606 a list, of which each item is assigned to {var1}, | |
| 7607 {var2}, etc. Example: > | |
| 7608 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
| 7609 :echo getline(lnum)[col] | |
| 7610 :endfor | |
| 7611 < | |
| 7 | 7612 *:continue* *:con* *E586* |
| 75 | 7613 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
| 7614 to the start of the loop. | |
| 7615 If it is used after a |:try| inside the loop but | |
| 7616 before the matching |:finally| (if present), the | |
| 7617 commands following the ":finally" up to the matching | |
| 7618 |:endtry| are executed first. This process applies to | |
| 7619 all nested ":try"s inside the loop. The outermost | |
| 7620 ":endtry" then jumps back to the start of the loop. | |
| 7 | 7621 |
| 7622 *:break* *:brea* *E587* | |
| 75 | 7623 :brea[k] When used inside a ":while" or ":for" loop, skips to |
| 7624 the command after the matching ":endwhile" or | |
| 7625 ":endfor". | |
| 7626 If it is used after a |:try| inside the loop but | |
| 7627 before the matching |:finally| (if present), the | |
| 7628 commands following the ":finally" up to the matching | |
| 7629 |:endtry| are executed first. This process applies to | |
| 7630 all nested ":try"s inside the loop. The outermost | |
| 7631 ":endtry" then jumps to the command after the loop. | |
| 7 | 7632 |
| 7633 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
| 7634 :endt[ry] Change the error handling for the commands between | |
| 7635 ":try" and ":endtry" including everything being | |
| 7636 executed across ":source" commands, function calls, | |
| 7637 or autocommand invocations. | |
| 7638 | |
| 7639 When an error or interrupt is detected and there is | |
| 7640 a |:finally| command following, execution continues | |
| 7641 after the ":finally". Otherwise, or when the | |
| 7642 ":endtry" is reached thereafter, the next | |
| 7643 (dynamically) surrounding ":try" is checked for | |
| 7644 a corresponding ":finally" etc. Then the script | |
| 7645 processing is terminated. (Whether a function | |
| 7646 definition has an "abort" argument does not matter.) | |
| 7647 Example: > | |
| 7648 :try | edit too much | finally | echo "cleanup" | endtry | |
| 7649 :echo "impossible" " not reached, script terminated above | |
| 7650 < | |
| 7651 Moreover, an error or interrupt (dynamically) inside | |
| 7652 ":try" and ":endtry" is converted to an exception. It | |
| 7653 can be caught as if it were thrown by a |:throw| | |
| 7654 command (see |:catch|). In this case, the script | |
| 7655 processing is not terminated. | |
| 7656 | |
| 7657 The value "Vim:Interrupt" is used for an interrupt | |
| 7658 exception. An error in a Vim command is converted | |
| 7659 to a value of the form "Vim({command}):{errmsg}", | |
| 7660 other errors are converted to a value of the form | |
| 7661 "Vim:{errmsg}". {command} is the full command name, | |
| 7662 and {errmsg} is the message that is displayed if the | |
| 7663 error exception is not caught, always beginning with | |
| 7664 the error number. | |
| 7665 Examples: > | |
| 7666 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry | |
| 7667 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
| 7668 < | |
| 7669 *:cat* *:catch* *E603* *E604* *E605* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7670 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
| 7 | 7671 |:finally|, or |:endtry| that belongs to the same |
| 7672 |:try| as the ":catch" are executed when an exception | |
| 7673 matching {pattern} is being thrown and has not yet | |
| 7674 been caught by a previous ":catch". Otherwise, these | |
| 7675 commands are skipped. | |
| 7676 When {pattern} is omitted all errors are caught. | |
| 7677 Examples: > | |
| 7678 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) | |
| 7679 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors | |
| 7680 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts | |
| 7681 :catch /^Vim(write):/ " catch all errors in :write | |
| 7682 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123 | |
| 7683 :catch /my-exception/ " catch user exception | |
| 7684 :catch /.*/ " catch everything | |
| 7685 :catch " same as /.*/ | |
| 7686 < | |
| 7687 Another character can be used instead of / around the | |
| 7688 {pattern}, so long as it does not have a special | |
| 7689 meaning (e.g., '|' or '"') and doesn't occur inside | |
| 7690 {pattern}. | |
| 5814 | 7691 Information about the exception is available in |
| 7692 |v:exception|. Also see |throw-variables|. | |
| 7 | 7693 NOTE: It is not reliable to ":catch" the TEXT of |
| 7694 an error message because it may vary in different | |
| 7695 locales. | |
| 7696 | |
| 7697 *:fina* *:finally* *E606* *E607* | |
| 7698 :fina[lly] The following commands until the matching |:endtry| | |
| 7699 are executed whenever the part between the matching | |
| 7700 |:try| and the ":finally" is left: either by falling | |
| 7701 through to the ":finally" or by a |:continue|, | |
| 7702 |:break|, |:finish|, or |:return|, or by an error or | |
| 7703 interrupt or exception (see |:throw|). | |
| 7704 | |
| 7705 *:th* *:throw* *E608* | |
| 7706 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
| 7707 If the ":throw" is used after a |:try| but before the | |
| 7708 first corresponding |:catch|, commands are skipped | |
| 7709 until the first ":catch" matching {expr1} is reached. | |
| 7710 If there is no such ":catch" or if the ":throw" is | |
| 7711 used after a ":catch" but before the |:finally|, the | |
| 7712 commands following the ":finally" (if present) up to | |
| 7713 the matching |:endtry| are executed. If the ":throw" | |
| 7714 is after the ":finally", commands up to the ":endtry" | |
| 7715 are skipped. At the ":endtry", this process applies | |
| 7716 again for the next dynamically surrounding ":try" | |
| 7717 (which may be found in a calling function or sourcing | |
| 7718 script), until a matching ":catch" has been found. | |
| 7719 If the exception is not caught, the command processing | |
| 7720 is terminated. | |
| 7721 Example: > | |
| 7722 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
| 2725 | 7723 < Note that "catch" may need to be on a separate line |
| 7724 for when an error causes the parsing to skip the whole | |
| 7725 line and not see the "|" that separates the commands. | |
| 7 | 7726 |
| 7727 *:ec* *:echo* | |
| 7728 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
| 7729 first {expr1} starts on a new line. | |
| 7730 Also see |:comment|. | |
| 7731 Use "\n" to start a new line. Use "\r" to move the | |
| 7732 cursor to the first column. | |
| 7733 Uses the highlighting set by the |:echohl| command. | |
| 7734 Cannot be followed by a comment. | |
| 7735 Example: > | |
| 7736 :echo "the value of 'shell' is" &shell | |
| 1156 | 7737 < *:echo-redraw* |
| 7738 A later redraw may make the message disappear again. | |
| 7739 And since Vim mostly postpones redrawing until it's | |
| 7740 finished with a sequence of commands this happens | |
| 7741 quite often. To avoid that a command from before the | |
| 7742 ":echo" causes a redraw afterwards (redraws are often | |
| 7743 postponed until you type something), force a redraw | |
| 7744 with the |:redraw| command. Example: > | |
| 7 | 7745 :new | redraw | echo "there is a new window" |
| 7746 < | |
| 7747 *:echon* | |
| 7748 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
| 7749 |:comment|. | |
| 7750 Uses the highlighting set by the |:echohl| command. | |
| 7751 Cannot be followed by a comment. | |
| 7752 Example: > | |
| 7753 :echon "the value of 'shell' is " &shell | |
| 7754 < | |
| 7755 Note the difference between using ":echo", which is a | |
| 7756 Vim command, and ":!echo", which is an external shell | |
| 7757 command: > | |
| 7758 :!echo % --> filename | |
| 7759 < The arguments of ":!" are expanded, see |:_%|. > | |
| 7760 :!echo "%" --> filename or "filename" | |
| 7761 < Like the previous example. Whether you see the double | |
| 7762 quotes or not depends on your 'shell'. > | |
| 7763 :echo % --> nothing | |
| 7764 < The '%' is an illegal character in an expression. > | |
| 7765 :echo "%" --> % | |
| 7766 < This just echoes the '%' character. > | |
| 7767 :echo expand("%") --> filename | |
| 7768 < This calls the expand() function to expand the '%'. | |
| 7769 | |
| 7770 *:echoh* *:echohl* | |
| 7771 :echoh[l] {name} Use the highlight group {name} for the following | |
| 7772 |:echo|, |:echon| and |:echomsg| commands. Also used | |
| 7773 for the |input()| prompt. Example: > | |
| 7774 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
| 7775 < Don't forget to set the group back to "None", | |
| 7776 otherwise all following echo's will be highlighted. | |
| 7777 | |
| 7778 *:echom* *:echomsg* | |
| 7779 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
| 7780 message in the |message-history|. | |
| 7781 Spaces are placed between the arguments as with the | |
| 7782 |:echo| command. But unprintable characters are | |
| 7783 displayed, not interpreted. | |
| 1156 | 7784 The parsing works slightly different from |:echo|, |
| 7785 more like |:execute|. All the expressions are first | |
| 7786 evaluated and concatenated before echoing anything. | |
| 7787 The expressions must evaluate to a Number or String, a | |
| 7788 Dictionary or List causes an error. | |
| 7 | 7789 Uses the highlighting set by the |:echohl| command. |
| 7790 Example: > | |
| 7791 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
| 1156 | 7792 < See |:echo-redraw| to avoid the message disappearing |
| 7793 when the screen is redrawn. | |
| 7 | 7794 *:echoe* *:echoerr* |
| 7795 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
| 7796 message in the |message-history|. When used in a | |
| 7797 script or function the line number will be added. | |
| 7798 Spaces are placed between the arguments as with the | |
| 1621 | 7799 :echo command. When used inside a try conditional, |
| 7 | 7800 the message is raised as an error exception instead |
| 7801 (see |try-echoerr|). | |
| 7802 Example: > | |
| 7803 :echoerr "This script just failed!" | |
| 7804 < If you just want a highlighted message use |:echohl|. | |
| 7805 And to get a beep: > | |
| 7806 :exe "normal \<Esc>" | |
| 7807 < | |
| 7808 *:exe* *:execute* | |
| 7809 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
| 2152 | 7810 of {expr1} as an Ex command. |
| 7811 Multiple arguments are concatenated, with a space in | |
| 7812 between. To avoid the extra space use the "." | |
| 7813 operator to concatenate strings into one argument. | |
| 7814 {expr1} is used as the processed command, command line | |
| 7815 editing keys are not recognized. | |
| 7 | 7816 Cannot be followed by a comment. |
| 7817 Examples: > | |
| 2152 | 7818 :execute "buffer" nextbuf |
| 7819 :execute "normal" count . "w" | |
| 7 | 7820 < |
| 7821 ":execute" can be used to append a command to commands | |
| 7822 that don't accept a '|'. Example: > | |
| 7823 :execute '!ls' | echo "theend" | |
| 7824 | |
| 7825 < ":execute" is also a nice way to avoid having to type | |
| 7826 control characters in a Vim script for a ":normal" | |
| 7827 command: > | |
| 7828 :execute "normal ixxx\<Esc>" | |
| 7829 < This has an <Esc> character, see |expr-string|. | |
| 7830 | |
| 1621 | 7831 Be careful to correctly escape special characters in |
| 7832 file names. The |fnameescape()| function can be used | |
| 1661 | 7833 for Vim commands, |shellescape()| for |:!| commands. |
| 7834 Examples: > | |
| 1621 | 7835 :execute "e " . fnameescape(filename) |
|
5692
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5690
diff
changeset
|
7836 :execute "!ls " . shellescape(filename, 1) |
| 1621 | 7837 < |
| 7 | 7838 Note: The executed string may be any command-line, but |
| 5763 | 7839 starting or ending "if", "while" and "for" does not |
| 7840 always work, because when commands are skipped the | |
| 7841 ":execute" is not evaluated and Vim loses track of | |
| 7842 where blocks start and end. Also "break" and | |
| 7843 "continue" should not be inside ":execute". | |
| 7844 This example does not work, because the ":execute" is | |
| 7845 not evaluated and Vim does not see the "while", and | |
| 7846 gives an error for finding an ":endwhile": > | |
| 7847 :if 0 | |
| 7848 : execute 'while i > 5' | |
| 7849 : echo "test" | |
| 7850 : endwhile | |
| 7851 :endif | |
| 7 | 7852 < |
| 7853 It is allowed to have a "while" or "if" command | |
| 7854 completely in the executed string: > | |
| 7855 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
| 7856 < | |
| 7857 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7858 *:exe-comment* |
| 7 | 7859 ":execute", ":echo" and ":echon" cannot be followed by |
| 7860 a comment directly, because they see the '"' as the | |
| 7861 start of a string. But, you can use '|' followed by a | |
| 7862 comment. Example: > | |
| 7863 :echo "foo" | "this is a comment | |
| 7864 | |
| 7865 ============================================================================== | |
| 7866 8. Exception handling *exception-handling* | |
| 7867 | |
| 7868 The Vim script language comprises an exception handling feature. This section | |
| 7869 explains how it can be used in a Vim script. | |
| 7870 | |
| 7871 Exceptions may be raised by Vim on an error or on interrupt, see | |
| 7872 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
| 7873 exception by using the ":throw" command, see |throw-catch|. | |
| 7874 | |
| 7875 | |
| 7876 TRY CONDITIONALS *try-conditionals* | |
| 7877 | |
| 7878 Exceptions can be caught or can cause cleanup code to be executed. You can | |
| 7879 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
| 7880 a finally clause (to be executed for cleanup). | |
| 7881 A try conditional begins with a |:try| command and ends at the matching | |
| 7882 |:endtry| command. In between, you can use a |:catch| command to start | |
| 7883 a catch clause, or a |:finally| command to start a finally clause. There may | |
| 7884 be none or multiple catch clauses, but there is at most one finally clause, | |
| 7885 which must not be followed by any catch clauses. The lines before the catch | |
| 7886 clauses and the finally clause is called a try block. > | |
| 7887 | |
| 7888 :try | |
| 1621 | 7889 : ... |
| 7890 : ... TRY BLOCK | |
| 7891 : ... | |
| 7 | 7892 :catch /{pattern}/ |
| 1621 | 7893 : ... |
| 7894 : ... CATCH CLAUSE | |
| 7895 : ... | |
| 7 | 7896 :catch /{pattern}/ |
| 1621 | 7897 : ... |
| 7898 : ... CATCH CLAUSE | |
| 7899 : ... | |
| 7 | 7900 :finally |
| 1621 | 7901 : ... |
| 7902 : ... FINALLY CLAUSE | |
| 7903 : ... | |
| 7 | 7904 :endtry |
| 7905 | |
| 7906 The try conditional allows to watch code for exceptions and to take the | |
| 7907 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
| 7908 from the try block and also the catch clauses may cause cleanup actions. | |
| 7909 When no exception is thrown during execution of the try block, the control | |
| 7910 is transferred to the finally clause, if present. After its execution, the | |
| 7911 script continues with the line following the ":endtry". | |
| 7912 When an exception occurs during execution of the try block, the remaining | |
| 7913 lines in the try block are skipped. The exception is matched against the | |
| 7914 patterns specified as arguments to the ":catch" commands. The catch clause | |
| 7915 after the first matching ":catch" is taken, other catch clauses are not | |
| 7916 executed. The catch clause ends when the next ":catch", ":finally", or | |
| 7917 ":endtry" command is reached - whatever is first. Then, the finally clause | |
| 7918 (if present) is executed. When the ":endtry" is reached, the script execution | |
| 7919 continues in the following line as usual. | |
| 7920 When an exception that does not match any of the patterns specified by the | |
| 7921 ":catch" commands is thrown in the try block, the exception is not caught by | |
| 7922 that try conditional and none of the catch clauses is executed. Only the | |
| 7923 finally clause, if present, is taken. The exception pends during execution of | |
| 7924 the finally clause. It is resumed at the ":endtry", so that commands after | |
| 7925 the ":endtry" are not executed and the exception might be caught elsewhere, | |
| 7926 see |try-nesting|. | |
| 7927 When during execution of a catch clause another exception is thrown, the | |
| 1621 | 7928 remaining lines in that catch clause are not executed. The new exception is |
| 7 | 7929 not matched against the patterns in any of the ":catch" commands of the same |
| 7930 try conditional and none of its catch clauses is taken. If there is, however, | |
| 7931 a finally clause, it is executed, and the exception pends during its | |
| 7932 execution. The commands following the ":endtry" are not executed. The new | |
| 7933 exception might, however, be caught elsewhere, see |try-nesting|. | |
| 7934 When during execution of the finally clause (if present) an exception is | |
| 1621 | 7935 thrown, the remaining lines in the finally clause are skipped. If the finally |
| 7 | 7936 clause has been taken because of an exception from the try block or one of the |
| 7937 catch clauses, the original (pending) exception is discarded. The commands | |
| 7938 following the ":endtry" are not executed, and the exception from the finally | |
| 7939 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
| 7940 | |
| 7941 The finally clause is also executed, when a ":break" or ":continue" for | |
| 7942 a ":while" loop enclosing the complete try conditional is executed from the | |
| 7943 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
| 7944 from the try block or a catch clause of a try conditional in a function or | |
| 7945 sourced script, respectively. The ":break", ":continue", ":return", or | |
| 7946 ":finish" pends during execution of the finally clause and is resumed when the | |
| 7947 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
| 7948 from the finally clause. | |
| 7949 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
| 7950 try conditional or when a ":return" or ":finish" is encountered in the finally | |
| 7951 clause, the rest of the finally clause is skipped, and the ":break", | |
| 7952 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
| 7953 clause has been taken because of an exception or an earlier ":break", | |
| 7954 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
| 7955 this pending exception or command is discarded. | |
| 7956 | |
| 7957 For examples see |throw-catch| and |try-finally|. | |
| 7958 | |
| 7959 | |
| 7960 NESTING OF TRY CONDITIONALS *try-nesting* | |
| 7961 | |
| 7962 Try conditionals can be nested arbitrarily. That is, a complete try | |
| 7963 conditional can be put into the try block, a catch clause, or the finally | |
| 7964 clause of another try conditional. If the inner try conditional does not | |
| 7965 catch an exception thrown in its try block or throws a new exception from one | |
| 7966 of its catch clauses or its finally clause, the outer try conditional is | |
| 7967 checked according to the rules above. If the inner try conditional is in the | |
| 7968 try block of the outer try conditional, its catch clauses are checked, but | |
| 1621 | 7969 otherwise only the finally clause is executed. It does not matter for |
| 7 | 7970 nesting, whether the inner try conditional is directly contained in the outer |
| 7971 one, or whether the outer one sources a script or calls a function containing | |
| 7972 the inner try conditional. | |
| 7973 | |
| 7974 When none of the active try conditionals catches an exception, just their | |
| 7975 finally clauses are executed. Thereafter, the script processing terminates. | |
| 7976 An error message is displayed in case of an uncaught exception explicitly | |
| 7977 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
| 7978 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
| 7979 as usual. | |
| 7980 | |
| 7981 For examples see |throw-catch|. | |
| 7982 | |
| 7983 | |
| 7984 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
| 7985 | |
| 7986 Exception handling code can get tricky. If you are in doubt what happens, set | |
| 7987 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
| 7988 script file. Then you see when an exception is thrown, discarded, caught, or | |
| 7989 finished. When using a verbosity level of at least 14, things pending in | |
| 7990 a finally clause are also shown. This information is also given in debug mode | |
| 7991 (see |debug-scripts|). | |
| 7992 | |
| 7993 | |
| 7994 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
| 7995 | |
| 7996 You can throw any number or string as an exception. Use the |:throw| command | |
| 7997 and pass the value to be thrown as argument: > | |
| 7998 :throw 4711 | |
| 7999 :throw "string" | |
| 8000 < *throw-expression* | |
| 8001 You can also specify an expression argument. The expression is then evaluated | |
| 8002 first, and the result is thrown: > | |
| 8003 :throw 4705 + strlen("string") | |
| 8004 :throw strpart("strings", 0, 6) | |
| 8005 | |
| 8006 An exception might be thrown during evaluation of the argument of the ":throw" | |
| 8007 command. Unless it is caught there, the expression evaluation is abandoned. | |
| 8008 The ":throw" command then does not throw a new exception. | |
| 8009 Example: > | |
| 8010 | |
| 8011 :function! Foo(arg) | |
| 8012 : try | |
| 8013 : throw a:arg | |
| 8014 : catch /foo/ | |
| 8015 : endtry | |
| 8016 : return 1 | |
| 8017 :endfunction | |
| 8018 : | |
| 8019 :function! Bar() | |
| 8020 : echo "in Bar" | |
| 8021 : return 4710 | |
| 8022 :endfunction | |
| 8023 : | |
| 8024 :throw Foo("arrgh") + Bar() | |
| 8025 | |
| 8026 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
| 8027 executed. > | |
| 8028 :throw Foo("foo") + Bar() | |
| 8029 however displays "in Bar" and throws 4711. | |
| 8030 | |
| 8031 Any other command that takes an expression as argument might also be | |
| 1621 | 8032 abandoned by an (uncaught) exception during the expression evaluation. The |
| 7 | 8033 exception is then propagated to the caller of the command. |
| 8034 Example: > | |
| 8035 | |
| 8036 :if Foo("arrgh") | |
| 8037 : echo "then" | |
| 8038 :else | |
| 8039 : echo "else" | |
| 8040 :endif | |
| 8041 | |
| 8042 Here neither of "then" or "else" is displayed. | |
| 8043 | |
| 8044 *catch-order* | |
| 8045 Exceptions can be caught by a try conditional with one or more |:catch| | |
| 8046 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
| 8047 command can be specified as a pattern argument. The subsequent catch clause | |
| 8048 gets executed when a matching exception is caught. | |
| 8049 Example: > | |
| 8050 | |
| 8051 :function! Foo(value) | |
| 8052 : try | |
| 8053 : throw a:value | |
| 8054 : catch /^\d\+$/ | |
| 8055 : echo "Number thrown" | |
| 8056 : catch /.*/ | |
| 8057 : echo "String thrown" | |
| 8058 : endtry | |
| 8059 :endfunction | |
| 8060 : | |
| 8061 :call Foo(0x1267) | |
| 8062 :call Foo('string') | |
| 8063 | |
| 8064 The first call to Foo() displays "Number thrown", the second "String thrown". | |
| 8065 An exception is matched against the ":catch" commands in the order they are | |
| 8066 specified. Only the first match counts. So you should place the more | |
| 8067 specific ":catch" first. The following order does not make sense: > | |
| 8068 | |
| 8069 : catch /.*/ | |
| 8070 : echo "String thrown" | |
| 8071 : catch /^\d\+$/ | |
| 8072 : echo "Number thrown" | |
| 8073 | |
| 8074 The first ":catch" here matches always, so that the second catch clause is | |
| 8075 never taken. | |
| 8076 | |
| 8077 *throw-variables* | |
| 8078 If you catch an exception by a general pattern, you may access the exact value | |
| 8079 in the variable |v:exception|: > | |
| 8080 | |
| 8081 : catch /^\d\+$/ | |
| 8082 : echo "Number thrown. Value is" v:exception | |
| 8083 | |
| 8084 You may also be interested where an exception was thrown. This is stored in | |
| 8085 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
| 8086 exception most recently caught as long it is not finished. | |
| 8087 Example: > | |
| 8088 | |
| 8089 :function! Caught() | |
| 8090 : if v:exception != "" | |
| 8091 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
| 8092 : else | |
| 8093 : echo 'Nothing caught' | |
| 8094 : endif | |
| 8095 :endfunction | |
| 8096 : | |
| 8097 :function! Foo() | |
| 8098 : try | |
| 8099 : try | |
| 8100 : try | |
| 8101 : throw 4711 | |
| 8102 : finally | |
| 8103 : call Caught() | |
| 8104 : endtry | |
| 8105 : catch /.*/ | |
| 8106 : call Caught() | |
| 8107 : throw "oops" | |
| 8108 : endtry | |
| 8109 : catch /.*/ | |
| 8110 : call Caught() | |
| 8111 : finally | |
| 8112 : call Caught() | |
| 8113 : endtry | |
| 8114 :endfunction | |
| 8115 : | |
| 8116 :call Foo() | |
| 8117 | |
| 8118 This displays > | |
| 8119 | |
| 8120 Nothing caught | |
| 8121 Caught "4711" in function Foo, line 4 | |
| 8122 Caught "oops" in function Foo, line 10 | |
| 8123 Nothing caught | |
| 8124 | |
| 8125 A practical example: The following command ":LineNumber" displays the line | |
| 8126 number in the script or function where it has been used: > | |
| 8127 | |
| 8128 :function! LineNumber() | |
| 8129 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
| 8130 :endfunction | |
| 8131 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
| 8132 < | |
| 8133 *try-nested* | |
| 8134 An exception that is not caught by a try conditional can be caught by | |
| 8135 a surrounding try conditional: > | |
| 8136 | |
| 8137 :try | |
| 8138 : try | |
| 8139 : throw "foo" | |
| 8140 : catch /foobar/ | |
| 8141 : echo "foobar" | |
| 8142 : finally | |
| 8143 : echo "inner finally" | |
| 8144 : endtry | |
| 8145 :catch /foo/ | |
| 8146 : echo "foo" | |
| 8147 :endtry | |
| 8148 | |
| 8149 The inner try conditional does not catch the exception, just its finally | |
| 8150 clause is executed. The exception is then caught by the outer try | |
| 8151 conditional. The example displays "inner finally" and then "foo". | |
| 8152 | |
| 8153 *throw-from-catch* | |
| 8154 You can catch an exception and throw a new one to be caught elsewhere from the | |
| 8155 catch clause: > | |
| 8156 | |
| 8157 :function! Foo() | |
| 8158 : throw "foo" | |
| 8159 :endfunction | |
| 8160 : | |
| 8161 :function! Bar() | |
| 8162 : try | |
| 8163 : call Foo() | |
| 8164 : catch /foo/ | |
| 8165 : echo "Caught foo, throw bar" | |
| 8166 : throw "bar" | |
| 8167 : endtry | |
| 8168 :endfunction | |
| 8169 : | |
| 8170 :try | |
| 8171 : call Bar() | |
| 8172 :catch /.*/ | |
| 8173 : echo "Caught" v:exception | |
| 8174 :endtry | |
| 8175 | |
| 8176 This displays "Caught foo, throw bar" and then "Caught bar". | |
| 8177 | |
| 8178 *rethrow* | |
| 8179 There is no real rethrow in the Vim script language, but you may throw | |
| 8180 "v:exception" instead: > | |
| 8181 | |
| 8182 :function! Bar() | |
| 8183 : try | |
| 8184 : call Foo() | |
| 8185 : catch /.*/ | |
| 8186 : echo "Rethrow" v:exception | |
| 8187 : throw v:exception | |
| 8188 : endtry | |
| 8189 :endfunction | |
| 8190 < *try-echoerr* | |
| 8191 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
| 8192 exceptions, because it is not possible to fake Vim internal exceptions. | |
| 8193 Trying so causes an error exception. You should throw your own exception | |
| 8194 denoting the situation. If you want to cause a Vim error exception containing | |
| 8195 the original error exception value, you can use the |:echoerr| command: > | |
| 8196 | |
| 8197 :try | |
| 8198 : try | |
| 8199 : asdf | |
| 8200 : catch /.*/ | |
| 8201 : echoerr v:exception | |
| 8202 : endtry | |
| 8203 :catch /.*/ | |
| 8204 : echo v:exception | |
| 8205 :endtry | |
| 8206 | |
| 8207 This code displays | |
| 8208 | |
| 1621 | 8209 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
| 7 | 8210 |
| 8211 | |
| 8212 CLEANUP CODE *try-finally* | |
| 8213 | |
| 8214 Scripts often change global settings and restore them at their end. If the | |
| 8215 user however interrupts the script by pressing CTRL-C, the settings remain in | |
| 1621 | 8216 an inconsistent state. The same may happen to you in the development phase of |
| 7 | 8217 a script when an error occurs or you explicitly throw an exception without |
| 8218 catching it. You can solve these problems by using a try conditional with | |
| 8219 a finally clause for restoring the settings. Its execution is guaranteed on | |
| 8220 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
| 8221 (Note that errors and interrupts from inside the try conditional are converted | |
| 1621 | 8222 to exceptions. When not caught, they terminate the script after the finally |
| 7 | 8223 clause has been executed.) |
| 8224 Example: > | |
| 8225 | |
| 8226 :try | |
| 8227 : let s:saved_ts = &ts | |
| 8228 : set ts=17 | |
| 8229 : | |
| 8230 : " Do the hard work here. | |
| 8231 : | |
| 8232 :finally | |
| 8233 : let &ts = s:saved_ts | |
| 8234 : unlet s:saved_ts | |
| 8235 :endtry | |
| 8236 | |
| 8237 This method should be used locally whenever a function or part of a script | |
| 8238 changes global settings which need to be restored on failure or normal exit of | |
| 8239 that function or script part. | |
| 8240 | |
| 8241 *break-finally* | |
| 8242 Cleanup code works also when the try block or a catch clause is left by | |
| 8243 a ":continue", ":break", ":return", or ":finish". | |
| 8244 Example: > | |
| 8245 | |
| 8246 :let first = 1 | |
| 8247 :while 1 | |
| 8248 : try | |
| 8249 : if first | |
| 8250 : echo "first" | |
| 8251 : let first = 0 | |
| 8252 : continue | |
| 8253 : else | |
| 8254 : throw "second" | |
| 8255 : endif | |
| 8256 : catch /.*/ | |
| 8257 : echo v:exception | |
| 8258 : break | |
| 8259 : finally | |
| 8260 : echo "cleanup" | |
| 8261 : endtry | |
| 8262 : echo "still in while" | |
| 8263 :endwhile | |
| 8264 :echo "end" | |
| 8265 | |
| 8266 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
| 8267 | |
| 8268 :function! Foo() | |
| 8269 : try | |
| 8270 : return 4711 | |
| 8271 : finally | |
| 8272 : echo "cleanup\n" | |
| 8273 : endtry | |
| 8274 : echo "Foo still active" | |
| 8275 :endfunction | |
| 8276 : | |
| 8277 :echo Foo() "returned by Foo" | |
| 8278 | |
| 8279 This displays "cleanup" and "4711 returned by Foo". You don't need to add an | |
| 1621 | 8280 extra ":return" in the finally clause. (Above all, this would override the |
| 7 | 8281 return value.) |
| 8282 | |
| 8283 *except-from-finally* | |
| 8284 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
| 8285 a finally clause is possible, but not recommended since it abandons the | |
| 8286 cleanup actions for the try conditional. But, of course, interrupt and error | |
| 8287 exceptions might get raised from a finally clause. | |
| 8288 Example where an error in the finally clause stops an interrupt from | |
| 8289 working correctly: > | |
| 8290 | |
| 8291 :try | |
| 8292 : try | |
| 8293 : echo "Press CTRL-C for interrupt" | |
| 8294 : while 1 | |
| 8295 : endwhile | |
| 8296 : finally | |
| 8297 : unlet novar | |
| 8298 : endtry | |
| 8299 :catch /novar/ | |
| 8300 :endtry | |
| 8301 :echo "Script still running" | |
| 8302 :sleep 1 | |
| 8303 | |
| 8304 If you need to put commands that could fail into a finally clause, you should | |
| 8305 think about catching or ignoring the errors in these commands, see | |
| 8306 |catch-errors| and |ignore-errors|. | |
| 8307 | |
| 8308 | |
| 8309 CATCHING ERRORS *catch-errors* | |
| 8310 | |
| 8311 If you want to catch specific errors, you just have to put the code to be | |
| 8312 watched in a try block and add a catch clause for the error message. The | |
| 8313 presence of the try conditional causes all errors to be converted to an | |
| 8314 exception. No message is displayed and |v:errmsg| is not set then. To find | |
| 8315 the right pattern for the ":catch" command, you have to know how the format of | |
| 8316 the error exception is. | |
| 8317 Error exceptions have the following format: > | |
| 8318 | |
| 8319 Vim({cmdname}):{errmsg} | |
| 8320 or > | |
| 8321 Vim:{errmsg} | |
| 8322 | |
| 8323 {cmdname} is the name of the command that failed; the second form is used when | |
| 1621 | 8324 the command name is not known. {errmsg} is the error message usually produced |
| 7 | 8325 when the error occurs outside try conditionals. It always begins with |
| 8326 a capital "E", followed by a two or three-digit error number, a colon, and | |
| 8327 a space. | |
| 8328 | |
| 8329 Examples: | |
| 8330 | |
| 8331 The command > | |
| 8332 :unlet novar | |
| 8333 normally produces the error message > | |
| 8334 E108: No such variable: "novar" | |
| 8335 which is converted inside try conditionals to an exception > | |
| 8336 Vim(unlet):E108: No such variable: "novar" | |
| 8337 | |
| 8338 The command > | |
| 8339 :dwim | |
| 8340 normally produces the error message > | |
| 8341 E492: Not an editor command: dwim | |
| 8342 which is converted inside try conditionals to an exception > | |
| 8343 Vim:E492: Not an editor command: dwim | |
| 8344 | |
| 8345 You can catch all ":unlet" errors by a > | |
| 8346 :catch /^Vim(unlet):/ | |
| 8347 or all errors for misspelled command names by a > | |
| 8348 :catch /^Vim:E492:/ | |
| 8349 | |
| 8350 Some error messages may be produced by different commands: > | |
| 8351 :function nofunc | |
| 8352 and > | |
| 8353 :delfunction nofunc | |
| 8354 both produce the error message > | |
| 8355 E128: Function name must start with a capital: nofunc | |
| 8356 which is converted inside try conditionals to an exception > | |
| 8357 Vim(function):E128: Function name must start with a capital: nofunc | |
| 8358 or > | |
| 8359 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
| 8360 respectively. You can catch the error by its number independently on the | |
| 8361 command that caused it if you use the following pattern: > | |
| 8362 :catch /^Vim(\a\+):E128:/ | |
| 8363 | |
| 8364 Some commands like > | |
| 8365 :let x = novar | |
| 8366 produce multiple error messages, here: > | |
| 8367 E121: Undefined variable: novar | |
| 8368 E15: Invalid expression: novar | |
| 8369 Only the first is used for the exception value, since it is the most specific | |
| 8370 one (see |except-several-errors|). So you can catch it by > | |
| 8371 :catch /^Vim(\a\+):E121:/ | |
| 8372 | |
| 8373 You can catch all errors related to the name "nofunc" by > | |
| 8374 :catch /\<nofunc\>/ | |
| 8375 | |
| 8376 You can catch all Vim errors in the ":write" and ":read" commands by > | |
| 8377 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
| 8378 | |
| 8379 You can catch all Vim errors by the pattern > | |
| 8380 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
| 8381 < | |
| 8382 *catch-text* | |
| 8383 NOTE: You should never catch the error message text itself: > | |
| 8384 :catch /No such variable/ | |
| 6647 | 8385 only works in the English locale, but not when the user has selected |
| 7 | 8386 a different language by the |:language| command. It is however helpful to |
| 8387 cite the message text in a comment: > | |
| 8388 :catch /^Vim(\a\+):E108:/ " No such variable | |
| 8389 | |
| 8390 | |
| 8391 IGNORING ERRORS *ignore-errors* | |
| 8392 | |
| 8393 You can ignore errors in a specific Vim command by catching them locally: > | |
| 8394 | |
| 8395 :try | |
| 8396 : write | |
| 8397 :catch | |
| 8398 :endtry | |
| 8399 | |
| 8400 But you are strongly recommended NOT to use this simple form, since it could | |
| 8401 catch more than you want. With the ":write" command, some autocommands could | |
| 8402 be executed and cause errors not related to writing, for instance: > | |
| 8403 | |
| 8404 :au BufWritePre * unlet novar | |
| 8405 | |
| 8406 There could even be such errors you are not responsible for as a script | |
| 8407 writer: a user of your script might have defined such autocommands. You would | |
| 8408 then hide the error from the user. | |
| 8409 It is much better to use > | |
| 8410 | |
| 8411 :try | |
| 8412 : write | |
| 8413 :catch /^Vim(write):/ | |
| 8414 :endtry | |
| 8415 | |
| 8416 which only catches real write errors. So catch only what you'd like to ignore | |
| 8417 intentionally. | |
| 8418 | |
| 8419 For a single command that does not cause execution of autocommands, you could | |
| 8420 even suppress the conversion of errors to exceptions by the ":silent!" | |
| 8421 command: > | |
| 8422 :silent! nunmap k | |
| 8423 This works also when a try conditional is active. | |
| 8424 | |
| 8425 | |
| 8426 CATCHING INTERRUPTS *catch-interrupt* | |
| 8427 | |
| 8428 When there are active try conditionals, an interrupt (CTRL-C) is converted to | |
| 1621 | 8429 the exception "Vim:Interrupt". You can catch it like every exception. The |
| 7 | 8430 script is not terminated, then. |
| 8431 Example: > | |
| 8432 | |
| 8433 :function! TASK1() | |
| 8434 : sleep 10 | |
| 8435 :endfunction | |
| 8436 | |
| 8437 :function! TASK2() | |
| 8438 : sleep 20 | |
| 8439 :endfunction | |
| 8440 | |
| 8441 :while 1 | |
| 8442 : let command = input("Type a command: ") | |
| 8443 : try | |
| 8444 : if command == "" | |
| 8445 : continue | |
| 8446 : elseif command == "END" | |
| 8447 : break | |
| 8448 : elseif command == "TASK1" | |
| 8449 : call TASK1() | |
| 8450 : elseif command == "TASK2" | |
| 8451 : call TASK2() | |
| 8452 : else | |
| 8453 : echo "\nIllegal command:" command | |
| 8454 : continue | |
| 8455 : endif | |
| 8456 : catch /^Vim:Interrupt$/ | |
| 8457 : echo "\nCommand interrupted" | |
| 8458 : " Caught the interrupt. Continue with next prompt. | |
| 8459 : endtry | |
| 8460 :endwhile | |
| 8461 | |
| 8462 You can interrupt a task here by pressing CTRL-C; the script then asks for | |
| 1621 | 8463 a new command. If you press CTRL-C at the prompt, the script is terminated. |
| 7 | 8464 |
| 8465 For testing what happens when CTRL-C would be pressed on a specific line in | |
| 8466 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
| 8467 command on that line. See |debug-scripts|. | |
| 8468 | |
| 8469 | |
| 8470 CATCHING ALL *catch-all* | |
| 8471 | |
| 8472 The commands > | |
| 8473 | |
| 8474 :catch /.*/ | |
| 8475 :catch // | |
| 8476 :catch | |
| 8477 | |
| 8478 catch everything, error exceptions, interrupt exceptions and exceptions | |
| 8479 explicitly thrown by the |:throw| command. This is useful at the top level of | |
| 8480 a script in order to catch unexpected things. | |
| 8481 Example: > | |
| 8482 | |
| 8483 :try | |
| 8484 : | |
| 8485 : " do the hard work here | |
| 8486 : | |
| 8487 :catch /MyException/ | |
| 8488 : | |
| 8489 : " handle known problem | |
| 8490 : | |
| 8491 :catch /^Vim:Interrupt$/ | |
| 8492 : echo "Script interrupted" | |
| 8493 :catch /.*/ | |
| 8494 : echo "Internal error (" . v:exception . ")" | |
| 8495 : echo " - occurred at " . v:throwpoint | |
| 8496 :endtry | |
| 8497 :" end of script | |
| 8498 | |
| 8499 Note: Catching all might catch more things than you want. Thus, you are | |
| 8500 strongly encouraged to catch only for problems that you can really handle by | |
| 8501 specifying a pattern argument to the ":catch". | |
| 8502 Example: Catching all could make it nearly impossible to interrupt a script | |
| 8503 by pressing CTRL-C: > | |
| 8504 | |
| 8505 :while 1 | |
| 8506 : try | |
| 8507 : sleep 1 | |
| 8508 : catch | |
| 8509 : endtry | |
| 8510 :endwhile | |
| 8511 | |
| 8512 | |
| 8513 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
| 8514 | |
| 8515 Exceptions may be used during execution of autocommands. Example: > | |
| 8516 | |
| 8517 :autocmd User x try | |
| 8518 :autocmd User x throw "Oops!" | |
| 8519 :autocmd User x catch | |
| 8520 :autocmd User x echo v:exception | |
| 8521 :autocmd User x endtry | |
| 8522 :autocmd User x throw "Arrgh!" | |
| 8523 :autocmd User x echo "Should not be displayed" | |
| 8524 : | |
| 8525 :try | |
| 8526 : doautocmd User x | |
| 8527 :catch | |
| 8528 : echo v:exception | |
| 8529 :endtry | |
| 8530 | |
| 8531 This displays "Oops!" and "Arrgh!". | |
| 8532 | |
| 8533 *except-autocmd-Pre* | |
| 8534 For some commands, autocommands get executed before the main action of the | |
| 8535 command takes place. If an exception is thrown and not caught in the sequence | |
| 8536 of autocommands, the sequence and the command that caused its execution are | |
| 8537 abandoned and the exception is propagated to the caller of the command. | |
| 8538 Example: > | |
| 8539 | |
| 8540 :autocmd BufWritePre * throw "FAIL" | |
| 8541 :autocmd BufWritePre * echo "Should not be displayed" | |
| 8542 : | |
| 8543 :try | |
| 8544 : write | |
| 8545 :catch | |
| 8546 : echo "Caught:" v:exception "from" v:throwpoint | |
| 8547 :endtry | |
| 8548 | |
| 8549 Here, the ":write" command does not write the file currently being edited (as | |
| 8550 you can see by checking 'modified'), since the exception from the BufWritePre | |
| 8551 autocommand abandons the ":write". The exception is then caught and the | |
| 8552 script displays: > | |
| 8553 | |
| 8554 Caught: FAIL from BufWrite Auto commands for "*" | |
| 8555 < | |
| 8556 *except-autocmd-Post* | |
| 8557 For some commands, autocommands get executed after the main action of the | |
| 8558 command has taken place. If this main action fails and the command is inside | |
| 8559 an active try conditional, the autocommands are skipped and an error exception | |
| 8560 is thrown that can be caught by the caller of the command. | |
| 8561 Example: > | |
| 8562 | |
| 8563 :autocmd BufWritePost * echo "File successfully written!" | |
| 8564 : | |
| 8565 :try | |
| 8566 : write /i/m/p/o/s/s/i/b/l/e | |
| 8567 :catch | |
| 8568 : echo v:exception | |
| 8569 :endtry | |
| 8570 | |
| 8571 This just displays: > | |
| 8572 | |
| 8573 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
| 8574 | |
| 8575 If you really need to execute the autocommands even when the main action | |
| 8576 fails, trigger the event from the catch clause. | |
| 8577 Example: > | |
| 8578 | |
| 8579 :autocmd BufWritePre * set noreadonly | |
| 8580 :autocmd BufWritePost * set readonly | |
| 8581 : | |
| 8582 :try | |
| 8583 : write /i/m/p/o/s/s/i/b/l/e | |
| 8584 :catch | |
| 8585 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
| 8586 :endtry | |
| 8587 < | |
| 8588 You can also use ":silent!": > | |
| 8589 | |
| 8590 :let x = "ok" | |
| 8591 :let v:errmsg = "" | |
| 8592 :autocmd BufWritePost * if v:errmsg != "" | |
| 8593 :autocmd BufWritePost * let x = "after fail" | |
| 8594 :autocmd BufWritePost * endif | |
| 8595 :try | |
| 8596 : silent! write /i/m/p/o/s/s/i/b/l/e | |
| 8597 :catch | |
| 8598 :endtry | |
| 8599 :echo x | |
| 8600 | |
| 8601 This displays "after fail". | |
| 8602 | |
| 8603 If the main action of the command does not fail, exceptions from the | |
| 8604 autocommands will be catchable by the caller of the command: > | |
| 8605 | |
| 8606 :autocmd BufWritePost * throw ":-(" | |
| 8607 :autocmd BufWritePost * echo "Should not be displayed" | |
| 8608 : | |
| 8609 :try | |
| 8610 : write | |
| 8611 :catch | |
| 8612 : echo v:exception | |
| 8613 :endtry | |
| 8614 < | |
| 8615 *except-autocmd-Cmd* | |
| 8616 For some commands, the normal action can be replaced by a sequence of | |
| 8617 autocommands. Exceptions from that sequence will be catchable by the caller | |
| 8618 of the command. | |
| 8619 Example: For the ":write" command, the caller cannot know whether the file | |
| 1621 | 8620 had actually been written when the exception occurred. You need to tell it in |
| 7 | 8621 some way. > |
| 8622 | |
| 8623 :if !exists("cnt") | |
| 8624 : let cnt = 0 | |
| 8625 : | |
| 8626 : autocmd BufWriteCmd * if &modified | |
| 8627 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
| 8628 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
| 8629 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 8630 : autocmd BufWriteCmd * endif | |
| 8631 : autocmd BufWriteCmd * write | set nomodified | |
| 8632 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
| 8633 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 8634 : autocmd BufWriteCmd * endif | |
| 8635 : autocmd BufWriteCmd * echo "File successfully written!" | |
| 8636 : autocmd BufWriteCmd * endif | |
| 8637 :endif | |
| 8638 : | |
| 8639 :try | |
| 8640 : write | |
| 8641 :catch /^BufWriteCmdError$/ | |
| 8642 : if &modified | |
| 8643 : echo "Error on writing (file contents not changed)" | |
| 8644 : else | |
| 8645 : echo "Error after writing" | |
| 8646 : endif | |
| 8647 :catch /^Vim(write):/ | |
| 8648 : echo "Error on writing" | |
| 8649 :endtry | |
| 8650 | |
| 8651 When this script is sourced several times after making changes, it displays | |
| 8652 first > | |
| 8653 File successfully written! | |
| 8654 then > | |
| 8655 Error on writing (file contents not changed) | |
| 8656 then > | |
| 8657 Error after writing | |
| 8658 etc. | |
| 8659 | |
| 8660 *except-autocmd-ill* | |
| 8661 You cannot spread a try conditional over autocommands for different events. | |
| 8662 The following code is ill-formed: > | |
| 8663 | |
| 8664 :autocmd BufWritePre * try | |
| 8665 : | |
| 8666 :autocmd BufWritePost * catch | |
| 8667 :autocmd BufWritePost * echo v:exception | |
| 8668 :autocmd BufWritePost * endtry | |
| 8669 : | |
| 8670 :write | |
| 8671 | |
| 8672 | |
| 8673 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
| 8674 | |
| 8675 Some programming languages allow to use hierarchies of exception classes or to | |
| 8676 pass additional information with the object of an exception class. You can do | |
| 8677 similar things in Vim. | |
| 8678 In order to throw an exception from a hierarchy, just throw the complete | |
| 8679 class name with the components separated by a colon, for instance throw the | |
| 8680 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
| 8681 When you want to pass additional information with your exception class, add | |
| 8682 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
| 8683 for an error when writing "myfile". | |
| 8684 With the appropriate patterns in the ":catch" command, you can catch for | |
| 8685 base classes or derived classes of your hierarchy. Additional information in | |
| 8686 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
| 8687 Example: > | |
| 8688 | |
| 8689 :function! CheckRange(a, func) | |
| 8690 : if a:a < 0 | |
| 8691 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
| 8692 : endif | |
| 8693 :endfunction | |
| 8694 : | |
| 8695 :function! Add(a, b) | |
| 8696 : call CheckRange(a:a, "Add") | |
| 8697 : call CheckRange(a:b, "Add") | |
| 8698 : let c = a:a + a:b | |
| 8699 : if c < 0 | |
| 8700 : throw "EXCEPT:MATHERR:OVERFLOW" | |
| 8701 : endif | |
| 8702 : return c | |
| 8703 :endfunction | |
| 8704 : | |
| 8705 :function! Div(a, b) | |
| 8706 : call CheckRange(a:a, "Div") | |
| 8707 : call CheckRange(a:b, "Div") | |
| 8708 : if (a:b == 0) | |
| 8709 : throw "EXCEPT:MATHERR:ZERODIV" | |
| 8710 : endif | |
| 8711 : return a:a / a:b | |
| 8712 :endfunction | |
| 8713 : | |
| 8714 :function! Write(file) | |
| 8715 : try | |
| 1621 | 8716 : execute "write" fnameescape(a:file) |
| 7 | 8717 : catch /^Vim(write):/ |
| 8718 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
| 8719 : endtry | |
| 8720 :endfunction | |
| 8721 : | |
| 8722 :try | |
| 8723 : | |
| 8724 : " something with arithmetics and I/O | |
| 8725 : | |
| 8726 :catch /^EXCEPT:MATHERR:RANGE/ | |
| 8727 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
| 8728 : echo "Range error in" function | |
| 8729 : | |
| 8730 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
| 8731 : echo "Math error" | |
| 8732 : | |
| 8733 :catch /^EXCEPT:IO/ | |
| 8734 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
| 8735 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
| 8736 : if file !~ '^/' | |
| 8737 : let file = dir . "/" . file | |
| 8738 : endif | |
| 8739 : echo 'I/O error for "' . file . '"' | |
| 8740 : | |
| 8741 :catch /^EXCEPT/ | |
| 8742 : echo "Unspecified error" | |
| 8743 : | |
| 8744 :endtry | |
| 8745 | |
| 8746 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
| 8747 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
| 8748 exceptions with the "Vim" prefix; they are reserved for Vim. | |
| 8749 Vim error exceptions are parameterized with the name of the command that | |
| 8750 failed, if known. See |catch-errors|. | |
| 8751 | |
| 8752 | |
| 8753 PECULIARITIES | |
| 8754 *except-compat* | |
| 8755 The exception handling concept requires that the command sequence causing the | |
| 8756 exception is aborted immediately and control is transferred to finally clauses | |
| 8757 and/or a catch clause. | |
| 8758 | |
| 8759 In the Vim script language there are cases where scripts and functions | |
| 8760 continue after an error: in functions without the "abort" flag or in a command | |
| 8761 after ":silent!", control flow goes to the following line, and outside | |
| 8762 functions, control flow goes to the line following the outermost ":endwhile" | |
| 8763 or ":endif". On the other hand, errors should be catchable as exceptions | |
| 8764 (thus, requiring the immediate abortion). | |
| 8765 | |
| 8766 This problem has been solved by converting errors to exceptions and using | |
| 8767 immediate abortion (if not suppressed by ":silent!") only when a try | |
| 1621 | 8768 conditional is active. This is no restriction since an (error) exception can |
| 8769 be caught only from an active try conditional. If you want an immediate | |
| 7 | 8770 termination without catching the error, just use a try conditional without |
| 8771 catch clause. (You can cause cleanup code being executed before termination | |
| 8772 by specifying a finally clause.) | |
| 8773 | |
| 8774 When no try conditional is active, the usual abortion and continuation | |
| 8775 behavior is used instead of immediate abortion. This ensures compatibility of | |
| 8776 scripts written for Vim 6.1 and earlier. | |
| 8777 | |
| 8778 However, when sourcing an existing script that does not use exception handling | |
| 8779 commands (or when calling one of its functions) from inside an active try | |
| 8780 conditional of a new script, you might change the control flow of the existing | |
| 8781 script on error. You get the immediate abortion on error and can catch the | |
| 8782 error in the new script. If however the sourced script suppresses error | |
| 8783 messages by using the ":silent!" command (checking for errors by testing | |
| 1621 | 8784 |v:errmsg| if appropriate), its execution path is not changed. The error is |
| 8785 not converted to an exception. (See |:silent|.) So the only remaining cause | |
| 7 | 8786 where this happens is for scripts that don't care about errors and produce |
| 8787 error messages. You probably won't want to use such code from your new | |
| 8788 scripts. | |
| 8789 | |
| 8790 *except-syntax-err* | |
| 8791 Syntax errors in the exception handling commands are never caught by any of | |
| 8792 the ":catch" commands of the try conditional they belong to. Its finally | |
| 8793 clauses, however, is executed. | |
| 8794 Example: > | |
| 8795 | |
| 8796 :try | |
| 8797 : try | |
| 8798 : throw 4711 | |
| 8799 : catch /\(/ | |
| 8800 : echo "in catch with syntax error" | |
| 8801 : catch | |
| 8802 : echo "inner catch-all" | |
| 8803 : finally | |
| 8804 : echo "inner finally" | |
| 8805 : endtry | |
| 8806 :catch | |
| 8807 : echo 'outer catch-all caught "' . v:exception . '"' | |
| 8808 : finally | |
| 8809 : echo "outer finally" | |
| 8810 :endtry | |
| 8811 | |
| 8812 This displays: > | |
| 8813 inner finally | |
| 8814 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
| 8815 outer finally | |
| 8816 The original exception is discarded and an error exception is raised, instead. | |
| 8817 | |
| 8818 *except-single-line* | |
| 8819 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
| 8820 a single line, but then syntax errors may make it difficult to recognize the | |
| 8821 "catch" line, thus you better avoid this. | |
| 8822 Example: > | |
| 8823 :try | unlet! foo # | catch | endtry | |
| 8824 raises an error exception for the trailing characters after the ":unlet!" | |
| 8825 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
| 8826 error exception is discarded and the "E488: Trailing characters" message gets | |
| 8827 displayed. | |
| 8828 | |
| 8829 *except-several-errors* | |
| 8830 When several errors appear in a single command, the first error message is | |
| 8831 usually the most specific one and therefor converted to the error exception. | |
| 8832 Example: > | |
| 8833 echo novar | |
| 8834 causes > | |
| 8835 E121: Undefined variable: novar | |
| 8836 E15: Invalid expression: novar | |
| 8837 The value of the error exception inside try conditionals is: > | |
| 8838 Vim(echo):E121: Undefined variable: novar | |
| 8839 < *except-syntax-error* | |
| 8840 But when a syntax error is detected after a normal error in the same command, | |
| 8841 the syntax error is used for the exception being thrown. | |
| 8842 Example: > | |
| 8843 unlet novar # | |
| 8844 causes > | |
| 8845 E108: No such variable: "novar" | |
| 8846 E488: Trailing characters | |
| 8847 The value of the error exception inside try conditionals is: > | |
| 8848 Vim(unlet):E488: Trailing characters | |
| 8849 This is done because the syntax error might change the execution path in a way | |
| 8850 not intended by the user. Example: > | |
| 8851 try | |
| 8852 try | unlet novar # | catch | echo v:exception | endtry | |
| 8853 catch /.*/ | |
| 8854 echo "outer catch:" v:exception | |
| 8855 endtry | |
| 8856 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
| 8857 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
| 8858 | |
| 8859 ============================================================================== | |
| 8860 9. Examples *eval-examples* | |
| 8861 | |
| 1156 | 8862 Printing in Binary ~ |
| 7 | 8863 > |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8864 :" The function Nr2Bin() returns the binary string representation of a number. |
| 1156 | 8865 :func Nr2Bin(nr) |
| 7 | 8866 : let n = a:nr |
| 8867 : let r = "" | |
| 8868 : while n | |
| 1156 | 8869 : let r = '01'[n % 2] . r |
| 8870 : let n = n / 2 | |
| 7 | 8871 : endwhile |
| 8872 : return r | |
| 8873 :endfunc | |
| 8874 | |
| 1156 | 8875 :" The function String2Bin() converts each character in a string to a |
| 8876 :" binary string, separated with dashes. | |
| 8877 :func String2Bin(str) | |
| 7 | 8878 : let out = '' |
| 1156 | 8879 : for ix in range(strlen(a:str)) |
| 8880 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
| 8881 : endfor | |
| 8882 : return out[1:] | |
| 7 | 8883 :endfunc |
| 8884 | |
| 8885 Example of its use: > | |
| 1156 | 8886 :echo Nr2Bin(32) |
| 8887 result: "100000" > | |
| 8888 :echo String2Bin("32") | |
| 8889 result: "110011-110010" | |
| 8890 | |
| 8891 | |
| 8892 Sorting lines ~ | |
| 8893 | |
| 8894 This example sorts lines with a specific compare function. > | |
| 8895 | |
| 8896 :func SortBuffer() | |
| 8897 : let lines = getline(1, '$') | |
| 8898 : call sort(lines, function("Strcmp")) | |
| 8899 : call setline(1, lines) | |
| 7 | 8900 :endfunction |
| 8901 | |
| 1156 | 8902 As a one-liner: > |
| 8903 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
| 8904 | |
| 8905 | |
| 8906 scanf() replacement ~ | |
| 7 | 8907 *sscanf* |
| 8908 There is no sscanf() function in Vim. If you need to extract parts from a | |
| 8909 line, you can use matchstr() and substitute() to do it. This example shows | |
| 8910 how to get the file name, line number and column number out of a line like | |
| 8911 "foobar.txt, 123, 45". > | |
| 8912 :" Set up the match bit | |
| 8913 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
| 8914 :"get the part matching the whole expression | |
| 8915 :let l = matchstr(line, mx) | |
| 8916 :"get each item out of the match | |
| 8917 :let file = substitute(l, mx, '\1', '') | |
| 8918 :let lnum = substitute(l, mx, '\2', '') | |
| 8919 :let col = substitute(l, mx, '\3', '') | |
| 8920 | |
| 8921 The input is in the variable "line", the results in the variables "file", | |
| 8922 "lnum" and "col". (idea from Michael Geddes) | |
| 8923 | |
| 1156 | 8924 |
| 8925 getting the scriptnames in a Dictionary ~ | |
| 8926 *scriptnames-dictionary* | |
| 8927 The |:scriptnames| command can be used to get a list of all script files that | |
| 8928 have been sourced. There is no equivalent function or variable for this | |
| 8929 (because it's rarely needed). In case you need to manipulate the list this | |
| 8930 code can be used: > | |
| 8931 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
| 8932 let scriptnames_output = '' | |
| 8933 redir => scriptnames_output | |
| 8934 silent scriptnames | |
| 8935 redir END | |
| 8936 | |
| 1621 | 8937 " Split the output into lines and parse each line. Add an entry to the |
| 1156 | 8938 " "scripts" dictionary. |
| 8939 let scripts = {} | |
| 8940 for line in split(scriptnames_output, "\n") | |
| 8941 " Only do non-blank lines. | |
| 8942 if line =~ '\S' | |
| 8943 " Get the first number in the line. | |
| 1621 | 8944 let nr = matchstr(line, '\d\+') |
| 1156 | 8945 " Get the file name, remove the script number " 123: ". |
| 1621 | 8946 let name = substitute(line, '.\+:\s*', '', '') |
| 1156 | 8947 " Add an item to the Dictionary |
| 1621 | 8948 let scripts[nr] = name |
| 1156 | 8949 endif |
| 8950 endfor | |
| 8951 unlet scriptnames_output | |
| 8952 | |
| 7 | 8953 ============================================================================== |
| 8954 10. No +eval feature *no-eval-feature* | |
| 8955 | |
| 8956 When the |+eval| feature was disabled at compile time, none of the expression | |
| 8957 evaluation commands are available. To prevent this from causing Vim scripts | |
| 8958 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
| 8959 recognized, though the argument of the ":if" and everything between the ":if" | |
| 8960 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
| 8961 only if the commands are at the start of the line. The ":else" command is not | |
| 8962 recognized. | |
| 8963 | |
| 8964 Example of how to avoid executing commands when the |+eval| feature is | |
| 8965 missing: > | |
| 8966 | |
| 8967 :if 1 | |
| 8968 : echo "Expression evaluation is compiled in" | |
| 8969 :else | |
| 8970 : echo "You will _never_ see this message" | |
| 8971 :endif | |
| 8972 | |
| 8973 ============================================================================== | |
| 8974 11. The sandbox *eval-sandbox* *sandbox* *E48* | |
| 8975 | |
|
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
8976 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
|
8977 '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
|
8978 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
|
8979 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
|
8980 the command from a tags file is executed and for CTRL-R = in the command line. |
| 29 | 8981 The sandbox is also used for the |:sandbox| command. |
| 7 | 8982 |
| 8983 These items are not allowed in the sandbox: | |
| 8984 - changing the buffer text | |
| 8985 - defining or changing mapping, autocommands, functions, user commands | |
| 8986 - setting certain options (see |option-summary|) | |
| 1156 | 8987 - setting certain v: variables (see |v:var|) *E794* |
| 7 | 8988 - executing a shell command |
| 8989 - reading or writing a file | |
| 8990 - jumping to another buffer or editing a file | |
| 625 | 8991 - executing Python, Perl, etc. commands |
| 29 | 8992 This is not guaranteed 100% secure, but it should block most attacks. |
| 8993 | |
| 8994 *:san* *:sandbox* | |
| 401 | 8995 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
| 29 | 8996 option that may have been set from a modeline, e.g. |
| 8997 'foldexpr'. | |
| 8998 | |
| 634 | 8999 *sandbox-option* |
| 9000 A few options contain an expression. When this expression is evaluated it may | |
| 790 | 9001 have to be done in the sandbox to avoid a security risk. But the sandbox is |
| 634 | 9002 restrictive, thus this only happens when the option was set from an insecure |
| 9003 location. Insecure in this context are: | |
| 843 | 9004 - sourcing a .vimrc or .exrc in the current directory |
| 634 | 9005 - while executing in the sandbox |
| 9006 - value coming from a modeline | |
| 9007 | |
| 9008 Note that when in the sandbox and saving an option value and restoring it, the | |
| 9009 option will still be marked as it was set in the sandbox. | |
| 9010 | |
| 9011 ============================================================================== | |
| 9012 12. Textlock *textlock* | |
| 9013 | |
| 9014 In a few situations it is not allowed to change the text in the buffer, jump | |
| 9015 to another window and some other things that might confuse or break what Vim | |
| 9016 is currently doing. This mostly applies to things that happen when Vim is | |
| 1621 | 9017 actually doing something else. For example, evaluating the 'balloonexpr' may |
| 634 | 9018 happen any moment the mouse cursor is resting at some position. |
| 9019 | |
| 9020 This is not allowed when the textlock is active: | |
| 9021 - changing the buffer text | |
| 9022 - jumping to another buffer or window | |
| 9023 - editing another file | |
| 9024 - closing a window or quitting Vim | |
| 9025 - etc. | |
| 9026 | |
| 7 | 9027 |
| 9028 vim:tw=78:ts=8:ft=help:norl: |