Mercurial > vim
annotate runtime/doc/eval.txt @ 2616:73d947c20291 v7.3.038
updated for version 7.3.038
Problem: v:windowid isn't set on MS-Windows.
Solution: Set it to the window handle. (Chris Sutcliffe)
| author | Bram Moolenaar <bram@vim.org> |
|---|---|
| date | Wed, 27 Oct 2010 12:33:17 +0200 |
| parents | 6c05b5e5c1be |
| children | 0aa21d63aba0 |
| rev | line source |
|---|---|
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
1 *eval.txt* For Vim version 7.3. Last change: 2010 Oct 18 |
| 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 | |
| 42 Number A 32 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, | |
| 94 use strlen(): > | |
| 95 :if strlen("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 |
| 126 cannot have both a Funcref variable and a function with the same name. | |
| 85 | 127 |
| 114 | 128 A special case is defining a function and directly assigning its Funcref to a |
| 129 Dictionary entry. Example: > | |
| 130 :function dict.init() dict | |
| 131 : let self.val = 0 | |
| 132 :endfunction | |
| 133 | |
| 134 The key of the Dictionary can start with a lower case letter. The actual | |
| 135 function name is not used here. Also see |numbered-function|. | |
| 136 | |
| 137 A Funcref can also be used with the |:call| command: > | |
| 138 :call Fn() | |
| 139 :call dict.init() | |
| 85 | 140 |
| 141 The name of the referenced function can be obtained with |string()|. > | |
| 119 | 142 :let func = string(Fn) |
| 85 | 143 |
| 144 You can use |call()| to invoke a Funcref and use a list variable for the | |
| 145 arguments: > | |
| 119 | 146 :let r = call(Fn, mylist) |
| 85 | 147 |
| 148 | |
| 87 | 149 1.3 Lists ~ |
| 161 | 150 *List* *Lists* *E686* |
| 55 | 151 A List is an ordered sequence of items. An item can be of any type. Items |
| 1621 | 152 can be accessed by their index number. Items can be added and removed at any |
| 55 | 153 position in the sequence. |
| 154 | |
| 85 | 155 |
| 156 List creation ~ | |
| 157 *E696* *E697* | |
| 55 | 158 A List is created with a comma separated list of items in square brackets. |
| 85 | 159 Examples: > |
| 160 :let mylist = [1, two, 3, "four"] | |
| 161 :let emptylist = [] | |
| 55 | 162 |
| 1621 | 163 An item can be any expression. Using a List for an item creates a |
| 842 | 164 List of Lists: > |
| 85 | 165 :let nestlist = [[11, 12], [21, 22], [31, 32]] |
| 55 | 166 |
| 167 An extra comma after the last item is ignored. | |
| 168 | |
| 85 | 169 |
| 170 List index ~ | |
| 171 *list-index* *E684* | |
| 55 | 172 An item in the List can be accessed by putting the index in square brackets |
| 85 | 173 after the List. Indexes are zero-based, thus the first item has index zero. > |
| 174 :let item = mylist[0] " get the first item: 1 | |
| 55 | 175 :let item = mylist[2] " get the third item: 3 |
| 85 | 176 |
| 87 | 177 When the resulting item is a list this can be repeated: > |
| 85 | 178 :let item = nestlist[0][1] " get the first list, second item: 12 |
| 55 | 179 < |
| 85 | 180 A negative index is counted from the end. Index -1 refers to the last item in |
| 181 the List, -2 to the last but one item, etc. > | |
| 55 | 182 :let last = mylist[-1] " get the last item: "four" |
| 183 | |
| 85 | 184 To avoid an error for an invalid index use the |get()| function. When an item |
| 87 | 185 is not available it returns zero or the default value you specify: > |
| 85 | 186 :echo get(mylist, idx) |
| 187 :echo get(mylist, idx, "NONE") | |
| 188 | |
| 189 | |
| 190 List concatenation ~ | |
| 191 | |
| 192 Two lists can be concatenated with the "+" operator: > | |
| 193 :let longlist = mylist + [5, 6] | |
| 119 | 194 :let mylist += [7, 8] |
| 85 | 195 |
| 196 To prepend or append an item turn the item into a list by putting [] around | |
| 197 it. To change a list in-place see |list-modification| below. | |
| 198 | |
| 199 | |
| 200 Sublist ~ | |
| 201 | |
| 55 | 202 A part of the List can be obtained by specifying the first and last index, |
| 203 separated by a colon in square brackets: > | |
| 85 | 204 :let shortlist = mylist[2:-1] " get List [3, "four"] |
| 55 | 205 |
| 206 Omitting the first index is similar to zero. Omitting the last index is | |
| 1156 | 207 similar to -1. > |
| 90 | 208 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"] |
| 209 :let shortlist = mylist[2:2] " List with one item: [3] | |
| 210 :let otherlist = mylist[:] " make a copy of the List | |
| 85 | 211 |
| 842 | 212 If the first index is beyond the last item of the List or the second item is |
| 213 before the first item, the result is an empty list. There is no error | |
| 214 message. | |
| 215 | |
| 216 If the second index is equal to or greater than the length of the list the | |
| 217 length minus one is used: > | |
| 829 | 218 :let mylist = [0, 1, 2, 3] |
| 219 :echo mylist[2:8] " result: [2, 3] | |
| 220 | |
| 270 | 221 NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for |
| 1621 | 222 using a single letter variable before the ":". Insert a space when needed: |
| 270 | 223 mylist[s : e]. |
| 224 | |
| 85 | 225 |
| 226 List identity ~ | |
| 99 | 227 *list-identity* |
| 85 | 228 When variable "aa" is a list and you assign it to another variable "bb", both |
| 229 variables refer to the same list. Thus changing the list "aa" will also | |
| 230 change "bb": > | |
| 231 :let aa = [1, 2, 3] | |
| 232 :let bb = aa | |
| 233 :call add(aa, 4) | |
| 234 :echo bb | |
| 114 | 235 < [1, 2, 3, 4] |
| 85 | 236 |
| 237 Making a copy of a list is done with the |copy()| function. Using [:] also | |
| 238 works, as explained above. This creates a shallow copy of the list: Changing | |
| 87 | 239 a list item in the list will also change the item in the copied list: > |
| 85 | 240 :let aa = [[1, 'a'], 2, 3] |
| 241 :let bb = copy(aa) | |
| 114 | 242 :call add(aa, 4) |
| 85 | 243 :let aa[0][1] = 'aaa' |
| 244 :echo aa | |
| 114 | 245 < [[1, aaa], 2, 3, 4] > |
| 85 | 246 :echo bb |
| 114 | 247 < [[1, aaa], 2, 3] |
| 85 | 248 |
| 87 | 249 To make a completely independent list use |deepcopy()|. This also makes a |
| 114 | 250 copy of the values in the list, recursively. Up to a hundred levels deep. |
| 85 | 251 |
| 252 The operator "is" can be used to check if two variables refer to the same | |
| 114 | 253 List. "isnot" does the opposite. In contrast "==" compares if two lists have |
| 87 | 254 the same value. > |
| 255 :let alist = [1, 2, 3] | |
| 256 :let blist = [1, 2, 3] | |
| 257 :echo alist is blist | |
| 114 | 258 < 0 > |
| 87 | 259 :echo alist == blist |
| 114 | 260 < 1 |
| 85 | 261 |
| 323 | 262 Note about comparing lists: Two lists are considered equal if they have the |
| 263 same length and all items compare equal, as with using "==". There is one | |
| 388 | 264 exception: When comparing a number with a string they are considered |
| 265 different. There is no automatic type conversion, as with using "==" on | |
| 266 variables. Example: > | |
| 267 echo 4 == "4" | |
| 323 | 268 < 1 > |
| 388 | 269 echo [4] == ["4"] |
| 323 | 270 < 0 |
| 271 | |
| 388 | 272 Thus comparing Lists is more strict than comparing numbers and strings. You |
| 1621 | 273 can compare simple values this way too by putting them in a list: > |
| 388 | 274 |
| 275 :let a = 5 | |
| 276 :let b = "5" | |
| 1621 | 277 :echo a == b |
| 388 | 278 < 1 > |
| 1621 | 279 :echo [a] == [b] |
| 388 | 280 < 0 |
| 323 | 281 |
| 85 | 282 |
| 283 List unpack ~ | |
| 284 | |
| 285 To unpack the items in a list to individual variables, put the variables in | |
| 286 square brackets, like list items: > | |
| 287 :let [var1, var2] = mylist | |
| 288 | |
| 289 When the number of variables does not match the number of items in the list | |
| 290 this produces an error. To handle any extra items from the list append ";" | |
| 291 and a variable name: > | |
| 292 :let [var1, var2; rest] = mylist | |
| 293 | |
| 294 This works like: > | |
| 295 :let var1 = mylist[0] | |
| 296 :let var2 = mylist[1] | |
| 95 | 297 :let rest = mylist[2:] |
| 85 | 298 |
| 299 Except that there is no error if there are only two items. "rest" will be an | |
| 300 empty list then. | |
| 301 | |
| 302 | |
| 303 List modification ~ | |
| 304 *list-modification* | |
| 87 | 305 To change a specific item of a list use |:let| this way: > |
| 85 | 306 :let list[4] = "four" |
| 307 :let listlist[0][3] = item | |
| 308 | |
| 87 | 309 To change part of a list you can specify the first and last item to be |
| 114 | 310 modified. The value must at least have the number of items in the range: > |
| 87 | 311 :let list[3:5] = [3, 4, 5] |
| 312 | |
| 85 | 313 Adding and removing items from a list is done with functions. Here are a few |
| 314 examples: > | |
| 315 :call insert(list, 'a') " prepend item 'a' | |
| 316 :call insert(list, 'a', 3) " insert item 'a' before list[3] | |
| 317 :call add(list, "new") " append String item | |
| 114 | 318 :call add(list, [1, 2]) " append a List as one new item |
| 85 | 319 :call extend(list, [1, 2]) " extend the list with two more items |
| 320 :let i = remove(list, 3) " remove item 3 | |
| 108 | 321 :unlet list[3] " idem |
| 85 | 322 :let l = remove(list, 3, -1) " remove items 3 to last item |
| 108 | 323 :unlet list[3 : ] " idem |
| 114 | 324 :call filter(list, 'v:val !~ "x"') " remove items with an 'x' |
| 325 | |
| 326 Changing the order of items in a list: > | |
| 87 | 327 :call sort(list) " sort a list alphabetically |
| 328 :call reverse(list) " reverse the order of items | |
| 329 | |
| 85 | 330 |
| 331 For loop ~ | |
| 332 | |
| 87 | 333 The |:for| loop executes commands for each item in a list. A variable is set |
| 334 to each item in the list in sequence. Example: > | |
| 114 | 335 :for item in mylist |
| 336 : call Doit(item) | |
| 85 | 337 :endfor |
| 338 | |
| 339 This works like: > | |
| 340 :let index = 0 | |
| 341 :while index < len(mylist) | |
| 114 | 342 : let item = mylist[index] |
| 343 : :call Doit(item) | |
| 85 | 344 : let index = index + 1 |
| 345 :endwhile | |
| 346 | |
| 347 Note that all items in the list should be of the same type, otherwise this | |
| 114 | 348 results in error |E706|. To avoid this |:unlet| the variable at the end of |
| 87 | 349 the loop. |
| 85 | 350 |
| 95 | 351 If all you want to do is modify each item in the list then the |map()| |
| 114 | 352 function will be a simpler method than a for loop. |
| 95 | 353 |
| 1621 | 354 Just like the |:let| command, |:for| also accepts a list of variables. This |
| 85 | 355 requires the argument to be a list of lists. > |
| 356 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]] | |
| 357 : call Doit(lnum, col) | |
| 358 :endfor | |
| 359 | |
| 360 This works like a |:let| command is done for each list item. Again, the types | |
| 361 must remain the same to avoid an error. | |
| 362 | |
| 114 | 363 It is also possible to put remaining items in a List variable: > |
| 85 | 364 :for [i, j; rest] in listlist |
| 365 : call Doit(i, j) | |
| 366 : if !empty(rest) | |
| 367 : echo "remainder: " . string(rest) | |
| 368 : endif | |
| 369 :endfor | |
| 370 | |
| 371 | |
| 372 List functions ~ | |
| 114 | 373 *E714* |
| 85 | 374 Functions that are useful with a List: > |
| 87 | 375 :let r = call(funcname, list) " call a function with an argument list |
| 85 | 376 :if empty(list) " check if list is empty |
| 102 | 377 :let l = len(list) " number of items in list |
| 378 :let big = max(list) " maximum value in list | |
| 379 :let small = min(list) " minimum value in list | |
| 87 | 380 :let xs = count(list, 'x') " count nr of times 'x' appears in list |
| 381 :let i = index(list, 'x') " index of first 'x' in list | |
| 85 | 382 :let lines = getline(1, 10) " get ten text lines from buffer |
| 383 :call append('$', lines) " append text lines in buffer | |
| 95 | 384 :let list = split("a b c") " create list from items in a string |
| 385 :let string = join(list, ', ') " create string from list items | |
| 102 | 386 :let s = string(list) " String representation of list |
| 387 :call map(list, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 388 |
| 258 | 389 Don't forget that a combination of features can make things simple. For |
| 390 example, to add up all the numbers in a list: > | |
| 391 :exe 'let sum = ' . join(nrlist, '+') | |
| 392 | |
| 99 | 393 |
| 394 1.4 Dictionaries ~ | |
| 114 | 395 *Dictionaries* *Dictionary* |
| 99 | 396 A Dictionary is an associative array: Each entry has a key and a value. The |
| 114 | 397 entry can be located with the key. The entries are stored without a specific |
| 398 ordering. | |
| 99 | 399 |
| 400 | |
| 401 Dictionary creation ~ | |
| 114 | 402 *E720* *E721* *E722* *E723* |
| 99 | 403 A Dictionary is created with a comma separated list of entries in curly |
| 114 | 404 braces. Each entry has a key and a value, separated by a colon. Each key can |
| 405 only appear once. Examples: > | |
| 99 | 406 :let mydict = {1: 'one', 2: 'two', 3: 'three'} |
| 407 :let emptydict = {} | |
| 114 | 408 < *E713* *E716* *E717* |
| 99 | 409 A key is always a String. You can use a Number, it will be converted to a |
| 410 String automatically. Thus the String '4' and the number 4 will find the same | |
| 1621 | 411 entry. Note that the String '04' and the Number 04 are different, since the |
| 114 | 412 Number will be converted to the String '4'. |
| 413 | |
| 1621 | 414 A value can be any expression. Using a Dictionary for a value creates a |
| 99 | 415 nested Dictionary: > |
| 416 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}} | |
| 417 | |
| 418 An extra comma after the last entry is ignored. | |
| 419 | |
| 420 | |
| 421 Accessing entries ~ | |
| 422 | |
| 423 The normal way to access an entry is by putting the key in square brackets: > | |
| 424 :let val = mydict["one"] | |
| 425 :let mydict["four"] = 4 | |
| 426 | |
| 114 | 427 You can add new entries to an existing Dictionary this way, unlike Lists. |
| 99 | 428 |
| 429 For keys that consist entirely of letters, digits and underscore the following | |
| 430 form can be used |expr-entry|: > | |
| 431 :let val = mydict.one | |
| 432 :let mydict.four = 4 | |
| 433 | |
| 434 Since an entry can be any type, also a List and a Dictionary, the indexing and | |
| 435 key lookup can be repeated: > | |
| 114 | 436 :echo dict.key[idx].key |
| 99 | 437 |
| 438 | |
| 439 Dictionary to List conversion ~ | |
| 440 | |
| 1621 | 441 You may want to loop over the entries in a dictionary. For this you need to |
| 99 | 442 turn the Dictionary into a List and pass it to |:for|. |
| 443 | |
| 444 Most often you want to loop over the keys, using the |keys()| function: > | |
| 445 :for key in keys(mydict) | |
| 446 : echo key . ': ' . mydict[key] | |
| 447 :endfor | |
| 448 | |
| 449 The List of keys is unsorted. You may want to sort them first: > | |
| 450 :for key in sort(keys(mydict)) | |
| 451 | |
| 452 To loop over the values use the |values()| function: > | |
| 453 :for v in values(mydict) | |
| 454 : echo "value: " . v | |
| 455 :endfor | |
| 456 | |
| 457 If you want both the key and the value use the |items()| function. It returns | |
| 1621 | 458 a List in which each item is a List with two items, the key and the value: > |
| 1156 | 459 :for [key, value] in items(mydict) |
| 460 : echo key . ': ' . value | |
| 99 | 461 :endfor |
| 462 | |
| 463 | |
| 464 Dictionary identity ~ | |
| 161 | 465 *dict-identity* |
| 99 | 466 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a |
| 467 Dictionary. Otherwise, assignment results in referring to the same | |
| 468 Dictionary: > | |
| 469 :let onedict = {'a': 1, 'b': 2} | |
| 470 :let adict = onedict | |
| 471 :let adict['a'] = 11 | |
| 472 :echo onedict['a'] | |
| 473 11 | |
| 474 | |
| 327 | 475 Two Dictionaries compare equal if all the key-value pairs compare equal. For |
| 476 more info see |list-identity|. | |
| 99 | 477 |
| 478 | |
| 479 Dictionary modification ~ | |
| 480 *dict-modification* | |
| 481 To change an already existing entry of a Dictionary, or to add a new entry, | |
| 482 use |:let| this way: > | |
| 483 :let dict[4] = "four" | |
| 484 :let dict['one'] = item | |
| 485 | |
| 108 | 486 Removing an entry from a Dictionary is done with |remove()| or |:unlet|. |
| 487 Three ways to remove the entry with key "aaa" from dict: > | |
| 488 :let i = remove(dict, 'aaa') | |
| 489 :unlet dict.aaa | |
| 490 :unlet dict['aaa'] | |
| 99 | 491 |
| 492 Merging a Dictionary with another is done with |extend()|: > | |
| 114 | 493 :call extend(adict, bdict) |
| 494 This extends adict with all entries from bdict. Duplicate keys cause entries | |
| 495 in adict to be overwritten. An optional third argument can change this. | |
| 119 | 496 Note that the order of entries in a Dictionary is irrelevant, thus don't |
| 497 expect ":echo adict" to show the items from bdict after the older entries in | |
| 498 adict. | |
| 99 | 499 |
| 500 Weeding out entries from a Dictionary can be done with |filter()|: > | |
| 1156 | 501 :call filter(dict, 'v:val =~ "x"') |
| 114 | 502 This removes all entries from "dict" with a value not matching 'x'. |
| 102 | 503 |
| 504 | |
| 505 Dictionary function ~ | |
| 114 | 506 *Dictionary-function* *self* *E725* |
| 102 | 507 When a function is defined with the "dict" attribute it can be used in a |
| 1621 | 508 special way with a dictionary. Example: > |
| 102 | 509 :function Mylen() dict |
| 114 | 510 : return len(self.data) |
| 102 | 511 :endfunction |
| 114 | 512 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")} |
| 513 :echo mydict.len() | |
| 102 | 514 |
| 515 This is like a method in object oriented programming. The entry in the | |
| 516 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary | |
| 517 the function was invoked from. | |
| 518 | |
| 114 | 519 It is also possible to add a function without the "dict" attribute as a |
| 520 Funcref to a Dictionary, but the "self" variable is not available then. | |
| 521 | |
| 819 | 522 *numbered-function* *anonymous-function* |
| 102 | 523 To avoid the extra name for the function it can be defined and directly |
| 524 assigned to a Dictionary in this way: > | |
| 114 | 525 :let mydict = {'data': [0, 1, 2, 3]} |
| 526 :function mydict.len() dict | |
| 527 : return len(self.data) | |
| 102 | 528 :endfunction |
| 114 | 529 :echo mydict.len() |
| 530 | |
| 531 The function will then get a number and the value of dict.len is a |Funcref| | |
| 1621 | 532 that references this function. The function can only be used through a |
| 114 | 533 |Funcref|. It will automatically be deleted when there is no |Funcref| |
| 534 remaining that refers to it. | |
| 535 | |
| 536 It is not necessary to use the "dict" attribute for a numbered function. | |
| 102 | 537 |
|
2488
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
538 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
|
539 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
|
540 :function {42} |
|
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
541 |
| 102 | 542 |
| 543 Functions for Dictionaries ~ | |
| 114 | 544 *E715* |
| 545 Functions that can be used with a Dictionary: > | |
| 102 | 546 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo" |
| 547 :if empty(dict) " TRUE if dict is empty | |
| 548 :let l = len(dict) " number of items in dict | |
| 549 :let big = max(dict) " maximum value in dict | |
| 550 :let small = min(dict) " minimum value in dict | |
| 551 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict | |
| 552 :let s = string(dict) " String representation of dict | |
| 553 :call map(dict, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 554 |
| 555 | |
| 556 1.5 More about variables ~ | |
| 85 | 557 *more-variables* |
| 7 | 558 If you need to know the type of a variable or expression, use the |type()| |
| 559 function. | |
| 560 | |
| 561 When the '!' flag is included in the 'viminfo' option, global variables that | |
| 562 start with an uppercase letter, and don't contain a lowercase letter, are | |
| 563 stored in the viminfo file |viminfo-file|. | |
| 564 | |
| 565 When the 'sessionoptions' option contains "global", global variables that | |
| 566 start with an uppercase letter and contain at least one lowercase letter are | |
| 567 stored in the session file |session-file|. | |
| 568 | |
| 569 variable name can be stored where ~ | |
| 570 my_var_6 not | |
| 571 My_Var_6 session file | |
| 572 MY_VAR_6 viminfo file | |
| 573 | |
| 574 | |
| 575 It's possible to form a variable name with curly braces, see | |
| 576 |curly-braces-names|. | |
| 577 | |
| 578 ============================================================================== | |
| 579 2. Expression syntax *expression-syntax* | |
| 580 | |
| 581 Expression syntax summary, from least to most significant: | |
| 582 | |
| 583 |expr1| expr2 ? expr1 : expr1 if-then-else | |
| 584 | |
| 585 |expr2| expr3 || expr3 .. logical OR | |
| 586 | |
| 587 |expr3| expr4 && expr4 .. logical AND | |
| 588 | |
| 589 |expr4| expr5 == expr5 equal | |
| 590 expr5 != expr5 not equal | |
| 591 expr5 > expr5 greater than | |
| 592 expr5 >= expr5 greater than or equal | |
| 593 expr5 < expr5 smaller than | |
| 594 expr5 <= expr5 smaller than or equal | |
| 595 expr5 =~ expr5 regexp matches | |
| 596 expr5 !~ expr5 regexp doesn't match | |
| 597 | |
| 598 expr5 ==? expr5 equal, ignoring case | |
| 599 expr5 ==# expr5 equal, match case | |
| 600 etc. As above, append ? for ignoring case, # for | |
| 601 matching case | |
| 602 | |
| 685 | 603 expr5 is expr5 same |List| instance |
| 604 expr5 isnot expr5 different |List| instance | |
| 79 | 605 |
| 606 |expr5| expr6 + expr6 .. number addition or list concatenation | |
| 7 | 607 expr6 - expr6 .. number subtraction |
| 608 expr6 . expr6 .. string concatenation | |
| 609 | |
| 610 |expr6| expr7 * expr7 .. number multiplication | |
| 611 expr7 / expr7 .. number division | |
| 612 expr7 % expr7 .. number modulo | |
| 613 | |
| 614 |expr7| ! expr7 logical NOT | |
| 615 - expr7 unary minus | |
| 616 + expr7 unary plus | |
| 102 | 617 |
| 618 | |
| 685 | 619 |expr8| expr8[expr1] byte of a String or item of a |List| |
| 620 expr8[expr1 : expr1] substring of a String or sublist of a |List| | |
| 621 expr8.name entry in a |Dictionary| | |
| 622 expr8(expr1, ...) function call with |Funcref| variable | |
| 102 | 623 |
| 624 |expr9| number number constant | |
| 26 | 625 "string" string constant, backslash is special |
| 99 | 626 'string' string constant, ' is doubled |
| 685 | 627 [expr1, ...] |List| |
| 628 {expr1: expr1, ...} |Dictionary| | |
| 7 | 629 &option option value |
| 630 (expr1) nested expression | |
| 631 variable internal variable | |
| 632 va{ria}ble internal variable with curly braces | |
| 633 $VAR environment variable | |
| 634 @r contents of register 'r' | |
| 635 function(expr1, ...) function call | |
| 636 func{ti}on(expr1, ...) function call with curly braces | |
| 637 | |
| 638 | |
| 639 ".." indicates that the operations in this level can be concatenated. | |
| 640 Example: > | |
| 641 &nu || &list && &shell == "csh" | |
| 642 | |
| 643 All expressions within one level are parsed from left to right. | |
| 644 | |
| 645 | |
| 646 expr1 *expr1* *E109* | |
| 647 ----- | |
| 648 | |
| 649 expr2 ? expr1 : expr1 | |
| 650 | |
| 651 The expression before the '?' is evaluated to a number. If it evaluates to | |
| 652 non-zero, the result is the value of the expression between the '?' and ':', | |
| 653 otherwise the result is the value of the expression after the ':'. | |
| 654 Example: > | |
| 655 :echo lnum == 1 ? "top" : lnum | |
| 656 | |
| 657 Since the first expression is an "expr2", it cannot contain another ?:. The | |
| 658 other two expressions can, thus allow for recursive use of ?:. | |
| 659 Example: > | |
| 660 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum | |
| 661 | |
| 662 To keep this readable, using |line-continuation| is suggested: > | |
| 663 :echo lnum == 1 | |
| 664 :\ ? "top" | |
| 665 :\ : lnum == 1000 | |
| 666 :\ ? "last" | |
| 667 :\ : lnum | |
| 668 | |
| 1156 | 669 You should always put a space before the ':', otherwise it can be mistaken for |
| 670 use in a variable such as "a:1". | |
| 671 | |
| 7 | 672 |
| 673 expr2 and expr3 *expr2* *expr3* | |
| 674 --------------- | |
| 675 | |
| 676 *expr-barbar* *expr-&&* | |
| 677 The "||" and "&&" operators take one argument on each side. The arguments | |
| 678 are (converted to) Numbers. The result is: | |
| 679 | |
| 680 input output ~ | |
| 681 n1 n2 n1 || n2 n1 && n2 ~ | |
| 682 zero zero zero zero | |
| 683 zero non-zero non-zero zero | |
| 684 non-zero zero non-zero zero | |
| 685 non-zero non-zero non-zero non-zero | |
| 686 | |
| 687 The operators can be concatenated, for example: > | |
| 688 | |
| 689 &nu || &list && &shell == "csh" | |
| 690 | |
| 691 Note that "&&" takes precedence over "||", so this has the meaning of: > | |
| 692 | |
| 693 &nu || (&list && &shell == "csh") | |
| 694 | |
| 695 Once the result is known, the expression "short-circuits", that is, further | |
| 696 arguments are not evaluated. This is like what happens in C. For example: > | |
| 697 | |
| 698 let a = 1 | |
| 699 echo a || b | |
| 700 | |
| 701 This is valid even if there is no variable called "b" because "a" is non-zero, | |
| 702 so the result must be non-zero. Similarly below: > | |
| 703 | |
| 704 echo exists("b") && b == "yes" | |
| 705 | |
| 706 This is valid whether "b" has been defined or not. The second clause will | |
| 707 only be evaluated if "b" has been defined. | |
| 708 | |
| 709 | |
| 710 expr4 *expr4* | |
| 711 ----- | |
| 712 | |
| 713 expr5 {cmp} expr5 | |
| 714 | |
| 715 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1 | |
| 716 if it evaluates to true. | |
| 717 | |
| 1621 | 718 *expr-==* *expr-!=* *expr->* *expr->=* |
| 7 | 719 *expr-<* *expr-<=* *expr-=~* *expr-!~* |
| 720 *expr-==#* *expr-!=#* *expr->#* *expr->=#* | |
| 721 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#* | |
| 722 *expr-==?* *expr-!=?* *expr->?* *expr->=?* | |
| 723 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?* | |
| 79 | 724 *expr-is* |
| 7 | 725 use 'ignorecase' match case ignore case ~ |
| 726 equal == ==# ==? | |
| 727 not equal != !=# !=? | |
| 728 greater than > ># >? | |
| 729 greater than or equal >= >=# >=? | |
| 730 smaller than < <# <? | |
| 731 smaller than or equal <= <=# <=? | |
| 732 regexp matches =~ =~# =~? | |
| 733 regexp doesn't match !~ !~# !~? | |
| 79 | 734 same instance is |
| 735 different instance isnot | |
| 7 | 736 |
| 737 Examples: | |
| 738 "abc" ==# "Abc" evaluates to 0 | |
| 739 "abc" ==? "Abc" evaluates to 1 | |
| 740 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise | |
| 741 | |
| 85 | 742 *E691* *E692* |
| 685 | 743 A |List| can only be compared with a |List| and only "equal", "not equal" and |
| 744 "is" can be used. This compares the values of the list, recursively. | |
| 745 Ignoring case means case is ignored when comparing item values. | |
| 79 | 746 |
| 114 | 747 *E735* *E736* |
| 685 | 748 A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not |
| 749 equal" and "is" can be used. This compares the key/values of the |Dictionary| | |
| 114 | 750 recursively. Ignoring case means case is ignored when comparing item values. |
| 751 | |
| 85 | 752 *E693* *E694* |
| 685 | 753 A |Funcref| can only be compared with a |Funcref| and only "equal" and "not |
| 754 equal" can be used. Case is never ignored. | |
| 755 | |
| 756 When using "is" or "isnot" with a |List| this checks if the expressions are | |
| 1621 | 757 referring to the same |List| instance. A copy of a |List| is different from |
| 685 | 758 the original |List|. When using "is" without a |List| it is equivalent to |
| 759 using "equal", using "isnot" equivalent to using "not equal". Except that a | |
| 1621 | 760 different type means the values are different. "4 == '4'" is true, "4 is '4'" |
| 79 | 761 is false. |
| 762 | |
| 7 | 763 When comparing a String with a Number, the String is converted to a Number, |
| 1621 | 764 and the comparison is done on Numbers. This means that "0 == 'x'" is TRUE, |
| 7 | 765 because 'x' converted to a Number is zero. |
| 766 | |
| 767 When comparing two Strings, this is done with strcmp() or stricmp(). This | |
| 768 results in the mathematical difference (comparing byte values), not | |
| 769 necessarily the alphabetical difference in the local language. | |
| 770 | |
| 1621 | 771 When using the operators with a trailing '#', or the short version and |
| 1156 | 772 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
| 7 | 773 |
| 774 When using the operators with a trailing '?', or the short version and | |
| 1156 | 775 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
| 776 | |
| 777 'smartcase' is not used. | |
| 7 | 778 |
| 779 The "=~" and "!~" operators match the lefthand argument with the righthand | |
| 780 argument, which is used as a pattern. See |pattern| for what a pattern is. | |
| 781 This matching is always done like 'magic' was set and 'cpoptions' is empty, no | |
| 782 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts | |
| 783 portable. To avoid backslashes in the regexp pattern to be doubled, use a | |
| 784 single-quote string, see |literal-string|. | |
| 785 Since a string is considered to be a single line, a multi-line pattern | |
| 786 (containing \n, backslash-n) will not match. However, a literal NL character | |
| 787 can be matched like an ordinary character. Examples: | |
| 788 "foo\nbar" =~ "\n" evaluates to 1 | |
| 789 "foo\nbar" =~ "\\n" evaluates to 0 | |
| 790 | |
| 791 | |
| 792 expr5 and expr6 *expr5* *expr6* | |
| 793 --------------- | |
| 685 | 794 expr6 + expr6 .. Number addition or |List| concatenation *expr-+* |
| 79 | 795 expr6 - expr6 .. Number subtraction *expr--* |
| 796 expr6 . expr6 .. String concatenation *expr-.* | |
| 797 | |
| 692 | 798 For |Lists| only "+" is possible and then both expr6 must be a list. The |
| 685 | 799 result is a new list with the two lists Concatenated. |
| 79 | 800 |
| 801 expr7 * expr7 .. number multiplication *expr-star* | |
| 802 expr7 / expr7 .. number division *expr-/* | |
| 803 expr7 % expr7 .. number modulo *expr-%* | |
| 7 | 804 |
| 805 For all, except ".", Strings are converted to Numbers. | |
| 806 | |
| 807 Note the difference between "+" and ".": | |
| 808 "123" + "456" = 579 | |
| 809 "123" . "456" = "123456" | |
| 810 | |
| 1621 | 811 Since '.' has the same precedence as '+' and '-', you need to read: > |
| 812 1 . 90 + 90.0 | |
| 813 As: > | |
| 814 (1 . 90) + 90.0 | |
| 815 That works, since the String "190" is automatically converted to the Number | |
| 816 190, which can be added to the Float 90.0. However: > | |
| 817 1 . 90 * 90.0 | |
| 818 Should be read as: > | |
| 819 1 . (90 * 90.0) | |
| 820 Since '.' has lower precedence than '*'. This does NOT work, since this | |
| 821 attempts to concatenate a Float and a String. | |
| 822 | |
| 823 When dividing a Number by zero the result depends on the value: | |
| 824 0 / 0 = -0x80000000 (like NaN for Float) | |
| 825 >0 / 0 = 0x7fffffff (like positive infinity) | |
| 826 <0 / 0 = -0x7fffffff (like negative infinity) | |
| 827 (before Vim 7.2 it was always 0x7fffffff) | |
| 828 | |
| 7 | 829 When the righthand side of '%' is zero, the result is 0. |
| 830 | |
| 685 | 831 None of these work for |Funcref|s. |
| 79 | 832 |
| 1621 | 833 . and % do not work for Float. *E804* |
| 834 | |
| 7 | 835 |
| 836 expr7 *expr7* | |
| 837 ----- | |
| 838 ! expr7 logical NOT *expr-!* | |
| 839 - expr7 unary minus *expr-unary--* | |
| 840 + expr7 unary plus *expr-unary-+* | |
| 841 | |
| 842 For '!' non-zero becomes zero, zero becomes one. | |
| 843 For '-' the sign of the number is changed. | |
| 844 For '+' the number is unchanged. | |
| 845 | |
| 846 A String will be converted to a Number first. | |
| 847 | |
| 1621 | 848 These three can be repeated and mixed. Examples: |
| 7 | 849 !-1 == 0 |
| 850 !!8 == 1 | |
| 851 --9 == 9 | |
| 852 | |
| 853 | |
| 854 expr8 *expr8* | |
| 855 ----- | |
| 685 | 856 expr8[expr1] item of String or |List| *expr-[]* *E111* |
| 102 | 857 |
| 858 If expr8 is a Number or String this results in a String that contains the | |
| 859 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
|
860 Number. This doesn't recognize multi-byte encodings, see |byteidx()| for |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
861 an alternative. |
| 55 | 862 |
| 863 Index zero gives the first character. This is like it works in C. Careful: | |
| 864 text column numbers start with one! Example, to get the character under the | |
| 865 cursor: > | |
| 823 | 866 :let c = getline(".")[col(".") - 1] |
| 7 | 867 |
| 868 If the length of the String is less than the index, the result is an empty | |
| 55 | 869 String. A negative index always results in an empty string (reason: backwards |
| 870 compatibility). Use [-1:] to get the last byte. | |
| 871 | |
| 685 | 872 If expr8 is a |List| then it results the item at index expr1. See |list-index| |
| 55 | 873 for possible index values. If the index is out of range this results in an |
| 1621 | 874 error. Example: > |
| 55 | 875 :let item = mylist[-1] " get last item |
| 876 | |
| 685 | 877 Generally, if a |List| index is equal to or higher than the length of the |
| 878 |List|, or more negative than the length of the |List|, this results in an | |
| 879 error. | |
| 55 | 880 |
| 99 | 881 |
| 102 | 882 expr8[expr1a : expr1b] substring or sublist *expr-[:]* |
| 883 | |
| 884 If expr8 is a Number or String this results in the substring with the bytes | |
| 885 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
|
886 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
|
887 |byteidx()| for computing the indexes. |
| 55 | 888 |
| 889 If expr1a is omitted zero is used. If expr1b is omitted the length of the | |
| 890 string minus one is used. | |
| 891 | |
| 892 A negative number can be used to measure from the end of the string. -1 is | |
| 893 the last character, -2 the last but one, etc. | |
| 894 | |
| 895 If an index goes out of range for the string characters are omitted. If | |
| 896 expr1b is smaller than expr1a the result is an empty string. | |
| 897 | |
| 898 Examples: > | |
| 899 :let c = name[-1:] " last byte of a string | |
| 900 :let c = name[-2:-2] " last but one byte of a string | |
| 901 :let s = line(".")[4:] " from the fifth byte to the end | |
| 902 :let s = s[:-3] " remove last two bytes | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
903 < |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
904 *sublist* *slice* |
| 685 | 905 If expr8 is a |List| this results in a new |List| with the items indicated by |
| 1621 | 906 the indexes expr1a and expr1b. This works like with a String, as explained |
| 685 | 907 just above, except that indexes out of range cause an error. Examples: > |
| 55 | 908 :let l = mylist[:3] " first four items |
| 909 :let l = mylist[4:4] " List with one item | |
| 910 :let l = mylist[:] " shallow copy of a List | |
| 911 | |
| 685 | 912 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an |
| 913 error. | |
| 914 | |
| 915 | |
| 916 expr8.name entry in a |Dictionary| *expr-entry* | |
| 917 | |
| 918 If expr8 is a |Dictionary| and it is followed by a dot, then the following | |
| 919 name will be used as a key in the |Dictionary|. This is just like: | |
| 920 expr8[name]. | |
| 99 | 921 |
| 922 The name must consist of alphanumeric characters, just like a variable name, | |
| 923 but it may start with a number. Curly braces cannot be used. | |
| 924 | |
| 925 There must not be white space before or after the dot. | |
| 926 | |
| 927 Examples: > | |
| 928 :let dict = {"one": 1, 2: "two"} | |
| 929 :echo dict.one | |
| 930 :echo dict .2 | |
| 931 | |
| 932 Note that the dot is also used for String concatenation. To avoid confusion | |
| 933 always put spaces around the dot for String concatenation. | |
| 934 | |
| 935 | |
| 685 | 936 expr8(expr1, ...) |Funcref| function call |
| 102 | 937 |
| 938 When expr8 is a |Funcref| type variable, invoke the function it refers to. | |
| 939 | |
| 940 | |
| 941 | |
| 942 *expr9* | |
| 7 | 943 number |
| 944 ------ | |
| 945 number number constant *expr-number* | |
| 946 | |
| 947 Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0). | |
| 948 | |
| 1621 | 949 *floating-point-format* |
| 950 Floating point numbers can be written in two forms: | |
| 951 | |
| 952 [-+]{N}.{M} | |
| 953 [-+]{N}.{M}e[-+]{exp} | |
| 954 | |
| 955 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
| 956 contain digits. | |
| 957 [-+] means there is an optional plus or minus sign. | |
| 958 {exp} is the exponent, power of 10. | |
| 959 Only a decimal point is accepted, not a comma. No matter what the current | |
| 960 locale is. | |
| 961 {only when compiled with the |+float| feature} | |
| 962 | |
| 963 Examples: | |
| 964 123.456 | |
| 965 +0.0001 | |
| 966 55.0 | |
| 967 -0.123 | |
| 968 1.234e03 | |
| 969 1.0E-6 | |
| 970 -3.1416e+88 | |
| 971 | |
| 972 These are INVALID: | |
| 973 3. empty {M} | |
| 974 1e40 missing .{M} | |
| 975 | |
| 1698 | 976 *float-pi* *float-e* |
| 977 A few useful values to copy&paste: > | |
| 978 :let pi = 3.14159265359 | |
| 979 :let e = 2.71828182846 | |
| 980 | |
| 1621 | 981 Rationale: |
| 982 Before floating point was introduced, the text "123.456" was interpreted as | |
| 983 the two numbers "123" and "456", both converted to a string and concatenated, | |
| 984 resulting in the string "123456". Since this was considered pointless, and we | |
| 1698 | 985 could not find it intentionally being used in Vim scripts, this backwards |
| 1621 | 986 incompatibility was accepted in favor of being able to use the normal notation |
| 987 for floating point numbers. | |
| 988 | |
| 989 *floating-point-precision* | |
| 990 The precision and range of floating points numbers depends on what "double" | |
| 991 means in the library Vim was compiled with. There is no way to change this at | |
| 992 runtime. | |
| 993 | |
| 994 The default for displaying a |Float| is to use 6 decimal places, like using | |
| 995 printf("%g", f). You can select something else when using the |printf()| | |
| 996 function. Example: > | |
| 997 :echo printf('%.15e', atan(1)) | |
| 998 < 7.853981633974483e-01 | |
| 999 | |
| 1000 | |
| 7 | 1001 |
| 1002 string *expr-string* *E114* | |
| 1003 ------ | |
| 1004 "string" string constant *expr-quote* | |
| 1005 | |
| 1006 Note that double quotes are used. | |
| 1007 | |
| 1008 A string constant accepts these special characters: | |
| 1009 \... three-digit octal number (e.g., "\316") | |
| 1010 \.. two-digit octal number (must be followed by non-digit) | |
| 1011 \. one-digit octal number (must be followed by non-digit) | |
| 1012 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
| 1013 \x. byte specified with one hex number (must be followed by non-hex char) | |
| 1014 \X.. same as \x.. | |
| 1015 \X. same as \x. | |
| 1621 | 1016 \u.... character specified with up to 4 hex numbers, stored according to the |
| 7 | 1017 current value of 'encoding' (e.g., "\u02a4") |
| 1018 \U.... same as \u.... | |
| 1019 \b backspace <BS> | |
| 1020 \e escape <Esc> | |
| 1021 \f formfeed <FF> | |
| 1022 \n newline <NL> | |
| 1023 \r return <CR> | |
| 1024 \t tab <Tab> | |
| 1025 \\ backslash | |
| 1026 \" double quote | |
| 2152 | 1027 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use |
| 1028 in mappings, the 0x80 byte is escaped. Don't use <Char-xxxx> to get a | |
| 1029 utf-8 character, use \uxxxx as mentioned above. | |
| 7 | 1030 |
| 1156 | 1031 Note that "\xff" is stored as the byte 255, which may be invalid in some |
| 1032 encodings. Use "\u00ff" to store character 255 according to the current value | |
| 1033 of 'encoding'. | |
| 1034 | |
| 7 | 1035 Note that "\000" and "\x00" force the end of the string. |
| 1036 | |
| 1037 | |
| 1038 literal-string *literal-string* *E115* | |
| 1039 --------------- | |
| 26 | 1040 'string' string constant *expr-'* |
| 7 | 1041 |
| 1042 Note that single quotes are used. | |
| 1043 | |
| 1621 | 1044 This string is taken as it is. No backslashes are removed or have a special |
| 99 | 1045 meaning. The only exception is that two quotes stand for one quote. |
| 26 | 1046 |
| 1047 Single quoted strings are useful for patterns, so that backslashes do not need | |
| 1621 | 1048 to be doubled. These two commands are equivalent: > |
| 26 | 1049 if a =~ "\\s*" |
| 1050 if a =~ '\s*' | |
| 7 | 1051 |
| 1052 | |
| 1053 option *expr-option* *E112* *E113* | |
| 1054 ------ | |
| 1055 &option option value, local value if possible | |
| 1056 &g:option global option value | |
| 1057 &l:option local option value | |
| 1058 | |
| 1059 Examples: > | |
| 1060 echo "tabstop is " . &tabstop | |
| 1061 if &insertmode | |
| 1062 | |
| 1063 Any option name can be used here. See |options|. When using the local value | |
| 1064 and there is no buffer-local or window-local value, the global value is used | |
| 1065 anyway. | |
| 1066 | |
| 1067 | |
| 1156 | 1068 register *expr-register* *@r* |
| 7 | 1069 -------- |
| 1070 @r contents of register 'r' | |
| 1071 | |
| 1072 The result is the contents of the named register, as a single string. | |
| 1073 Newlines are inserted where required. To get the contents of the unnamed | |
| 1621 | 1074 register use @" or @@. See |registers| for an explanation of the available |
| 336 | 1075 registers. |
| 1076 | |
| 1077 When using the '=' register you get the expression itself, not what it | |
| 1078 evaluates to. Use |eval()| to evaluate it. | |
| 7 | 1079 |
| 1080 | |
| 1081 nesting *expr-nesting* *E110* | |
| 1082 ------- | |
| 1083 (expr1) nested expression | |
| 1084 | |
| 1085 | |
| 1086 environment variable *expr-env* | |
| 1087 -------------------- | |
| 1088 $VAR environment variable | |
| 1089 | |
| 1090 The String value of any environment variable. When it is not defined, the | |
| 1091 result is an empty string. | |
| 1092 *expr-env-expand* | |
| 1093 Note that there is a difference between using $VAR directly and using | |
| 1094 expand("$VAR"). Using it directly will only expand environment variables that | |
| 1095 are known inside the current Vim session. Using expand() will first try using | |
| 1096 the environment variables known inside the current Vim session. If that | |
| 1097 fails, a shell will be used to expand the variable. This can be slow, but it | |
| 1098 does expand all variables that the shell knows about. Example: > | |
| 1099 :echo $version | |
| 1100 :echo expand("$version") | |
| 1101 The first one probably doesn't echo anything, the second echoes the $version | |
| 1102 variable (if your shell supports it). | |
| 1103 | |
| 1104 | |
| 1105 internal variable *expr-variable* | |
| 1106 ----------------- | |
| 1107 variable internal variable | |
| 1108 See below |internal-variables|. | |
| 1109 | |
| 1110 | |
| 170 | 1111 function call *expr-function* *E116* *E118* *E119* *E120* |
| 7 | 1112 ------------- |
| 1113 function(expr1, ...) function call | |
| 1114 See below |functions|. | |
| 1115 | |
| 1116 | |
| 1117 ============================================================================== | |
| 2596 | 1118 3. Internal variable *internal-variables* *E461* |
| 1119 | |
| 7 | 1120 An internal variable name can be made up of letters, digits and '_'. But it |
| 1121 cannot start with a digit. It's also possible to use curly braces, see | |
| 1122 |curly-braces-names|. | |
| 1123 | |
| 1124 An internal variable is created with the ":let" command |:let|. | |
| 87 | 1125 An internal variable is explicitly destroyed with the ":unlet" command |
| 1126 |:unlet|. | |
| 1127 Using a name that is not an internal variable or refers to a variable that has | |
| 1128 been destroyed results in an error. | |
| 7 | 1129 |
| 1130 There are several name spaces for variables. Which one is to be used is | |
| 1131 specified by what is prepended: | |
| 1132 | |
| 1133 (nothing) In a function: local to a function; otherwise: global | |
| 1134 |buffer-variable| b: Local to the current buffer. | |
| 1135 |window-variable| w: Local to the current window. | |
| 819 | 1136 |tabpage-variable| t: Local to the current tab page. |
| 7 | 1137 |global-variable| g: Global. |
| 1138 |local-variable| l: Local to a function. | |
| 1139 |script-variable| s: Local to a |:source|'ed Vim script. | |
| 1140 |function-argument| a: Function argument (only inside a function). | |
| 1621 | 1141 |vim-variable| v: Global, predefined by Vim. |
| 7 | 1142 |
| 685 | 1143 The scope name by itself can be used as a |Dictionary|. For example, to |
| 1144 delete all script-local variables: > | |
| 133 | 1145 :for k in keys(s:) |
| 1146 : unlet s:[k] | |
| 1147 :endfor | |
| 1148 < | |
| 7 | 1149 *buffer-variable* *b:var* |
| 1150 A variable name that is preceded with "b:" is local to the current buffer. | |
| 1151 Thus you can have several "b:foo" variables, one for each buffer. | |
| 1152 This kind of variable is deleted when the buffer is wiped out or deleted with | |
| 1153 |:bdelete|. | |
| 1154 | |
| 1155 One local buffer variable is predefined: | |
| 1156 *b:changedtick-variable* *changetick* | |
| 1157 b:changedtick The total number of changes to the current buffer. It is | |
| 1158 incremented for each change. An undo command is also a change | |
| 1159 in this case. This can be used to perform an action only when | |
| 1160 the buffer has changed. Example: > | |
| 1161 :if my_changedtick != b:changedtick | |
| 1621 | 1162 : let my_changedtick = b:changedtick |
| 1163 : call My_Update() | |
| 7 | 1164 :endif |
| 1165 < | |
| 1166 *window-variable* *w:var* | |
| 1167 A variable name that is preceded with "w:" is local to the current window. It | |
| 1168 is deleted when the window is closed. | |
| 1169 | |
| 819 | 1170 *tabpage-variable* *t:var* |
| 1171 A variable name that is preceded with "t:" is local to the current tab page, | |
| 1172 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
|
1173 without the |+windows| feature} |
| 819 | 1174 |
| 7 | 1175 *global-variable* *g:var* |
| 1176 Inside functions global variables are accessed with "g:". Omitting this will | |
| 1621 | 1177 access a variable local to a function. But "g:" can also be used in any other |
| 7 | 1178 place if you like. |
| 1179 | |
| 1180 *local-variable* *l:var* | |
| 1181 Inside functions local variables are accessed without prepending anything. | |
| 1156 | 1182 But you can also prepend "l:" if you like. However, without prepending "l:" |
| 1183 you may run into reserved variable names. For example "count". By itself it | |
| 1184 refers to "v:count". Using "l:count" you can have a local variable with the | |
| 1185 same name. | |
| 7 | 1186 |
| 1187 *script-variable* *s:var* | |
| 1188 In a Vim script variables starting with "s:" can be used. They cannot be | |
| 1189 accessed from outside of the scripts, thus are local to the script. | |
| 1190 | |
| 1191 They can be used in: | |
| 1192 - commands executed while the script is sourced | |
| 1193 - functions defined in the script | |
| 1194 - autocommands defined in the script | |
| 1195 - functions and autocommands defined in functions and autocommands which were | |
| 1196 defined in the script (recursively) | |
| 1197 - user defined commands defined in the script | |
| 1198 Thus not in: | |
| 1199 - other scripts sourced from this one | |
| 1200 - mappings | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1201 - menus |
| 7 | 1202 - etc. |
| 1203 | |
| 1156 | 1204 Script variables can be used to avoid conflicts with global variable names. |
| 1205 Take this example: > | |
| 7 | 1206 |
| 1207 let s:counter = 0 | |
| 1208 function MyCounter() | |
| 1209 let s:counter = s:counter + 1 | |
| 1210 echo s:counter | |
| 1211 endfunction | |
| 1212 command Tick call MyCounter() | |
| 1213 | |
| 1214 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
| 1215 that script will not be changed, only the "s:counter" in the script where | |
| 1216 "Tick" was defined is used. | |
| 1217 | |
| 1218 Another example that does the same: > | |
| 1219 | |
| 1220 let s:counter = 0 | |
| 1221 command Tick let s:counter = s:counter + 1 | echo s:counter | |
| 1222 | |
| 1223 When calling a function and invoking a user-defined command, the context for | |
| 9 | 1224 script variables is set to the script where the function or command was |
| 7 | 1225 defined. |
| 1226 | |
| 1227 The script variables are also available when a function is defined inside a | |
| 1228 function that is defined in a script. Example: > | |
| 1229 | |
| 1230 let s:counter = 0 | |
| 1231 function StartCounting(incr) | |
| 1232 if a:incr | |
| 1233 function MyCounter() | |
| 1234 let s:counter = s:counter + 1 | |
| 1235 endfunction | |
| 1236 else | |
| 1237 function MyCounter() | |
| 1238 let s:counter = s:counter - 1 | |
| 1239 endfunction | |
| 1240 endif | |
| 1241 endfunction | |
| 1242 | |
| 1243 This defines the MyCounter() function either for counting up or counting down | |
| 1244 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
| 1245 called, the s:counter variable will be accessible in MyCounter(). | |
| 1246 | |
| 1247 When the same script is sourced again it will use the same script variables. | |
| 1248 They will remain valid as long as Vim is running. This can be used to | |
| 1249 maintain a counter: > | |
| 1250 | |
| 1251 if !exists("s:counter") | |
| 1252 let s:counter = 1 | |
| 1253 echo "script executed for the first time" | |
| 1254 else | |
| 1255 let s:counter = s:counter + 1 | |
| 1256 echo "script executed " . s:counter . " times now" | |
| 1257 endif | |
| 1258 | |
| 1259 Note that this means that filetype plugins don't get a different set of script | |
| 1260 variables for each buffer. Use local buffer variables instead |b:var|. | |
| 1261 | |
| 1262 | |
| 1263 Predefined Vim variables: *vim-variable* *v:var* | |
| 1264 | |
| 189 | 1265 *v:beval_col* *beval_col-variable* |
| 1266 v:beval_col The number of the column, over which the mouse pointer is. | |
| 1267 This is the byte index in the |v:beval_lnum| line. | |
| 1268 Only valid while evaluating the 'balloonexpr' option. | |
| 1269 | |
| 1270 *v:beval_bufnr* *beval_bufnr-variable* | |
| 1271 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
| 1272 valid while evaluating the 'balloonexpr' option. | |
| 1273 | |
| 1274 *v:beval_lnum* *beval_lnum-variable* | |
| 1275 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
| 1276 valid while evaluating the 'balloonexpr' option. | |
| 1277 | |
| 1278 *v:beval_text* *beval_text-variable* | |
| 374 | 1279 v:beval_text The text under or after the mouse pointer. Usually a word as |
| 1280 it is useful for debugging a C program. 'iskeyword' applies, | |
| 1281 but a dot and "->" before the position is included. When on a | |
| 1282 ']' the text before it is used, including the matching '[' and | |
| 189 | 1283 word before it. When on a Visual area within one line the |
| 1284 highlighted text is used. | |
| 1285 Only valid while evaluating the 'balloonexpr' option. | |
| 1286 | |
| 1287 *v:beval_winnr* *beval_winnr-variable* | |
| 1288 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
| 1289 valid while evaluating the 'balloonexpr' option. | |
| 1290 | |
| 844 | 1291 *v:char* *char-variable* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1292 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
|
1293 character when using <expr> in an abbreviation |:map-<expr>|. |
| 844 | 1294 |
| 7 | 1295 *v:charconvert_from* *charconvert_from-variable* |
| 1296 v:charconvert_from | |
| 1297 The name of the character encoding of a file to be converted. | |
| 1298 Only valid while evaluating the 'charconvert' option. | |
| 1299 | |
| 1300 *v:charconvert_to* *charconvert_to-variable* | |
| 1301 v:charconvert_to | |
| 1302 The name of the character encoding of a file after conversion. | |
| 1303 Only valid while evaluating the 'charconvert' option. | |
| 1304 | |
| 1305 *v:cmdarg* *cmdarg-variable* | |
| 1306 v:cmdarg This variable is used for two purposes: | |
| 1307 1. The extra arguments given to a file read/write command. | |
| 1308 Currently these are "++enc=" and "++ff=". This variable is | |
| 1309 set before an autocommand event for a file read/write | |
| 1310 command is triggered. There is a leading space to make it | |
| 1311 possible to append this variable directly after the | |
| 1621 | 1312 read/write command. Note: The "+cmd" argument isn't |
| 7 | 1313 included here, because it will be executed anyway. |
| 1314 2. When printing a PostScript file with ":hardcopy" this is | |
| 1315 the argument for the ":hardcopy" command. This can be used | |
| 1316 in 'printexpr'. | |
| 1317 | |
| 1318 *v:cmdbang* *cmdbang-variable* | |
| 1319 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
| 1320 was used the value is 1, otherwise it is 0. Note that this | |
| 1321 can only be used in autocommands. For user commands |<bang>| | |
| 1322 can be used. | |
| 1323 | |
| 1324 *v:count* *count-variable* | |
| 1325 v:count The count given for the last Normal mode command. Can be used | |
| 1621 | 1326 to get the count before a mapping. Read-only. Example: > |
| 7 | 1327 :map _x :<C-U>echo "the count is " . v:count<CR> |
| 1328 < Note: The <C-U> is required to remove the line range that you | |
| 1329 get when typing ':' after a count. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1330 When there are two counts, as in "3d2w", they are multiplied, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1331 just like what happens in the command, "d6w" for the example. |
| 667 | 1332 Also used for evaluating the 'formatexpr' option. |
| 7 | 1333 "count" also works, for backwards compatibility. |
| 1334 | |
| 1335 *v:count1* *count1-variable* | |
| 1336 v:count1 Just like "v:count", but defaults to one when no count is | |
| 1337 used. | |
| 1338 | |
| 1339 *v:ctype* *ctype-variable* | |
| 1340 v:ctype The current locale setting for characters of the runtime | |
| 1341 environment. This allows Vim scripts to be aware of the | |
| 1342 current locale encoding. Technical: it's the value of | |
| 1343 LC_CTYPE. When not using a locale the value is "C". | |
| 1344 This variable can not be set directly, use the |:language| | |
| 1345 command. | |
| 1346 See |multi-lang|. | |
| 1347 | |
| 1348 *v:dying* *dying-variable* | |
| 1621 | 1349 v:dying Normally zero. When a deadly signal is caught it's set to |
| 7 | 1350 one. When multiple signals are caught the number increases. |
| 1351 Can be used in an autocommand to check if Vim didn't | |
| 1352 terminate normally. {only works on Unix} | |
| 1353 Example: > | |
| 1354 :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
|
1355 < 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
|
1356 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
|
1357 |
| 7 | 1358 *v:errmsg* *errmsg-variable* |
| 1359 v:errmsg Last given error message. It's allowed to set this variable. | |
| 1360 Example: > | |
| 1361 :let v:errmsg = "" | |
| 1362 :silent! next | |
| 1363 :if v:errmsg != "" | |
| 1364 : ... handle error | |
| 1365 < "errmsg" also works, for backwards compatibility. | |
| 1366 | |
| 1367 *v:exception* *exception-variable* | |
| 1368 v:exception The value of the exception most recently caught and not | |
| 1369 finished. See also |v:throwpoint| and |throw-variables|. | |
| 1370 Example: > | |
| 1371 :try | |
| 1372 : throw "oops" | |
| 1373 :catch /.*/ | |
| 1374 : echo "caught" v:exception | |
| 1375 :endtry | |
| 1376 < Output: "caught oops". | |
| 1377 | |
| 179 | 1378 *v:fcs_reason* *fcs_reason-variable* |
| 1379 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
| 1380 Can be used in an autocommand to decide what to do and/or what | |
| 1381 to set v:fcs_choice to. Possible values: | |
| 1382 deleted file no longer exists | |
| 1383 conflict file contents, mode or timestamp was | |
| 1384 changed and buffer is modified | |
| 1385 changed file contents has changed | |
| 1386 mode mode of file changed | |
| 1387 time only file timestamp changed | |
| 1388 | |
| 1389 *v:fcs_choice* *fcs_choice-variable* | |
| 1390 v:fcs_choice What should happen after a |FileChangedShell| event was | |
| 1391 triggered. Can be used in an autocommand to tell Vim what to | |
| 1392 do with the affected buffer: | |
| 1393 reload Reload the buffer (does not work if | |
| 1394 the file was deleted). | |
| 1395 ask Ask the user what to do, as if there | |
| 1396 was no autocommand. Except that when | |
| 1397 only the timestamp changed nothing | |
| 1398 will happen. | |
| 1399 <empty> Nothing, the autocommand should do | |
| 1400 everything that needs to be done. | |
| 1401 The default is empty. If another (invalid) value is used then | |
| 1402 Vim behaves like it is empty, there is no warning message. | |
| 1403 | |
| 7 | 1404 *v:fname_in* *fname_in-variable* |
| 579 | 1405 v:fname_in The name of the input file. Valid while evaluating: |
| 7 | 1406 option used for ~ |
| 1407 'charconvert' file to be converted | |
| 1408 'diffexpr' original file | |
| 1409 'patchexpr' original file | |
| 1410 'printexpr' file to be printed | |
| 593 | 1411 And set to the swap file name for |SwapExists|. |
| 7 | 1412 |
| 1413 *v:fname_out* *fname_out-variable* | |
| 1414 v:fname_out The name of the output file. Only valid while | |
| 1415 evaluating: | |
| 1416 option used for ~ | |
| 1417 'charconvert' resulting converted file (*) | |
| 1418 'diffexpr' output of diff | |
| 1419 'patchexpr' resulting patched file | |
| 1420 (*) When doing conversion for a write command (e.g., ":w | |
| 1621 | 1421 file") it will be equal to v:fname_in. When doing conversion |
| 7 | 1422 for a read command (e.g., ":e file") it will be a temporary |
| 1423 file and different from v:fname_in. | |
| 1424 | |
| 1425 *v:fname_new* *fname_new-variable* | |
| 1426 v:fname_new The name of the new version of the file. Only valid while | |
| 1427 evaluating 'diffexpr'. | |
| 1428 | |
| 1429 *v:fname_diff* *fname_diff-variable* | |
| 1430 v:fname_diff The name of the diff (patch) file. Only valid while | |
| 1431 evaluating 'patchexpr'. | |
| 1432 | |
| 1433 *v:folddashes* *folddashes-variable* | |
| 1434 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
| 1435 fold. | |
| 29 | 1436 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1437 |
| 1438 *v:foldlevel* *foldlevel-variable* | |
| 1439 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
| 29 | 1440 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1441 |
| 1442 *v:foldend* *foldend-variable* | |
| 1443 v:foldend Used for 'foldtext': last line of closed fold. | |
| 29 | 1444 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1445 |
| 1446 *v:foldstart* *foldstart-variable* | |
| 1447 v:foldstart Used for 'foldtext': first line of closed fold. | |
| 29 | 1448 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1449 |
| 11 | 1450 *v:insertmode* *insertmode-variable* |
| 1451 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
| 1452 events. Values: | |
| 1453 i Insert mode | |
| 1454 r Replace mode | |
| 1455 v Virtual Replace mode | |
| 1456 | |
| 102 | 1457 *v:key* *key-variable* |
| 685 | 1458 v:key Key of the current item of a |Dictionary|. Only valid while |
| 102 | 1459 evaluating the expression used with |map()| and |filter()|. |
| 1460 Read-only. | |
| 1461 | |
| 7 | 1462 *v:lang* *lang-variable* |
| 1463 v:lang The current locale setting for messages of the runtime | |
| 1464 environment. This allows Vim scripts to be aware of the | |
| 1465 current language. Technical: it's the value of LC_MESSAGES. | |
| 1466 The value is system dependent. | |
| 1467 This variable can not be set directly, use the |:language| | |
| 1468 command. | |
| 1469 It can be different from |v:ctype| when messages are desired | |
| 1470 in a different language than what is used for character | |
| 1471 encoding. See |multi-lang|. | |
| 1472 | |
| 1473 *v:lc_time* *lc_time-variable* | |
| 1474 v:lc_time The current locale setting for time messages of the runtime | |
| 1475 environment. This allows Vim scripts to be aware of the | |
| 1476 current language. Technical: it's the value of LC_TIME. | |
| 1477 This variable can not be set directly, use the |:language| | |
| 1478 command. See |multi-lang|. | |
| 1479 | |
| 1480 *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
|
1481 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
|
1482 '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
|
1483 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
|
1484 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
|
1485 |sandbox|. |
| 7 | 1486 |
| 1029 | 1487 *v:mouse_win* *mouse_win-variable* |
| 1488 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
| 1489 First window has number 1, like with |winnr()|. The value is | |
| 1490 zero when there was no mouse button click. | |
| 1491 | |
| 1492 *v:mouse_lnum* *mouse_lnum-variable* | |
| 1493 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
| 1494 This is the text line number, not the screen line number. The | |
| 1495 value is zero when there was no mouse button click. | |
| 1496 | |
| 1497 *v:mouse_col* *mouse_col-variable* | |
| 1498 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
| 1499 This is the screen column number, like with |virtcol()|. The | |
| 1500 value is zero when there was no mouse button click. | |
| 1501 | |
| 1733 | 1502 *v:oldfiles* *oldfiles-variable* |
| 1503 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
| 1504 startup. These are the files that Vim remembers marks for. | |
| 1505 The length of the List is limited by the ' argument of the | |
| 1506 'viminfo' option (default is 100). | |
| 1507 Also see |:oldfiles| and |c_#<|. | |
| 1508 The List can be modified, but this has no effect on what is | |
| 1509 stored in the |viminfo| file later. If you use values other | |
| 1510 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
|
1511 {only when compiled with the |+viminfo| feature} |
| 1733 | 1512 |
| 1490 | 1513 *v:operator* *operator-variable* |
| 1514 v:operator The last operator given in Normal mode. This is a single | |
| 1515 character except for commands starting with <g> or <z>, | |
| 1516 in which case it is two characters. Best used alongside | |
| 1517 |v:prevcount| and |v:register|. Useful if you want to cancel | |
| 1518 Operator-pending mode and then use the operator, e.g.: > | |
| 1519 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
| 1520 < The value remains set until another operator is entered, thus | |
| 1521 don't expect it to be empty. | |
| 1522 v:operator is not set for |:delete|, |:yank| or other Ex | |
| 1523 commands. | |
| 1524 Read-only. | |
| 1525 | |
| 7 | 1526 *v:prevcount* *prevcount-variable* |
| 1527 v:prevcount The count given for the last but one Normal mode command. | |
| 1528 This is the v:count value of the previous command. Useful if | |
| 1490 | 1529 you want to cancel Visual or Operator-pending mode and then |
| 1530 use the count, e.g.: > | |
| 7 | 1531 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
| 1532 < Read-only. | |
| 1533 | |
| 170 | 1534 *v:profiling* *profiling-variable* |
| 1621 | 1535 v:profiling Normally zero. Set to one after using ":profile start". |
| 170 | 1536 See |profiling|. |
| 1537 | |
| 7 | 1538 *v:progname* *progname-variable* |
| 1539 v:progname Contains the name (with path removed) with which Vim was | |
| 1540 invoked. Allows you to do special initialisations for "view", | |
| 1541 "evim" etc., or any other name you might symlink to Vim. | |
| 1542 Read-only. | |
| 1543 | |
| 1544 *v:register* *register-variable* | |
| 1545 v:register The name of the register supplied to the last normal mode | |
| 1546 command. Empty if none were supplied. |getreg()| |setreg()| | |
| 1547 | |
| 540 | 1548 *v:scrollstart* *scrollstart-variable* |
| 1549 v:scrollstart String describing the script or function that caused the | |
| 1550 screen to scroll up. It's only set when it is empty, thus the | |
| 1551 first reason is remembered. It is set to "Unknown" for a | |
| 1552 typed command. | |
| 1553 This can be used to find out why your script causes the | |
| 1554 hit-enter prompt. | |
| 1555 | |
| 7 | 1556 *v:servername* *servername-variable* |
| 1557 v:servername The resulting registered |x11-clientserver| name if any. | |
| 1558 Read-only. | |
| 1559 | |
| 1621 | 1560 |
| 1561 v:searchforward *v:searchforward* *searchforward-variable* | |
| 1562 Search direction: 1 after a forward search, 0 after a | |
| 1563 backward search. It is reset to forward when directly setting | |
| 1564 the last search pattern, see |quote/|. | |
| 1565 Note that the value is restored when returning from a | |
| 1566 function. |function-search-undo|. | |
| 1567 Read-write. | |
| 1568 | |
| 7 | 1569 *v:shell_error* *shell_error-variable* |
| 1570 v:shell_error Result of the last shell command. When non-zero, the last | |
| 1571 shell command had an error. When zero, there was no problem. | |
| 1572 This only works when the shell returns the error code to Vim. | |
| 1573 The value -1 is often used when the command could not be | |
| 1574 executed. Read-only. | |
| 1575 Example: > | |
| 1576 :!mv foo bar | |
| 1577 :if v:shell_error | |
| 1578 : echo 'could not rename "foo" to "bar"!' | |
| 1579 :endif | |
| 1580 < "shell_error" also works, for backwards compatibility. | |
| 1581 | |
| 1582 *v:statusmsg* *statusmsg-variable* | |
| 1583 v:statusmsg Last given status message. It's allowed to set this variable. | |
| 1584 | |
| 579 | 1585 *v:swapname* *swapname-variable* |
| 1586 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
| 1587 the swap file found. Read-only. | |
| 1588 | |
| 1589 *v:swapchoice* *swapchoice-variable* | |
| 1590 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
| 1591 for handling an existing swap file: | |
| 1592 'o' Open read-only | |
| 1593 'e' Edit anyway | |
| 1594 'r' Recover | |
| 1595 'd' Delete swapfile | |
| 1596 'q' Quit | |
| 1597 'a' Abort | |
| 1621 | 1598 The value should be a single-character string. An empty value |
| 579 | 1599 results in the user being asked, as would happen when there is |
| 1600 no SwapExists autocommand. The default is empty. | |
| 1601 | |
| 590 | 1602 *v:swapcommand* *swapcommand-variable* |
| 625 | 1603 v:swapcommand Normal mode command to be executed after a file has been |
| 590 | 1604 opened. Can be used for a |SwapExists| autocommand to have |
| 1621 | 1605 another Vim open the file and jump to the right place. For |
| 590 | 1606 example, when jumping to a tag the value is ":tag tagname\r". |
| 716 | 1607 For ":edit +cmd file" the value is ":cmd\r". |
| 590 | 1608 |
| 7 | 1609 *v:termresponse* *termresponse-variable* |
| 1610 v:termresponse The escape sequence returned by the terminal for the |t_RV| | |
| 1621 | 1611 termcap entry. It is set when Vim receives an escape sequence |
| 7 | 1612 that starts with ESC [ or CSI and ends in a 'c', with only |
| 1613 digits, ';' and '.' in between. | |
| 1614 When this option is set, the TermResponse autocommand event is | |
| 1615 fired, so that you can react to the response from the | |
| 1616 terminal. | |
| 1617 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp | |
| 1618 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the | |
| 1619 patch level (since this was introduced in patch 95, it's | |
| 1620 always 95 or bigger). Pc is always zero. | |
| 1621 {only when compiled with |+termresponse| feature} | |
| 1622 | |
| 1623 *v:this_session* *this_session-variable* | |
| 1624 v:this_session Full filename of the last loaded or saved session file. See | |
| 1625 |:mksession|. It is allowed to set this variable. When no | |
| 1626 session file has been saved, this variable is empty. | |
| 1627 "this_session" also works, for backwards compatibility. | |
| 1628 | |
| 1629 *v:throwpoint* *throwpoint-variable* | |
| 1630 v:throwpoint The point where the exception most recently caught and not | |
| 1621 | 1631 finished was thrown. Not set when commands are typed. See |
| 7 | 1632 also |v:exception| and |throw-variables|. |
| 1633 Example: > | |
| 1634 :try | |
| 1635 : throw "oops" | |
| 1636 :catch /.*/ | |
| 1637 : echo "Exception from" v:throwpoint | |
| 1638 :endtry | |
| 1639 < Output: "Exception from test.vim, line 2" | |
| 1640 | |
| 102 | 1641 *v:val* *val-variable* |
| 1621 | 1642 v:val Value of the current item of a |List| or |Dictionary|. Only |
| 685 | 1643 valid while evaluating the expression used with |map()| and |
| 102 | 1644 |filter()|. Read-only. |
| 1645 | |
| 7 | 1646 *v:version* *version-variable* |
| 1647 v:version Version number of Vim: Major version number times 100 plus | |
| 1648 minor version number. Version 5.0 is 500. Version 5.1 (5.01) | |
| 1649 is 501. Read-only. "version" also works, for backwards | |
| 1650 compatibility. | |
| 1651 Use |has()| to check if a certain patch was included, e.g.: > | |
| 1652 if has("patch123") | |
| 1653 < Note that patch numbers are specific to the version, thus both | |
| 1654 version 5.0 and 5.1 may have a patch 123, but these are | |
| 1655 completely different. | |
| 1656 | |
| 1657 *v:warningmsg* *warningmsg-variable* | |
| 1658 v:warningmsg Last given warning message. It's allowed to set this variable. | |
| 1659 | |
| 2609 | 1660 *v:windowid* *windowid-variable* |
| 1661 v:windowid When any X11 based GUI is running or when running in a | |
| 1662 terminal and Vim connects to the X server (|-X|) this will be | |
| 2616 | 1663 set to the window ID. |
| 1664 When an MS-Windows GUI is running this will be set to the | |
| 1665 window handle. | |
| 1666 Otherwise the value is zero. | |
| 1667 Note: for windows inside Vim use |winnr()|. | |
| 2609 | 1668 |
| 7 | 1669 ============================================================================== |
| 1670 4. Builtin Functions *functions* | |
| 1671 | |
| 1672 See |function-list| for a list grouped by what the function is used for. | |
| 1673 | |
| 236 | 1674 (Use CTRL-] on the function name to jump to the full explanation.) |
| 7 | 1675 |
| 1676 USAGE RESULT DESCRIPTION ~ | |
| 1677 | |
| 1621 | 1678 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
|
1679 acos( {expr}) Float arc cosine of {expr} |
| 685 | 1680 add( {list}, {item}) List append {item} to |List| {list} |
| 55 | 1681 append( {lnum}, {string}) Number append {string} below line {lnum} |
| 161 | 1682 append( {lnum}, {list}) Number append lines {list} below line {lnum} |
| 7 | 1683 argc() Number number of files in the argument list |
| 55 | 1684 argidx() Number current index in the argument list |
| 7 | 1685 argv( {nr}) String {nr} entry of the argument list |
| 818 | 1686 argv( ) List the argument list |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1687 asin( {expr}) Float arc sine of {expr} |
| 1621 | 1688 atan( {expr}) Float arc tangent of {expr} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1689 atan2( {expr}, {expr}) Float arc tangent of {expr1} / {expr2} |
| 7 | 1690 browse( {save}, {title}, {initdir}, {default}) |
| 1691 String put up a file requester | |
| 1621 | 1692 browsedir( {title}, {initdir}) String put up a directory requester |
| 7 | 1693 bufexists( {expr}) Number TRUE if buffer {expr} exists |
| 55 | 1694 buflisted( {expr}) Number TRUE if buffer {expr} is listed |
| 1695 bufloaded( {expr}) Number TRUE if buffer {expr} is loaded | |
| 7 | 1696 bufname( {expr}) String Name of the buffer {expr} |
| 1697 bufnr( {expr}) Number Number of the buffer {expr} | |
| 1698 bufwinnr( {expr}) Number window number of buffer {expr} | |
| 1699 byte2line( {byte}) Number line number at byte count {byte} | |
| 55 | 1700 byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr} |
| 102 | 1701 call( {func}, {arglist} [, {dict}]) |
| 1702 any call {func} with arguments {arglist} | |
| 1621 | 1703 ceil( {expr}) Float round {expr} up |
| 1704 changenr() Number current change number | |
| 7 | 1705 char2nr( {expr}) Number ASCII value of first char in {expr} |
| 55 | 1706 cindent( {lnum}) Number C indent for line {lnum} |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1707 clearmatches() none clear all matches |
| 7 | 1708 col( {expr}) Number column nr of cursor or mark |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1709 complete( {startcol}, {matches}) none set Insert mode completion |
| 464 | 1710 complete_add( {expr}) Number add completion match |
| 1621 | 1711 complete_check() Number check for key typed during completion |
| 7 | 1712 confirm( {msg} [, {choices} [, {default} [, {type}]]]) |
| 1713 Number number of choice picked by user | |
| 55 | 1714 copy( {expr}) any make a shallow copy of {expr} |
| 1621 | 1715 cos( {expr}) Float cosine of {expr} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1716 cosh( {expr}) Float hyperbolic cosine of {expr} |
| 95 | 1717 count( {list}, {expr} [, {start} [, {ic}]]) |
| 1718 Number count how many {expr} are in {list} | |
| 7 | 1719 cscope_connection( [{num} , {dbpath} [, {prepend}]]) |
| 1720 Number checks existence of cscope connection | |
| 703 | 1721 cursor( {lnum}, {col} [, {coladd}]) |
| 1722 Number move cursor to {lnum}, {col}, {coladd} | |
| 1723 cursor( {list}) Number move cursor to position in {list} | |
| 55 | 1724 deepcopy( {expr}) any make a full copy of {expr} |
| 7 | 1725 delete( {fname}) Number delete file {fname} |
| 1726 did_filetype() Number TRUE if FileType autocommand event used | |
| 55 | 1727 diff_filler( {lnum}) Number diff filler lines about {lnum} |
| 1728 diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col} | |
| 85 | 1729 empty( {expr}) Number TRUE if {expr} is empty |
| 7 | 1730 escape( {string}, {chars}) String escape {chars} in {string} with '\' |
| 205 | 1731 eval( {string}) any evaluate {string} into its value |
| 55 | 1732 eventhandler( ) Number TRUE if inside an event handler |
| 7 | 1733 executable( {expr}) Number 1 if executable {expr} exists |
| 1734 exists( {expr}) Number TRUE if {expr} exists | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1735 extend( {expr1}, {expr2} [, {expr3}]) |
| 824 | 1736 List/Dict insert items of {expr2} into {expr1} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1737 exp( {expr}) Float exponential of {expr} |
| 1754 | 1738 expand( {expr} [, {flag}]) String expand special keywords in {expr} |
| 1621 | 1739 feedkeys( {string} [, {mode}]) Number add key sequence to typeahead buffer |
| 7 | 1740 filereadable( {file}) Number TRUE if {file} is a readable file |
| 824 | 1741 filewritable( {file}) Number TRUE if {file} is a writable file |
| 102 | 1742 filter( {expr}, {string}) List/Dict remove items from {expr} where |
| 1743 {string} is 0 | |
| 95 | 1744 finddir( {name}[, {path}[, {count}]]) |
| 824 | 1745 String find directory {name} in {path} |
| 19 | 1746 findfile( {name}[, {path}[, {count}]]) |
| 824 | 1747 String find file {name} in {path} |
| 1621 | 1748 float2nr( {expr}) Number convert Float {expr} to a Number |
| 1749 floor( {expr}) Float round {expr} down | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1750 fmod( {expr1}, {expr2}) Float remainder of {expr1} / {expr2} |
| 1586 | 1751 fnameescape( {fname}) String escape special characters in {fname} |
| 7 | 1752 fnamemodify( {fname}, {mods}) String modify file name |
| 55 | 1753 foldclosed( {lnum}) Number first line of fold at {lnum} if closed |
| 1754 foldclosedend( {lnum}) Number last line of fold at {lnum} if closed | |
| 7 | 1755 foldlevel( {lnum}) Number fold level at {lnum} |
| 55 | 1756 foldtext( ) String line displayed for closed fold |
| 824 | 1757 foldtextresult( {lnum}) String text for closed fold at {lnum} |
| 7 | 1758 foreground( ) Number bring the Vim window to the foreground |
| 55 | 1759 function( {name}) Funcref reference to function {name} |
| 1405 | 1760 garbagecollect( [at_exit]) none free memory, breaking cyclic references |
| 82 | 1761 get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def} |
| 102 | 1762 get( {dict}, {key} [, {def}]) any get item {key} from {dict} or {def} |
| 435 | 1763 getbufline( {expr}, {lnum} [, {end}]) |
| 1764 List lines {lnum} to {end} of buffer {expr} | |
| 824 | 1765 getbufvar( {expr}, {varname}) any variable {varname} in buffer {expr} |
| 55 | 1766 getchar( [expr]) Number get one character from the user |
| 1767 getcharmod( ) Number modifiers for the last typed character | |
| 7 | 1768 getcmdline() String return the current command-line |
| 1769 getcmdpos() Number return cursor position in command-line | |
| 531 | 1770 getcmdtype() String return the current command-line type |
| 7 | 1771 getcwd() String the current working directory |
| 20 | 1772 getfperm( {fname}) String file permissions of file {fname} |
| 1773 getfsize( {fname}) Number size in bytes of file {fname} | |
| 37 | 1774 getfontname( [{name}]) String name of font being used |
| 7 | 1775 getftime( {fname}) Number last modification time of file |
| 20 | 1776 getftype( {fname}) String description of type of file {fname} |
| 161 | 1777 getline( {lnum}) String line {lnum} of current buffer |
| 1778 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
|
1779 getloclist( {nr}) List list of location list items |
| 1326 | 1780 getmatches() List list of current matches |
| 1548 | 1781 getpid() Number process ID of Vim |
| 703 | 1782 getpos( {expr}) List position of cursor, mark, etc. |
| 230 | 1783 getqflist() List list of quickfix items |
| 282 | 1784 getreg( [{regname} [, 1]]) String contents of register |
| 55 | 1785 getregtype( [{regname}]) String type of register |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
1786 gettabvar( {nr}, {varname}) any variable {varname} in tab {nr} |
| 831 | 1787 gettabwinvar( {tabnr}, {winnr}, {name}) |
| 1788 any {name} in {winnr} in tab page {tabnr} | |
| 7 | 1789 getwinposx() Number X coord in pixels of GUI Vim window |
| 1790 getwinposy() Number Y coord in pixels of GUI Vim window | |
| 824 | 1791 getwinvar( {nr}, {varname}) any variable {varname} in window {nr} |
| 1754 | 1792 glob( {expr} [, {flag}]) String expand file wildcards in {expr} |
| 1793 globpath( {path}, {expr} [, {flag}]) | |
| 1794 String do glob({expr}) for all dirs in {path} | |
| 7 | 1795 has( {feature}) Number TRUE if feature {feature} supported |
| 102 | 1796 has_key( {dict}, {key}) Number TRUE if {dict} has entry {key} |
| 1104 | 1797 haslocaldir() Number TRUE if current window executed |:lcd| |
| 782 | 1798 hasmapto( {what} [, {mode} [, {abbr}]]) |
| 1799 Number TRUE if mapping to {what} exists | |
| 7 | 1800 histadd( {history},{item}) String add an item to a history |
| 1801 histdel( {history} [, {item}]) String remove an item from a history | |
| 1802 histget( {history} [, {index}]) String get the item {index} from a history | |
| 1803 histnr( {history}) Number highest index of a history | |
| 1804 hlexists( {name}) Number TRUE if highlight group {name} exists | |
| 1805 hlID( {name}) Number syntax ID of highlight group {name} | |
| 1806 hostname() String name of the machine Vim is running on | |
| 55 | 1807 iconv( {expr}, {from}, {to}) String convert encoding of {expr} |
| 1808 indent( {lnum}) Number indent of line {lnum} | |
| 95 | 1809 index( {list}, {expr} [, {start} [, {ic}]]) |
| 1810 Number index in {list} where {expr} appears | |
| 531 | 1811 input( {prompt} [, {text} [, {completion}]]) |
| 1812 String get input from the user | |
| 7 | 1813 inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog |
| 824 | 1814 inputlist( {textlist}) Number let the user pick from a choice list |
| 55 | 1815 inputrestore() Number restore typeahead |
| 1816 inputsave() Number save and clear typeahead | |
| 7 | 1817 inputsecret( {prompt} [, {text}]) String like input() but hiding the text |
| 55 | 1818 insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}] |
| 7 | 1819 isdirectory( {directory}) Number TRUE if {directory} is a directory |
| 148 | 1820 islocked( {expr}) Number TRUE if {expr} is locked |
| 685 | 1821 items( {dict}) List key-value pairs in {dict} |
| 95 | 1822 join( {list} [, {sep}]) String join {list} items into one String |
| 685 | 1823 keys( {dict}) List keys in {dict} |
| 55 | 1824 len( {expr}) Number the length of {expr} |
| 1825 libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg} | |
| 7 | 1826 libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number |
| 1827 line( {expr}) Number line nr of cursor, last line or mark | |
| 1828 line2byte( {lnum}) Number byte count of line {lnum} | |
| 55 | 1829 lispindent( {lnum}) Number Lisp indent for line {lnum} |
| 7 | 1830 localtime() Number current time |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1831 log( {expr}) Float natural logarithm (base e) of {expr} |
| 1621 | 1832 log10( {expr}) Float logarithm of Float {expr} to base 10 |
| 102 | 1833 map( {expr}, {string}) List/Dict change each item in {expr} to {expr} |
| 2610 | 1834 maparg( {name}[, {mode} [, {abbr} [, {dict}]]]) |
| 782 | 1835 String rhs of mapping {name} in mode {mode} |
| 1836 mapcheck( {name}[, {mode} [, {abbr}]]) | |
| 1837 String check for mappings matching {name} | |
| 19 | 1838 match( {expr}, {pat}[, {start}[, {count}]]) |
| 7 | 1839 Number position where {pat} matches in {expr} |
| 1326 | 1840 matchadd( {group}, {pattern}[, {priority}[, {id}]]) |
| 1841 Number highlight {pattern} with {group} | |
| 819 | 1842 matcharg( {nr}) List arguments of |:match| |
| 1326 | 1843 matchdelete( {id}) Number delete match identified by {id} |
| 19 | 1844 matchend( {expr}, {pat}[, {start}[, {count}]]) |
| 7 | 1845 Number position where {pat} ends in {expr} |
| 158 | 1846 matchlist( {expr}, {pat}[, {start}[, {count}]]) |
| 1847 List match and submatches of {pat} in {expr} | |
| 19 | 1848 matchstr( {expr}, {pat}[, {start}[, {count}]]) |
| 1849 String {count}'th match of {pat} in {expr} | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1850 max( {list}) Number maximum value of items in {list} |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1851 min( {list}) Number minimum value of items in {list} |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1852 mkdir( {name} [, {path} [, {prot}]]) |
| 168 | 1853 Number create directory {name} |
| 1621 | 1854 mode( [expr]) String current editing mode |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
1855 mzeval( {expr}) any evaluate |MzScheme| expression |
| 7 | 1856 nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum} |
| 1857 nr2char( {expr}) String single char with ASCII value {expr} | |
| 819 | 1858 pathshorten( {expr}) String shorten directory names in a path |
| 1621 | 1859 pow( {x}, {y}) Float {x} to the power of {y} |
| 7 | 1860 prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum} |
| 1621 | 1861 printf( {fmt}, {expr1}...) String format text |
| 1862 pumvisible() Number whether popup menu is visible | |
| 99 | 1863 range( {expr} [, {max} [, {stride}]]) |
| 1864 List items from {expr} to {max} | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1865 readfile( {fname} [, {binary} [, {max}]]) |
| 168 | 1866 List get list of lines from file {fname} |
| 794 | 1867 reltime( [{start} [, {end}]]) List get time value |
| 1868 reltimestr( {time}) String turn time value into a String | |
| 7 | 1869 remote_expr( {server}, {string} [, {idvar}]) |
| 1870 String send expression | |
| 1871 remote_foreground( {server}) Number bring Vim server to the foreground | |
| 1872 remote_peek( {serverid} [, {retvar}]) | |
| 1873 Number check for reply string | |
| 1874 remote_read( {serverid}) String read reply string | |
| 1875 remote_send( {server}, {string} [, {idvar}]) | |
| 1876 String send key sequence | |
| 79 | 1877 remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list} |
| 856 | 1878 remove( {dict}, {key}) any remove entry {key} from {dict} |
| 55 | 1879 rename( {from}, {to}) Number rename (move) file from {from} to {to} |
| 1880 repeat( {expr}, {count}) String repeat {expr} {count} times | |
| 1881 resolve( {filename}) String get filename a shortcut points to | |
| 82 | 1882 reverse( {list}) List reverse {list} in-place |
| 1621 | 1883 round( {expr}) Float round off {expr} |
| 1496 | 1884 search( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
| 1885 Number search for {pattern} | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1886 searchdecl( {name} [, {global} [, {thisblock}]]) |
| 1621 | 1887 Number search for variable declaration |
| 1496 | 1888 searchpair( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 55 | 1889 Number search for other end of start/end pair |
| 1496 | 1890 searchpairpos( {start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 667 | 1891 List search for other end of start/end pair |
| 1496 | 1892 searchpos( {pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
| 667 | 1893 List search for {pattern} |
| 7 | 1894 server2client( {clientid}, {string}) |
| 1895 Number send reply string | |
| 1896 serverlist() String get a list of available servers | |
| 1897 setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val} | |
| 1898 setcmdpos( {pos}) Number set cursor position in command-line | |
| 1899 setline( {lnum}, {line}) Number set line {lnum} to {line} | |
| 647 | 1900 setloclist( {nr}, {list}[, {action}]) |
| 1901 Number modify location list using {list} | |
| 1326 | 1902 setmatches( {list}) Number restore a list of matches |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1903 setpos( {expr}, {list}) Number set the {expr} position to {list} |
| 647 | 1904 setqflist( {list}[, {action}]) Number modify quickfix list using {list} |
| 55 | 1905 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
|
1906 settabvar( {nr}, {varname}, {val}) set {varname} in tab page {nr} to {val} |
| 831 | 1907 settabwinvar( {tabnr}, {winnr}, {varname}, {val}) set {varname} in window |
| 1908 {winnr} in tab page {tabnr} to {val} | |
| 7 | 1909 setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val} |
| 1661 | 1910 shellescape( {string} [, {special}]) |
| 1911 String escape {string} for use as shell | |
| 985 | 1912 command argument |
| 55 | 1913 simplify( {filename}) String simplify filename as much as possible |
| 1621 | 1914 sin( {expr}) Float sine of {expr} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1915 sinh( {expr}) Float hyperbolic sine of {expr} |
| 82 | 1916 sort( {list} [, {func}]) List sort {list}, using {func} to compare |
| 374 | 1917 soundfold( {word}) String sound-fold {word} |
| 344 | 1918 spellbadword() String badly spelled word at cursor |
| 537 | 1919 spellsuggest( {word} [, {max} [, {capital}]]) |
| 1920 List spelling suggestions | |
| 282 | 1921 split( {expr} [, {pat} [, {keepempty}]]) |
| 685 | 1922 List make |List| from {pat} separated {expr} |
| 1621 | 1923 sqrt( {expr} Float squar root of {expr} |
| 1924 str2float( {expr}) Float convert String to Float | |
| 1925 str2nr( {expr} [, {base}]) Number convert String to Number | |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1926 strchars( {expr}) Number character length of the String {expr} |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
1927 strdisplaywidth( {expr} [, {col}]) Number display length of the String {expr} |
| 7 | 1928 strftime( {format}[, {time}]) String time in specified format |
| 133 | 1929 stridx( {haystack}, {needle}[, {start}]) |
| 1930 Number index of {needle} in {haystack} | |
| 95 | 1931 string( {expr}) String String representation of {expr} value |
| 7 | 1932 strlen( {expr}) Number length of the String {expr} |
| 1933 strpart( {src}, {start}[, {len}]) | |
| 1934 String {len} characters of {src} at {start} | |
| 140 | 1935 strridx( {haystack}, {needle} [, {start}]) |
| 1936 Number last index of {needle} in {haystack} | |
| 7 | 1937 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
|
1938 strwidth( {expr}) Number display cell length of the String {expr} |
| 55 | 1939 submatch( {nr}) String specific match in ":substitute" |
| 7 | 1940 substitute( {expr}, {pat}, {sub}, {flags}) |
| 1941 String all {pat} in {expr} replaced with {sub} | |
| 32 | 1942 synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col} |
| 7 | 1943 synIDattr( {synID}, {what} [, {mode}]) |
| 1944 String attribute {what} of syntax ID {synID} | |
| 1945 synIDtrans( {synID}) Number translated syntax ID of {synID} | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
1946 synconcealed( {lnum}, {col}) List info about concealing |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1947 synstack( {lnum}, {col}) List stack of syntax IDs at {lnum} and {col} |
| 24 | 1948 system( {expr} [, {input}]) String output of shell command/filter {expr} |
| 677 | 1949 tabpagebuflist( [{arg}]) List list of buffer numbers in tab page |
| 1950 tabpagenr( [{arg}]) Number number of current or last tab page | |
| 1951 tabpagewinnr( {tabarg}[, {arg}]) | |
| 1952 Number number of current window in tab page | |
| 1953 taglist( {expr}) List list of tags matching {expr} | |
| 1621 | 1954 tagfiles() List tags files used |
| 7 | 1955 tempname() String name for a temporary file |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1956 tan( {expr}) Float tangent of {expr} |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1957 tanh( {expr}) Float hyperbolic tangent of {expr} |
| 7 | 1958 tolower( {expr}) String the String {expr} switched to lowercase |
| 1959 toupper( {expr}) String the String {expr} switched to uppercase | |
| 15 | 1960 tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
| 1961 to chars in {tostr} | |
| 1621 | 1962 trunc( {expr} Float truncate Float {expr} |
| 7 | 1963 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
|
1964 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
|
1965 undotree() List undo file tree |
| 685 | 1966 values( {dict}) List values in {dict} |
| 7 | 1967 virtcol( {expr}) Number screen column of cursor or mark |
| 1968 visualmode( [expr]) String last visual mode used | |
| 1969 winbufnr( {nr}) Number buffer number of window {nr} | |
| 1970 wincol() Number window column of the cursor | |
| 1971 winheight( {nr}) Number height of window {nr} | |
| 1972 winline() Number window line of the cursor | |
| 674 | 1973 winnr( [{expr}]) Number number of current window |
| 55 | 1974 winrestcmd() String returns command to restore window sizes |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1975 winrestview( {dict}) none restore view of current window |
| 712 | 1976 winsaveview() Dict save view of current window |
| 7 | 1977 winwidth( {nr}) Number width of window {nr} |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1978 writefile( {list}, {fname} [, {binary}]) |
| 158 | 1979 Number write list of lines to file {fname} |
| 7 | 1980 |
| 1621 | 1981 abs({expr}) *abs()* |
| 1982 Return the absolute value of {expr}. When {expr} evaluates to | |
| 1983 a |Float| abs() returns a |Float|. When {expr} can be | |
| 1984 converted to a |Number| abs() returns a |Number|. Otherwise | |
| 1985 abs() gives an error message and returns -1. | |
| 1986 Examples: > | |
| 1987 echo abs(1.456) | |
| 1988 < 1.456 > | |
| 1989 echo abs(-5.456) | |
| 1990 < 5.456 > | |
| 1991 echo abs(-4) | |
| 1992 < 4 | |
| 1993 {only available when compiled with the |+float| feature} | |
| 1994 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1995 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1996 acos({expr}) *acos()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1997 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
|
1998 |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
|
1999 {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
|
2000 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2001 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2002 :echo acos(0) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2003 < 1.570796 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2004 :echo acos(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2005 < 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
|
2006 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2007 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2008 |
| 82 | 2009 add({list}, {expr}) *add()* |
| 685 | 2010 Append the item {expr} to |List| {list}. Returns the |
| 2011 resulting |List|. Examples: > | |
| 82 | 2012 :let alist = add([1, 2, 3], item) |
| 2013 :call add(mylist, "woodstock") | |
| 685 | 2014 < Note that when {expr} is a |List| it is appended as a single |
| 692 | 2015 item. Use |extend()| to concatenate |Lists|. |
| 85 | 2016 Use |insert()| to add an item at another position. |
| 55 | 2017 |
| 82 | 2018 |
| 2019 append({lnum}, {expr}) *append()* | |
| 685 | 2020 When {expr} is a |List|: Append each item of the |List| as a |
| 2021 text line below line {lnum} in the current buffer. | |
| 153 | 2022 Otherwise append {expr} as one text line below line {lnum} in |
| 2023 the current buffer. | |
| 2024 {lnum} can be zero to insert a line before the first one. | |
| 82 | 2025 Returns 1 for failure ({lnum} out of range or out of memory), |
| 1621 | 2026 0 for success. Example: > |
| 55 | 2027 :let failed = append(line('$'), "# THE END") |
| 82 | 2028 :let failed = append(0, ["Chapter 1", "the beginning"]) |
| 55 | 2029 < |
| 7 | 2030 *argc()* |
| 2031 argc() The result is the number of files in the argument list of the | |
| 2032 current window. See |arglist|. | |
| 2033 | |
| 2034 *argidx()* | |
| 2035 argidx() The result is the current index in the argument list. 0 is | |
| 2036 the first file. argc() - 1 is the last one. See |arglist|. | |
| 2037 | |
| 2038 *argv()* | |
| 818 | 2039 argv([{nr}]) The result is the {nr}th file in the argument list of the |
| 7 | 2040 current window. See |arglist|. "argv(0)" is the first one. |
| 2041 Example: > | |
| 2042 :let i = 0 | |
| 2043 :while i < argc() | |
| 1621 | 2044 : let f = escape(fnameescape(argv(i)), '.') |
| 7 | 2045 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
| 2046 : let i = i + 1 | |
| 2047 :endwhile | |
| 818 | 2048 < Without the {nr} argument a |List| with the whole |arglist| is |
| 2049 returned. | |
| 2050 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2051 asin({expr}) *asin()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2052 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
|
2053 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
|
2054 {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
|
2055 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2056 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2057 :echo asin(0.8) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2058 < 0.927295 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2059 :echo asin(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2060 < -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
|
2061 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2062 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2063 |
| 1621 | 2064 atan({expr}) *atan()* |
| 2065 Return the principal value of the arc tangent of {expr}, in | |
| 2066 the range [-pi/2, +pi/2] radians, as a |Float|. | |
| 2067 {expr} must evaluate to a |Float| or a |Number|. | |
| 2068 Examples: > | |
| 2069 :echo atan(100) | |
| 2070 < 1.560797 > | |
| 2071 :echo atan(-4.01) | |
| 2072 < -1.326405 | |
| 2073 {only available when compiled with the |+float| feature} | |
| 2074 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2075 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2076 atan2({expr1}, {expr2}) *atan2()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2077 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
|
2078 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
|
2079 {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
|
2080 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2081 :echo atan2(-1, 1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2082 < -0.785398 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2083 :echo atan2(1, -1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2084 < 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
|
2085 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2086 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2087 |
| 7 | 2088 *browse()* |
| 2089 browse({save}, {title}, {initdir}, {default}) | |
| 2090 Put up a file requester. This only works when "has("browse")" | |
| 2091 returns non-zero (only in some GUI versions). | |
| 2092 The input fields are: | |
| 2093 {save} when non-zero, select file to write | |
| 2094 {title} title for the requester | |
| 2095 {initdir} directory to start browsing in | |
| 2096 {default} default file name | |
| 2097 When the "Cancel" button is hit, something went wrong, or | |
| 2098 browsing is not possible, an empty string is returned. | |
| 2099 | |
| 29 | 2100 *browsedir()* |
| 2101 browsedir({title}, {initdir}) | |
| 2102 Put up a directory requester. This only works when | |
| 2103 "has("browse")" returns non-zero (only in some GUI versions). | |
| 2104 On systems where a directory browser is not supported a file | |
| 2105 browser is used. In that case: select a file in the directory | |
| 2106 to be used. | |
| 2107 The input fields are: | |
| 2108 {title} title for the requester | |
| 2109 {initdir} directory to start browsing in | |
| 2110 When the "Cancel" button is hit, something went wrong, or | |
| 2111 browsing is not possible, an empty string is returned. | |
| 2112 | |
| 7 | 2113 bufexists({expr}) *bufexists()* |
| 2114 The result is a Number, which is non-zero if a buffer called | |
| 2115 {expr} exists. | |
| 9 | 2116 If the {expr} argument is a number, buffer numbers are used. |
| 7 | 2117 If the {expr} argument is a string it must match a buffer name |
| 9 | 2118 exactly. The name can be: |
| 2119 - Relative to the current directory. | |
| 2120 - A full path. | |
| 1621 | 2121 - The name of a buffer with 'buftype' set to "nofile". |
| 9 | 2122 - A URL name. |
| 7 | 2123 Unlisted buffers will be found. |
| 2124 Note that help files are listed by their short name in the | |
| 2125 output of |:buffers|, but bufexists() requires using their | |
| 2126 long name to be able to find them. | |
| 1621 | 2127 bufexists() may report a buffer exists, but to use the name |
| 2128 with a |:buffer| command you may need to use |expand()|. Esp | |
| 2129 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
| 7 | 2130 Use "bufexists(0)" to test for the existence of an alternate |
| 2131 file name. | |
| 2132 *buffer_exists()* | |
| 2133 Obsolete name: buffer_exists(). | |
| 2134 | |
| 2135 buflisted({expr}) *buflisted()* | |
| 2136 The result is a Number, which is non-zero if a buffer called | |
| 2137 {expr} exists and is listed (has the 'buflisted' option set). | |
| 9 | 2138 The {expr} argument is used like with |bufexists()|. |
| 7 | 2139 |
| 2140 bufloaded({expr}) *bufloaded()* | |
| 2141 The result is a Number, which is non-zero if a buffer called | |
| 2142 {expr} exists and is loaded (shown in a window or hidden). | |
| 9 | 2143 The {expr} argument is used like with |bufexists()|. |
| 7 | 2144 |
| 2145 bufname({expr}) *bufname()* | |
| 2146 The result is the name of a buffer, as it is displayed by the | |
| 2147 ":ls" command. | |
| 2148 If {expr} is a Number, that buffer number's name is given. | |
| 2149 Number zero is the alternate buffer for the current window. | |
| 2150 If {expr} is a String, it is used as a |file-pattern| to match | |
| 1621 | 2151 with the buffer names. This is always done like 'magic' is |
| 7 | 2152 set and 'cpoptions' is empty. When there is more than one |
| 2153 match an empty string is returned. | |
| 2154 "" or "%" can be used for the current buffer, "#" for the | |
| 2155 alternate buffer. | |
| 2156 A full match is preferred, otherwise a match at the start, end | |
| 1156 | 2157 or middle of the buffer name is accepted. If you only want a |
| 2158 full match then put "^" at the start and "$" at the end of the | |
| 2159 pattern. | |
| 7 | 2160 Listed buffers are found first. If there is a single match |
| 2161 with a listed buffer, that one is returned. Next unlisted | |
| 2162 buffers are searched for. | |
| 2163 If the {expr} is a String, but you want to use it as a buffer | |
| 2164 number, force it to be a Number by adding zero to it: > | |
| 2165 :echo bufname("3" + 0) | |
| 2166 < If the buffer doesn't exist, or doesn't have a name, an empty | |
| 2167 string is returned. > | |
| 2168 bufname("#") alternate buffer name | |
| 2169 bufname(3) name of buffer 3 | |
| 2170 bufname("%") name of current buffer | |
| 2171 bufname("file2") name of buffer where "file2" matches. | |
| 2172 < *buffer_name()* | |
| 2173 Obsolete name: buffer_name(). | |
| 2174 | |
| 2175 *bufnr()* | |
| 707 | 2176 bufnr({expr} [, {create}]) |
| 2177 The result is the number of a buffer, as it is displayed by | |
| 7 | 2178 the ":ls" command. For the use of {expr}, see |bufname()| |
| 707 | 2179 above. |
| 2180 If the buffer doesn't exist, -1 is returned. Or, if the | |
| 2181 {create} argument is present and not zero, a new, unlisted, | |
| 2182 buffer is created and its number is returned. | |
| 7 | 2183 bufnr("$") is the last buffer: > |
| 2184 :let last_buffer = bufnr("$") | |
| 2185 < The result is a Number, which is the highest buffer number | |
| 2186 of existing buffers. Note that not all buffers with a smaller | |
| 2187 number necessarily exist, because ":bwipeout" may have removed | |
| 2188 them. Use bufexists() to test for the existence of a buffer. | |
| 2189 *buffer_number()* | |
| 2190 Obsolete name: buffer_number(). | |
| 2191 *last_buffer_nr()* | |
| 2192 Obsolete name for bufnr("$"): last_buffer_nr(). | |
| 2193 | |
| 2194 bufwinnr({expr}) *bufwinnr()* | |
| 2195 The result is a Number, which is the number of the first | |
| 2196 window associated with buffer {expr}. For the use of {expr}, | |
| 1621 | 2197 see |bufname()| above. If buffer {expr} doesn't exist or |
| 7 | 2198 there is no such window, -1 is returned. Example: > |
| 2199 | |
| 2200 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
| 2201 | |
| 2202 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
| 2203 |:wincmd|. | |
| 1156 | 2204 Only deals with the current tab page. |
| 7 | 2205 |
| 2206 | |
| 2207 byte2line({byte}) *byte2line()* | |
| 2208 Return the line number that contains the character at byte | |
| 2209 count {byte} in the current buffer. This includes the | |
| 2210 end-of-line character, depending on the 'fileformat' option | |
| 2211 for the current buffer. The first character has byte count | |
| 2212 one. | |
| 2213 Also see |line2byte()|, |go| and |:goto|. | |
| 2214 {not available when compiled without the |+byte_offset| | |
| 2215 feature} | |
| 2216 | |
| 18 | 2217 byteidx({expr}, {nr}) *byteidx()* |
| 2218 Return byte index of the {nr}'th character in the string | |
| 2219 {expr}. Use zero for the first character, it returns zero. | |
| 2220 This function is only useful when there are multibyte | |
| 2221 characters, otherwise the returned value is equal to {nr}. | |
| 2222 Composing characters are counted as a separate character. | |
| 2223 Example : > | |
| 2224 echo matchstr(str, ".", byteidx(str, 3)) | |
| 2225 < will display the fourth character. Another way to do the | |
| 2226 same: > | |
| 2227 let s = strpart(str, byteidx(str, 3)) | |
| 2228 echo strpart(s, 0, byteidx(s, 1)) | |
| 2229 < If there are less than {nr} characters -1 is returned. | |
| 2230 If there are exactly {nr} characters the length of the string | |
| 2231 is returned. | |
| 2232 | |
| 102 | 2233 call({func}, {arglist} [, {dict}]) *call()* *E699* |
| 685 | 2234 Call function {func} with the items in |List| {arglist} as |
| 79 | 2235 arguments. |
| 685 | 2236 {func} can either be a |Funcref| or the name of a function. |
| 79 | 2237 a:firstline and a:lastline are set to the cursor line. |
| 2238 Returns the return value of the called function. | |
| 102 | 2239 {dict} is for functions with the "dict" attribute. It will be |
| 2240 used to set the local variable "self". |Dictionary-function| | |
| 79 | 2241 |
| 1621 | 2242 ceil({expr}) *ceil()* |
| 2243 Return the smallest integral value greater than or equal to | |
| 2244 {expr} as a |Float| (round up). | |
| 2245 {expr} must evaluate to a |Float| or a |Number|. | |
| 2246 Examples: > | |
| 2247 echo ceil(1.456) | |
| 2248 < 2.0 > | |
| 2249 echo ceil(-5.456) | |
| 2250 < -5.0 > | |
| 2251 echo ceil(4.0) | |
| 2252 < 4.0 | |
| 2253 {only available when compiled with the |+float| feature} | |
| 2254 | |
| 777 | 2255 changenr() *changenr()* |
| 2256 Return the number of the most recent change. This is the same | |
| 2257 number as what is displayed with |:undolist| and can be used | |
| 2258 with the |:undo| command. | |
| 2259 When a change was made it is the number of that change. After | |
| 2260 redo it is the number of the redone change. After undo it is | |
| 2261 one less than the number of the undone change. | |
| 2262 | |
| 7 | 2263 char2nr({expr}) *char2nr()* |
| 2264 Return number value of the first char in {expr}. Examples: > | |
| 2265 char2nr(" ") returns 32 | |
| 2266 char2nr("ABC") returns 65 | |
| 2267 < The current 'encoding' is used. Example for "utf-8": > | |
| 1156 | 2268 char2nr("á") returns 225 |
| 2269 char2nr("á"[0]) returns 195 | |
| 1621 | 2270 < |nr2char()| does the opposite. |
| 7 | 2271 |
| 2272 cindent({lnum}) *cindent()* | |
| 2273 Get the amount of indent for line {lnum} according the C | |
| 2274 indenting rules, as with 'cindent'. | |
| 2275 The indent is counted in spaces, the value of 'tabstop' is | |
| 2276 relevant. {lnum} is used just like in |getline()|. | |
| 2277 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
| 2278 feature, -1 is returned. | |
| 548 | 2279 See |C-indenting|. |
| 7 | 2280 |
| 1326 | 2281 clearmatches() *clearmatches()* |
| 2282 Clears all matches previously defined by |matchadd()| and the | |
| 2283 |:match| commands. | |
| 2284 | |
| 7 | 2285 *col()* |
| 24 | 2286 col({expr}) The result is a Number, which is the byte index of the column |
| 7 | 2287 position given with {expr}. The accepted positions are: |
| 2288 . the cursor position | |
| 2289 $ the end of the cursor line (the result is the | |
| 2290 number of characters in the cursor line plus one) | |
| 2291 'x position of mark x (if the mark is not set, 0 is | |
| 2292 returned) | |
| 1317 | 2293 Additionally {expr} can be [lnum, col]: a |List| with the line |
| 2294 and column number. Most useful when the column is "$", to get | |
| 1621 | 2295 the last column of a specific line. When "lnum" or "col" is |
| 1317 | 2296 out of range then col() returns zero. |
| 1156 | 2297 To get the line number use |line()|. To get both use |
| 703 | 2298 |getpos()|. |
| 7 | 2299 For the screen column position use |virtcol()|. |
| 2300 Note that only marks in the current file can be used. | |
| 2301 Examples: > | |
| 2302 col(".") column of cursor | |
| 2303 col("$") length of cursor line plus one | |
| 2304 col("'t") column of mark t | |
| 2305 col("'" . markname) column of mark markname | |
| 1621 | 2306 < The first column is 1. 0 is returned for an error. |
| 1156 | 2307 For an uppercase mark the column may actually be in another |
| 2308 buffer. | |
| 7 | 2309 For the cursor position, when 'virtualedit' is active, the |
| 2310 column is one higher if the cursor is after the end of the | |
| 2311 line. This can be used to obtain the column in Insert mode: > | |
| 2312 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
| 2313 \<C-O>:set ve=all<CR> | |
| 2314 \<C-O>:echo col(".") . "\n" <Bar> | |
| 2315 \let &ve = save_ve<CR> | |
| 2316 < | |
| 464 | 2317 |
| 724 | 2318 complete({startcol}, {matches}) *complete()* *E785* |
| 2319 Set the matches for Insert mode completion. | |
| 2320 Can only be used in Insert mode. You need to use a mapping | |
| 1156 | 2321 with CTRL-R = |i_CTRL-R|. It does not work after CTRL-O or |
| 2322 with an expression mapping. | |
| 724 | 2323 {startcol} is the byte offset in the line where the completed |
| 2324 text start. The text up to the cursor is the original text | |
| 2325 that will be replaced by the matches. Use col('.') for an | |
| 2326 empty string. "col('.') - 1" will replace one character by a | |
| 2327 match. | |
| 2328 {matches} must be a |List|. Each |List| item is one match. | |
| 2329 See |complete-items| for the kind of items that are possible. | |
| 2330 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
|
2331 inserting anything that would cause completion to stop. |
| 724 | 2332 The match can be selected with CTRL-N and CTRL-P as usual with |
| 2333 Insert mode completion. The popup menu will appear if | |
| 2334 specified, see |ins-completion-menu|. | |
| 2335 Example: > | |
| 1156 | 2336 inoremap <F5> <C-R>=ListMonths()<CR> |
| 724 | 2337 |
| 2338 func! ListMonths() | |
| 2339 call complete(col('.'), ['January', 'February', 'March', | |
| 2340 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
| 2341 \ 'October', 'November', 'December']) | |
| 2342 return '' | |
| 2343 endfunc | |
| 2344 < This isn't very useful, but it shows how it works. Note that | |
| 2345 an empty string is returned to avoid a zero being inserted. | |
| 2346 | |
| 464 | 2347 complete_add({expr}) *complete_add()* |
| 2348 Add {expr} to the list of matches. Only to be used by the | |
| 2349 function specified with the 'completefunc' option. | |
| 2350 Returns 0 for failure (empty string or out of memory), | |
| 2351 1 when the match was added, 2 when the match was already in | |
| 2352 the list. | |
| 1621 | 2353 See |complete-functions| for an explanation of {expr}. It is |
| 786 | 2354 the same as one item in the list that 'omnifunc' would return. |
| 464 | 2355 |
| 2356 complete_check() *complete_check()* | |
| 2357 Check for a key typed while looking for completion matches. | |
| 2358 This is to be used when looking for matches takes some time. | |
| 2359 Returns non-zero when searching for matches is to be aborted, | |
| 2360 zero otherwise. | |
| 2361 Only to be used by the function specified with the | |
| 2362 'completefunc' option. | |
| 2363 | |
| 7 | 2364 *confirm()* |
| 2365 confirm({msg} [, {choices} [, {default} [, {type}]]]) | |
| 2366 Confirm() offers the user a dialog, from which a choice can be | |
| 2367 made. It returns the number of the choice. For the first | |
| 2368 choice this is 1. | |
| 2369 Note: confirm() is only supported when compiled with dialog | |
| 2370 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
|
2371 |
| 7 | 2372 {msg} is displayed in a |dialog| with {choices} as the |
| 2373 alternatives. When {choices} is missing or empty, "&OK" is | |
| 2374 used (and translated). | |
| 2375 {msg} is a String, use '\n' to include a newline. Only on | |
| 2376 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
|
2377 |
| 7 | 2378 {choices} is a String, with the individual choices separated |
| 2379 by '\n', e.g. > | |
| 2380 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
| 2381 < The letter after the '&' is the shortcut key for that choice. | |
| 2382 Thus you can type 'c' to select "Cancel". The shortcut does | |
| 2383 not need to be the first letter: > | |
| 2384 confirm("file has been modified", "&Save\nSave &All") | |
| 2385 < For the console, the first letter of each choice is used as | |
| 2386 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
|
2387 |
| 7 | 2388 The optional {default} argument is the number of the choice |
| 2389 that is made if the user hits <CR>. Use 1 to make the first | |
| 2390 choice the default one. Use 0 to not set a default. If | |
| 2391 {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
|
2392 |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2393 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
|
2394 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
|
2395 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
|
2396 "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
|
2397 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
|
2398 |
| 7 | 2399 If the user aborts the dialog by pressing <Esc>, CTRL-C, |
| 2400 or another valid interrupt key, confirm() returns 0. | |
| 2401 | |
| 2402 An example: > | |
| 2403 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
| 2404 :if choice == 0 | |
| 2405 : echo "make up your mind!" | |
| 2406 :elseif choice == 3 | |
| 2407 : echo "tasteful" | |
| 2408 :else | |
| 2409 : echo "I prefer bananas myself." | |
| 2410 :endif | |
| 2411 < In a GUI dialog, buttons are used. The layout of the buttons | |
| 2412 depends on the 'v' flag in 'guioptions'. If it is included, | |
| 1621 | 2413 the buttons are always put vertically. Otherwise, confirm() |
| 7 | 2414 tries to put the buttons in one horizontal line. If they |
| 2415 don't fit, a vertical layout is used anyway. For some systems | |
| 2416 the horizontal layout is always used. | |
| 2417 | |
| 55 | 2418 *copy()* |
| 1621 | 2419 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 2420 different from using {expr} directly. |
| 685 | 2421 When {expr} is a |List| a shallow copy is created. This means |
| 2422 that the original |List| can be changed without changing the | |
| 1621 | 2423 copy, and vice versa. But the items are identical, thus |
| 2424 changing an item changes the contents of both |Lists|. Also | |
| 685 | 2425 see |deepcopy()|. |
| 55 | 2426 |
| 1621 | 2427 cos({expr}) *cos()* |
| 2428 Return the cosine of {expr}, measured in radians, as a |Float|. | |
| 2429 {expr} must evaluate to a |Float| or a |Number|. | |
| 2430 Examples: > | |
| 2431 :echo cos(100) | |
| 2432 < 0.862319 > | |
| 2433 :echo cos(-4.01) | |
| 2434 < -0.646043 | |
| 2435 {only available when compiled with the |+float| feature} | |
| 2436 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2437 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2438 cosh({expr}) *cosh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2439 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
|
2440 [1, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2441 {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
|
2442 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2443 :echo cosh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2444 < 1.127626 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2445 :echo cosh(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2446 < -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
|
2447 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2448 |
| 1621 | 2449 |
| 102 | 2450 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
| 79 | 2451 Return the number of times an item with value {expr} appears |
| 685 | 2452 in |List| or |Dictionary| {comp}. |
| 102 | 2453 If {start} is given then start with the item with this index. |
| 685 | 2454 {start} can only be used with a |List|. |
| 79 | 2455 When {ic} is given and it's non-zero then case is ignored. |
| 2456 | |
| 2457 | |
| 7 | 2458 *cscope_connection()* |
| 2459 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
| 2460 Checks for the existence of a |cscope| connection. If no | |
| 2461 parameters are specified, then the function returns: | |
| 2462 0, if cscope was not available (not compiled in), or | |
| 2463 if there are no cscope connections; | |
| 2464 1, if there is at least one cscope connection. | |
| 2465 | |
| 2466 If parameters are specified, then the value of {num} | |
| 2467 determines how existence of a cscope connection is checked: | |
| 2468 | |
| 2469 {num} Description of existence check | |
| 2470 ----- ------------------------------ | |
| 2471 0 Same as no parameters (e.g., "cscope_connection()"). | |
| 2472 1 Ignore {prepend}, and use partial string matches for | |
| 2473 {dbpath}. | |
| 2474 2 Ignore {prepend}, and use exact string matches for | |
| 2475 {dbpath}. | |
| 2476 3 Use {prepend}, use partial string matches for both | |
| 2477 {dbpath} and {prepend}. | |
| 2478 4 Use {prepend}, use exact string matches for both | |
| 2479 {dbpath} and {prepend}. | |
| 2480 | |
| 2481 Note: All string comparisons are case sensitive! | |
| 2482 | |
| 2483 Examples. Suppose we had the following (from ":cs show"): > | |
| 2484 | |
| 2485 # pid database name prepend path | |
| 2486 0 27664 cscope.out /usr/local | |
| 2487 < | |
| 2488 Invocation Return Val ~ | |
| 2489 ---------- ---------- > | |
| 2490 cscope_connection() 1 | |
| 2491 cscope_connection(1, "out") 1 | |
| 2492 cscope_connection(2, "out") 0 | |
| 2493 cscope_connection(3, "out") 0 | |
| 2494 cscope_connection(3, "out", "local") 1 | |
| 2495 cscope_connection(4, "out") 0 | |
| 2496 cscope_connection(4, "out", "local") 0 | |
| 2497 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
| 2498 < | |
| 703 | 2499 cursor({lnum}, {col} [, {off}]) *cursor()* |
| 2500 cursor({list}) | |
| 1156 | 2501 Positions the cursor at the column (byte count) {col} in the |
| 2502 line {lnum}. The first column is one. | |
| 703 | 2503 When there is one argument {list} this is used as a |List| |
| 707 | 2504 with two or three items {lnum}, {col} and {off}. This is like |
| 2505 the return value of |getpos()|, but without the first item. | |
| 7 | 2506 Does not change the jumplist. |
| 2507 If {lnum} is greater than the number of lines in the buffer, | |
| 2508 the cursor will be positioned at the last line in the buffer. | |
| 2509 If {lnum} is zero, the cursor will stay in the current line. | |
| 493 | 2510 If {col} is greater than the number of bytes in the line, |
| 7 | 2511 the cursor will be positioned at the last character in the |
| 2512 line. | |
| 2513 If {col} is zero, the cursor will stay in the current column. | |
| 703 | 2514 When 'virtualedit' is used {off} specifies the offset in |
| 2515 screen columns from the start of the character. E.g., a | |
| 1266 | 2516 position within a <Tab> or after the last character. |
| 1851 | 2517 Returns 0 when the position could be set, -1 otherwise. |
| 7 | 2518 |
| 55 | 2519 |
| 164 | 2520 deepcopy({expr}[, {noref}]) *deepcopy()* *E698* |
| 1621 | 2521 Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 2522 different from using {expr} directly. |
| 685 | 2523 When {expr} is a |List| a full copy is created. This means |
| 2524 that the original |List| can be changed without changing the | |
| 1621 | 2525 copy, and vice versa. When an item is a |List|, a copy for it |
| 55 | 2526 is made, recursively. Thus changing an item in the copy does |
| 685 | 2527 not change the contents of the original |List|. |
| 2528 When {noref} is omitted or zero a contained |List| or | |
| 2529 |Dictionary| is only copied once. All references point to | |
| 2530 this single copy. With {noref} set to 1 every occurrence of a | |
| 2531 |List| or |Dictionary| results in a new copy. This also means | |
| 2532 that a cyclic reference causes deepcopy() to fail. | |
| 114 | 2533 *E724* |
| 2534 Nesting is possible up to 100 levels. When there is an item | |
| 164 | 2535 that refers back to a higher level making a deep copy with |
| 2536 {noref} set to 1 will fail. | |
| 55 | 2537 Also see |copy()|. |
| 2538 | |
| 2539 delete({fname}) *delete()* | |
| 2540 Deletes the file by the name {fname}. The result is a Number, | |
| 7 | 2541 which is 0 if the file was deleted successfully, and non-zero |
| 2542 when the deletion failed. | |
| 685 | 2543 Use |remove()| to delete an item from a |List|. |
| 7 | 2544 |
| 2545 *did_filetype()* | |
| 2546 did_filetype() Returns non-zero when autocommands are being executed and the | |
| 2547 FileType event has been triggered at least once. Can be used | |
| 2548 to avoid triggering the FileType event again in the scripts | |
| 2549 that detect the file type. |FileType| | |
| 2550 When editing another file, the counter is reset, thus this | |
| 2551 really checks if the FileType event has been triggered for the | |
| 2552 current buffer. This allows an autocommand that starts | |
| 2553 editing another buffer to set 'filetype' and load a syntax | |
| 2554 file. | |
| 2555 | |
| 32 | 2556 diff_filler({lnum}) *diff_filler()* |
| 2557 Returns the number of filler lines above line {lnum}. | |
| 2558 These are the lines that were inserted at this point in | |
| 2559 another diff'ed window. These filler lines are shown in the | |
| 2560 display but don't exist in the buffer. | |
| 2561 {lnum} is used like with |getline()|. Thus "." is the current | |
| 2562 line, "'m" mark m, etc. | |
| 2563 Returns 0 if the current window is not in diff mode. | |
| 2564 | |
| 2565 diff_hlID({lnum}, {col}) *diff_hlID()* | |
| 2566 Returns the highlight ID for diff mode at line {lnum} column | |
| 2567 {col} (byte index). When the current line does not have a | |
| 2568 diff change zero is returned. | |
| 2569 {lnum} is used like with |getline()|. Thus "." is the current | |
| 2570 line, "'m" mark m, etc. | |
| 2571 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
| 2572 line. | |
| 2573 The highlight ID can be used with |synIDattr()| to obtain | |
| 2574 syntax information about the highlighting. | |
| 2575 | |
| 85 | 2576 empty({expr}) *empty()* |
| 2577 Return the Number 1 if {expr} is empty, zero otherwise. | |
| 685 | 2578 A |List| or |Dictionary| is empty when it does not have any |
| 1621 | 2579 items. A Number is empty when its value is zero. |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2580 For a long |List| this is much faster than comparing the |
| 685 | 2581 length with zero. |
| 85 | 2582 |
| 7 | 2583 escape({string}, {chars}) *escape()* |
| 2584 Escape the characters in {chars} that occur in {string} with a | |
| 2585 backslash. Example: > | |
| 2586 :echo escape('c:\program files\vim', ' \') | |
| 2587 < results in: > | |
| 2588 c:\\program\ files\\vim | |
| 1621 | 2589 < Also see |shellescape()|. |
| 2590 | |
| 2591 *eval()* | |
| 95 | 2592 eval({string}) Evaluate {string} and return the result. Especially useful to |
| 2593 turn the result of |string()| back into the original value. | |
| 1621 | 2594 This works for Numbers, Floats, Strings and composites of |
| 2595 them. Also works for |Funcref|s that refer to existing | |
| 2596 functions. | |
| 95 | 2597 |
| 7 | 2598 eventhandler() *eventhandler()* |
| 2599 Returns 1 when inside an event handler. That is that Vim got | |
| 2600 interrupted while waiting for the user to type a character, | |
| 2601 e.g., when dropping a file on Vim. This means interactive | |
| 2602 commands cannot be used. Otherwise zero is returned. | |
| 2603 | |
| 2604 executable({expr}) *executable()* | |
| 2605 This function checks if an executable with the name {expr} | |
| 2606 exists. {expr} must be the name of the program without any | |
| 10 | 2607 arguments. |
| 2608 executable() uses the value of $PATH and/or the normal | |
| 2609 searchpath for programs. *PATHEXT* | |
| 2610 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can | |
| 2611 optionally be included. Then the extensions in $PATHEXT are | |
| 1621 | 2612 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be |
| 2613 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is | |
| 10 | 2614 used. A dot by itself can be used in $PATHEXT to try using |
| 1621 | 2615 the name without an extension. When 'shell' looks like a |
| 10 | 2616 Unix shell, then the name is also tried without adding an |
| 2617 extension. | |
| 2618 On MS-DOS and MS-Windows it only checks if the file exists and | |
| 2619 is not a directory, not if it's really executable. | |
| 819 | 2620 On MS-Windows an executable in the same directory as Vim is |
| 2621 always found. Since this directory is added to $PATH it | |
| 2622 should also work to execute it |win32-PATH|. | |
| 7 | 2623 The result is a Number: |
| 2624 1 exists | |
| 2625 0 does not exist | |
| 2626 -1 not implemented on this system | |
| 2627 | |
| 2628 *exists()* | |
| 2629 exists({expr}) The result is a Number, which is non-zero if {expr} is | |
| 2630 defined, zero otherwise. The {expr} argument is a string, | |
| 2631 which contains one of these: | |
| 2632 &option-name Vim option (only checks if it exists, | |
| 2633 not if it really works) | |
| 2634 +option-name Vim option that works. | |
| 2635 $ENVNAME environment variable (could also be | |
| 2636 done by comparing with an empty | |
| 2637 string) | |
| 2638 *funcname built-in function (see |functions|) | |
| 2639 or user defined function (see | |
| 2640 |user-functions|). | |
| 2641 varname internal variable (see | |
| 1621 | 2642 |internal-variables|). Also works |
| 685 | 2643 for |curly-braces-names|, |Dictionary| |
| 2644 entries, |List| items, etc. Beware | |
| 1668 | 2645 that evaluating an index may cause an |
| 2646 error message for an invalid | |
| 2647 expression. E.g.: > | |
| 2648 :let l = [1, 2, 3] | |
| 2649 :echo exists("l[5]") | |
| 2650 < 0 > | |
| 2651 :echo exists("l[xx]") | |
| 2652 < E121: Undefined variable: xx | |
| 2653 0 | |
| 7 | 2654 :cmdname Ex command: built-in command, user |
| 2655 command or command modifier |:command|. | |
| 2656 Returns: | |
| 2657 1 for match with start of a command | |
| 2658 2 full match with a command | |
| 2659 3 matches several user commands | |
| 2660 To check for a supported command | |
| 2661 always check the return value to be 2. | |
| 864 | 2662 :2match The |:2match| command. |
| 2663 :3match The |:3match| command. | |
| 7 | 2664 #event autocommand defined for this event |
| 2665 #event#pattern autocommand defined for this event and | |
| 2666 pattern (the pattern is taken | |
| 2667 literally and compared to the | |
| 2668 autocommand patterns character by | |
| 2669 character) | |
| 613 | 2670 #group autocommand group exists |
| 2671 #group#event autocommand defined for this group and | |
| 2672 event. | |
| 2673 #group#event#pattern | |
| 856 | 2674 autocommand defined for this group, |
| 613 | 2675 event and pattern. |
| 615 | 2676 ##event autocommand for this event is |
| 2677 supported. | |
| 7 | 2678 For checking for a supported feature use |has()|. |
| 2679 | |
| 2680 Examples: > | |
| 2681 exists("&shortname") | |
| 2682 exists("$HOSTNAME") | |
| 2683 exists("*strftime") | |
| 2684 exists("*s:MyFunc") | |
| 2685 exists("bufcount") | |
| 2686 exists(":Make") | |
| 613 | 2687 exists("#CursorHold") |
| 7 | 2688 exists("#BufReadPre#*.gz") |
| 613 | 2689 exists("#filetypeindent") |
| 2690 exists("#filetypeindent#FileType") | |
| 2691 exists("#filetypeindent#FileType#*") | |
| 615 | 2692 exists("##ColorScheme") |
| 7 | 2693 < There must be no space between the symbol (&/$/*/#) and the |
| 2694 name. | |
| 867 | 2695 There must be no extra characters after the name, although in |
| 2696 a few cases this is ignored. That may become more strict in | |
| 2697 the future, thus don't count on it! | |
| 2698 Working example: > | |
| 2699 exists(":make") | |
| 2700 < NOT working example: > | |
| 2701 exists(":make install") | |
| 859 | 2702 |
| 2703 < Note that the argument must be a string, not the name of the | |
| 2704 variable itself. For example: > | |
| 7 | 2705 exists(bufcount) |
| 2706 < This doesn't check for existence of the "bufcount" variable, | |
| 853 | 2707 but gets the value of "bufcount", and checks if that exists. |
| 7 | 2708 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2709 exp({expr}) *exp()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2710 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
|
2711 [0, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2712 {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
|
2713 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2714 :echo exp(2) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2715 < 7.389056 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2716 :echo exp(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2717 < 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
|
2718 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2719 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2720 |
| 7 | 2721 expand({expr} [, {flag}]) *expand()* |
| 2722 Expand wildcards and the following special keywords in {expr}. | |
| 2723 The result is a String. | |
| 2724 | |
| 2725 When there are several matches, they are separated by <NL> | |
| 2726 characters. [Note: in version 5.0 a space was used, which | |
| 2727 caused problems when a file name contains a space] | |
| 2728 | |
| 1621 | 2729 If the expansion fails, the result is an empty string. A name |
| 7 | 2730 for a non-existing file is not included. |
| 2731 | |
| 2732 When {expr} starts with '%', '#' or '<', the expansion is done | |
| 2733 like for the |cmdline-special| variables with their associated | |
| 2734 modifiers. Here is a short overview: | |
| 2735 | |
| 2736 % current file name | |
| 2737 # alternate file name | |
| 2738 #n alternate file name n | |
| 2739 <cfile> file name under the cursor | |
| 2740 <afile> autocmd file name | |
| 2741 <abuf> autocmd buffer number (as a String!) | |
| 2742 <amatch> autocmd matched name | |
| 2743 <sfile> sourced script file name | |
| 2744 <cword> word under the cursor | |
| 2745 <cWORD> WORD under the cursor | |
| 2746 <client> the {clientid} of the last received | |
| 2747 message |server2client()| | |
| 2748 Modifiers: | |
| 2749 :p expand to full path | |
| 2750 :h head (last path component removed) | |
| 2751 :t tail (last path component only) | |
| 2752 :r root (one extension removed) | |
| 2753 :e extension only | |
| 2754 | |
| 2755 Example: > | |
| 2756 :let &tags = expand("%:p:h") . "/tags" | |
| 2757 < Note that when expanding a string that starts with '%', '#' or | |
| 2758 '<', any following text is ignored. This does NOT work: > | |
| 2759 :let doesntwork = expand("%:h.bak") | |
| 2760 < Use this: > | |
| 2761 :let doeswork = expand("%:h") . ".bak" | |
| 2762 < Also note that expanding "<cfile>" and others only returns the | |
| 2763 referenced file name without further expansion. If "<cfile>" | |
| 2764 is "~/.cshrc", you need to do another expand() to have the | |
| 2765 "~/" expanded into the path of the home directory: > | |
| 2766 :echo expand(expand("<cfile>")) | |
| 2767 < | |
| 2768 There cannot be white space between the variables and the | |
| 2769 following modifier. The |fnamemodify()| function can be used | |
| 2770 to modify normal file names. | |
| 2771 | |
| 2772 When using '%' or '#', and the current or alternate file name | |
| 2773 is not defined, an empty string is used. Using "%:p" in a | |
| 2774 buffer with no name, results in the current directory, with a | |
| 2775 '/' added. | |
| 2776 | |
| 2777 When {expr} does not start with '%', '#' or '<', it is | |
| 2778 expanded like a file name is expanded on the command line. | |
| 2779 'suffixes' and 'wildignore' are used, unless the optional | |
| 2780 {flag} argument is given and it is non-zero. Names for | |
| 444 | 2781 non-existing files are included. The "**" item can be used to |
| 2782 search in a directory tree. For example, to find all "README" | |
| 2783 files in the current directory and below: > | |
| 2784 :echo expand("**/README") | |
| 2785 < | |
| 7 | 2786 Expand() can also be used to expand variables and environment |
| 2787 variables that are only known in a shell. But this can be | |
| 1621 | 2788 slow, because a shell must be started. See |expr-env-expand|. |
| 7 | 2789 The expanded variable is still handled like a list of file |
| 1621 | 2790 names. When an environment variable cannot be expanded, it is |
| 7 | 2791 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
| 2792 "$FOOBAR". | |
| 2793 | |
| 2794 See |glob()| for finding existing files. See |system()| for | |
| 2795 getting the raw output of an external command. | |
| 2796 | |
| 102 | 2797 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
| 692 | 2798 {expr1} and {expr2} must be both |Lists| or both |
| 2799 |Dictionaries|. | |
| 2800 | |
| 2801 If they are |Lists|: Append {expr2} to {expr1}. | |
| 102 | 2802 If {expr3} is given insert the items of {expr2} before item |
| 2803 {expr3} in {expr1}. When {expr3} is zero insert before the | |
| 2804 first item. When {expr3} is equal to len({expr1}) then | |
| 2805 {expr2} is appended. | |
| 79 | 2806 Examples: > |
| 2807 :echo sort(extend(mylist, [7, 5])) | |
| 2808 :call extend(mylist, [2, 3], 1) | |
| 1699 | 2809 < When {expr1} is the same List as {expr2} then the number of |
| 2810 items copied is equal to the original length of the List. | |
| 2811 E.g., when {expr3} is 1 you get N new copies of the first item | |
| 2812 (where N is the original length of the List). | |
| 2813 Use |add()| to concatenate one item to a list. To concatenate | |
| 82 | 2814 two lists into a new list use the + operator: > |
| 79 | 2815 :let newlist = [1, 2, 3] + [4, 5] |
| 102 | 2816 < |
| 692 | 2817 If they are |Dictionaries|: |
| 102 | 2818 Add all entries from {expr2} to {expr1}. |
| 2819 If a key exists in both {expr1} and {expr2} then {expr3} is | |
| 2820 used to decide what to do: | |
| 2821 {expr3} = "keep": keep the value of {expr1} | |
| 2822 {expr3} = "force": use the value of {expr2} | |
| 856 | 2823 {expr3} = "error": give an error message *E737* |
| 102 | 2824 When {expr3} is omitted then "force" is assumed. |
| 2825 | |
| 2826 {expr1} is changed when {expr2} is not empty. If necessary | |
| 2827 make a copy of {expr1} first. | |
| 2828 {expr2} remains unchanged. | |
| 2829 Returns {expr1}. | |
| 2830 | |
| 79 | 2831 |
| 842 | 2832 feedkeys({string} [, {mode}]) *feedkeys()* |
| 2833 Characters in {string} are queued for processing as if they | |
| 1621 | 2834 come from a mapping or were typed by the user. They are added |
| 1156 | 2835 to the end of the typeahead buffer, thus if a mapping is still |
| 842 | 2836 being executed these characters come after them. |
| 2837 The function does not wait for processing of keys contained in | |
| 2838 {string}. | |
| 2839 To include special keys into {string}, use double-quotes | |
| 2840 and "\..." notation |expr-quote|. For example, | |
| 1215 | 2841 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
| 842 | 2842 feedkeys('\<CR>') pushes 5 characters. |
| 2843 If {mode} is absent, keys are remapped. | |
| 2844 {mode} is a String, which can contain these character flags: | |
| 843 | 2845 'm' Remap keys. This is default. |
| 2846 'n' Do not remap keys. | |
| 2847 't' Handle keys as if typed; otherwise they are handled as | |
| 2848 if coming from a mapping. This matters for undo, | |
| 2849 opening folds, etc. | |
| 842 | 2850 Return value is always 0. |
| 2851 | |
| 7 | 2852 filereadable({file}) *filereadable()* |
| 2853 The result is a Number, which is TRUE when a file with the | |
| 2854 name {file} exists, and can be read. If {file} doesn't exist, | |
| 2855 or is a directory, the result is FALSE. {file} is any | |
| 2856 expression, which is used as a String. | |
| 1156 | 2857 If you don't care about the file being readable you can use |
| 2858 |glob()|. | |
| 7 | 2859 *file_readable()* |
| 2860 Obsolete name: file_readable(). | |
| 2861 | |
| 95 | 2862 |
| 1156 | 2863 filewritable({file}) *filewritable()* |
| 2864 The result is a Number, which is 1 when a file with the | |
| 2865 name {file} exists, and can be written. If {file} doesn't | |
| 1621 | 2866 exist, or is not writable, the result is 0. If {file} is a |
| 1156 | 2867 directory, and we can write to it, the result is 2. |
| 2868 | |
| 2869 | |
| 102 | 2870 filter({expr}, {string}) *filter()* |
| 685 | 2871 {expr} must be a |List| or a |Dictionary|. |
| 102 | 2872 For each item in {expr} evaluate {string} and when the result |
| 685 | 2873 is zero remove the item from the |List| or |Dictionary|. |
| 102 | 2874 Inside {string} |v:val| has the value of the current item. |
| 685 | 2875 For a |Dictionary| |v:key| has the key of the current item. |
| 102 | 2876 Examples: > |
| 2877 :call filter(mylist, 'v:val !~ "OLD"') | |
| 2878 < Removes the items where "OLD" appears. > | |
| 2879 :call filter(mydict, 'v:key >= 8') | |
| 2880 < Removes the items with a key below 8. > | |
| 2881 :call filter(var, 0) | |
| 685 | 2882 < Removes all the items, thus clears the |List| or |Dictionary|. |
| 99 | 2883 |
| 102 | 2884 Note that {string} is the result of expression and is then |
| 2885 used as an expression again. Often it is good to use a | |
| 2886 |literal-string| to avoid having to double backslashes. | |
| 2887 | |
| 685 | 2888 The operation is done in-place. If you want a |List| or |
| 2889 |Dictionary| to remain unmodified make a copy first: > | |
| 650 | 2890 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
| 102 | 2891 |
| 685 | 2892 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
| 648 | 2893 When an error is encountered while evaluating {string} no |
| 2894 further items in {expr} are processed. | |
| 95 | 2895 |
| 2896 | |
| 19 | 2897 finddir({name}[, {path}[, {count}]]) *finddir()* |
| 1095 | 2898 Find directory {name} in {path}. Supports both downwards and |
| 2899 upwards recursive directory searches. See |file-searching| | |
| 2900 for the syntax of {path}. | |
| 2901 Returns the path of the first found match. When the found | |
| 2902 directory is below the current directory a relative path is | |
| 2903 returned. Otherwise a full path is returned. | |
| 19 | 2904 If {path} is omitted or empty then 'path' is used. |
| 2905 If the optional {count} is given, find {count}'s occurrence of | |
| 794 | 2906 {name} in {path} instead of the first one. |
| 809 | 2907 When {count} is negative return all the matches in a |List|. |
| 19 | 2908 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
|
2909 {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
|
2910 feature} |
| 794 | 2911 |
| 2912 findfile({name}[, {path}[, {count}]]) *findfile()* | |
| 2913 Just like |finddir()|, but find a file instead of a directory. | |
| 2914 Uses 'suffixesadd'. | |
| 19 | 2915 Example: > |
| 2916 :echo findfile("tags.vim", ".;") | |
| 1156 | 2917 < Searches from the directory of the current file upwards until |
| 2918 it finds the file "tags.vim". | |
| 7 | 2919 |
| 1621 | 2920 float2nr({expr}) *float2nr()* |
| 2921 Convert {expr} to a Number by omitting the part after the | |
| 2922 decimal point. | |
| 2923 {expr} must evaluate to a |Float| or a Number. | |
| 2924 When the value of {expr} is out of range for a |Number| the | |
| 2925 result is truncated to 0x7fffffff or -0x7fffffff. NaN results | |
| 2926 in -0x80000000. | |
| 2927 Examples: > | |
| 2928 echo float2nr(3.95) | |
| 2929 < 3 > | |
| 2930 echo float2nr(-23.45) | |
| 2931 < -23 > | |
| 2932 echo float2nr(1.0e100) | |
| 2933 < 2147483647 > | |
| 2934 echo float2nr(-1.0e150) | |
| 2935 < -2147483647 > | |
| 2936 echo float2nr(1.0e-100) | |
| 2937 < 0 | |
| 2938 {only available when compiled with the |+float| feature} | |
| 2939 | |
| 2940 | |
| 2941 floor({expr}) *floor()* | |
| 2942 Return the largest integral value less than or equal to | |
| 2943 {expr} as a |Float| (round down). | |
| 2944 {expr} must evaluate to a |Float| or a |Number|. | |
| 2945 Examples: > | |
| 2946 echo floor(1.856) | |
| 2947 < 1.0 > | |
| 2948 echo floor(-5.456) | |
| 2949 < -6.0 > | |
| 2950 echo floor(4.0) | |
| 2951 < 4.0 | |
| 2952 {only available when compiled with the |+float| feature} | |
| 2953 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2954 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2955 fmod({expr1}, {expr2}) *fmod()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2956 Return the remainder of {expr1} / {expr2}, even if the |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2957 division is not representable. Returns {expr1} - i * {expr2} |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2958 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
|
2959 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
|
2960 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
|
2961 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
|
2962 {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
|
2963 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2964 :echo fmod(12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2965 < 0.13 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2966 :echo fmod(-12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2967 < -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
|
2968 {only available when compiled with |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2969 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2970 |
| 1586 | 2971 fnameescape({string}) *fnameescape()* |
| 1621 | 2972 Escape {string} for use as file name command argument. All |
| 1586 | 2973 characters that have a special meaning, such as '%' and '|' |
| 2974 are escaped with a backslash. | |
| 1621 | 2975 For most systems the characters escaped are |
| 2976 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
| 2977 appears in a filename, it depends on the value of 'isfname'. | |
| 1700 | 2978 A leading '+' and '>' is also escaped (special after |:edit| |
| 2979 and |:write|). And a "-" by itself (special after |:cd|). | |
| 1586 | 2980 Example: > |
| 1700 | 2981 :let fname = '+some str%nge|name' |
| 1586 | 2982 :exe "edit " . fnameescape(fname) |
| 2983 < results in executing: > | |
| 1700 | 2984 edit \+some\ str\%nge\|name |
| 1586 | 2985 |
| 7 | 2986 fnamemodify({fname}, {mods}) *fnamemodify()* |
| 2987 Modify file name {fname} according to {mods}. {mods} is a | |
| 2988 string of characters like it is used for file names on the | |
| 2989 command line. See |filename-modifiers|. | |
| 2990 Example: > | |
| 2991 :echo fnamemodify("main.c", ":p:h") | |
| 2992 < results in: > | |
| 2993 /home/mool/vim/vim/src | |
| 1621 | 2994 < Note: Environment variables don't work in {fname}, use |
| 7 | 2995 |expand()| first then. |
| 2996 | |
| 2997 foldclosed({lnum}) *foldclosed()* | |
| 2998 The result is a Number. If the line {lnum} is in a closed | |
| 2999 fold, the result is the number of the first line in that fold. | |
| 3000 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 3001 | |
| 3002 foldclosedend({lnum}) *foldclosedend()* | |
| 3003 The result is a Number. If the line {lnum} is in a closed | |
| 3004 fold, the result is the number of the last line in that fold. | |
| 3005 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 3006 | |
| 3007 foldlevel({lnum}) *foldlevel()* | |
| 3008 The result is a Number, which is the foldlevel of line {lnum} | |
| 1621 | 3009 in the current buffer. For nested folds the deepest level is |
| 7 | 3010 returned. If there is no fold at line {lnum}, zero is |
| 3011 returned. It doesn't matter if the folds are open or closed. | |
| 3012 When used while updating folds (from 'foldexpr') -1 is | |
| 3013 returned for lines where folds are still to be updated and the | |
| 3014 foldlevel is unknown. As a special case the level of the | |
| 3015 previous line is usually available. | |
| 3016 | |
| 3017 *foldtext()* | |
| 3018 foldtext() Returns a String, to be displayed for a closed fold. This is | |
| 3019 the default function used for the 'foldtext' option and should | |
| 3020 only be called from evaluating 'foldtext'. It uses the | |
| 3021 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
| 3022 The returned string looks like this: > | |
| 3023 +-- 45 lines: abcdef | |
| 1621 | 3024 < The number of dashes depends on the foldlevel. The "45" is |
| 7 | 3025 the number of lines in the fold. "abcdef" is the text in the |
| 3026 first non-blank line of the fold. Leading white space, "//" | |
| 3027 or "/*" and the text from the 'foldmarker' and 'commentstring' | |
| 3028 options is removed. | |
| 3029 {not available when compiled without the |+folding| feature} | |
| 3030 | |
| 29 | 3031 foldtextresult({lnum}) *foldtextresult()* |
| 3032 Returns the text that is displayed for the closed fold at line | |
| 3033 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
| 3034 When there is no closed fold at {lnum} an empty string is | |
| 3035 returned. | |
| 3036 {lnum} is used like with |getline()|. Thus "." is the current | |
| 3037 line, "'m" mark m, etc. | |
| 3038 Useful when exporting folded text, e.g., to HTML. | |
| 3039 {not available when compiled without the |+folding| feature} | |
| 3040 | |
| 7 | 3041 *foreground()* |
| 1621 | 3042 foreground() Move the Vim window to the foreground. Useful when sent from |
| 7 | 3043 a client to a Vim server. |remote_send()| |
| 3044 On Win32 systems this might not work, the OS does not always | |
| 3045 allow a window to bring itself to the foreground. Use | |
| 3046 |remote_foreground()| instead. | |
| 3047 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 3048 Win32 console version} | |
| 3049 | |
| 82 | 3050 |
| 85 | 3051 function({name}) *function()* *E700* |
| 685 | 3052 Return a |Funcref| variable that refers to function {name}. |
| 55 | 3053 {name} can be a user defined function or an internal function. |
| 3054 | |
| 82 | 3055 |
| 1405 | 3056 garbagecollect([at_exit]) *garbagecollect()* |
| 692 | 3057 Cleanup unused |Lists| and |Dictionaries| that have circular |
| 370 | 3058 references. There is hardly ever a need to invoke this |
| 3059 function, as it is automatically done when Vim runs out of | |
| 3060 memory or is waiting for the user to press a key after | |
| 3061 'updatetime'. Items without circular references are always | |
| 3062 freed when they become unused. | |
| 685 | 3063 This is useful if you have deleted a very big |List| and/or |
| 3064 |Dictionary| with circular references in a script that runs | |
| 3065 for a long time. | |
| 1405 | 3066 When the optional "at_exit" argument is one, garbage |
| 3067 collection will also be done when exiting Vim, if it wasn't | |
| 3068 done before. This is useful when checking for memory leaks. | |
| 370 | 3069 |
| 140 | 3070 get({list}, {idx} [, {default}]) *get()* |
| 685 | 3071 Get item {idx} from |List| {list}. When this item is not |
| 82 | 3072 available return {default}. Return zero when {default} is |
| 3073 omitted. | |
| 102 | 3074 get({dict}, {key} [, {default}]) |
| 685 | 3075 Get item with key {key} from |Dictionary| {dict}. When this |
| 102 | 3076 item is not available return {default}. Return zero when |
| 3077 {default} is omitted. | |
| 3078 | |
| 435 | 3079 *getbufline()* |
| 3080 getbufline({expr}, {lnum} [, {end}]) | |
| 685 | 3081 Return a |List| with the lines starting from {lnum} to {end} |
| 3082 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
| 3083 |List| with only the line {lnum} is returned. | |
| 435 | 3084 |
| 3085 For the use of {expr}, see |bufname()| above. | |
| 3086 | |
| 448 | 3087 For {lnum} and {end} "$" can be used for the last line of the |
| 3088 buffer. Otherwise a number must be used. | |
| 435 | 3089 |
| 3090 When {lnum} is smaller than 1 or bigger than the number of | |
| 685 | 3091 lines in the buffer, an empty |List| is returned. |
| 435 | 3092 |
| 3093 When {end} is greater than the number of lines in the buffer, | |
| 3094 it is treated as {end} is set to the number of lines in the | |
| 685 | 3095 buffer. When {end} is before {lnum} an empty |List| is |
| 435 | 3096 returned. |
| 3097 | |
| 448 | 3098 This function works only for loaded buffers. For unloaded and |
| 685 | 3099 non-existing buffers, an empty |List| is returned. |
| 435 | 3100 |
| 3101 Example: > | |
| 3102 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
| 82 | 3103 |
| 3104 getbufvar({expr}, {varname}) *getbufvar()* | |
| 3105 The result is the value of option or local buffer variable | |
| 3106 {varname} in buffer {expr}. Note that the name without "b:" | |
| 3107 must be used. | |
| 1668 | 3108 When {varname} is empty returns a dictionary with all the |
| 3109 buffer-local variables. | |
| 216 | 3110 This also works for a global or buffer-local option, but it |
| 3111 doesn't work for a global variable, window-local variable or | |
| 3112 window-local option. | |
| 82 | 3113 For the use of {expr}, see |bufname()| above. |
| 3114 When the buffer or variable doesn't exist an empty string is | |
| 3115 returned, there is no error message. | |
| 3116 Examples: > | |
| 3117 :let bufmodified = getbufvar(1, "&mod") | |
| 3118 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
| 3119 < | |
| 7 | 3120 getchar([expr]) *getchar()* |
| 867 | 3121 Get a single character from the user or input stream. |
| 7 | 3122 If [expr] is omitted, wait until a character is available. |
| 3123 If [expr] is 0, only get a character when one is available. | |
| 867 | 3124 Return zero otherwise. |
| 7 | 3125 If [expr] is 1, only check if a character is available, it is |
| 867 | 3126 not consumed. Return zero if no character available. |
| 3127 | |
| 3128 Without {expr} and when {expr} is 0 a whole character or | |
| 3129 special key is returned. If it is an 8-bit character, the | |
| 3130 result is a number. Use nr2char() to convert it to a String. | |
| 3131 Otherwise a String is returned with the encoded character. | |
| 3132 For a special key it's a sequence of bytes starting with 0x80 | |
| 872 | 3133 (decimal: 128). This is the same value as the string |
| 3134 "\<Key>", e.g., "\<Left>". The returned value is also a | |
| 3135 String when a modifier (shift, control, alt) was used that is | |
| 3136 not included in the character. | |
| 867 | 3137 |
| 3138 When {expr} is 1 only the first byte is returned. For a | |
| 872 | 3139 one-byte character it is the character itself as a number. |
| 3140 Use nr2char() to convert it to a String. | |
| 867 | 3141 |
| 1029 | 3142 When the user clicks a mouse button, the mouse event will be |
| 3143 returned. The position can then be found in |v:mouse_col|, | |
| 3144 |v:mouse_lnum| and |v:mouse_win|. This example positions the | |
| 3145 mouse as it would normally happen: > | |
| 3146 let c = getchar() | |
| 1621 | 3147 if c == "\<LeftMouse>" && v:mouse_win > 0 |
| 1029 | 3148 exe v:mouse_win . "wincmd w" |
| 3149 exe v:mouse_lnum | |
| 3150 exe "normal " . v:mouse_col . "|" | |
| 3151 endif | |
| 3152 < | |
| 7 | 3153 There is no prompt, you will somehow have to make clear to the |
| 3154 user that a character has to be typed. | |
| 3155 There is no mapping for the character. | |
| 3156 Key codes are replaced, thus when the user presses the <Del> | |
| 3157 key you get the code for the <Del> key, not the raw character | |
| 3158 sequence. Examples: > | |
| 3159 getchar() == "\<Del>" | |
| 3160 getchar() == "\<S-Left>" | |
| 3161 < This example redefines "f" to ignore case: > | |
| 3162 :nmap f :call FindChar()<CR> | |
| 3163 :function FindChar() | |
| 3164 : let c = nr2char(getchar()) | |
| 3165 : while col('.') < col('$') - 1 | |
| 3166 : normal l | |
| 3167 : if getline('.')[col('.') - 1] ==? c | |
| 3168 : break | |
| 3169 : endif | |
| 3170 : endwhile | |
| 3171 :endfunction | |
| 3172 | |
| 3173 getcharmod() *getcharmod()* | |
| 3174 The result is a Number which is the state of the modifiers for | |
| 3175 the last obtained character with getchar() or in another way. | |
| 3176 These values are added together: | |
| 3177 2 shift | |
| 3178 4 control | |
| 3179 8 alt (meta) | |
| 3180 16 mouse double click | |
| 3181 32 mouse triple click | |
| 3182 64 mouse quadruple click | |
| 3183 128 Macintosh only: command | |
| 3184 Only the modifiers that have not been included in the | |
| 1621 | 3185 character itself are obtained. Thus Shift-a results in "A" |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3186 without a modifier. |
| 7 | 3187 |
| 3188 getcmdline() *getcmdline()* | |
| 3189 Return the current command-line. Only works when the command | |
| 3190 line is being edited, thus requires use of |c_CTRL-\_e| or | |
| 3191 |c_CTRL-R_=|. | |
| 3192 Example: > | |
| 3193 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
| 531 | 3194 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
| 7 | 3195 |
| 95 | 3196 getcmdpos() *getcmdpos()* |
| 7 | 3197 Return the position of the cursor in the command line as a |
| 3198 byte count. The first column is 1. | |
| 3199 Only works when editing the command line, thus requires use of | |
| 3200 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns 0 otherwise. | |
| 531 | 3201 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
| 3202 | |
| 3203 getcmdtype() *getcmdtype()* | |
| 3204 Return the current command-line type. Possible return values | |
| 3205 are: | |
| 532 | 3206 : normal Ex command |
| 3207 > debug mode command |debug-mode| | |
| 3208 / forward search command | |
| 3209 ? backward search command | |
| 3210 @ |input()| command | |
| 3211 - |:insert| or |:append| command | |
| 531 | 3212 Only works when editing the command line, thus requires use of |
| 3213 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns an empty string | |
| 3214 otherwise. | |
| 3215 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. | |
| 7 | 3216 |
| 3217 *getcwd()* | |
| 3218 getcwd() The result is a String, which is the name of the current | |
| 3219 working directory. | |
| 3220 | |
| 3221 getfsize({fname}) *getfsize()* | |
| 3222 The result is a Number, which is the size in bytes of the | |
| 3223 given file {fname}. | |
| 3224 If {fname} is a directory, 0 is returned. | |
| 3225 If the file {fname} can't be found, -1 is returned. | |
| 1293 | 3226 If the size of {fname} is too big to fit in a Number then -2 |
| 3227 is returned. | |
| 7 | 3228 |
| 37 | 3229 getfontname([{name}]) *getfontname()* |
| 3230 Without an argument returns the name of the normal font being | |
| 3231 used. Like what is used for the Normal highlight group | |
| 3232 |hl-Normal|. | |
| 3233 With an argument a check is done whether {name} is a valid | |
| 3234 font name. If not then an empty string is returned. | |
| 3235 Otherwise the actual font name is returned, or {name} if the | |
| 3236 GUI does not support obtaining the real name. | |
| 824 | 3237 Only works when the GUI is running, thus not in your vimrc or |
| 819 | 3238 gvimrc file. Use the |GUIEnter| autocommand to use this |
| 3239 function just after the GUI has started. | |
| 37 | 3240 Note that the GTK 2 GUI accepts any font name, thus checking |
| 3241 for a valid name does not work. | |
| 3242 | |
| 20 | 3243 getfperm({fname}) *getfperm()* |
| 3244 The result is a String, which is the read, write, and execute | |
| 3245 permissions of the given file {fname}. | |
| 3246 If {fname} does not exist or its directory cannot be read, an | |
| 3247 empty string is returned. | |
| 3248 The result is of the form "rwxrwxrwx", where each group of | |
| 3249 "rwx" flags represent, in turn, the permissions of the owner | |
| 3250 of the file, the group the file belongs to, and other users. | |
| 3251 If a user does not have a given permission the flag for this | |
| 3252 is replaced with the string "-". Example: > | |
| 3253 :echo getfperm("/etc/passwd") | |
| 3254 < This will hopefully (from a security point of view) display | |
| 3255 the string "rw-r--r--" or even "rw-------". | |
| 205 | 3256 |
| 7 | 3257 getftime({fname}) *getftime()* |
| 3258 The result is a Number, which is the last modification time of | |
| 3259 the given file {fname}. The value is measured as seconds | |
| 3260 since 1st Jan 1970, and may be passed to strftime(). See also | |
| 3261 |localtime()| and |strftime()|. | |
| 3262 If the file {fname} can't be found -1 is returned. | |
| 3263 | |
| 20 | 3264 getftype({fname}) *getftype()* |
| 3265 The result is a String, which is a description of the kind of | |
| 3266 file of the given file {fname}. | |
| 3267 If {fname} does not exist an empty string is returned. | |
| 3268 Here is a table over different kinds of files and their | |
| 3269 results: | |
| 3270 Normal file "file" | |
| 3271 Directory "dir" | |
| 3272 Symbolic link "link" | |
| 3273 Block device "bdev" | |
| 3274 Character device "cdev" | |
| 3275 Socket "socket" | |
| 3276 FIFO "fifo" | |
| 3277 All other "other" | |
| 3278 Example: > | |
| 3279 getftype("/home") | |
| 3280 < Note that a type such as "link" will only be returned on | |
| 3281 systems that support it. On some systems only "dir" and | |
| 3282 "file" are returned. | |
| 3283 | |
| 7 | 3284 *getline()* |
| 82 | 3285 getline({lnum} [, {end}]) |
| 3286 Without {end} the result is a String, which is line {lnum} | |
| 3287 from the current buffer. Example: > | |
| 7 | 3288 getline(1) |
| 3289 < When {lnum} is a String that doesn't start with a | |
| 3290 digit, line() is called to translate the String into a Number. | |
| 3291 To get the line under the cursor: > | |
| 3292 getline(".") | |
| 3293 < When {lnum} is smaller than 1 or bigger than the number of | |
| 3294 lines in the buffer, an empty string is returned. | |
| 3295 | |
| 685 | 3296 When {end} is given the result is a |List| where each item is |
| 3297 a line from the current buffer in the range {lnum} to {end}, | |
| 82 | 3298 including line {end}. |
| 3299 {end} is used in the same way as {lnum}. | |
| 3300 Non-existing lines are silently omitted. | |
| 685 | 3301 When {end} is before {lnum} an empty |List| is returned. |
| 82 | 3302 Example: > |
| 3303 :let start = line('.') | |
| 3304 :let end = search("^$") - 1 | |
| 3305 :let lines = getline(start, end) | |
| 3306 | |
| 1156 | 3307 < To get lines from another buffer see |getbufline()| |
| 3308 | |
| 647 | 3309 getloclist({nr}) *getloclist()* |
| 3310 Returns a list with all the entries in the location list for | |
| 3311 window {nr}. When {nr} is zero the current window is used. | |
| 3312 For a location list window, the displayed location list is | |
| 648 | 3313 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
|
3314 returned. Otherwise, same as |getqflist()|. |
| 82 | 3315 |
| 1326 | 3316 getmatches() *getmatches()* |
| 3317 Returns a |List| with all matches previously defined by | |
| 3318 |matchadd()| and the |:match| commands. |getmatches()| is | |
| 3319 useful in combination with |setmatches()|, as |setmatches()| | |
| 3320 can restore a list of matches saved by |getmatches()|. | |
| 3321 Example: > | |
| 3322 :echo getmatches() | |
| 3323 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 3324 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 3325 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 3326 :let m = getmatches() | |
| 3327 :call clearmatches() | |
| 3328 :echo getmatches() | |
| 3329 < [] > | |
| 3330 :call setmatches(m) | |
| 3331 :echo getmatches() | |
| 3332 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 3333 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 3334 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 3335 :unlet m | |
| 3336 < | |
| 3337 | |
| 230 | 3338 getqflist() *getqflist()* |
| 3339 Returns a list with all the current quickfix errors. Each | |
| 3340 list item is a dictionary with these entries: | |
| 3341 bufnr number of buffer that has the file name, use | |
| 3342 bufname() to get the name | |
| 3343 lnum line number in the buffer (first line is 1) | |
| 3344 col column number (first column is 1) | |
| 233 | 3345 vcol non-zero: "col" is visual column |
| 3346 zero: "col" is byte index | |
| 230 | 3347 nr error number |
| 1065 | 3348 pattern search pattern used to locate the error |
| 230 | 3349 text description of the error |
| 3350 type type of the error, 'E', '1', etc. | |
| 3351 valid non-zero: recognized error message | |
| 3352 | |
| 515 | 3353 When there is no error list or it's empty an empty list is |
| 1065 | 3354 returned. Quickfix list entries with non-existing buffer |
| 3355 number are returned with "bufnr" set to zero. | |
| 515 | 3356 |
| 230 | 3357 Useful application: Find pattern matches in multiple files and |
| 3358 do something with them: > | |
| 3359 :vimgrep /theword/jg *.c | |
| 3360 :for d in getqflist() | |
| 3361 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
| 3362 :endfor | |
| 3363 | |
| 3364 | |
| 282 | 3365 getreg([{regname} [, 1]]) *getreg()* |
| 7 | 3366 The result is a String, which is the contents of register |
| 236 | 3367 {regname}. Example: > |
| 7 | 3368 :let cliptext = getreg('*') |
| 3369 < getreg('=') returns the last evaluated value of the expression | |
| 236 | 3370 register. (For use in maps.) |
| 282 | 3371 getreg('=', 1) returns the expression itself, so that it can |
| 3372 be restored with |setreg()|. For other registers the extra | |
| 3373 argument is ignored, thus you can always give it. | |
| 7 | 3374 If {regname} is not specified, |v:register| is used. |
| 3375 | |
| 82 | 3376 |
| 7 | 3377 getregtype([{regname}]) *getregtype()* |
| 3378 The result is a String, which is type of register {regname}. | |
| 3379 The value will be one of: | |
| 3380 "v" for |characterwise| text | |
| 3381 "V" for |linewise| text | |
| 3382 "<CTRL-V>{width}" for |blockwise-visual| text | |
| 3383 0 for an empty or unknown register | |
| 3384 <CTRL-V> is one character with value 0x16. | |
| 3385 If {regname} is not specified, |v:register| is used. | |
| 3386 | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3387 gettabvar({tabnr}, {varname}) *gettabvar()* |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3388 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
|
3389 {tabnr}. |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3390 Tabs are numbered starting with one. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3391 Note that the name without "t:" must be used. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
3392 |
| 831 | 3393 gettabwinvar({tabnr}, {winnr}, {varname}) *gettabwinvar()* |
| 1156 | 3394 Get the value of window-local variable {varname} in window |
| 3395 {winnr} in tab page {tabnr}. | |
| 3396 When {varname} starts with "&" get the value of a window-local | |
| 3397 option. | |
| 831 | 3398 Tabs are numbered starting with one. For the current tabpage |
| 3399 use |getwinvar()|. | |
| 3400 When {winnr} is zero the current window is used. | |
| 3401 This also works for a global option, buffer-local option and | |
| 3402 window-local option, but it doesn't work for a global variable | |
| 3403 or buffer-local variable. | |
| 1156 | 3404 When {varname} is empty a dictionary with all window-local |
| 3405 variables is returned. | |
| 3406 Note that {varname} must be the name without "w:". | |
| 831 | 3407 Examples: > |
| 3408 :let list_is_on = gettabwinvar(1, 2, '&list') | |
| 3409 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
| 1266 | 3410 < |
| 7 | 3411 *getwinposx()* |
| 3412 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
| 3413 the left hand side of the GUI Vim window. The result will be | |
| 3414 -1 if the information is not available. | |
| 3415 | |
| 3416 *getwinposy()* | |
| 3417 getwinposy() The result is a Number, which is the Y coordinate in pixels of | |
| 1621 | 3418 the top of the GUI Vim window. The result will be -1 if the |
| 7 | 3419 information is not available. |
| 3420 | |
| 831 | 3421 getwinvar({winnr}, {varname}) *getwinvar()* |
| 3422 Like |gettabwinvar()| for the current tabpage. | |
| 7 | 3423 Examples: > |
| 3424 :let list_is_on = getwinvar(2, '&list') | |
| 3425 :echo "myvar = " . getwinvar(1, 'myvar') | |
| 3426 < | |
| 1754 | 3427 glob({expr} [, {flag}]) *glob()* |
| 3428 Expand the file wildcards in {expr}. See |wildcards| for the | |
| 1156 | 3429 use of special characters. |
| 3430 The result is a String. | |
| 7 | 3431 When there are several matches, they are separated by <NL> |
| 3432 characters. | |
| 1754 | 3433 Unless the optional {flag} argument is given and is non-zero, |
| 3434 the 'suffixes' and 'wildignore' options apply: Names matching | |
| 3435 one of the patterns in 'wildignore' will be skipped and | |
| 3436 'suffixes' affect the ordering of matches. | |
| 7 | 3437 If the expansion fails, the result is an empty string. |
| 3438 A name for a non-existing file is not included. | |
| 3439 | |
| 3440 For most systems backticks can be used to get files names from | |
| 3441 any external command. Example: > | |
| 3442 :let tagfiles = glob("`find . -name tags -print`") | |
| 3443 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
| 3444 < The result of the program inside the backticks should be one | |
| 1621 | 3445 item per line. Spaces inside an item are allowed. |
| 7 | 3446 |
| 3447 See |expand()| for expanding special Vim variables. See | |
| 3448 |system()| for getting the raw output of an external command. | |
| 3449 | |
| 1754 | 3450 globpath({path}, {expr} [, {flag}]) *globpath()* |
| 7 | 3451 Perform glob() on all directories in {path} and concatenate |
| 3452 the results. Example: > | |
| 3453 :echo globpath(&rtp, "syntax/c.vim") | |
| 3454 < {path} is a comma-separated list of directory names. Each | |
| 3455 directory name is prepended to {expr} and expanded like with | |
| 1754 | 3456 |glob()|. A path separator is inserted when needed. |
| 7 | 3457 To add a comma inside a directory name escape it with a |
| 3458 backslash. Note that on MS-Windows a directory may have a | |
| 3459 trailing backslash, remove it if you put a comma after it. | |
| 3460 If the expansion fails for one of the directories, there is no | |
| 3461 error message. | |
| 1754 | 3462 Unless the optional {flag} argument is given and is non-zero, |
| 3463 the 'suffixes' and 'wildignore' options apply: Names matching | |
| 3464 one of the patterns in 'wildignore' will be skipped and | |
| 3465 'suffixes' affect the ordering of matches. | |
| 7 | 3466 |
| 444 | 3467 The "**" item can be used to search in a directory tree. |
| 3468 For example, to find all "README.txt" files in the directories | |
| 3469 in 'runtimepath' and below: > | |
| 3470 :echo globpath(&rtp, "**/README.txt") | |
| 1668 | 3471 < Upwards search and limiting the depth of "**" is not |
| 3472 supported, thus using 'path' will not always work properly. | |
| 3473 | |
| 7 | 3474 *has()* |
| 3475 has({feature}) The result is a Number, which is 1 if the feature {feature} is | |
| 3476 supported, zero otherwise. The {feature} argument is a | |
| 3477 string. See |feature-list| below. | |
| 3478 Also see |exists()|. | |
| 3479 | |
| 102 | 3480 |
| 3481 has_key({dict}, {key}) *has_key()* | |
| 685 | 3482 The result is a Number, which is 1 if |Dictionary| {dict} has |
| 3483 an entry with key {key}. Zero otherwise. | |
| 102 | 3484 |
| 1104 | 3485 haslocaldir() *haslocaldir()* |
| 3486 The result is a Number, which is 1 when the current | |
| 1621 | 3487 window has set a local path via |:lcd|, and 0 otherwise. |
| 102 | 3488 |
| 782 | 3489 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
| 7 | 3490 The result is a Number, which is 1 if there is a mapping that |
| 3491 contains {what} in somewhere in the rhs (what it is mapped to) | |
| 3492 and this mapping exists in one of the modes indicated by | |
| 3493 {mode}. | |
| 782 | 3494 When {abbr} is there and it is non-zero use abbreviations |
| 786 | 3495 instead of mappings. Don't forget to specify Insert and/or |
| 3496 Command-line mode. | |
| 7 | 3497 Both the global mappings and the mappings local to the current |
| 3498 buffer are checked for a match. | |
| 3499 If no matching mapping is found 0 is returned. | |
| 3500 The following characters are recognized in {mode}: | |
| 3501 n Normal mode | |
| 3502 v Visual mode | |
| 3503 o Operator-pending mode | |
| 3504 i Insert mode | |
| 3505 l Language-Argument ("r", "f", "t", etc.) | |
| 3506 c Command-line mode | |
| 3507 When {mode} is omitted, "nvo" is used. | |
| 3508 | |
| 3509 This function is useful to check if a mapping already exists | |
| 1621 | 3510 to a function in a Vim script. Example: > |
| 7 | 3511 :if !hasmapto('\ABCdoit') |
| 3512 : map <Leader>d \ABCdoit | |
| 3513 :endif | |
| 3514 < This installs the mapping to "\ABCdoit" only if there isn't | |
| 3515 already a mapping to "\ABCdoit". | |
| 3516 | |
| 3517 histadd({history}, {item}) *histadd()* | |
| 3518 Add the String {item} to the history {history} which can be | |
| 3519 one of: *hist-names* | |
| 3520 "cmd" or ":" command line history | |
| 3521 "search" or "/" search pattern history | |
| 1621 | 3522 "expr" or "=" typed expression history |
| 7 | 3523 "input" or "@" input line history |
| 3524 If {item} does already exist in the history, it will be | |
| 3525 shifted to become the newest entry. | |
| 3526 The result is a Number: 1 if the operation was successful, | |
| 3527 otherwise 0 is returned. | |
| 3528 | |
| 3529 Example: > | |
| 3530 :call histadd("input", strftime("%Y %b %d")) | |
| 3531 :let date=input("Enter date: ") | |
| 3532 < This function is not available in the |sandbox|. | |
| 3533 | |
| 3534 histdel({history} [, {item}]) *histdel()* | |
| 236 | 3535 Clear {history}, i.e. delete all its entries. See |hist-names| |
| 7 | 3536 for the possible values of {history}. |
| 3537 | |
| 1668 | 3538 If the parameter {item} evaluates to a String, it is used as a |
| 3539 regular expression. All entries matching that expression will | |
| 3540 be removed from the history (if there are any). | |
| 7 | 3541 Upper/lowercase must match, unless "\c" is used |/\c|. |
| 1668 | 3542 If {item} evaluates to a Number, it will be interpreted as |
| 3543 an index, see |:history-indexing|. The respective entry will | |
| 3544 be removed if it exists. | |
| 7 | 3545 |
| 3546 The result is a Number: 1 for a successful operation, | |
| 3547 otherwise 0 is returned. | |
| 3548 | |
| 3549 Examples: | |
| 3550 Clear expression register history: > | |
| 3551 :call histdel("expr") | |
| 3552 < | |
| 3553 Remove all entries starting with "*" from the search history: > | |
| 3554 :call histdel("/", '^\*') | |
| 3555 < | |
| 3556 The following three are equivalent: > | |
| 3557 :call histdel("search", histnr("search")) | |
| 3558 :call histdel("search", -1) | |
| 3559 :call histdel("search", '^'.histget("search", -1).'$') | |
| 3560 < | |
| 3561 To delete the last search pattern and use the last-but-one for | |
| 3562 the "n" command and 'hlsearch': > | |
| 3563 :call histdel("search", -1) | |
| 3564 :let @/ = histget("search", -1) | |
| 3565 | |
| 3566 histget({history} [, {index}]) *histget()* | |
| 3567 The result is a String, the entry with Number {index} from | |
| 3568 {history}. See |hist-names| for the possible values of | |
| 3569 {history}, and |:history-indexing| for {index}. If there is | |
| 3570 no such entry, an empty String is returned. When {index} is | |
| 3571 omitted, the most recent item from the history is used. | |
| 3572 | |
| 3573 Examples: | |
| 3574 Redo the second last search from history. > | |
| 3575 :execute '/' . histget("search", -2) | |
| 3576 | |
| 3577 < Define an Ex command ":H {num}" that supports re-execution of | |
| 3578 the {num}th entry from the output of |:history|. > | |
| 3579 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
| 3580 < | |
| 3581 histnr({history}) *histnr()* | |
| 3582 The result is the Number of the current entry in {history}. | |
| 3583 See |hist-names| for the possible values of {history}. | |
| 3584 If an error occurred, -1 is returned. | |
| 3585 | |
| 3586 Example: > | |
| 3587 :let inp_index = histnr("expr") | |
| 3588 < | |
| 3589 hlexists({name}) *hlexists()* | |
| 3590 The result is a Number, which is non-zero if a highlight group | |
| 3591 called {name} exists. This is when the group has been | |
| 3592 defined in some way. Not necessarily when highlighting has | |
| 3593 been defined for it, it may also have been used for a syntax | |
| 3594 item. | |
| 3595 *highlight_exists()* | |
| 3596 Obsolete name: highlight_exists(). | |
| 3597 | |
| 3598 *hlID()* | |
| 3599 hlID({name}) The result is a Number, which is the ID of the highlight group | |
| 3600 with name {name}. When the highlight group doesn't exist, | |
| 3601 zero is returned. | |
| 3602 This can be used to retrieve information about the highlight | |
| 1621 | 3603 group. For example, to get the background color of the |
| 7 | 3604 "Comment" group: > |
| 3605 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
| 3606 < *highlightID()* | |
| 3607 Obsolete name: highlightID(). | |
| 3608 | |
| 3609 hostname() *hostname()* | |
| 3610 The result is a String, which is the name of the machine on | |
| 236 | 3611 which Vim is currently running. Machine names greater than |
| 7 | 3612 256 characters long are truncated. |
| 3613 | |
| 3614 iconv({expr}, {from}, {to}) *iconv()* | |
| 3615 The result is a String, which is the text {expr} converted | |
| 3616 from encoding {from} to encoding {to}. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3617 When the conversion completely fails an empty string is |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3618 returned. When some characters could not be converted they |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3619 are replaced with "?". |
| 7 | 3620 The encoding names are whatever the iconv() library function |
| 3621 can accept, see ":!man 3 iconv". | |
| 3622 Most conversions require Vim to be compiled with the |+iconv| | |
| 3623 feature. Otherwise only UTF-8 to latin1 conversion and back | |
| 3624 can be done. | |
| 3625 This can be used to display messages with special characters, | |
| 3626 no matter what 'encoding' is set to. Write the message in | |
| 3627 UTF-8 and use: > | |
| 3628 echo iconv(utf8_str, "utf-8", &enc) | |
| 3629 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
| 3630 from/to UCS-2 is automatically changed to use UTF-8. You | |
| 3631 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
|
3632 {only available when compiled with the |+multi_byte| feature} |
| 7 | 3633 |
| 3634 *indent()* | |
| 3635 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
| 3636 current buffer. The indent is counted in spaces, the value | |
| 3637 of 'tabstop' is relevant. {lnum} is used just like in | |
| 3638 |getline()|. | |
| 3639 When {lnum} is invalid -1 is returned. | |
| 3640 | |
| 79 | 3641 |
| 95 | 3642 index({list}, {expr} [, {start} [, {ic}]]) *index()* |
| 685 | 3643 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
|
3644 value equal to {expr}. There is no automatic conversion, so |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3645 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
|
3646 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
|
3647 is not used here, case always matters. |
| 153 | 3648 If {start} is given then start looking at the item with index |
| 3649 {start} (may be negative for an item relative to the end). | |
| 79 | 3650 When {ic} is given and it is non-zero, ignore case. Otherwise |
| 3651 case must match. | |
| 3652 -1 is returned when {expr} is not found in {list}. | |
| 3653 Example: > | |
| 3654 :let idx = index(words, "the") | |
| 87 | 3655 :if index(numbers, 123) >= 0 |
| 79 | 3656 |
| 3657 | |
| 531 | 3658 input({prompt} [, {text} [, {completion}]]) *input()* |
| 7 | 3659 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
|
3660 the command-line. The {prompt} argument is either a prompt |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3661 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
|
3662 in the prompt to start a new line. |
| 531 | 3663 The highlighting set with |:echohl| is used for the prompt. |
| 3664 The input is entered just like a command-line, with the same | |
| 1621 | 3665 editing commands and mappings. There is a separate history |
| 531 | 3666 for lines typed for input(). |
| 3667 Example: > | |
| 3668 :if input("Coffee or beer? ") == "beer" | |
| 3669 : echo "Cheers!" | |
| 3670 :endif | |
| 3671 < | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3672 If the optional {text} argument is present and not empty, this |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3673 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
|
3674 Example: > |
| 531 | 3675 :let color = input("Color? ", "white") |
| 3676 | |
| 3677 < The optional {completion} argument specifies the type of | |
| 3678 completion supported for the input. Without it completion is | |
| 1621 | 3679 not performed. The supported completion types are the same as |
| 531 | 3680 that can be supplied to a user-defined command using the |
| 1621 | 3681 "-complete=" argument. Refer to |:command-completion| for |
| 531 | 3682 more information. Example: > |
| 3683 let fname = input("File: ", "", "file") | |
| 3684 < | |
| 3685 NOTE: This function must not be used in a startup file, for | |
| 3686 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
| 7 | 3687 Note: When input() is called from within a mapping it will |
| 3688 consume remaining characters from that mapping, because a | |
| 3689 mapping is handled like the characters were typed. | |
| 3690 Use |inputsave()| before input() and |inputrestore()| | |
| 3691 after input() to avoid that. Another solution is to avoid | |
| 3692 that further characters follow in the mapping, e.g., by using | |
| 3693 |:execute| or |:normal|. | |
| 3694 | |
| 531 | 3695 Example with a mapping: > |
| 7 | 3696 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
| 3697 :function GetFoo() | |
| 3698 : call inputsave() | |
| 3699 : let g:Foo = input("enter search pattern: ") | |
| 3700 : call inputrestore() | |
| 3701 :endfunction | |
| 3702 | |
| 3703 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3704 Like |input()|, but when the GUI is running and text dialogs |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3705 are supported, a dialog window pops up to input the text. |
| 7 | 3706 Example: > |
| 3707 :let n = inputdialog("value for shiftwidth", &sw) | |
| 3708 :if n != "" | |
| 3709 : let &sw = n | |
| 3710 :endif | |
| 3711 < When the dialog is cancelled {cancelreturn} is returned. When | |
| 3712 omitted an empty string is returned. | |
| 3713 Hitting <Enter> works like pressing the OK button. Hitting | |
| 3714 <Esc> works like pressing the Cancel button. | |
| 531 | 3715 NOTE: Command-line completion is not supported. |
| 7 | 3716 |
| 519 | 3717 inputlist({textlist}) *inputlist()* |
| 819 | 3718 {textlist} must be a |List| of strings. This |List| is |
| 3719 displayed, one string per line. The user will be prompted to | |
| 3720 enter a number, which is returned. | |
| 519 | 3721 The user can also select an item by clicking on it with the |
| 1621 | 3722 mouse. For the first string 0 is returned. When clicking |
| 519 | 3723 above the first item a negative number is returned. When |
| 3724 clicking on the prompt one more than the length of {textlist} | |
| 3725 is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3726 Make sure {textlist} has less than 'lines' entries, otherwise |
| 1621 | 3727 it won't work. It's a good idea to put the entry number at |
| 1156 | 3728 the start of the string. And put a prompt in the first item. |
| 3729 Example: > | |
| 519 | 3730 let color = inputlist(['Select color:', '1. red', |
| 3731 \ '2. green', '3. blue']) | |
| 3732 | |
| 7 | 3733 inputrestore() *inputrestore()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3734 Restore typeahead that was saved with a previous |inputsave()|. |
| 7 | 3735 Should be called the same number of times inputsave() is |
| 3736 called. Calling it more often is harmless though. | |
| 3737 Returns 1 when there is nothing to restore, 0 otherwise. | |
| 3738 | |
| 3739 inputsave() *inputsave()* | |
| 3740 Preserve typeahead (also from mappings) and clear it, so that | |
| 3741 a following prompt gets input from the user. Should be | |
| 3742 followed by a matching inputrestore() after the prompt. Can | |
| 3743 be used several times, in which case there must be just as | |
| 3744 many inputrestore() calls. | |
| 3745 Returns 1 when out of memory, 0 otherwise. | |
| 3746 | |
| 3747 inputsecret({prompt} [, {text}]) *inputsecret()* | |
| 3748 This function acts much like the |input()| function with but | |
| 3749 two exceptions: | |
| 3750 a) the user's response will be displayed as a sequence of | |
| 3751 asterisks ("*") thereby keeping the entry secret, and | |
| 3752 b) the user's response will not be recorded on the input | |
| 3753 |history| stack. | |
| 3754 The result is a String, which is whatever the user actually | |
| 3755 typed on the command-line in response to the issued prompt. | |
| 531 | 3756 NOTE: Command-line completion is not supported. |
| 7 | 3757 |
| 55 | 3758 insert({list}, {item} [, {idx}]) *insert()* |
| 685 | 3759 Insert {item} at the start of |List| {list}. |
| 55 | 3760 If {idx} is specified insert {item} before the item with index |
| 1621 | 3761 {idx}. If {idx} is zero it goes before the first item, just |
| 55 | 3762 like omitting {idx}. A negative {idx} is also possible, see |
| 3763 |list-index|. -1 inserts just before the last item. | |
| 685 | 3764 Returns the resulting |List|. Examples: > |
| 55 | 3765 :let mylist = insert([2, 3, 5], 1) |
| 3766 :call insert(mylist, 4, -1) | |
| 3767 :call insert(mylist, 6, len(mylist)) | |
| 82 | 3768 < The last example can be done simpler with |add()|. |
| 685 | 3769 Note that when {item} is a |List| it is inserted as a single |
| 692 | 3770 item. Use |extend()| to concatenate |Lists|. |
| 55 | 3771 |
| 7 | 3772 isdirectory({directory}) *isdirectory()* |
| 3773 The result is a Number, which is non-zero when a directory | |
| 3774 with the name {directory} exists. If {directory} doesn't | |
| 3775 exist, or isn't a directory, the result is FALSE. {directory} | |
| 3776 is any expression, which is used as a String. | |
| 3777 | |
| 819 | 3778 islocked({expr}) *islocked()* *E786* |
| 148 | 3779 The result is a Number, which is non-zero when {expr} is the |
| 3780 name of a locked variable. | |
| 685 | 3781 {expr} must be the name of a variable, |List| item or |
| 3782 |Dictionary| entry, not the variable itself! Example: > | |
| 148 | 3783 :let alist = [0, ['a', 'b'], 2, 3] |
| 3784 :lockvar 1 alist | |
| 3785 :echo islocked('alist') " 1 | |
| 3786 :echo islocked('alist[1]') " 0 | |
| 3787 | |
| 3788 < When {expr} is a variable that does not exist you get an error | |
| 843 | 3789 message. Use |exists()| to check for existence. |
| 148 | 3790 |
| 140 | 3791 items({dict}) *items()* |
| 685 | 3792 Return a |List| with all the key-value pairs of {dict}. Each |
| 3793 |List| item is a list with two items: the key of a {dict} | |
| 3794 entry and the value of this entry. The |List| is in arbitrary | |
| 3795 order. | |
| 140 | 3796 |
| 95 | 3797 |
| 3798 join({list} [, {sep}]) *join()* | |
| 3799 Join the items in {list} together into one String. | |
| 3800 When {sep} is specified it is put in between the items. If | |
| 3801 {sep} is omitted a single space is used. | |
| 3802 Note that {sep} is not added at the end. You might want to | |
| 3803 add it there too: > | |
| 3804 let lines = join(mylist, "\n") . "\n" | |
| 692 | 3805 < String items are used as-is. |Lists| and |Dictionaries| are |
| 95 | 3806 converted into a string like with |string()|. |
| 3807 The opposite function is |split()|. | |
| 3808 | |
| 99 | 3809 keys({dict}) *keys()* |
| 685 | 3810 Return a |List| with all the keys of {dict}. The |List| is in |
| 99 | 3811 arbitrary order. |
| 3812 | |
| 85 | 3813 *len()* *E701* |
| 55 | 3814 len({expr}) The result is a Number, which is the length of the argument. |
| 3815 When {expr} is a String or a Number the length in bytes is | |
| 3816 used, as with |strlen()|. | |
| 685 | 3817 When {expr} is a |List| the number of items in the |List| is |
| 55 | 3818 returned. |
| 685 | 3819 When {expr} is a |Dictionary| the number of entries in the |
| 3820 |Dictionary| is returned. | |
| 55 | 3821 Otherwise an error is given. |
| 3822 | |
| 7 | 3823 *libcall()* *E364* *E368* |
| 3824 libcall({libname}, {funcname}, {argument}) | |
| 3825 Call function {funcname} in the run-time library {libname} | |
| 3826 with single argument {argument}. | |
| 3827 This is useful to call functions in a library that you | |
| 3828 especially made to be used with Vim. Since only one argument | |
| 3829 is possible, calling standard library functions is rather | |
| 3830 limited. | |
| 3831 The result is the String returned by the function. If the | |
| 3832 function returns NULL, this will appear as an empty string "" | |
| 3833 to Vim. | |
| 3834 If the function returns a number, use libcallnr()! | |
| 3835 If {argument} is a number, it is passed to the function as an | |
| 3836 int; if {argument} is a string, it is passed as a | |
| 3837 null-terminated string. | |
| 3838 This function will fail in |restricted-mode|. | |
| 3839 | |
| 3840 libcall() allows you to write your own 'plug-in' extensions to | |
| 3841 Vim without having to recompile the program. It is NOT a | |
| 3842 means to call system functions! If you try to do so Vim will | |
| 3843 very probably crash. | |
| 3844 | |
| 3845 For Win32, the functions you write must be placed in a DLL | |
| 3846 and use the normal C calling convention (NOT Pascal which is | |
| 3847 used in Windows System DLLs). The function must take exactly | |
| 3848 one parameter, either a character pointer or a long integer, | |
| 3849 and must return a character pointer or NULL. The character | |
| 3850 pointer returned must point to memory that will remain valid | |
| 3851 after the function has returned (e.g. in static data in the | |
| 3852 DLL). If it points to allocated memory, that memory will | |
| 3853 leak away. Using a static buffer in the function should work, | |
| 3854 it's then freed when the DLL is unloaded. | |
| 3855 | |
| 3856 WARNING: If the function returns a non-valid pointer, Vim may | |
| 1621 | 3857 crash! This also happens if the function returns a number, |
| 7 | 3858 because Vim thinks it's a pointer. |
| 3859 For Win32 systems, {libname} should be the filename of the DLL | |
| 3860 without the ".DLL" suffix. A full path is only required if | |
| 3861 the DLL is not in the usual places. | |
| 3862 For Unix: When compiling your own plugins, remember that the | |
| 3863 object code must be compiled as position-independent ('PIC'). | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3864 {only in Win32 and some Unix versions, when the |+libcall| |
| 7 | 3865 feature is present} |
| 3866 Examples: > | |
| 3867 :echo libcall("libc.so", "getenv", "HOME") | |
| 3868 < | |
| 3869 *libcallnr()* | |
| 3870 libcallnr({libname}, {funcname}, {argument}) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3871 Just like |libcall()|, but used for a function that returns an |
| 7 | 3872 int instead of a string. |
| 3873 {only in Win32 on some Unix versions, when the |+libcall| | |
| 3874 feature is present} | |
| 1621 | 3875 Examples: > |
| 3876 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
| 7 | 3877 :call libcallnr("libc.so", "printf", "Hello World!\n") |
| 3878 :call libcallnr("libc.so", "sleep", 10) | |
| 3879 < | |
| 3880 *line()* | |
| 3881 line({expr}) The result is a Number, which is the line number of the file | |
| 3882 position given with {expr}. The accepted positions are: | |
| 3883 . the cursor position | |
| 3884 $ the last line in the current buffer | |
| 3885 'x position of mark x (if the mark is not set, 0 is | |
| 3886 returned) | |
| 665 | 3887 w0 first line visible in current window |
| 3888 w$ last line visible in current window | |
| 1609 | 3889 v In Visual mode: the start of the Visual area (the |
| 3890 cursor is the end). When not in Visual mode | |
| 3891 returns the cursor position. Differs from |'<| in | |
| 3892 that it's updated right away. | |
| 1156 | 3893 Note that a mark in another file can be used. The line number |
| 3894 then applies to another buffer. | |
| 703 | 3895 To get the column number use |col()|. To get both use |
| 3896 |getpos()|. | |
| 7 | 3897 Examples: > |
| 3898 line(".") line number of the cursor | |
| 3899 line("'t") line number of mark t | |
| 3900 line("'" . marker) line number of mark marker | |
| 3901 < *last-position-jump* | |
| 3902 This autocommand jumps to the last known position in a file | |
| 3903 just after opening it, if the '" mark is set: > | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3904 :au BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g`\"" | endif |
| 9 | 3905 |
| 7 | 3906 line2byte({lnum}) *line2byte()* |
| 3907 Return the byte count from the start of the buffer for line | |
| 3908 {lnum}. This includes the end-of-line character, depending on | |
| 3909 the 'fileformat' option for the current buffer. The first | |
| 3910 line returns 1. | |
| 3911 This can also be used to get the byte count for the line just | |
| 3912 below the last line: > | |
| 3913 line2byte(line("$") + 1) | |
| 3914 < This is the file size plus one. | |
| 3915 When {lnum} is invalid, or the |+byte_offset| feature has been | |
| 3916 disabled at compile time, -1 is returned. | |
| 3917 Also see |byte2line()|, |go| and |:goto|. | |
| 3918 | |
| 3919 lispindent({lnum}) *lispindent()* | |
| 3920 Get the amount of indent for line {lnum} according the lisp | |
| 3921 indenting rules, as with 'lisp'. | |
| 3922 The indent is counted in spaces, the value of 'tabstop' is | |
| 3923 relevant. {lnum} is used just like in |getline()|. | |
| 3924 When {lnum} is invalid or Vim was not compiled the | |
| 3925 |+lispindent| feature, -1 is returned. | |
| 3926 | |
| 3927 localtime() *localtime()* | |
| 3928 Return the current time, measured as seconds since 1st Jan | |
| 3929 1970. See also |strftime()| and |getftime()|. | |
| 3930 | |
| 95 | 3931 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3932 log({expr}) *log()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3933 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
|
3934 {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
|
3935 (0, inf]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3936 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3937 :echo log(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3938 < 2.302585 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3939 :echo log(exp(5)) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3940 < 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
|
3941 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3942 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3943 |
| 1621 | 3944 log10({expr}) *log10()* |
| 3945 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
| 3946 {expr} must evaluate to a |Float| or a |Number|. | |
| 3947 Examples: > | |
| 3948 :echo log10(1000) | |
| 3949 < 3.0 > | |
| 3950 :echo log10(0.01) | |
| 3951 < -2.0 | |
| 3952 {only available when compiled with the |+float| feature} | |
| 3953 | |
| 102 | 3954 map({expr}, {string}) *map()* |
| 685 | 3955 {expr} must be a |List| or a |Dictionary|. |
| 102 | 3956 Replace each item in {expr} with the result of evaluating |
| 3957 {string}. | |
| 3958 Inside {string} |v:val| has the value of the current item. | |
| 1998 | 3959 For a |Dictionary| |v:key| has the key of the current item |
| 3960 and for a |List| |v:key| has the index of the current item. | |
| 102 | 3961 Example: > |
| 3962 :call map(mylist, '"> " . v:val . " <"') | |
| 95 | 3963 < This puts "> " before and " <" after each item in "mylist". |
| 102 | 3964 |
| 158 | 3965 Note that {string} is the result of an expression and is then |
| 102 | 3966 used as an expression again. Often it is good to use a |
| 158 | 3967 |literal-string| to avoid having to double backslashes. You |
| 3968 still have to double ' quotes | |
| 102 | 3969 |
| 685 | 3970 The operation is done in-place. If you want a |List| or |
| 3971 |Dictionary| to remain unmodified make a copy first: > | |
| 99 | 3972 :let tlist = map(copy(mylist), ' & . "\t"') |
| 102 | 3973 |
| 685 | 3974 < Returns {expr}, the |List| or |Dictionary| that was filtered. |
| 648 | 3975 When an error is encountered while evaluating {string} no |
| 3976 further items in {expr} are processed. | |
| 95 | 3977 |
| 3978 | |
| 2610 | 3979 maparg({name}[, {mode} [, {abbr} [, {dict}]]]) *maparg()* |
| 3980 When {dict} is omitted or zero: Return the rhs of mapping | |
| 3981 {name} in mode {mode}. The returned String has special | |
| 3982 characters translated like in the output of the ":map" command | |
| 3983 listing. | |
| 3984 | |
| 3985 When there is no mapping for {name}, an empty String is | |
| 3986 returned. | |
| 3987 | |
| 3988 The {name} can have special key names, like in the ":map" | |
| 3989 command. | |
| 3990 | |
| 644 | 3991 {mode} can be one of these strings: |
| 7 | 3992 "n" Normal |
| 2610 | 3993 "v" Visual (including Select) |
| 7 | 3994 "o" Operator-pending |
| 3995 "i" Insert | |
| 3996 "c" Cmd-line | |
| 2610 | 3997 "s" Select |
| 3998 "x" Visual | |
| 7 | 3999 "l" langmap |language-mapping| |
| 4000 "" Normal, Visual and Operator-pending | |
| 644 | 4001 When {mode} is omitted, the modes for "" are used. |
| 2610 | 4002 |
| 782 | 4003 When {abbr} is there and it is non-zero use abbreviations |
| 4004 instead of mappings. | |
| 2610 | 4005 |
| 4006 When {dict} is there and it is non-zero return a dictionary | |
| 4007 containing all the information of the mapping with the | |
| 4008 following items: | |
| 4009 "lhs" The {lhs} of the mapping. | |
| 4010 "rhs" The {rhs} of the mapping as typed. | |
| 4011 "silent" 1 for a |:map-silent| mapping, else 0. | |
| 4012 "noremap" 1 if the {rhs} of the mapping is remappable. | |
| 4013 "expr" 1 for an expression mapping (|:map-<expr>|). | |
| 4014 "buffer" 1 for a buffer local mapping (|:map-local|). | |
| 4015 "mode" Modes for which the mapping is defined. In | |
| 4016 addition to the modes mentioned above, these | |
| 4017 characters will be used: | |
| 4018 " " Normal, Visual and Operator-pending | |
| 4019 "!" Insert and Commandline mode | |
| 4020 (|mapmpde-ic|) | |
| 4021 "sid" the Script local ID, used for <sid> mappings | |
| 4022 (|<SID>|) | |
| 4023 | |
| 7 | 4024 The mappings local to the current buffer are checked first, |
| 4025 then the global mappings. | |
| 626 | 4026 This function can be used to map a key even when it's already |
| 4027 mapped, and have it do the original mapping too. Sketch: > | |
| 4028 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
| 4029 | |
| 7 | 4030 |
| 782 | 4031 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()* |
| 7 | 4032 Check if there is a mapping that matches with {name} in mode |
| 4033 {mode}. See |maparg()| for {mode} and special names in | |
| 4034 {name}. | |
| 782 | 4035 When {abbr} is there and it is non-zero use abbreviations |
| 4036 instead of mappings. | |
| 7 | 4037 A match happens with a mapping that starts with {name} and |
| 4038 with a mapping which is equal to the start of {name}. | |
| 4039 | |
| 1621 | 4040 matches mapping "a" "ab" "abc" ~ |
| 7 | 4041 mapcheck("a") yes yes yes |
| 4042 mapcheck("abc") yes yes yes | |
| 4043 mapcheck("ax") yes no no | |
| 4044 mapcheck("b") no no no | |
| 4045 | |
| 4046 The difference with maparg() is that mapcheck() finds a | |
| 4047 mapping that matches with {name}, while maparg() only finds a | |
| 4048 mapping for {name} exactly. | |
| 4049 When there is no mapping that starts with {name}, an empty | |
| 4050 String is returned. If there is one, the rhs of that mapping | |
| 4051 is returned. If there are several mappings that start with | |
| 4052 {name}, the rhs of one of them is returned. | |
| 4053 The mappings local to the current buffer are checked first, | |
| 4054 then the global mappings. | |
| 4055 This function can be used to check if a mapping can be added | |
| 4056 without being ambiguous. Example: > | |
| 4057 :if mapcheck("_vv") == "" | |
| 4058 : map _vv :set guifont=7x13<CR> | |
| 4059 :endif | |
| 4060 < This avoids adding the "_vv" mapping when there already is a | |
| 4061 mapping for "_v" or for "_vvv". | |
| 4062 | |
| 19 | 4063 match({expr}, {pat}[, {start}[, {count}]]) *match()* |
| 685 | 4064 When {expr} is a |List| then this returns the index of the |
| 4065 first item where {pat} matches. Each item is used as a | |
| 692 | 4066 String, |Lists| and |Dictionaries| are used as echoed. |
| 1621 | 4067 Otherwise, {expr} is used as a String. The result is a |
| 95 | 4068 Number, which gives the index (byte offset) in {expr} where |
| 4069 {pat} matches. | |
| 685 | 4070 A match at the first character or |List| item returns zero. |
| 19 | 4071 If there is no match -1 is returned. |
| 4072 Example: > | |
| 95 | 4073 :echo match("testing", "ing") " results in 4 |
| 714 | 4074 :echo match([1, 'x'], '\a') " results in 1 |
| 95 | 4075 < See |string-match| for how {pat} is used. |
| 170 | 4076 *strpbrk()* |
| 1621 | 4077 Vim doesn't have a strpbrk() function. But you can do: > |
| 170 | 4078 :let sepidx = match(line, '[.,;: \t]') |
| 4079 < *strcasestr()* | |
| 4080 Vim doesn't have a strcasestr() function. But you can add | |
| 4081 "\c" to the pattern to ignore case: > | |
| 4082 :let idx = match(haystack, '\cneedle') | |
| 4083 < | |
| 95 | 4084 If {start} is given, the search starts from byte index |
| 685 | 4085 {start} in a String or item {start} in a |List|. |
| 7 | 4086 The result, however, is still the index counted from the |
| 236 | 4087 first character/item. Example: > |
| 7 | 4088 :echo match("testing", "ing", 2) |
| 4089 < result is again "4". > | |
| 4090 :echo match("testing", "ing", 4) | |
| 4091 < result is again "4". > | |
| 4092 :echo match("testing", "t", 2) | |
| 4093 < result is "3". | |
| 694 | 4094 For a String, if {start} > 0 then it is like the string starts |
| 703 | 4095 {start} bytes later, thus "^" will match at {start}. Except |
| 4096 when {count} is given, then it's like matches before the | |
| 4097 {start} byte are ignored (this is a bit complicated to keep it | |
| 4098 backwards compatible). | |
| 95 | 4099 For a String, if {start} < 0, it will be set to 0. For a list |
| 4100 the index is counted from the end. | |
| 697 | 4101 If {start} is out of range ({start} > strlen({expr}) for a |
| 4102 String or {start} > len({expr}) for a |List|) -1 is returned. | |
| 95 | 4103 |
| 694 | 4104 When {count} is given use the {count}'th match. When a match |
| 697 | 4105 is found in a String the search for the next one starts one |
| 694 | 4106 character further. Thus this example results in 1: > |
| 4107 echo match("testing", "..", 0, 2) | |
| 4108 < In a |List| the search continues in the next item. | |
| 703 | 4109 Note that when {count} is added the way {start} works changes, |
| 4110 see above. | |
| 694 | 4111 |
| 7 | 4112 See |pattern| for the patterns that are accepted. |
| 4113 The 'ignorecase' option is used to set the ignore-caseness of | |
| 1621 | 4114 the pattern. 'smartcase' is NOT used. The matching is always |
| 7 | 4115 done like 'magic' is set and 'cpoptions' is empty. |
| 4116 | |
| 1326 | 4117 *matchadd()* *E798* *E799* *E801* |
| 4118 matchadd({group}, {pattern}[, {priority}[, {id}]]) | |
| 4119 Defines a pattern to be highlighted in the current window (a | |
| 4120 "match"). It will be highlighted with {group}. Returns an | |
| 4121 identification number (ID), which can be used to delete the | |
| 4122 match using |matchdelete()|. | |
| 4123 | |
| 4124 The optional {priority} argument assigns a priority to the | |
| 1621 | 4125 match. A match with a high priority will have its |
| 1326 | 4126 highlighting overrule that of a match with a lower priority. |
| 4127 A priority is specified as an integer (negative numbers are no | |
| 4128 exception). If the {priority} argument is not specified, the | |
| 4129 default priority is 10. The priority of 'hlsearch' is zero, | |
| 4130 hence all matches with a priority greater than zero will | |
| 4131 overrule it. Syntax highlighting (see 'syntax') is a separate | |
| 4132 mechanism, and regardless of the chosen priority a match will | |
| 4133 always overrule syntax highlighting. | |
| 4134 | |
| 4135 The optional {id} argument allows the request for a specific | |
| 4136 match ID. If a specified ID is already taken, an error | |
| 4137 message will appear and the match will not be added. An ID | |
| 4138 is specified as a positive integer (zero excluded). IDs 1, 2 | |
| 4139 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
| 4140 respectively. If the {id} argument is not specified, | |
| 4141 |matchadd()| automatically chooses a free ID. | |
| 4142 | |
| 4143 The number of matches is not limited, as it is the case with | |
| 4144 the |:match| commands. | |
| 4145 | |
| 4146 Example: > | |
| 4147 :highlight MyGroup ctermbg=green guibg=green | |
| 4148 :let m = matchadd("MyGroup", "TODO") | |
| 4149 < Deletion of the pattern: > | |
| 4150 :call matchdelete(m) | |
| 4151 | |
| 4152 < A list of matches defined by |matchadd()| and |:match| are | |
| 1621 | 4153 available from |getmatches()|. All matches can be deleted in |
| 1326 | 4154 one operation by |clearmatches()|. |
| 819 | 4155 |
| 4156 matcharg({nr}) *matcharg()* | |
| 856 | 4157 Selects the {nr} match item, as set with a |:match|, |
| 819 | 4158 |:2match| or |:3match| command. |
| 4159 Return a |List| with two elements: | |
| 4160 The name of the highlight group used | |
| 4161 The pattern used. | |
| 4162 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
| 4163 When there is no match item set returns ['', '']. | |
| 1326 | 4164 This is useful to save and restore a |:match|. |
| 4165 Highlighting matches using the |:match| commands are limited | |
| 4166 to three matches. |matchadd()| does not have this limitation. | |
| 4167 | |
| 4168 matchdelete({id}) *matchdelete()* *E802* *E803* | |
| 4169 Deletes a match with ID {id} previously defined by |matchadd()| | |
| 1621 | 4170 or one of the |:match| commands. Returns 0 if successful, |
| 1326 | 4171 otherwise -1. See example for |matchadd()|. All matches can |
| 4172 be deleted in one operation by |clearmatches()|. | |
| 819 | 4173 |
| 19 | 4174 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4175 Same as |match()|, but return the index of first character |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4176 after the match. Example: > |
| 7 | 4177 :echo matchend("testing", "ing") |
| 4178 < results in "7". | |
| 170 | 4179 *strspn()* *strcspn()* |
| 4180 Vim doesn't have a strspn() or strcspn() function, but you can | |
| 4181 do it with matchend(): > | |
| 4182 :let span = matchend(line, '[a-zA-Z]') | |
| 4183 :let span = matchend(line, '[^a-zA-Z]') | |
| 4184 < Except that -1 is returned when there are no matches. | |
| 4185 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4186 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 4187 :echo matchend("testing", "ing", 2) |
| 4188 < results in "7". > | |
| 4189 :echo matchend("testing", "ing", 5) | |
| 4190 < result is "-1". | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4191 When {expr} is a |List| the result is equal to |match()|. |
| 7 | 4192 |
| 158 | 4193 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4194 Same as |match()|, but return a |List|. The first item in the |
| 158 | 4195 list is the matched string, same as what matchstr() would |
| 4196 return. Following items are submatches, like "\1", "\2", etc. | |
| 842 | 4197 in |:substitute|. When an optional submatch didn't match an |
| 4198 empty string is used. Example: > | |
| 4199 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
| 4200 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
| 158 | 4201 When there is no match an empty list is returned. |
| 4202 | |
| 19 | 4203 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()* |
| 1621 | 4204 Same as |match()|, but return the matched string. Example: > |
| 7 | 4205 :echo matchstr("testing", "ing") |
| 4206 < results in "ing". | |
| 4207 When there is no match "" is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4208 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 4209 :echo matchstr("testing", "ing", 2) |
| 4210 < results in "ing". > | |
| 4211 :echo matchstr("testing", "ing", 5) | |
| 4212 < result is "". | |
| 685 | 4213 When {expr} is a |List| then the matching item is returned. |
| 95 | 4214 The type isn't changed, it's not necessarily a String. |
| 7 | 4215 |
| 87 | 4216 *max()* |
| 4217 max({list}) Return the maximum value of all items in {list}. | |
| 4218 If {list} is not a list or one of the items in {list} cannot | |
| 4219 be used as a Number this results in an error. | |
| 685 | 4220 An empty |List| results in zero. |
| 87 | 4221 |
| 4222 *min()* | |
| 1215 | 4223 min({list}) Return the minimum value of all items in {list}. |
| 87 | 4224 If {list} is not a list or one of the items in {list} cannot |
| 4225 be used as a Number this results in an error. | |
| 685 | 4226 An empty |List| results in zero. |
| 87 | 4227 |
| 843 | 4228 *mkdir()* *E739* |
| 168 | 4229 mkdir({name} [, {path} [, {prot}]]) |
| 4230 Create directory {name}. | |
| 4231 If {path} is "p" then intermediate directories are created as | |
| 4232 necessary. Otherwise it must be "". | |
| 4233 If {prot} is given it is used to set the protection bits of | |
| 4234 the new directory. The default is 0755 (rwxr-xr-x: r/w for | |
| 1621 | 4235 the user readable for others). Use 0700 to make it unreadable |
| 1702 | 4236 for others. This is only used for the last part of {name}. |
| 4237 Thus if you create /tmp/foo/bar then /tmp/foo will be created | |
| 4238 with 0755. | |
| 4239 Example: > | |
| 4240 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700) | |
| 4241 < This function is not available in the |sandbox|. | |
| 168 | 4242 Not available on all systems. To check use: > |
| 4243 :if exists("*mkdir") | |
| 4244 < | |
| 7 | 4245 *mode()* |
| 1621 | 4246 mode([expr]) Return a string that indicates the current mode. |
| 1661 | 4247 If [expr] is supplied and it evaluates to a non-zero Number or |
| 4248 a non-empty String (|non-zero-arg|), then the full mode is | |
| 4249 returned, otherwise only the first letter is returned. Note | |
| 4250 that " " and "0" are also non-empty strings. | |
| 1621 | 4251 |
| 7 | 4252 n Normal |
| 1621 | 4253 no Operator-pending |
| 7 | 4254 v Visual by character |
| 4255 V Visual by line | |
| 4256 CTRL-V Visual blockwise | |
| 4257 s Select by character | |
| 4258 S Select by line | |
| 4259 CTRL-S Select blockwise | |
| 4260 i Insert | |
| 1621 | 4261 R Replace |R| |
| 4262 Rv Virtual Replace |gR| | |
| 7 | 4263 c Command-line |
| 1621 | 4264 cv Vim Ex mode |gQ| |
| 4265 ce Normal Ex mode |Q| | |
| 7 | 4266 r Hit-enter prompt |
| 1621 | 4267 rm The -- more -- prompt |
| 4268 r? A |:confirm| query of some sort | |
| 4269 ! Shell or external command is executing | |
| 4270 This is useful in the 'statusline' option or when used | |
| 4271 with |remote_expr()| In most other places it always returns | |
| 4272 "c" or "n". | |
| 4273 Also see |visualmode()|. | |
| 7 | 4274 |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4275 mzeval({expr}) *mzeval()* |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4276 Evaluate MzScheme expression {expr} and return its result |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4277 convert to Vim data structures. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4278 Numbers and strings are returned as they are. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4279 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
|
4280 returned as Vim |Lists|. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4281 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
|
4282 converted to strings. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4283 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
|
4284 Examples: > |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4285 :mz (define l (list 1 2 3)) |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4286 :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
|
4287 :echo mzeval("l") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4288 :echo mzeval("h") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4289 < |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4290 {only available when compiled with the |+mzscheme| feature} |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
4291 |
| 7 | 4292 nextnonblank({lnum}) *nextnonblank()* |
| 4293 Return the line number of the first line at or below {lnum} | |
| 4294 that is not blank. Example: > | |
| 4295 if getline(nextnonblank(1)) =~ "Java" | |
| 4296 < When {lnum} is invalid or there is no non-blank line at or | |
| 4297 below it, zero is returned. | |
| 4298 See also |prevnonblank()|. | |
| 4299 | |
| 4300 nr2char({expr}) *nr2char()* | |
| 4301 Return a string with a single character, which has the number | |
| 4302 value {expr}. Examples: > | |
| 4303 nr2char(64) returns "@" | |
| 4304 nr2char(32) returns " " | |
| 4305 < The current 'encoding' is used. Example for "utf-8": > | |
| 4306 nr2char(300) returns I with bow character | |
| 4307 < Note that a NUL character in the file is specified with | |
| 4308 nr2char(10), because NULs are represented with newline | |
| 4309 characters. nr2char(0) is a real NUL and terminates the | |
| 119 | 4310 string, thus results in an empty string. |
| 7 | 4311 |
| 1548 | 4312 *getpid()* |
| 4313 getpid() Return a Number which is the process ID of the Vim process. | |
| 1621 | 4314 On Unix and MS-Windows this is a unique number, until Vim |
| 4315 exits. On MS-DOS it's always zero. | |
| 1548 | 4316 |
| 703 | 4317 *getpos()* |
| 707 | 4318 getpos({expr}) Get the position for {expr}. For possible values of {expr} |
| 4319 see |line()|. | |
| 4320 The result is a |List| with four numbers: | |
| 4321 [bufnum, lnum, col, off] | |
| 4322 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
| 4323 is the buffer number of the mark. | |
| 4324 "lnum" and "col" are the position in the buffer. The first | |
| 4325 column is 1. | |
| 703 | 4326 The "off" number is zero, unless 'virtualedit' is used. Then |
| 4327 it is the offset in screen columns from the start of the | |
| 1266 | 4328 character. E.g., a position within a <Tab> or after the last |
| 703 | 4329 character. |
| 4330 This can be used to save and restore the cursor position: > | |
| 4331 let save_cursor = getpos(".") | |
| 4332 MoveTheCursorAround | |
| 798 | 4333 call setpos('.', save_cursor) |
| 707 | 4334 < Also see |setpos()|. |
| 703 | 4335 |
| 819 | 4336 pathshorten({expr}) *pathshorten()* |
| 4337 Shorten directory names in the path {expr} and return the | |
| 4338 result. The tail, the file name, is kept as-is. The other | |
| 4339 components in the path are reduced to single letters. Leading | |
| 4340 '~' and '.' characters are kept. Example: > | |
| 4341 :echo pathshorten('~/.vim/autoload/myfile.vim') | |
| 4342 < ~/.v/a/myfile.vim ~ | |
| 4343 It doesn't matter if the path exists or not. | |
| 4344 | |
| 1621 | 4345 pow({x}, {y}) *pow()* |
| 4346 Return the power of {x} to the exponent {y} as a |Float|. | |
| 4347 {x} and {y} must evaluate to a |Float| or a |Number|. | |
| 4348 Examples: > | |
| 4349 :echo pow(3, 3) | |
| 4350 < 27.0 > | |
| 4351 :echo pow(2, 16) | |
| 4352 < 65536.0 > | |
| 4353 :echo pow(32, 0.20) | |
| 4354 < 2.0 | |
| 4355 {only available when compiled with the |+float| feature} | |
| 4356 | |
| 667 | 4357 prevnonblank({lnum}) *prevnonblank()* |
| 4358 Return the line number of the first line at or above {lnum} | |
| 4359 that is not blank. Example: > | |
| 4360 let ind = indent(prevnonblank(v:lnum - 1)) | |
| 4361 < When {lnum} is invalid or there is no non-blank line at or | |
| 4362 above it, zero is returned. | |
| 4363 Also see |nextnonblank()|. | |
| 4364 | |
| 4365 | |
| 449 | 4366 printf({fmt}, {expr1} ...) *printf()* |
| 4367 Return a String with {fmt}, where "%" items are replaced by | |
| 4368 the formatted form of their respective arguments. Example: > | |
| 452 | 4369 printf("%4d: E%d %.30s", lnum, errno, msg) |
| 449 | 4370 < May result in: |
| 452 | 4371 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
| 449 | 4372 |
| 4373 Often used items are: | |
| 856 | 4374 %s string |
| 653 | 4375 %6s string right-aligned in 6 bytes |
| 1621 | 4376 %.9s string truncated to 9 bytes |
| 4377 %c single byte | |
| 4378 %d decimal number | |
| 4379 %5d decimal number padded with spaces to 5 characters | |
| 4380 %x hex number | |
| 4381 %04x hex number padded with zeros to at least 4 characters | |
| 4382 %X hex number using upper case letters | |
| 4383 %o octal number | |
| 4384 %f floating point number in the form 123.456 | |
| 4385 %e floating point number in the form 1.234e3 | |
| 4386 %E floating point number in the form 1.234E3 | |
| 4387 %g floating point number, as %f or %e depending on value | |
| 4388 %G floating point number, as %f or %E depending on value | |
| 4389 %% the % character itself | |
| 449 | 4390 |
| 4391 Conversion specifications start with '%' and end with the | |
| 4392 conversion type. All other characters are copied unchanged to | |
| 4393 the result. | |
| 4394 | |
| 4395 The "%" starts a conversion specification. The following | |
| 452 | 4396 arguments appear in sequence: |
| 4397 | |
| 4398 % [flags] [field-width] [.precision] type | |
| 4399 | |
| 856 | 4400 flags |
| 452 | 4401 Zero or more of the following flags: |
| 4402 | |
| 449 | 4403 # The value should be converted to an "alternate |
| 4404 form". For c, d, and s conversions, this option | |
| 4405 has no effect. For o conversions, the precision | |
| 4406 of the number is increased to force the first | |
| 4407 character of the output string to a zero (except | |
| 4408 if a zero value is printed with an explicit | |
| 4409 precision of zero). | |
| 4410 For x and X conversions, a non-zero result has | |
| 4411 the string "0x" (or "0X" for X conversions) | |
| 4412 prepended to it. | |
| 452 | 4413 |
| 449 | 4414 0 (zero) Zero padding. For all conversions the converted |
| 4415 value is padded on the left with zeros rather | |
| 4416 than blanks. If a precision is given with a | |
| 4417 numeric conversion (d, o, x, and X), the 0 flag | |
| 4418 is ignored. | |
| 452 | 4419 |
| 449 | 4420 - A negative field width flag; the converted value |
| 4421 is to be left adjusted on the field boundary. | |
| 4422 The converted value is padded on the right with | |
| 4423 blanks, rather than on the left with blanks or | |
| 4424 zeros. A - overrides a 0 if both are given. | |
| 452 | 4425 |
| 449 | 4426 ' ' (space) A blank should be left before a positive |
| 4427 number produced by a signed conversion (d). | |
| 452 | 4428 |
| 449 | 4429 + A sign must always be placed before a number |
| 1621 | 4430 produced by a signed conversion. A + overrides |
| 449 | 4431 a space if both are used. |
| 452 | 4432 |
| 4433 field-width | |
| 4434 An optional decimal digit string specifying a minimum | |
| 653 | 4435 field width. If the converted value has fewer bytes |
| 4436 than the field width, it will be padded with spaces on | |
| 4437 the left (or right, if the left-adjustment flag has | |
| 4438 been given) to fill out the field width. | |
| 452 | 4439 |
| 4440 .precision | |
| 4441 An optional precision, in the form of a period '.' | |
| 4442 followed by an optional digit string. If the digit | |
| 4443 string is omitted, the precision is taken as zero. | |
| 4444 This gives the minimum number of digits to appear for | |
| 4445 d, o, x, and X conversions, or the maximum number of | |
| 653 | 4446 bytes to be printed from a string for s conversions. |
| 1621 | 4447 For floating point it is the number of digits after |
| 4448 the decimal point. | |
| 452 | 4449 |
| 4450 type | |
| 4451 A character that specifies the type of conversion to | |
| 4452 be applied, see below. | |
| 4453 | |
| 449 | 4454 A field width or precision, or both, may be indicated by an |
| 4455 asterisk '*' instead of a digit string. In this case, a | |
| 1621 | 4456 Number argument supplies the field width or precision. A |
| 449 | 4457 negative field width is treated as a left adjustment flag |
| 4458 followed by a positive field width; a negative precision is | |
| 4459 treated as though it were missing. Example: > | |
| 452 | 4460 :echo printf("%d: %.*s", nr, width, line) |
| 449 | 4461 < This limits the length of the text used from "line" to |
| 452 | 4462 "width" bytes. |
| 449 | 4463 |
| 856 | 4464 The conversion specifiers and their meanings are: |
| 452 | 4465 |
| 1621 | 4466 *printf-d* *printf-o* *printf-x* *printf-X* |
| 4467 doxX The Number argument is converted to signed decimal | |
| 449 | 4468 (d), unsigned octal (o), or unsigned hexadecimal (x |
| 4469 and X) notation. The letters "abcdef" are used for | |
| 4470 x conversions; the letters "ABCDEF" are used for X | |
| 452 | 4471 conversions. |
| 4472 The precision, if any, gives the minimum number of | |
| 4473 digits that must appear; if the converted value | |
| 4474 requires fewer digits, it is padded on the left with | |
| 4475 zeros. | |
| 4476 In no case does a non-existent or small field width | |
| 4477 cause truncation of a numeric field; if the result of | |
| 4478 a conversion is wider than the field width, the field | |
| 4479 is expanded to contain the conversion result. | |
| 4480 | |
| 1621 | 4481 *printf-c* |
| 452 | 4482 c The Number argument is converted to a byte, and the |
| 4483 resulting character is written. | |
| 4484 | |
| 1621 | 4485 *printf-s* |
| 452 | 4486 s The text of the String argument is used. If a |
| 4487 precision is specified, no more bytes than the number | |
| 4488 specified are used. | |
| 4489 | |
| 1621 | 4490 *printf-f* *E807* |
| 4491 f The Float argument is converted into a string of the | |
| 4492 form 123.456. The precision specifies the number of | |
| 4493 digits after the decimal point. When the precision is | |
| 4494 zero the decimal point is omitted. When the precision | |
| 4495 is not specified 6 is used. A really big number | |
| 4496 (out of range or dividing by zero) results in "inf". | |
| 4497 "0.0 / 0.0" results in "nan". | |
| 4498 Example: > | |
| 4499 echo printf("%.2f", 12.115) | |
| 4500 < 12.12 | |
| 4501 Note that roundoff depends on the system libraries. | |
| 4502 Use |round()| when in doubt. | |
| 4503 | |
| 4504 *printf-e* *printf-E* | |
| 4505 e E The Float argument is converted into a string of the | |
| 4506 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
| 4507 precision specifies the number of digits after the | |
| 4508 decimal point, like with 'f'. | |
| 4509 | |
| 4510 *printf-g* *printf-G* | |
| 4511 g G The Float argument is converted like with 'f' if the | |
| 4512 value is between 0.001 (inclusive) and 10000000.0 | |
| 4513 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
| 4514 for 'G'. When no precision is specified superfluous | |
| 4515 zeroes and '+' signs are removed, except for the zero | |
| 4516 immediately after the decimal point. Thus 10000000.0 | |
| 4517 results in 1.0e7. | |
| 4518 | |
| 4519 *printf-%* | |
| 449 | 4520 % A '%' is written. No argument is converted. The |
| 4521 complete conversion specification is "%%". | |
| 452 | 4522 |
| 1668 | 4523 When a Number argument is expected a String argument is also |
| 4524 accepted and automatically converted. | |
| 4525 When a Float or String argument is expected a Number argument | |
| 4526 is also accepted and automatically converted. | |
| 4527 Any other argument type results in an error message. | |
| 449 | 4528 |
| 459 | 4529 *E766* *E767* |
| 449 | 4530 The number of {exprN} arguments must exactly match the number |
| 4531 of "%" items. If there are not sufficient or too many | |
| 452 | 4532 arguments an error is given. Up to 18 arguments can be used. |
| 449 | 4533 |
| 4534 | |
| 667 | 4535 pumvisible() *pumvisible()* |
| 4536 Returns non-zero when the popup menu is visible, zero | |
| 4537 otherwise. See |ins-completion-menu|. | |
| 712 | 4538 This can be used to avoid some things that would remove the |
| 4539 popup menu. | |
| 7 | 4540 |
| 114 | 4541 *E726* *E727* |
| 99 | 4542 range({expr} [, {max} [, {stride}]]) *range()* |
| 685 | 4543 Returns a |List| with Numbers: |
| 99 | 4544 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
| 4545 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
| 4546 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
| 4547 {max}] (increasing {expr} with {stride} each time, not | |
| 4548 producing a value past {max}). | |
| 336 | 4549 When the maximum is one before the start the result is an |
| 4550 empty list. When the maximum is more than one before the | |
| 4551 start this is an error. | |
| 99 | 4552 Examples: > |
| 856 | 4553 range(4) " [0, 1, 2, 3] |
| 99 | 4554 range(2, 4) " [2, 3, 4] |
| 4555 range(2, 9, 3) " [2, 5, 8] | |
| 856 | 4556 range(2, -2, -1) " [2, 1, 0, -1, -2] |
| 336 | 4557 range(0) " [] |
| 4558 range(2, 0) " error! | |
| 99 | 4559 < |
| 158 | 4560 *readfile()* |
| 168 | 4561 readfile({fname} [, {binary} [, {max}]]) |
| 685 | 4562 Read file {fname} and return a |List|, each line of the file |
| 4563 as an item. Lines broken at NL characters. Macintosh files | |
| 158 | 4564 separated with CR will result in a single long line (unless a |
| 4565 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
|
4566 All NUL characters are replaced with a NL character. |
| 158 | 4567 When {binary} is equal to "b" binary mode is used: |
| 4568 - When the last line ends in a NL an extra empty list item is | |
| 4569 added. | |
| 4570 - No CR characters are removed. | |
| 4571 Otherwise: | |
| 4572 - CR characters that appear before a NL are removed. | |
| 4573 - 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
|
4574 - 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
|
4575 removed from the text. |
| 168 | 4576 When {max} is given this specifies the maximum number of lines |
| 4577 to be read. Useful if you only want to check the first ten | |
| 4578 lines of a file: > | |
| 4579 :for line in readfile(fname, '', 10) | |
| 4580 : if line =~ 'Date' | echo line | endif | |
| 4581 :endfor | |
| 233 | 4582 < When {max} is negative -{max} lines from the end of the file |
| 4583 are returned, or as many as there are. | |
| 4584 When {max} is zero the result is an empty list. | |
| 168 | 4585 Note that without {max} the whole file is read into memory. |
| 4586 Also note that there is no recognition of encoding. Read a | |
| 4587 file into a buffer if you need to. | |
| 158 | 4588 When the file can't be opened an error message is given and |
| 4589 the result is an empty list. | |
| 4590 Also see |writefile()|. | |
| 4591 | |
| 794 | 4592 reltime([{start} [, {end}]]) *reltime()* |
| 4593 Return an item that represents a time value. The format of | |
| 4594 the item depends on the system. It can be passed to | |
| 4595 |reltimestr()| to convert it to a string. | |
| 4596 Without an argument it returns the current time. | |
| 4597 With one argument is returns the time passed since the time | |
| 4598 specified in the argument. | |
| 843 | 4599 With two arguments it returns the time passed between {start} |
| 794 | 4600 and {end}. |
| 4601 The {start} and {end} arguments must be values returned by | |
| 4602 reltime(). | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
4603 {only available when compiled with the |+reltime| feature} |
| 794 | 4604 |
| 4605 reltimestr({time}) *reltimestr()* | |
| 4606 Return a String that represents the time value of {time}. | |
| 4607 This is the number of seconds, a dot and the number of | |
| 4608 microseconds. Example: > | |
| 4609 let start = reltime() | |
| 4610 call MyFunction() | |
| 4611 echo reltimestr(reltime(start)) | |
| 4612 < Note that overhead for the commands will be added to the time. | |
| 4613 The accuracy depends on the system. | |
| 1156 | 4614 Leading spaces are used to make the string align nicely. You |
| 4615 can use split() to remove it. > | |
| 4616 echo split(reltimestr(reltime(start)))[0] | |
| 4617 < 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
|
4618 {only available when compiled with the |+reltime| feature} |
| 794 | 4619 |
| 7 | 4620 *remote_expr()* *E449* |
| 4621 remote_expr({server}, {string} [, {idvar}]) | |
| 1621 | 4622 Send the {string} to {server}. The string is sent as an |
| 7 | 4623 expression and the result is returned after evaluation. |
| 714 | 4624 The result must be a String or a |List|. A |List| is turned |
| 4625 into a String by joining the items with a line break in | |
| 4626 between (not at the end), like with join(expr, "\n"). | |
| 7 | 4627 If {idvar} is present, it is taken as the name of a |
| 4628 variable and a {serverid} for later use with | |
| 4629 remote_read() is stored there. | |
| 4630 See also |clientserver| |RemoteReply|. | |
| 4631 This function is not available in the |sandbox|. | |
| 4632 {only available when compiled with the |+clientserver| feature} | |
| 4633 Note: Any errors will cause a local error message to be issued | |
| 4634 and the result will be the empty string. | |
| 4635 Examples: > | |
| 4636 :echo remote_expr("gvim", "2+2") | |
| 4637 :echo remote_expr("gvim1", "b:current_syntax") | |
| 4638 < | |
| 4639 | |
| 4640 remote_foreground({server}) *remote_foreground()* | |
| 4641 Move the Vim server with the name {server} to the foreground. | |
| 4642 This works like: > | |
| 4643 remote_expr({server}, "foreground()") | |
| 4644 < Except that on Win32 systems the client does the work, to work | |
| 4645 around the problem that the OS doesn't always allow the server | |
| 4646 to bring itself to the foreground. | |
| 574 | 4647 Note: This does not restore the window if it was minimized, |
| 4648 like foreground() does. | |
| 7 | 4649 This function is not available in the |sandbox|. |
| 4650 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 4651 Win32 console version} | |
| 4652 | |
| 4653 | |
| 4654 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
| 4655 Returns a positive number if there are available strings | |
| 4656 from {serverid}. Copies any reply string into the variable | |
| 1621 | 4657 {retvar} if specified. {retvar} must be a string with the |
| 7 | 4658 name of a variable. |
| 4659 Returns zero if none are available. | |
| 4660 Returns -1 if something is wrong. | |
| 4661 See also |clientserver|. | |
| 4662 This function is not available in the |sandbox|. | |
| 4663 {only available when compiled with the |+clientserver| feature} | |
| 4664 Examples: > | |
| 4665 :let repl = "" | |
| 4666 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
| 4667 | |
| 4668 remote_read({serverid}) *remote_read()* | |
| 4669 Return the oldest available reply from {serverid} and consume | |
| 4670 it. It blocks until a reply is available. | |
| 4671 See also |clientserver|. | |
| 4672 This function is not available in the |sandbox|. | |
| 4673 {only available when compiled with the |+clientserver| feature} | |
| 4674 Example: > | |
| 4675 :echo remote_read(id) | |
| 4676 < | |
| 4677 *remote_send()* *E241* | |
| 4678 remote_send({server}, {string} [, {idvar}]) | |
| 1621 | 4679 Send the {string} to {server}. The string is sent as input |
| 22 | 4680 keys and the function returns immediately. At the Vim server |
| 4681 the keys are not mapped |:map|. | |
| 667 | 4682 If {idvar} is present, it is taken as the name of a variable |
| 4683 and a {serverid} for later use with remote_read() is stored | |
| 4684 there. | |
| 7 | 4685 See also |clientserver| |RemoteReply|. |
| 4686 This function is not available in the |sandbox|. | |
| 4687 {only available when compiled with the |+clientserver| feature} | |
| 4688 Note: Any errors will be reported in the server and may mess | |
| 4689 up the display. | |
| 4690 Examples: > | |
| 4691 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
| 4692 \ remote_read(serverid) | |
| 4693 | |
| 4694 :autocmd NONE RemoteReply * | |
| 4695 \ echo remote_read(expand("<amatch>")) | |
| 4696 :echo remote_send("gvim", ":sleep 10 | echo ". | |
| 4697 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
| 82 | 4698 < |
| 79 | 4699 remove({list}, {idx} [, {end}]) *remove()* |
| 685 | 4700 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
|
4701 return the item. |
| 79 | 4702 With {end}: Remove items from {idx} to {end} (inclusive) and |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4703 return a List with these items. When {idx} points to the same |
| 79 | 4704 item as {end} a list with one item is returned. When {end} |
| 4705 points to an item before {idx} this is an error. | |
| 4706 See |list-index| for possible values of {idx} and {end}. | |
| 55 | 4707 Example: > |
| 4708 :echo "last item: " . remove(mylist, -1) | |
| 79 | 4709 :call remove(mylist, 0, 9) |
| 99 | 4710 remove({dict}, {key}) |
| 4711 Remove the entry from {dict} with key {key}. Example: > | |
| 4712 :echo "removed " . remove(dict, "one") | |
| 4713 < If there is no {key} in {dict} this is an error. | |
| 4714 | |
| 4715 Use |delete()| to remove a file. | |
| 55 | 4716 |
| 7 | 4717 rename({from}, {to}) *rename()* |
| 4718 Rename the file by the name {from} to the name {to}. This | |
| 4719 should also work to move files across file systems. The | |
| 4720 result is a Number, which is 0 if the file was renamed | |
| 4721 successfully, and non-zero when the renaming failed. | |
| 1851 | 4722 NOTE: If {to} exists it is overwritten without warning. |
| 7 | 4723 This function is not available in the |sandbox|. |
| 4724 | |
| 18 | 4725 repeat({expr}, {count}) *repeat()* |
| 4726 Repeat {expr} {count} times and return the concatenated | |
| 4727 result. Example: > | |
| 843 | 4728 :let separator = repeat('-', 80) |
| 18 | 4729 < When {count} is zero or negative the result is empty. |
| 685 | 4730 When {expr} is a |List| the result is {expr} concatenated |
| 1621 | 4731 {count} times. Example: > |
| 79 | 4732 :let longlist = repeat(['a', 'b'], 3) |
| 4733 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
| 18 | 4734 |
| 82 | 4735 |
| 7 | 4736 resolve({filename}) *resolve()* *E655* |
| 4737 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
| 4738 returns the path the shortcut points to in a simplified form. | |
| 4739 On Unix, repeat resolving symbolic links in all path | |
| 4740 components of {filename} and return the simplified result. | |
| 4741 To cope with link cycles, resolving of symbolic links is | |
| 4742 stopped after 100 iterations. | |
| 4743 On other systems, return the simplified {filename}. | |
| 4744 The simplification step is done as by |simplify()|. | |
| 4745 resolve() keeps a leading path component specifying the | |
| 4746 current directory (provided the result is still a relative | |
| 4747 path name) and also keeps a trailing path separator. | |
| 4748 | |
| 82 | 4749 *reverse()* |
| 1621 | 4750 reverse({list}) Reverse the order of items in {list} in-place. Returns |
| 82 | 4751 {list}. |
| 4752 If you want a list to remain unmodified make a copy first: > | |
| 4753 :let revlist = reverse(copy(mylist)) | |
| 4754 | |
| 1621 | 4755 round({expr}) *round()* |
| 1668 | 4756 Round off {expr} to the nearest integral value and return it |
| 1621 | 4757 as a |Float|. If {expr} lies halfway between two integral |
| 4758 values, then use the larger one (away from zero). | |
| 4759 {expr} must evaluate to a |Float| or a |Number|. | |
| 4760 Examples: > | |
| 4761 echo round(0.456) | |
| 4762 < 0.0 > | |
| 4763 echo round(4.5) | |
| 4764 < 5.0 > | |
| 4765 echo round(-4.5) | |
| 4766 < -5.0 | |
| 4767 {only available when compiled with the |+float| feature} | |
| 4768 | |
| 4769 | |
| 1496 | 4770 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()* |
| 7 | 4771 Search for regexp pattern {pattern}. The search starts at the |
| 119 | 4772 cursor position (you can use |cursor()| to set it). |
| 707 | 4773 |
| 7 | 4774 {flags} is a String, which can contain these character flags: |
| 4775 'b' search backward instead of forward | |
| 1621 | 4776 'c' accept a match at the cursor position |
| 712 | 4777 'e' move to the End of the match |
| 20 | 4778 'n' do Not move the cursor |
| 712 | 4779 'p' return number of matching sub-pattern (see below) |
| 4780 's' set the ' mark at the previous location of the cursor | |
| 7 | 4781 'w' wrap around the end of the file |
| 4782 'W' don't wrap around the end of the file | |
| 4783 If neither 'w' or 'W' is given, the 'wrapscan' option applies. | |
| 4784 | |
| 444 | 4785 If the 's' flag is supplied, the ' mark is set, only if the |
| 4786 cursor is moved. The 's' flag cannot be combined with the 'n' | |
| 4787 flag. | |
| 4788 | |
| 1156 | 4789 'ignorecase', 'smartcase' and 'magic' are used. |
| 4790 | |
| 692 | 4791 When the {stopline} argument is given then the search stops |
| 4792 after searching this line. This is useful to restrict the | |
| 4793 search to a range of lines. Examples: > | |
| 4794 let match = search('(', 'b', line("w0")) | |
| 4795 let end = search('END', '', line("w$")) | |
| 4796 < When {stopline} is used and it is not zero this also implies | |
| 4797 that the search does not wrap around the end of the file. | |
| 1496 | 4798 A zero value is equal to not giving the argument. |
| 4799 | |
| 4800 When the {timeout} argument is given the search stops when | |
| 1621 | 4801 more than this many milli seconds have passed. Thus when |
| 1496 | 4802 {timeout} is 500 the search stops after half a second. |
| 4803 The value must not be negative. A zero value is like not | |
| 4804 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
|
4805 {only available when compiled with the |+reltime| feature} |
| 692 | 4806 |
| 712 | 4807 If there is no match a 0 is returned and the cursor doesn't |
| 4808 move. No error message is given. | |
| 714 | 4809 When a match has been found its line number is returned. |
| 4810 *search()-sub-match* | |
| 4811 With the 'p' flag the returned value is one more than the | |
| 4812 first sub-match in \(\). One if none of them matched but the | |
| 4813 whole pattern did match. | |
| 712 | 4814 To get the column number too use |searchpos()|. |
| 4815 | |
| 20 | 4816 The cursor will be positioned at the match, unless the 'n' |
| 707 | 4817 flag is used. |
| 7 | 4818 |
| 4819 Example (goes over all files in the argument list): > | |
| 4820 :let n = 1 | |
| 4821 :while n <= argc() " loop over all files in arglist | |
| 4822 : exe "argument " . n | |
| 4823 : " start at the last char in the file and wrap for the | |
| 4824 : " first search to find match at start of file | |
| 4825 : normal G$ | |
| 4826 : let flags = "w" | |
| 4827 : while search("foo", flags) > 0 | |
| 1621 | 4828 : s/foo/bar/g |
| 7 | 4829 : let flags = "W" |
| 4830 : endwhile | |
| 4831 : update " write the file if modified | |
| 4832 : let n = n + 1 | |
| 4833 :endwhile | |
| 4834 < | |
| 712 | 4835 Example for using some flags: > |
| 4836 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
| 4837 < This will search for the keywords "if", "else", and "endif" | |
| 4838 under or after the cursor. Because of the 'p' flag, it | |
| 4839 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
| 4840 if the search fails. With the cursor on the first word of the | |
| 4841 line: | |
| 4842 if (foo == 0) | let foo = foo + 1 | endif ~ | |
| 4843 the function returns 1. Without the 'c' flag, the function | |
| 4844 finds the "endif" and returns 3. The same thing happens | |
| 4845 without the 'e' flag if the cursor is on the "f" of "if". | |
| 4846 The 'n' flag tells the function not to move the cursor. | |
| 4847 | |
| 504 | 4848 |
| 523 | 4849 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
| 4850 Search for the declaration of {name}. | |
| 856 | 4851 |
| 523 | 4852 With a non-zero {global} argument it works like |gD|, find |
| 4853 first match in the file. Otherwise it works like |gd|, find | |
| 4854 first match in the function. | |
| 4855 | |
| 4856 With a non-zero {thisblock} argument matches in a {} block | |
| 4857 that ends before the cursor position are ignored. Avoids | |
| 4858 finding variable declarations only valid in another scope. | |
| 4859 | |
| 504 | 4860 Moves the cursor to the found match. |
| 4861 Returns zero for success, non-zero for failure. | |
| 4862 Example: > | |
| 4863 if searchdecl('myvar') == 0 | |
| 4864 echo getline('.') | |
| 4865 endif | |
| 4866 < | |
| 7 | 4867 *searchpair()* |
| 1496 | 4868 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
| 4869 [, {stopline} [, {timeout}]]]]) | |
| 7 | 4870 Search for the match of a nested start-end pair. This can be |
| 4871 used to find the "endif" that matches an "if", while other | |
| 4872 if/endif pairs in between are ignored. | |
| 677 | 4873 The search starts at the cursor. The default is to search |
| 4874 forward, include 'b' in {flags} to search backward. | |
| 4875 If a match is found, the cursor is positioned at it and the | |
| 4876 line number is returned. If no match is found 0 or -1 is | |
| 4877 returned and the cursor doesn't move. No error message is | |
| 4878 given. | |
| 7 | 4879 |
| 4880 {start}, {middle} and {end} are patterns, see |pattern|. They | |
| 4881 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
| 4882 {middle} is not empty, it is found when searching from either | |
| 4883 direction, but only when not in a nested start-end pair. A | |
| 4884 typical use is: > | |
| 4885 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
| 4886 < By leaving {middle} empty the "else" is skipped. | |
| 4887 | |
| 712 | 4888 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
| 4889 |search()|. Additionally: | |
| 7 | 4890 'r' Repeat until no more matches found; will find the |
| 1621 | 4891 outer pair. Implies the 'W' flag. |
| 4892 'm' Return number of matches instead of line number with | |
| 712 | 4893 the match; will be > 1 when 'r' is used. |
| 1621 | 4894 Note: it's nearly always a good idea to use the 'W' flag, to |
| 4895 avoid wrapping around the end of the file. | |
| 7 | 4896 |
| 4897 When a match for {start}, {middle} or {end} is found, the | |
| 4898 {skip} expression is evaluated with the cursor positioned on | |
| 4899 the start of the match. It should return non-zero if this | |
| 4900 match is to be skipped. E.g., because it is inside a comment | |
| 4901 or a string. | |
| 4902 When {skip} is omitted or empty, every match is accepted. | |
| 4903 When evaluating {skip} causes an error the search is aborted | |
| 4904 and -1 returned. | |
| 4905 | |
| 1496 | 4906 For {stopline} and {timeout} see |search()|. |
| 692 | 4907 |
| 7 | 4908 The value of 'ignorecase' is used. 'magic' is ignored, the |
| 4909 patterns are used like it's on. | |
| 4910 | |
| 4911 The search starts exactly at the cursor. A match with | |
| 4912 {start}, {middle} or {end} at the next character, in the | |
| 4913 direction of searching, is the first one found. Example: > | |
| 4914 if 1 | |
| 4915 if 2 | |
| 4916 endif 2 | |
| 4917 endif 1 | |
| 4918 < When starting at the "if 2", with the cursor on the "i", and | |
| 4919 searching forwards, the "endif 2" is found. When starting on | |
| 4920 the character just before the "if 2", the "endif 1" will be | |
| 1621 | 4921 found. That's because the "if 2" will be found first, and |
| 7 | 4922 then this is considered to be a nested if/endif from "if 2" to |
| 4923 "endif 2". | |
| 4924 When searching backwards and {end} is more than one character, | |
| 4925 it may be useful to put "\zs" at the end of the pattern, so | |
| 4926 that when the cursor is inside a match with the end it finds | |
| 4927 the matching start. | |
| 4928 | |
| 4929 Example, to find the "endif" command in a Vim script: > | |
| 4930 | |
| 4931 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
| 4932 \ 'getline(".") =~ "^\\s*\""') | |
| 4933 | |
| 4934 < The cursor must be at or after the "if" for which a match is | |
| 4935 to be found. Note that single-quote strings are used to avoid | |
| 4936 having to double the backslashes. The skip expression only | |
| 4937 catches comments at the start of a line, not after a command. | |
| 4938 Also, a word "en" or "if" halfway a line is considered a | |
| 4939 match. | |
| 4940 Another example, to search for the matching "{" of a "}": > | |
| 4941 | |
| 4942 :echo searchpair('{', '', '}', 'bW') | |
| 4943 | |
| 4944 < This works when the cursor is at or before the "}" for which a | |
| 4945 match is to be found. To reject matches that syntax | |
| 4946 highlighting recognized as strings: > | |
| 4947 | |
| 4948 :echo searchpair('{', '', '}', 'bW', | |
| 4949 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
| 4950 < | |
| 667 | 4951 *searchpairpos()* |
| 1496 | 4952 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
| 4953 [, {stopline} [, {timeout}]]]]) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4954 Same as |searchpair()|, but returns a |List| with the line and |
| 685 | 4955 column position of the match. The first element of the |List| |
| 4956 is the line number and the second element is the byte index of | |
| 667 | 4957 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
|
4958 returns [0, 0]. > |
|
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
4959 |
| 667 | 4960 :let [lnum,col] = searchpairpos('{', '', '}', 'n') |
| 4961 < | |
| 4962 See |match-parens| for a bigger and more useful example. | |
| 4963 | |
| 1496 | 4964 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()* |
| 692 | 4965 Same as |search()|, but returns a |List| with the line and |
| 685 | 4966 column position of the match. The first element of the |List| |
| 4967 is the line number and the second element is the byte index of | |
| 4968 the column position of the match. If no match is found, | |
| 4969 returns [0, 0]. | |
| 714 | 4970 Example: > |
| 4971 :let [lnum, col] = searchpos('mypattern', 'n') | |
| 4972 | |
| 4973 < When the 'p' flag is given then there is an extra item with | |
| 4974 the sub-pattern match number |search()-sub-match|. Example: > | |
| 4975 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
| 4976 < In this example "submatch" is 2 when a lowercase letter is | |
| 4977 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
| 4978 | |
| 7 | 4979 server2client( {clientid}, {string}) *server2client()* |
| 4980 Send a reply string to {clientid}. The most recent {clientid} | |
| 4981 that sent a string can be retrieved with expand("<client>"). | |
| 4982 {only available when compiled with the |+clientserver| feature} | |
| 4983 Note: | |
| 4984 This id has to be stored before the next command can be | |
| 236 | 4985 received. I.e. before returning from the received command and |
| 7 | 4986 before calling any commands that waits for input. |
| 4987 See also |clientserver|. | |
| 4988 Example: > | |
| 4989 :echo server2client(expand("<client>"), "HELLO") | |
| 4990 < | |
| 4991 serverlist() *serverlist()* | |
| 4992 Return a list of available server names, one per line. | |
| 4993 When there are no servers or the information is not available | |
| 4994 an empty string is returned. See also |clientserver|. | |
| 4995 {only available when compiled with the |+clientserver| feature} | |
| 4996 Example: > | |
| 4997 :echo serverlist() | |
| 4998 < | |
| 4999 setbufvar({expr}, {varname}, {val}) *setbufvar()* | |
| 5000 Set option or local variable {varname} in buffer {expr} to | |
| 5001 {val}. | |
| 5002 This also works for a global or local window option, but it | |
| 5003 doesn't work for a global or local window variable. | |
| 5004 For a local window option the global value is unchanged. | |
| 5005 For the use of {expr}, see |bufname()| above. | |
| 5006 Note that the variable name without "b:" must be used. | |
| 5007 Examples: > | |
| 5008 :call setbufvar(1, "&mod", 1) | |
| 5009 :call setbufvar("todo", "myvar", "foobar") | |
| 5010 < This function is not available in the |sandbox|. | |
| 5011 | |
| 5012 setcmdpos({pos}) *setcmdpos()* | |
| 5013 Set the cursor position in the command line to byte position | |
| 1621 | 5014 {pos}. The first position is 1. |
| 7 | 5015 Use |getcmdpos()| to obtain the current position. |
| 5016 Only works while editing the command line, thus you must use | |
| 99 | 5017 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
| 5018 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
| 5019 set after the command line is set to the expression. For | |
| 5020 |c_CTRL-R_=| it is set after evaluating the expression but | |
| 5021 before inserting the resulting text. | |
| 7 | 5022 When the number is too big the cursor is put at the end of the |
| 5023 line. A number smaller than one has undefined results. | |
| 5024 Returns 0 when successful, 1 when not editing the command | |
| 5025 line. | |
| 5026 | |
| 1621 | 5027 setline({lnum}, {text}) *setline()* |
| 5028 Set line {lnum} of the current buffer to {text}. | |
| 236 | 5029 {lnum} is used like with |getline()|. |
| 1621 | 5030 When {lnum} is just below the last line the {text} will be |
| 282 | 5031 added as a new line. |
| 236 | 5032 If this succeeds, 0 is returned. If this fails (most likely |
| 5033 because {lnum} is invalid) 1 is returned. Example: > | |
| 7 | 5034 :call setline(5, strftime("%c")) |
| 1621 | 5035 < When {text} is a |List| then line {lnum} and following lines |
| 282 | 5036 will be set to the items in the list. Example: > |
| 5037 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
| 5038 < This is equivalent to: > | |
| 5039 :for [n, l] in [[5, 6, 7], ['aaa', 'bbb', 'ccc']] | |
| 5040 : call setline(n, l) | |
| 5041 :endfor | |
| 7 | 5042 < Note: The '[ and '] marks are not set. |
| 5043 | |
| 647 | 5044 setloclist({nr}, {list} [, {action}]) *setloclist()* |
| 5045 Create or replace or add to the location list for window {nr}. | |
| 5046 When {nr} is zero the current window is used. For a location | |
| 648 | 5047 list window, the displayed location list is modified. For an |
| 5048 invalid window number {nr}, -1 is returned. | |
| 1326 | 5049 Otherwise, same as |setqflist()|. |
| 5050 Also see |location-list|. | |
| 5051 | |
| 5052 setmatches({list}) *setmatches()* | |
| 5053 Restores a list of matches saved by |getmatches()|. Returns 0 | |
| 1621 | 5054 if successful, otherwise -1. All current matches are cleared |
| 1326 | 5055 before the list is restored. See example for |getmatches()|. |
| 230 | 5056 |
| 707 | 5057 *setpos()* |
| 5058 setpos({expr}, {list}) | |
| 5059 Set the position for {expr}. Possible values: | |
| 5060 . the cursor | |
| 5061 'x mark x | |
| 5062 | |
| 5063 {list} must be a |List| with four numbers: | |
| 5064 [bufnum, lnum, col, off] | |
| 5065 | |
| 1621 | 5066 "bufnum" is the buffer number. Zero can be used for the |
| 856 | 5067 current buffer. Setting the cursor is only possible for |
| 707 | 5068 the current buffer. To set a mark in another buffer you can |
| 5069 use the |bufnr()| function to turn a file name into a buffer | |
| 5070 number. | |
| 798 | 5071 Does not change the jumplist. |
| 707 | 5072 |
| 5073 "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
|
5074 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
|
5075 smaller than 1 then 1 is used. |
| 707 | 5076 |
| 5077 The "off" number is only used when 'virtualedit' is set. Then | |
| 5078 it is the offset in screen columns from the start of the | |
| 1266 | 5079 character. E.g., a position within a <Tab> or after the last |
| 707 | 5080 character. |
| 5081 | |
| 1533 | 5082 Returns 0 when the position could be set, -1 otherwise. |
| 5083 An error message is given if {expr} is invalid. | |
| 5084 | |
| 707 | 5085 Also see |getpos()| |
| 5086 | |
| 1156 | 5087 This does not restore the preferred column for moving |
| 5088 vertically. See |winrestview()| for that. | |
| 5089 | |
| 707 | 5090 |
| 277 | 5091 setqflist({list} [, {action}]) *setqflist()* |
| 647 | 5092 Create or replace or add to the quickfix list using the items |
| 5093 in {list}. Each item in {list} is a dictionary. | |
| 5094 Non-dictionary items in {list} are ignored. Each dictionary | |
| 5095 item can contain the following entries: | |
| 230 | 5096 |
| 1065 | 5097 bufnr buffer number; must be the number of a valid |
| 1621 | 5098 buffer |
| 1065 | 5099 filename name of a file; only used when "bufnr" is not |
| 1621 | 5100 present or it is invalid. |
| 230 | 5101 lnum line number in the file |
| 233 | 5102 pattern search pattern used to locate the error |
| 230 | 5103 col column number |
| 233 | 5104 vcol when non-zero: "col" is visual column |
| 856 | 5105 when zero: "col" is byte index |
| 233 | 5106 nr error number |
| 230 | 5107 text description of the error |
| 233 | 5108 type single-character error type, 'E', 'W', etc. |
| 5109 | |
| 5110 The "col", "vcol", "nr", "type" and "text" entries are | |
| 5111 optional. Either "lnum" or "pattern" entry can be used to | |
| 5112 locate a matching error line. | |
| 1065 | 5113 If the "filename" and "bufnr" entries are not present or |
| 5114 neither the "lnum" or "pattern" entries are present, then the | |
| 5115 item will not be handled as an error line. | |
| 230 | 5116 If both "pattern" and "lnum" are present then "pattern" will |
| 5117 be used. | |
| 2152 | 5118 If you supply an empty {list}, the quickfix list will be |
| 5119 cleared. | |
| 1065 | 5120 Note that the list is not exactly the same as what |
| 5121 |getqflist()| returns. | |
| 230 | 5122 |
| 277 | 5123 If {action} is set to 'a', then the items from {list} are |
| 5124 added to the existing quickfix list. If there is no existing | |
| 5125 list, then a new list is created. If {action} is set to 'r', | |
| 5126 then the items from the current quickfix list are replaced | |
| 5127 with the items from {list}. If {action} is not present or is | |
| 5128 set to ' ', then a new list is created. | |
| 5129 | |
| 230 | 5130 Returns zero for success, -1 for failure. |
| 5131 | |
| 5132 This function can be used to create a quickfix list | |
| 5133 independent of the 'errorformat' setting. Use a command like | |
| 5134 ":cc 1" to jump to the first position. | |
| 5135 | |
| 5136 | |
| 7 | 5137 *setreg()* |
| 5138 setreg({regname}, {value} [,{options}]) | |
| 5139 Set the register {regname} to {value}. | |
| 5140 If {options} contains "a" or {regname} is upper case, | |
| 5141 then the value is appended. | |
| 2423 | 5142 {options} can also contain a register type specification: |
| 7 | 5143 "c" or "v" |characterwise| mode |
| 5144 "l" or "V" |linewise| mode | |
| 5145 "b" or "<CTRL-V>" |blockwise-visual| mode | |
| 5146 If a number immediately follows "b" or "<CTRL-V>" then this is | |
| 5147 used as the width of the selection - if it is not specified | |
| 5148 then the width of the block is set to the number of characters | |
| 1266 | 5149 in the longest line (counting a <Tab> as 1 character). |
| 7 | 5150 |
| 5151 If {options} contains no register settings, then the default | |
| 5152 is to use character mode unless {value} ends in a <NL>. | |
| 5153 Setting the '=' register is not possible. | |
| 5154 Returns zero for success, non-zero for failure. | |
| 5155 | |
| 5156 Examples: > | |
| 5157 :call setreg(v:register, @*) | |
| 5158 :call setreg('*', @%, 'ac') | |
| 5159 :call setreg('a', "1\n2\n3", 'b5') | |
| 5160 | |
| 5161 < This example shows using the functions to save and restore a | |
| 5162 register. > | |
| 282 | 5163 :let var_a = getreg('a', 1) |
| 7 | 5164 :let var_amode = getregtype('a') |
| 5165 .... | |
| 5166 :call setreg('a', var_a, var_amode) | |
| 5167 | |
| 5168 < You can also change the type of a register by appending | |
| 5169 nothing: > | |
| 5170 :call setreg('a', '', 'al') | |
| 5171 | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5172 settabvar({tabnr}, {varname}, {val}) *settabvar()* |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5173 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
|
5174 |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5175 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
|
5176 Tabs are numbered starting with one. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5177 Vim briefly goes to the tab page {tabnr}, this may trigger |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5178 TabLeave and TabEnter autocommands. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5179 This function is not available in the |sandbox|. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5180 |
| 831 | 5181 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
| 5182 Set option or local variable {varname} in window {winnr} to | |
| 5183 {val}. | |
| 5184 Tabs are numbered starting with one. For the current tabpage | |
| 5185 use |setwinvar()|. | |
| 5186 When {winnr} is zero the current window is used. | |
| 7 | 5187 This also works for a global or local buffer option, but it |
| 5188 doesn't work for a global or local buffer variable. | |
| 5189 For a local buffer option the global value is unchanged. | |
| 5190 Note that the variable name without "w:" must be used. | |
| 831 | 5191 Vim briefly goes to the tab page {tabnr}, this may trigger |
| 5192 TabLeave and TabEnter autocommands. | |
| 5193 Examples: > | |
| 5194 :call settabwinvar(1, 1, "&list", 0) | |
| 5195 :call settabwinvar(3, 2, "myvar", "foobar") | |
| 5196 < This function is not available in the |sandbox|. | |
| 5197 | |
| 5198 setwinvar({nr}, {varname}, {val}) *setwinvar()* | |
| 5199 Like |settabwinvar()| for the current tab page. | |
| 7 | 5200 Examples: > |
| 5201 :call setwinvar(1, "&list", 0) | |
| 5202 :call setwinvar(2, "myvar", "foobar") | |
| 5203 | |
| 1661 | 5204 shellescape({string} [, {special}]) *shellescape()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5205 Escape {string} for use as a shell command argument. |
| 985 | 5206 On MS-Windows and MS-DOS, when 'shellslash' is not set, it |
| 1661 | 5207 will enclose {string} in double quotes and double all double |
| 985 | 5208 quotes within {string}. |
| 5209 For other systems, it will enclose {string} in single quotes | |
| 5210 and replace all "'" with "'\''". | |
| 1661 | 5211 When the {special} argument is present and it's a non-zero |
| 5212 Number or a non-empty String (|non-zero-arg|), then special | |
| 1698 | 5213 items such as "!", "%", "#" and "<cword>" will be preceded by |
| 5214 a backslash. This backslash will be removed again by the |:!| | |
| 1661 | 5215 command. |
| 1698 | 5216 The "!" character will be escaped (again with a |non-zero-arg| |
| 5217 {special}) when 'shell' contains "csh" in the tail. That is | |
| 5218 because for csh and tcsh "!" is used for history replacement | |
| 5219 even when inside single quotes. | |
| 5220 The <NL> character is also escaped. With a |non-zero-arg| | |
| 5221 {special} and 'shell' containing "csh" in the tail it's | |
| 5222 escaped a second time. | |
| 1661 | 5223 Example of use with a |:!| command: > |
| 5224 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
| 5225 < This results in a directory listing for the file under the | |
| 5226 cursor. Example of use with |system()|: > | |
| 5227 :call system("chmod +w -- " . shellescape(expand("%"))) | |
| 985 | 5228 |
| 5229 | |
| 7 | 5230 simplify({filename}) *simplify()* |
| 5231 Simplify the file name as much as possible without changing | |
| 5232 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
| 5233 Unix) are not resolved. If the first path component in | |
| 5234 {filename} designates the current directory, this will be | |
| 5235 valid for the result as well. A trailing path separator is | |
| 5236 not removed either. | |
| 5237 Example: > | |
| 5238 simplify("./dir/.././/file/") == "./file/" | |
| 5239 < Note: The combination "dir/.." is only removed if "dir" is | |
| 5240 a searchable directory or does not exist. On Unix, it is also | |
| 5241 removed when "dir" is a symbolic link within the same | |
| 5242 directory. In order to resolve all the involved symbolic | |
| 5243 links before simplifying the path name, use |resolve()|. | |
| 5244 | |
| 82 | 5245 |
| 1621 | 5246 sin({expr}) *sin()* |
| 5247 Return the sine of {expr}, measured in radians, as a |Float|. | |
| 5248 {expr} must evaluate to a |Float| or a |Number|. | |
| 5249 Examples: > | |
| 5250 :echo sin(100) | |
| 5251 < -0.506366 > | |
| 5252 :echo sin(-4.01) | |
| 5253 < 0.763301 | |
| 5254 {only available when compiled with the |+float| feature} | |
| 5255 | |
| 5256 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5257 sinh({expr}) *sinh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5258 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
|
5259 [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5260 {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
|
5261 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5262 :echo sinh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5263 < 0.521095 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5264 :echo sinh(-0.9) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5265 < -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
|
5266 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5267 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5268 |
| 85 | 5269 sort({list} [, {func}]) *sort()* *E702* |
| 82 | 5270 Sort the items in {list} in-place. Returns {list}. If you |
| 5271 want a list to remain unmodified make a copy first: > | |
| 5272 :let sortedlist = sort(copy(mylist)) | |
| 5273 < Uses the string representation of each item to sort on. | |
| 692 | 5274 Numbers sort after Strings, |Lists| after Numbers. |
| 282 | 5275 For sorting text in the current buffer use |:sort|. |
| 82 | 5276 When {func} is given and it is one then case is ignored. |
| 685 | 5277 When {func} is a |Funcref| or a function name, this function |
| 5278 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
|
5279 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
|
5280 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
|
5281 smaller if the first one sorts before the second one. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5282 Example: > |
| 82 | 5283 func MyCompare(i1, i2) |
| 5284 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
| 5285 endfunc | |
| 5286 let sortedlist = sort(mylist, "MyCompare") | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5287 < A shorter compare version for this specific simple case, which |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5288 ignores overflow: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5289 func MyCompare(i1, i2) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5290 return a:i1 - a:i2 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5291 endfunc |
| 344 | 5292 < |
| 374 | 5293 *soundfold()* |
| 5294 soundfold({word}) | |
| 5295 Return the sound-folded equivalent of {word}. Uses the first | |
| 1621 | 5296 language in 'spelllang' for the current window that supports |
| 375 | 5297 soundfolding. 'spell' must be set. When no sound folding is |
| 5298 possible the {word} is returned unmodified. | |
| 374 | 5299 This can be used for making spelling suggestions. Note that |
| 5300 the method can be quite slow. | |
| 5301 | |
| 344 | 5302 *spellbadword()* |
| 532 | 5303 spellbadword([{sentence}]) |
| 5304 Without argument: The result is the badly spelled word under | |
| 5305 or after the cursor. The cursor is moved to the start of the | |
| 5306 bad word. When no bad word is found in the cursor line the | |
| 5307 result is an empty string and the cursor doesn't move. | |
| 5308 | |
| 5309 With argument: The result is the first word in {sentence} that | |
| 5310 is badly spelled. If there are no spelling mistakes the | |
| 5311 result is an empty string. | |
| 5312 | |
| 5313 The return value is a list with two items: | |
| 5314 - The badly spelled word or an empty string. | |
| 5315 - The type of the spelling error: | |
| 856 | 5316 "bad" spelling mistake |
| 532 | 5317 "rare" rare word |
| 5318 "local" word only valid in another region | |
| 5319 "caps" word should start with Capital | |
| 5320 Example: > | |
| 5321 echo spellbadword("the quik brown fox") | |
| 5322 < ['quik', 'bad'] ~ | |
| 5323 | |
| 5324 The spelling information for the current window is used. The | |
| 5325 'spell' option must be set and the value of 'spelllang' is | |
| 5326 used. | |
| 344 | 5327 |
| 5328 *spellsuggest()* | |
| 537 | 5329 spellsuggest({word} [, {max} [, {capital}]]) |
| 685 | 5330 Return a |List| with spelling suggestions to replace {word}. |
| 344 | 5331 When {max} is given up to this number of suggestions are |
| 5332 returned. Otherwise up to 25 suggestions are returned. | |
| 5333 | |
| 537 | 5334 When the {capital} argument is given and it's non-zero only |
| 5335 suggestions with a leading capital will be given. Use this | |
| 5336 after a match with 'spellcapcheck'. | |
| 5337 | |
| 344 | 5338 {word} can be a badly spelled word followed by other text. |
| 5339 This allows for joining two words that were split. The | |
| 359 | 5340 suggestions also include the following text, thus you can |
| 5341 replace a line. | |
| 5342 | |
| 5343 {word} may also be a good word. Similar words will then be | |
| 537 | 5344 returned. {word} itself is not included in the suggestions, |
| 5345 although it may appear capitalized. | |
| 344 | 5346 |
| 5347 The spelling information for the current window is used. The | |
| 375 | 5348 'spell' option must be set and the values of 'spelllang' and |
| 5349 'spellsuggest' are used. | |
| 344 | 5350 |
| 82 | 5351 |
| 282 | 5352 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
| 685 | 5353 Make a |List| out of {expr}. When {pattern} is omitted or |
| 5354 empty each white-separated sequence of characters becomes an | |
| 5355 item. | |
| 82 | 5356 Otherwise the string is split where {pattern} matches, |
| 282 | 5357 removing the matched characters. |
| 5358 When the first or last item is empty it is omitted, unless the | |
| 5359 {keepempty} argument is given and it's non-zero. | |
| 293 | 5360 Other empty items are kept when {pattern} matches at least one |
| 5361 character or when {keepempty} is non-zero. | |
| 82 | 5362 Example: > |
| 95 | 5363 :let words = split(getline('.'), '\W\+') |
| 282 | 5364 < To split a string in individual characters: > |
| 236 | 5365 :for c in split(mystring, '\zs') |
| 258 | 5366 < If you want to keep the separator you can also use '\zs': > |
| 5367 :echo split('abc:def:ghi', ':\zs') | |
| 5368 < ['abc:', 'def:', 'ghi'] ~ | |
| 282 | 5369 Splitting a table where the first element can be empty: > |
| 5370 :let items = split(line, ':', 1) | |
| 5371 < The opposite function is |join()|. | |
| 82 | 5372 |
| 5373 | |
| 1621 | 5374 sqrt({expr}) *sqrt()* |
| 5375 Return the non-negative square root of Float {expr} as a | |
| 5376 |Float|. | |
| 5377 {expr} must evaluate to a |Float| or a |Number|. When {expr} | |
| 5378 is negative the result is NaN (Not a Number). | |
| 5379 Examples: > | |
| 5380 :echo sqrt(100) | |
| 5381 < 10.0 > | |
| 5382 :echo sqrt(-4.01) | |
| 5383 < nan | |
| 1668 | 5384 "nan" may be different, it depends on system libraries. |
| 1621 | 5385 {only available when compiled with the |+float| feature} |
| 5386 | |
| 5387 | |
| 5388 str2float( {expr}) *str2float()* | |
| 5389 Convert String {expr} to a Float. This mostly works the same | |
| 5390 as when using a floating point number in an expression, see | |
| 5391 |floating-point-format|. But it's a bit more permissive. | |
| 5392 E.g., "1e40" is accepted, while in an expression you need to | |
| 5393 write "1.0e40". | |
| 5394 Text after the number is silently ignored. | |
| 5395 The decimal point is always '.', no matter what the locale is | |
| 5396 set to. A comma ends the number: "12,345.67" is converted to | |
| 5397 12.0. You can strip out thousands separators with | |
| 5398 |substitute()|: > | |
| 5399 let f = str2float(substitute(text, ',', '', 'g')) | |
| 5400 < {only available when compiled with the |+float| feature} | |
| 5401 | |
| 5402 | |
| 782 | 5403 str2nr( {expr} [, {base}]) *str2nr()* |
| 5404 Convert string {expr} to a number. | |
| 5405 {base} is the conversion base, it can be 8, 10 or 16. | |
| 5406 When {base} is omitted base 10 is used. This also means that | |
| 5407 a leading zero doesn't cause octal conversion to be used, as | |
| 5408 with the default String to Number conversion. | |
| 5409 When {base} is 16 a leading "0x" or "0X" is ignored. With a | |
| 5410 different base the result will be zero. | |
| 5411 Text after the number is silently ignored. | |
| 856 | 5412 |
| 782 | 5413 |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5414 strchars({expr}) *strchars()* |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5415 The result is a Number, which is the number of characters |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5416 String {expr} occupies. Composing characters are counted |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5417 separately. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5418 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5419 |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5420 strdisplaywidth({expr}[, {col}]) *strdisplaywidth()* |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5421 The result is a Number, which is the number of display cells |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5422 String {expr} occupies on the screen. |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5423 When {col} is omitted zero is used. Otherwise it is the |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5424 screen column where to start. This matters for Tab |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5425 characters. |
|
2343
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
5426 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
|
5427 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
|
5428 'tabstop' and 'display'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5429 When {expr} contains characters with East Asian Width Class |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5430 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5431 Also see |strlen()|, |strwidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5432 |
| 7 | 5433 strftime({format} [, {time}]) *strftime()* |
| 5434 The result is a String, which is a formatted date and time, as | |
| 5435 specified by the {format} string. The given {time} is used, | |
| 5436 or the current time if no time is given. The accepted | |
| 5437 {format} depends on your system, thus this is not portable! | |
| 5438 See the manual page of the C function strftime() for the | |
| 5439 format. The maximum length of the result is 80 characters. | |
| 5440 See also |localtime()| and |getftime()|. | |
| 5441 The language can be changed with the |:language| command. | |
| 5442 Examples: > | |
| 5443 :echo strftime("%c") Sun Apr 27 11:49:23 1997 | |
| 5444 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 | |
| 5445 :echo strftime("%y%m%d %T") 970427 11:53:55 | |
| 5446 :echo strftime("%H:%M") 11:55 | |
| 5447 :echo strftime("%c", getftime("file.c")) | |
| 5448 Show mod time of file.c. | |
| 82 | 5449 < Not available on all systems. To check use: > |
| 5450 :if exists("*strftime") | |
| 5451 | |
| 133 | 5452 stridx({haystack}, {needle} [, {start}]) *stridx()* |
| 5453 The result is a Number, which gives the byte index in | |
| 5454 {haystack} of the first occurrence of the String {needle}. | |
| 140 | 5455 If {start} is specified, the search starts at index {start}. |
| 5456 This can be used to find a second match: > | |
| 5457 :let comma1 = stridx(line, ",") | |
| 5458 :let comma2 = stridx(line, ",", comma1 + 1) | |
| 5459 < The search is done case-sensitive. | |
| 205 | 5460 For pattern searches use |match()|. |
| 133 | 5461 -1 is returned if the {needle} does not occur in {haystack}. |
| 140 | 5462 See also |strridx()|. |
| 5463 Examples: > | |
| 7 | 5464 :echo stridx("An Example", "Example") 3 |
| 5465 :echo stridx("Starting point", "Start") 0 | |
| 5466 :echo stridx("Starting point", "start") -1 | |
| 856 | 5467 < *strstr()* *strchr()* |
| 170 | 5468 stridx() works similar to the C function strstr(). When used |
| 5469 with a single character it works similar to strchr(). | |
| 5470 | |
| 55 | 5471 *string()* |
| 95 | 5472 string({expr}) Return {expr} converted to a String. If {expr} is a Number, |
| 1621 | 5473 Float, String or a composition of them, then the result can be |
| 5474 parsed back with |eval()|. | |
| 55 | 5475 {expr} type result ~ |
| 99 | 5476 String 'string' |
| 95 | 5477 Number 123 |
| 1621 | 5478 Float 123.123456 or 1.123456e8 |
| 99 | 5479 Funcref function('name') |
| 95 | 5480 List [item, item] |
| 323 | 5481 Dictionary {key: value, key: value} |
| 99 | 5482 Note that in String values the ' character is doubled. |
| 1156 | 5483 Also see |strtrans()|. |
| 55 | 5484 |
| 7 | 5485 *strlen()* |
| 5486 strlen({expr}) The result is a Number, which is the length of the String | |
| 502 | 5487 {expr} in bytes. |
| 5488 If you want to count the number of multi-byte characters (not | |
| 5489 counting composing characters) use something like this: > | |
| 7 | 5490 |
| 5491 :let len = strlen(substitute(str, ".", "x", "g")) | |
| 502 | 5492 < |
| 55 | 5493 If the argument is a Number it is first converted to a String. |
| 5494 For other types an error is given. | |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5495 Also see |len()|, |strchars()|, |strdisplaywidth()| and |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5496 |strwidth()|. |
| 7 | 5497 |
| 5498 strpart({src}, {start}[, {len}]) *strpart()* | |
| 5499 The result is a String, which is part of {src}, starting from | |
| 574 | 5500 byte {start}, with the byte length {len}. |
| 7 | 5501 When non-existing bytes are included, this doesn't result in |
| 5502 an error, the bytes are simply omitted. | |
| 5503 If {len} is missing, the copy continues from {start} till the | |
| 5504 end of the {src}. > | |
| 5505 strpart("abcdefg", 3, 2) == "de" | |
| 5506 strpart("abcdefg", -2, 4) == "ab" | |
| 5507 strpart("abcdefg", 5, 4) == "fg" | |
| 1621 | 5508 strpart("abcdefg", 3) == "defg" |
| 7 | 5509 < Note: To get the first character, {start} must be 0. For |
| 5510 example, to get three bytes under and after the cursor: > | |
| 823 | 5511 strpart(getline("."), col(".") - 1, 3) |
| 7 | 5512 < |
| 140 | 5513 strridx({haystack}, {needle} [, {start}]) *strridx()* |
| 5514 The result is a Number, which gives the byte index in | |
| 5515 {haystack} of the last occurrence of the String {needle}. | |
| 5516 When {start} is specified, matches beyond this index are | |
| 5517 ignored. This can be used to find a match before a previous | |
| 5518 match: > | |
| 5519 :let lastcomma = strridx(line, ",") | |
| 5520 :let comma2 = strridx(line, ",", lastcomma - 1) | |
| 5521 < The search is done case-sensitive. | |
| 133 | 5522 For pattern searches use |match()|. |
| 5523 -1 is returned if the {needle} does not occur in {haystack}. | |
| 22 | 5524 If the {needle} is empty the length of {haystack} is returned. |
| 236 | 5525 See also |stridx()|. Examples: > |
| 7 | 5526 :echo strridx("an angry armadillo", "an") 3 |
| 856 | 5527 < *strrchr()* |
| 170 | 5528 When used with a single character it works similar to the C |
| 5529 function strrchr(). | |
| 5530 | |
| 7 | 5531 strtrans({expr}) *strtrans()* |
| 5532 The result is a String, which is {expr} with all unprintable | |
| 5533 characters translated into printable characters |'isprint'|. | |
| 5534 Like they are shown in a window. Example: > | |
| 5535 echo strtrans(@a) | |
| 5536 < This displays a newline in register a as "^@" instead of | |
| 5537 starting a new line. | |
| 5538 | |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5539 strwidth({expr}) *strwidth()* |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5540 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
|
5541 String {expr} occupies. A Tab character is counted as one |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5542 cell, alternatively use |strdisplaywidth()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5543 When {expr} contains characters with East Asian Width Class |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5544 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
5545 Also see |strlen()|, |strdisplaywidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
5546 |
| 7 | 5547 submatch({nr}) *submatch()* |
| 5548 Only for an expression in a |:substitute| command. Returns | |
| 5549 the {nr}'th submatch of the matched text. When {nr} is 0 | |
| 5550 the whole matched text is returned. | |
| 5551 Example: > | |
| 5552 :s/\d\+/\=submatch(0) + 1/ | |
| 5553 < This finds the first number in the line and adds one to it. | |
| 5554 A line break is included as a newline character. | |
| 5555 | |
| 5556 substitute({expr}, {pat}, {sub}, {flags}) *substitute()* | |
| 5557 The result is a String, which is a copy of {expr}, in which | |
| 5558 the first match of {pat} is replaced with {sub}. This works | |
| 5559 like the ":substitute" command (without any flags). But the | |
| 5560 matching with {pat} is always done like the 'magic' option is | |
| 5561 set and 'cpoptions' is empty (to make scripts portable). | |
| 1156 | 5562 'ignorecase' is still relevant. 'smartcase' is not used. |
| 7 | 5563 See |string-match| for how {pat} is used. |
| 5564 And a "~" in {sub} is not replaced with the previous {sub}. | |
| 5565 Note that some codes in {sub} have a special meaning | |
| 1621 | 5566 |sub-replace-special|. For example, to replace something with |
| 7 | 5567 "\n" (two characters), use "\\\\n" or '\\n'. |
| 5568 When {pat} does not match in {expr}, {expr} is returned | |
| 5569 unmodified. | |
| 5570 When {flags} is "g", all matches of {pat} in {expr} are | |
| 5571 replaced. Otherwise {flags} should be "". | |
| 5572 Example: > | |
| 5573 :let &path = substitute(&path, ",\\=[^,]*$", "", "") | |
| 5574 < This removes the last component of the 'path' option. > | |
| 5575 :echo substitute("testing", ".*", "\\U\\0", "") | |
| 5576 < results in "TESTING". | |
| 5577 | |
| 32 | 5578 synID({lnum}, {col}, {trans}) *synID()* |
| 7 | 5579 The result is a Number, which is the syntax ID at the position |
| 32 | 5580 {lnum} and {col} in the current window. |
| 7 | 5581 The syntax ID can be used with |synIDattr()| and |
| 5582 |synIDtrans()| to obtain syntax information about text. | |
| 419 | 5583 |
| 32 | 5584 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
| 419 | 5585 line. 'synmaxcol' applies, in a longer line zero is returned. |
| 5586 | |
| 7 | 5587 When {trans} is non-zero, transparent items are reduced to the |
| 1621 | 5588 item that they reveal. This is useful when wanting to know |
| 7 | 5589 the effective color. When {trans} is zero, the transparent |
| 5590 item is returned. This is useful when wanting to know which | |
| 5591 syntax item is effective (e.g. inside parens). | |
| 5592 Warning: This function can be very slow. Best speed is | |
| 5593 obtained by going through the file in forward direction. | |
| 5594 | |
| 5595 Example (echoes the name of the syntax item under the cursor): > | |
| 5596 :echo synIDattr(synID(line("."), col("."), 1), "name") | |
| 5597 < | |
|
2401
e7751177126b
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
5598 |
| 7 | 5599 synIDattr({synID}, {what} [, {mode}]) *synIDattr()* |
| 5600 The result is a String, which is the {what} attribute of | |
| 5601 syntax ID {synID}. This can be used to obtain information | |
| 5602 about a syntax item. | |
| 5603 {mode} can be "gui", "cterm" or "term", to get the attributes | |
| 1621 | 5604 for that mode. When {mode} is omitted, or an invalid value is |
| 7 | 5605 used, the attributes for the currently active highlighting are |
| 5606 used (GUI, cterm or term). | |
| 5607 Use synIDtrans() to follow linked highlight groups. | |
| 5608 {what} result | |
| 5609 "name" the name of the syntax item | |
| 5610 "fg" foreground color (GUI: color name used to set | |
| 5611 the color, cterm: color number as a string, | |
| 5612 term: empty string) | |
| 1755 | 5613 "bg" background color (as with "fg") |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
5614 "font" font name (only available in the GUI) |
|
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
5615 |highlight-font| |
| 1755 | 5616 "sp" special color (as with "fg") |highlight-guisp| |
| 7 | 5617 "fg#" like "fg", but for the GUI and the GUI is |
| 5618 running the name in "#RRGGBB" form | |
| 5619 "bg#" like "fg#" for "bg" | |
| 1755 | 5620 "sp#" like "fg#" for "sp" |
| 7 | 5621 "bold" "1" if bold |
| 5622 "italic" "1" if italic | |
| 5623 "reverse" "1" if reverse | |
| 5624 "inverse" "1" if inverse (= reverse) | |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
5625 "standout" "1" if standout |
| 7 | 5626 "underline" "1" if underlined |
| 205 | 5627 "undercurl" "1" if undercurled |
| 7 | 5628 |
| 5629 Example (echoes the color of the syntax item under the | |
| 5630 cursor): > | |
| 5631 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
| 5632 < | |
| 5633 synIDtrans({synID}) *synIDtrans()* | |
| 5634 The result is a Number, which is the translated syntax ID of | |
| 5635 {synID}. This is the syntax group ID of what is being used to | |
| 5636 highlight the character. Highlight links given with | |
| 5637 ":highlight link" are followed. | |
| 5638 | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5639 synconcealed({lnum}, {col}) *synconcealed()* |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5640 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
|
5641 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
|
5642 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
|
5643 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
|
5644 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
|
5645 depending on the current setting of 'conceallevel'. The third |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5646 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
|
5647 specific syntax region matched. This allows detection of the |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5648 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
|
5649 consecutive regions with the same replacement character. |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5650 For an example use see $VIMRUNTIME/syntax/2html.vim . |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5651 |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
5652 |
| 1500 | 5653 synstack({lnum}, {col}) *synstack()* |
| 5654 Return a |List|, which is the stack of syntax items at the | |
| 5655 position {lnum} and {col} in the current window. Each item in | |
| 5656 the List is an ID like what |synID()| returns. | |
| 5657 The first item in the List is the outer region, following are | |
| 5658 items contained in that one. The last one is what |synID()| | |
| 5659 returns, unless not the whole item is highlighted or it is a | |
| 5660 transparent item. | |
| 5661 This function is useful for debugging a syntax file. | |
| 5662 Example that shows the syntax stack under the cursor: > | |
| 5663 for id in synstack(line("."), col(".")) | |
| 5664 echo synIDattr(id, "name") | |
| 5665 endfor | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
5666 < 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
|
5667 nothing is returned. The position just after the last |
|
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
5668 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
|
5669 valid positions. |
| 1500 | 5670 |
| 24 | 5671 system({expr} [, {input}]) *system()* *E677* |
| 5672 Get the output of the shell command {expr}. | |
| 5673 When {input} is given, this string is written to a file and | |
| 5674 passed as stdin to the command. The string is written as-is, | |
| 5675 you need to take care of using the correct line separators | |
| 170 | 5676 yourself. Pipes are not used. |
| 1661 | 5677 Note: Use |shellescape()| to escape special characters in a |
| 5678 command argument. Newlines in {expr} may cause the command to | |
| 5679 fail. The characters in 'shellquote' and 'shellxquote' may | |
| 5680 also cause trouble. | |
| 7 | 5681 This is not to be used for interactive commands. |
| 1661 | 5682 |
| 7 | 5683 The result is a String. Example: > |
| 1661 | 5684 :let files = system("ls " . shellescape(expand('%:h'))) |
| 7 | 5685 |
| 5686 < To make the result more system-independent, the shell output | |
| 5687 is filtered to replace <CR> with <NL> for Macintosh, and | |
| 5688 <CR><NL> with <NL> for DOS-like systems. | |
| 5689 The command executed is constructed using several options: | |
| 5690 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
| 5691 ({tmp} is an automatically generated file name). | |
| 5692 For Unix and OS/2 braces are put around {expr} to allow for | |
| 5693 concatenated commands. | |
| 5694 | |
| 794 | 5695 The command will be executed in "cooked" mode, so that a |
| 5696 CTRL-C will interrupt the command (on Unix at least). | |
| 5697 | |
| 7 | 5698 The resulting error code can be found in |v:shell_error|. |
| 5699 This function will fail in |restricted-mode|. | |
| 625 | 5700 |
| 5701 Note that any wrong value in the options mentioned above may | |
| 5702 make the function fail. It has also been reported to fail | |
| 5703 when using a security agent application. | |
| 7 | 5704 Unlike ":!cmd" there is no automatic check for changed files. |
| 5705 Use |:checktime| to force a check. | |
| 5706 | |
| 205 | 5707 |
| 677 | 5708 tabpagebuflist([{arg}]) *tabpagebuflist()* |
| 685 | 5709 The result is a |List|, where each item is the number of the |
| 677 | 5710 buffer associated with each window in the current tab page. |
| 5711 {arg} specifies the number of tab page to be used. When | |
| 5712 omitted the current tab page is used. | |
| 5713 When {arg} is invalid the number zero is returned. | |
| 5714 To get a list of all buffers in all tabs use this: > | |
| 5715 tablist = [] | |
| 5716 for i in range(tabpagenr('$')) | |
| 5717 call extend(tablist, tabpagebuflist(i + 1)) | |
| 5718 endfor | |
| 5719 < Note that a buffer may appear in more than one window. | |
| 5720 | |
| 5721 | |
| 5722 tabpagenr([{arg}]) *tabpagenr()* | |
| 674 | 5723 The result is a Number, which is the number of the current |
| 5724 tab page. The first tab page has number 1. | |
| 5725 When the optional argument is "$", the number of the last tab | |
| 5726 page is returned (the tab page count). | |
| 5727 The number can be used with the |:tab| command. | |
| 5728 | |
| 5729 | |
| 677 | 5730 tabpagewinnr({tabarg}, [{arg}]) *tabpagewinnr()* |
|
2569
f612f6b0b883
Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5731 Like |winnr()| but for tab page {tabarg}. |
| 677 | 5732 {tabarg} specifies the number of tab page to be used. |
| 5733 {arg} is used like with |winnr()|: | |
| 5734 - When omitted the current window number is returned. This is | |
| 5735 the window which will be used when going to this tab page. | |
| 5736 - When "$" the number of windows is returned. | |
| 5737 - When "#" the previous window nr is returned. | |
| 5738 Useful examples: > | |
| 5739 tabpagewinnr(1) " current window of tab page 1 | |
| 5740 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
| 5741 < When {tabarg} is invalid zero is returned. | |
| 5742 | |
| 805 | 5743 *tagfiles()* |
| 5744 tagfiles() Returns a |List| with the file names used to search for tags | |
| 5745 for the current buffer. This is the 'tags' option expanded. | |
| 5746 | |
| 5747 | |
| 205 | 5748 taglist({expr}) *taglist()* |
| 5749 Returns a list of tags matching the regular expression {expr}. | |
| 438 | 5750 Each list item is a dictionary with at least the following |
| 5751 entries: | |
| 648 | 5752 name Name of the tag. |
| 5753 filename Name of the file where the tag is | |
| 1156 | 5754 defined. It is either relative to the |
| 5755 current directory or a full path. | |
| 205 | 5756 cmd Ex command used to locate the tag in |
| 5757 the file. | |
| 648 | 5758 kind Type of the tag. The value for this |
| 205 | 5759 entry depends on the language specific |
| 1156 | 5760 kind values. Only available when |
| 5761 using a tags file generated by | |
| 5762 Exuberant ctags or hdrtag. | |
| 648 | 5763 static A file specific tag. Refer to |
| 205 | 5764 |static-tag| for more information. |
| 1156 | 5765 More entries may be present, depending on the content of the |
| 5766 tags file: access, implementation, inherits and signature. | |
| 5767 Refer to the ctags documentation for information about these | |
| 5768 fields. For C code the fields "struct", "class" and "enum" | |
| 5769 may appear, they give the name of the entity the tag is | |
| 5770 contained in. | |
| 452 | 5771 |
| 216 | 5772 The ex-command 'cmd' can be either an ex search pattern, a |
| 5773 line number or a line number followed by a byte number. | |
| 205 | 5774 |
| 5775 If there are no matching tags, then an empty list is returned. | |
| 5776 | |
| 5777 To get an exact tag match, the anchors '^' and '$' should be | |
| 5778 used in {expr}. Refer to |tag-regexp| for more information | |
| 5779 about the tag search regular expression pattern. | |
| 5780 | |
| 5781 Refer to |'tags'| for information about how the tags file is | |
| 5782 located by Vim. Refer to |tags-file-format| for the format of | |
| 5783 the tags file generated by the different ctags tools. | |
| 5784 | |
| 7 | 5785 tempname() *tempname()* *temp-file-name* |
| 5786 The result is a String, which is the name of a file that | |
| 1621 | 5787 doesn't exist. It can be used for a temporary file. The name |
| 7 | 5788 is different for at least 26 consecutive calls. Example: > |
| 5789 :let tmpfile = tempname() | |
| 5790 :exe "redir > " . tmpfile | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5791 < For Unix, the file will be in a private directory |tempfile|. |
| 7 | 5792 For MS-Windows forward slashes are used when the 'shellslash' |
| 5793 option is set or when 'shellcmdflag' starts with '-'. | |
| 5794 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5795 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5796 tan({expr}) *tan()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5797 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
|
5798 in the range [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5799 {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
|
5800 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5801 :echo tan(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5802 < 0.648361 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5803 :echo tan(-4.01) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5804 < -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
|
5805 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5806 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5807 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5808 tanh({expr}) *tanh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5809 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
|
5810 range [-1, 1]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5811 {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
|
5812 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5813 :echo tanh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5814 < 0.462117 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5815 :echo tanh(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5816 < -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
|
5817 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5818 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5819 |
| 7 | 5820 tolower({expr}) *tolower()* |
| 5821 The result is a copy of the String given, with all uppercase | |
| 5822 characters turned into lowercase (just like applying |gu| to | |
| 5823 the string). | |
| 5824 | |
| 5825 toupper({expr}) *toupper()* | |
| 5826 The result is a copy of the String given, with all lowercase | |
| 5827 characters turned into uppercase (just like applying |gU| to | |
| 5828 the string). | |
| 5829 | |
| 15 | 5830 tr({src}, {fromstr}, {tostr}) *tr()* |
| 5831 The result is a copy of the {src} string with all characters | |
| 5832 which appear in {fromstr} replaced by the character in that | |
| 5833 position in the {tostr} string. Thus the first character in | |
| 5834 {fromstr} is translated into the first character in {tostr} | |
| 5835 and so on. Exactly like the unix "tr" command. | |
| 5836 This code also deals with multibyte characters properly. | |
| 5837 | |
| 5838 Examples: > | |
| 5839 echo tr("hello there", "ht", "HT") | |
| 5840 < returns "Hello THere" > | |
| 5841 echo tr("<blob>", "<>", "{}") | |
| 5842 < returns "{blob}" | |
| 5843 | |
| 1621 | 5844 trunc({expr}) *trunc()* |
| 1668 | 5845 Return the largest integral value with magnitude less than or |
| 1621 | 5846 equal to {expr} as a |Float| (truncate towards zero). |
| 5847 {expr} must evaluate to a |Float| or a |Number|. | |
| 5848 Examples: > | |
| 5849 echo trunc(1.456) | |
| 5850 < 1.0 > | |
| 5851 echo trunc(-5.456) | |
| 5852 < -5.0 > | |
| 5853 echo trunc(4.0) | |
| 5854 < 4.0 | |
| 5855 {only available when compiled with the |+float| feature} | |
| 5856 | |
| 87 | 5857 *type()* |
| 5858 type({expr}) The result is a Number, depending on the type of {expr}: | |
| 153 | 5859 Number: 0 |
| 5860 String: 1 | |
| 5861 Funcref: 2 | |
| 5862 List: 3 | |
| 5863 Dictionary: 4 | |
| 1621 | 5864 Float: 5 |
| 153 | 5865 To avoid the magic numbers it should be used this way: > |
| 87 | 5866 :if type(myvar) == type(0) |
| 5867 :if type(myvar) == type("") | |
| 5868 :if type(myvar) == type(function("tr")) | |
| 5869 :if type(myvar) == type([]) | |
| 153 | 5870 :if type(myvar) == type({}) |
| 1621 | 5871 :if type(myvar) == type(0.0) |
| 7 | 5872 |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
5873 undofile({name}) *undofile()* |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
5874 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
|
5875 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
|
5876 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
|
5877 the undo file exists. |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
5878 {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
|
5879 is used internally. |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
5880 Useful in combination with |:wundo| and |:rundo|. |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
5881 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
|
5882 returns an empty string. |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
5883 |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5884 undotree() *undotree()* |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5885 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
|
5886 the following items: |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5887 "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
|
5888 "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
|
5889 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
|
5890 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
|
5891 "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
|
5892 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
|
5893 something readable. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5894 "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
|
5895 write yet. |
|
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
5896 "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
|
5897 tree. |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5898 "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
|
5899 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
|
5900 user. See |undo-blocks|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5901 "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
|
5902 undo blocks. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5903 |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5904 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
|
5905 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
|
5906 "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
|
5907 |:undolist|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5908 "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
|
5909 |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
|
5910 "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
|
5911 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
|
5912 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
|
5913 "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
|
5914 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
|
5915 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
|
5916 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
|
5917 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
|
5918 not appear anywhere. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5919 "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
|
5920 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
|
5921 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
|
5922 "save_last" mentioned above. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5923 "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
|
5924 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
|
5925 item. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
5926 |
| 140 | 5927 values({dict}) *values()* |
| 1621 | 5928 Return a |List| with all the values of {dict}. The |List| is |
| 685 | 5929 in arbitrary order. |
| 140 | 5930 |
| 5931 | |
| 7 | 5932 virtcol({expr}) *virtcol()* |
| 5933 The result is a Number, which is the screen column of the file | |
| 5934 position given with {expr}. That is, the last screen position | |
| 5935 occupied by the character at that position, when the screen | |
| 5936 would be of unlimited width. When there is a <Tab> at the | |
| 5937 position, the returned Number will be the column at the end of | |
| 5938 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
| 5939 set to 8, it returns 8. | |
| 1317 | 5940 For the byte position use |col()|. |
| 5941 For the use of {expr} see |col()|. | |
| 5942 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
| 703 | 5943 "off" is the offset in screen columns from the start of the |
| 1266 | 5944 character. E.g., a position within a <Tab> or after the last |
| 703 | 5945 character. |
| 7 | 5946 When Virtual editing is active in the current mode, a position |
| 5947 beyond the end of the line can be returned. |'virtualedit'| | |
| 5948 The accepted positions are: | |
| 5949 . the cursor position | |
| 5950 $ the end of the cursor line (the result is the | |
| 5951 number of displayed characters in the cursor line | |
| 5952 plus one) | |
| 5953 'x position of mark x (if the mark is not set, 0 is | |
| 5954 returned) | |
| 5955 Note that only marks in the current file can be used. | |
| 5956 Examples: > | |
| 5957 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
| 5958 virtcol("$") with text "foo^Lbar", returns 9 | |
| 1621 | 5959 virtcol("'t") with text " there", with 't at 'h', returns 6 |
| 5960 < The first column is 1. 0 is returned for an error. | |
| 1156 | 5961 A more advanced example that echoes the maximum length of |
| 5962 all lines: > | |
| 5963 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
| 5964 | |
| 7 | 5965 |
| 5966 visualmode([expr]) *visualmode()* | |
| 5967 The result is a String, which describes the last Visual mode | |
| 856 | 5968 used in the current buffer. Initially it returns an empty |
| 5969 string, but once Visual mode has been used, it returns "v", | |
| 5970 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
| 5971 character-wise, line-wise, or block-wise Visual mode | |
| 5972 respectively. | |
| 7 | 5973 Example: > |
| 5974 :exe "normal " . visualmode() | |
| 5975 < This enters the same Visual mode as before. It is also useful | |
| 5976 in scripts if you wish to act differently depending on the | |
| 5977 Visual mode that was used. | |
| 1621 | 5978 If Visual mode is active, use |mode()| to get the Visual mode |
| 5979 (e.g., in a |:vmap|). | |
| 1661 | 5980 *non-zero-arg* |
| 5981 If [expr] is supplied and it evaluates to a non-zero Number or | |
| 5982 a non-empty String, then the Visual mode will be cleared and | |
| 1621 | 5983 the old value is returned. Note that " " and "0" are also |
| 1661 | 5984 non-empty strings, thus cause the mode to be cleared. A List, |
| 5985 Dictionary or Float is not a Number or String, thus does not | |
| 5986 cause the mode to be cleared. | |
| 7 | 5987 |
| 5988 *winbufnr()* | |
| 5989 winbufnr({nr}) The result is a Number, which is the number of the buffer | |
| 236 | 5990 associated with window {nr}. When {nr} is zero, the number of |
| 7 | 5991 the buffer in the current window is returned. When window |
| 5992 {nr} doesn't exist, -1 is returned. | |
| 5993 Example: > | |
| 5994 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
| 5995 < | |
| 5996 *wincol()* | |
| 5997 wincol() The result is a Number, which is the virtual column of the | |
| 5998 cursor in the window. This is counting screen cells from the | |
| 5999 left side of the window. The leftmost column is one. | |
| 6000 | |
| 6001 winheight({nr}) *winheight()* | |
| 6002 The result is a Number, which is the height of window {nr}. | |
| 6003 When {nr} is zero, the height of the current window is | |
| 6004 returned. When window {nr} doesn't exist, -1 is returned. | |
| 6005 An existing window always has a height of zero or more. | |
| 6006 Examples: > | |
| 6007 :echo "The current window has " . winheight(0) . " lines." | |
| 6008 < | |
| 6009 *winline()* | |
| 6010 winline() The result is a Number, which is the screen line of the cursor | |
| 1621 | 6011 in the window. This is counting screen lines from the top of |
| 7 | 6012 the window. The first line is one. |
| 531 | 6013 If the cursor was moved the view on the file will be updated |
| 6014 first, this may cause a scroll. | |
| 7 | 6015 |
| 6016 *winnr()* | |
| 20 | 6017 winnr([{arg}]) The result is a Number, which is the number of the current |
| 6018 window. The top window has number 1. | |
| 6019 When the optional argument is "$", the number of the | |
| 674 | 6020 last window is returned (the window count). |
| 20 | 6021 When the optional argument is "#", the number of the last |
| 6022 accessed window is returned (where |CTRL-W_p| goes to). | |
| 1156 | 6023 If there is no previous window or it is in another tab page 0 |
| 6024 is returned. | |
| 20 | 6025 The number can be used with |CTRL-W_w| and ":wincmd w" |
| 6026 |:wincmd|. | |
| 1156 | 6027 Also see |tabpagewinnr()|. |
| 7 | 6028 |
| 6029 *winrestcmd()* | |
| 6030 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
| 6031 the current window sizes. Only works properly when no windows | |
| 712 | 6032 are opened or closed and the current window and tab page is |
| 6033 unchanged. | |
| 7 | 6034 Example: > |
| 6035 :let cmd = winrestcmd() | |
| 6036 :call MessWithWindowSizes() | |
| 6037 :exe cmd | |
| 712 | 6038 < |
| 6039 *winrestview()* | |
| 6040 winrestview({dict}) | |
| 6041 Uses the |Dictionary| returned by |winsaveview()| to restore | |
| 6042 the view of the current window. | |
| 6043 If you have changed the values the result is unpredictable. | |
| 6044 If the window size changed the result won't be the same. | |
| 6045 | |
| 6046 *winsaveview()* | |
| 6047 winsaveview() Returns a |Dictionary| that contains information to restore | |
| 6048 the view of the current window. Use |winrestview()| to | |
| 6049 restore the view. | |
| 6050 This is useful if you have a mapping that jumps around in the | |
| 6051 buffer and you want to go back to the original view. | |
| 6052 This does not save fold information. Use the 'foldenable' | |
| 798 | 6053 option to temporarily switch off folding, so that folds are |
| 6054 not opened when moving around. | |
| 712 | 6055 The return value includes: |
| 6056 lnum cursor line number | |
| 6057 col cursor column | |
| 6058 coladd cursor column offset for 'virtualedit' | |
| 6059 curswant column for vertical movement | |
| 6060 topline first line in the window | |
| 6061 topfill filler lines, only in diff mode | |
| 6062 leftcol first column displayed | |
| 6063 skipcol columns skipped | |
| 6064 Note that no option values are saved. | |
| 6065 | |
| 7 | 6066 |
| 6067 winwidth({nr}) *winwidth()* | |
| 6068 The result is a Number, which is the width of window {nr}. | |
| 6069 When {nr} is zero, the width of the current window is | |
| 6070 returned. When window {nr} doesn't exist, -1 is returned. | |
| 6071 An existing window always has a width of zero or more. | |
| 6072 Examples: > | |
| 6073 :echo "The current window has " . winwidth(0) . " columns." | |
| 6074 :if winwidth(0) <= 50 | |
| 6075 : exe "normal 50\<C-W>|" | |
| 6076 :endif | |
| 6077 < | |
| 158 | 6078 *writefile()* |
| 6079 writefile({list}, {fname} [, {binary}]) | |
| 685 | 6080 Write |List| {list} to file {fname}. Each list item is |
| 158 | 6081 separated with a NL. Each list item must be a String or |
| 6082 Number. | |
| 6083 When {binary} is equal to "b" binary mode is used: There will | |
| 6084 not be a NL after the last list item. An empty item at the | |
| 6085 end does cause the last line in the file to end in a NL. | |
| 6086 All NL characters are replaced with a NUL character. | |
| 6087 Inserting CR characters needs to be done before passing {list} | |
| 6088 to writefile(). | |
| 6089 An existing file is overwritten, if possible. | |
| 6090 When the write fails -1 is returned, otherwise 0. There is an | |
| 6091 error message if the file can't be created or when writing | |
| 6092 fails. | |
| 6093 Also see |readfile()|. | |
| 6094 To copy a file byte for byte: > | |
| 6095 :let fl = readfile("foo", "b") | |
| 6096 :call writefile(fl, "foocopy", "b") | |
| 6097 < | |
| 7 | 6098 |
| 6099 *feature-list* | |
| 6100 There are three types of features: | |
| 6101 1. Features that are only supported when they have been enabled when Vim | |
| 6102 was compiled |+feature-list|. Example: > | |
| 6103 :if has("cindent") | |
| 6104 2. Features that are only supported when certain conditions have been met. | |
| 6105 Example: > | |
| 6106 :if has("gui_running") | |
| 6107 < *has-patch* | |
| 6108 3. Included patches. First check |v:version| for the version of Vim. | |
| 6109 Then the "patch123" feature means that patch 123 has been included for | |
| 6110 this version. Example (checking version 6.2.148 or later): > | |
| 6111 :if v:version > 602 || v:version == 602 && has("patch148") | |
| 1156 | 6112 < Note that it's possible for patch 147 to be omitted even though 148 is |
| 6113 included. | |
| 7 | 6114 |
| 6115 all_builtin_terms Compiled with all builtin terminals enabled. | |
| 6116 amiga Amiga version of Vim. | |
| 6117 arabic Compiled with Arabic support |Arabic|. | |
| 6118 arp Compiled with ARP support (Amiga). | |
| 613 | 6119 autocmd Compiled with autocommand support. |autocommand| |
| 7 | 6120 balloon_eval Compiled with |balloon-eval| support. |
| 435 | 6121 balloon_multiline GUI supports multiline balloons. |
| 7 | 6122 beos BeOS version of Vim. |
| 6123 browse Compiled with |:browse| support, and browse() will | |
| 6124 work. | |
| 6125 builtin_terms Compiled with some builtin terminals. | |
| 6126 byte_offset Compiled with support for 'o' in 'statusline' | |
| 6127 cindent Compiled with 'cindent' support. | |
| 6128 clientserver Compiled with remote invocation support |clientserver|. | |
| 6129 clipboard Compiled with 'clipboard' support. | |
| 6130 cmdline_compl Compiled with |cmdline-completion| support. | |
| 6131 cmdline_hist Compiled with |cmdline-history| support. | |
| 6132 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
| 6133 comments Compiled with |'comments'| support. | |
| 6134 cryptv Compiled with encryption support |encryption|. | |
| 6135 cscope Compiled with |cscope| support. | |
| 6136 compatible Compiled to be very Vi compatible. | |
| 6137 debug Compiled with "DEBUG" defined. | |
| 6138 dialog_con Compiled with console dialog support. | |
| 6139 dialog_gui Compiled with GUI dialog support. | |
| 6140 diff Compiled with |vimdiff| and 'diff' support. | |
| 6141 digraphs Compiled with support for digraphs. | |
| 6142 dnd Compiled with support for the "~ register |quote_~|. | |
| 6143 dos32 32 bits DOS (DJGPP) version of Vim. | |
| 6144 dos16 16 bits DOS version of Vim. | |
| 6145 ebcdic Compiled on a machine with ebcdic character set. | |
| 6146 emacs_tags Compiled with support for Emacs tags. | |
| 6147 eval Compiled with expression evaluation support. Always | |
| 6148 true, of course! | |
| 6149 ex_extra Compiled with extra Ex commands |+ex_extra|. | |
| 6150 extra_search Compiled with support for |'incsearch'| and | |
| 6151 |'hlsearch'| | |
| 6152 farsi Compiled with Farsi support |farsi|. | |
| 6153 file_in_path Compiled with support for |gf| and |<cfile>| | |
| 168 | 6154 filterpipe When 'shelltemp' is off pipes are used for shell |
| 6155 read/write/filter commands | |
| 7 | 6156 find_in_path Compiled with support for include file searches |
| 6157 |+find_in_path|. | |
| 1621 | 6158 float Compiled with support for |Float|. |
| 7 | 6159 fname_case Case in file names matters (for Amiga, MS-DOS, and |
| 6160 Windows this is not present). | |
| 6161 folding Compiled with |folding| support. | |
| 6162 footer Compiled with GUI footer support. |gui-footer| | |
| 6163 fork Compiled to use fork()/exec() instead of system(). | |
| 6164 gettext Compiled with message translation |multi-lang| | |
| 6165 gui Compiled with GUI enabled. | |
| 6166 gui_athena Compiled with Athena GUI. | |
| 6167 gui_gtk Compiled with GTK+ GUI (any version). | |
| 6168 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined). | |
| 1621 | 6169 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
| 7 | 6170 gui_mac Compiled with Macintosh GUI. |
| 6171 gui_motif Compiled with Motif GUI. | |
| 6172 gui_photon Compiled with Photon GUI. | |
| 6173 gui_win32 Compiled with MS Windows Win32 GUI. | |
| 6174 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
| 6175 gui_running Vim is running in the GUI, or it will start soon. | |
| 6176 hangul_input Compiled with Hangul input support. |hangul| | |
| 6177 iconv Can use iconv() for conversion. | |
| 6178 insert_expand Compiled with support for CTRL-X expansion commands in | |
| 6179 Insert mode. | |
| 6180 jumplist Compiled with |jumplist| support. | |
| 6181 keymap Compiled with 'keymap' support. | |
| 6182 langmap Compiled with 'langmap' support. | |
| 6183 libcall Compiled with |libcall()| support. | |
| 6184 linebreak Compiled with 'linebreak', 'breakat' and 'showbreak' | |
| 6185 support. | |
| 6186 lispindent Compiled with support for lisp indenting. | |
| 6187 listcmds Compiled with commands for the buffer list |:files| | |
| 6188 and the argument list |arglist|. | |
| 6189 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
|
6190 lua Compiled with Lua interface |Lua|. |
| 7 | 6191 mac Macintosh version of Vim. |
| 6192 macunix Macintosh version of Vim, using Unix files (OS-X). | |
| 6193 menu Compiled with support for |:menu|. | |
| 6194 mksession Compiled with support for |:mksession|. | |
| 6195 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
| 6196 mouse Compiled with support mouse. | |
| 6197 mouseshape Compiled with support for 'mouseshape'. | |
| 6198 mouse_dec Compiled with support for Dec terminal mouse. | |
| 6199 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
| 6200 mouse_netterm Compiled with support for netterm mouse. | |
| 6201 mouse_pterm Compiled with support for qnx pterm mouse. | |
| 1621 | 6202 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
| 7 | 6203 mouse_xterm Compiled with support for xterm mouse. |
| 1768 | 6204 multi_byte Compiled with support for 'encoding' |
| 6205 multi_byte_encoding 'encoding' is set to a multi-byte encoding. | |
| 7 | 6206 multi_byte_ime Compiled with support for IME input method. |
| 6207 multi_lang Compiled with support for multiple languages. | |
| 14 | 6208 mzscheme Compiled with MzScheme interface |mzscheme|. |
| 7 | 6209 netbeans_intg Compiled with support for |netbeans|. |
| 2210 | 6210 netbeans_enabled Compiled with support for |netbeans| and connected. |
| 7 | 6211 ole Compiled with OLE automation support for Win32. |
| 6212 os2 OS/2 version of Vim. | |
| 6213 osfiletype Compiled with support for osfiletypes |+osfiletype| | |
| 6214 path_extra Compiled with up/downwards search in 'path' and 'tags' | |
| 6215 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
|
6216 persistent_undo Compiled with support for persistent undo history. |
| 7 | 6217 postscript Compiled with PostScript file printing. |
| 6218 printer Compiled with |:hardcopy| support. | |
| 170 | 6219 profile Compiled with |:profile| support. |
| 7 | 6220 python Compiled with Python interface. |
| 6221 qnx QNX version of Vim. | |
| 6222 quickfix Compiled with |quickfix| support. | |
| 857 | 6223 reltime Compiled with |reltime()| support. |
| 7 | 6224 rightleft Compiled with 'rightleft' support. |
| 6225 ruby Compiled with Ruby interface |ruby|. | |
| 6226 scrollbind Compiled with 'scrollbind' support. | |
| 6227 showcmd Compiled with 'showcmd' support. | |
| 6228 signs Compiled with |:sign| support. | |
| 6229 smartindent Compiled with 'smartindent' support. | |
| 9 | 6230 sniff Compiled with SNiFF interface support. |
| 1989 | 6231 startuptime Compiled with |--startuptime| support. |
| 7 | 6232 statusline Compiled with support for 'statusline', 'rulerformat' |
| 6233 and special formats of 'titlestring' and 'iconstring'. | |
| 6234 sun_workshop Compiled with support for Sun |workshop|. | |
| 314 | 6235 spell Compiled with spell checking support |spell|. |
| 6236 syntax Compiled with syntax highlighting support |syntax|. | |
| 7 | 6237 syntax_items There are active syntax highlighting items for the |
| 6238 current buffer. | |
| 6239 system Compiled to use system() instead of fork()/exec(). | |
| 6240 tag_binary Compiled with binary searching in tags files | |
| 6241 |tag-binary-search|. | |
| 6242 tag_old_static Compiled with support for old static tags | |
| 6243 |tag-old-static|. | |
| 6244 tag_any_white Compiled with support for any white characters in tags | |
| 6245 files |tag-any-white|. | |
| 6246 tcl Compiled with Tcl interface. | |
| 6247 terminfo Compiled with terminfo instead of termcap. | |
| 6248 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
| 6249 textobjects Compiled with support for |text-objects|. | |
| 6250 tgetent Compiled with tgetent support, able to use a termcap | |
| 6251 or terminfo file. | |
| 6252 title Compiled with window title support |'title'|. | |
| 6253 toolbar Compiled with support for |gui-toolbar|. | |
| 6254 unix Unix version of Vim. | |
| 6255 user_commands User-defined commands. | |
| 6256 viminfo Compiled with viminfo support. | |
| 2581 | 6257 vim_starting True while initial source'ing takes place. |startup| |
| 7 | 6258 vertsplit Compiled with vertically split windows |:vsplit|. |
| 6259 virtualedit Compiled with 'virtualedit' option. | |
| 6260 visual Compiled with Visual mode. | |
| 6261 visualextra Compiled with extra Visual mode commands. | |
| 6262 |blockwise-operators|. | |
| 6263 vms VMS version of Vim. | |
| 6264 vreplace Compiled with |gR| and |gr| commands. | |
| 6265 wildignore Compiled with 'wildignore' option. | |
| 6266 wildmenu Compiled with 'wildmenu' option. | |
| 6267 windows Compiled with support for more than one window. | |
| 6268 winaltkeys Compiled with 'winaltkeys' option. | |
| 6269 win16 Win16 version of Vim (MS-Windows 3.1). | |
| 6270 win32 Win32 version of Vim (MS-Windows 95/98/ME/NT/2000/XP). | |
| 6271 win64 Win64 version of Vim (MS-Windows 64 bit). | |
| 6272 win32unix Win32 version of Vim, using Unix files (Cygwin) | |
| 6273 win95 Win32 version for MS-Windows 95/98/ME. | |
| 6274 writebackup Compiled with 'writebackup' default on. | |
| 6275 xfontset Compiled with X fontset support |xfontset|. | |
| 6276 xim Compiled with X input method support |xim|. | |
| 6277 xsmp Compiled with X session management support. | |
| 6278 xsmp_interact Compiled with interactive X session management support. | |
| 6279 xterm_clipboard Compiled with support for xterm clipboard. | |
| 6280 xterm_save Compiled with support for saving and restoring the | |
| 6281 xterm screen. | |
| 6282 x11 Compiled with X11 support. | |
| 6283 | |
| 6284 *string-match* | |
| 6285 Matching a pattern in a String | |
| 6286 | |
| 6287 A regexp pattern as explained at |pattern| is normally used to find a match in | |
| 6288 the buffer lines. When a pattern is used to find a match in a String, almost | |
| 6289 everything works in the same way. The difference is that a String is handled | |
| 6290 like it is one line. When it contains a "\n" character, this is not seen as a | |
| 6291 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
| 6292 with ".". Example: > | |
| 6293 :let a = "aaaa\nxxxx" | |
| 6294 :echo matchstr(a, "..\n..") | |
| 6295 aa | |
| 6296 xx | |
| 6297 :echo matchstr(a, "a.x") | |
| 6298 a | |
| 6299 x | |
| 6300 | |
| 6301 Don't forget that "^" will only match at the first character of the String and | |
| 6302 "$" at the last character of the string. They don't match after or before a | |
| 6303 "\n". | |
| 6304 | |
| 6305 ============================================================================== | |
| 6306 5. Defining functions *user-functions* | |
| 6307 | |
| 6308 New functions can be defined. These can be called just like builtin | |
| 6309 functions. The function executes a sequence of Ex commands. Normal mode | |
| 6310 commands can be executed with the |:normal| command. | |
| 6311 | |
| 6312 The function name must start with an uppercase letter, to avoid confusion with | |
| 6313 builtin functions. To prevent from using the same name in different scripts | |
| 6314 avoid obvious, short names. A good habit is to start the function name with | |
| 6315 the name of the script, e.g., "HTMLcolor()". | |
| 6316 | |
| 504 | 6317 It's also possible to use curly braces, see |curly-braces-names|. And the |
| 6318 |autoload| facility is useful to define a function only when it's called. | |
| 7 | 6319 |
| 6320 *local-function* | |
| 6321 A function local to a script must start with "s:". A local script function | |
| 6322 can only be called from within the script and from functions, user commands | |
| 6323 and autocommands defined in the script. It is also possible to call the | |
| 1698 | 6324 function from a mapping defined in the script, but then |<SID>| must be used |
| 7 | 6325 instead of "s:" when the mapping is expanded outside of the script. |
| 6326 | |
| 6327 *:fu* *:function* *E128* *E129* *E123* | |
| 6328 :fu[nction] List all functions and their arguments. | |
| 6329 | |
| 6330 :fu[nction] {name} List function {name}. | |
| 685 | 6331 {name} can also be a |Dictionary| entry that is a |
| 6332 |Funcref|: > | |
| 114 | 6333 :function dict.init |
| 504 | 6334 |
| 6335 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
| 6336 Example that lists all functions ending with "File": > | |
| 6337 :function /File$ | |
| 482 | 6338 < |
| 6339 *:function-verbose* | |
| 6340 When 'verbose' is non-zero, listing a function will also display where it was | |
| 6341 last defined. Example: > | |
| 6342 | |
| 6343 :verbose function SetFileTypeSH | |
| 6344 function SetFileTypeSH(name) | |
| 6345 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
| 6346 < | |
| 484 | 6347 See |:verbose-cmd| for more information. |
| 482 | 6348 |
| 856 | 6349 *E124* *E125* |
| 102 | 6350 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] |
| 7 | 6351 Define a new function by the name {name}. The name |
| 6352 must be made of alphanumeric characters and '_', and | |
| 6353 must start with a capital or "s:" (see above). | |
| 114 | 6354 |
| 685 | 6355 {name} can also be a |Dictionary| entry that is a |
| 6356 |Funcref|: > | |
| 114 | 6357 :function dict.init(arg) |
| 1621 | 6358 < "dict" must be an existing dictionary. The entry |
| 114 | 6359 "init" is added if it didn't exist yet. Otherwise [!] |
| 1621 | 6360 is required to overwrite an existing function. The |
| 114 | 6361 result is a |Funcref| to a numbered function. The |
| 6362 function can only be used with a |Funcref| and will be | |
| 6363 deleted if there are no more references to it. | |
| 7 | 6364 *E127* *E122* |
| 6365 When a function by this name already exists and [!] is | |
| 6366 not used an error message is given. When [!] is used, | |
| 6367 an existing function is silently replaced. Unless it | |
| 6368 is currently being executed, that is an error. | |
| 133 | 6369 |
| 6370 For the {arguments} see |function-argument|. | |
| 6371 | |
| 7 | 6372 *a:firstline* *a:lastline* |
| 6373 When the [range] argument is added, the function is | |
| 6374 expected to take care of a range itself. The range is | |
| 6375 passed as "a:firstline" and "a:lastline". If [range] | |
| 6376 is excluded, ":{range}call" will call the function for | |
| 6377 each line in the range, with the cursor on the start | |
| 6378 of each line. See |function-range-example|. | |
| 114 | 6379 |
| 7 | 6380 When the [abort] argument is added, the function will |
| 6381 abort as soon as an error is detected. | |
| 114 | 6382 |
| 102 | 6383 When the [dict] argument is added, the function must |
| 1621 | 6384 be invoked through an entry in a |Dictionary|. The |
| 102 | 6385 local variable "self" will then be set to the |
| 6386 dictionary. See |Dictionary-function|. | |
| 7 | 6387 |
| 1621 | 6388 *function-search-undo* |
| 653 | 6389 The last used search pattern and the redo command "." |
| 1621 | 6390 will not be changed by the function. This also |
| 6391 implies that the effect of |:nohlsearch| is undone | |
| 6392 when the function returns. | |
| 653 | 6393 |
| 7 | 6394 *:endf* *:endfunction* *E126* *E193* |
| 6395 :endf[unction] The end of a function definition. Must be on a line | |
| 6396 by its own, without other commands. | |
| 6397 | |
| 6398 *:delf* *:delfunction* *E130* *E131* | |
| 6399 :delf[unction] {name} Delete function {name}. | |
| 685 | 6400 {name} can also be a |Dictionary| entry that is a |
| 6401 |Funcref|: > | |
| 114 | 6402 :delfunc dict.init |
| 1621 | 6403 < This will remove the "init" entry from "dict". The |
| 114 | 6404 function is deleted if there are no more references to |
| 6405 it. | |
| 7 | 6406 *:retu* *:return* *E133* |
| 6407 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
| 6408 evaluated and returned as the result of the function. | |
| 6409 If "[expr]" is not given, the number 0 is returned. | |
| 6410 When a function ends without an explicit ":return", | |
| 6411 the number 0 is returned. | |
| 6412 Note that there is no check for unreachable lines, | |
| 6413 thus there is no warning if commands follow ":return". | |
| 6414 | |
| 6415 If the ":return" is used after a |:try| but before the | |
| 6416 matching |:finally| (if present), the commands | |
| 6417 following the ":finally" up to the matching |:endtry| | |
| 6418 are executed first. This process applies to all | |
| 6419 nested ":try"s inside the function. The function | |
| 6420 returns at the outermost ":endtry". | |
| 6421 | |
| 133 | 6422 *function-argument* *a:var* |
| 1621 | 6423 An argument can be defined by giving its name. In the function this can then |
| 133 | 6424 be used as "a:name" ("a:" for argument). |
| 1156 | 6425 *a:0* *a:1* *a:000* *E740* *...* |
| 133 | 6426 Up to 20 arguments can be given, separated by commas. After the named |
| 6427 arguments an argument "..." can be specified, which means that more arguments | |
| 6428 may optionally be following. In the function the extra arguments can be used | |
| 6429 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
| 685 | 6430 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
| 6431 that "a:1" is the same as "a:000[0]". | |
| 148 | 6432 *E742* |
| 6433 The a: scope and the variables in it cannot be changed, they are fixed. | |
| 1698 | 6434 However, if a |List| or |Dictionary| is used, you can change their contents. |
| 685 | 6435 Thus you can pass a |List| to a function and have the function add an item to |
| 6436 it. If you want to make sure the function cannot change a |List| or | |
| 6437 |Dictionary| use |:lockvar|. | |
| 133 | 6438 |
| 6439 When not using "...", the number of arguments in a function call must be equal | |
| 6440 to the number of named arguments. When using "...", the number of arguments | |
| 6441 may be larger. | |
| 6442 | |
| 6443 It is also possible to define a function without any arguments. You must | |
| 6444 still supply the () then. The body of the function follows in the next lines, | |
| 6445 until the matching |:endfunction|. It is allowed to define another function | |
| 6446 inside a function body. | |
| 6447 | |
| 6448 *local-variables* | |
| 7 | 6449 Inside a function variables can be used. These are local variables, which |
| 6450 will disappear when the function returns. Global variables need to be | |
| 6451 accessed with "g:". | |
| 6452 | |
| 6453 Example: > | |
| 6454 :function Table(title, ...) | |
| 6455 : echohl Title | |
| 6456 : echo a:title | |
| 6457 : echohl None | |
| 140 | 6458 : echo a:0 . " items:" |
| 6459 : for s in a:000 | |
| 6460 : echon ' ' . s | |
| 6461 : endfor | |
| 7 | 6462 :endfunction |
| 6463 | |
| 6464 This function can then be called with: > | |
| 140 | 6465 call Table("Table", "line1", "line2") |
| 6466 call Table("Empty Table") | |
| 7 | 6467 |
| 1156 | 6468 To return more than one value, return a |List|: > |
| 6469 :function Compute(n1, n2) | |
| 7 | 6470 : if a:n2 == 0 |
| 1156 | 6471 : return ["fail", 0] |
| 7 | 6472 : endif |
| 1156 | 6473 : return ["ok", a:n1 / a:n2] |
| 7 | 6474 :endfunction |
| 6475 | |
| 6476 This function can then be called with: > | |
| 1156 | 6477 :let [success, div] = Compute(102, 6) |
| 7 | 6478 :if success == "ok" |
| 6479 : echo div | |
| 6480 :endif | |
| 1156 | 6481 < |
| 786 | 6482 *:cal* *:call* *E107* *E117* |
| 7 | 6483 :[range]cal[l] {name}([arguments]) |
| 6484 Call a function. The name of the function and its arguments | |
| 6485 are as specified with |:function|. Up to 20 arguments can be | |
| 1156 | 6486 used. The returned value is discarded. |
| 7 | 6487 Without a range and for functions that accept a range, the |
| 6488 function is called once. When a range is given the cursor is | |
| 6489 positioned at the start of the first line before executing the | |
| 6490 function. | |
| 6491 When a range is given and the function doesn't handle it | |
| 6492 itself, the function is executed for each line in the range, | |
| 6493 with the cursor in the first column of that line. The cursor | |
| 6494 is left at the last line (possibly moved by the last function | |
| 1621 | 6495 call). The arguments are re-evaluated for each line. Thus |
| 7 | 6496 this works: |
| 6497 *function-range-example* > | |
| 6498 :function Mynumber(arg) | |
| 6499 : echo line(".") . " " . a:arg | |
| 6500 :endfunction | |
| 6501 :1,5call Mynumber(getline(".")) | |
| 6502 < | |
| 6503 The "a:firstline" and "a:lastline" are defined anyway, they | |
| 6504 can be used to do something different at the start or end of | |
| 6505 the range. | |
| 6506 | |
| 6507 Example of a function that handles the range itself: > | |
| 6508 | |
| 6509 :function Cont() range | |
| 6510 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
| 6511 :endfunction | |
| 6512 :4,8call Cont() | |
| 6513 < | |
| 6514 This function inserts the continuation character "\" in front | |
| 6515 of all the lines in the range, except the first one. | |
| 6516 | |
| 1156 | 6517 When the function returns a composite value it can be further |
| 6518 dereferenced, but the range will not be used then. Example: > | |
| 6519 :4,8call GetDict().method() | |
| 6520 < Here GetDict() gets the range but method() does not. | |
| 6521 | |
| 7 | 6522 *E132* |
| 6523 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
| 6524 option. | |
| 6525 | |
| 161 | 6526 |
| 6527 AUTOMATICALLY LOADING FUNCTIONS ~ | |
| 7 | 6528 *autoload-functions* |
| 6529 When using many or large functions, it's possible to automatically define them | |
| 161 | 6530 only when they are used. There are two methods: with an autocommand and with |
| 6531 the "autoload" directory in 'runtimepath'. | |
| 6532 | |
| 6533 | |
| 6534 Using an autocommand ~ | |
| 6535 | |
| 170 | 6536 This is introduced in the user manual, section |41.14|. |
| 6537 | |
| 161 | 6538 The autocommand is useful if you have a plugin that is a long Vim script file. |
| 6539 You can define the autocommand and quickly quit the script with |:finish|. | |
| 1621 | 6540 That makes Vim startup faster. The autocommand should then load the same file |
| 161 | 6541 again, setting a variable to skip the |:finish| command. |
| 6542 | |
| 6543 Use the FuncUndefined autocommand event with a pattern that matches the | |
| 6544 function(s) to be defined. Example: > | |
| 7 | 6545 |
| 6546 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
| 6547 | |
| 6548 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
| 6549 "BufNet". Also see |FuncUndefined|. | |
| 6550 | |
| 161 | 6551 |
| 6552 Using an autoload script ~ | |
| 168 | 6553 *autoload* *E746* |
| 170 | 6554 This is introduced in the user manual, section |41.15|. |
| 6555 | |
| 161 | 6556 Using a script in the "autoload" directory is simpler, but requires using |
| 6557 exactly the right file name. A function that can be autoloaded has a name | |
| 6558 like this: > | |
| 6559 | |
| 270 | 6560 :call filename#funcname() |
| 161 | 6561 |
| 6562 When such a function is called, and it is not defined yet, Vim will search the | |
| 6563 "autoload" directories in 'runtimepath' for a script file called | |
| 6564 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
| 6565 then define the function like this: > | |
| 6566 | |
| 270 | 6567 function filename#funcname() |
| 161 | 6568 echo "Done!" |
| 6569 endfunction | |
| 6570 | |
| 530 | 6571 The file name and the name used before the # in the function must match |
| 161 | 6572 exactly, and the defined function must have the name exactly as it will be |
| 6573 called. | |
| 6574 | |
| 270 | 6575 It is possible to use subdirectories. Every # in the function name works like |
| 6576 a path separator. Thus when calling a function: > | |
| 6577 | |
| 6578 :call foo#bar#func() | |
| 161 | 6579 |
| 6580 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
| 6581 | |
| 168 | 6582 This also works when reading a variable that has not been set yet: > |
| 6583 | |
| 270 | 6584 :let l = foo#bar#lvar |
| 168 | 6585 |
| 557 | 6586 However, when the autoload script was already loaded it won't be loaded again |
| 6587 for an unknown variable. | |
| 6588 | |
| 168 | 6589 When assigning a value to such a variable nothing special happens. This can |
| 6590 be used to pass settings to the autoload script before it's loaded: > | |
| 6591 | |
| 270 | 6592 :let foo#bar#toggle = 1 |
| 6593 :call foo#bar#func() | |
| 168 | 6594 |
| 164 | 6595 Note that when you make a mistake and call a function that is supposed to be |
| 6596 defined in an autoload script, but the script doesn't actually define the | |
| 6597 function, the script will be sourced every time you try to call the function. | |
| 168 | 6598 And you will get an error message every time. |
| 6599 | |
| 6600 Also note that if you have two script files, and one calls a function in the | |
| 1621 | 6601 other and vice versa, before the used function is defined, it won't work. |
| 168 | 6602 Avoid using the autoload functionality at the toplevel. |
| 161 | 6603 |
| 794 | 6604 Hint: If you distribute a bunch of scripts you can pack them together with the |
| 6605 |vimball| utility. Also read the user manual |distribute-script|. | |
| 6606 | |
| 7 | 6607 ============================================================================== |
| 6608 6. Curly braces names *curly-braces-names* | |
| 6609 | |
| 6610 Wherever you can use a variable, you can use a "curly braces name" variable. | |
| 6611 This is a regular variable name with one or more expressions wrapped in braces | |
| 6612 {} like this: > | |
| 6613 my_{adjective}_variable | |
| 6614 | |
| 6615 When Vim encounters this, it evaluates the expression inside the braces, puts | |
| 6616 that in place of the expression, and re-interprets the whole as a variable | |
| 6617 name. So in the above example, if the variable "adjective" was set to | |
| 6618 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
| 6619 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
| 6620 | |
| 6621 One application for this is to create a set of variables governed by an option | |
| 1621 | 6622 value. For example, the statement > |
| 7 | 6623 echo my_{&background}_message |
| 6624 | |
| 6625 would output the contents of "my_dark_message" or "my_light_message" depending | |
| 6626 on the current value of 'background'. | |
| 6627 | |
| 6628 You can use multiple brace pairs: > | |
| 6629 echo my_{adverb}_{adjective}_message | |
| 6630 ..or even nest them: > | |
| 6631 echo my_{ad{end_of_word}}_message | |
| 6632 where "end_of_word" is either "verb" or "jective". | |
| 6633 | |
| 6634 However, the expression inside the braces must evaluate to a valid single | |
| 236 | 6635 variable name, e.g. this is invalid: > |
| 7 | 6636 :let foo='a + b' |
| 6637 :echo c{foo}d | |
| 6638 .. since the result of expansion is "ca + bd", which is not a variable name. | |
| 6639 | |
| 6640 *curly-braces-function-names* | |
| 6641 You can call and define functions by an evaluated name in a similar way. | |
| 6642 Example: > | |
| 6643 :let func_end='whizz' | |
| 6644 :call my_func_{func_end}(parameter) | |
| 6645 | |
| 6646 This would call the function "my_func_whizz(parameter)". | |
| 6647 | |
| 6648 ============================================================================== | |
| 6649 7. Commands *expression-commands* | |
| 6650 | |
| 6651 :let {var-name} = {expr1} *:let* *E18* | |
| 6652 Set internal variable {var-name} to the result of the | |
| 6653 expression {expr1}. The variable will get the type | |
| 6654 from the {expr}. If {var-name} didn't exist yet, it | |
| 6655 is created. | |
| 6656 | |
| 85 | 6657 :let {var-name}[{idx}] = {expr1} *E689* |
| 6658 Set a list item to the result of the expression | |
| 6659 {expr1}. {var-name} must refer to a list and {idx} | |
| 6660 must be a valid index in that list. For nested list | |
| 6661 the index can be repeated. | |
| 1621 | 6662 This cannot be used to add an item to a |List|. |
| 6663 This cannot be used to set a byte in a String. You | |
| 6664 can do that like this: > | |
| 6665 :let var = var[0:2] . 'X' . var[4:] | |
| 6666 < | |
| 114 | 6667 *E711* *E719* |
| 6668 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
| 685 | 6669 Set a sequence of items in a |List| to the result of |
| 6670 the expression {expr1}, which must be a list with the | |
| 87 | 6671 correct number of items. |
| 6672 {idx1} can be omitted, zero is used instead. | |
| 6673 {idx2} can be omitted, meaning the end of the list. | |
| 6674 When the selected range of items is partly past the | |
| 6675 end of the list, items will be added. | |
| 6676 | |
| 153 | 6677 *:let+=* *:let-=* *:let.=* *E734* |
| 114 | 6678 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
| 6679 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
| 6680 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". | |
| 6681 These fail if {var} was not set yet and when the type | |
| 6682 of {var} and {expr1} don't fit the operator. | |
| 6683 | |
| 6684 | |
| 7 | 6685 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
| 6686 Set environment variable {env-name} to the result of | |
| 6687 the expression {expr1}. The type is always String. | |
| 114 | 6688 :let ${env-name} .= {expr1} |
| 6689 Append {expr1} to the environment variable {env-name}. | |
| 6690 If the environment variable didn't exist yet this | |
| 6691 works like "=". | |
| 7 | 6692 |
| 6693 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
| 6694 Write the result of the expression {expr1} in register | |
| 6695 {reg-name}. {reg-name} must be a single letter, and | |
| 6696 must be the name of a writable register (see | |
| 6697 |registers|). "@@" can be used for the unnamed | |
| 6698 register, "@/" for the search pattern. | |
| 6699 If the result of {expr1} ends in a <CR> or <NL>, the | |
| 6700 register will be linewise, otherwise it will be set to | |
| 6701 characterwise. | |
| 6702 This can be used to clear the last search pattern: > | |
| 6703 :let @/ = "" | |
| 6704 < This is different from searching for an empty string, | |
| 6705 that would match everywhere. | |
| 6706 | |
| 114 | 6707 :let @{reg-name} .= {expr1} |
| 1621 | 6708 Append {expr1} to register {reg-name}. If the |
| 114 | 6709 register was empty it's like setting it to {expr1}. |
| 6710 | |
| 1156 | 6711 :let &{option-name} = {expr1} *:let-option* *:let-&* |
| 7 | 6712 Set option {option-name} to the result of the |
| 68 | 6713 expression {expr1}. A String or Number value is |
| 6714 always converted to the type of the option. | |
| 7 | 6715 For an option local to a window or buffer the effect |
| 6716 is just like using the |:set| command: both the local | |
| 555 | 6717 value and the global value are changed. |
| 68 | 6718 Example: > |
| 6719 :let &path = &path . ',/usr/local/include' | |
| 7 | 6720 |
| 114 | 6721 :let &{option-name} .= {expr1} |
| 6722 For a string option: Append {expr1} to the value. | |
| 6723 Does not insert a comma like |:set+=|. | |
| 6724 | |
| 6725 :let &{option-name} += {expr1} | |
| 6726 :let &{option-name} -= {expr1} | |
| 6727 For a number or boolean option: Add or subtract | |
| 6728 {expr1}. | |
| 6729 | |
| 7 | 6730 :let &l:{option-name} = {expr1} |
| 114 | 6731 :let &l:{option-name} .= {expr1} |
| 6732 :let &l:{option-name} += {expr1} | |
| 6733 :let &l:{option-name} -= {expr1} | |
| 7 | 6734 Like above, but only set the local value of an option |
| 6735 (if there is one). Works like |:setlocal|. | |
| 6736 | |
| 6737 :let &g:{option-name} = {expr1} | |
| 114 | 6738 :let &g:{option-name} .= {expr1} |
| 6739 :let &g:{option-name} += {expr1} | |
| 6740 :let &g:{option-name} -= {expr1} | |
| 7 | 6741 Like above, but only set the global value of an option |
| 6742 (if there is one). Works like |:setglobal|. | |
| 6743 | |
| 85 | 6744 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
| 685 | 6745 {expr1} must evaluate to a |List|. The first item in |
| 68 | 6746 the list is assigned to {name1}, the second item to |
| 6747 {name2}, etc. | |
| 6748 The number of names must match the number of items in | |
| 685 | 6749 the |List|. |
| 68 | 6750 Each name can be one of the items of the ":let" |
| 6751 command as mentioned above. | |
| 6752 Example: > | |
| 6753 :let [s, item] = GetItem(s) | |
| 114 | 6754 < Detail: {expr1} is evaluated first, then the |
| 6755 assignments are done in sequence. This matters if | |
| 6756 {name2} depends on {name1}. Example: > | |
| 6757 :let x = [0, 1] | |
| 6758 :let i = 0 | |
| 6759 :let [i, x[i]] = [1, 2] | |
| 6760 :echo x | |
| 6761 < The result is [0, 2]. | |
| 6762 | |
| 6763 :let [{name1}, {name2}, ...] .= {expr1} | |
| 6764 :let [{name1}, {name2}, ...] += {expr1} | |
| 6765 :let [{name1}, {name2}, ...] -= {expr1} | |
| 6766 Like above, but append/add/subtract the value for each | |
| 685 | 6767 |List| item. |
| 68 | 6768 |
| 6769 :let [{name}, ..., ; {lastname}] = {expr1} | |
| 685 | 6770 Like |:let-unpack| above, but the |List| may have more |
| 114 | 6771 items than there are names. A list of the remaining |
| 6772 items is assigned to {lastname}. If there are no | |
| 6773 remaining items {lastname} is set to an empty list. | |
| 68 | 6774 Example: > |
| 6775 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
| 6776 < | |
| 114 | 6777 :let [{name}, ..., ; {lastname}] .= {expr1} |
| 6778 :let [{name}, ..., ; {lastname}] += {expr1} | |
| 6779 :let [{name}, ..., ; {lastname}] -= {expr1} | |
| 6780 Like above, but append/add/subtract the value for each | |
| 685 | 6781 |List| item. |
| 2596 | 6782 |
| 6783 *E121* | |
| 1621 | 6784 :let {var-name} .. List the value of variable {var-name}. Multiple |
| 123 | 6785 variable names may be given. Special names recognized |
| 6786 here: *E738* | |
| 777 | 6787 g: global variables |
| 6788 b: local buffer variables | |
| 6789 w: local window variables | |
| 819 | 6790 t: local tab page variables |
| 777 | 6791 s: script-local variables |
| 6792 l: local function variables | |
| 123 | 6793 v: Vim variables. |
| 7 | 6794 |
| 55 | 6795 :let List the values of all variables. The type of the |
| 6796 variable is indicated before the value: | |
| 6797 <nothing> String | |
| 6798 # Number | |
| 856 | 6799 * Funcref |
| 7 | 6800 |
| 148 | 6801 |
| 1156 | 6802 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
| 148 | 6803 Remove the internal variable {name}. Several variable |
| 6804 names can be given, they are all removed. The name | |
| 685 | 6805 may also be a |List| or |Dictionary| item. |
| 7 | 6806 With [!] no error message is given for non-existing |
| 6807 variables. | |
| 685 | 6808 One or more items from a |List| can be removed: > |
| 108 | 6809 :unlet list[3] " remove fourth item |
| 6810 :unlet list[3:] " remove fourth item to last | |
| 685 | 6811 < One item from a |Dictionary| can be removed at a time: > |
| 108 | 6812 :unlet dict['two'] |
| 6813 :unlet dict.two | |
| 1668 | 6814 < This is especially useful to clean up used global |
| 6815 variables and script-local variables (these are not | |
| 6816 deleted when the script ends). Function-local | |
| 6817 variables are automatically deleted when the function | |
| 6818 ends. | |
| 7 | 6819 |
| 148 | 6820 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
| 6821 Lock the internal variable {name}. Locking means that | |
| 6822 it can no longer be changed (until it is unlocked). | |
| 6823 A locked variable can be deleted: > | |
| 6824 :lockvar v | |
| 6825 :let v = 'asdf' " fails! | |
| 6826 :unlet v | |
| 6827 < *E741* | |
| 6828 If you try to change a locked variable you get an | |
| 6829 error message: "E741: Value of {name} is locked" | |
| 6830 | |
| 685 | 6831 [depth] is relevant when locking a |List| or |
| 6832 |Dictionary|. It specifies how deep the locking goes: | |
| 6833 1 Lock the |List| or |Dictionary| itself, | |
| 148 | 6834 cannot add or remove items, but can |
| 6835 still change their values. | |
| 6836 2 Also lock the values, cannot change | |
| 685 | 6837 the items. If an item is a |List| or |
| 6838 |Dictionary|, cannot add or remove | |
| 148 | 6839 items, but can still change the |
| 6840 values. | |
| 685 | 6841 3 Like 2 but for the |List| / |
| 6842 |Dictionary| in the |List| / | |
| 6843 |Dictionary|, one level deeper. | |
| 6844 The default [depth] is 2, thus when {name} is a |List| | |
| 6845 or |Dictionary| the values cannot be changed. | |
| 148 | 6846 *E743* |
| 6847 For unlimited depth use [!] and omit [depth]. | |
| 6848 However, there is a maximum depth of 100 to catch | |
| 6849 loops. | |
| 6850 | |
| 685 | 6851 Note that when two variables refer to the same |List| |
| 6852 and you lock one of them, the |List| will also be | |
| 819 | 6853 locked when used through the other variable. |
| 6854 Example: > | |
| 148 | 6855 :let l = [0, 1, 2, 3] |
| 6856 :let cl = l | |
| 6857 :lockvar l | |
| 6858 :let cl[1] = 99 " won't work! | |
| 6859 < You may want to make a copy of a list to avoid this. | |
| 6860 See |deepcopy()|. | |
| 6861 | |
| 6862 | |
| 6863 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
| 6864 Unlock the internal variable {name}. Does the | |
| 6865 opposite of |:lockvar|. | |
| 6866 | |
| 6867 | |
| 7 | 6868 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580* |
| 6869 :en[dif] Execute the commands until the next matching ":else" | |
| 6870 or ":endif" if {expr1} evaluates to non-zero. | |
| 6871 | |
| 6872 From Vim version 4.5 until 5.0, every Ex command in | |
| 6873 between the ":if" and ":endif" is ignored. These two | |
| 6874 commands were just to allow for future expansions in a | |
| 6875 backwards compatible way. Nesting was allowed. Note | |
| 6876 that any ":else" or ":elseif" was ignored, the "else" | |
| 6877 part was not executed either. | |
| 6878 | |
| 6879 You can use this to remain compatible with older | |
| 6880 versions: > | |
| 6881 :if version >= 500 | |
| 6882 : version-5-specific-commands | |
| 6883 :endif | |
| 6884 < The commands still need to be parsed to find the | |
| 6885 "endif". Sometimes an older Vim has a problem with a | |
| 6886 new command. For example, ":silent" is recognized as | |
| 6887 a ":substitute" command. In that case ":execute" can | |
| 6888 avoid problems: > | |
| 6889 :if version >= 600 | |
| 6890 : execute "silent 1,$delete" | |
| 6891 :endif | |
| 6892 < | |
| 6893 NOTE: The ":append" and ":insert" commands don't work | |
| 6894 properly in between ":if" and ":endif". | |
| 6895 | |
| 6896 *:else* *:el* *E581* *E583* | |
| 6897 :el[se] Execute the commands until the next matching ":else" | |
| 6898 or ":endif" if they previously were not being | |
| 6899 executed. | |
| 6900 | |
| 6901 *:elseif* *:elsei* *E582* *E584* | |
| 6902 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
| 6903 is no extra ":endif". | |
| 6904 | |
| 6905 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
| 114 | 6906 *E170* *E585* *E588* *E733* |
| 7 | 6907 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
| 6908 as long as {expr1} evaluates to non-zero. | |
| 6909 When an error is detected from a command inside the | |
| 6910 loop, execution continues after the "endwhile". | |
| 75 | 6911 Example: > |
| 6912 :let lnum = 1 | |
| 6913 :while lnum <= line("$") | |
| 6914 :call FixLine(lnum) | |
| 6915 :let lnum = lnum + 1 | |
| 6916 :endwhile | |
| 6917 < | |
| 7 | 6918 NOTE: The ":append" and ":insert" commands don't work |
| 99 | 6919 properly inside a ":while" and ":for" loop. |
| 75 | 6920 |
| 114 | 6921 :for {var} in {list} *:for* *E690* *E732* |
| 75 | 6922 :endfo[r] *:endfo* *:endfor* |
| 6923 Repeat the commands between ":for" and ":endfor" for | |
| 158 | 6924 each item in {list}. Variable {var} is set to the |
| 79 | 6925 value of each item. |
| 6926 When an error is detected for a command inside the | |
| 75 | 6927 loop, execution continues after the "endfor". |
| 464 | 6928 Changing {list} inside the loop affects what items are |
| 6929 used. Make a copy if this is unwanted: > | |
| 79 | 6930 :for item in copy(mylist) |
| 6931 < When not making a copy, Vim stores a reference to the | |
| 6932 next item in the list, before executing the commands | |
| 1621 | 6933 with the current item. Thus the current item can be |
| 79 | 6934 removed without effect. Removing any later item means |
| 6935 it will not be found. Thus the following example | |
| 6936 works (an inefficient way to make a list empty): > | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6937 for item in mylist |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6938 call remove(mylist, 0) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6939 endfor |
| 87 | 6940 < Note that reordering the list (e.g., with sort() or |
| 6941 reverse()) may have unexpected effects. | |
| 6942 Note that the type of each list item should be | |
| 75 | 6943 identical to avoid errors for the type of {var} |
| 6944 changing. Unlet the variable at the end of the loop | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6945 to allow multiple item types: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6946 for item in ["foo", ["bar"]] |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6947 echo item |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6948 unlet item " E706 without this |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6949 endfor |
| 75 | 6950 |
| 6951 :for [{var1}, {var2}, ...] in {listlist} | |
| 6952 :endfo[r] | |
| 6953 Like ":for" above, but each item in {listlist} must be | |
| 6954 a list, of which each item is assigned to {var1}, | |
| 6955 {var2}, etc. Example: > | |
| 6956 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
| 6957 :echo getline(lnum)[col] | |
| 6958 :endfor | |
| 6959 < | |
| 7 | 6960 *:continue* *:con* *E586* |
| 75 | 6961 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
| 6962 to the start of the loop. | |
| 6963 If it is used after a |:try| inside the loop but | |
| 6964 before the matching |:finally| (if present), the | |
| 6965 commands following the ":finally" up to the matching | |
| 6966 |:endtry| are executed first. This process applies to | |
| 6967 all nested ":try"s inside the loop. The outermost | |
| 6968 ":endtry" then jumps back to the start of the loop. | |
| 7 | 6969 |
| 6970 *:break* *:brea* *E587* | |
| 75 | 6971 :brea[k] When used inside a ":while" or ":for" loop, skips to |
| 6972 the command after the matching ":endwhile" or | |
| 6973 ":endfor". | |
| 6974 If it is used after a |:try| inside the loop but | |
| 6975 before the matching |:finally| (if present), the | |
| 6976 commands following the ":finally" up to the matching | |
| 6977 |:endtry| are executed first. This process applies to | |
| 6978 all nested ":try"s inside the loop. The outermost | |
| 6979 ":endtry" then jumps to the command after the loop. | |
| 7 | 6980 |
| 6981 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
| 6982 :endt[ry] Change the error handling for the commands between | |
| 6983 ":try" and ":endtry" including everything being | |
| 6984 executed across ":source" commands, function calls, | |
| 6985 or autocommand invocations. | |
| 6986 | |
| 6987 When an error or interrupt is detected and there is | |
| 6988 a |:finally| command following, execution continues | |
| 6989 after the ":finally". Otherwise, or when the | |
| 6990 ":endtry" is reached thereafter, the next | |
| 6991 (dynamically) surrounding ":try" is checked for | |
| 6992 a corresponding ":finally" etc. Then the script | |
| 6993 processing is terminated. (Whether a function | |
| 6994 definition has an "abort" argument does not matter.) | |
| 6995 Example: > | |
| 6996 :try | edit too much | finally | echo "cleanup" | endtry | |
| 6997 :echo "impossible" " not reached, script terminated above | |
| 6998 < | |
| 6999 Moreover, an error or interrupt (dynamically) inside | |
| 7000 ":try" and ":endtry" is converted to an exception. It | |
| 7001 can be caught as if it were thrown by a |:throw| | |
| 7002 command (see |:catch|). In this case, the script | |
| 7003 processing is not terminated. | |
| 7004 | |
| 7005 The value "Vim:Interrupt" is used for an interrupt | |
| 7006 exception. An error in a Vim command is converted | |
| 7007 to a value of the form "Vim({command}):{errmsg}", | |
| 7008 other errors are converted to a value of the form | |
| 7009 "Vim:{errmsg}". {command} is the full command name, | |
| 7010 and {errmsg} is the message that is displayed if the | |
| 7011 error exception is not caught, always beginning with | |
| 7012 the error number. | |
| 7013 Examples: > | |
| 7014 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry | |
| 7015 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
| 7016 < | |
| 7017 *:cat* *:catch* *E603* *E604* *E605* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7018 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
| 7 | 7019 |:finally|, or |:endtry| that belongs to the same |
| 7020 |:try| as the ":catch" are executed when an exception | |
| 7021 matching {pattern} is being thrown and has not yet | |
| 7022 been caught by a previous ":catch". Otherwise, these | |
| 7023 commands are skipped. | |
| 7024 When {pattern} is omitted all errors are caught. | |
| 7025 Examples: > | |
| 7026 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) | |
| 7027 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors | |
| 7028 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts | |
| 7029 :catch /^Vim(write):/ " catch all errors in :write | |
| 7030 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123 | |
| 7031 :catch /my-exception/ " catch user exception | |
| 7032 :catch /.*/ " catch everything | |
| 7033 :catch " same as /.*/ | |
| 7034 < | |
| 7035 Another character can be used instead of / around the | |
| 7036 {pattern}, so long as it does not have a special | |
| 7037 meaning (e.g., '|' or '"') and doesn't occur inside | |
| 7038 {pattern}. | |
| 7039 NOTE: It is not reliable to ":catch" the TEXT of | |
| 7040 an error message because it may vary in different | |
| 7041 locales. | |
| 7042 | |
| 7043 *:fina* *:finally* *E606* *E607* | |
| 7044 :fina[lly] The following commands until the matching |:endtry| | |
| 7045 are executed whenever the part between the matching | |
| 7046 |:try| and the ":finally" is left: either by falling | |
| 7047 through to the ":finally" or by a |:continue|, | |
| 7048 |:break|, |:finish|, or |:return|, or by an error or | |
| 7049 interrupt or exception (see |:throw|). | |
| 7050 | |
| 7051 *:th* *:throw* *E608* | |
| 7052 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
| 7053 If the ":throw" is used after a |:try| but before the | |
| 7054 first corresponding |:catch|, commands are skipped | |
| 7055 until the first ":catch" matching {expr1} is reached. | |
| 7056 If there is no such ":catch" or if the ":throw" is | |
| 7057 used after a ":catch" but before the |:finally|, the | |
| 7058 commands following the ":finally" (if present) up to | |
| 7059 the matching |:endtry| are executed. If the ":throw" | |
| 7060 is after the ":finally", commands up to the ":endtry" | |
| 7061 are skipped. At the ":endtry", this process applies | |
| 7062 again for the next dynamically surrounding ":try" | |
| 7063 (which may be found in a calling function or sourcing | |
| 7064 script), until a matching ":catch" has been found. | |
| 7065 If the exception is not caught, the command processing | |
| 7066 is terminated. | |
| 7067 Example: > | |
| 7068 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
| 7069 < | |
| 7070 | |
| 7071 *:ec* *:echo* | |
| 7072 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
| 7073 first {expr1} starts on a new line. | |
| 7074 Also see |:comment|. | |
| 7075 Use "\n" to start a new line. Use "\r" to move the | |
| 7076 cursor to the first column. | |
| 7077 Uses the highlighting set by the |:echohl| command. | |
| 7078 Cannot be followed by a comment. | |
| 7079 Example: > | |
| 7080 :echo "the value of 'shell' is" &shell | |
| 1156 | 7081 < *:echo-redraw* |
| 7082 A later redraw may make the message disappear again. | |
| 7083 And since Vim mostly postpones redrawing until it's | |
| 7084 finished with a sequence of commands this happens | |
| 7085 quite often. To avoid that a command from before the | |
| 7086 ":echo" causes a redraw afterwards (redraws are often | |
| 7087 postponed until you type something), force a redraw | |
| 7088 with the |:redraw| command. Example: > | |
| 7 | 7089 :new | redraw | echo "there is a new window" |
| 7090 < | |
| 7091 *:echon* | |
| 7092 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
| 7093 |:comment|. | |
| 7094 Uses the highlighting set by the |:echohl| command. | |
| 7095 Cannot be followed by a comment. | |
| 7096 Example: > | |
| 7097 :echon "the value of 'shell' is " &shell | |
| 7098 < | |
| 7099 Note the difference between using ":echo", which is a | |
| 7100 Vim command, and ":!echo", which is an external shell | |
| 7101 command: > | |
| 7102 :!echo % --> filename | |
| 7103 < The arguments of ":!" are expanded, see |:_%|. > | |
| 7104 :!echo "%" --> filename or "filename" | |
| 7105 < Like the previous example. Whether you see the double | |
| 7106 quotes or not depends on your 'shell'. > | |
| 7107 :echo % --> nothing | |
| 7108 < The '%' is an illegal character in an expression. > | |
| 7109 :echo "%" --> % | |
| 7110 < This just echoes the '%' character. > | |
| 7111 :echo expand("%") --> filename | |
| 7112 < This calls the expand() function to expand the '%'. | |
| 7113 | |
| 7114 *:echoh* *:echohl* | |
| 7115 :echoh[l] {name} Use the highlight group {name} for the following | |
| 7116 |:echo|, |:echon| and |:echomsg| commands. Also used | |
| 7117 for the |input()| prompt. Example: > | |
| 7118 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
| 7119 < Don't forget to set the group back to "None", | |
| 7120 otherwise all following echo's will be highlighted. | |
| 7121 | |
| 7122 *:echom* *:echomsg* | |
| 7123 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
| 7124 message in the |message-history|. | |
| 7125 Spaces are placed between the arguments as with the | |
| 7126 |:echo| command. But unprintable characters are | |
| 7127 displayed, not interpreted. | |
| 1156 | 7128 The parsing works slightly different from |:echo|, |
| 7129 more like |:execute|. All the expressions are first | |
| 7130 evaluated and concatenated before echoing anything. | |
| 7131 The expressions must evaluate to a Number or String, a | |
| 7132 Dictionary or List causes an error. | |
| 7 | 7133 Uses the highlighting set by the |:echohl| command. |
| 7134 Example: > | |
| 7135 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
| 1156 | 7136 < See |:echo-redraw| to avoid the message disappearing |
| 7137 when the screen is redrawn. | |
| 7 | 7138 *:echoe* *:echoerr* |
| 7139 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
| 7140 message in the |message-history|. When used in a | |
| 7141 script or function the line number will be added. | |
| 7142 Spaces are placed between the arguments as with the | |
| 1621 | 7143 :echo command. When used inside a try conditional, |
| 7 | 7144 the message is raised as an error exception instead |
| 7145 (see |try-echoerr|). | |
| 7146 Example: > | |
| 7147 :echoerr "This script just failed!" | |
| 7148 < If you just want a highlighted message use |:echohl|. | |
| 7149 And to get a beep: > | |
| 7150 :exe "normal \<Esc>" | |
| 7151 < | |
| 7152 *:exe* *:execute* | |
| 7153 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
| 2152 | 7154 of {expr1} as an Ex command. |
| 7155 Multiple arguments are concatenated, with a space in | |
| 7156 between. To avoid the extra space use the "." | |
| 7157 operator to concatenate strings into one argument. | |
| 7158 {expr1} is used as the processed command, command line | |
| 7159 editing keys are not recognized. | |
| 7 | 7160 Cannot be followed by a comment. |
| 7161 Examples: > | |
| 2152 | 7162 :execute "buffer" nextbuf |
| 7163 :execute "normal" count . "w" | |
| 7 | 7164 < |
| 7165 ":execute" can be used to append a command to commands | |
| 7166 that don't accept a '|'. Example: > | |
| 7167 :execute '!ls' | echo "theend" | |
| 7168 | |
| 7169 < ":execute" is also a nice way to avoid having to type | |
| 7170 control characters in a Vim script for a ":normal" | |
| 7171 command: > | |
| 7172 :execute "normal ixxx\<Esc>" | |
| 7173 < This has an <Esc> character, see |expr-string|. | |
| 7174 | |
| 1621 | 7175 Be careful to correctly escape special characters in |
| 7176 file names. The |fnameescape()| function can be used | |
| 1661 | 7177 for Vim commands, |shellescape()| for |:!| commands. |
| 7178 Examples: > | |
| 1621 | 7179 :execute "e " . fnameescape(filename) |
| 1661 | 7180 :execute "!ls " . shellescape(expand('%:h'), 1) |
| 1621 | 7181 < |
| 7 | 7182 Note: The executed string may be any command-line, but |
| 99 | 7183 you cannot start or end a "while", "for" or "if" |
| 7184 command. Thus this is illegal: > | |
| 7 | 7185 :execute 'while i > 5' |
| 7186 :execute 'echo "test" | break' | |
| 7187 < | |
| 7188 It is allowed to have a "while" or "if" command | |
| 7189 completely in the executed string: > | |
| 7190 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
| 7191 < | |
| 7192 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7193 *:exe-comment* |
| 7 | 7194 ":execute", ":echo" and ":echon" cannot be followed by |
| 7195 a comment directly, because they see the '"' as the | |
| 7196 start of a string. But, you can use '|' followed by a | |
| 7197 comment. Example: > | |
| 7198 :echo "foo" | "this is a comment | |
| 7199 | |
| 7200 ============================================================================== | |
| 7201 8. Exception handling *exception-handling* | |
| 7202 | |
| 7203 The Vim script language comprises an exception handling feature. This section | |
| 7204 explains how it can be used in a Vim script. | |
| 7205 | |
| 7206 Exceptions may be raised by Vim on an error or on interrupt, see | |
| 7207 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
| 7208 exception by using the ":throw" command, see |throw-catch|. | |
| 7209 | |
| 7210 | |
| 7211 TRY CONDITIONALS *try-conditionals* | |
| 7212 | |
| 7213 Exceptions can be caught or can cause cleanup code to be executed. You can | |
| 7214 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
| 7215 a finally clause (to be executed for cleanup). | |
| 7216 A try conditional begins with a |:try| command and ends at the matching | |
| 7217 |:endtry| command. In between, you can use a |:catch| command to start | |
| 7218 a catch clause, or a |:finally| command to start a finally clause. There may | |
| 7219 be none or multiple catch clauses, but there is at most one finally clause, | |
| 7220 which must not be followed by any catch clauses. The lines before the catch | |
| 7221 clauses and the finally clause is called a try block. > | |
| 7222 | |
| 7223 :try | |
| 1621 | 7224 : ... |
| 7225 : ... TRY BLOCK | |
| 7226 : ... | |
| 7 | 7227 :catch /{pattern}/ |
| 1621 | 7228 : ... |
| 7229 : ... CATCH CLAUSE | |
| 7230 : ... | |
| 7 | 7231 :catch /{pattern}/ |
| 1621 | 7232 : ... |
| 7233 : ... CATCH CLAUSE | |
| 7234 : ... | |
| 7 | 7235 :finally |
| 1621 | 7236 : ... |
| 7237 : ... FINALLY CLAUSE | |
| 7238 : ... | |
| 7 | 7239 :endtry |
| 7240 | |
| 7241 The try conditional allows to watch code for exceptions and to take the | |
| 7242 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
| 7243 from the try block and also the catch clauses may cause cleanup actions. | |
| 7244 When no exception is thrown during execution of the try block, the control | |
| 7245 is transferred to the finally clause, if present. After its execution, the | |
| 7246 script continues with the line following the ":endtry". | |
| 7247 When an exception occurs during execution of the try block, the remaining | |
| 7248 lines in the try block are skipped. The exception is matched against the | |
| 7249 patterns specified as arguments to the ":catch" commands. The catch clause | |
| 7250 after the first matching ":catch" is taken, other catch clauses are not | |
| 7251 executed. The catch clause ends when the next ":catch", ":finally", or | |
| 7252 ":endtry" command is reached - whatever is first. Then, the finally clause | |
| 7253 (if present) is executed. When the ":endtry" is reached, the script execution | |
| 7254 continues in the following line as usual. | |
| 7255 When an exception that does not match any of the patterns specified by the | |
| 7256 ":catch" commands is thrown in the try block, the exception is not caught by | |
| 7257 that try conditional and none of the catch clauses is executed. Only the | |
| 7258 finally clause, if present, is taken. The exception pends during execution of | |
| 7259 the finally clause. It is resumed at the ":endtry", so that commands after | |
| 7260 the ":endtry" are not executed and the exception might be caught elsewhere, | |
| 7261 see |try-nesting|. | |
| 7262 When during execution of a catch clause another exception is thrown, the | |
| 1621 | 7263 remaining lines in that catch clause are not executed. The new exception is |
| 7 | 7264 not matched against the patterns in any of the ":catch" commands of the same |
| 7265 try conditional and none of its catch clauses is taken. If there is, however, | |
| 7266 a finally clause, it is executed, and the exception pends during its | |
| 7267 execution. The commands following the ":endtry" are not executed. The new | |
| 7268 exception might, however, be caught elsewhere, see |try-nesting|. | |
| 7269 When during execution of the finally clause (if present) an exception is | |
| 1621 | 7270 thrown, the remaining lines in the finally clause are skipped. If the finally |
| 7 | 7271 clause has been taken because of an exception from the try block or one of the |
| 7272 catch clauses, the original (pending) exception is discarded. The commands | |
| 7273 following the ":endtry" are not executed, and the exception from the finally | |
| 7274 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
| 7275 | |
| 7276 The finally clause is also executed, when a ":break" or ":continue" for | |
| 7277 a ":while" loop enclosing the complete try conditional is executed from the | |
| 7278 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
| 7279 from the try block or a catch clause of a try conditional in a function or | |
| 7280 sourced script, respectively. The ":break", ":continue", ":return", or | |
| 7281 ":finish" pends during execution of the finally clause and is resumed when the | |
| 7282 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
| 7283 from the finally clause. | |
| 7284 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
| 7285 try conditional or when a ":return" or ":finish" is encountered in the finally | |
| 7286 clause, the rest of the finally clause is skipped, and the ":break", | |
| 7287 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
| 7288 clause has been taken because of an exception or an earlier ":break", | |
| 7289 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
| 7290 this pending exception or command is discarded. | |
| 7291 | |
| 7292 For examples see |throw-catch| and |try-finally|. | |
| 7293 | |
| 7294 | |
| 7295 NESTING OF TRY CONDITIONALS *try-nesting* | |
| 7296 | |
| 7297 Try conditionals can be nested arbitrarily. That is, a complete try | |
| 7298 conditional can be put into the try block, a catch clause, or the finally | |
| 7299 clause of another try conditional. If the inner try conditional does not | |
| 7300 catch an exception thrown in its try block or throws a new exception from one | |
| 7301 of its catch clauses or its finally clause, the outer try conditional is | |
| 7302 checked according to the rules above. If the inner try conditional is in the | |
| 7303 try block of the outer try conditional, its catch clauses are checked, but | |
| 1621 | 7304 otherwise only the finally clause is executed. It does not matter for |
| 7 | 7305 nesting, whether the inner try conditional is directly contained in the outer |
| 7306 one, or whether the outer one sources a script or calls a function containing | |
| 7307 the inner try conditional. | |
| 7308 | |
| 7309 When none of the active try conditionals catches an exception, just their | |
| 7310 finally clauses are executed. Thereafter, the script processing terminates. | |
| 7311 An error message is displayed in case of an uncaught exception explicitly | |
| 7312 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
| 7313 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
| 7314 as usual. | |
| 7315 | |
| 7316 For examples see |throw-catch|. | |
| 7317 | |
| 7318 | |
| 7319 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
| 7320 | |
| 7321 Exception handling code can get tricky. If you are in doubt what happens, set | |
| 7322 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
| 7323 script file. Then you see when an exception is thrown, discarded, caught, or | |
| 7324 finished. When using a verbosity level of at least 14, things pending in | |
| 7325 a finally clause are also shown. This information is also given in debug mode | |
| 7326 (see |debug-scripts|). | |
| 7327 | |
| 7328 | |
| 7329 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
| 7330 | |
| 7331 You can throw any number or string as an exception. Use the |:throw| command | |
| 7332 and pass the value to be thrown as argument: > | |
| 7333 :throw 4711 | |
| 7334 :throw "string" | |
| 7335 < *throw-expression* | |
| 7336 You can also specify an expression argument. The expression is then evaluated | |
| 7337 first, and the result is thrown: > | |
| 7338 :throw 4705 + strlen("string") | |
| 7339 :throw strpart("strings", 0, 6) | |
| 7340 | |
| 7341 An exception might be thrown during evaluation of the argument of the ":throw" | |
| 7342 command. Unless it is caught there, the expression evaluation is abandoned. | |
| 7343 The ":throw" command then does not throw a new exception. | |
| 7344 Example: > | |
| 7345 | |
| 7346 :function! Foo(arg) | |
| 7347 : try | |
| 7348 : throw a:arg | |
| 7349 : catch /foo/ | |
| 7350 : endtry | |
| 7351 : return 1 | |
| 7352 :endfunction | |
| 7353 : | |
| 7354 :function! Bar() | |
| 7355 : echo "in Bar" | |
| 7356 : return 4710 | |
| 7357 :endfunction | |
| 7358 : | |
| 7359 :throw Foo("arrgh") + Bar() | |
| 7360 | |
| 7361 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
| 7362 executed. > | |
| 7363 :throw Foo("foo") + Bar() | |
| 7364 however displays "in Bar" and throws 4711. | |
| 7365 | |
| 7366 Any other command that takes an expression as argument might also be | |
| 1621 | 7367 abandoned by an (uncaught) exception during the expression evaluation. The |
| 7 | 7368 exception is then propagated to the caller of the command. |
| 7369 Example: > | |
| 7370 | |
| 7371 :if Foo("arrgh") | |
| 7372 : echo "then" | |
| 7373 :else | |
| 7374 : echo "else" | |
| 7375 :endif | |
| 7376 | |
| 7377 Here neither of "then" or "else" is displayed. | |
| 7378 | |
| 7379 *catch-order* | |
| 7380 Exceptions can be caught by a try conditional with one or more |:catch| | |
| 7381 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
| 7382 command can be specified as a pattern argument. The subsequent catch clause | |
| 7383 gets executed when a matching exception is caught. | |
| 7384 Example: > | |
| 7385 | |
| 7386 :function! Foo(value) | |
| 7387 : try | |
| 7388 : throw a:value | |
| 7389 : catch /^\d\+$/ | |
| 7390 : echo "Number thrown" | |
| 7391 : catch /.*/ | |
| 7392 : echo "String thrown" | |
| 7393 : endtry | |
| 7394 :endfunction | |
| 7395 : | |
| 7396 :call Foo(0x1267) | |
| 7397 :call Foo('string') | |
| 7398 | |
| 7399 The first call to Foo() displays "Number thrown", the second "String thrown". | |
| 7400 An exception is matched against the ":catch" commands in the order they are | |
| 7401 specified. Only the first match counts. So you should place the more | |
| 7402 specific ":catch" first. The following order does not make sense: > | |
| 7403 | |
| 7404 : catch /.*/ | |
| 7405 : echo "String thrown" | |
| 7406 : catch /^\d\+$/ | |
| 7407 : echo "Number thrown" | |
| 7408 | |
| 7409 The first ":catch" here matches always, so that the second catch clause is | |
| 7410 never taken. | |
| 7411 | |
| 7412 *throw-variables* | |
| 7413 If you catch an exception by a general pattern, you may access the exact value | |
| 7414 in the variable |v:exception|: > | |
| 7415 | |
| 7416 : catch /^\d\+$/ | |
| 7417 : echo "Number thrown. Value is" v:exception | |
| 7418 | |
| 7419 You may also be interested where an exception was thrown. This is stored in | |
| 7420 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
| 7421 exception most recently caught as long it is not finished. | |
| 7422 Example: > | |
| 7423 | |
| 7424 :function! Caught() | |
| 7425 : if v:exception != "" | |
| 7426 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
| 7427 : else | |
| 7428 : echo 'Nothing caught' | |
| 7429 : endif | |
| 7430 :endfunction | |
| 7431 : | |
| 7432 :function! Foo() | |
| 7433 : try | |
| 7434 : try | |
| 7435 : try | |
| 7436 : throw 4711 | |
| 7437 : finally | |
| 7438 : call Caught() | |
| 7439 : endtry | |
| 7440 : catch /.*/ | |
| 7441 : call Caught() | |
| 7442 : throw "oops" | |
| 7443 : endtry | |
| 7444 : catch /.*/ | |
| 7445 : call Caught() | |
| 7446 : finally | |
| 7447 : call Caught() | |
| 7448 : endtry | |
| 7449 :endfunction | |
| 7450 : | |
| 7451 :call Foo() | |
| 7452 | |
| 7453 This displays > | |
| 7454 | |
| 7455 Nothing caught | |
| 7456 Caught "4711" in function Foo, line 4 | |
| 7457 Caught "oops" in function Foo, line 10 | |
| 7458 Nothing caught | |
| 7459 | |
| 7460 A practical example: The following command ":LineNumber" displays the line | |
| 7461 number in the script or function where it has been used: > | |
| 7462 | |
| 7463 :function! LineNumber() | |
| 7464 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
| 7465 :endfunction | |
| 7466 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
| 7467 < | |
| 7468 *try-nested* | |
| 7469 An exception that is not caught by a try conditional can be caught by | |
| 7470 a surrounding try conditional: > | |
| 7471 | |
| 7472 :try | |
| 7473 : try | |
| 7474 : throw "foo" | |
| 7475 : catch /foobar/ | |
| 7476 : echo "foobar" | |
| 7477 : finally | |
| 7478 : echo "inner finally" | |
| 7479 : endtry | |
| 7480 :catch /foo/ | |
| 7481 : echo "foo" | |
| 7482 :endtry | |
| 7483 | |
| 7484 The inner try conditional does not catch the exception, just its finally | |
| 7485 clause is executed. The exception is then caught by the outer try | |
| 7486 conditional. The example displays "inner finally" and then "foo". | |
| 7487 | |
| 7488 *throw-from-catch* | |
| 7489 You can catch an exception and throw a new one to be caught elsewhere from the | |
| 7490 catch clause: > | |
| 7491 | |
| 7492 :function! Foo() | |
| 7493 : throw "foo" | |
| 7494 :endfunction | |
| 7495 : | |
| 7496 :function! Bar() | |
| 7497 : try | |
| 7498 : call Foo() | |
| 7499 : catch /foo/ | |
| 7500 : echo "Caught foo, throw bar" | |
| 7501 : throw "bar" | |
| 7502 : endtry | |
| 7503 :endfunction | |
| 7504 : | |
| 7505 :try | |
| 7506 : call Bar() | |
| 7507 :catch /.*/ | |
| 7508 : echo "Caught" v:exception | |
| 7509 :endtry | |
| 7510 | |
| 7511 This displays "Caught foo, throw bar" and then "Caught bar". | |
| 7512 | |
| 7513 *rethrow* | |
| 7514 There is no real rethrow in the Vim script language, but you may throw | |
| 7515 "v:exception" instead: > | |
| 7516 | |
| 7517 :function! Bar() | |
| 7518 : try | |
| 7519 : call Foo() | |
| 7520 : catch /.*/ | |
| 7521 : echo "Rethrow" v:exception | |
| 7522 : throw v:exception | |
| 7523 : endtry | |
| 7524 :endfunction | |
| 7525 < *try-echoerr* | |
| 7526 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
| 7527 exceptions, because it is not possible to fake Vim internal exceptions. | |
| 7528 Trying so causes an error exception. You should throw your own exception | |
| 7529 denoting the situation. If you want to cause a Vim error exception containing | |
| 7530 the original error exception value, you can use the |:echoerr| command: > | |
| 7531 | |
| 7532 :try | |
| 7533 : try | |
| 7534 : asdf | |
| 7535 : catch /.*/ | |
| 7536 : echoerr v:exception | |
| 7537 : endtry | |
| 7538 :catch /.*/ | |
| 7539 : echo v:exception | |
| 7540 :endtry | |
| 7541 | |
| 7542 This code displays | |
| 7543 | |
| 1621 | 7544 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
| 7 | 7545 |
| 7546 | |
| 7547 CLEANUP CODE *try-finally* | |
| 7548 | |
| 7549 Scripts often change global settings and restore them at their end. If the | |
| 7550 user however interrupts the script by pressing CTRL-C, the settings remain in | |
| 1621 | 7551 an inconsistent state. The same may happen to you in the development phase of |
| 7 | 7552 a script when an error occurs or you explicitly throw an exception without |
| 7553 catching it. You can solve these problems by using a try conditional with | |
| 7554 a finally clause for restoring the settings. Its execution is guaranteed on | |
| 7555 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
| 7556 (Note that errors and interrupts from inside the try conditional are converted | |
| 1621 | 7557 to exceptions. When not caught, they terminate the script after the finally |
| 7 | 7558 clause has been executed.) |
| 7559 Example: > | |
| 7560 | |
| 7561 :try | |
| 7562 : let s:saved_ts = &ts | |
| 7563 : set ts=17 | |
| 7564 : | |
| 7565 : " Do the hard work here. | |
| 7566 : | |
| 7567 :finally | |
| 7568 : let &ts = s:saved_ts | |
| 7569 : unlet s:saved_ts | |
| 7570 :endtry | |
| 7571 | |
| 7572 This method should be used locally whenever a function or part of a script | |
| 7573 changes global settings which need to be restored on failure or normal exit of | |
| 7574 that function or script part. | |
| 7575 | |
| 7576 *break-finally* | |
| 7577 Cleanup code works also when the try block or a catch clause is left by | |
| 7578 a ":continue", ":break", ":return", or ":finish". | |
| 7579 Example: > | |
| 7580 | |
| 7581 :let first = 1 | |
| 7582 :while 1 | |
| 7583 : try | |
| 7584 : if first | |
| 7585 : echo "first" | |
| 7586 : let first = 0 | |
| 7587 : continue | |
| 7588 : else | |
| 7589 : throw "second" | |
| 7590 : endif | |
| 7591 : catch /.*/ | |
| 7592 : echo v:exception | |
| 7593 : break | |
| 7594 : finally | |
| 7595 : echo "cleanup" | |
| 7596 : endtry | |
| 7597 : echo "still in while" | |
| 7598 :endwhile | |
| 7599 :echo "end" | |
| 7600 | |
| 7601 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
| 7602 | |
| 7603 :function! Foo() | |
| 7604 : try | |
| 7605 : return 4711 | |
| 7606 : finally | |
| 7607 : echo "cleanup\n" | |
| 7608 : endtry | |
| 7609 : echo "Foo still active" | |
| 7610 :endfunction | |
| 7611 : | |
| 7612 :echo Foo() "returned by Foo" | |
| 7613 | |
| 7614 This displays "cleanup" and "4711 returned by Foo". You don't need to add an | |
| 1621 | 7615 extra ":return" in the finally clause. (Above all, this would override the |
| 7 | 7616 return value.) |
| 7617 | |
| 7618 *except-from-finally* | |
| 7619 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
| 7620 a finally clause is possible, but not recommended since it abandons the | |
| 7621 cleanup actions for the try conditional. But, of course, interrupt and error | |
| 7622 exceptions might get raised from a finally clause. | |
| 7623 Example where an error in the finally clause stops an interrupt from | |
| 7624 working correctly: > | |
| 7625 | |
| 7626 :try | |
| 7627 : try | |
| 7628 : echo "Press CTRL-C for interrupt" | |
| 7629 : while 1 | |
| 7630 : endwhile | |
| 7631 : finally | |
| 7632 : unlet novar | |
| 7633 : endtry | |
| 7634 :catch /novar/ | |
| 7635 :endtry | |
| 7636 :echo "Script still running" | |
| 7637 :sleep 1 | |
| 7638 | |
| 7639 If you need to put commands that could fail into a finally clause, you should | |
| 7640 think about catching or ignoring the errors in these commands, see | |
| 7641 |catch-errors| and |ignore-errors|. | |
| 7642 | |
| 7643 | |
| 7644 CATCHING ERRORS *catch-errors* | |
| 7645 | |
| 7646 If you want to catch specific errors, you just have to put the code to be | |
| 7647 watched in a try block and add a catch clause for the error message. The | |
| 7648 presence of the try conditional causes all errors to be converted to an | |
| 7649 exception. No message is displayed and |v:errmsg| is not set then. To find | |
| 7650 the right pattern for the ":catch" command, you have to know how the format of | |
| 7651 the error exception is. | |
| 7652 Error exceptions have the following format: > | |
| 7653 | |
| 7654 Vim({cmdname}):{errmsg} | |
| 7655 or > | |
| 7656 Vim:{errmsg} | |
| 7657 | |
| 7658 {cmdname} is the name of the command that failed; the second form is used when | |
| 1621 | 7659 the command name is not known. {errmsg} is the error message usually produced |
| 7 | 7660 when the error occurs outside try conditionals. It always begins with |
| 7661 a capital "E", followed by a two or three-digit error number, a colon, and | |
| 7662 a space. | |
| 7663 | |
| 7664 Examples: | |
| 7665 | |
| 7666 The command > | |
| 7667 :unlet novar | |
| 7668 normally produces the error message > | |
| 7669 E108: No such variable: "novar" | |
| 7670 which is converted inside try conditionals to an exception > | |
| 7671 Vim(unlet):E108: No such variable: "novar" | |
| 7672 | |
| 7673 The command > | |
| 7674 :dwim | |
| 7675 normally produces the error message > | |
| 7676 E492: Not an editor command: dwim | |
| 7677 which is converted inside try conditionals to an exception > | |
| 7678 Vim:E492: Not an editor command: dwim | |
| 7679 | |
| 7680 You can catch all ":unlet" errors by a > | |
| 7681 :catch /^Vim(unlet):/ | |
| 7682 or all errors for misspelled command names by a > | |
| 7683 :catch /^Vim:E492:/ | |
| 7684 | |
| 7685 Some error messages may be produced by different commands: > | |
| 7686 :function nofunc | |
| 7687 and > | |
| 7688 :delfunction nofunc | |
| 7689 both produce the error message > | |
| 7690 E128: Function name must start with a capital: nofunc | |
| 7691 which is converted inside try conditionals to an exception > | |
| 7692 Vim(function):E128: Function name must start with a capital: nofunc | |
| 7693 or > | |
| 7694 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
| 7695 respectively. You can catch the error by its number independently on the | |
| 7696 command that caused it if you use the following pattern: > | |
| 7697 :catch /^Vim(\a\+):E128:/ | |
| 7698 | |
| 7699 Some commands like > | |
| 7700 :let x = novar | |
| 7701 produce multiple error messages, here: > | |
| 7702 E121: Undefined variable: novar | |
| 7703 E15: Invalid expression: novar | |
| 7704 Only the first is used for the exception value, since it is the most specific | |
| 7705 one (see |except-several-errors|). So you can catch it by > | |
| 7706 :catch /^Vim(\a\+):E121:/ | |
| 7707 | |
| 7708 You can catch all errors related to the name "nofunc" by > | |
| 7709 :catch /\<nofunc\>/ | |
| 7710 | |
| 7711 You can catch all Vim errors in the ":write" and ":read" commands by > | |
| 7712 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
| 7713 | |
| 7714 You can catch all Vim errors by the pattern > | |
| 7715 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
| 7716 < | |
| 7717 *catch-text* | |
| 7718 NOTE: You should never catch the error message text itself: > | |
| 7719 :catch /No such variable/ | |
| 7720 only works in the english locale, but not when the user has selected | |
| 7721 a different language by the |:language| command. It is however helpful to | |
| 7722 cite the message text in a comment: > | |
| 7723 :catch /^Vim(\a\+):E108:/ " No such variable | |
| 7724 | |
| 7725 | |
| 7726 IGNORING ERRORS *ignore-errors* | |
| 7727 | |
| 7728 You can ignore errors in a specific Vim command by catching them locally: > | |
| 7729 | |
| 7730 :try | |
| 7731 : write | |
| 7732 :catch | |
| 7733 :endtry | |
| 7734 | |
| 7735 But you are strongly recommended NOT to use this simple form, since it could | |
| 7736 catch more than you want. With the ":write" command, some autocommands could | |
| 7737 be executed and cause errors not related to writing, for instance: > | |
| 7738 | |
| 7739 :au BufWritePre * unlet novar | |
| 7740 | |
| 7741 There could even be such errors you are not responsible for as a script | |
| 7742 writer: a user of your script might have defined such autocommands. You would | |
| 7743 then hide the error from the user. | |
| 7744 It is much better to use > | |
| 7745 | |
| 7746 :try | |
| 7747 : write | |
| 7748 :catch /^Vim(write):/ | |
| 7749 :endtry | |
| 7750 | |
| 7751 which only catches real write errors. So catch only what you'd like to ignore | |
| 7752 intentionally. | |
| 7753 | |
| 7754 For a single command that does not cause execution of autocommands, you could | |
| 7755 even suppress the conversion of errors to exceptions by the ":silent!" | |
| 7756 command: > | |
| 7757 :silent! nunmap k | |
| 7758 This works also when a try conditional is active. | |
| 7759 | |
| 7760 | |
| 7761 CATCHING INTERRUPTS *catch-interrupt* | |
| 7762 | |
| 7763 When there are active try conditionals, an interrupt (CTRL-C) is converted to | |
| 1621 | 7764 the exception "Vim:Interrupt". You can catch it like every exception. The |
| 7 | 7765 script is not terminated, then. |
| 7766 Example: > | |
| 7767 | |
| 7768 :function! TASK1() | |
| 7769 : sleep 10 | |
| 7770 :endfunction | |
| 7771 | |
| 7772 :function! TASK2() | |
| 7773 : sleep 20 | |
| 7774 :endfunction | |
| 7775 | |
| 7776 :while 1 | |
| 7777 : let command = input("Type a command: ") | |
| 7778 : try | |
| 7779 : if command == "" | |
| 7780 : continue | |
| 7781 : elseif command == "END" | |
| 7782 : break | |
| 7783 : elseif command == "TASK1" | |
| 7784 : call TASK1() | |
| 7785 : elseif command == "TASK2" | |
| 7786 : call TASK2() | |
| 7787 : else | |
| 7788 : echo "\nIllegal command:" command | |
| 7789 : continue | |
| 7790 : endif | |
| 7791 : catch /^Vim:Interrupt$/ | |
| 7792 : echo "\nCommand interrupted" | |
| 7793 : " Caught the interrupt. Continue with next prompt. | |
| 7794 : endtry | |
| 7795 :endwhile | |
| 7796 | |
| 7797 You can interrupt a task here by pressing CTRL-C; the script then asks for | |
| 1621 | 7798 a new command. If you press CTRL-C at the prompt, the script is terminated. |
| 7 | 7799 |
| 7800 For testing what happens when CTRL-C would be pressed on a specific line in | |
| 7801 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
| 7802 command on that line. See |debug-scripts|. | |
| 7803 | |
| 7804 | |
| 7805 CATCHING ALL *catch-all* | |
| 7806 | |
| 7807 The commands > | |
| 7808 | |
| 7809 :catch /.*/ | |
| 7810 :catch // | |
| 7811 :catch | |
| 7812 | |
| 7813 catch everything, error exceptions, interrupt exceptions and exceptions | |
| 7814 explicitly thrown by the |:throw| command. This is useful at the top level of | |
| 7815 a script in order to catch unexpected things. | |
| 7816 Example: > | |
| 7817 | |
| 7818 :try | |
| 7819 : | |
| 7820 : " do the hard work here | |
| 7821 : | |
| 7822 :catch /MyException/ | |
| 7823 : | |
| 7824 : " handle known problem | |
| 7825 : | |
| 7826 :catch /^Vim:Interrupt$/ | |
| 7827 : echo "Script interrupted" | |
| 7828 :catch /.*/ | |
| 7829 : echo "Internal error (" . v:exception . ")" | |
| 7830 : echo " - occurred at " . v:throwpoint | |
| 7831 :endtry | |
| 7832 :" end of script | |
| 7833 | |
| 7834 Note: Catching all might catch more things than you want. Thus, you are | |
| 7835 strongly encouraged to catch only for problems that you can really handle by | |
| 7836 specifying a pattern argument to the ":catch". | |
| 7837 Example: Catching all could make it nearly impossible to interrupt a script | |
| 7838 by pressing CTRL-C: > | |
| 7839 | |
| 7840 :while 1 | |
| 7841 : try | |
| 7842 : sleep 1 | |
| 7843 : catch | |
| 7844 : endtry | |
| 7845 :endwhile | |
| 7846 | |
| 7847 | |
| 7848 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
| 7849 | |
| 7850 Exceptions may be used during execution of autocommands. Example: > | |
| 7851 | |
| 7852 :autocmd User x try | |
| 7853 :autocmd User x throw "Oops!" | |
| 7854 :autocmd User x catch | |
| 7855 :autocmd User x echo v:exception | |
| 7856 :autocmd User x endtry | |
| 7857 :autocmd User x throw "Arrgh!" | |
| 7858 :autocmd User x echo "Should not be displayed" | |
| 7859 : | |
| 7860 :try | |
| 7861 : doautocmd User x | |
| 7862 :catch | |
| 7863 : echo v:exception | |
| 7864 :endtry | |
| 7865 | |
| 7866 This displays "Oops!" and "Arrgh!". | |
| 7867 | |
| 7868 *except-autocmd-Pre* | |
| 7869 For some commands, autocommands get executed before the main action of the | |
| 7870 command takes place. If an exception is thrown and not caught in the sequence | |
| 7871 of autocommands, the sequence and the command that caused its execution are | |
| 7872 abandoned and the exception is propagated to the caller of the command. | |
| 7873 Example: > | |
| 7874 | |
| 7875 :autocmd BufWritePre * throw "FAIL" | |
| 7876 :autocmd BufWritePre * echo "Should not be displayed" | |
| 7877 : | |
| 7878 :try | |
| 7879 : write | |
| 7880 :catch | |
| 7881 : echo "Caught:" v:exception "from" v:throwpoint | |
| 7882 :endtry | |
| 7883 | |
| 7884 Here, the ":write" command does not write the file currently being edited (as | |
| 7885 you can see by checking 'modified'), since the exception from the BufWritePre | |
| 7886 autocommand abandons the ":write". The exception is then caught and the | |
| 7887 script displays: > | |
| 7888 | |
| 7889 Caught: FAIL from BufWrite Auto commands for "*" | |
| 7890 < | |
| 7891 *except-autocmd-Post* | |
| 7892 For some commands, autocommands get executed after the main action of the | |
| 7893 command has taken place. If this main action fails and the command is inside | |
| 7894 an active try conditional, the autocommands are skipped and an error exception | |
| 7895 is thrown that can be caught by the caller of the command. | |
| 7896 Example: > | |
| 7897 | |
| 7898 :autocmd BufWritePost * echo "File successfully written!" | |
| 7899 : | |
| 7900 :try | |
| 7901 : write /i/m/p/o/s/s/i/b/l/e | |
| 7902 :catch | |
| 7903 : echo v:exception | |
| 7904 :endtry | |
| 7905 | |
| 7906 This just displays: > | |
| 7907 | |
| 7908 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
| 7909 | |
| 7910 If you really need to execute the autocommands even when the main action | |
| 7911 fails, trigger the event from the catch clause. | |
| 7912 Example: > | |
| 7913 | |
| 7914 :autocmd BufWritePre * set noreadonly | |
| 7915 :autocmd BufWritePost * set readonly | |
| 7916 : | |
| 7917 :try | |
| 7918 : write /i/m/p/o/s/s/i/b/l/e | |
| 7919 :catch | |
| 7920 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
| 7921 :endtry | |
| 7922 < | |
| 7923 You can also use ":silent!": > | |
| 7924 | |
| 7925 :let x = "ok" | |
| 7926 :let v:errmsg = "" | |
| 7927 :autocmd BufWritePost * if v:errmsg != "" | |
| 7928 :autocmd BufWritePost * let x = "after fail" | |
| 7929 :autocmd BufWritePost * endif | |
| 7930 :try | |
| 7931 : silent! write /i/m/p/o/s/s/i/b/l/e | |
| 7932 :catch | |
| 7933 :endtry | |
| 7934 :echo x | |
| 7935 | |
| 7936 This displays "after fail". | |
| 7937 | |
| 7938 If the main action of the command does not fail, exceptions from the | |
| 7939 autocommands will be catchable by the caller of the command: > | |
| 7940 | |
| 7941 :autocmd BufWritePost * throw ":-(" | |
| 7942 :autocmd BufWritePost * echo "Should not be displayed" | |
| 7943 : | |
| 7944 :try | |
| 7945 : write | |
| 7946 :catch | |
| 7947 : echo v:exception | |
| 7948 :endtry | |
| 7949 < | |
| 7950 *except-autocmd-Cmd* | |
| 7951 For some commands, the normal action can be replaced by a sequence of | |
| 7952 autocommands. Exceptions from that sequence will be catchable by the caller | |
| 7953 of the command. | |
| 7954 Example: For the ":write" command, the caller cannot know whether the file | |
| 1621 | 7955 had actually been written when the exception occurred. You need to tell it in |
| 7 | 7956 some way. > |
| 7957 | |
| 7958 :if !exists("cnt") | |
| 7959 : let cnt = 0 | |
| 7960 : | |
| 7961 : autocmd BufWriteCmd * if &modified | |
| 7962 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
| 7963 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
| 7964 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 7965 : autocmd BufWriteCmd * endif | |
| 7966 : autocmd BufWriteCmd * write | set nomodified | |
| 7967 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
| 7968 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 7969 : autocmd BufWriteCmd * endif | |
| 7970 : autocmd BufWriteCmd * echo "File successfully written!" | |
| 7971 : autocmd BufWriteCmd * endif | |
| 7972 :endif | |
| 7973 : | |
| 7974 :try | |
| 7975 : write | |
| 7976 :catch /^BufWriteCmdError$/ | |
| 7977 : if &modified | |
| 7978 : echo "Error on writing (file contents not changed)" | |
| 7979 : else | |
| 7980 : echo "Error after writing" | |
| 7981 : endif | |
| 7982 :catch /^Vim(write):/ | |
| 7983 : echo "Error on writing" | |
| 7984 :endtry | |
| 7985 | |
| 7986 When this script is sourced several times after making changes, it displays | |
| 7987 first > | |
| 7988 File successfully written! | |
| 7989 then > | |
| 7990 Error on writing (file contents not changed) | |
| 7991 then > | |
| 7992 Error after writing | |
| 7993 etc. | |
| 7994 | |
| 7995 *except-autocmd-ill* | |
| 7996 You cannot spread a try conditional over autocommands for different events. | |
| 7997 The following code is ill-formed: > | |
| 7998 | |
| 7999 :autocmd BufWritePre * try | |
| 8000 : | |
| 8001 :autocmd BufWritePost * catch | |
| 8002 :autocmd BufWritePost * echo v:exception | |
| 8003 :autocmd BufWritePost * endtry | |
| 8004 : | |
| 8005 :write | |
| 8006 | |
| 8007 | |
| 8008 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
| 8009 | |
| 8010 Some programming languages allow to use hierarchies of exception classes or to | |
| 8011 pass additional information with the object of an exception class. You can do | |
| 8012 similar things in Vim. | |
| 8013 In order to throw an exception from a hierarchy, just throw the complete | |
| 8014 class name with the components separated by a colon, for instance throw the | |
| 8015 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
| 8016 When you want to pass additional information with your exception class, add | |
| 8017 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
| 8018 for an error when writing "myfile". | |
| 8019 With the appropriate patterns in the ":catch" command, you can catch for | |
| 8020 base classes or derived classes of your hierarchy. Additional information in | |
| 8021 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
| 8022 Example: > | |
| 8023 | |
| 8024 :function! CheckRange(a, func) | |
| 8025 : if a:a < 0 | |
| 8026 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
| 8027 : endif | |
| 8028 :endfunction | |
| 8029 : | |
| 8030 :function! Add(a, b) | |
| 8031 : call CheckRange(a:a, "Add") | |
| 8032 : call CheckRange(a:b, "Add") | |
| 8033 : let c = a:a + a:b | |
| 8034 : if c < 0 | |
| 8035 : throw "EXCEPT:MATHERR:OVERFLOW" | |
| 8036 : endif | |
| 8037 : return c | |
| 8038 :endfunction | |
| 8039 : | |
| 8040 :function! Div(a, b) | |
| 8041 : call CheckRange(a:a, "Div") | |
| 8042 : call CheckRange(a:b, "Div") | |
| 8043 : if (a:b == 0) | |
| 8044 : throw "EXCEPT:MATHERR:ZERODIV" | |
| 8045 : endif | |
| 8046 : return a:a / a:b | |
| 8047 :endfunction | |
| 8048 : | |
| 8049 :function! Write(file) | |
| 8050 : try | |
| 1621 | 8051 : execute "write" fnameescape(a:file) |
| 7 | 8052 : catch /^Vim(write):/ |
| 8053 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
| 8054 : endtry | |
| 8055 :endfunction | |
| 8056 : | |
| 8057 :try | |
| 8058 : | |
| 8059 : " something with arithmetics and I/O | |
| 8060 : | |
| 8061 :catch /^EXCEPT:MATHERR:RANGE/ | |
| 8062 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
| 8063 : echo "Range error in" function | |
| 8064 : | |
| 8065 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
| 8066 : echo "Math error" | |
| 8067 : | |
| 8068 :catch /^EXCEPT:IO/ | |
| 8069 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
| 8070 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
| 8071 : if file !~ '^/' | |
| 8072 : let file = dir . "/" . file | |
| 8073 : endif | |
| 8074 : echo 'I/O error for "' . file . '"' | |
| 8075 : | |
| 8076 :catch /^EXCEPT/ | |
| 8077 : echo "Unspecified error" | |
| 8078 : | |
| 8079 :endtry | |
| 8080 | |
| 8081 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
| 8082 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
| 8083 exceptions with the "Vim" prefix; they are reserved for Vim. | |
| 8084 Vim error exceptions are parameterized with the name of the command that | |
| 8085 failed, if known. See |catch-errors|. | |
| 8086 | |
| 8087 | |
| 8088 PECULIARITIES | |
| 8089 *except-compat* | |
| 8090 The exception handling concept requires that the command sequence causing the | |
| 8091 exception is aborted immediately and control is transferred to finally clauses | |
| 8092 and/or a catch clause. | |
| 8093 | |
| 8094 In the Vim script language there are cases where scripts and functions | |
| 8095 continue after an error: in functions without the "abort" flag or in a command | |
| 8096 after ":silent!", control flow goes to the following line, and outside | |
| 8097 functions, control flow goes to the line following the outermost ":endwhile" | |
| 8098 or ":endif". On the other hand, errors should be catchable as exceptions | |
| 8099 (thus, requiring the immediate abortion). | |
| 8100 | |
| 8101 This problem has been solved by converting errors to exceptions and using | |
| 8102 immediate abortion (if not suppressed by ":silent!") only when a try | |
| 1621 | 8103 conditional is active. This is no restriction since an (error) exception can |
| 8104 be caught only from an active try conditional. If you want an immediate | |
| 7 | 8105 termination without catching the error, just use a try conditional without |
| 8106 catch clause. (You can cause cleanup code being executed before termination | |
| 8107 by specifying a finally clause.) | |
| 8108 | |
| 8109 When no try conditional is active, the usual abortion and continuation | |
| 8110 behavior is used instead of immediate abortion. This ensures compatibility of | |
| 8111 scripts written for Vim 6.1 and earlier. | |
| 8112 | |
| 8113 However, when sourcing an existing script that does not use exception handling | |
| 8114 commands (or when calling one of its functions) from inside an active try | |
| 8115 conditional of a new script, you might change the control flow of the existing | |
| 8116 script on error. You get the immediate abortion on error and can catch the | |
| 8117 error in the new script. If however the sourced script suppresses error | |
| 8118 messages by using the ":silent!" command (checking for errors by testing | |
| 1621 | 8119 |v:errmsg| if appropriate), its execution path is not changed. The error is |
| 8120 not converted to an exception. (See |:silent|.) So the only remaining cause | |
| 7 | 8121 where this happens is for scripts that don't care about errors and produce |
| 8122 error messages. You probably won't want to use such code from your new | |
| 8123 scripts. | |
| 8124 | |
| 8125 *except-syntax-err* | |
| 8126 Syntax errors in the exception handling commands are never caught by any of | |
| 8127 the ":catch" commands of the try conditional they belong to. Its finally | |
| 8128 clauses, however, is executed. | |
| 8129 Example: > | |
| 8130 | |
| 8131 :try | |
| 8132 : try | |
| 8133 : throw 4711 | |
| 8134 : catch /\(/ | |
| 8135 : echo "in catch with syntax error" | |
| 8136 : catch | |
| 8137 : echo "inner catch-all" | |
| 8138 : finally | |
| 8139 : echo "inner finally" | |
| 8140 : endtry | |
| 8141 :catch | |
| 8142 : echo 'outer catch-all caught "' . v:exception . '"' | |
| 8143 : finally | |
| 8144 : echo "outer finally" | |
| 8145 :endtry | |
| 8146 | |
| 8147 This displays: > | |
| 8148 inner finally | |
| 8149 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
| 8150 outer finally | |
| 8151 The original exception is discarded and an error exception is raised, instead. | |
| 8152 | |
| 8153 *except-single-line* | |
| 8154 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
| 8155 a single line, but then syntax errors may make it difficult to recognize the | |
| 8156 "catch" line, thus you better avoid this. | |
| 8157 Example: > | |
| 8158 :try | unlet! foo # | catch | endtry | |
| 8159 raises an error exception for the trailing characters after the ":unlet!" | |
| 8160 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
| 8161 error exception is discarded and the "E488: Trailing characters" message gets | |
| 8162 displayed. | |
| 8163 | |
| 8164 *except-several-errors* | |
| 8165 When several errors appear in a single command, the first error message is | |
| 8166 usually the most specific one and therefor converted to the error exception. | |
| 8167 Example: > | |
| 8168 echo novar | |
| 8169 causes > | |
| 8170 E121: Undefined variable: novar | |
| 8171 E15: Invalid expression: novar | |
| 8172 The value of the error exception inside try conditionals is: > | |
| 8173 Vim(echo):E121: Undefined variable: novar | |
| 8174 < *except-syntax-error* | |
| 8175 But when a syntax error is detected after a normal error in the same command, | |
| 8176 the syntax error is used for the exception being thrown. | |
| 8177 Example: > | |
| 8178 unlet novar # | |
| 8179 causes > | |
| 8180 E108: No such variable: "novar" | |
| 8181 E488: Trailing characters | |
| 8182 The value of the error exception inside try conditionals is: > | |
| 8183 Vim(unlet):E488: Trailing characters | |
| 8184 This is done because the syntax error might change the execution path in a way | |
| 8185 not intended by the user. Example: > | |
| 8186 try | |
| 8187 try | unlet novar # | catch | echo v:exception | endtry | |
| 8188 catch /.*/ | |
| 8189 echo "outer catch:" v:exception | |
| 8190 endtry | |
| 8191 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
| 8192 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
| 8193 | |
| 8194 ============================================================================== | |
| 8195 9. Examples *eval-examples* | |
| 8196 | |
| 1156 | 8197 Printing in Binary ~ |
| 7 | 8198 > |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8199 :" The function Nr2Bin() returns the binary string representation of a number. |
| 1156 | 8200 :func Nr2Bin(nr) |
| 7 | 8201 : let n = a:nr |
| 8202 : let r = "" | |
| 8203 : while n | |
| 1156 | 8204 : let r = '01'[n % 2] . r |
| 8205 : let n = n / 2 | |
| 7 | 8206 : endwhile |
| 8207 : return r | |
| 8208 :endfunc | |
| 8209 | |
| 1156 | 8210 :" The function String2Bin() converts each character in a string to a |
| 8211 :" binary string, separated with dashes. | |
| 8212 :func String2Bin(str) | |
| 7 | 8213 : let out = '' |
| 1156 | 8214 : for ix in range(strlen(a:str)) |
| 8215 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
| 8216 : endfor | |
| 8217 : return out[1:] | |
| 7 | 8218 :endfunc |
| 8219 | |
| 8220 Example of its use: > | |
| 1156 | 8221 :echo Nr2Bin(32) |
| 8222 result: "100000" > | |
| 8223 :echo String2Bin("32") | |
| 8224 result: "110011-110010" | |
| 8225 | |
| 8226 | |
| 8227 Sorting lines ~ | |
| 8228 | |
| 8229 This example sorts lines with a specific compare function. > | |
| 8230 | |
| 8231 :func SortBuffer() | |
| 8232 : let lines = getline(1, '$') | |
| 8233 : call sort(lines, function("Strcmp")) | |
| 8234 : call setline(1, lines) | |
| 7 | 8235 :endfunction |
| 8236 | |
| 1156 | 8237 As a one-liner: > |
| 8238 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
| 8239 | |
| 8240 | |
| 8241 scanf() replacement ~ | |
| 7 | 8242 *sscanf* |
| 8243 There is no sscanf() function in Vim. If you need to extract parts from a | |
| 8244 line, you can use matchstr() and substitute() to do it. This example shows | |
| 8245 how to get the file name, line number and column number out of a line like | |
| 8246 "foobar.txt, 123, 45". > | |
| 8247 :" Set up the match bit | |
| 8248 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
| 8249 :"get the part matching the whole expression | |
| 8250 :let l = matchstr(line, mx) | |
| 8251 :"get each item out of the match | |
| 8252 :let file = substitute(l, mx, '\1', '') | |
| 8253 :let lnum = substitute(l, mx, '\2', '') | |
| 8254 :let col = substitute(l, mx, '\3', '') | |
| 8255 | |
| 8256 The input is in the variable "line", the results in the variables "file", | |
| 8257 "lnum" and "col". (idea from Michael Geddes) | |
| 8258 | |
| 1156 | 8259 |
| 8260 getting the scriptnames in a Dictionary ~ | |
| 8261 *scriptnames-dictionary* | |
| 8262 The |:scriptnames| command can be used to get a list of all script files that | |
| 8263 have been sourced. There is no equivalent function or variable for this | |
| 8264 (because it's rarely needed). In case you need to manipulate the list this | |
| 8265 code can be used: > | |
| 8266 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
| 8267 let scriptnames_output = '' | |
| 8268 redir => scriptnames_output | |
| 8269 silent scriptnames | |
| 8270 redir END | |
| 8271 | |
| 1621 | 8272 " Split the output into lines and parse each line. Add an entry to the |
| 1156 | 8273 " "scripts" dictionary. |
| 8274 let scripts = {} | |
| 8275 for line in split(scriptnames_output, "\n") | |
| 8276 " Only do non-blank lines. | |
| 8277 if line =~ '\S' | |
| 8278 " Get the first number in the line. | |
| 1621 | 8279 let nr = matchstr(line, '\d\+') |
| 1156 | 8280 " Get the file name, remove the script number " 123: ". |
| 1621 | 8281 let name = substitute(line, '.\+:\s*', '', '') |
| 1156 | 8282 " Add an item to the Dictionary |
| 1621 | 8283 let scripts[nr] = name |
| 1156 | 8284 endif |
| 8285 endfor | |
| 8286 unlet scriptnames_output | |
| 8287 | |
| 7 | 8288 ============================================================================== |
| 8289 10. No +eval feature *no-eval-feature* | |
| 8290 | |
| 8291 When the |+eval| feature was disabled at compile time, none of the expression | |
| 8292 evaluation commands are available. To prevent this from causing Vim scripts | |
| 8293 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
| 8294 recognized, though the argument of the ":if" and everything between the ":if" | |
| 8295 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
| 8296 only if the commands are at the start of the line. The ":else" command is not | |
| 8297 recognized. | |
| 8298 | |
| 8299 Example of how to avoid executing commands when the |+eval| feature is | |
| 8300 missing: > | |
| 8301 | |
| 8302 :if 1 | |
| 8303 : echo "Expression evaluation is compiled in" | |
| 8304 :else | |
| 8305 : echo "You will _never_ see this message" | |
| 8306 :endif | |
| 8307 | |
| 8308 ============================================================================== | |
| 8309 11. The sandbox *eval-sandbox* *sandbox* *E48* | |
| 8310 | |
|
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
8311 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
|
8312 '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
|
8313 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
|
8314 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
|
8315 the command from a tags file is executed and for CTRL-R = in the command line. |
| 29 | 8316 The sandbox is also used for the |:sandbox| command. |
| 7 | 8317 |
| 8318 These items are not allowed in the sandbox: | |
| 8319 - changing the buffer text | |
| 8320 - defining or changing mapping, autocommands, functions, user commands | |
| 8321 - setting certain options (see |option-summary|) | |
| 1156 | 8322 - setting certain v: variables (see |v:var|) *E794* |
| 7 | 8323 - executing a shell command |
| 8324 - reading or writing a file | |
| 8325 - jumping to another buffer or editing a file | |
| 625 | 8326 - executing Python, Perl, etc. commands |
| 29 | 8327 This is not guaranteed 100% secure, but it should block most attacks. |
| 8328 | |
| 8329 *:san* *:sandbox* | |
| 401 | 8330 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
| 29 | 8331 option that may have been set from a modeline, e.g. |
| 8332 'foldexpr'. | |
| 8333 | |
| 634 | 8334 *sandbox-option* |
| 8335 A few options contain an expression. When this expression is evaluated it may | |
| 790 | 8336 have to be done in the sandbox to avoid a security risk. But the sandbox is |
| 634 | 8337 restrictive, thus this only happens when the option was set from an insecure |
| 8338 location. Insecure in this context are: | |
| 843 | 8339 - sourcing a .vimrc or .exrc in the current directory |
| 634 | 8340 - while executing in the sandbox |
| 8341 - value coming from a modeline | |
| 8342 | |
| 8343 Note that when in the sandbox and saving an option value and restoring it, the | |
| 8344 option will still be marked as it was set in the sandbox. | |
| 8345 | |
| 8346 ============================================================================== | |
| 8347 12. Textlock *textlock* | |
| 8348 | |
| 8349 In a few situations it is not allowed to change the text in the buffer, jump | |
| 8350 to another window and some other things that might confuse or break what Vim | |
| 8351 is currently doing. This mostly applies to things that happen when Vim is | |
| 1621 | 8352 actually doing something else. For example, evaluating the 'balloonexpr' may |
| 634 | 8353 happen any moment the mouse cursor is resting at some position. |
| 8354 | |
| 8355 This is not allowed when the textlock is active: | |
| 8356 - changing the buffer text | |
| 8357 - jumping to another buffer or window | |
| 8358 - editing another file | |
| 8359 - closing a window or quitting Vim | |
| 8360 - etc. | |
| 8361 | |
| 7 | 8362 |
| 8363 vim:tw=78:ts=8:ft=help:norl: |