Mercurial > vim
annotate runtime/doc/eval.txt @ 10048:43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Author: Bram Moolenaar <Bram@vim.org>
Date: Tue Aug 30 23:26:57 2016 +0200
Updated runtime files. Remove version checks for Vim older than 6.0.
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Tue, 30 Aug 2016 23:30:09 +0200 |
| parents | 7cf4e210cf3c |
| children | 46763b01cd9a |
| rev | line source |
|---|---|
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
1 *eval.txt* For Vim version 7.4. Last change: 2016 Aug 30 |
| 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 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
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| |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
32 13. Testing |testing| |
| 7 | 33 |
| 34 {Vi does not have any of these commands} | |
| 35 | |
| 36 ============================================================================== | |
| 37 1. Variables *variables* | |
| 38 | |
| 85 | 39 1.1 Variable types ~ |
| 114 | 40 *E712* |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
41 There are nine types of variables: |
| 1621 | 42 |
| 3082 | 43 Number A 32 or 64 bit signed number. |expr-number| *Number* |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
44 64-bit Numbers are available only when compiled with the |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
45 |+num64| feature. |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
46 Examples: -123 0x10 0177 0b1011 |
| 99 | 47 |
| 1621 | 48 Float A floating point number. |floating-point-format| *Float* |
| 49 {only when compiled with the |+float| feature} | |
| 50 Examples: 123.456 1.15e-6 -1.1e3 | |
| 51 | |
|
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
52 *E928* |
| 99 | 53 String A NUL terminated string of 8-bit unsigned characters (bytes). |
| 1621 | 54 |expr-string| Examples: "ab\txx\"--" 'x-z''a,c' |
| 99 | 55 |
| 56 List An ordered sequence of items |List|. | |
| 57 Example: [1, 2, ['a', 'b']] | |
| 55 | 58 |
| 370 | 59 Dictionary An associative, unordered array: Each entry has a key and a |
| 60 value. |Dictionary| | |
| 61 Example: {'blue': "#0000ff", 'red': "#ff0000"} | |
| 62 | |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
63 Funcref A reference to a function |Funcref|. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
64 Example: function("strlen") |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
65 It can be bound to a dictionary and arguments, it then works |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
66 like a Partial. |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
67 Example: function("Callback", [arg], myDict) |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
68 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
69 Special |v:false|, |v:true|, |v:none| and |v:null|. *Special* |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
70 |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
71 Job Used for a job, see |job_start()|. *Job* *Jobs* |
|
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
72 |
|
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
73 Channel Used for a channel, see |ch_open()|. *Channel* *Channels* |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
74 |
| 55 | 75 The Number and String types are converted automatically, depending on how they |
| 76 are used. | |
| 7 | 77 |
| 78 Conversion from a Number to a String is by making the ASCII representation of | |
| 2581 | 79 the Number. Examples: |
| 80 Number 123 --> String "123" ~ | |
| 81 Number 0 --> String "0" ~ | |
| 82 Number -1 --> String "-1" ~ | |
| 2152 | 83 *octal* |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
84 Conversion from a String to a Number is done by converting the first digits to |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
85 a number. Hexadecimal "0xf9", Octal "017", and Binary "0b10" numbers are |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
86 recognized. If the String doesn't start with digits, the result is zero. |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
87 Examples: |
| 2581 | 88 String "456" --> Number 456 ~ |
| 89 String "6bar" --> Number 6 ~ | |
| 90 String "foo" --> Number 0 ~ | |
| 91 String "0xf1" --> Number 241 ~ | |
| 92 String "0100" --> Number 64 ~ | |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
93 String "0b101" --> Number 5 ~ |
| 2581 | 94 String "-8" --> Number -8 ~ |
| 95 String "+8" --> Number 0 ~ | |
| 7 | 96 |
| 97 To force conversion from String to Number, add zero to it: > | |
| 98 :echo "0100" + 0 | |
| 782 | 99 < 64 ~ |
| 100 | |
| 101 To avoid a leading zero to cause octal conversion, or for using a different | |
| 102 base, use |str2nr()|. | |
| 7 | 103 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
104 *TRUE* *FALSE* |
| 7 | 105 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE. |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
106 You can also use |v:false| and |v:true|. When TRUE is returned from a |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
107 function it is the Number one, FALSE is the number zero. |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
108 |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
109 Note that in the command: > |
| 7 | 110 :if "foo" |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
111 :" NOT executed |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
112 "foo" is converted to 0, which means FALSE. If the string starts with a |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
113 non-zero number it means TRUE: > |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
114 :if "8foo" |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
115 :" executed |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
116 To test for a non-empty string, use empty(): > |
| 3893 | 117 :if !empty("foo") |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
118 < |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
119 *non-zero-arg* |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
120 Function arguments often behave slightly different from |TRUE|: If the |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
121 argument is present and it evaluates to a non-zero Number, |v:true| or a |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
122 non-empty String, then the value is considere to be TRUE. |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
123 Note that " " and "0" are also non-empty strings, thus cause the mode to be |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
124 cleared. A List, Dictionary or Float is not a Number or String, thus |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
125 evaluates to FALSE. |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
126 |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
127 *E745* *E728* *E703* *E729* *E730* *E731* *E908* *E910* *E913* |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
128 List, Dictionary, Funcref and Job types are not automatically converted. |
| 85 | 129 |
| 1621 | 130 *E805* *E806* *E808* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
131 When mixing Number and Float the Number is converted to Float. Otherwise |
| 1621 | 132 there is no automatic conversion of Float. You can use str2float() for String |
| 133 to Float, printf() for Float to String and float2nr() for Float to Number. | |
| 134 | |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
135 *E891* *E892* *E893* *E894* *E907* *E911* *E914* |
|
7707
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
136 When expecting a Float a Number can also be used, but nothing else. |
|
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
137 |
|
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
138 *no-type-checking* |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
139 You will not get an error if you try to change the type of a variable. |
| 85 | 140 |
| 141 | |
| 87 | 142 1.2 Function references ~ |
| 153 | 143 *Funcref* *E695* *E718* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
144 A Funcref variable is obtained with the |function()| function, the |funcref()| |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
145 function or created with the lambda expression |expr-lambda|. It can be used |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
146 in an expression in the place of a function name, before the parenthesis |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
147 around the arguments, to invoke the function it refers to. Example: > |
| 55 | 148 |
| 149 :let Fn = function("MyFunc") | |
| 150 :echo Fn() | |
| 114 | 151 < *E704* *E705* *E707* |
| 819 | 152 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You |
| 5340 | 153 can use "g:" but the following name must still start with a capital. You |
| 819 | 154 cannot have both a Funcref variable and a function with the same name. |
| 85 | 155 |
| 114 | 156 A special case is defining a function and directly assigning its Funcref to a |
| 157 Dictionary entry. Example: > | |
| 158 :function dict.init() dict | |
| 159 : let self.val = 0 | |
| 160 :endfunction | |
| 161 | |
| 162 The key of the Dictionary can start with a lower case letter. The actual | |
| 163 function name is not used here. Also see |numbered-function|. | |
| 164 | |
| 165 A Funcref can also be used with the |:call| command: > | |
| 166 :call Fn() | |
| 167 :call dict.init() | |
| 85 | 168 |
| 169 The name of the referenced function can be obtained with |string()|. > | |
| 119 | 170 :let func = string(Fn) |
| 85 | 171 |
| 172 You can use |call()| to invoke a Funcref and use a list variable for the | |
| 173 arguments: > | |
| 119 | 174 :let r = call(Fn, mylist) |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
175 < |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
176 *Partial* |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
177 A Funcref optionally binds a Dictionary and/or arguments. This is also called |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
178 a Partial. This is created by passing the Dictionary and/or arguments to |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
179 function() or funcref(). When calling the function the Dictionary and/or |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
180 arguments will be passed to the function. Example: > |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
181 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
182 let Cb = function('Callback', ['foo'], myDict) |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
183 call Cb() |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
184 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
185 This will invoke the function as if using: > |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
186 call myDict.Callback('foo') |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
187 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
188 This is very useful when passing a function around, e.g. in the arguments of |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
189 |ch_open()|. |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
190 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
191 Note that binding a function to a Dictionary also happens when the function is |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
192 a member of the Dictionary: > |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
193 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
194 let myDict.myFunction = MyFunction |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
195 call myDict.myFunction() |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
196 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
197 Here MyFunction() will get myDict passed as "self". This happens when the |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
198 "myFunction" member is accessed. When making assigning "myFunction" to |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
199 otherDict and calling it, it will be bound to otherDict: > |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
200 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
201 let otherDict.myFunction = myDict.myFunction |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
202 call otherDict.myFunction() |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
203 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
204 Now "self" will be "otherDict". But when the dictionary was bound explicitly |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
205 this won't happen: > |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
206 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
207 let myDict.myFunction = function(MyFunction, myDict) |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
208 let otherDict.myFunction = myDict.myFunction |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
209 call otherDict.myFunction() |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
210 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
211 Here "self" will be "myDict", because it was bound explicitly. |
| 85 | 212 |
| 213 | |
| 87 | 214 1.3 Lists ~ |
| 5814 | 215 *list* *List* *Lists* *E686* |
| 55 | 216 A List is an ordered sequence of items. An item can be of any type. Items |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
217 can be accessed by their index number. Items can be added and removed at any |
| 55 | 218 position in the sequence. |
| 219 | |
| 85 | 220 |
| 221 List creation ~ | |
| 222 *E696* *E697* | |
| 55 | 223 A List is created with a comma separated list of items in square brackets. |
| 85 | 224 Examples: > |
| 225 :let mylist = [1, two, 3, "four"] | |
| 226 :let emptylist = [] | |
| 55 | 227 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
228 An item can be any expression. Using a List for an item creates a |
| 842 | 229 List of Lists: > |
| 85 | 230 :let nestlist = [[11, 12], [21, 22], [31, 32]] |
| 55 | 231 |
| 232 An extra comma after the last item is ignored. | |
| 233 | |
| 85 | 234 |
| 235 List index ~ | |
| 236 *list-index* *E684* | |
| 55 | 237 An item in the List can be accessed by putting the index in square brackets |
| 85 | 238 after the List. Indexes are zero-based, thus the first item has index zero. > |
| 239 :let item = mylist[0] " get the first item: 1 | |
| 55 | 240 :let item = mylist[2] " get the third item: 3 |
| 85 | 241 |
| 87 | 242 When the resulting item is a list this can be repeated: > |
| 85 | 243 :let item = nestlist[0][1] " get the first list, second item: 12 |
| 55 | 244 < |
| 85 | 245 A negative index is counted from the end. Index -1 refers to the last item in |
| 246 the List, -2 to the last but one item, etc. > | |
| 55 | 247 :let last = mylist[-1] " get the last item: "four" |
| 248 | |
| 85 | 249 To avoid an error for an invalid index use the |get()| function. When an item |
| 87 | 250 is not available it returns zero or the default value you specify: > |
| 85 | 251 :echo get(mylist, idx) |
| 252 :echo get(mylist, idx, "NONE") | |
| 253 | |
| 254 | |
| 255 List concatenation ~ | |
| 256 | |
| 257 Two lists can be concatenated with the "+" operator: > | |
| 258 :let longlist = mylist + [5, 6] | |
| 119 | 259 :let mylist += [7, 8] |
| 85 | 260 |
| 261 To prepend or append an item turn the item into a list by putting [] around | |
| 262 it. To change a list in-place see |list-modification| below. | |
| 263 | |
| 264 | |
| 265 Sublist ~ | |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
266 *sublist* |
| 55 | 267 A part of the List can be obtained by specifying the first and last index, |
| 268 separated by a colon in square brackets: > | |
| 85 | 269 :let shortlist = mylist[2:-1] " get List [3, "four"] |
| 55 | 270 |
| 271 Omitting the first index is similar to zero. Omitting the last index is | |
| 1156 | 272 similar to -1. > |
| 90 | 273 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"] |
| 274 :let shortlist = mylist[2:2] " List with one item: [3] | |
| 275 :let otherlist = mylist[:] " make a copy of the List | |
| 85 | 276 |
| 842 | 277 If the first index is beyond the last item of the List or the second item is |
| 278 before the first item, the result is an empty list. There is no error | |
| 279 message. | |
| 280 | |
| 281 If the second index is equal to or greater than the length of the list the | |
| 282 length minus one is used: > | |
| 829 | 283 :let mylist = [0, 1, 2, 3] |
| 284 :echo mylist[2:8] " result: [2, 3] | |
| 285 | |
| 270 | 286 NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
287 using a single letter variable before the ":". Insert a space when needed: |
| 270 | 288 mylist[s : e]. |
| 289 | |
| 85 | 290 |
| 291 List identity ~ | |
| 99 | 292 *list-identity* |
| 85 | 293 When variable "aa" is a list and you assign it to another variable "bb", both |
| 294 variables refer to the same list. Thus changing the list "aa" will also | |
| 295 change "bb": > | |
| 296 :let aa = [1, 2, 3] | |
| 297 :let bb = aa | |
| 298 :call add(aa, 4) | |
| 299 :echo bb | |
| 114 | 300 < [1, 2, 3, 4] |
| 85 | 301 |
| 302 Making a copy of a list is done with the |copy()| function. Using [:] also | |
| 303 works, as explained above. This creates a shallow copy of the list: Changing | |
| 87 | 304 a list item in the list will also change the item in the copied list: > |
| 85 | 305 :let aa = [[1, 'a'], 2, 3] |
| 306 :let bb = copy(aa) | |
| 114 | 307 :call add(aa, 4) |
| 85 | 308 :let aa[0][1] = 'aaa' |
| 309 :echo aa | |
| 114 | 310 < [[1, aaa], 2, 3, 4] > |
| 85 | 311 :echo bb |
| 114 | 312 < [[1, aaa], 2, 3] |
| 85 | 313 |
| 87 | 314 To make a completely independent list use |deepcopy()|. This also makes a |
| 114 | 315 copy of the values in the list, recursively. Up to a hundred levels deep. |
| 85 | 316 |
| 317 The operator "is" can be used to check if two variables refer to the same | |
| 114 | 318 List. "isnot" does the opposite. In contrast "==" compares if two lists have |
| 87 | 319 the same value. > |
| 320 :let alist = [1, 2, 3] | |
| 321 :let blist = [1, 2, 3] | |
| 322 :echo alist is blist | |
| 114 | 323 < 0 > |
| 87 | 324 :echo alist == blist |
| 114 | 325 < 1 |
| 85 | 326 |
| 323 | 327 Note about comparing lists: Two lists are considered equal if they have the |
| 328 same length and all items compare equal, as with using "==". There is one | |
| 388 | 329 exception: When comparing a number with a string they are considered |
| 330 different. There is no automatic type conversion, as with using "==" on | |
| 331 variables. Example: > | |
| 332 echo 4 == "4" | |
| 323 | 333 < 1 > |
| 388 | 334 echo [4] == ["4"] |
| 323 | 335 < 0 |
| 336 | |
| 388 | 337 Thus comparing Lists is more strict than comparing numbers and strings. You |
| 1621 | 338 can compare simple values this way too by putting them in a list: > |
| 388 | 339 |
| 340 :let a = 5 | |
| 341 :let b = "5" | |
| 1621 | 342 :echo a == b |
| 388 | 343 < 1 > |
| 1621 | 344 :echo [a] == [b] |
| 388 | 345 < 0 |
| 323 | 346 |
| 85 | 347 |
| 348 List unpack ~ | |
| 349 | |
| 350 To unpack the items in a list to individual variables, put the variables in | |
| 351 square brackets, like list items: > | |
| 352 :let [var1, var2] = mylist | |
| 353 | |
| 354 When the number of variables does not match the number of items in the list | |
| 355 this produces an error. To handle any extra items from the list append ";" | |
| 356 and a variable name: > | |
| 357 :let [var1, var2; rest] = mylist | |
| 358 | |
| 359 This works like: > | |
| 360 :let var1 = mylist[0] | |
| 361 :let var2 = mylist[1] | |
| 95 | 362 :let rest = mylist[2:] |
| 85 | 363 |
| 364 Except that there is no error if there are only two items. "rest" will be an | |
| 365 empty list then. | |
| 366 | |
| 367 | |
| 368 List modification ~ | |
| 369 *list-modification* | |
| 87 | 370 To change a specific item of a list use |:let| this way: > |
| 85 | 371 :let list[4] = "four" |
| 372 :let listlist[0][3] = item | |
| 373 | |
| 87 | 374 To change part of a list you can specify the first and last item to be |
| 114 | 375 modified. The value must at least have the number of items in the range: > |
| 87 | 376 :let list[3:5] = [3, 4, 5] |
| 377 | |
| 85 | 378 Adding and removing items from a list is done with functions. Here are a few |
| 379 examples: > | |
| 380 :call insert(list, 'a') " prepend item 'a' | |
| 381 :call insert(list, 'a', 3) " insert item 'a' before list[3] | |
| 382 :call add(list, "new") " append String item | |
| 114 | 383 :call add(list, [1, 2]) " append a List as one new item |
| 85 | 384 :call extend(list, [1, 2]) " extend the list with two more items |
| 385 :let i = remove(list, 3) " remove item 3 | |
| 108 | 386 :unlet list[3] " idem |
| 85 | 387 :let l = remove(list, 3, -1) " remove items 3 to last item |
| 108 | 388 :unlet list[3 : ] " idem |
| 114 | 389 :call filter(list, 'v:val !~ "x"') " remove items with an 'x' |
| 390 | |
| 391 Changing the order of items in a list: > | |
| 87 | 392 :call sort(list) " sort a list alphabetically |
| 393 :call reverse(list) " reverse the order of items | |
| 5747 | 394 :call uniq(sort(list)) " sort and remove duplicates |
| 87 | 395 |
| 85 | 396 |
| 397 For loop ~ | |
| 398 | |
| 87 | 399 The |:for| loop executes commands for each item in a list. A variable is set |
| 400 to each item in the list in sequence. Example: > | |
| 114 | 401 :for item in mylist |
| 402 : call Doit(item) | |
| 85 | 403 :endfor |
| 404 | |
| 405 This works like: > | |
| 406 :let index = 0 | |
| 407 :while index < len(mylist) | |
| 114 | 408 : let item = mylist[index] |
| 409 : :call Doit(item) | |
| 85 | 410 : let index = index + 1 |
| 411 :endwhile | |
| 412 | |
| 95 | 413 If all you want to do is modify each item in the list then the |map()| |
| 114 | 414 function will be a simpler method than a for loop. |
| 95 | 415 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
416 Just like the |:let| command, |:for| also accepts a list of variables. This |
| 85 | 417 requires the argument to be a list of lists. > |
| 418 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]] | |
| 419 : call Doit(lnum, col) | |
| 420 :endfor | |
| 421 | |
| 422 This works like a |:let| command is done for each list item. Again, the types | |
| 423 must remain the same to avoid an error. | |
| 424 | |
| 114 | 425 It is also possible to put remaining items in a List variable: > |
| 85 | 426 :for [i, j; rest] in listlist |
| 427 : call Doit(i, j) | |
| 428 : if !empty(rest) | |
| 429 : echo "remainder: " . string(rest) | |
| 430 : endif | |
| 431 :endfor | |
| 432 | |
| 433 | |
| 434 List functions ~ | |
| 114 | 435 *E714* |
| 85 | 436 Functions that are useful with a List: > |
| 87 | 437 :let r = call(funcname, list) " call a function with an argument list |
| 85 | 438 :if empty(list) " check if list is empty |
| 102 | 439 :let l = len(list) " number of items in list |
| 440 :let big = max(list) " maximum value in list | |
| 441 :let small = min(list) " minimum value in list | |
| 87 | 442 :let xs = count(list, 'x') " count nr of times 'x' appears in list |
| 443 :let i = index(list, 'x') " index of first 'x' in list | |
| 85 | 444 :let lines = getline(1, 10) " get ten text lines from buffer |
| 445 :call append('$', lines) " append text lines in buffer | |
| 95 | 446 :let list = split("a b c") " create list from items in a string |
| 447 :let string = join(list, ', ') " create string from list items | |
| 102 | 448 :let s = string(list) " String representation of list |
| 449 :call map(list, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 450 |
| 258 | 451 Don't forget that a combination of features can make things simple. For |
| 452 example, to add up all the numbers in a list: > | |
| 453 :exe 'let sum = ' . join(nrlist, '+') | |
| 454 | |
| 99 | 455 |
| 456 1.4 Dictionaries ~ | |
| 5814 | 457 *dict* *Dictionaries* *Dictionary* |
| 99 | 458 A Dictionary is an associative array: Each entry has a key and a value. The |
| 114 | 459 entry can be located with the key. The entries are stored without a specific |
| 460 ordering. | |
| 99 | 461 |
| 462 | |
| 463 Dictionary creation ~ | |
| 114 | 464 *E720* *E721* *E722* *E723* |
| 99 | 465 A Dictionary is created with a comma separated list of entries in curly |
| 114 | 466 braces. Each entry has a key and a value, separated by a colon. Each key can |
| 467 only appear once. Examples: > | |
| 99 | 468 :let mydict = {1: 'one', 2: 'two', 3: 'three'} |
| 469 :let emptydict = {} | |
| 114 | 470 < *E713* *E716* *E717* |
| 99 | 471 A key is always a String. You can use a Number, it will be converted to a |
| 472 String automatically. Thus the String '4' and the number 4 will find the same | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
473 entry. Note that the String '04' and the Number 04 are different, since the |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
474 Number will be converted to the String '4'. The empty string can be used as a |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
475 key. |
| 114 | 476 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
477 A value can be any expression. Using a Dictionary for a value creates a |
| 99 | 478 nested Dictionary: > |
| 479 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}} | |
| 480 | |
| 481 An extra comma after the last entry is ignored. | |
| 482 | |
| 483 | |
| 484 Accessing entries ~ | |
| 485 | |
| 486 The normal way to access an entry is by putting the key in square brackets: > | |
| 487 :let val = mydict["one"] | |
| 488 :let mydict["four"] = 4 | |
| 489 | |
| 114 | 490 You can add new entries to an existing Dictionary this way, unlike Lists. |
| 99 | 491 |
| 492 For keys that consist entirely of letters, digits and underscore the following | |
| 493 form can be used |expr-entry|: > | |
| 494 :let val = mydict.one | |
| 495 :let mydict.four = 4 | |
| 496 | |
| 497 Since an entry can be any type, also a List and a Dictionary, the indexing and | |
| 498 key lookup can be repeated: > | |
| 114 | 499 :echo dict.key[idx].key |
| 99 | 500 |
| 501 | |
| 502 Dictionary to List conversion ~ | |
| 503 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
504 You may want to loop over the entries in a dictionary. For this you need to |
| 99 | 505 turn the Dictionary into a List and pass it to |:for|. |
| 506 | |
| 507 Most often you want to loop over the keys, using the |keys()| function: > | |
| 508 :for key in keys(mydict) | |
| 509 : echo key . ': ' . mydict[key] | |
| 510 :endfor | |
| 511 | |
| 512 The List of keys is unsorted. You may want to sort them first: > | |
| 513 :for key in sort(keys(mydict)) | |
| 514 | |
| 515 To loop over the values use the |values()| function: > | |
| 516 :for v in values(mydict) | |
| 517 : echo "value: " . v | |
| 518 :endfor | |
| 519 | |
| 520 If you want both the key and the value use the |items()| function. It returns | |
| 1621 | 521 a List in which each item is a List with two items, the key and the value: > |
| 1156 | 522 :for [key, value] in items(mydict) |
| 523 : echo key . ': ' . value | |
| 99 | 524 :endfor |
| 525 | |
| 526 | |
| 527 Dictionary identity ~ | |
| 161 | 528 *dict-identity* |
| 99 | 529 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a |
| 530 Dictionary. Otherwise, assignment results in referring to the same | |
| 531 Dictionary: > | |
| 532 :let onedict = {'a': 1, 'b': 2} | |
| 533 :let adict = onedict | |
| 534 :let adict['a'] = 11 | |
| 535 :echo onedict['a'] | |
| 536 11 | |
| 537 | |
| 327 | 538 Two Dictionaries compare equal if all the key-value pairs compare equal. For |
| 539 more info see |list-identity|. | |
| 99 | 540 |
| 541 | |
| 542 Dictionary modification ~ | |
| 543 *dict-modification* | |
| 544 To change an already existing entry of a Dictionary, or to add a new entry, | |
| 545 use |:let| this way: > | |
| 546 :let dict[4] = "four" | |
| 547 :let dict['one'] = item | |
| 548 | |
| 108 | 549 Removing an entry from a Dictionary is done with |remove()| or |:unlet|. |
| 550 Three ways to remove the entry with key "aaa" from dict: > | |
| 551 :let i = remove(dict, 'aaa') | |
| 552 :unlet dict.aaa | |
| 553 :unlet dict['aaa'] | |
| 99 | 554 |
| 555 Merging a Dictionary with another is done with |extend()|: > | |
| 114 | 556 :call extend(adict, bdict) |
| 557 This extends adict with all entries from bdict. Duplicate keys cause entries | |
| 558 in adict to be overwritten. An optional third argument can change this. | |
| 119 | 559 Note that the order of entries in a Dictionary is irrelevant, thus don't |
| 560 expect ":echo adict" to show the items from bdict after the older entries in | |
| 561 adict. | |
| 99 | 562 |
| 563 Weeding out entries from a Dictionary can be done with |filter()|: > | |
| 1156 | 564 :call filter(dict, 'v:val =~ "x"') |
| 114 | 565 This removes all entries from "dict" with a value not matching 'x'. |
| 102 | 566 |
| 567 | |
| 568 Dictionary function ~ | |
| 4159 | 569 *Dictionary-function* *self* *E725* *E862* |
| 102 | 570 When a function is defined with the "dict" attribute it can be used in a |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
571 special way with a dictionary. Example: > |
| 102 | 572 :function Mylen() dict |
| 114 | 573 : return len(self.data) |
| 102 | 574 :endfunction |
| 114 | 575 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")} |
| 576 :echo mydict.len() | |
| 102 | 577 |
| 578 This is like a method in object oriented programming. The entry in the | |
| 579 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary | |
| 580 the function was invoked from. | |
| 581 | |
| 114 | 582 It is also possible to add a function without the "dict" attribute as a |
| 583 Funcref to a Dictionary, but the "self" variable is not available then. | |
| 584 | |
| 819 | 585 *numbered-function* *anonymous-function* |
| 102 | 586 To avoid the extra name for the function it can be defined and directly |
| 587 assigned to a Dictionary in this way: > | |
| 114 | 588 :let mydict = {'data': [0, 1, 2, 3]} |
| 6741 | 589 :function mydict.len() |
| 114 | 590 : return len(self.data) |
| 102 | 591 :endfunction |
| 114 | 592 :echo mydict.len() |
| 593 | |
| 594 The function will then get a number and the value of dict.len is a |Funcref| | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
595 that references this function. The function can only be used through a |
| 114 | 596 |Funcref|. It will automatically be deleted when there is no |Funcref| |
| 597 remaining that refers to it. | |
| 598 | |
| 599 It is not necessary to use the "dict" attribute for a numbered function. | |
| 102 | 600 |
|
2488
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
601 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
|
602 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
|
603 :function {42} |
|
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
604 |
| 102 | 605 |
| 606 Functions for Dictionaries ~ | |
| 114 | 607 *E715* |
| 608 Functions that can be used with a Dictionary: > | |
| 102 | 609 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo" |
| 610 :if empty(dict) " TRUE if dict is empty | |
| 611 :let l = len(dict) " number of items in dict | |
| 612 :let big = max(dict) " maximum value in dict | |
| 613 :let small = min(dict) " minimum value in dict | |
| 614 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict | |
| 615 :let s = string(dict) " String representation of dict | |
| 616 :call map(dict, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 617 |
| 618 | |
| 619 1.5 More about variables ~ | |
| 85 | 620 *more-variables* |
| 7 | 621 If you need to know the type of a variable or expression, use the |type()| |
| 622 function. | |
| 623 | |
| 624 When the '!' flag is included in the 'viminfo' option, global variables that | |
| 625 start with an uppercase letter, and don't contain a lowercase letter, are | |
| 626 stored in the viminfo file |viminfo-file|. | |
| 627 | |
| 628 When the 'sessionoptions' option contains "global", global variables that | |
| 629 start with an uppercase letter and contain at least one lowercase letter are | |
| 630 stored in the session file |session-file|. | |
| 631 | |
| 632 variable name can be stored where ~ | |
| 633 my_var_6 not | |
| 634 My_Var_6 session file | |
| 635 MY_VAR_6 viminfo file | |
| 636 | |
| 637 | |
| 638 It's possible to form a variable name with curly braces, see | |
| 639 |curly-braces-names|. | |
| 640 | |
| 641 ============================================================================== | |
| 642 2. Expression syntax *expression-syntax* | |
| 643 | |
| 644 Expression syntax summary, from least to most significant: | |
| 645 | |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
646 |expr1| expr2 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
647 expr2 ? expr1 : expr1 if-then-else |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
648 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
649 |expr2| expr3 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
650 expr3 || expr3 .. logical OR |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
651 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
652 |expr3| expr4 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
653 expr4 && expr4 .. logical AND |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
654 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
655 |expr4| expr5 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
656 expr5 == expr5 equal |
| 7 | 657 expr5 != expr5 not equal |
| 658 expr5 > expr5 greater than | |
| 659 expr5 >= expr5 greater than or equal | |
| 660 expr5 < expr5 smaller than | |
| 661 expr5 <= expr5 smaller than or equal | |
| 662 expr5 =~ expr5 regexp matches | |
| 663 expr5 !~ expr5 regexp doesn't match | |
| 664 | |
| 665 expr5 ==? expr5 equal, ignoring case | |
| 666 expr5 ==# expr5 equal, match case | |
| 667 etc. As above, append ? for ignoring case, # for | |
| 668 matching case | |
| 669 | |
| 685 | 670 expr5 is expr5 same |List| instance |
| 671 expr5 isnot expr5 different |List| instance | |
| 79 | 672 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
673 |expr5| expr6 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
674 expr6 + expr6 .. number addition or list concatenation |
| 7 | 675 expr6 - expr6 .. number subtraction |
| 676 expr6 . expr6 .. string concatenation | |
| 677 | |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
678 |expr6| expr7 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
679 expr7 * expr7 .. number multiplication |
| 7 | 680 expr7 / expr7 .. number division |
| 681 expr7 % expr7 .. number modulo | |
| 682 | |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
683 |expr7| expr8 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
684 ! expr7 logical NOT |
| 7 | 685 - expr7 unary minus |
| 686 + expr7 unary plus | |
| 102 | 687 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
688 |expr8| expr9 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
689 expr8[expr1] byte of a String or item of a |List| |
| 685 | 690 expr8[expr1 : expr1] substring of a String or sublist of a |List| |
| 691 expr8.name entry in a |Dictionary| | |
| 692 expr8(expr1, ...) function call with |Funcref| variable | |
| 102 | 693 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
694 |expr9| number number constant |
| 26 | 695 "string" string constant, backslash is special |
| 99 | 696 'string' string constant, ' is doubled |
| 685 | 697 [expr1, ...] |List| |
| 698 {expr1: expr1, ...} |Dictionary| | |
| 7 | 699 &option option value |
| 700 (expr1) nested expression | |
| 701 variable internal variable | |
| 702 va{ria}ble internal variable with curly braces | |
| 703 $VAR environment variable | |
| 704 @r contents of register 'r' | |
| 705 function(expr1, ...) function call | |
| 706 func{ti}on(expr1, ...) function call with curly braces | |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
707 {args -> expr1} lambda expression |
| 7 | 708 |
| 709 | |
| 710 ".." indicates that the operations in this level can be concatenated. | |
| 711 Example: > | |
| 712 &nu || &list && &shell == "csh" | |
| 713 | |
| 714 All expressions within one level are parsed from left to right. | |
| 715 | |
| 716 | |
| 717 expr1 *expr1* *E109* | |
| 718 ----- | |
| 719 | |
| 720 expr2 ? expr1 : expr1 | |
| 721 | |
| 722 The expression before the '?' is evaluated to a number. If it evaluates to | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
723 |TRUE|, the result is the value of the expression between the '?' and ':', |
| 7 | 724 otherwise the result is the value of the expression after the ':'. |
| 725 Example: > | |
| 726 :echo lnum == 1 ? "top" : lnum | |
| 727 | |
| 728 Since the first expression is an "expr2", it cannot contain another ?:. The | |
| 729 other two expressions can, thus allow for recursive use of ?:. | |
| 730 Example: > | |
| 731 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum | |
| 732 | |
| 733 To keep this readable, using |line-continuation| is suggested: > | |
| 734 :echo lnum == 1 | |
| 735 :\ ? "top" | |
| 736 :\ : lnum == 1000 | |
| 737 :\ ? "last" | |
| 738 :\ : lnum | |
| 739 | |
| 1156 | 740 You should always put a space before the ':', otherwise it can be mistaken for |
| 741 use in a variable such as "a:1". | |
| 742 | |
| 7 | 743 |
| 744 expr2 and expr3 *expr2* *expr3* | |
| 745 --------------- | |
| 746 | |
|
10038
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
747 expr3 || expr3 .. logical OR *expr-barbar* |
|
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
748 expr4 && expr4 .. logical AND *expr-&&* |
|
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
749 |
| 7 | 750 The "||" and "&&" operators take one argument on each side. The arguments |
| 751 are (converted to) Numbers. The result is: | |
| 752 | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
753 input output ~ |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
754 n1 n2 n1 || n2 n1 && n2 ~ |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
755 |FALSE| |FALSE| |FALSE| |FALSE| |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
756 |FALSE| |TRUE| |TRUE| |FALSE| |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
757 |TRUE| |FALSE| |TRUE| |FALSE| |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
758 |TRUE| |TRUE| |TRUE| |TRUE| |
| 7 | 759 |
| 760 The operators can be concatenated, for example: > | |
| 761 | |
| 762 &nu || &list && &shell == "csh" | |
| 763 | |
| 764 Note that "&&" takes precedence over "||", so this has the meaning of: > | |
| 765 | |
| 766 &nu || (&list && &shell == "csh") | |
| 767 | |
| 768 Once the result is known, the expression "short-circuits", that is, further | |
| 769 arguments are not evaluated. This is like what happens in C. For example: > | |
| 770 | |
| 771 let a = 1 | |
| 772 echo a || b | |
| 773 | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
774 This is valid even if there is no variable called "b" because "a" is |TRUE|, |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
775 so the result must be |TRUE|. Similarly below: > |
| 7 | 776 |
| 777 echo exists("b") && b == "yes" | |
| 778 | |
| 779 This is valid whether "b" has been defined or not. The second clause will | |
| 780 only be evaluated if "b" has been defined. | |
| 781 | |
| 782 | |
| 783 expr4 *expr4* | |
| 784 ----- | |
| 785 | |
| 786 expr5 {cmp} expr5 | |
| 787 | |
| 788 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1 | |
| 789 if it evaluates to true. | |
| 790 | |
| 1621 | 791 *expr-==* *expr-!=* *expr->* *expr->=* |
| 7 | 792 *expr-<* *expr-<=* *expr-=~* *expr-!~* |
| 793 *expr-==#* *expr-!=#* *expr->#* *expr->=#* | |
| 794 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#* | |
| 795 *expr-==?* *expr-!=?* *expr->?* *expr->=?* | |
| 796 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?* | |
| 2908 | 797 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#* |
| 798 *expr-is?* *expr-isnot?* | |
| 7 | 799 use 'ignorecase' match case ignore case ~ |
| 800 equal == ==# ==? | |
| 801 not equal != !=# !=? | |
| 802 greater than > ># >? | |
| 803 greater than or equal >= >=# >=? | |
| 804 smaller than < <# <? | |
| 805 smaller than or equal <= <=# <=? | |
| 806 regexp matches =~ =~# =~? | |
| 807 regexp doesn't match !~ !~# !~? | |
| 2908 | 808 same instance is is# is? |
| 809 different instance isnot isnot# isnot? | |
| 7 | 810 |
| 811 Examples: | |
| 812 "abc" ==# "Abc" evaluates to 0 | |
| 813 "abc" ==? "Abc" evaluates to 1 | |
| 814 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise | |
| 815 | |
| 85 | 816 *E691* *E692* |
| 685 | 817 A |List| can only be compared with a |List| and only "equal", "not equal" and |
| 818 "is" can be used. This compares the values of the list, recursively. | |
| 819 Ignoring case means case is ignored when comparing item values. | |
| 79 | 820 |
| 114 | 821 *E735* *E736* |
| 685 | 822 A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not |
| 823 equal" and "is" can be used. This compares the key/values of the |Dictionary| | |
| 114 | 824 recursively. Ignoring case means case is ignored when comparing item values. |
| 825 | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
826 *E694* |
|
9407
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
827 A |Funcref| can only be compared with a |Funcref| and only "equal", "not |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
828 equal", "is" and "isnot" can be used. Case is never ignored. Whether |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
829 arguments or a Dictionary are bound (with a partial) matters. The |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
830 Dictionaries must also be equal (or the same, in case of "is") and the |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
831 arguments must be equal (or the same). |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
832 |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
833 To compare Funcrefs to see if they refer to the same function, ignoring bound |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
834 Dictionary and arguments, use |get()| to get the function name: > |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
835 if get(Part1, 'name') == get(Part2, 'name') |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
836 " Part1 and Part2 refer to the same function |
| 685 | 837 |
| 2908 | 838 When using "is" or "isnot" with a |List| or a |Dictionary| this checks if the |
| 839 expressions are referring to the same |List| or |Dictionary| instance. A copy | |
| 840 of a |List| is different from the original |List|. When using "is" without | |
| 841 a |List| or a |Dictionary| it is equivalent to using "equal", using "isnot" | |
| 842 equivalent to using "not equal". Except that a different type means the | |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
843 values are different: > |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
844 echo 4 == '4' |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
845 1 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
846 echo 4 is '4' |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
847 0 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
848 echo 0 is [] |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
849 0 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
850 "is#"/"isnot#" and "is?"/"isnot?" can be used to match and ignore case. |
| 79 | 851 |
| 7 | 852 When comparing a String with a Number, the String is converted to a Number, |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
853 and the comparison is done on Numbers. This means that: > |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
854 echo 0 == 'x' |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
855 1 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
856 because 'x' converted to a Number is zero. However: > |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
857 echo [0] == ['x'] |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
858 0 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
859 Inside a List or Dictionary this conversion is not used. |
| 7 | 860 |
| 861 When comparing two Strings, this is done with strcmp() or stricmp(). This | |
| 862 results in the mathematical difference (comparing byte values), not | |
| 863 necessarily the alphabetical difference in the local language. | |
| 864 | |
| 1621 | 865 When using the operators with a trailing '#', or the short version and |
| 1156 | 866 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
| 7 | 867 |
| 868 When using the operators with a trailing '?', or the short version and | |
| 1156 | 869 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
| 870 | |
| 871 'smartcase' is not used. | |
| 7 | 872 |
| 873 The "=~" and "!~" operators match the lefthand argument with the righthand | |
| 874 argument, which is used as a pattern. See |pattern| for what a pattern is. | |
| 875 This matching is always done like 'magic' was set and 'cpoptions' is empty, no | |
| 876 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts | |
| 877 portable. To avoid backslashes in the regexp pattern to be doubled, use a | |
| 878 single-quote string, see |literal-string|. | |
| 879 Since a string is considered to be a single line, a multi-line pattern | |
| 880 (containing \n, backslash-n) will not match. However, a literal NL character | |
| 881 can be matched like an ordinary character. Examples: | |
| 882 "foo\nbar" =~ "\n" evaluates to 1 | |
| 883 "foo\nbar" =~ "\\n" evaluates to 0 | |
| 884 | |
| 885 | |
| 886 expr5 and expr6 *expr5* *expr6* | |
| 887 --------------- | |
| 685 | 888 expr6 + expr6 .. Number addition or |List| concatenation *expr-+* |
| 79 | 889 expr6 - expr6 .. Number subtraction *expr--* |
| 890 expr6 . expr6 .. String concatenation *expr-.* | |
| 891 | |
| 692 | 892 For |Lists| only "+" is possible and then both expr6 must be a list. The |
| 685 | 893 result is a new list with the two lists Concatenated. |
| 79 | 894 |
| 3214 | 895 expr7 * expr7 .. Number multiplication *expr-star* |
| 896 expr7 / expr7 .. Number division *expr-/* | |
| 897 expr7 % expr7 .. Number modulo *expr-%* | |
| 7 | 898 |
| 899 For all, except ".", Strings are converted to Numbers. | |
| 3214 | 900 For bitwise operators see |and()|, |or()| and |xor()|. |
| 7 | 901 |
| 902 Note the difference between "+" and ".": | |
| 903 "123" + "456" = 579 | |
| 904 "123" . "456" = "123456" | |
| 905 | |
| 1621 | 906 Since '.' has the same precedence as '+' and '-', you need to read: > |
| 907 1 . 90 + 90.0 | |
| 908 As: > | |
| 909 (1 . 90) + 90.0 | |
| 910 That works, since the String "190" is automatically converted to the Number | |
| 911 190, which can be added to the Float 90.0. However: > | |
| 912 1 . 90 * 90.0 | |
| 913 Should be read as: > | |
| 914 1 . (90 * 90.0) | |
| 915 Since '.' has lower precedence than '*'. This does NOT work, since this | |
| 916 attempts to concatenate a Float and a String. | |
| 917 | |
| 918 When dividing a Number by zero the result depends on the value: | |
| 919 0 / 0 = -0x80000000 (like NaN for Float) | |
| 920 >0 / 0 = 0x7fffffff (like positive infinity) | |
| 921 <0 / 0 = -0x7fffffff (like negative infinity) | |
| 922 (before Vim 7.2 it was always 0x7fffffff) | |
| 923 | |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
924 When 64-bit Number support is enabled: |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
925 0 / 0 = -0x8000000000000000 (like NaN for Float) |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
926 >0 / 0 = 0x7fffffffffffffff (like positive infinity) |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
927 <0 / 0 = -0x7fffffffffffffff (like negative infinity) |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
928 |
| 7 | 929 When the righthand side of '%' is zero, the result is 0. |
| 930 | |
| 685 | 931 None of these work for |Funcref|s. |
| 79 | 932 |
| 1621 | 933 . and % do not work for Float. *E804* |
| 934 | |
| 7 | 935 |
| 936 expr7 *expr7* | |
| 937 ----- | |
| 938 ! expr7 logical NOT *expr-!* | |
| 939 - expr7 unary minus *expr-unary--* | |
| 940 + expr7 unary plus *expr-unary-+* | |
| 941 | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
942 For '!' |TRUE| becomes |FALSE|, |FALSE| becomes |TRUE| (one). |
| 7 | 943 For '-' the sign of the number is changed. |
| 944 For '+' the number is unchanged. | |
| 945 | |
| 946 A String will be converted to a Number first. | |
| 947 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
948 These three can be repeated and mixed. Examples: |
| 7 | 949 !-1 == 0 |
| 950 !!8 == 1 | |
| 951 --9 == 9 | |
| 952 | |
| 953 | |
| 954 expr8 *expr8* | |
| 955 ----- | |
| 685 | 956 expr8[expr1] item of String or |List| *expr-[]* *E111* |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
957 *E909* *subscript* |
| 102 | 958 If expr8 is a Number or String this results in a String that contains the |
| 959 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
|
960 Number. This doesn't recognize multi-byte encodings, see |byteidx()| for |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
961 an alternative, or use `split()` to turn the string into a list of characters. |
| 55 | 962 |
|
7384
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7358
diff
changeset
|
963 Index zero gives the first byte. This is like it works in C. Careful: |
|
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7358
diff
changeset
|
964 text column numbers start with one! Example, to get the byte under the |
| 55 | 965 cursor: > |
| 823 | 966 :let c = getline(".")[col(".") - 1] |
| 7 | 967 |
| 968 If the length of the String is less than the index, the result is an empty | |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
969 String. A negative index always results in an empty string (reason: backward |
| 55 | 970 compatibility). Use [-1:] to get the last byte. |
| 971 | |
| 685 | 972 If expr8 is a |List| then it results the item at index expr1. See |list-index| |
| 55 | 973 for possible index values. If the index is out of range this results in an |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
974 error. Example: > |
| 55 | 975 :let item = mylist[-1] " get last item |
| 976 | |
| 685 | 977 Generally, if a |List| index is equal to or higher than the length of the |
| 978 |List|, or more negative than the length of the |List|, this results in an | |
| 979 error. | |
| 55 | 980 |
| 99 | 981 |
| 102 | 982 expr8[expr1a : expr1b] substring or sublist *expr-[:]* |
| 983 | |
| 984 If expr8 is a Number or String this results in the substring with the bytes | |
| 985 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
|
986 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
|
987 |byteidx()| for computing the indexes. |
| 55 | 988 |
| 989 If expr1a is omitted zero is used. If expr1b is omitted the length of the | |
| 990 string minus one is used. | |
| 991 | |
| 992 A negative number can be used to measure from the end of the string. -1 is | |
| 993 the last character, -2 the last but one, etc. | |
| 994 | |
| 995 If an index goes out of range for the string characters are omitted. If | |
| 996 expr1b is smaller than expr1a the result is an empty string. | |
| 997 | |
| 998 Examples: > | |
| 999 :let c = name[-1:] " last byte of a string | |
| 1000 :let c = name[-2:-2] " last but one byte of a string | |
| 1001 :let s = line(".")[4:] " from the fifth byte to the end | |
| 1002 :let s = s[:-3] " remove last two bytes | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1003 < |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
1004 *slice* |
| 685 | 1005 If expr8 is a |List| this results in a new |List| with the items indicated by |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1006 the indexes expr1a and expr1b. This works like with a String, as explained |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
1007 just above. Also see |sublist| below. Examples: > |
| 55 | 1008 :let l = mylist[:3] " first four items |
| 1009 :let l = mylist[4:4] " List with one item | |
| 1010 :let l = mylist[:] " shallow copy of a List | |
| 1011 | |
| 685 | 1012 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an |
| 1013 error. | |
| 1014 | |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1015 Watch out for confusion between a namespace and a variable followed by a colon |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1016 for a sublist: > |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1017 mylist[n:] " uses variable n |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1018 mylist[s:] " uses namespace s:, error! |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1019 |
| 685 | 1020 |
| 1021 expr8.name entry in a |Dictionary| *expr-entry* | |
| 1022 | |
| 1023 If expr8 is a |Dictionary| and it is followed by a dot, then the following | |
| 1024 name will be used as a key in the |Dictionary|. This is just like: | |
| 1025 expr8[name]. | |
| 99 | 1026 |
| 1027 The name must consist of alphanumeric characters, just like a variable name, | |
| 1028 but it may start with a number. Curly braces cannot be used. | |
| 1029 | |
| 1030 There must not be white space before or after the dot. | |
| 1031 | |
| 1032 Examples: > | |
| 1033 :let dict = {"one": 1, 2: "two"} | |
| 1034 :echo dict.one | |
| 1035 :echo dict .2 | |
| 1036 | |
| 1037 Note that the dot is also used for String concatenation. To avoid confusion | |
| 1038 always put spaces around the dot for String concatenation. | |
| 1039 | |
| 1040 | |
| 685 | 1041 expr8(expr1, ...) |Funcref| function call |
| 102 | 1042 |
| 1043 When expr8 is a |Funcref| type variable, invoke the function it refers to. | |
| 1044 | |
| 1045 | |
| 1046 | |
| 1047 *expr9* | |
| 7 | 1048 number |
| 1049 ------ | |
| 3224 | 1050 number number constant *expr-number* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1051 *hex-number* *octal-number* *binary-number* |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1052 |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1053 Decimal, Hexadecimal (starting with 0x or 0X), Binary (starting with 0b or 0B) |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1054 and Octal (starting with 0). |
| 7 | 1055 |
| 1621 | 1056 *floating-point-format* |
| 1057 Floating point numbers can be written in two forms: | |
| 1058 | |
| 1059 [-+]{N}.{M} | |
| 6530 | 1060 [-+]{N}.{M}[eE][-+]{exp} |
| 1621 | 1061 |
| 1062 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
| 1063 contain digits. | |
| 1064 [-+] means there is an optional plus or minus sign. | |
| 1065 {exp} is the exponent, power of 10. | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1066 Only a decimal point is accepted, not a comma. No matter what the current |
| 1621 | 1067 locale is. |
| 1068 {only when compiled with the |+float| feature} | |
| 1069 | |
| 1070 Examples: | |
| 1071 123.456 | |
| 1072 +0.0001 | |
| 1073 55.0 | |
| 1074 -0.123 | |
| 1075 1.234e03 | |
| 1076 1.0E-6 | |
| 1077 -3.1416e+88 | |
| 1078 | |
| 1079 These are INVALID: | |
| 1080 3. empty {M} | |
| 1081 1e40 missing .{M} | |
| 1082 | |
| 1698 | 1083 *float-pi* *float-e* |
| 1084 A few useful values to copy&paste: > | |
| 1085 :let pi = 3.14159265359 | |
| 1086 :let e = 2.71828182846 | |
| 1087 | |
| 1621 | 1088 Rationale: |
| 1089 Before floating point was introduced, the text "123.456" was interpreted as | |
| 1090 the two numbers "123" and "456", both converted to a string and concatenated, | |
| 1091 resulting in the string "123456". Since this was considered pointless, and we | |
| 1698 | 1092 could not find it intentionally being used in Vim scripts, this backwards |
| 1621 | 1093 incompatibility was accepted in favor of being able to use the normal notation |
| 1094 for floating point numbers. | |
| 1095 | |
| 1096 *floating-point-precision* | |
| 1097 The precision and range of floating points numbers depends on what "double" | |
| 1098 means in the library Vim was compiled with. There is no way to change this at | |
| 1099 runtime. | |
| 1100 | |
| 1101 The default for displaying a |Float| is to use 6 decimal places, like using | |
| 1102 printf("%g", f). You can select something else when using the |printf()| | |
| 1103 function. Example: > | |
| 1104 :echo printf('%.15e', atan(1)) | |
| 1105 < 7.853981633974483e-01 | |
| 1106 | |
| 1107 | |
| 7 | 1108 |
| 6884 | 1109 string *string* *String* *expr-string* *E114* |
| 7 | 1110 ------ |
| 1111 "string" string constant *expr-quote* | |
| 1112 | |
| 1113 Note that double quotes are used. | |
| 1114 | |
| 1115 A string constant accepts these special characters: | |
| 1116 \... three-digit octal number (e.g., "\316") | |
| 1117 \.. two-digit octal number (must be followed by non-digit) | |
| 1118 \. one-digit octal number (must be followed by non-digit) | |
| 1119 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
| 1120 \x. byte specified with one hex number (must be followed by non-hex char) | |
| 1121 \X.. same as \x.. | |
| 1122 \X. same as \x. | |
| 1621 | 1123 \u.... character specified with up to 4 hex numbers, stored according to the |
| 7 | 1124 current value of 'encoding' (e.g., "\u02a4") |
| 6840 | 1125 \U.... same as \u but allows up to 8 hex numbers. |
| 7 | 1126 \b backspace <BS> |
| 1127 \e escape <Esc> | |
| 1128 \f formfeed <FF> | |
| 1129 \n newline <NL> | |
| 1130 \r return <CR> | |
| 1131 \t tab <Tab> | |
| 1132 \\ backslash | |
| 1133 \" double quote | |
| 2152 | 1134 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1135 in mappings, the 0x80 byte is escaped. |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1136 To use the double quote character it must be escaped: "<M-\">". |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1137 Don't use <Char-xxxx> to get a utf-8 character, use \uxxxx as |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1138 mentioned above. |
| 7 | 1139 |
| 1156 | 1140 Note that "\xff" is stored as the byte 255, which may be invalid in some |
| 1141 encodings. Use "\u00ff" to store character 255 according to the current value | |
| 1142 of 'encoding'. | |
| 1143 | |
| 7 | 1144 Note that "\000" and "\x00" force the end of the string. |
| 1145 | |
| 1146 | |
| 1147 literal-string *literal-string* *E115* | |
| 1148 --------------- | |
| 26 | 1149 'string' string constant *expr-'* |
| 7 | 1150 |
| 1151 Note that single quotes are used. | |
| 1152 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1153 This string is taken as it is. No backslashes are removed or have a special |
| 99 | 1154 meaning. The only exception is that two quotes stand for one quote. |
| 26 | 1155 |
| 1156 Single quoted strings are useful for patterns, so that backslashes do not need | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1157 to be doubled. These two commands are equivalent: > |
| 26 | 1158 if a =~ "\\s*" |
| 1159 if a =~ '\s*' | |
| 7 | 1160 |
| 1161 | |
| 1162 option *expr-option* *E112* *E113* | |
| 1163 ------ | |
| 1164 &option option value, local value if possible | |
| 1165 &g:option global option value | |
| 1166 &l:option local option value | |
| 1167 | |
| 1168 Examples: > | |
| 1169 echo "tabstop is " . &tabstop | |
| 1170 if &insertmode | |
| 1171 | |
| 1172 Any option name can be used here. See |options|. When using the local value | |
| 1173 and there is no buffer-local or window-local value, the global value is used | |
| 1174 anyway. | |
| 1175 | |
| 1176 | |
| 1156 | 1177 register *expr-register* *@r* |
| 7 | 1178 -------- |
| 1179 @r contents of register 'r' | |
| 1180 | |
| 1181 The result is the contents of the named register, as a single string. | |
| 1182 Newlines are inserted where required. To get the contents of the unnamed | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1183 register use @" or @@. See |registers| for an explanation of the available |
| 336 | 1184 registers. |
| 1185 | |
| 1186 When using the '=' register you get the expression itself, not what it | |
| 1187 evaluates to. Use |eval()| to evaluate it. | |
| 7 | 1188 |
| 1189 | |
| 1190 nesting *expr-nesting* *E110* | |
| 1191 ------- | |
| 1192 (expr1) nested expression | |
| 1193 | |
| 1194 | |
| 1195 environment variable *expr-env* | |
| 1196 -------------------- | |
| 1197 $VAR environment variable | |
| 1198 | |
| 1199 The String value of any environment variable. When it is not defined, the | |
| 1200 result is an empty string. | |
| 1201 *expr-env-expand* | |
| 1202 Note that there is a difference between using $VAR directly and using | |
| 1203 expand("$VAR"). Using it directly will only expand environment variables that | |
| 1204 are known inside the current Vim session. Using expand() will first try using | |
| 1205 the environment variables known inside the current Vim session. If that | |
| 1206 fails, a shell will be used to expand the variable. This can be slow, but it | |
| 1207 does expand all variables that the shell knows about. Example: > | |
| 6180 | 1208 :echo $shell |
| 1209 :echo expand("$shell") | |
| 1210 The first one probably doesn't echo anything, the second echoes the $shell | |
| 7 | 1211 variable (if your shell supports it). |
| 1212 | |
| 1213 | |
| 1214 internal variable *expr-variable* | |
| 1215 ----------------- | |
| 1216 variable internal variable | |
| 1217 See below |internal-variables|. | |
| 1218 | |
| 1219 | |
| 170 | 1220 function call *expr-function* *E116* *E118* *E119* *E120* |
| 7 | 1221 ------------- |
| 1222 function(expr1, ...) function call | |
| 1223 See below |functions|. | |
| 1224 | |
| 1225 | |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1226 lambda expression *expr-lambda* *lambda* |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1227 ----------------- |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1228 {args -> expr1} lambda expression |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1229 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1230 A lambda expression creates a new unnamed function which returns the result of |
|
9555
9560a5b782ee
commit https://github.com/vim/vim/commit/42ebd066422d73cdb7bda6a1dc828a3dd022dec8
Christian Brabandt <cb@256bit.org>
parents:
9536
diff
changeset
|
1231 evaluating |expr1|. Lambda expressions differ from |user-functions| in |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1232 the following ways: |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1233 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1234 1. The body of the lambda expression is an |expr1| and not a sequence of |Ex| |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1235 commands. |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1236 2. The prefix "a:" should not be used for arguments. E.g.: > |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1237 :let F = {arg1, arg2 -> arg1 - arg2} |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1238 :echo F(5, 2) |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1239 < 3 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1240 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1241 The arguments are optional. Example: > |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1242 :let F = {-> 'error function'} |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1243 :echo F() |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1244 < error function |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1245 *closure* |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1246 Lambda expressions can access outer scope variables and arguments. This is |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1247 often called a closure. Example where "i" a and "a:arg" are used in a lambda |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
1248 while they exist in the function scope. They remain valid even after the |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1249 function returns: > |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1250 :function Foo(arg) |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1251 : let i = 3 |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1252 : return {x -> x + i - a:arg} |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1253 :endfunction |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1254 :let Bar = Foo(4) |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1255 :echo Bar(6) |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1256 < 5 |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
1257 |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
1258 See also |:func-closure|. Lambda and closure support can be checked with: > |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
1259 if has('lambda') |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1260 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1261 Examples for using a lambda expression with |sort()|, |map()| and |filter()|: > |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1262 :echo map([1, 2, 3], {idx, val -> val + 1}) |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1263 < [2, 3, 4] > |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1264 :echo sort([3,7,2,1,4], {a, b -> a - b}) |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1265 < [1, 2, 3, 4, 7] |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1266 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1267 The lambda expression is also useful for Channel, Job and timer: > |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1268 :let timer = timer_start(500, |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1269 \ {-> execute("echo 'Handler called'", "")}, |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1270 \ {'repeat': 3}) |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1271 < Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1272 Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1273 Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1274 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1275 Note how execute() is used to execute an Ex command. That's ugly though. |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1276 |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1277 |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1278 Lambda expressions have internal names like '<lambda>42'. If you get an error |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1279 for a lambda expression, you can find what it is with the following command: > |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1280 :function {'<lambda>42'} |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1281 See also: |numbered-function| |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1282 |
| 7 | 1283 ============================================================================== |
| 2596 | 1284 3. Internal variable *internal-variables* *E461* |
| 1285 | |
| 7 | 1286 An internal variable name can be made up of letters, digits and '_'. But it |
| 1287 cannot start with a digit. It's also possible to use curly braces, see | |
| 1288 |curly-braces-names|. | |
| 1289 | |
| 1290 An internal variable is created with the ":let" command |:let|. | |
| 87 | 1291 An internal variable is explicitly destroyed with the ":unlet" command |
| 1292 |:unlet|. | |
| 1293 Using a name that is not an internal variable or refers to a variable that has | |
| 1294 been destroyed results in an error. | |
| 7 | 1295 |
| 1296 There are several name spaces for variables. Which one is to be used is | |
| 1297 specified by what is prepended: | |
| 1298 | |
| 1299 (nothing) In a function: local to a function; otherwise: global | |
| 1300 |buffer-variable| b: Local to the current buffer. | |
| 1301 |window-variable| w: Local to the current window. | |
| 819 | 1302 |tabpage-variable| t: Local to the current tab page. |
| 7 | 1303 |global-variable| g: Global. |
| 1304 |local-variable| l: Local to a function. | |
| 1305 |script-variable| s: Local to a |:source|'ed Vim script. | |
| 1306 |function-argument| a: Function argument (only inside a function). | |
| 5815 | 1307 |vim-variable| v: Global, predefined by Vim. |
| 7 | 1308 |
| 685 | 1309 The scope name by itself can be used as a |Dictionary|. For example, to |
| 1310 delete all script-local variables: > | |
| 133 | 1311 :for k in keys(s:) |
| 1312 : unlet s:[k] | |
| 1313 :endfor | |
| 1314 < | |
| 4358 | 1315 *buffer-variable* *b:var* *b:* |
| 7 | 1316 A variable name that is preceded with "b:" is local to the current buffer. |
| 1317 Thus you can have several "b:foo" variables, one for each buffer. | |
| 1318 This kind of variable is deleted when the buffer is wiped out or deleted with | |
| 1319 |:bdelete|. | |
| 1320 | |
| 1321 One local buffer variable is predefined: | |
| 4264 | 1322 *b:changedtick* *changetick* |
| 7 | 1323 b:changedtick The total number of changes to the current buffer. It is |
| 1324 incremented for each change. An undo command is also a change | |
| 1325 in this case. This can be used to perform an action only when | |
| 1326 the buffer has changed. Example: > | |
| 1327 :if my_changedtick != b:changedtick | |
| 1621 | 1328 : let my_changedtick = b:changedtick |
| 1329 : call My_Update() | |
| 7 | 1330 :endif |
| 1331 < | |
| 4358 | 1332 *window-variable* *w:var* *w:* |
| 7 | 1333 A variable name that is preceded with "w:" is local to the current window. It |
| 1334 is deleted when the window is closed. | |
| 1335 | |
| 4437 | 1336 *tabpage-variable* *t:var* *t:* |
| 819 | 1337 A variable name that is preceded with "t:" is local to the current tab page, |
| 1338 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
|
1339 without the |+windows| feature} |
| 819 | 1340 |
| 4358 | 1341 *global-variable* *g:var* *g:* |
| 7 | 1342 Inside functions global variables are accessed with "g:". Omitting this will |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1343 access a variable local to a function. But "g:" can also be used in any other |
| 7 | 1344 place if you like. |
| 1345 | |
| 4358 | 1346 *local-variable* *l:var* *l:* |
| 7 | 1347 Inside functions local variables are accessed without prepending anything. |
| 1156 | 1348 But you can also prepend "l:" if you like. However, without prepending "l:" |
| 1349 you may run into reserved variable names. For example "count". By itself it | |
| 1350 refers to "v:count". Using "l:count" you can have a local variable with the | |
| 1351 same name. | |
| 7 | 1352 |
| 1353 *script-variable* *s:var* | |
| 1354 In a Vim script variables starting with "s:" can be used. They cannot be | |
| 1355 accessed from outside of the scripts, thus are local to the script. | |
| 1356 | |
| 1357 They can be used in: | |
| 1358 - commands executed while the script is sourced | |
| 1359 - functions defined in the script | |
| 1360 - autocommands defined in the script | |
| 1361 - functions and autocommands defined in functions and autocommands which were | |
| 1362 defined in the script (recursively) | |
| 1363 - user defined commands defined in the script | |
| 1364 Thus not in: | |
| 1365 - other scripts sourced from this one | |
| 1366 - mappings | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1367 - menus |
| 7 | 1368 - etc. |
| 1369 | |
| 1156 | 1370 Script variables can be used to avoid conflicts with global variable names. |
| 1371 Take this example: > | |
| 7 | 1372 |
| 1373 let s:counter = 0 | |
| 1374 function MyCounter() | |
| 1375 let s:counter = s:counter + 1 | |
| 1376 echo s:counter | |
| 1377 endfunction | |
| 1378 command Tick call MyCounter() | |
| 1379 | |
| 1380 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
| 1381 that script will not be changed, only the "s:counter" in the script where | |
| 1382 "Tick" was defined is used. | |
| 1383 | |
| 1384 Another example that does the same: > | |
| 1385 | |
| 1386 let s:counter = 0 | |
| 1387 command Tick let s:counter = s:counter + 1 | echo s:counter | |
| 1388 | |
| 1389 When calling a function and invoking a user-defined command, the context for | |
| 9 | 1390 script variables is set to the script where the function or command was |
| 7 | 1391 defined. |
| 1392 | |
| 1393 The script variables are also available when a function is defined inside a | |
| 1394 function that is defined in a script. Example: > | |
| 1395 | |
| 1396 let s:counter = 0 | |
| 1397 function StartCounting(incr) | |
| 1398 if a:incr | |
| 1399 function MyCounter() | |
| 1400 let s:counter = s:counter + 1 | |
| 1401 endfunction | |
| 1402 else | |
| 1403 function MyCounter() | |
| 1404 let s:counter = s:counter - 1 | |
| 1405 endfunction | |
| 1406 endif | |
| 1407 endfunction | |
| 1408 | |
| 1409 This defines the MyCounter() function either for counting up or counting down | |
| 1410 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
| 1411 called, the s:counter variable will be accessible in MyCounter(). | |
| 1412 | |
| 1413 When the same script is sourced again it will use the same script variables. | |
| 1414 They will remain valid as long as Vim is running. This can be used to | |
| 1415 maintain a counter: > | |
| 1416 | |
| 1417 if !exists("s:counter") | |
| 1418 let s:counter = 1 | |
| 1419 echo "script executed for the first time" | |
| 1420 else | |
| 1421 let s:counter = s:counter + 1 | |
| 1422 echo "script executed " . s:counter . " times now" | |
| 1423 endif | |
| 1424 | |
| 1425 Note that this means that filetype plugins don't get a different set of script | |
| 1426 variables for each buffer. Use local buffer variables instead |b:var|. | |
| 1427 | |
| 1428 | |
| 4358 | 1429 Predefined Vim variables: *vim-variable* *v:var* *v:* |
| 7 | 1430 |
| 189 | 1431 *v:beval_col* *beval_col-variable* |
| 1432 v:beval_col The number of the column, over which the mouse pointer is. | |
| 1433 This is the byte index in the |v:beval_lnum| line. | |
| 1434 Only valid while evaluating the 'balloonexpr' option. | |
| 1435 | |
| 1436 *v:beval_bufnr* *beval_bufnr-variable* | |
| 1437 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
| 1438 valid while evaluating the 'balloonexpr' option. | |
| 1439 | |
| 1440 *v:beval_lnum* *beval_lnum-variable* | |
| 1441 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
| 1442 valid while evaluating the 'balloonexpr' option. | |
| 1443 | |
| 1444 *v:beval_text* *beval_text-variable* | |
| 374 | 1445 v:beval_text The text under or after the mouse pointer. Usually a word as |
| 1446 it is useful for debugging a C program. 'iskeyword' applies, | |
| 1447 but a dot and "->" before the position is included. When on a | |
| 1448 ']' the text before it is used, including the matching '[' and | |
| 189 | 1449 word before it. When on a Visual area within one line the |
| 1450 highlighted text is used. | |
| 1451 Only valid while evaluating the 'balloonexpr' option. | |
| 1452 | |
| 1453 *v:beval_winnr* *beval_winnr-variable* | |
| 1454 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
| 2709 | 1455 valid while evaluating the 'balloonexpr' option. The first |
| 1456 window has number zero (unlike most other places where a | |
| 1457 window gets a number). | |
| 189 | 1458 |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1459 *v:beval_winid* *beval_winid-variable* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1460 v:beval_winid The |window-ID| of the window, over which the mouse pointer |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1461 is. Otherwise like v:beval_winnr. |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1462 |
| 844 | 1463 *v:char* *char-variable* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1464 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
|
1465 character when using <expr> in an abbreviation |:map-<expr>|. |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4437
diff
changeset
|
1466 It is also used by the |InsertCharPre| and |InsertEnter| events. |
| 844 | 1467 |
| 7 | 1468 *v:charconvert_from* *charconvert_from-variable* |
| 1469 v:charconvert_from | |
| 1470 The name of the character encoding of a file to be converted. | |
| 1471 Only valid while evaluating the 'charconvert' option. | |
| 1472 | |
| 1473 *v:charconvert_to* *charconvert_to-variable* | |
| 1474 v:charconvert_to | |
| 1475 The name of the character encoding of a file after conversion. | |
| 1476 Only valid while evaluating the 'charconvert' option. | |
| 1477 | |
| 1478 *v:cmdarg* *cmdarg-variable* | |
| 1479 v:cmdarg This variable is used for two purposes: | |
| 1480 1. The extra arguments given to a file read/write command. | |
| 1481 Currently these are "++enc=" and "++ff=". This variable is | |
| 1482 set before an autocommand event for a file read/write | |
| 1483 command is triggered. There is a leading space to make it | |
| 1484 possible to append this variable directly after the | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1485 read/write command. Note: The "+cmd" argument isn't |
| 7 | 1486 included here, because it will be executed anyway. |
| 1487 2. When printing a PostScript file with ":hardcopy" this is | |
| 1488 the argument for the ":hardcopy" command. This can be used | |
| 1489 in 'printexpr'. | |
| 1490 | |
| 1491 *v:cmdbang* *cmdbang-variable* | |
| 1492 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
| 1493 was used the value is 1, otherwise it is 0. Note that this | |
| 1494 can only be used in autocommands. For user commands |<bang>| | |
| 1495 can be used. | |
| 1496 | |
| 6909 | 1497 *v:completed_item* *completed_item-variable* |
| 1498 v:completed_item | |
| 1499 |Dictionary| containing the |complete-items| for the most | |
| 1500 recently completed word after |CompleteDone|. The | |
| 1501 |Dictionary| is empty if the completion failed. | |
| 1502 | |
| 7 | 1503 *v:count* *count-variable* |
| 1504 v:count The count given for the last Normal mode command. Can be used | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1505 to get the count before a mapping. Read-only. Example: > |
| 7 | 1506 :map _x :<C-U>echo "the count is " . v:count<CR> |
| 1507 < Note: The <C-U> is required to remove the line range that you | |
| 1508 get when typing ':' after a count. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1509 When there are two counts, as in "3d2w", they are multiplied, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1510 just like what happens in the command, "d6w" for the example. |
| 667 | 1511 Also used for evaluating the 'formatexpr' option. |
| 7 | 1512 "count" also works, for backwards compatibility. |
| 1513 | |
| 1514 *v:count1* *count1-variable* | |
| 1515 v:count1 Just like "v:count", but defaults to one when no count is | |
| 1516 used. | |
| 1517 | |
| 1518 *v:ctype* *ctype-variable* | |
| 1519 v:ctype The current locale setting for characters of the runtime | |
| 1520 environment. This allows Vim scripts to be aware of the | |
| 1521 current locale encoding. Technical: it's the value of | |
| 1522 LC_CTYPE. When not using a locale the value is "C". | |
| 1523 This variable can not be set directly, use the |:language| | |
| 1524 command. | |
| 1525 See |multi-lang|. | |
| 1526 | |
| 1527 *v:dying* *dying-variable* | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1528 v:dying Normally zero. When a deadly signal is caught it's set to |
| 7 | 1529 one. When multiple signals are caught the number increases. |
| 1530 Can be used in an autocommand to check if Vim didn't | |
| 1531 terminate normally. {only works on Unix} | |
| 1532 Example: > | |
| 1533 :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
|
1534 < 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
|
1535 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
|
1536 |
| 7 | 1537 *v:errmsg* *errmsg-variable* |
| 1538 v:errmsg Last given error message. It's allowed to set this variable. | |
| 1539 Example: > | |
| 1540 :let v:errmsg = "" | |
| 1541 :silent! next | |
| 1542 :if v:errmsg != "" | |
| 1543 : ... handle error | |
| 1544 < "errmsg" also works, for backwards compatibility. | |
| 1545 | |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1546 *v:errors* *errors-variable* |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
1547 v:errors Errors found by assert functions, such as |assert_true()|. |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1548 This is a list of strings. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1549 The assert functions append an item when an assert fails. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1550 To remove old results make it empty: > |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1551 :let v:errors = [] |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1552 < If v:errors is set to anything but a list it is made an empty |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1553 list by the assert function. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1554 |
| 7 | 1555 *v:exception* *exception-variable* |
| 1556 v:exception The value of the exception most recently caught and not | |
| 1557 finished. See also |v:throwpoint| and |throw-variables|. | |
| 1558 Example: > | |
| 1559 :try | |
| 1560 : throw "oops" | |
| 1561 :catch /.*/ | |
| 1562 : echo "caught" v:exception | |
| 1563 :endtry | |
| 1564 < Output: "caught oops". | |
| 1565 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1566 *v:false* *false-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1567 v:false A Number with value zero. Used to put "false" in JSON. See |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
1568 |json_encode()|. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1569 When used as a string this evaluates to "v:false". > |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1570 echo v:false |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1571 < v:false ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1572 That is so that eval() can parse the string back to the same |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
1573 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1574 |
| 179 | 1575 *v:fcs_reason* *fcs_reason-variable* |
| 1576 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
| 1577 Can be used in an autocommand to decide what to do and/or what | |
| 1578 to set v:fcs_choice to. Possible values: | |
| 1579 deleted file no longer exists | |
| 1580 conflict file contents, mode or timestamp was | |
| 1581 changed and buffer is modified | |
| 1582 changed file contents has changed | |
| 1583 mode mode of file changed | |
| 1584 time only file timestamp changed | |
| 1585 | |
| 1586 *v:fcs_choice* *fcs_choice-variable* | |
| 1587 v:fcs_choice What should happen after a |FileChangedShell| event was | |
| 1588 triggered. Can be used in an autocommand to tell Vim what to | |
| 1589 do with the affected buffer: | |
| 1590 reload Reload the buffer (does not work if | |
| 1591 the file was deleted). | |
| 1592 ask Ask the user what to do, as if there | |
| 1593 was no autocommand. Except that when | |
| 1594 only the timestamp changed nothing | |
| 1595 will happen. | |
| 1596 <empty> Nothing, the autocommand should do | |
| 1597 everything that needs to be done. | |
| 1598 The default is empty. If another (invalid) value is used then | |
| 1599 Vim behaves like it is empty, there is no warning message. | |
| 1600 | |
| 7 | 1601 *v:fname_in* *fname_in-variable* |
| 579 | 1602 v:fname_in The name of the input file. Valid while evaluating: |
| 7 | 1603 option used for ~ |
| 1604 'charconvert' file to be converted | |
| 1605 'diffexpr' original file | |
| 1606 'patchexpr' original file | |
| 1607 'printexpr' file to be printed | |
| 593 | 1608 And set to the swap file name for |SwapExists|. |
| 7 | 1609 |
| 1610 *v:fname_out* *fname_out-variable* | |
| 1611 v:fname_out The name of the output file. Only valid while | |
| 1612 evaluating: | |
| 1613 option used for ~ | |
| 1614 'charconvert' resulting converted file (*) | |
| 1615 'diffexpr' output of diff | |
| 1616 'patchexpr' resulting patched file | |
| 1617 (*) When doing conversion for a write command (e.g., ":w | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1618 file") it will be equal to v:fname_in. When doing conversion |
| 7 | 1619 for a read command (e.g., ":e file") it will be a temporary |
| 1620 file and different from v:fname_in. | |
| 1621 | |
| 1622 *v:fname_new* *fname_new-variable* | |
| 1623 v:fname_new The name of the new version of the file. Only valid while | |
| 1624 evaluating 'diffexpr'. | |
| 1625 | |
| 1626 *v:fname_diff* *fname_diff-variable* | |
| 1627 v:fname_diff The name of the diff (patch) file. Only valid while | |
| 1628 evaluating 'patchexpr'. | |
| 1629 | |
| 1630 *v:folddashes* *folddashes-variable* | |
| 1631 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
| 1632 fold. | |
| 29 | 1633 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1634 |
| 1635 *v:foldlevel* *foldlevel-variable* | |
| 1636 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
| 29 | 1637 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1638 |
| 1639 *v:foldend* *foldend-variable* | |
| 1640 v:foldend Used for 'foldtext': last line of closed fold. | |
| 29 | 1641 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1642 |
| 1643 *v:foldstart* *foldstart-variable* | |
| 1644 v:foldstart Used for 'foldtext': first line of closed fold. | |
| 29 | 1645 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1646 |
| 5460 | 1647 *v:hlsearch* *hlsearch-variable* |
| 6413 | 1648 v:hlsearch Variable that indicates whether search highlighting is on. |
| 1649 Setting it makes sense only if 'hlsearch' is enabled which | |
| 1650 requires |+extra_search|. Setting this variable to zero acts | |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1651 like the |:nohlsearch| command, setting it to one acts like > |
| 5460 | 1652 let &hlsearch = &hlsearch |
| 6918 | 1653 < Note that the value is restored when returning from a |
| 1654 function. |function-search-undo|. | |
| 1655 | |
| 11 | 1656 *v:insertmode* *insertmode-variable* |
| 1657 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
| 1658 events. Values: | |
| 1659 i Insert mode | |
| 1660 r Replace mode | |
| 1661 v Virtual Replace mode | |
| 1662 | |
| 102 | 1663 *v:key* *key-variable* |
| 685 | 1664 v:key Key of the current item of a |Dictionary|. Only valid while |
| 102 | 1665 evaluating the expression used with |map()| and |filter()|. |
| 1666 Read-only. | |
| 1667 | |
| 7 | 1668 *v:lang* *lang-variable* |
| 1669 v:lang The current locale setting for messages of the runtime | |
| 1670 environment. This allows Vim scripts to be aware of the | |
| 1671 current language. Technical: it's the value of LC_MESSAGES. | |
| 1672 The value is system dependent. | |
| 1673 This variable can not be set directly, use the |:language| | |
| 1674 command. | |
| 1675 It can be different from |v:ctype| when messages are desired | |
| 1676 in a different language than what is used for character | |
| 1677 encoding. See |multi-lang|. | |
| 1678 | |
| 1679 *v:lc_time* *lc_time-variable* | |
| 1680 v:lc_time The current locale setting for time messages of the runtime | |
| 1681 environment. This allows Vim scripts to be aware of the | |
| 1682 current language. Technical: it's the value of LC_TIME. | |
| 1683 This variable can not be set directly, use the |:language| | |
| 1684 command. See |multi-lang|. | |
| 1685 | |
| 1686 *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
|
1687 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
|
1688 '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
|
1689 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
|
1690 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
|
1691 |sandbox|. |
| 7 | 1692 |
| 1029 | 1693 *v:mouse_win* *mouse_win-variable* |
| 1694 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
| 1695 First window has number 1, like with |winnr()|. The value is | |
| 1696 zero when there was no mouse button click. | |
| 1697 | |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1698 *v:mouse_winid* *mouse_winid-variable* |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1699 v:mouse_winid Window ID for a mouse click obtained with |getchar()|. |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1700 The value is zero when there was no mouse button click. |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1701 |
| 1029 | 1702 *v:mouse_lnum* *mouse_lnum-variable* |
| 1703 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
| 1704 This is the text line number, not the screen line number. The | |
| 1705 value is zero when there was no mouse button click. | |
| 1706 | |
| 1707 *v:mouse_col* *mouse_col-variable* | |
| 1708 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
| 1709 This is the screen column number, like with |virtcol()|. The | |
| 1710 value is zero when there was no mouse button click. | |
| 1711 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1712 *v:none* *none-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1713 v:none An empty String. Used to put an empty item in JSON. See |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
1714 |json_encode()|. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1715 When used as a number this evaluates to zero. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1716 When used as a string this evaluates to "v:none". > |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1717 echo v:none |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1718 < v:none ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1719 That is so that eval() can parse the string back to the same |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
1720 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1721 |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1722 *v:null* *null-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1723 v:null An empty String. Used to put "null" in JSON. See |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
1724 |json_encode()|. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1725 When used as a number this evaluates to zero. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1726 When used as a string this evaluates to "v:null". > |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1727 echo v:null |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1728 < v:null ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1729 That is so that eval() can parse the string back to the same |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
1730 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1731 |
| 1733 | 1732 *v:oldfiles* *oldfiles-variable* |
| 1733 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
| 1734 startup. These are the files that Vim remembers marks for. | |
| 1735 The length of the List is limited by the ' argument of the | |
| 1736 'viminfo' option (default is 100). | |
| 5618 | 1737 When the |viminfo| file is not used the List is empty. |
| 1733 | 1738 Also see |:oldfiles| and |c_#<|. |
| 1739 The List can be modified, but this has no effect on what is | |
| 1740 stored in the |viminfo| file later. If you use values other | |
| 1741 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
|
1742 {only when compiled with the |+viminfo| feature} |
| 1733 | 1743 |
| 6935 | 1744 *v:option_new* |
| 1745 v:option_new New value of the option. Valid while executing an |OptionSet| | |
| 1746 autocommand. | |
| 1747 *v:option_old* | |
| 1748 v:option_old Old value of the option. Valid while executing an |OptionSet| | |
| 1749 autocommand. | |
| 1750 *v:option_type* | |
| 1751 v:option_type Scope of the set command. Valid while executing an | |
| 1752 |OptionSet| autocommand. Can be either "global" or "local" | |
| 1490 | 1753 *v:operator* *operator-variable* |
| 1754 v:operator The last operator given in Normal mode. This is a single | |
| 1755 character except for commands starting with <g> or <z>, | |
| 1756 in which case it is two characters. Best used alongside | |
| 1757 |v:prevcount| and |v:register|. Useful if you want to cancel | |
| 1758 Operator-pending mode and then use the operator, e.g.: > | |
| 1759 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
| 1760 < The value remains set until another operator is entered, thus | |
| 1761 don't expect it to be empty. | |
| 1762 v:operator is not set for |:delete|, |:yank| or other Ex | |
| 1763 commands. | |
| 1764 Read-only. | |
| 1765 | |
| 7 | 1766 *v:prevcount* *prevcount-variable* |
| 1767 v:prevcount The count given for the last but one Normal mode command. | |
| 1768 This is the v:count value of the previous command. Useful if | |
| 1490 | 1769 you want to cancel Visual or Operator-pending mode and then |
| 1770 use the count, e.g.: > | |
| 7 | 1771 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
| 1772 < Read-only. | |
| 1773 | |
| 170 | 1774 *v:profiling* *profiling-variable* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1775 v:profiling Normally zero. Set to one after using ":profile start". |
| 170 | 1776 See |profiling|. |
| 1777 | |
| 7 | 1778 *v:progname* *progname-variable* |
| 1779 v:progname Contains the name (with path removed) with which Vim was | |
| 3492 | 1780 invoked. Allows you to do special initialisations for |view|, |
| 1781 |evim| etc., or any other name you might symlink to Vim. | |
| 7 | 1782 Read-only. |
| 1783 | |
| 5780 | 1784 *v:progpath* *progpath-variable* |
| 1785 v:progpath Contains the command with which Vim was invoked, including the | |
| 1786 path. Useful if you want to message a Vim server using a | |
| 1787 |--remote-expr|. | |
| 5782 | 1788 To get the full path use: > |
| 1789 echo exepath(v:progpath) | |
| 1790 < NOTE: This does not work when the command is a relative path | |
| 1791 and the current directory has changed. | |
| 5780 | 1792 Read-only. |
| 1793 | |
| 7 | 1794 *v:register* *register-variable* |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1795 v:register The name of the register in effect for the current normal mode |
| 3492 | 1796 command (regardless of whether that command actually used a |
| 1797 register). Or for the currently executing normal mode mapping | |
| 1798 (use this in custom commands that take a register). | |
| 1799 If none is supplied it is the default register '"', unless | |
| 1800 'clipboard' contains "unnamed" or "unnamedplus", then it is | |
| 1801 '*' or '+'. | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1802 Also see |getreg()| and |setreg()| |
| 7 | 1803 |
| 540 | 1804 *v:scrollstart* *scrollstart-variable* |
| 1805 v:scrollstart String describing the script or function that caused the | |
| 1806 screen to scroll up. It's only set when it is empty, thus the | |
| 1807 first reason is remembered. It is set to "Unknown" for a | |
| 1808 typed command. | |
| 1809 This can be used to find out why your script causes the | |
| 1810 hit-enter prompt. | |
| 1811 | |
| 7 | 1812 *v:servername* *servername-variable* |
| 1813 v:servername The resulting registered |x11-clientserver| name if any. | |
| 1814 Read-only. | |
| 1815 | |
| 1621 | 1816 |
| 1817 v:searchforward *v:searchforward* *searchforward-variable* | |
| 1818 Search direction: 1 after a forward search, 0 after a | |
| 1819 backward search. It is reset to forward when directly setting | |
| 1820 the last search pattern, see |quote/|. | |
| 1821 Note that the value is restored when returning from a | |
| 1822 function. |function-search-undo|. | |
| 1823 Read-write. | |
| 1824 | |
| 7 | 1825 *v:shell_error* *shell_error-variable* |
| 1826 v:shell_error Result of the last shell command. When non-zero, the last | |
| 1827 shell command had an error. When zero, there was no problem. | |
| 1828 This only works when the shell returns the error code to Vim. | |
| 1829 The value -1 is often used when the command could not be | |
| 1830 executed. Read-only. | |
| 1831 Example: > | |
| 1832 :!mv foo bar | |
| 1833 :if v:shell_error | |
| 1834 : echo 'could not rename "foo" to "bar"!' | |
| 1835 :endif | |
| 1836 < "shell_error" also works, for backwards compatibility. | |
| 1837 | |
| 1838 *v:statusmsg* *statusmsg-variable* | |
| 1839 v:statusmsg Last given status message. It's allowed to set this variable. | |
| 1840 | |
| 579 | 1841 *v:swapname* *swapname-variable* |
| 1842 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
| 1843 the swap file found. Read-only. | |
| 1844 | |
| 1845 *v:swapchoice* *swapchoice-variable* | |
| 1846 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
| 1847 for handling an existing swap file: | |
| 1848 'o' Open read-only | |
| 1849 'e' Edit anyway | |
| 1850 'r' Recover | |
| 1851 'd' Delete swapfile | |
| 1852 'q' Quit | |
| 1853 'a' Abort | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1854 The value should be a single-character string. An empty value |
| 579 | 1855 results in the user being asked, as would happen when there is |
| 1856 no SwapExists autocommand. The default is empty. | |
| 1857 | |
| 590 | 1858 *v:swapcommand* *swapcommand-variable* |
| 625 | 1859 v:swapcommand Normal mode command to be executed after a file has been |
| 590 | 1860 opened. Can be used for a |SwapExists| autocommand to have |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1861 another Vim open the file and jump to the right place. For |
| 590 | 1862 example, when jumping to a tag the value is ":tag tagname\r". |
| 716 | 1863 For ":edit +cmd file" the value is ":cmd\r". |
| 590 | 1864 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
1865 *v:t_TYPE* *v:t_bool* *t_bool-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1866 v:t_bool Value of Boolean type. Read-only. See: |type()| |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
1867 *v:t_channel* *t_channel-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1868 v:t_channel Value of Channel type. Read-only. See: |type()| |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
1869 *v:t_dict* *t_dict-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1870 v:t_dict Value of Dictionary type. Read-only. See: |type()| |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
1871 *v:t_float* *t_float-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1872 v:t_float Value of Float type. Read-only. See: |type()| |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
1873 *v:t_func* *t_func-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1874 v:t_func Value of Funcref type. Read-only. See: |type()| |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
1875 *v:t_job* *t_job-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1876 v:t_job Value of Job type. Read-only. See: |type()| |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
1877 *v:t_list* *t_list-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1878 v:t_list Value of List type. Read-only. See: |type()| |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
1879 *v:t_none* *t_none-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1880 v:t_none Value of None type. Read-only. See: |type()| |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
1881 *v:t_number* *t_number-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1882 v:t_number Value of Number type. Read-only. See: |type()| |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
1883 *v:t_string* *t_string-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1884 v:t_string Value of String type. Read-only. See: |type()| |
|
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1885 |
| 7 | 1886 *v:termresponse* *termresponse-variable* |
| 1887 v:termresponse The escape sequence returned by the terminal for the |t_RV| | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1888 termcap entry. It is set when Vim receives an escape sequence |
| 7 | 1889 that starts with ESC [ or CSI and ends in a 'c', with only |
| 1890 digits, ';' and '.' in between. | |
| 1891 When this option is set, the TermResponse autocommand event is | |
| 1892 fired, so that you can react to the response from the | |
| 1893 terminal. | |
| 1894 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp | |
| 1895 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the | |
| 1896 patch level (since this was introduced in patch 95, it's | |
| 1897 always 95 or bigger). Pc is always zero. | |
| 1898 {only when compiled with |+termresponse| feature} | |
| 1899 | |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
1900 *v:testing* *testing-variable* |
|
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
1901 v:testing Must be set before using `test_garbagecollect_now()`. |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
1902 |
| 7 | 1903 *v:this_session* *this_session-variable* |
| 1904 v:this_session Full filename of the last loaded or saved session file. See | |
| 1905 |:mksession|. It is allowed to set this variable. When no | |
| 1906 session file has been saved, this variable is empty. | |
| 1907 "this_session" also works, for backwards compatibility. | |
| 1908 | |
| 1909 *v:throwpoint* *throwpoint-variable* | |
| 1910 v:throwpoint The point where the exception most recently caught and not | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1911 finished was thrown. Not set when commands are typed. See |
| 7 | 1912 also |v:exception| and |throw-variables|. |
| 1913 Example: > | |
| 1914 :try | |
| 1915 : throw "oops" | |
| 1916 :catch /.*/ | |
| 1917 : echo "Exception from" v:throwpoint | |
| 1918 :endtry | |
| 1919 < Output: "Exception from test.vim, line 2" | |
| 1920 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1921 *v:true* *true-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1922 v:true A Number with value one. Used to put "true" in JSON. See |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
1923 |json_encode()|. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1924 When used as a string this evaluates to "v:true". > |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1925 echo v:true |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1926 < v:true ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1927 That is so that eval() can parse the string back to the same |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
1928 value. Read-only. |
| 102 | 1929 *v:val* *val-variable* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1930 v:val Value of the current item of a |List| or |Dictionary|. Only |
| 685 | 1931 valid while evaluating the expression used with |map()| and |
| 102 | 1932 |filter()|. Read-only. |
| 1933 | |
| 7 | 1934 *v:version* *version-variable* |
| 1935 v:version Version number of Vim: Major version number times 100 plus | |
| 1936 minor version number. Version 5.0 is 500. Version 5.1 (5.01) | |
| 1937 is 501. Read-only. "version" also works, for backwards | |
| 1938 compatibility. | |
| 1939 Use |has()| to check if a certain patch was included, e.g.: > | |
| 5786 | 1940 if has("patch-7.4.123") |
| 7 | 1941 < Note that patch numbers are specific to the version, thus both |
| 1942 version 5.0 and 5.1 may have a patch 123, but these are | |
| 1943 completely different. | |
| 1944 | |
|
8738
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
1945 *v:vim_did_enter* *vim_did_enter-variable* |
|
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
1946 v:vim_did_enter Zero until most of startup is done. It is set to one just |
|
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
1947 before |VimEnter| autocommands are triggered. |
|
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
1948 |
| 7 | 1949 *v:warningmsg* *warningmsg-variable* |
| 1950 v:warningmsg Last given warning message. It's allowed to set this variable. | |
| 1951 | |
| 2609 | 1952 *v:windowid* *windowid-variable* |
| 1953 v:windowid When any X11 based GUI is running or when running in a | |
| 1954 terminal and Vim connects to the X server (|-X|) this will be | |
| 2616 | 1955 set to the window ID. |
| 1956 When an MS-Windows GUI is running this will be set to the | |
| 1957 window handle. | |
| 1958 Otherwise the value is zero. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1959 Note: for windows inside Vim use |winnr()| or |win_getid()|, |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1960 see |window-ID|. |
| 2609 | 1961 |
| 7 | 1962 ============================================================================== |
| 1963 4. Builtin Functions *functions* | |
| 1964 | |
| 1965 See |function-list| for a list grouped by what the function is used for. | |
| 1966 | |
| 236 | 1967 (Use CTRL-] on the function name to jump to the full explanation.) |
| 7 | 1968 |
| 1969 USAGE RESULT DESCRIPTION ~ | |
| 1970 | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1971 abs({expr}) Float or Number absolute value of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1972 acos({expr}) Float arc cosine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1973 add({list}, {item}) List append {item} to |List| {list} |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
1974 and({expr}, {expr}) Number bitwise AND |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1975 append({lnum}, {string}) Number append {string} below line {lnum} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1976 append({lnum}, {list}) Number append lines {list} below line {lnum} |
| 7 | 1977 argc() Number number of files in the argument list |
| 55 | 1978 argidx() Number current index in the argument list |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1979 arglistid([{winnr} [, {tabnr}]]) Number argument list id |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1980 argv({nr}) String {nr} entry of the argument list |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
1981 argv() List the argument list |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1982 assert_equal({exp}, {act} [, {msg}]) none assert {exp} is equal to {act} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1983 assert_exception({error} [, {msg}]) none assert {error} is in v:exception |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1984 assert_fails({cmd} [, {error}]) none assert {cmd} fails |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1985 assert_false({actual} [, {msg}]) none assert {actual} is false |
|
9636
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
1986 assert_inrange({lower}, {upper}, {actual} [, {msg}]) |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
1987 none assert {actual} is inside the range |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1988 assert_match({pat}, {text} [, {msg}]) none assert {pat} matches {text} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1989 assert_notequal({exp}, {act} [, {msg}]) none assert {exp} is not equal {act} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1990 assert_notmatch({pat}, {text} [, {msg}]) none assert {pat} not matches {text} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1991 assert_true({actual} [, {msg}]) none assert {actual} is true |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1992 asin({expr}) Float arc sine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1993 atan({expr}) Float arc tangent of {expr} |
|
10038
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
1994 atan2({expr1}, {expr2}) Float arc tangent of {expr1} / {expr2} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1995 browse({save}, {title}, {initdir}, {default}) |
| 7 | 1996 String put up a file requester |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
1997 browsedir({title}, {initdir}) String put up a directory requester |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
1998 bufexists({expr}) Number |TRUE| if buffer {expr} exists |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
1999 buflisted({expr}) Number |TRUE| if buffer {expr} is listed |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2000 bufloaded({expr}) Number |TRUE| if buffer {expr} is loaded |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2001 bufname({expr}) String Name of the buffer {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2002 bufnr({expr} [, {create}]) Number Number of the buffer {expr} |
|
9219
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
2003 bufwinid({expr}) Number window ID of buffer {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2004 bufwinnr({expr}) Number window number of buffer {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2005 byte2line({byte}) Number line number at byte count {byte} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2006 byteidx({expr}, {nr}) Number byte index of {nr}'th char in {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2007 byteidxcomp({expr}, {nr}) Number byte index of {nr}'th char in {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2008 call({func}, {arglist} [, {dict}]) |
| 102 | 2009 any call {func} with arguments {arglist} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2010 ceil({expr}) Float round {expr} up |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2011 ch_close({handle}) none close {handle} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2012 ch_evalexpr({handle}, {expr} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2013 any evaluate {expr} on JSON {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2014 ch_evalraw({handle}, {string} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2015 any evaluate {string} on raw {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2016 ch_getbufnr({handle}, {what}) Number get buffer number for {handle}/{what} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2017 ch_getjob({channel}) Job get the Job of {channel} |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2018 ch_info({handle}) String info about channel {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2019 ch_log({msg} [, {handle}]) none write {msg} in the channel log file |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2020 ch_logfile({fname} [, {mode}]) none start logging channel activity |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2021 ch_open({address} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2022 Channel open a channel to {address} |
|
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2023 ch_read({handle} [, {options}]) String read from {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2024 ch_readraw({handle} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2025 String read raw from {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2026 ch_sendexpr({handle}, {expr} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2027 any send {expr} over JSON {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2028 ch_sendraw({handle}, {string} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2029 any send {string} over raw {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2030 ch_setoptions({handle}, {options}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2031 none set options for {handle} |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2032 ch_status({handle}) String status of channel {handle} |
| 1621 | 2033 changenr() Number current change number |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2034 char2nr({expr}[, {utf8}]) Number ASCII/UTF8 value of first char in {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2035 cindent({lnum}) Number C indent for line {lnum} |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2036 clearmatches() none clear all matches |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2037 col({expr}) Number column nr of cursor or mark |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2038 complete({startcol}, {matches}) none set Insert mode completion |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2039 complete_add({expr}) Number add completion match |
| 1621 | 2040 complete_check() Number check for key typed during completion |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2041 confirm({msg} [, {choices} [, {default} [, {type}]]]) |
| 7 | 2042 Number number of choice picked by user |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2043 copy({expr}) any make a shallow copy of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2044 cos({expr}) Float cosine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2045 cosh({expr}) Float hyperbolic cosine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2046 count({list}, {expr} [, {ic} [, {start}]]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2047 Number count how many {expr} are in {list} |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
2048 cscope_connection([{num}, {dbpath} [, {prepend}]]) |
| 7 | 2049 Number checks existence of cscope connection |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2050 cursor({lnum}, {col} [, {off}]) |
| 6385 | 2051 Number move cursor to {lnum}, {col}, {off} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2052 cursor({list}) Number move cursor to position in {list} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2053 deepcopy({expr} [, {noref}]) any make a full copy of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2054 delete({fname} [, {flags}]) Number delete the file or directory {fname} |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2055 did_filetype() Number |TRUE| if FileType autocmd event used |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2056 diff_filler({lnum}) Number diff filler lines about {lnum} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2057 diff_hlID({lnum}, {col}) Number diff highlighting at {lnum}/{col} |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2058 empty({expr}) Number |TRUE| if {expr} is empty |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2059 escape({string}, {chars}) String escape {chars} in {string} with '\' |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2060 eval({string}) any evaluate {string} into its value |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2061 eventhandler() Number |TRUE| if inside an event handler |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2062 executable({expr}) Number 1 if executable {expr} exists |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
2063 execute({command}) String execute {command} and get the output |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2064 exepath({expr}) String full path of the command {expr} |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2065 exists({expr}) Number |TRUE| if {expr} exists |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2066 extend({expr1}, {expr2} [, {expr3}]) |
| 824 | 2067 List/Dict insert items of {expr2} into {expr1} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2068 exp({expr}) Float exponential of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2069 expand({expr} [, {nosuf} [, {list}]]) |
| 3398 | 2070 any expand special keywords in {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2071 feedkeys({string} [, {mode}]) Number add key sequence to typeahead buffer |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2072 filereadable({file}) Number |TRUE| if {file} is a readable file |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2073 filewritable({file}) Number |TRUE| if {file} is a writable file |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2074 filter({expr}, {string}) List/Dict remove items from {expr} where |
| 102 | 2075 {string} is 0 |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2076 finddir({name}[, {path}[, {count}]]) |
| 824 | 2077 String find directory {name} in {path} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2078 findfile({name}[, {path}[, {count}]]) |
| 824 | 2079 String find file {name} in {path} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2080 float2nr({expr}) Number convert Float {expr} to a Number |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2081 floor({expr}) Float round {expr} down |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2082 fmod({expr1}, {expr2}) Float remainder of {expr1} / {expr2} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2083 fnameescape({fname}) String escape special characters in {fname} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2084 fnamemodify({fname}, {mods}) String modify file name |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2085 foldclosed({lnum}) Number first line of fold at {lnum} if closed |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2086 foldclosedend({lnum}) Number last line of fold at {lnum} if closed |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2087 foldlevel({lnum}) Number fold level at {lnum} |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2088 foldtext() String line displayed for closed fold |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2089 foldtextresult({lnum}) String text for closed fold at {lnum} |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2090 foreground() Number bring the Vim window to the foreground |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
2091 funcref({name} [, {arglist}] [, {dict}]) |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
2092 Funcref reference to function {name} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2093 function({name} [, {arglist}] [, {dict}]) |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
2094 Funcref named reference to function {name} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2095 garbagecollect([{atexit}]) none free memory, breaking cyclic references |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2096 get({list}, {idx} [, {def}]) any get item {idx} from {list} or {def} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2097 get({dict}, {key} [, {def}]) any get item {key} from {dict} or {def} |
|
9117
0cc48b3cd884
commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents:
9110
diff
changeset
|
2098 get({func}, {what}) any get property of funcref/partial {func} |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2099 getbufinfo([{expr}]) List information about buffers |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2100 getbufline({expr}, {lnum} [, {end}]) |
| 435 | 2101 List lines {lnum} to {end} of buffer {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2102 getbufvar({expr}, {varname} [, {def}]) |
| 4157 | 2103 any variable {varname} in buffer {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2104 getchar([expr]) Number get one character from the user |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2105 getcharmod() Number modifiers for the last typed character |
| 7013 | 2106 getcharsearch() Dict last character search |
| 7 | 2107 getcmdline() String return the current command-line |
| 2108 getcmdpos() Number return cursor position in command-line | |
| 6153 | 2109 getcmdtype() String return current command-line type |
| 2110 getcmdwintype() String return current command-line window type | |
|
9861
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
2111 getcompletion({pat}, {type} [, {filtered}]) |
|
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
2112 List list of cmdline completion matches |
| 5944 | 2113 getcurpos() List position of the cursor |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2114 getcwd([{winnr} [, {tabnr}]]) String get the current working directory |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2115 getfontname([{name}]) String name of font being used |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2116 getfperm({fname}) String file permissions of file {fname} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2117 getfsize({fname}) Number size in bytes of file {fname} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2118 getftime({fname}) Number last modification time of file |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2119 getftype({fname}) String description of type of file {fname} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2120 getline({lnum}) String line {lnum} of current buffer |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2121 getline({lnum}, {end}) List lines {lnum} to {end} of current buffer |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
2122 getloclist({nr}[, {what}]) List list of location list items |
| 1326 | 2123 getmatches() List list of current matches |
| 1548 | 2124 getpid() Number process ID of Vim |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2125 getpos({expr}) List position of cursor, mark, etc. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
2126 getqflist([{what}]) List list of quickfix items |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2127 getreg([{regname} [, 1 [, {list}]]]) |
| 5796 | 2128 String or List contents of register |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2129 getregtype([{regname}]) String type of register |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2130 gettabinfo([{expr}]) List list of tab pages |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2131 gettabvar({nr}, {varname} [, {def}]) |
| 4157 | 2132 any variable {varname} in tab {nr} or {def} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2133 gettabwinvar({tabnr}, {winnr}, {name} [, {def}]) |
| 831 | 2134 any {name} in {winnr} in tab page {tabnr} |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2135 getwininfo([{winid}]) List list of windows |
| 7 | 2136 getwinposx() Number X coord in pixels of GUI Vim window |
| 2137 getwinposy() Number Y coord in pixels of GUI Vim window | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2138 getwinvar({nr}, {varname} [, {def}]) |
| 4157 | 2139 any variable {varname} in window {nr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2140 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 3398 | 2141 any expand file wildcards in {expr} |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2142 glob2regpat({expr}) String convert a glob pat into a search pat |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2143 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 1754 | 2144 String do glob({expr}) for all dirs in {path} |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2145 has({feature}) Number |TRUE| if feature {feature} supported |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2146 has_key({dict}, {key}) Number |TRUE| if {dict} has entry {key} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2147 haslocaldir([{winnr} [, {tabnr}]]) |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2148 Number |TRUE| if the window executed |:lcd| |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2149 hasmapto({what} [, {mode} [, {abbr}]]) |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2150 Number |TRUE| if mapping to {what} exists |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2151 histadd({history}, {item}) String add an item to a history |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2152 histdel({history} [, {item}]) String remove an item from a history |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2153 histget({history} [, {index}]) String get the item {index} from a history |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2154 histnr({history}) Number highest index of a history |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2155 hlexists({name}) Number |TRUE| if highlight group {name} exists |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2156 hlID({name}) Number syntax ID of highlight group {name} |
| 7 | 2157 hostname() String name of the machine Vim is running on |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2158 iconv({expr}, {from}, {to}) String convert encoding of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2159 indent({lnum}) Number indent of line {lnum} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2160 index({list}, {expr} [, {start} [, {ic}]]) |
| 95 | 2161 Number index in {list} where {expr} appears |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2162 input({prompt} [, {text} [, {completion}]]) |
| 531 | 2163 String get input from the user |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2164 inputdialog({prompt} [, {text} [, {completion}]]]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2165 String like input() but in a GUI dialog |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2166 inputlist({textlist}) Number let the user pick from a choice list |
| 55 | 2167 inputrestore() Number restore typeahead |
| 2168 inputsave() Number save and clear typeahead | |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2169 inputsecret({prompt} [, {text}]) String like input() but hiding the text |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2170 insert({list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}] |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2171 invert({expr}) Number bitwise invert |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2172 isdirectory({directory}) Number |TRUE| if {directory} is a directory |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2173 islocked({expr}) Number |TRUE| if {expr} is locked |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2174 isnan({expr}) Number |TRUE| if {expr} is NaN |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2175 items({dict}) List key-value pairs in {dict} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2176 job_getchannel({job}) Channel get the channel handle for {job} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2177 job_info({job}) Dict get information about {job} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2178 job_setoptions({job}, {options}) none set options for {job} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2179 job_start({command} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2180 Job start a job |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2181 job_status({job}) String get the status of {job} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2182 job_stop({job} [, {how}]) Number stop {job} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2183 join({list} [, {sep}]) String join {list} items into one String |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2184 js_decode({string}) any decode JS style JSON |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2185 js_encode({expr}) String encode JS style JSON |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2186 json_decode({string}) any decode JSON |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2187 json_encode({expr}) String encode JSON |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2188 keys({dict}) List keys in {dict} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2189 len({expr}) Number the length of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2190 libcall({lib}, {func}, {arg}) String call {func} in library {lib} with {arg} |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2191 libcallnr({lib}, {func}, {arg}) Number idem, but return a Number |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2192 line({expr}) Number line nr of cursor, last line or mark |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2193 line2byte({lnum}) Number byte count of line {lnum} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2194 lispindent({lnum}) Number Lisp indent for line {lnum} |
| 7 | 2195 localtime() Number current time |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2196 log({expr}) Float natural logarithm (base e) of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2197 log10({expr}) Float logarithm of Float {expr} to base 10 |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2198 luaeval({expr}[, {expr}]) any evaluate |Lua| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2199 map({expr}, {string}) List/Dict change each item in {expr} to {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2200 maparg({name}[, {mode} [, {abbr} [, {dict}]]]) |
| 3224 | 2201 String or Dict |
| 2202 rhs of mapping {name} in mode {mode} | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2203 mapcheck({name}[, {mode} [, {abbr}]]) |
| 782 | 2204 String check for mappings matching {name} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2205 match({expr}, {pat}[, {start}[, {count}]]) |
| 7 | 2206 Number position where {pat} matches in {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2207 matchadd({group}, {pattern}[, {priority}[, {id} [, {dict}]]]) |
| 1326 | 2208 Number highlight {pattern} with {group} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2209 matchaddpos({group}, {pos}[, {priority}[, {id}[, {dict}]]]) |
| 5979 | 2210 Number highlight positions with {group} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2211 matcharg({nr}) List arguments of |:match| |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2212 matchdelete({id}) Number delete match identified by {id} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2213 matchend({expr}, {pat}[, {start}[, {count}]]) |
| 7 | 2214 Number position where {pat} ends in {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2215 matchlist({expr}, {pat}[, {start}[, {count}]]) |
| 158 | 2216 List match and submatches of {pat} in {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2217 matchstr({expr}, {pat}[, {start}[, {count}]]) |
| 19 | 2218 String {count}'th match of {pat} in {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2219 matchstrpos({expr}, {pat}[, {start}[, {count}]]) |
|
8793
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
2220 List {count}'th match of {pat} in {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2221 max({list}) Number maximum value of items in {list} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2222 min({list}) Number minimum value of items in {list} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2223 mkdir({name} [, {path} [, {prot}]]) |
| 168 | 2224 Number create directory {name} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2225 mode([expr]) String current editing mode |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2226 mzeval({expr}) any evaluate |MzScheme| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2227 nextnonblank({lnum}) Number line nr of non-blank line >= {lnum} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2228 nr2char({expr}[, {utf8}]) String single char with ASCII/UTF8 value {expr} |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2229 or({expr}, {expr}) Number bitwise OR |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2230 pathshorten({expr}) String shorten directory names in a path |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2231 perleval({expr}) any evaluate |Perl| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2232 pow({x}, {y}) Float {x} to the power of {y} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2233 prevnonblank({lnum}) Number line nr of non-blank line <= {lnum} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2234 printf({fmt}, {expr1}...) String format text |
| 1621 | 2235 pumvisible() Number whether popup menu is visible |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2236 pyeval({expr}) any evaluate |Python| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2237 py3eval({expr}) any evaluate |python3| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2238 range({expr} [, {max} [, {stride}]]) |
| 99 | 2239 List items from {expr} to {max} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2240 readfile({fname} [, {binary} [, {max}]]) |
| 168 | 2241 List get list of lines from file {fname} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2242 reltime([{start} [, {end}]]) List get time value |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2243 reltimefloat({time}) Float turn the time value into a Float |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2244 reltimestr({time}) String turn time value into a String |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2245 remote_expr({server}, {string} [, {idvar}]) |
| 7 | 2246 String send expression |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2247 remote_foreground({server}) Number bring Vim server to the foreground |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2248 remote_peek({serverid} [, {retvar}]) |
| 7 | 2249 Number check for reply string |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2250 remote_read({serverid}) String read reply string |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2251 remote_send({server}, {string} [, {idvar}]) |
| 7 | 2252 String send key sequence |
|
9344
33c1b85d408c
commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
2253 remove({list}, {idx} [, {end}]) any remove items {idx}-{end} from {list} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2254 remove({dict}, {key}) any remove entry {key} from {dict} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2255 rename({from}, {to}) Number rename (move) file from {from} to {to} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2256 repeat({expr}, {count}) String repeat {expr} {count} times |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2257 resolve({filename}) String get filename a shortcut points to |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2258 reverse({list}) List reverse {list} in-place |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2259 round({expr}) Float round off {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2260 screenattr({row}, {col}) Number attribute at screen position |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2261 screenchar({row}, {col}) Number character at screen position |
| 3986 | 2262 screencol() Number current cursor column |
| 2263 screenrow() Number current cursor row | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2264 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
| 1496 | 2265 Number search for {pattern} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2266 searchdecl({name} [, {global} [, {thisblock}]]) |
| 1621 | 2267 Number search for variable declaration |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2268 searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 55 | 2269 Number search for other end of start/end pair |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2270 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 667 | 2271 List search for other end of start/end pair |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2272 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
| 667 | 2273 List search for {pattern} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2274 server2client({clientid}, {string}) |
| 7 | 2275 Number send reply string |
| 2276 serverlist() String get a list of available servers | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2277 setbufvar({expr}, {varname}, {val}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2278 none set {varname} in buffer {expr} to {val} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2279 setcharsearch({dict}) Dict set character search from {dict} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2280 setcmdpos({pos}) Number set cursor position in command-line |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2281 setfperm({fname}, {mode}) Number set {fname} file permissions to {mode} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2282 setline({lnum}, {line}) Number set line {lnum} to {line} |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
2283 setloclist({nr}, {list}[, {action}[, {what}]]) |
| 647 | 2284 Number modify location list using {list} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2285 setmatches({list}) Number restore a list of matches |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2286 setpos({expr}, {list}) Number set the {expr} position to {list} |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
2287 setqflist({list}[, {action}[, {what}]]) |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
2288 Number modify quickfix list using {list} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2289 setreg({n}, {v}[, {opt}]) Number set register to value and type |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2290 settabvar({nr}, {varname}, {val}) none set {varname} in tab page {nr} to {val} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2291 settabwinvar({tabnr}, {winnr}, {varname}, {val}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2292 none set {varname} in window {winnr} in tab |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2293 page {tabnr} to {val} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2294 setwinvar({nr}, {varname}, {val}) none set {varname} in window {nr} to {val} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2295 sha256({string}) String SHA256 checksum of {string} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2296 shellescape({string} [, {special}]) |
| 1661 | 2297 String escape {string} for use as shell |
| 985 | 2298 command argument |
| 3875 | 2299 shiftwidth() Number effective value of 'shiftwidth' |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2300 simplify({filename}) String simplify filename as much as possible |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2301 sin({expr}) Float sine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2302 sinh({expr}) Float hyperbolic sine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2303 sort({list} [, {func} [, {dict}]]) |
| 2902 | 2304 List sort {list}, using {func} to compare |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2305 soundfold({word}) String sound-fold {word} |
| 344 | 2306 spellbadword() String badly spelled word at cursor |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2307 spellsuggest({word} [, {max} [, {capital}]]) |
| 537 | 2308 List spelling suggestions |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2309 split({expr} [, {pat} [, {keepempty}]]) |
| 685 | 2310 List make |List| from {pat} separated {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2311 sqrt({expr}) Float square root of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2312 str2float({expr}) Float convert String to Float |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2313 str2nr({expr} [, {base}]) Number convert String to Number |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2314 strchars({expr} [, {skipcc}]) Number character length of the String {expr} |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2315 strcharpart({str}, {start}[, {len}]) |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2316 String {len} characters of {str} at {start} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2317 strdisplaywidth({expr} [, {col}]) Number display length of the String {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2318 strftime({format}[, {time}]) String time in specified format |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2319 strgetchar({str}, {index}) Number get char {index} from {str} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2320 stridx({haystack}, {needle}[, {start}]) |
| 133 | 2321 Number index of {needle} in {haystack} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2322 string({expr}) String String representation of {expr} value |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2323 strlen({expr}) Number length of the String {expr} |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2324 strpart({str}, {start}[, {len}]) |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2325 String {len} characters of {str} at {start} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2326 strridx({haystack}, {needle} [, {start}]) |
| 140 | 2327 Number last index of {needle} in {haystack} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2328 strtrans({expr}) String translate string to make it printable |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2329 strwidth({expr}) Number display cell length of the String {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2330 submatch({nr}[, {list}]) String or List |
| 5794 | 2331 specific match in ":s" or substitute() |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2332 substitute({expr}, {pat}, {sub}, {flags}) |
| 7 | 2333 String all {pat} in {expr} replaced with {sub} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2334 synID({lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2335 synIDattr({synID}, {what} [, {mode}]) |
| 7 | 2336 String attribute {what} of syntax ID {synID} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2337 synIDtrans({synID}) Number translated syntax ID of {synID} |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2338 synconcealed({lnum}, {col}) List info about concealing |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2339 synstack({lnum}, {col}) List stack of syntax IDs at {lnum} and {col} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2340 system({expr} [, {input}]) String output of shell command/filter {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2341 systemlist({expr} [, {input}]) List output of shell command/filter {expr} |
|
9344
33c1b85d408c
commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
2342 tabpagebuflist([{arg}]) List list of buffer numbers in tab page |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2343 tabpagenr([{arg}]) Number number of current or last tab page |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2344 tabpagewinnr({tabarg}[, {arg}]) Number number of current window in tab page |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2345 taglist({expr}) List list of tags matching {expr} |
| 1621 | 2346 tagfiles() List tags files used |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2347 tan({expr}) Float tangent of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2348 tanh({expr}) Float hyperbolic tangent of {expr} |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
2349 tempname() String name for a temporary file |
|
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
2350 test_alloc_fail({id}, {countdown}, {repeat}) |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
2351 none make memory allocation fail |
|
9644
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
2352 test_autochdir() none enable 'autochdir' during startup |
|
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
2353 test_disable_char_avail({expr}) none test without typeahead |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
2354 test_garbagecollect_now() none free memory right now for testing |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
2355 test_null_channel() Channel null value for testing |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
2356 test_null_dict() Dict null value for testing |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
2357 test_null_job() Job null value for testing |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
2358 test_null_list() List null value for testing |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
2359 test_null_partial() Funcref null value for testing |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
2360 test_null_string() String null value for testing |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2361 test_settime({expr}) none set current time for testing |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
2362 timer_info([{id}]) List information about timers |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
2363 timer_pause({id}, {pause}) none pause or unpause a timer |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2364 timer_start({time}, {callback} [, {options}]) |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
2365 Number create a timer |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2366 timer_stop({timer}) none stop a timer |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
2367 timer_stopall() none stop all timers |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2368 tolower({expr}) String the String {expr} switched to lowercase |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2369 toupper({expr}) String the String {expr} switched to uppercase |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2370 tr({src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
| 15 | 2371 to chars in {tostr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2372 trunc({expr}) Float truncate Float {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2373 type({name}) Number type of variable {name} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2374 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
|
2375 undotree() List undo file tree |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2376 uniq({list} [, {func} [, {dict}]]) |
| 5747 | 2377 List remove adjacent duplicates from a list |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2378 values({dict}) List values in {dict} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2379 virtcol({expr}) Number screen column of cursor or mark |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2380 visualmode([expr]) String last visual mode used |
| 4151 | 2381 wildmenumode() Number whether 'wildmenu' mode is active |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2382 win_findbuf({bufnr}) List find windows containing {bufnr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2383 win_getid([{win} [, {tab}]]) Number get window ID for {win} in {tab} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2384 win_gotoid({expr}) Number go to window with ID {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2385 win_id2tabwin({expr}) List get tab and window nr from window ID |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2386 win_id2win({expr}) Number get window nr from window ID |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2387 winbufnr({nr}) Number buffer number of window {nr} |
| 7 | 2388 wincol() Number window column of the cursor |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2389 winheight({nr}) Number height of window {nr} |
| 7 | 2390 winline() Number window line of the cursor |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2391 winnr([{expr}]) Number number of current window |
| 55 | 2392 winrestcmd() String returns command to restore window sizes |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2393 winrestview({dict}) none restore view of current window |
| 712 | 2394 winsaveview() Dict save view of current window |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2395 winwidth({nr}) Number width of window {nr} |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
2396 wordcount() Dict get byte/char/word statistics |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2397 writefile({list}, {fname} [, {flags}]) |
| 158 | 2398 Number write list of lines to file {fname} |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2399 xor({expr}, {expr}) Number bitwise XOR |
| 7 | 2400 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
2401 |
| 1621 | 2402 abs({expr}) *abs()* |
| 2403 Return the absolute value of {expr}. When {expr} evaluates to | |
| 2404 a |Float| abs() returns a |Float|. When {expr} can be | |
| 2405 converted to a |Number| abs() returns a |Number|. Otherwise | |
| 2406 abs() gives an error message and returns -1. | |
| 2407 Examples: > | |
| 2408 echo abs(1.456) | |
| 2409 < 1.456 > | |
| 2410 echo abs(-5.456) | |
| 2411 < 5.456 > | |
| 2412 echo abs(-4) | |
| 2413 < 4 | |
| 2414 {only available when compiled with the |+float| feature} | |
| 2415 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2416 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2417 acos({expr}) *acos()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2418 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
|
2419 |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
|
2420 {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
|
2421 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2422 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2423 :echo acos(0) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2424 < 1.570796 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2425 :echo acos(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2426 < 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
|
2427 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2428 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2429 |
| 82 | 2430 add({list}, {expr}) *add()* |
| 685 | 2431 Append the item {expr} to |List| {list}. Returns the |
| 2432 resulting |List|. Examples: > | |
| 82 | 2433 :let alist = add([1, 2, 3], item) |
| 2434 :call add(mylist, "woodstock") | |
| 685 | 2435 < Note that when {expr} is a |List| it is appended as a single |
| 692 | 2436 item. Use |extend()| to concatenate |Lists|. |
| 85 | 2437 Use |insert()| to add an item at another position. |
| 55 | 2438 |
| 82 | 2439 |
| 3214 | 2440 and({expr}, {expr}) *and()* |
| 2441 Bitwise AND on the two arguments. The arguments are converted | |
| 2442 to a number. A List, Dict or Float argument causes an error. | |
| 2443 Example: > | |
| 2444 :let flag = and(bits, 0x80) | |
| 2445 | |
| 2446 | |
| 82 | 2447 append({lnum}, {expr}) *append()* |
| 685 | 2448 When {expr} is a |List|: Append each item of the |List| as a |
| 2449 text line below line {lnum} in the current buffer. | |
| 153 | 2450 Otherwise append {expr} as one text line below line {lnum} in |
| 2451 the current buffer. | |
| 2452 {lnum} can be zero to insert a line before the first one. | |
| 82 | 2453 Returns 1 for failure ({lnum} out of range or out of memory), |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2454 0 for success. Example: > |
| 55 | 2455 :let failed = append(line('$'), "# THE END") |
| 82 | 2456 :let failed = append(0, ["Chapter 1", "the beginning"]) |
| 55 | 2457 < |
| 7 | 2458 *argc()* |
| 2459 argc() The result is the number of files in the argument list of the | |
| 2460 current window. See |arglist|. | |
| 2461 | |
| 2462 *argidx()* | |
| 2463 argidx() The result is the current index in the argument list. 0 is | |
| 2464 the first file. argc() - 1 is the last one. See |arglist|. | |
| 2465 | |
| 5942 | 2466 *arglistid()* |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2467 arglistid([{winnr} [, {tabnr}]]) |
| 5942 | 2468 Return the argument list ID. This is a number which |
| 2469 identifies the argument list being used. Zero is used for the | |
| 6153 | 2470 global argument list. See |arglist|. |
| 2471 Return -1 if the arguments are invalid. | |
| 5942 | 2472 |
| 2473 Without arguments use the current window. | |
| 2474 With {winnr} only use this window in the current tab page. | |
| 2475 With {winnr} and {tabnr} use the window in the specified tab | |
| 2476 page. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
2477 {winnr} can be the window number or the |window-ID|. |
| 5942 | 2478 |
| 7 | 2479 *argv()* |
| 818 | 2480 argv([{nr}]) The result is the {nr}th file in the argument list of the |
| 7 | 2481 current window. See |arglist|. "argv(0)" is the first one. |
| 2482 Example: > | |
| 2483 :let i = 0 | |
| 2484 :while i < argc() | |
| 1621 | 2485 : let f = escape(fnameescape(argv(i)), '.') |
| 7 | 2486 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
| 2487 : let i = i + 1 | |
| 2488 :endwhile | |
| 818 | 2489 < Without the {nr} argument a |List| with the whole |arglist| is |
| 2490 returned. | |
| 2491 | |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2492 *assert_equal()* |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2493 assert_equal({expected}, {actual} [, {msg}]) |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2494 When {expected} and {actual} are not equal an error message is |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2495 added to |v:errors|. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2496 There is no automatic conversion, the String "4" is different |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2497 from the Number 4. And the number 4 is different from the |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2498 Float 4.0. The value of 'ignorecase' is not used here, case |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2499 always matters. |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2500 When {msg} is omitted an error in the form "Expected |
|
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2501 {expected} but got {actual}" is produced. |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2502 Example: > |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2503 assert_equal('foo', 'bar') |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2504 < Will result in a string to be added to |v:errors|: |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2505 test.vim line 12: Expected 'foo' but got 'bar' ~ |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2506 |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2507 assert_exception({error} [, {msg}]) *assert_exception()* |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2508 When v:exception does not contain the string {error} an error |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2509 message is added to |v:errors|. |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2510 This can be used to assert that a command throws an exception. |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2511 Using the error number, followed by a colon, avoids problems |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2512 with translations: > |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2513 try |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2514 commandthatfails |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2515 call assert_false(1, 'command should have failed') |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2516 catch |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2517 call assert_exception('E492:') |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2518 endtry |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2519 |
|
7593
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2520 assert_fails({cmd} [, {error}]) *assert_fails()* |
|
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2521 Run {cmd} and add an error message to |v:errors| if it does |
|
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2522 NOT produce an error. |
|
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2523 When {error} is given it must match |v:errmsg|. |
|
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2524 |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2525 assert_false({actual} [, {msg}]) *assert_false()* |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2526 When {actual} is not false an error message is added to |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2527 |v:errors|, like with |assert_equal()|. |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
2528 A value is false when it is zero. When {actual} is not a |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2529 number the assert fails. |
|
9636
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2530 When {msg} is omitted an error in the form |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2531 "Expected False but got {actual}" is produced. |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2532 |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2533 assert_inrange({lower}, {upper}, {actual} [, {msg}]) *assert_inrange()* |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2534 This asserts number values. When {actual} is lower than |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2535 {lower} or higher than {upper} an error message is added to |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2536 |v:errors|. |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2537 When {msg} is omitted an error in the form |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2538 "Expected range {lower} - {upper}, but got {actual}" is |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2539 produced. |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2540 |
|
8749
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2541 *assert_match()* |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2542 assert_match({pattern}, {actual} [, {msg}]) |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2543 When {pattern} does not match {actual} an error message is |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2544 added to |v:errors|. |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2545 |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2546 {pattern} is used as with |=~|: The matching is always done |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2547 like 'magic' was set and 'cpoptions' is empty, no matter what |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2548 the actual value of 'magic' or 'cpoptions' is. |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2549 |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2550 {actual} is used as a string, automatic conversion applies. |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2551 Use "^" and "$" to match with the start and end of the text. |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2552 Use both to match the whole text. |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2553 |
|
9636
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2554 When {msg} is omitted an error in the form |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2555 "Pattern {pattern} does not match {actual}" is produced. |
|
8749
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2556 Example: > |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2557 assert_match('^f.*o$', 'foobar') |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2558 < Will result in a string to be added to |v:errors|: |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2559 test.vim line 12: Pattern '^f.*o$' does not match 'foobar' ~ |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2560 |
|
8831
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2561 *assert_notequal()* |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2562 assert_notequal({expected}, {actual} [, {msg}]) |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2563 The opposite of `assert_equal()`: add an error message to |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2564 |v:errors| when {expected} and {actual} are equal. |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2565 |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2566 *assert_notmatch()* |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2567 assert_notmatch({pattern}, {actual} [, {msg}]) |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2568 The opposite of `assert_match()`: add an error message to |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2569 |v:errors| when {pattern} matches {actual}. |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2570 |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2571 assert_true({actual} [, {msg}]) *assert_true()* |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2572 When {actual} is not true an error message is added to |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2573 |v:errors|, like with |assert_equal()|. |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2574 A value is TRUE when it is a non-zero number. When {actual} |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2575 is not a number the assert fails. |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2576 When {msg} is omitted an error in the form "Expected True but |
|
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2577 got {actual}" is produced. |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2578 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2579 asin({expr}) *asin()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2580 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
|
2581 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
|
2582 {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
|
2583 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2584 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2585 :echo asin(0.8) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2586 < 0.927295 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2587 :echo asin(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2588 < -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
|
2589 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2590 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2591 |
| 1621 | 2592 atan({expr}) *atan()* |
| 2593 Return the principal value of the arc tangent of {expr}, in | |
| 2594 the range [-pi/2, +pi/2] radians, as a |Float|. | |
| 2595 {expr} must evaluate to a |Float| or a |Number|. | |
| 2596 Examples: > | |
| 2597 :echo atan(100) | |
| 2598 < 1.560797 > | |
| 2599 :echo atan(-4.01) | |
| 2600 < -1.326405 | |
| 2601 {only available when compiled with the |+float| feature} | |
| 2602 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2603 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2604 atan2({expr1}, {expr2}) *atan2()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2605 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
|
2606 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
|
2607 {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
|
2608 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2609 :echo atan2(-1, 1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2610 < -0.785398 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2611 :echo atan2(1, -1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2612 < 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
|
2613 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2614 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2615 |
| 7 | 2616 *browse()* |
| 2617 browse({save}, {title}, {initdir}, {default}) | |
| 2618 Put up a file requester. This only works when "has("browse")" | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2619 returns |TRUE| (only in some GUI versions). |
| 7 | 2620 The input fields are: |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2621 {save} when |TRUE|, select file to write |
| 7 | 2622 {title} title for the requester |
| 2623 {initdir} directory to start browsing in | |
| 2624 {default} default file name | |
| 2625 When the "Cancel" button is hit, something went wrong, or | |
| 2626 browsing is not possible, an empty string is returned. | |
| 2627 | |
| 29 | 2628 *browsedir()* |
| 2629 browsedir({title}, {initdir}) | |
| 2630 Put up a directory requester. This only works when | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2631 "has("browse")" returns |TRUE| (only in some GUI versions). |
| 29 | 2632 On systems where a directory browser is not supported a file |
| 2633 browser is used. In that case: select a file in the directory | |
| 2634 to be used. | |
| 2635 The input fields are: | |
| 2636 {title} title for the requester | |
| 2637 {initdir} directory to start browsing in | |
| 2638 When the "Cancel" button is hit, something went wrong, or | |
| 2639 browsing is not possible, an empty string is returned. | |
| 2640 | |
| 7 | 2641 bufexists({expr}) *bufexists()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2642 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 2643 {expr} exists. |
| 9 | 2644 If the {expr} argument is a number, buffer numbers are used. |
| 7 | 2645 If the {expr} argument is a string it must match a buffer name |
| 9 | 2646 exactly. The name can be: |
| 2647 - Relative to the current directory. | |
| 2648 - A full path. | |
| 1621 | 2649 - The name of a buffer with 'buftype' set to "nofile". |
| 9 | 2650 - A URL name. |
| 7 | 2651 Unlisted buffers will be found. |
| 2652 Note that help files are listed by their short name in the | |
| 2653 output of |:buffers|, but bufexists() requires using their | |
| 2654 long name to be able to find them. | |
| 1621 | 2655 bufexists() may report a buffer exists, but to use the name |
| 2656 with a |:buffer| command you may need to use |expand()|. Esp | |
| 2657 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
| 7 | 2658 Use "bufexists(0)" to test for the existence of an alternate |
| 2659 file name. | |
| 2660 *buffer_exists()* | |
| 2661 Obsolete name: buffer_exists(). | |
| 2662 | |
| 2663 buflisted({expr}) *buflisted()* | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2664 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 2665 {expr} exists and is listed (has the 'buflisted' option set). |
| 9 | 2666 The {expr} argument is used like with |bufexists()|. |
| 7 | 2667 |
| 2668 bufloaded({expr}) *bufloaded()* | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2669 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 2670 {expr} exists and is loaded (shown in a window or hidden). |
| 9 | 2671 The {expr} argument is used like with |bufexists()|. |
| 7 | 2672 |
| 2673 bufname({expr}) *bufname()* | |
| 2674 The result is the name of a buffer, as it is displayed by the | |
| 2675 ":ls" command. | |
| 2676 If {expr} is a Number, that buffer number's name is given. | |
| 2677 Number zero is the alternate buffer for the current window. | |
| 2678 If {expr} is a String, it is used as a |file-pattern| to match | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2679 with the buffer names. This is always done like 'magic' is |
| 7 | 2680 set and 'cpoptions' is empty. When there is more than one |
| 2681 match an empty string is returned. | |
| 2682 "" or "%" can be used for the current buffer, "#" for the | |
| 2683 alternate buffer. | |
| 2684 A full match is preferred, otherwise a match at the start, end | |
| 1156 | 2685 or middle of the buffer name is accepted. If you only want a |
| 2686 full match then put "^" at the start and "$" at the end of the | |
| 2687 pattern. | |
| 7 | 2688 Listed buffers are found first. If there is a single match |
| 2689 with a listed buffer, that one is returned. Next unlisted | |
| 2690 buffers are searched for. | |
| 2691 If the {expr} is a String, but you want to use it as a buffer | |
| 2692 number, force it to be a Number by adding zero to it: > | |
| 2693 :echo bufname("3" + 0) | |
| 2694 < If the buffer doesn't exist, or doesn't have a name, an empty | |
| 2695 string is returned. > | |
| 2696 bufname("#") alternate buffer name | |
| 2697 bufname(3) name of buffer 3 | |
| 2698 bufname("%") name of current buffer | |
| 2699 bufname("file2") name of buffer where "file2" matches. | |
| 2700 < *buffer_name()* | |
| 2701 Obsolete name: buffer_name(). | |
| 2702 | |
| 2703 *bufnr()* | |
| 707 | 2704 bufnr({expr} [, {create}]) |
| 2705 The result is the number of a buffer, as it is displayed by | |
| 7 | 2706 the ":ls" command. For the use of {expr}, see |bufname()| |
| 707 | 2707 above. |
| 2708 If the buffer doesn't exist, -1 is returned. Or, if the | |
| 2709 {create} argument is present and not zero, a new, unlisted, | |
| 2710 buffer is created and its number is returned. | |
| 7 | 2711 bufnr("$") is the last buffer: > |
| 2712 :let last_buffer = bufnr("$") | |
| 2713 < The result is a Number, which is the highest buffer number | |
| 2714 of existing buffers. Note that not all buffers with a smaller | |
| 2715 number necessarily exist, because ":bwipeout" may have removed | |
| 2716 them. Use bufexists() to test for the existence of a buffer. | |
| 2717 *buffer_number()* | |
| 2718 Obsolete name: buffer_number(). | |
| 2719 *last_buffer_nr()* | |
| 2720 Obsolete name for bufnr("$"): last_buffer_nr(). | |
| 2721 | |
|
9219
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
2722 bufwinid({expr}) *bufwinid()* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
2723 The result is a Number, which is the |window-ID| of the first |
|
9219
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
2724 window associated with buffer {expr}. For the use of {expr}, |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2725 see |bufname()| above. If buffer {expr} doesn't exist or |
|
9219
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
2726 there is no such window, -1 is returned. Example: > |
|
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
2727 |
|
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
2728 echo "A window containing buffer 1 is " . (bufwinid(1)) |
|
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
2729 < |
|
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
2730 Only deals with the current tab page. |
|
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
2731 |
| 7 | 2732 bufwinnr({expr}) *bufwinnr()* |
| 2733 The result is a Number, which is the number of the first | |
| 2734 window associated with buffer {expr}. For the use of {expr}, | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2735 see |bufname()| above. If buffer {expr} doesn't exist or |
| 7 | 2736 there is no such window, -1 is returned. Example: > |
| 2737 | |
| 2738 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
| 2739 | |
| 2740 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
| 2741 |:wincmd|. | |
| 1156 | 2742 Only deals with the current tab page. |
| 7 | 2743 |
| 2744 byte2line({byte}) *byte2line()* | |
| 2745 Return the line number that contains the character at byte | |
| 2746 count {byte} in the current buffer. This includes the | |
| 2747 end-of-line character, depending on the 'fileformat' option | |
| 2748 for the current buffer. The first character has byte count | |
| 2749 one. | |
| 2750 Also see |line2byte()|, |go| and |:goto|. | |
| 2751 {not available when compiled without the |+byte_offset| | |
| 2752 feature} | |
| 2753 | |
| 18 | 2754 byteidx({expr}, {nr}) *byteidx()* |
| 2755 Return byte index of the {nr}'th character in the string | |
| 2756 {expr}. Use zero for the first character, it returns zero. | |
| 2757 This function is only useful when there are multibyte | |
| 2758 characters, otherwise the returned value is equal to {nr}. | |
| 5413 | 2759 Composing characters are not counted separately, their byte |
| 2760 length is added to the preceding base character. See | |
| 2761 |byteidxcomp()| below for counting composing characters | |
| 2762 separately. | |
| 18 | 2763 Example : > |
| 2764 echo matchstr(str, ".", byteidx(str, 3)) | |
| 2765 < will display the fourth character. Another way to do the | |
| 2766 same: > | |
| 2767 let s = strpart(str, byteidx(str, 3)) | |
| 2768 echo strpart(s, 0, byteidx(s, 1)) | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2769 < Also see |strgetchar()| and |strcharpart()|. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2770 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2771 If there are less than {nr} characters -1 is returned. |
| 18 | 2772 If there are exactly {nr} characters the length of the string |
| 5413 | 2773 in bytes is returned. |
| 2774 | |
| 2775 byteidxcomp({expr}, {nr}) *byteidxcomp()* | |
| 2776 Like byteidx(), except that a composing character is counted | |
| 2777 as a separate character. Example: > | |
| 2778 let s = 'e' . nr2char(0x301) | |
| 2779 echo byteidx(s, 1) | |
| 2780 echo byteidxcomp(s, 1) | |
| 2781 echo byteidxcomp(s, 2) | |
| 2782 < The first and third echo result in 3 ('e' plus composing | |
| 2783 character is 3 bytes), the second echo results in 1 ('e' is | |
| 2784 one byte). | |
| 2785 Only works different from byteidx() when 'encoding' is set to | |
| 2786 a Unicode encoding. | |
| 18 | 2787 |
| 102 | 2788 call({func}, {arglist} [, {dict}]) *call()* *E699* |
| 685 | 2789 Call function {func} with the items in |List| {arglist} as |
| 79 | 2790 arguments. |
| 685 | 2791 {func} can either be a |Funcref| or the name of a function. |
| 79 | 2792 a:firstline and a:lastline are set to the cursor line. |
| 2793 Returns the return value of the called function. | |
| 102 | 2794 {dict} is for functions with the "dict" attribute. It will be |
| 2795 used to set the local variable "self". |Dictionary-function| | |
| 79 | 2796 |
| 1621 | 2797 ceil({expr}) *ceil()* |
| 2798 Return the smallest integral value greater than or equal to | |
| 2799 {expr} as a |Float| (round up). | |
| 2800 {expr} must evaluate to a |Float| or a |Number|. | |
| 2801 Examples: > | |
| 2802 echo ceil(1.456) | |
| 2803 < 2.0 > | |
| 2804 echo ceil(-5.456) | |
| 2805 < -5.0 > | |
| 2806 echo ceil(4.0) | |
| 2807 < 4.0 | |
| 2808 {only available when compiled with the |+float| feature} | |
| 2809 | |
| 777 | 2810 changenr() *changenr()* |
| 2811 Return the number of the most recent change. This is the same | |
| 2812 number as what is displayed with |:undolist| and can be used | |
| 2813 with the |:undo| command. | |
| 2814 When a change was made it is the number of that change. After | |
| 2815 redo it is the number of the redone change. After undo it is | |
| 2816 one less than the number of the undone change. | |
| 2817 | |
| 4051 | 2818 char2nr({expr}[, {utf8}]) *char2nr()* |
| 7 | 2819 Return number value of the first char in {expr}. Examples: > |
| 2820 char2nr(" ") returns 32 | |
| 2821 char2nr("ABC") returns 65 | |
| 4051 | 2822 < When {utf8} is omitted or zero, the current 'encoding' is used. |
| 2823 Example for "utf-8": > | |
| 1156 | 2824 char2nr("á") returns 225 |
| 2825 char2nr("á"[0]) returns 195 | |
| 4051 | 2826 < With {utf8} set to 1, always treat as utf-8 characters. |
| 2827 A combining character is a separate character. | |
| 2965 | 2828 |nr2char()| does the opposite. |
| 7 | 2829 |
| 2830 cindent({lnum}) *cindent()* | |
| 2831 Get the amount of indent for line {lnum} according the C | |
| 2832 indenting rules, as with 'cindent'. | |
| 2833 The indent is counted in spaces, the value of 'tabstop' is | |
| 2834 relevant. {lnum} is used just like in |getline()|. | |
| 2835 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
| 2836 feature, -1 is returned. | |
| 548 | 2837 See |C-indenting|. |
| 7 | 2838 |
| 1326 | 2839 clearmatches() *clearmatches()* |
| 2840 Clears all matches previously defined by |matchadd()| and the | |
| 2841 |:match| commands. | |
| 2842 | |
| 7 | 2843 *col()* |
| 24 | 2844 col({expr}) The result is a Number, which is the byte index of the column |
| 7 | 2845 position given with {expr}. The accepted positions are: |
| 2846 . the cursor position | |
| 2847 $ the end of the cursor line (the result is the | |
| 3513 | 2848 number of bytes in the cursor line plus one) |
| 7 | 2849 'x position of mark x (if the mark is not set, 0 is |
| 2850 returned) | |
| 6447 | 2851 v In Visual mode: the start of the Visual area (the |
| 2852 cursor is the end). When not in Visual mode | |
| 2853 returns the cursor position. Differs from |'<| in | |
| 2854 that it's updated right away. | |
| 1317 | 2855 Additionally {expr} can be [lnum, col]: a |List| with the line |
| 2856 and column number. Most useful when the column is "$", to get | |
| 1621 | 2857 the last column of a specific line. When "lnum" or "col" is |
| 1317 | 2858 out of range then col() returns zero. |
| 1156 | 2859 To get the line number use |line()|. To get both use |
| 703 | 2860 |getpos()|. |
| 7 | 2861 For the screen column position use |virtcol()|. |
| 2862 Note that only marks in the current file can be used. | |
| 2863 Examples: > | |
| 2864 col(".") column of cursor | |
| 2865 col("$") length of cursor line plus one | |
| 2866 col("'t") column of mark t | |
| 2867 col("'" . markname) column of mark markname | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2868 < The first column is 1. 0 is returned for an error. |
| 1156 | 2869 For an uppercase mark the column may actually be in another |
| 2870 buffer. | |
| 7 | 2871 For the cursor position, when 'virtualedit' is active, the |
| 2872 column is one higher if the cursor is after the end of the | |
| 2873 line. This can be used to obtain the column in Insert mode: > | |
| 2874 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
| 2875 \<C-O>:set ve=all<CR> | |
| 2876 \<C-O>:echo col(".") . "\n" <Bar> | |
| 2877 \let &ve = save_ve<CR> | |
| 2878 < | |
| 464 | 2879 |
| 724 | 2880 complete({startcol}, {matches}) *complete()* *E785* |
| 2881 Set the matches for Insert mode completion. | |
| 2882 Can only be used in Insert mode. You need to use a mapping | |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
2883 with CTRL-R = (see |i_CTRL-R|). It does not work after CTRL-O |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
2884 or with an expression mapping. |
| 724 | 2885 {startcol} is the byte offset in the line where the completed |
| 2886 text start. The text up to the cursor is the original text | |
| 2887 that will be replaced by the matches. Use col('.') for an | |
| 2888 empty string. "col('.') - 1" will replace one character by a | |
| 2889 match. | |
| 2890 {matches} must be a |List|. Each |List| item is one match. | |
| 2891 See |complete-items| for the kind of items that are possible. | |
| 2892 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
|
2893 inserting anything that would cause completion to stop. |
| 724 | 2894 The match can be selected with CTRL-N and CTRL-P as usual with |
| 2895 Insert mode completion. The popup menu will appear if | |
| 2896 specified, see |ins-completion-menu|. | |
| 2897 Example: > | |
| 1156 | 2898 inoremap <F5> <C-R>=ListMonths()<CR> |
| 724 | 2899 |
| 2900 func! ListMonths() | |
| 2901 call complete(col('.'), ['January', 'February', 'March', | |
| 2902 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
| 2903 \ 'October', 'November', 'December']) | |
| 2904 return '' | |
| 2905 endfunc | |
| 2906 < This isn't very useful, but it shows how it works. Note that | |
| 2907 an empty string is returned to avoid a zero being inserted. | |
| 2908 | |
| 464 | 2909 complete_add({expr}) *complete_add()* |
| 2910 Add {expr} to the list of matches. Only to be used by the | |
| 2911 function specified with the 'completefunc' option. | |
| 2912 Returns 0 for failure (empty string or out of memory), | |
| 2913 1 when the match was added, 2 when the match was already in | |
| 2914 the list. | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2915 See |complete-functions| for an explanation of {expr}. It is |
| 786 | 2916 the same as one item in the list that 'omnifunc' would return. |
| 464 | 2917 |
| 2918 complete_check() *complete_check()* | |
| 2919 Check for a key typed while looking for completion matches. | |
| 2920 This is to be used when looking for matches takes some time. | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2921 Returns |TRUE| when searching for matches is to be aborted, |
| 464 | 2922 zero otherwise. |
| 2923 Only to be used by the function specified with the | |
| 2924 'completefunc' option. | |
| 2925 | |
| 7 | 2926 *confirm()* |
| 2927 confirm({msg} [, {choices} [, {default} [, {type}]]]) | |
| 2928 Confirm() offers the user a dialog, from which a choice can be | |
| 2929 made. It returns the number of the choice. For the first | |
| 2930 choice this is 1. | |
| 2931 Note: confirm() is only supported when compiled with dialog | |
| 2932 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
|
2933 |
| 7 | 2934 {msg} is displayed in a |dialog| with {choices} as the |
| 2935 alternatives. When {choices} is missing or empty, "&OK" is | |
| 2936 used (and translated). | |
| 2937 {msg} is a String, use '\n' to include a newline. Only on | |
| 2938 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
|
2939 |
| 7 | 2940 {choices} is a String, with the individual choices separated |
| 2941 by '\n', e.g. > | |
| 2942 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
| 2943 < The letter after the '&' is the shortcut key for that choice. | |
| 2944 Thus you can type 'c' to select "Cancel". The shortcut does | |
| 2945 not need to be the first letter: > | |
| 2946 confirm("file has been modified", "&Save\nSave &All") | |
| 2947 < For the console, the first letter of each choice is used as | |
| 2948 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
|
2949 |
| 7 | 2950 The optional {default} argument is the number of the choice |
| 2951 that is made if the user hits <CR>. Use 1 to make the first | |
| 2952 choice the default one. Use 0 to not set a default. If | |
| 2953 {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
|
2954 |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
2955 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
|
2956 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
|
2957 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
|
2958 "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
|
2959 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
|
2960 |
| 7 | 2961 If the user aborts the dialog by pressing <Esc>, CTRL-C, |
| 2962 or another valid interrupt key, confirm() returns 0. | |
| 2963 | |
| 2964 An example: > | |
| 2965 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
| 2966 :if choice == 0 | |
| 2967 : echo "make up your mind!" | |
| 2968 :elseif choice == 3 | |
| 2969 : echo "tasteful" | |
| 2970 :else | |
| 2971 : echo "I prefer bananas myself." | |
| 2972 :endif | |
| 2973 < In a GUI dialog, buttons are used. The layout of the buttons | |
| 2974 depends on the 'v' flag in 'guioptions'. If it is included, | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2975 the buttons are always put vertically. Otherwise, confirm() |
| 7 | 2976 tries to put the buttons in one horizontal line. If they |
| 2977 don't fit, a vertical layout is used anyway. For some systems | |
| 2978 the horizontal layout is always used. | |
| 2979 | |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2980 ch_close({handle}) *ch_close()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2981 Close {handle}. See |channel-close|. |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2982 {handle} can be Channel or a Job that has a Channel. |
|
8392
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
2983 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
2984 {only available when compiled with the |+channel| feature} |
|
7895
bff95e0d8885
commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
2985 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2986 ch_evalexpr({handle}, {expr} [, {options}]) *ch_evalexpr()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2987 Send {expr} over {handle}. The {expr} is encoded |
|
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2988 according to the type of channel. The function cannot be used |
|
8303
88207f4b861a
commit https://github.com/vim/vim/commit/dae8d21dd291df6a6679a00be64e18bca0156576
Christian Brabandt <cb@256bit.org>
parents:
8291
diff
changeset
|
2989 with a raw channel. See |channel-use|. |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2990 {handle} can be Channel or a Job that has a Channel. |
|
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2991 *E917* |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2992 {options} must be a Dictionary. It must not have a "callback" |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
2993 entry. It can have a "timeout" entry to specify the timeout |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
2994 for this specific request. |
|
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2995 |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2996 ch_evalexpr() waits for a response and returns the decoded |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2997 expression. When there is an error or timeout it returns an |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2998 empty string. |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2999 |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3000 {only available when compiled with the |+channel| feature} |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3001 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3002 ch_evalraw({handle}, {string} [, {options}]) *ch_evalraw()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3003 Send {string} over {handle}. |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3004 {handle} can be Channel or a Job that has a Channel. |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3005 |
|
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3006 Works like |ch_evalexpr()|, but does not encode the request or |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3007 decode the response. The caller is responsible for the |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3008 correct contents. Also does not add a newline for a channel |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3009 in NL mode, the caller must do that. The NL in the response |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3010 is removed. |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3011 See |channel-use|. |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3012 |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3013 {only available when compiled with the |+channel| feature} |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3014 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3015 ch_getbufnr({handle}, {what}) *ch_getbufnr()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3016 Get the buffer number that {handle} is using for {what}. |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3017 {handle} can be Channel or a Job that has a Channel. |
|
8291
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
3018 {what} can be "err" for stderr, "out" for stdout or empty for |
|
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
3019 socket output. |
|
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
3020 Returns -1 when there is no buffer. |
|
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
3021 {only available when compiled with the |+channel| feature} |
|
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
3022 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3023 ch_getjob({channel}) *ch_getjob()* |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3024 Get the Job associated with {channel}. |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3025 If there is no job calling |job_status()| on the returned Job |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3026 will result in "fail". |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3027 |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3028 {only available when compiled with the |+channel| and |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3029 |+job| features} |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3030 |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3031 ch_info({handle}) *ch_info()* |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3032 Returns a Dictionary with information about {handle}. The |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3033 items are: |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3034 "id" number of the channel |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3035 "status" "open" (any part is open) or "closed" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3036 When opened with ch_open(): |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3037 "hostname" the hostname of the address |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3038 "port" the port of the address |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3039 "sock_status" "open" or "closed" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3040 "sock_mode" "NL", "RAW", "JSON" or "JS" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3041 "sock_io" "socket" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3042 "sock_timeout" timeout in msec |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3043 When opened with job_start(): |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3044 "out_status" "open" or "closed" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3045 "out_mode" "NL", "RAW", "JSON" or "JS" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3046 "out_io" "null", "pipe", "file" or "buffer" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3047 "out_timeout" timeout in msec |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3048 "err_status" "open" or "closed" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3049 "err_mode" "NL", "RAW", "JSON" or "JS" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3050 "err_io" "out", "null", "pipe", "file" or "buffer" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3051 "err_timeout" timeout in msec |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3052 "in_status" "open" or "closed" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3053 "in_mode" "NL", "RAW", "JSON" or "JS" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3054 "in_io" "null", "pipe", "file" or "buffer" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3055 "in_timeout" timeout in msec |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3056 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3057 ch_log({msg} [, {handle}]) *ch_log()* |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3058 Write {msg} in the channel log file, if it was opened with |
|
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3059 |ch_logfile()|. |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3060 When {handle} is passed the channel number is used for the |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3061 message. |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3062 {handle} can be Channel or a Job that has a Channel. The |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3063 Channel must open. |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3064 |
|
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3065 ch_logfile({fname} [, {mode}]) *ch_logfile()* |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3066 Start logging channel activity to {fname}. |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3067 When {fname} is an empty string: stop logging. |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3068 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3069 When {mode} is omitted or "a" append to the file. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3070 When {mode} is "w" start with an empty file. |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3071 |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3072 The file is flushed after every message, on Unix you can use |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3073 "tail -f" to see what is going on in real time. |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3074 |
|
8392
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
3075 |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3076 ch_open({address} [, {options}]) *ch_open()* |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3077 Open a channel to {address}. See |channel|. |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3078 Returns a Channel. Use |ch_status()| to check for failure. |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3079 |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3080 {address} has the form "hostname:port", e.g., |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3081 "localhost:8765". |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3082 |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3083 If {options} is given it must be a |Dictionary|. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3084 See |channel-open-options|. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3085 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3086 {only available when compiled with the |+channel| feature} |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3087 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3088 ch_read({handle} [, {options}]) *ch_read()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3089 Read from {handle} and return the received message. |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3090 {handle} can be Channel or a Job that has a Channel. |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3091 See |channel-more|. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3092 {only available when compiled with the |+channel| feature} |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3093 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3094 ch_readraw({handle} [, {options}]) *ch_readraw()* |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3095 Like ch_read() but for a JS and JSON channel does not decode |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3096 the message. See |channel-more|. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3097 {only available when compiled with the |+channel| feature} |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3098 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3099 ch_sendexpr({handle}, {expr} [, {options}]) *ch_sendexpr()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3100 Send {expr} over {handle}. The {expr} is encoded |
|
7992
78106b0f2c56
commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents:
7967
diff
changeset
|
3101 according to the type of channel. The function cannot be used |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3102 with a raw channel. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3103 See |channel-use|. *E912* |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3104 {handle} can be Channel or a Job that has a Channel. |
|
7895
bff95e0d8885
commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3105 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3106 {only available when compiled with the |+channel| feature} |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3107 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3108 ch_sendraw({handle}, {string} [, {options}]) *ch_sendraw()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3109 Send {string} over {handle}. |
|
7992
78106b0f2c56
commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents:
7967
diff
changeset
|
3110 Works like |ch_sendexpr()|, but does not encode the request or |
|
78106b0f2c56
commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents:
7967
diff
changeset
|
3111 decode the response. The caller is responsible for the |
|
8094
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
3112 correct contents. Also does not add a newline for a channel |
|
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
3113 in NL mode, the caller must do that. The NL in the response |
|
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
3114 is removed. |
|
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
3115 See |channel-use|. |
|
7895
bff95e0d8885
commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3116 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3117 {only available when compiled with the |+channel| feature} |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3118 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3119 ch_setoptions({handle}, {options}) *ch_setoptions()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3120 Set options on {handle}: |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3121 "callback" the channel callback |
|
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3122 "timeout" default read timeout in msec |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3123 "mode" mode for the whole channel |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3124 See |ch_open()| for more explanation. |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3125 {handle} can be Channel or a Job that has a Channel. |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3126 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3127 Note that changing the mode may cause queued messages to be |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3128 lost. |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3129 |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3130 These options cannot be changed: |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
3131 "waittime" only applies to |ch_open()| |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3132 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3133 ch_status({handle}) *ch_status()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3134 Return the status of {handle}: |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3135 "fail" failed to open the channel |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3136 "open" channel can be used |
|
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
3137 "buffered" channel can be read, not written to |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3138 "closed" channel can not be used |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3139 {handle} can be Channel or a Job that has a Channel. |
|
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
3140 "buffered" is used when the channel was closed but there is |
|
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
3141 still data that can be obtained with |ch_read()|. |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3142 |
| 55 | 3143 *copy()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3144 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 3145 different from using {expr} directly. |
| 685 | 3146 When {expr} is a |List| a shallow copy is created. This means |
| 3147 that the original |List| can be changed without changing the | |
| 1621 | 3148 copy, and vice versa. But the items are identical, thus |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
3149 changing an item changes the contents of both |Lists|. |
|
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
3150 A |Dictionary| is copied in a similar way as a |List|. |
|
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
3151 Also see |deepcopy()|. |
| 55 | 3152 |
| 1621 | 3153 cos({expr}) *cos()* |
| 3154 Return the cosine of {expr}, measured in radians, as a |Float|. | |
| 3155 {expr} must evaluate to a |Float| or a |Number|. | |
| 3156 Examples: > | |
| 3157 :echo cos(100) | |
| 3158 < 0.862319 > | |
| 3159 :echo cos(-4.01) | |
| 3160 < -0.646043 | |
| 3161 {only available when compiled with the |+float| feature} | |
| 3162 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3163 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3164 cosh({expr}) *cosh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3165 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
|
3166 [1, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3167 {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
|
3168 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3169 :echo cosh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3170 < 1.127626 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3171 :echo cosh(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3172 < -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
|
3173 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3174 |
| 1621 | 3175 |
| 102 | 3176 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
| 79 | 3177 Return the number of times an item with value {expr} appears |
| 685 | 3178 in |List| or |Dictionary| {comp}. |
| 102 | 3179 If {start} is given then start with the item with this index. |
| 685 | 3180 {start} can only be used with a |List|. |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3181 When {ic} is given and it's |TRUE| then case is ignored. |
| 79 | 3182 |
| 3183 | |
| 7 | 3184 *cscope_connection()* |
| 3185 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
| 3186 Checks for the existence of a |cscope| connection. If no | |
| 3187 parameters are specified, then the function returns: | |
| 3188 0, if cscope was not available (not compiled in), or | |
| 3189 if there are no cscope connections; | |
| 3190 1, if there is at least one cscope connection. | |
| 3191 | |
| 3192 If parameters are specified, then the value of {num} | |
| 3193 determines how existence of a cscope connection is checked: | |
| 3194 | |
| 3195 {num} Description of existence check | |
| 3196 ----- ------------------------------ | |
| 3197 0 Same as no parameters (e.g., "cscope_connection()"). | |
| 3198 1 Ignore {prepend}, and use partial string matches for | |
| 3199 {dbpath}. | |
| 3200 2 Ignore {prepend}, and use exact string matches for | |
| 3201 {dbpath}. | |
| 3202 3 Use {prepend}, use partial string matches for both | |
| 3203 {dbpath} and {prepend}. | |
| 3204 4 Use {prepend}, use exact string matches for both | |
| 3205 {dbpath} and {prepend}. | |
| 3206 | |
| 3207 Note: All string comparisons are case sensitive! | |
| 3208 | |
| 3209 Examples. Suppose we had the following (from ":cs show"): > | |
| 3210 | |
| 3211 # pid database name prepend path | |
| 3212 0 27664 cscope.out /usr/local | |
| 3213 < | |
| 3214 Invocation Return Val ~ | |
| 3215 ---------- ---------- > | |
| 3216 cscope_connection() 1 | |
| 3217 cscope_connection(1, "out") 1 | |
| 3218 cscope_connection(2, "out") 0 | |
| 3219 cscope_connection(3, "out") 0 | |
| 3220 cscope_connection(3, "out", "local") 1 | |
| 3221 cscope_connection(4, "out") 0 | |
| 3222 cscope_connection(4, "out", "local") 0 | |
| 3223 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
| 3224 < | |
| 703 | 3225 cursor({lnum}, {col} [, {off}]) *cursor()* |
| 3226 cursor({list}) | |
| 1156 | 3227 Positions the cursor at the column (byte count) {col} in the |
| 3228 line {lnum}. The first column is one. | |
| 5938 | 3229 |
| 703 | 3230 When there is one argument {list} this is used as a |List| |
| 5938 | 3231 with two, three or four item: |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
3232 [{lnum}, {col}] |
| 5938 | 3233 [{lnum}, {col}, {off}] |
| 3234 [{lnum}, {col}, {off}, {curswant}] | |
| 6009 | 3235 This is like the return value of |getpos()| or |getcurpos()|, |
| 5944 | 3236 but without the first item. |
| 5938 | 3237 |
| 7 | 3238 Does not change the jumplist. |
| 3239 If {lnum} is greater than the number of lines in the buffer, | |
| 3240 the cursor will be positioned at the last line in the buffer. | |
| 3241 If {lnum} is zero, the cursor will stay in the current line. | |
| 493 | 3242 If {col} is greater than the number of bytes in the line, |
| 7 | 3243 the cursor will be positioned at the last character in the |
| 3244 line. | |
| 3245 If {col} is zero, the cursor will stay in the current column. | |
| 5944 | 3246 If {curswant} is given it is used to set the preferred column |
| 6180 | 3247 for vertical movement. Otherwise {col} is used. |
| 6385 | 3248 |
| 703 | 3249 When 'virtualedit' is used {off} specifies the offset in |
| 3250 screen columns from the start of the character. E.g., a | |
| 1266 | 3251 position within a <Tab> or after the last character. |
| 1851 | 3252 Returns 0 when the position could be set, -1 otherwise. |
| 7 | 3253 |
| 55 | 3254 |
| 164 | 3255 deepcopy({expr}[, {noref}]) *deepcopy()* *E698* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3256 Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 3257 different from using {expr} directly. |
| 685 | 3258 When {expr} is a |List| a full copy is created. This means |
| 3259 that the original |List| can be changed without changing the | |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3260 copy, and vice versa. When an item is a |List| or |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3261 |Dictionary|, a copy for it is made, recursively. Thus |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3262 changing an item in the copy does not change the contents of |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3263 the original |List|. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3264 A |Dictionary| is copied in a similar way as a |List|. |
| 685 | 3265 When {noref} is omitted or zero a contained |List| or |
| 3266 |Dictionary| is only copied once. All references point to | |
| 3267 this single copy. With {noref} set to 1 every occurrence of a | |
| 3268 |List| or |Dictionary| results in a new copy. This also means | |
| 3269 that a cyclic reference causes deepcopy() to fail. | |
| 114 | 3270 *E724* |
| 3271 Nesting is possible up to 100 levels. When there is an item | |
| 164 | 3272 that refers back to a higher level making a deep copy with |
| 3273 {noref} set to 1 will fail. | |
| 55 | 3274 Also see |copy()|. |
| 3275 | |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3276 delete({fname} [, {flags}]) *delete()* |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3277 Without {flags} or with {flags} empty: Deletes the file by the |
|
7629
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
3278 name {fname}. This also works when {fname} is a symbolic link. |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3279 |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3280 When {flags} is "d": Deletes the directory by the name |
|
7629
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
3281 {fname}. This fails when directory {fname} is not empty. |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3282 |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3283 When {flags} is "rf": Deletes the directory by the name |
|
7629
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
3284 {fname} and everything in it, recursively. BE CAREFUL! |
|
10027
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
10004
diff
changeset
|
3285 Note: on MS-Windows it is not possible to delete a directory |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
10004
diff
changeset
|
3286 that is being used. |
|
10004
8061455d9179
commit https://github.com/vim/vim/commit/818078ddfbb8cc2546f697c5675a251d095722ec
Christian Brabandt <cb@256bit.org>
parents:
10000
diff
changeset
|
3287 |
|
7629
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
3288 A symbolic link itself is deleted, not what it points to. |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3289 |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3290 The result is a Number, which is 0 if the delete operation was |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3291 successful and -1 when the deletion failed or partly failed. |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3292 |
| 685 | 3293 Use |remove()| to delete an item from a |List|. |
| 4229 | 3294 To delete a line from the buffer use |:delete|. Use |:exe| |
| 3295 when the line number is in a variable. | |
| 7 | 3296 |
| 3297 *did_filetype()* | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3298 did_filetype() Returns |TRUE| when autocommands are being executed and the |
| 7 | 3299 FileType event has been triggered at least once. Can be used |
| 3300 to avoid triggering the FileType event again in the scripts | |
| 3301 that detect the file type. |FileType| | |
| 3302 When editing another file, the counter is reset, thus this | |
| 3303 really checks if the FileType event has been triggered for the | |
| 3304 current buffer. This allows an autocommand that starts | |
| 3305 editing another buffer to set 'filetype' and load a syntax | |
| 3306 file. | |
| 3307 | |
| 32 | 3308 diff_filler({lnum}) *diff_filler()* |
| 3309 Returns the number of filler lines above line {lnum}. | |
| 3310 These are the lines that were inserted at this point in | |
| 3311 another diff'ed window. These filler lines are shown in the | |
| 3312 display but don't exist in the buffer. | |
| 3313 {lnum} is used like with |getline()|. Thus "." is the current | |
| 3314 line, "'m" mark m, etc. | |
| 3315 Returns 0 if the current window is not in diff mode. | |
| 3316 | |
| 3317 diff_hlID({lnum}, {col}) *diff_hlID()* | |
| 3318 Returns the highlight ID for diff mode at line {lnum} column | |
| 3319 {col} (byte index). When the current line does not have a | |
| 3320 diff change zero is returned. | |
| 3321 {lnum} is used like with |getline()|. Thus "." is the current | |
| 3322 line, "'m" mark m, etc. | |
| 3323 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
| 3324 line. | |
| 3325 The highlight ID can be used with |synIDattr()| to obtain | |
| 3326 syntax information about the highlighting. | |
| 3327 | |
| 85 | 3328 empty({expr}) *empty()* |
| 3329 Return the Number 1 if {expr} is empty, zero otherwise. | |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3330 - A |List| or |Dictionary| is empty when it does not have any |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3331 items. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3332 - A Number and Float is empty when its value is zero. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3333 - |v:false|, |v:none| and |v:null| are empty, |v:true| is not. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3334 - A Job is empty when it failed to start. |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3335 - A Channel is empty when it is closed. |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3336 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3337 For a long |List| this is much faster than comparing the |
| 685 | 3338 length with zero. |
| 85 | 3339 |
| 7 | 3340 escape({string}, {chars}) *escape()* |
| 3341 Escape the characters in {chars} that occur in {string} with a | |
| 3342 backslash. Example: > | |
| 3343 :echo escape('c:\program files\vim', ' \') | |
| 3344 < results in: > | |
| 3345 c:\\program\ files\\vim | |
| 1621 | 3346 < Also see |shellescape()|. |
| 3347 | |
| 3348 *eval()* | |
| 95 | 3349 eval({string}) Evaluate {string} and return the result. Especially useful to |
| 3350 turn the result of |string()| back into the original value. | |
| 1621 | 3351 This works for Numbers, Floats, Strings and composites of |
| 3352 them. Also works for |Funcref|s that refer to existing | |
| 3353 functions. | |
| 95 | 3354 |
| 7 | 3355 eventhandler() *eventhandler()* |
| 3356 Returns 1 when inside an event handler. That is that Vim got | |
| 3357 interrupted while waiting for the user to type a character, | |
| 3358 e.g., when dropping a file on Vim. This means interactive | |
| 3359 commands cannot be used. Otherwise zero is returned. | |
| 3360 | |
| 3361 executable({expr}) *executable()* | |
| 3362 This function checks if an executable with the name {expr} | |
| 3363 exists. {expr} must be the name of the program without any | |
| 10 | 3364 arguments. |
| 3365 executable() uses the value of $PATH and/or the normal | |
| 3366 searchpath for programs. *PATHEXT* | |
| 3367 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can | |
| 3368 optionally be included. Then the extensions in $PATHEXT are | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3369 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3370 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is |
| 10 | 3371 used. A dot by itself can be used in $PATHEXT to try using |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3372 the name without an extension. When 'shell' looks like a |
| 10 | 3373 Unix shell, then the name is also tried without adding an |
| 3374 extension. | |
| 3375 On MS-DOS and MS-Windows it only checks if the file exists and | |
| 3376 is not a directory, not if it's really executable. | |
| 819 | 3377 On MS-Windows an executable in the same directory as Vim is |
| 3378 always found. Since this directory is added to $PATH it | |
| 3379 should also work to execute it |win32-PATH|. | |
| 7 | 3380 The result is a Number: |
| 3381 1 exists | |
| 3382 0 does not exist | |
| 3383 -1 not implemented on this system | |
| 3384 | |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3385 execute({command} [, {silent}]) *execute()* |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3386 Execute an Ex command or commands and return the output as a |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3387 string. |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3388 {command} can be a string or a List. In case of a List the |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3389 lines are executed one by one. |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3390 This is equivalent to: > |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3391 redir => var |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3392 {command} |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3393 redir END |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3394 < |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3395 The optional {silent} argument can have these values: |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3396 "" no `:silent` used |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3397 "silent" `:silent` used |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3398 "silent!" `:silent!` used |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3399 The default is 'silent'. Note that with "silent!", unlike |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
3400 `:redir`, error messages are dropped. When using an external |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
3401 command the screen may be messed up, use `system()` instead. |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3402 *E930* |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3403 It is not possible to use `:redir` anywhere in {command}. |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3404 |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3405 To get a list of lines use |split()| on the result: > |
|
9464
be72f4201a1d
commit https://github.com/vim/vim/commit/063b9d15abea041a5bfff3ffc4e219e26fd1d4fa
Christian Brabandt <cb@256bit.org>
parents:
9460
diff
changeset
|
3406 split(execute('args'), "\n") |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3407 |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3408 < When used recursively the output of the recursive call is not |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3409 included in the output of the higher level call. |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3410 |
| 5782 | 3411 exepath({expr}) *exepath()* |
| 3412 If {expr} is an executable and is either an absolute path, a | |
| 3413 relative path or found in $PATH, return the full path. | |
| 3414 Note that the current directory is used when {expr} starts | |
| 3415 with "./", which may be a problem for Vim: > | |
| 3416 echo exepath(v:progpath) | |
| 5814 | 3417 < If {expr} cannot be found in $PATH or is not executable then |
| 5782 | 3418 an empty string is returned. |
| 3419 | |
| 7 | 3420 *exists()* |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3421 exists({expr}) The result is a Number, which is |TRUE| if {expr} is defined, |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3422 zero otherwise. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3423 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3424 For checking for a supported feature use |has()|. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3425 For checking if a file exists use |filereadable()|. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3426 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3427 The {expr} argument is a string, which contains one of these: |
| 7 | 3428 &option-name Vim option (only checks if it exists, |
| 3429 not if it really works) | |
| 3430 +option-name Vim option that works. | |
| 3431 $ENVNAME environment variable (could also be | |
| 3432 done by comparing with an empty | |
| 3433 string) | |
| 3434 *funcname built-in function (see |functions|) | |
| 3435 or user defined function (see | |
| 5862 | 3436 |user-functions|). Also works for a |
| 3437 variable that is a Funcref. | |
| 7 | 3438 varname internal variable (see |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3439 |internal-variables|). Also works |
| 685 | 3440 for |curly-braces-names|, |Dictionary| |
| 3441 entries, |List| items, etc. Beware | |
| 1668 | 3442 that evaluating an index may cause an |
| 3443 error message for an invalid | |
| 3444 expression. E.g.: > | |
| 3445 :let l = [1, 2, 3] | |
| 3446 :echo exists("l[5]") | |
| 3447 < 0 > | |
| 3448 :echo exists("l[xx]") | |
| 3449 < E121: Undefined variable: xx | |
| 3450 0 | |
| 7 | 3451 :cmdname Ex command: built-in command, user |
| 3452 command or command modifier |:command|. | |
| 3453 Returns: | |
| 3454 1 for match with start of a command | |
| 3455 2 full match with a command | |
| 3456 3 matches several user commands | |
| 3457 To check for a supported command | |
| 3458 always check the return value to be 2. | |
| 864 | 3459 :2match The |:2match| command. |
| 3460 :3match The |:3match| command. | |
| 7 | 3461 #event autocommand defined for this event |
| 3462 #event#pattern autocommand defined for this event and | |
| 3463 pattern (the pattern is taken | |
| 3464 literally and compared to the | |
| 3465 autocommand patterns character by | |
| 3466 character) | |
| 613 | 3467 #group autocommand group exists |
| 3468 #group#event autocommand defined for this group and | |
| 3469 event. | |
| 3470 #group#event#pattern | |
| 856 | 3471 autocommand defined for this group, |
| 613 | 3472 event and pattern. |
| 615 | 3473 ##event autocommand for this event is |
| 3474 supported. | |
| 7 | 3475 |
| 3476 Examples: > | |
| 3477 exists("&shortname") | |
| 3478 exists("$HOSTNAME") | |
| 3479 exists("*strftime") | |
| 3480 exists("*s:MyFunc") | |
| 3481 exists("bufcount") | |
| 3482 exists(":Make") | |
| 613 | 3483 exists("#CursorHold") |
| 7 | 3484 exists("#BufReadPre#*.gz") |
| 613 | 3485 exists("#filetypeindent") |
| 3486 exists("#filetypeindent#FileType") | |
| 3487 exists("#filetypeindent#FileType#*") | |
| 615 | 3488 exists("##ColorScheme") |
| 7 | 3489 < There must be no space between the symbol (&/$/*/#) and the |
| 3490 name. | |
| 867 | 3491 There must be no extra characters after the name, although in |
| 3492 a few cases this is ignored. That may become more strict in | |
| 3493 the future, thus don't count on it! | |
| 3494 Working example: > | |
| 3495 exists(":make") | |
| 3496 < NOT working example: > | |
| 3497 exists(":make install") | |
| 859 | 3498 |
| 3499 < Note that the argument must be a string, not the name of the | |
| 3500 variable itself. For example: > | |
| 7 | 3501 exists(bufcount) |
| 3502 < This doesn't check for existence of the "bufcount" variable, | |
| 853 | 3503 but gets the value of "bufcount", and checks if that exists. |
| 7 | 3504 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3505 exp({expr}) *exp()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3506 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
|
3507 [0, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3508 {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
|
3509 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3510 :echo exp(2) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3511 < 7.389056 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3512 :echo exp(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3513 < 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
|
3514 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3515 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3516 |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3517 expand({expr} [, {nosuf} [, {list}]]) *expand()* |
| 7 | 3518 Expand wildcards and the following special keywords in {expr}. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3519 'wildignorecase' applies. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3520 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3521 If {list} is given and it is |TRUE|, a List will be returned. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3522 Otherwise the result is a String and when there are several |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3523 matches, they are separated by <NL> characters. [Note: in |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3524 version 5.0 a space was used, which caused problems when a |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3525 file name contains a space] |
| 7 | 3526 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3527 If the expansion fails, the result is an empty string. A name |
| 4869 | 3528 for a non-existing file is not included, unless {expr} does |
| 3529 not start with '%', '#' or '<', see below. | |
| 7 | 3530 |
| 3531 When {expr} starts with '%', '#' or '<', the expansion is done | |
| 3532 like for the |cmdline-special| variables with their associated | |
| 3533 modifiers. Here is a short overview: | |
| 3534 | |
| 3535 % current file name | |
| 3536 # alternate file name | |
| 3537 #n alternate file name n | |
| 3538 <cfile> file name under the cursor | |
| 3539 <afile> autocmd file name | |
| 3540 <abuf> autocmd buffer number (as a String!) | |
| 3541 <amatch> autocmd matched name | |
| 5734 | 3542 <sfile> sourced script file or function name |
| 2662 | 3543 <slnum> sourced script file line number |
| 7 | 3544 <cword> word under the cursor |
| 3545 <cWORD> WORD under the cursor | |
| 3546 <client> the {clientid} of the last received | |
| 3547 message |server2client()| | |
| 3548 Modifiers: | |
| 3549 :p expand to full path | |
| 3550 :h head (last path component removed) | |
| 3551 :t tail (last path component only) | |
| 3552 :r root (one extension removed) | |
| 3553 :e extension only | |
| 3554 | |
| 3555 Example: > | |
| 3556 :let &tags = expand("%:p:h") . "/tags" | |
| 3557 < Note that when expanding a string that starts with '%', '#' or | |
| 3558 '<', any following text is ignored. This does NOT work: > | |
| 3559 :let doesntwork = expand("%:h.bak") | |
| 3560 < Use this: > | |
| 3561 :let doeswork = expand("%:h") . ".bak" | |
| 3562 < Also note that expanding "<cfile>" and others only returns the | |
| 3563 referenced file name without further expansion. If "<cfile>" | |
| 3564 is "~/.cshrc", you need to do another expand() to have the | |
| 3565 "~/" expanded into the path of the home directory: > | |
| 3566 :echo expand(expand("<cfile>")) | |
| 3567 < | |
| 3568 There cannot be white space between the variables and the | |
| 3569 following modifier. The |fnamemodify()| function can be used | |
| 3570 to modify normal file names. | |
| 3571 | |
| 3572 When using '%' or '#', and the current or alternate file name | |
| 3573 is not defined, an empty string is used. Using "%:p" in a | |
| 3574 buffer with no name, results in the current directory, with a | |
| 3575 '/' added. | |
| 3576 | |
| 3577 When {expr} does not start with '%', '#' or '<', it is | |
| 3578 expanded like a file name is expanded on the command line. | |
| 3579 'suffixes' and 'wildignore' are used, unless the optional | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3580 {nosuf} argument is given and it is |TRUE|. |
| 3398 | 3581 Names for non-existing files are included. The "**" item can |
| 3582 be used to search in a directory tree. For example, to find | |
| 3583 all "README" files in the current directory and below: > | |
| 444 | 3584 :echo expand("**/README") |
| 3585 < | |
| 7 | 3586 Expand() can also be used to expand variables and environment |
| 3587 variables that are only known in a shell. But this can be | |
| 6180 | 3588 slow, because a shell may be used to do the expansion. See |
| 3589 |expr-env-expand|. | |
| 7 | 3590 The expanded variable is still handled like a list of file |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3591 names. When an environment variable cannot be expanded, it is |
| 7 | 3592 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
| 3593 "$FOOBAR". | |
| 3594 | |
| 3595 See |glob()| for finding existing files. See |system()| for | |
| 3596 getting the raw output of an external command. | |
| 3597 | |
| 102 | 3598 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
| 692 | 3599 {expr1} and {expr2} must be both |Lists| or both |
| 3600 |Dictionaries|. | |
| 3601 | |
| 3602 If they are |Lists|: Append {expr2} to {expr1}. | |
| 102 | 3603 If {expr3} is given insert the items of {expr2} before item |
| 3604 {expr3} in {expr1}. When {expr3} is zero insert before the | |
| 3605 first item. When {expr3} is equal to len({expr1}) then | |
| 3606 {expr2} is appended. | |
| 79 | 3607 Examples: > |
| 3608 :echo sort(extend(mylist, [7, 5])) | |
| 3609 :call extend(mylist, [2, 3], 1) | |
| 1699 | 3610 < When {expr1} is the same List as {expr2} then the number of |
| 3611 items copied is equal to the original length of the List. | |
| 3612 E.g., when {expr3} is 1 you get N new copies of the first item | |
| 3613 (where N is the original length of the List). | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3614 Use |add()| to concatenate one item to a list. To concatenate |
| 82 | 3615 two lists into a new list use the + operator: > |
| 79 | 3616 :let newlist = [1, 2, 3] + [4, 5] |
| 102 | 3617 < |
| 692 | 3618 If they are |Dictionaries|: |
| 102 | 3619 Add all entries from {expr2} to {expr1}. |
| 3620 If a key exists in both {expr1} and {expr2} then {expr3} is | |
| 3621 used to decide what to do: | |
| 3622 {expr3} = "keep": keep the value of {expr1} | |
| 3623 {expr3} = "force": use the value of {expr2} | |
| 856 | 3624 {expr3} = "error": give an error message *E737* |
| 102 | 3625 When {expr3} is omitted then "force" is assumed. |
| 3626 | |
| 3627 {expr1} is changed when {expr2} is not empty. If necessary | |
| 3628 make a copy of {expr1} first. | |
| 3629 {expr2} remains unchanged. | |
| 6823 | 3630 When {expr1} is locked and {expr2} is not empty the operation |
| 3631 fails. | |
| 102 | 3632 Returns {expr1}. |
| 3633 | |
| 79 | 3634 |
| 842 | 3635 feedkeys({string} [, {mode}]) *feedkeys()* |
| 3636 Characters in {string} are queued for processing as if they | |
| 6549 | 3637 come from a mapping or were typed by the user. |
| 3638 By default the string is added to the end of the typeahead | |
| 3639 buffer, thus if a mapping is still being executed the | |
| 3640 characters come after them. Use the 'i' flag to insert before | |
| 3641 other characters, they will be executed next, before any | |
| 3642 characters from a mapping. | |
| 842 | 3643 The function does not wait for processing of keys contained in |
| 3644 {string}. | |
| 3645 To include special keys into {string}, use double-quotes | |
| 3646 and "\..." notation |expr-quote|. For example, | |
| 1215 | 3647 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
| 842 | 3648 feedkeys('\<CR>') pushes 5 characters. |
| 3649 If {mode} is absent, keys are remapped. | |
| 3650 {mode} is a String, which can contain these character flags: | |
| 843 | 3651 'm' Remap keys. This is default. |
| 3652 'n' Do not remap keys. | |
| 3653 't' Handle keys as if typed; otherwise they are handled as | |
| 3654 if coming from a mapping. This matters for undo, | |
| 3655 opening folds, etc. | |
| 6549 | 3656 'i' Insert the string instead of appending (see above). |
|
7703
39251e981d1f
commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
3657 'x' Execute commands until typeahead is empty. This is |
|
39251e981d1f
commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
3658 similar to using ":normal!". You can call feedkeys() |
|
39251e981d1f
commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
3659 several times without 'x' and then one time with 'x' |
|
39251e981d1f
commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents:
7659
diff
changeset
|
3660 (possibly with an empty {string}) to execute all the |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
3661 typeahead. Note that when Vim ends in Insert mode it |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
3662 will behave as if <Esc> is typed, to avoid getting |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
3663 stuck, waiting for a character to be typed before the |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
3664 script continues. |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3665 '!' When used with 'x' will not end Insert mode. Can be |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3666 used in a test when a timer is set to exit Insert mode |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3667 a little later. Useful for testing CursorHoldI. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3668 |
| 842 | 3669 Return value is always 0. |
| 3670 | |
| 7 | 3671 filereadable({file}) *filereadable()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3672 The result is a Number, which is |TRUE| when a file with the |
| 7 | 3673 name {file} exists, and can be read. If {file} doesn't exist, |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3674 or is a directory, the result is |FALSE|. {file} is any |
| 7 | 3675 expression, which is used as a String. |
| 1156 | 3676 If you don't care about the file being readable you can use |
| 3677 |glob()|. | |
| 7 | 3678 *file_readable()* |
| 3679 Obsolete name: file_readable(). | |
| 3680 | |
| 95 | 3681 |
| 1156 | 3682 filewritable({file}) *filewritable()* |
| 3683 The result is a Number, which is 1 when a file with the | |
| 3684 name {file} exists, and can be written. If {file} doesn't | |
| 1621 | 3685 exist, or is not writable, the result is 0. If {file} is a |
| 1156 | 3686 directory, and we can write to it, the result is 2. |
| 3687 | |
| 3688 | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3689 filter({expr1}, {expr2}) *filter()* |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3690 {expr1} must be a |List| or a |Dictionary|. |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3691 For each item in {expr1} evaluate {expr2} and when the result |
| 685 | 3692 is zero remove the item from the |List| or |Dictionary|. |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3693 {expr2} must be a |string| or |Funcref|. |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3694 |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3695 if {expr2} is a |string|, inside {expr2} |v:val| has the value |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3696 of the current item. For a |Dictionary| |v:key| has the key |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3697 of the current item. |
| 102 | 3698 Examples: > |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3699 call filter(mylist, 'v:val !~ "OLD"') |
| 102 | 3700 < Removes the items where "OLD" appears. > |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3701 call filter(mydict, 'v:key >= 8') |
| 102 | 3702 < Removes the items with a key below 8. > |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3703 call filter(var, 0) |
| 685 | 3704 < Removes all the items, thus clears the |List| or |Dictionary|. |
| 99 | 3705 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3706 Note that {expr2} is the result of expression and is then |
| 102 | 3707 used as an expression again. Often it is good to use a |
| 3708 |literal-string| to avoid having to double backslashes. | |
| 3709 | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3710 If {expr2} is a |Funcref| it must take two arguments: |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3711 1. the key or the index of the current item. |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3712 2. the value of the current item. |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3713 The function must return |TRUE| if the item should be kept. |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3714 Example that keeps the odd items of a list: > |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3715 func Odd(idx, val) |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3716 return a:idx % 2 == 1 |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3717 endfunc |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3718 call filter(mylist, function('Odd')) |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3719 < |
| 685 | 3720 The operation is done in-place. If you want a |List| or |
| 3721 |Dictionary| to remain unmodified make a copy first: > | |
| 650 | 3722 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
| 102 | 3723 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3724 < Returns {expr1}, the |List| or |Dictionary| that was filtered. |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3725 When an error is encountered while evaluating {expr2} no |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3726 further items in {expr1} are processed. When {expr2} is a |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3727 Funcref errors inside a function are ignored, unless it was |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3728 defined with the "abort" flag. |
| 95 | 3729 |
| 3730 | |
| 19 | 3731 finddir({name}[, {path}[, {count}]]) *finddir()* |
| 1095 | 3732 Find directory {name} in {path}. Supports both downwards and |
| 3733 upwards recursive directory searches. See |file-searching| | |
| 3734 for the syntax of {path}. | |
| 3735 Returns the path of the first found match. When the found | |
| 3736 directory is below the current directory a relative path is | |
| 3737 returned. Otherwise a full path is returned. | |
| 19 | 3738 If {path} is omitted or empty then 'path' is used. |
| 3739 If the optional {count} is given, find {count}'s occurrence of | |
| 794 | 3740 {name} in {path} instead of the first one. |
| 809 | 3741 When {count} is negative return all the matches in a |List|. |
| 19 | 3742 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
|
3743 {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
|
3744 feature} |
| 794 | 3745 |
| 3746 findfile({name}[, {path}[, {count}]]) *findfile()* | |
| 3747 Just like |finddir()|, but find a file instead of a directory. | |
| 3748 Uses 'suffixesadd'. | |
| 19 | 3749 Example: > |
| 3750 :echo findfile("tags.vim", ".;") | |
| 1156 | 3751 < Searches from the directory of the current file upwards until |
| 3752 it finds the file "tags.vim". | |
| 7 | 3753 |
| 1621 | 3754 float2nr({expr}) *float2nr()* |
| 3755 Convert {expr} to a Number by omitting the part after the | |
| 3756 decimal point. | |
| 3757 {expr} must evaluate to a |Float| or a Number. | |
| 3758 When the value of {expr} is out of range for a |Number| the | |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
3759 result is truncated to 0x7fffffff or -0x7fffffff (or when |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
3760 64-bit Number support is enabled, 0x7fffffffffffffff or |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
3761 -0x7fffffffffffffff. NaN results in -0x80000000 (or when |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
3762 64-bit Number support is enabled, -0x8000000000000000). |
| 1621 | 3763 Examples: > |
| 3764 echo float2nr(3.95) | |
| 3765 < 3 > | |
| 3766 echo float2nr(-23.45) | |
| 3767 < -23 > | |
| 3768 echo float2nr(1.0e100) | |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
3769 < 2147483647 (or 9223372036854775807) > |
| 1621 | 3770 echo float2nr(-1.0e150) |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
3771 < -2147483647 (or -9223372036854775807) > |
| 1621 | 3772 echo float2nr(1.0e-100) |
| 3773 < 0 | |
| 3774 {only available when compiled with the |+float| feature} | |
| 3775 | |
| 3776 | |
| 3777 floor({expr}) *floor()* | |
| 3778 Return the largest integral value less than or equal to | |
| 3779 {expr} as a |Float| (round down). | |
| 3780 {expr} must evaluate to a |Float| or a |Number|. | |
| 3781 Examples: > | |
| 3782 echo floor(1.856) | |
| 3783 < 1.0 > | |
| 3784 echo floor(-5.456) | |
| 3785 < -6.0 > | |
| 3786 echo floor(4.0) | |
| 3787 < 4.0 | |
| 3788 {only available when compiled with the |+float| feature} | |
| 3789 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3790 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3791 fmod({expr1}, {expr2}) *fmod()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3792 Return the remainder of {expr1} / {expr2}, even if the |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3793 division is not representable. Returns {expr1} - i * {expr2} |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3794 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
|
3795 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
|
3796 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
|
3797 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
|
3798 {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
|
3799 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3800 :echo fmod(12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3801 < 0.13 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3802 :echo fmod(-12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3803 < -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
|
3804 {only available when compiled with |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3805 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3806 |
| 1586 | 3807 fnameescape({string}) *fnameescape()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3808 Escape {string} for use as file name command argument. All |
| 1586 | 3809 characters that have a special meaning, such as '%' and '|' |
| 3810 are escaped with a backslash. | |
| 1621 | 3811 For most systems the characters escaped are |
| 3812 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
| 3813 appears in a filename, it depends on the value of 'isfname'. | |
| 1700 | 3814 A leading '+' and '>' is also escaped (special after |:edit| |
| 3815 and |:write|). And a "-" by itself (special after |:cd|). | |
| 1586 | 3816 Example: > |
| 1700 | 3817 :let fname = '+some str%nge|name' |
| 1586 | 3818 :exe "edit " . fnameescape(fname) |
| 3819 < results in executing: > | |
| 1700 | 3820 edit \+some\ str\%nge\|name |
| 1586 | 3821 |
| 7 | 3822 fnamemodify({fname}, {mods}) *fnamemodify()* |
| 3823 Modify file name {fname} according to {mods}. {mods} is a | |
| 3824 string of characters like it is used for file names on the | |
| 3825 command line. See |filename-modifiers|. | |
| 3826 Example: > | |
| 3827 :echo fnamemodify("main.c", ":p:h") | |
| 3828 < results in: > | |
| 3829 /home/mool/vim/vim/src | |
| 1621 | 3830 < Note: Environment variables don't work in {fname}, use |
| 7 | 3831 |expand()| first then. |
| 3832 | |
| 3833 foldclosed({lnum}) *foldclosed()* | |
| 3834 The result is a Number. If the line {lnum} is in a closed | |
| 3835 fold, the result is the number of the first line in that fold. | |
| 3836 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 3837 | |
| 3838 foldclosedend({lnum}) *foldclosedend()* | |
| 3839 The result is a Number. If the line {lnum} is in a closed | |
| 3840 fold, the result is the number of the last line in that fold. | |
| 3841 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 3842 | |
| 3843 foldlevel({lnum}) *foldlevel()* | |
| 3844 The result is a Number, which is the foldlevel of line {lnum} | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3845 in the current buffer. For nested folds the deepest level is |
| 7 | 3846 returned. If there is no fold at line {lnum}, zero is |
| 3847 returned. It doesn't matter if the folds are open or closed. | |
| 3848 When used while updating folds (from 'foldexpr') -1 is | |
| 3849 returned for lines where folds are still to be updated and the | |
| 3850 foldlevel is unknown. As a special case the level of the | |
| 3851 previous line is usually available. | |
| 3852 | |
| 3853 *foldtext()* | |
| 3854 foldtext() Returns a String, to be displayed for a closed fold. This is | |
| 3855 the default function used for the 'foldtext' option and should | |
| 3856 only be called from evaluating 'foldtext'. It uses the | |
| 3857 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
| 3858 The returned string looks like this: > | |
| 3859 +-- 45 lines: abcdef | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3860 < The number of dashes depends on the foldlevel. The "45" is |
| 7 | 3861 the number of lines in the fold. "abcdef" is the text in the |
| 3862 first non-blank line of the fold. Leading white space, "//" | |
| 3863 or "/*" and the text from the 'foldmarker' and 'commentstring' | |
| 3864 options is removed. | |
| 3865 {not available when compiled without the |+folding| feature} | |
| 3866 | |
| 29 | 3867 foldtextresult({lnum}) *foldtextresult()* |
| 3868 Returns the text that is displayed for the closed fold at line | |
| 3869 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
| 3870 When there is no closed fold at {lnum} an empty string is | |
| 3871 returned. | |
| 3872 {lnum} is used like with |getline()|. Thus "." is the current | |
| 3873 line, "'m" mark m, etc. | |
| 3874 Useful when exporting folded text, e.g., to HTML. | |
| 3875 {not available when compiled without the |+folding| feature} | |
| 3876 | |
| 7 | 3877 *foreground()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3878 foreground() Move the Vim window to the foreground. Useful when sent from |
| 7 | 3879 a client to a Vim server. |remote_send()| |
| 3880 On Win32 systems this might not work, the OS does not always | |
| 3881 allow a window to bring itself to the foreground. Use | |
| 3882 |remote_foreground()| instead. | |
| 3883 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 3884 Win32 console version} | |
| 3885 | |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
3886 *funcref()* |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
3887 funcref({name} [, {arglist}] [, {dict}]) |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
3888 Just like |function()|, but the returned Funcref will lookup |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
3889 the function by reference, not by name. This matters when the |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
3890 function {name} is redefined later. |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
3891 |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
3892 Unlike |function()|, {name} must be an existing user function. |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
3893 Also for autoloaded functions. {name} cannot be a builtin |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
3894 function. |
| 82 | 3895 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3896 *function()* *E700* *E922* *E923* |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3897 function({name} [, {arglist}] [, {dict}]) |
| 685 | 3898 Return a |Funcref| variable that refers to function {name}. |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3899 {name} can be the name of a user defined function or an |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3900 internal function. |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3901 |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
3902 {name} can also be a Funcref or a partial. When it is a |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3903 partial the dict stored in it will be used and the {dict} |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3904 argument is not allowed. E.g.: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3905 let FuncWithArg = function(dict.Func, [arg]) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3906 let Broken = function(dict.Func, [arg], dict) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3907 < |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
3908 When using the Funcref the function will be found by {name}, |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
3909 also when it was redefined later. Use |funcref()| to keep the |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
3910 same function. |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
3911 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3912 When {arglist} or {dict} is present this creates a partial. |
|
9097
071f9da012fb
commit https://github.com/vim/vim/commit/06d2d38ab7564e1f784b1058a4ef4580cd6d1810
Christian Brabandt <cb@256bit.org>
parents:
9076
diff
changeset
|
3913 That means the argument list and/or the dictionary is stored in |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3914 the Funcref and will be used when the Funcref is called. |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3915 |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3916 The arguments are passed to the function in front of other |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3917 arguments. Example: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3918 func Callback(arg1, arg2, name) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3919 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3920 let Func = function('Callback', ['one', 'two']) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3921 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3922 call Func('name') |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3923 < Invokes the function as with: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3924 call Callback('one', 'two', 'name') |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3925 |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3926 < The function() call can be nested to add more arguments to the |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3927 Funcref. The extra arguments are appended to the list of |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3928 arguments. Example: > |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3929 func Callback(arg1, arg2, name) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3930 ... |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3931 let Func = function('Callback', ['one']) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3932 let Func2 = function(Func, ['two']) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3933 ... |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3934 call Func2('name') |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3935 < Invokes the function as with: > |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3936 call Callback('one', 'two', 'name') |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3937 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3938 < The Dictionary is only useful when calling a "dict" function. |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3939 In that case the {dict} is passed in as "self". Example: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3940 function Callback() dict |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3941 echo "called for " . self.name |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3942 endfunction |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3943 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3944 let context = {"name": "example"} |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3945 let Func = function('Callback', context) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3946 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3947 call Func() " will echo: called for example |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3948 < The use of function() is not needed when there are no extra |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3949 arguments, these two are equivalent: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3950 let Func = function('Callback', context) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3951 let Func = context.Callback |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3952 |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3953 < The argument list and the Dictionary can be combined: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3954 function Callback(arg1, count) dict |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3955 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3956 let context = {"name": "example"} |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3957 let Func = function('Callback', ['one'], context) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3958 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3959 call Func(500) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3960 < Invokes the function as with: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3961 call context.Callback('one', 500) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
3962 |
| 82 | 3963 |
| 3224 | 3964 garbagecollect([{atexit}]) *garbagecollect()* |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3965 Cleanup unused |Lists|, |Dictionaries|, |Channels| and |Jobs| |
|
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3966 that have circular references. |
|
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3967 |
|
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3968 There is hardly ever a need to invoke this function, as it is |
|
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3969 automatically done when Vim runs out of memory or is waiting |
|
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3970 for the user to press a key after 'updatetime'. Items without |
|
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3971 circular references are always freed when they become unused. |
| 685 | 3972 This is useful if you have deleted a very big |List| and/or |
| 3973 |Dictionary| with circular references in a script that runs | |
| 3974 for a long time. | |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3975 |
| 3224 | 3976 When the optional {atexit} argument is one, garbage |
| 1405 | 3977 collection will also be done when exiting Vim, if it wasn't |
| 3978 done before. This is useful when checking for memory leaks. | |
| 370 | 3979 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
3980 The garbage collection is not done immediately but only when |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
3981 it's safe to perform. This is when waiting for the user to |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
3982 type a character. To force garbage collection immediately use |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
3983 |test_garbagecollect_now()|. |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
3984 |
| 140 | 3985 get({list}, {idx} [, {default}]) *get()* |
| 685 | 3986 Get item {idx} from |List| {list}. When this item is not |
| 82 | 3987 available return {default}. Return zero when {default} is |
| 3988 omitted. | |
| 102 | 3989 get({dict}, {key} [, {default}]) |
| 685 | 3990 Get item with key {key} from |Dictionary| {dict}. When this |
| 102 | 3991 item is not available return {default}. Return zero when |
| 3992 {default} is omitted. | |
|
9117
0cc48b3cd884
commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents:
9110
diff
changeset
|
3993 get({func}, {what}) |
|
0cc48b3cd884
commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents:
9110
diff
changeset
|
3994 Get an item with from Funcref {func}. Possible values for |
|
9110
6d3888e2232c
commit https://github.com/vim/vim/commit/2bbf8eff6fab16d86e7bcfc0da1962d31bec7891
Christian Brabandt <cb@256bit.org>
parents:
9108
diff
changeset
|
3995 {what} are: |
|
9117
0cc48b3cd884
commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents:
9110
diff
changeset
|
3996 'name' The function name |
|
9110
6d3888e2232c
commit https://github.com/vim/vim/commit/2bbf8eff6fab16d86e7bcfc0da1962d31bec7891
Christian Brabandt <cb@256bit.org>
parents:
9108
diff
changeset
|
3997 'func' The function |
|
6d3888e2232c
commit https://github.com/vim/vim/commit/2bbf8eff6fab16d86e7bcfc0da1962d31bec7891
Christian Brabandt <cb@256bit.org>
parents:
9108
diff
changeset
|
3998 'dict' The dictionary |
|
6d3888e2232c
commit https://github.com/vim/vim/commit/2bbf8eff6fab16d86e7bcfc0da1962d31bec7891
Christian Brabandt <cb@256bit.org>
parents:
9108
diff
changeset
|
3999 'args' The list with arguments |
| 102 | 4000 |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4001 *getbufinfo()* |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4002 getbufinfo([{expr}]) |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4003 getbufinfo([{dict}]) |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4004 Get information about buffers as a List of Dictionaries. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4005 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4006 Without an argument information about all the buffers is |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4007 returned. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4008 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4009 When the argument is a Dictionary only the buffers matching |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4010 the specified criteria are returned. The following keys can |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4011 be specified in {dict}: |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4012 buflisted include only listed buffers. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4013 bufloaded include only loaded buffers. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4014 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4015 Otherwise, {expr} specifies a particular buffer to return |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4016 information for. For the use of {expr}, see |bufname()| |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4017 above. If the buffer is found the returned List has one item. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4018 Otherwise the result is an empty list. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4019 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4020 Each returned List item is a dictionary with the following |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4021 entries: |
|
9904
24900147aa44
commit https://github.com/vim/vim/commit/339288377072f66ec88e21903e75a82d23ffbf4f
Christian Brabandt <cb@256bit.org>
parents:
9894
diff
changeset
|
4022 bufnr buffer number. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4023 changed TRUE if the buffer is modified. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4024 changedtick number of changes made to the buffer. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4025 hidden TRUE if the buffer is hidden. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4026 listed TRUE if the buffer is listed. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4027 lnum current line number in buffer. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4028 loaded TRUE if the buffer is loaded. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4029 name full path to the file in the buffer. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4030 signs list of signs placed in the buffer. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4031 Each list item is a dictionary with |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4032 the following fields: |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4033 id sign identifier |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4034 lnum line number |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4035 name sign name |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4036 variables a reference to the dictionary with |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4037 buffer-local variables. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4038 windows list of |window-ID|s that display this |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4039 buffer |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4040 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4041 Examples: > |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4042 for buf in getbufinfo() |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4043 echo buf.name |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4044 endfor |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4045 for buf in getbufinfo({'buflisted':1}) |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4046 if buf.changed |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4047 .... |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4048 endif |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4049 endfor |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4050 < |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4051 To get buffer-local options use: > |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4052 getbufvar({bufnr}, '&') |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4053 |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4054 < |
| 435 | 4055 *getbufline()* |
| 4056 getbufline({expr}, {lnum} [, {end}]) | |
| 685 | 4057 Return a |List| with the lines starting from {lnum} to {end} |
| 4058 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
| 4059 |List| with only the line {lnum} is returned. | |
| 435 | 4060 |
| 4061 For the use of {expr}, see |bufname()| above. | |
| 4062 | |
| 448 | 4063 For {lnum} and {end} "$" can be used for the last line of the |
| 4064 buffer. Otherwise a number must be used. | |
| 435 | 4065 |
| 4066 When {lnum} is smaller than 1 or bigger than the number of | |
| 685 | 4067 lines in the buffer, an empty |List| is returned. |
| 435 | 4068 |
| 4069 When {end} is greater than the number of lines in the buffer, | |
| 4070 it is treated as {end} is set to the number of lines in the | |
| 685 | 4071 buffer. When {end} is before {lnum} an empty |List| is |
| 435 | 4072 returned. |
| 4073 | |
| 448 | 4074 This function works only for loaded buffers. For unloaded and |
| 685 | 4075 non-existing buffers, an empty |List| is returned. |
| 435 | 4076 |
| 4077 Example: > | |
| 4078 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
| 82 | 4079 |
| 4157 | 4080 getbufvar({expr}, {varname} [, {def}]) *getbufvar()* |
| 82 | 4081 The result is the value of option or local buffer variable |
| 4082 {varname} in buffer {expr}. Note that the name without "b:" | |
| 4083 must be used. | |
| 1668 | 4084 When {varname} is empty returns a dictionary with all the |
| 4085 buffer-local variables. | |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4086 When {varname} is equal to "&" returns a dictionary with all |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4087 the buffer-local options. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4088 Otherwise, when {varname} starts with "&" returns the value of |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4089 a buffer-local option. |
| 216 | 4090 This also works for a global or buffer-local option, but it |
| 4091 doesn't work for a global variable, window-local variable or | |
| 4092 window-local option. | |
| 82 | 4093 For the use of {expr}, see |bufname()| above. |
| 4157 | 4094 When the buffer or variable doesn't exist {def} or an empty |
| 4095 string is returned, there is no error message. | |
| 82 | 4096 Examples: > |
| 4097 :let bufmodified = getbufvar(1, "&mod") | |
| 4098 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
| 4099 < | |
| 7 | 4100 getchar([expr]) *getchar()* |
| 867 | 4101 Get a single character from the user or input stream. |
| 7 | 4102 If [expr] is omitted, wait until a character is available. |
| 4103 If [expr] is 0, only get a character when one is available. | |
| 867 | 4104 Return zero otherwise. |
| 7 | 4105 If [expr] is 1, only check if a character is available, it is |
| 867 | 4106 not consumed. Return zero if no character available. |
| 4107 | |
| 5555 | 4108 Without [expr] and when [expr] is 0 a whole character or |
| 867 | 4109 special key is returned. If it is an 8-bit character, the |
| 4110 result is a number. Use nr2char() to convert it to a String. | |
| 4111 Otherwise a String is returned with the encoded character. | |
| 4112 For a special key it's a sequence of bytes starting with 0x80 | |
| 872 | 4113 (decimal: 128). This is the same value as the string |
| 4114 "\<Key>", e.g., "\<Left>". The returned value is also a | |
| 4115 String when a modifier (shift, control, alt) was used that is | |
| 4116 not included in the character. | |
| 867 | 4117 |
| 5968 | 4118 When [expr] is 0 and Esc is typed, there will be a short delay |
| 4119 while Vim waits to see if this is the start of an escape | |
| 4120 sequence. | |
| 4121 | |
| 5555 | 4122 When [expr] is 1 only the first byte is returned. For a |
| 872 | 4123 one-byte character it is the character itself as a number. |
| 4124 Use nr2char() to convert it to a String. | |
| 867 | 4125 |
| 3224 | 4126 Use getcharmod() to obtain any additional modifiers. |
| 4127 | |
| 1029 | 4128 When the user clicks a mouse button, the mouse event will be |
| 4129 returned. The position can then be found in |v:mouse_col|, | |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
4130 |v:mouse_lnum|, |v:mouse_winid| and |v:mouse_win|. This |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
4131 example positions the mouse as it would normally happen: > |
| 1029 | 4132 let c = getchar() |
| 1621 | 4133 if c == "\<LeftMouse>" && v:mouse_win > 0 |
| 1029 | 4134 exe v:mouse_win . "wincmd w" |
| 4135 exe v:mouse_lnum | |
| 4136 exe "normal " . v:mouse_col . "|" | |
| 4137 endif | |
| 4138 < | |
| 7 | 4139 There is no prompt, you will somehow have to make clear to the |
| 4140 user that a character has to be typed. | |
| 4141 There is no mapping for the character. | |
| 4142 Key codes are replaced, thus when the user presses the <Del> | |
| 4143 key you get the code for the <Del> key, not the raw character | |
| 4144 sequence. Examples: > | |
| 4145 getchar() == "\<Del>" | |
| 4146 getchar() == "\<S-Left>" | |
| 4147 < This example redefines "f" to ignore case: > | |
| 4148 :nmap f :call FindChar()<CR> | |
| 4149 :function FindChar() | |
| 4150 : let c = nr2char(getchar()) | |
| 4151 : while col('.') < col('$') - 1 | |
| 4152 : normal l | |
| 4153 : if getline('.')[col('.') - 1] ==? c | |
| 4154 : break | |
| 4155 : endif | |
| 4156 : endwhile | |
| 4157 :endfunction | |
| 6421 | 4158 < |
| 6647 | 4159 You may also receive synthetic characters, such as |
| 6421 | 4160 |<CursorHold>|. Often you will want to ignore this and get |
| 4161 another character: > | |
| 4162 :function GetKey() | |
| 4163 : let c = getchar() | |
| 4164 : while c == "\<CursorHold>" | |
| 4165 : let c = getchar() | |
| 4166 : endwhile | |
| 4167 : return c | |
| 4168 :endfunction | |
| 7 | 4169 |
| 4170 getcharmod() *getcharmod()* | |
| 4171 The result is a Number which is the state of the modifiers for | |
| 4172 the last obtained character with getchar() or in another way. | |
| 4173 These values are added together: | |
| 4174 2 shift | |
| 4175 4 control | |
| 4176 8 alt (meta) | |
| 3224 | 4177 16 meta (when it's different from ALT) |
| 4178 32 mouse double click | |
| 4179 64 mouse triple click | |
| 4180 96 mouse quadruple click (== 32 + 64) | |
| 4181 128 command (Macintosh only) | |
| 7 | 4182 Only the modifiers that have not been included in the |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4183 character itself are obtained. Thus Shift-a results in "A" |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4184 without a modifier. |
| 7 | 4185 |
| 6991 | 4186 getcharsearch() *getcharsearch()* |
| 4187 Return the current character search information as a {dict} | |
| 4188 with the following entries: | |
| 4189 | |
| 4190 char character previously used for a character | |
| 4191 search (|t|, |f|, |T|, or |F|); empty string | |
| 4192 if no character search has been performed | |
| 4193 forward direction of character search; 1 for forward, | |
| 4194 0 for backward | |
| 4195 until type of character search; 1 for a |t| or |T| | |
| 4196 character search, 0 for an |f| or |F| | |
| 4197 character search | |
| 4198 | |
| 4199 This can be useful to always have |;| and |,| search | |
| 4200 forward/backward regardless of the direction of the previous | |
| 4201 character search: > | |
| 4202 :nnoremap <expr> ; getcharsearch().forward ? ';' : ',' | |
| 4203 :nnoremap <expr> , getcharsearch().forward ? ',' : ';' | |
| 4204 < Also see |setcharsearch()|. | |
| 4205 | |
| 7 | 4206 getcmdline() *getcmdline()* |
| 4207 Return the current command-line. Only works when the command | |
| 4208 line is being edited, thus requires use of |c_CTRL-\_e| or | |
| 4209 |c_CTRL-R_=|. | |
| 4210 Example: > | |
| 4211 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
| 531 | 4212 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
| 7 | 4213 |
| 95 | 4214 getcmdpos() *getcmdpos()* |
| 7 | 4215 Return the position of the cursor in the command line as a |
| 4216 byte count. The first column is 1. | |
| 4217 Only works when editing the command line, thus requires use of | |
| 3456 | 4218 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 4219 Returns 0 otherwise. | |
| 531 | 4220 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
| 4221 | |
| 4222 getcmdtype() *getcmdtype()* | |
| 4223 Return the current command-line type. Possible return values | |
| 4224 are: | |
| 532 | 4225 : normal Ex command |
| 4226 > debug mode command |debug-mode| | |
| 4227 / forward search command | |
| 4228 ? backward search command | |
| 4229 @ |input()| command | |
| 4230 - |:insert| or |:append| command | |
| 6213 | 4231 = |i_CTRL-R_=| |
| 531 | 4232 Only works when editing the command line, thus requires use of |
| 3456 | 4233 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 4234 Returns an empty string otherwise. | |
| 531 | 4235 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. |
| 7 | 4236 |
| 6153 | 4237 getcmdwintype() *getcmdwintype()* |
| 4238 Return the current |command-line-window| type. Possible return | |
| 4239 values are the same as |getcmdtype()|. Returns an empty string | |
| 4240 when not in the command-line window. | |
| 4241 | |
|
9861
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
4242 getcompletion({pat}, {type} [, {filtered}]) *getcompletion()* |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4243 Return a list of command-line completion matches. {type} |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4244 specifies what for. The following completion types are |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4245 supported: |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4246 |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4247 augroup autocmd groups |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4248 buffer buffer names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4249 behave :behave suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4250 color color schemes |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4251 command Ex command (and arguments) |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4252 compiler compilers |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4253 cscope |:cscope| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4254 dir directory names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4255 environment environment variable names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4256 event autocommand events |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4257 expression Vim expression |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4258 file file and directory names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4259 file_in_path file and directory names in |'path'| |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4260 filetype filetype names |'filetype'| |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4261 function function name |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4262 help help subjects |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4263 highlight highlight groups |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4264 history :history suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4265 locale locale names (as output of locale -a) |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4266 mapping mapping name |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4267 menu menus |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4268 option options |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4269 shellcmd Shell command |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4270 sign |:sign| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4271 syntax syntax file names |'syntax'| |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4272 syntime |:syntime| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4273 tag tags |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4274 tag_listfiles tags, file names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4275 user user names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4276 var user variables |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4277 |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4278 If {pat} is an empty string, then all the matches are returned. |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4279 Otherwise only items matching {pat} are returned. See |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4280 |wildcards| for the use of special characters in {pat}. |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4281 |
|
9861
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
4282 If the optional {filtered} flag is set to 1, then 'wildignore' |
|
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
4283 is applied to filter the results. Otherwise all the matches |
|
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
4284 are returned. The 'wildignorecase' option always applies. |
|
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
4285 |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4286 If there are no matches, an empty list is returned. An |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4287 invalid value for {type} produces an error. |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4288 |
| 5944 | 4289 *getcurpos()* |
| 4290 getcurpos() Get the position of the cursor. This is like getpos('.'), but | |
| 4291 includes an extra item in the list: | |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
7593
diff
changeset
|
4292 [bufnum, lnum, col, off, curswant] ~ |
| 5944 | 4293 The "curswant" number is the preferred column when moving the |
| 4294 cursor vertically. | |
| 4295 This can be used to save and restore the cursor position: > | |
| 4296 let save_cursor = getcurpos() | |
| 4297 MoveTheCursorAround | |
| 4298 call setpos('.', save_cursor) | |
| 6153 | 4299 < |
| 7 | 4300 *getcwd()* |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4301 getcwd([{winnr} [, {tabnr}]]) |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4302 The result is a String, which is the name of the current |
| 7 | 4303 working directory. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4304 Without arguments, for the current window. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4305 |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4306 With {winnr} return the local current directory of this window |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4307 in the current tab page. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4308 With {winnr} and {tabnr} return the local current directory of |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4309 the window in the specified tab page. |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4310 {winnr} can be the window number or the |window-ID|. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4311 Return an empty string if the arguments are invalid. |
| 7 | 4312 |
| 4313 getfsize({fname}) *getfsize()* | |
| 4314 The result is a Number, which is the size in bytes of the | |
| 4315 given file {fname}. | |
| 4316 If {fname} is a directory, 0 is returned. | |
| 4317 If the file {fname} can't be found, -1 is returned. | |
| 1293 | 4318 If the size of {fname} is too big to fit in a Number then -2 |
| 4319 is returned. | |
| 7 | 4320 |
| 37 | 4321 getfontname([{name}]) *getfontname()* |
| 4322 Without an argument returns the name of the normal font being | |
| 4323 used. Like what is used for the Normal highlight group | |
| 4324 |hl-Normal|. | |
| 4325 With an argument a check is done whether {name} is a valid | |
| 4326 font name. If not then an empty string is returned. | |
| 4327 Otherwise the actual font name is returned, or {name} if the | |
| 4328 GUI does not support obtaining the real name. | |
| 824 | 4329 Only works when the GUI is running, thus not in your vimrc or |
| 819 | 4330 gvimrc file. Use the |GUIEnter| autocommand to use this |
| 4331 function just after the GUI has started. | |
| 37 | 4332 Note that the GTK 2 GUI accepts any font name, thus checking |
| 4333 for a valid name does not work. | |
| 4334 | |
| 20 | 4335 getfperm({fname}) *getfperm()* |
| 4336 The result is a String, which is the read, write, and execute | |
| 4337 permissions of the given file {fname}. | |
| 4338 If {fname} does not exist or its directory cannot be read, an | |
| 4339 empty string is returned. | |
| 4340 The result is of the form "rwxrwxrwx", where each group of | |
| 4341 "rwx" flags represent, in turn, the permissions of the owner | |
| 4342 of the file, the group the file belongs to, and other users. | |
| 4343 If a user does not have a given permission the flag for this | |
| 3750 | 4344 is replaced with the string "-". Examples: > |
| 20 | 4345 :echo getfperm("/etc/passwd") |
| 3750 | 4346 :echo getfperm(expand("~/.vimrc")) |
| 20 | 4347 < This will hopefully (from a security point of view) display |
| 4348 the string "rw-r--r--" or even "rw-------". | |
| 205 | 4349 |
|
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
4350 For setting permissins use |setfperm()|. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
4351 |
| 7 | 4352 getftime({fname}) *getftime()* |
| 4353 The result is a Number, which is the last modification time of | |
| 4354 the given file {fname}. The value is measured as seconds | |
| 4355 since 1st Jan 1970, and may be passed to strftime(). See also | |
| 4356 |localtime()| and |strftime()|. | |
| 4357 If the file {fname} can't be found -1 is returned. | |
| 4358 | |
| 20 | 4359 getftype({fname}) *getftype()* |
| 4360 The result is a String, which is a description of the kind of | |
| 4361 file of the given file {fname}. | |
| 4362 If {fname} does not exist an empty string is returned. | |
| 4363 Here is a table over different kinds of files and their | |
| 4364 results: | |
| 4365 Normal file "file" | |
| 4366 Directory "dir" | |
| 4367 Symbolic link "link" | |
| 4368 Block device "bdev" | |
| 4369 Character device "cdev" | |
| 4370 Socket "socket" | |
| 4371 FIFO "fifo" | |
| 4372 All other "other" | |
| 4373 Example: > | |
| 4374 getftype("/home") | |
| 4375 < Note that a type such as "link" will only be returned on | |
| 4376 systems that support it. On some systems only "dir" and | |
|
7707
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
4377 "file" are returned. On MS-Windows a symbolic link to a |
|
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
4378 directory returns "dir" instead of "link". |
| 20 | 4379 |
| 7 | 4380 *getline()* |
| 82 | 4381 getline({lnum} [, {end}]) |
| 4382 Without {end} the result is a String, which is line {lnum} | |
| 4383 from the current buffer. Example: > | |
| 7 | 4384 getline(1) |
| 4385 < When {lnum} is a String that doesn't start with a | |
| 4386 digit, line() is called to translate the String into a Number. | |
| 4387 To get the line under the cursor: > | |
| 4388 getline(".") | |
| 4389 < When {lnum} is smaller than 1 or bigger than the number of | |
| 4390 lines in the buffer, an empty string is returned. | |
| 4391 | |
| 685 | 4392 When {end} is given the result is a |List| where each item is |
| 4393 a line from the current buffer in the range {lnum} to {end}, | |
| 82 | 4394 including line {end}. |
| 4395 {end} is used in the same way as {lnum}. | |
| 4396 Non-existing lines are silently omitted. | |
| 685 | 4397 When {end} is before {lnum} an empty |List| is returned. |
| 82 | 4398 Example: > |
| 4399 :let start = line('.') | |
| 4400 :let end = search("^$") - 1 | |
| 4401 :let lines = getline(start, end) | |
| 4402 | |
| 1156 | 4403 < To get lines from another buffer see |getbufline()| |
| 4404 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4405 getloclist({nr}[, {what}]) *getloclist()* |
| 647 | 4406 Returns a list with all the entries in the location list for |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4407 window {nr}. {nr} can be the window number or the |window-ID|. |
|
9223
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
4408 When {nr} is zero the current window is used. |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
4409 |
| 647 | 4410 For a location list window, the displayed location list is |
| 648 | 4411 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
|
4412 returned. Otherwise, same as |getqflist()|. |
| 82 | 4413 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4414 If the optional {what} dictionary argument is supplied, then |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4415 returns the items listed in {what} as a dictionary. Refer to |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4416 |getqflist()| for the supported items in {what}. |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4417 |
| 1326 | 4418 getmatches() *getmatches()* |
| 4419 Returns a |List| with all matches previously defined by | |
| 4420 |matchadd()| and the |:match| commands. |getmatches()| is | |
| 4421 useful in combination with |setmatches()|, as |setmatches()| | |
| 4422 can restore a list of matches saved by |getmatches()|. | |
| 4423 Example: > | |
| 4424 :echo getmatches() | |
| 4425 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 4426 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 4427 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 4428 :let m = getmatches() | |
| 4429 :call clearmatches() | |
| 4430 :echo getmatches() | |
| 4431 < [] > | |
| 4432 :call setmatches(m) | |
| 4433 :echo getmatches() | |
| 4434 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 4435 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 4436 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 4437 :unlet m | |
| 4438 < | |
| 5968 | 4439 *getpid()* |
| 4440 getpid() Return a Number which is the process ID of the Vim process. | |
| 4441 On Unix and MS-Windows this is a unique number, until Vim | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4442 exits. On MS-DOS it's always zero. |
| 5968 | 4443 |
| 4444 *getpos()* | |
| 4445 getpos({expr}) Get the position for {expr}. For possible values of {expr} | |
| 4446 see |line()|. For getting the cursor position see | |
| 4447 |getcurpos()|. | |
| 4448 The result is a |List| with four numbers: | |
| 4449 [bufnum, lnum, col, off] | |
| 4450 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
| 4451 is the buffer number of the mark. | |
| 4452 "lnum" and "col" are the position in the buffer. The first | |
| 4453 column is 1. | |
| 4454 The "off" number is zero, unless 'virtualedit' is used. Then | |
| 4455 it is the offset in screen columns from the start of the | |
| 4456 character. E.g., a position within a <Tab> or after the last | |
| 4457 character. | |
| 4458 Note that for '< and '> Visual mode matters: when it is "V" | |
| 4459 (visual line mode) the column of '< is zero and the column of | |
| 4460 '> is a large number. | |
| 4461 This can be used to save and restore the position of a mark: > | |
| 4462 let save_a_mark = getpos("'a") | |
| 4463 ... | |
| 6421 | 4464 call setpos("'a", save_a_mark) |
| 5968 | 4465 < Also see |getcurpos()| and |setpos()|. |
| 4466 | |
| 1326 | 4467 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4468 getqflist([{what}]) *getqflist()* |
| 230 | 4469 Returns a list with all the current quickfix errors. Each |
| 4470 list item is a dictionary with these entries: | |
| 4471 bufnr number of buffer that has the file name, use | |
| 4472 bufname() to get the name | |
| 4473 lnum line number in the buffer (first line is 1) | |
| 4474 col column number (first column is 1) | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4475 vcol |TRUE|: "col" is visual column |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4476 |FALSE|: "col" is byte index |
| 230 | 4477 nr error number |
| 1065 | 4478 pattern search pattern used to locate the error |
| 230 | 4479 text description of the error |
| 4480 type type of the error, 'E', '1', etc. | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4481 valid |TRUE|: recognized error message |
| 230 | 4482 |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4483 When there is no error list or it's empty, an empty list is |
| 1065 | 4484 returned. Quickfix list entries with non-existing buffer |
| 4485 number are returned with "bufnr" set to zero. | |
| 515 | 4486 |
| 230 | 4487 Useful application: Find pattern matches in multiple files and |
| 4488 do something with them: > | |
| 4489 :vimgrep /theword/jg *.c | |
| 4490 :for d in getqflist() | |
| 4491 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
| 4492 :endfor | |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4493 < |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4494 If the optional {what} dictionary argument is supplied, then |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4495 returns only the items listed in {what} as a dictionary. The |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4496 following string items are supported in {what}: |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4497 nr get information for this quickfix list |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4498 title get the list title |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4499 winid get the |window-ID| (if opened) |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4500 all all of the above quickfix properties |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4501 Non-string items in {what} are ignored. |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4502 If "nr" is not present then the current quickfix list is used. |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4503 In case of error processing {what}, an empty dictionary is |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4504 returned. |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4505 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4506 The returned dictionary contains the following entries: |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4507 nr quickfix list number |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4508 title quickfix list title text |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4509 winid quickfix |window-ID| (if opened) |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4510 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4511 Examples: > |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4512 :echo getqflist({'all': 1}) |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4513 :echo getqflist({'nr': 2, 'title': 1}) |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4514 < |
| 230 | 4515 |
| 5796 | 4516 getreg([{regname} [, 1 [, {list}]]]) *getreg()* |
| 7 | 4517 The result is a String, which is the contents of register |
| 236 | 4518 {regname}. Example: > |
| 7 | 4519 :let cliptext = getreg('*') |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
4520 < When {regname} was not set the result is an empty string. |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4521 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4522 getreg('=') returns the last evaluated value of the expression |
| 236 | 4523 register. (For use in maps.) |
| 282 | 4524 getreg('=', 1) returns the expression itself, so that it can |
| 4525 be restored with |setreg()|. For other registers the extra | |
| 4526 argument is ignored, thus you can always give it. | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4527 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4528 If {list} is present and |TRUE|, the result type is changed |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4529 to |List|. Each list item is one text line. Use it if you care |
| 5796 | 4530 about zero bytes possibly present inside register: without |
| 4531 third argument both NLs and zero bytes are represented as NLs | |
| 4532 (see |NL-used-for-Nul|). | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4533 When the register was not set an empty list is returned. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4534 |
| 7 | 4535 If {regname} is not specified, |v:register| is used. |
| 4536 | |
| 82 | 4537 |
| 7 | 4538 getregtype([{regname}]) *getregtype()* |
| 4539 The result is a String, which is type of register {regname}. | |
| 4540 The value will be one of: | |
| 4541 "v" for |characterwise| text | |
| 4542 "V" for |linewise| text | |
| 4543 "<CTRL-V>{width}" for |blockwise-visual| text | |
| 5596 | 4544 "" for an empty or unknown register |
| 7 | 4545 <CTRL-V> is one character with value 0x16. |
| 4546 If {regname} is not specified, |v:register| is used. | |
| 4547 | |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4548 gettabinfo([{arg}]) *gettabinfo()* |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4549 If {arg} is not specified, then information about all the tab |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4550 pages is returned as a List. Each List item is a Dictionary. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4551 Otherwise, {arg} specifies the tab page number and information |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4552 about that one is returned. If the tab page does not exist an |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4553 empty List is returned. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4554 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4555 Each List item is a Dictionary with the following entries: |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4556 tabnr tab page number. |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4557 variables a reference to the dictionary with |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4558 tabpage-local variables |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4559 windows List of |window-ID|s in the tag page. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4560 |
| 4157 | 4561 gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()* |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
4562 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
|
4563 {tabnr}. |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
4564 Tabs are numbered starting with one. |
| 6197 | 4565 When {varname} is empty a dictionary with all tab-local |
| 4566 variables is returned. | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
4567 Note that the name without "t:" must be used. |
| 4157 | 4568 When the tab or variable doesn't exist {def} or an empty |
| 4569 string is returned, there is no error message. | |
| 4570 | |
| 4571 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()* | |
| 1156 | 4572 Get the value of window-local variable {varname} in window |
| 4573 {winnr} in tab page {tabnr}. | |
| 4157 | 4574 When {varname} is empty a dictionary with all window-local |
| 4575 variables is returned. | |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4576 When {varname} is equal to "&" get the values of all |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4577 window-local options in a Dictionary. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4578 Otherwise, when {varname} starts with "&" get the value of a |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4579 window-local option. |
| 4157 | 4580 Note that {varname} must be the name without "w:". |
| 831 | 4581 Tabs are numbered starting with one. For the current tabpage |
| 4582 use |getwinvar()|. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4583 {winnr} can be the window number or the |window-ID|. |
| 831 | 4584 When {winnr} is zero the current window is used. |
| 4585 This also works for a global option, buffer-local option and | |
| 4586 window-local option, but it doesn't work for a global variable | |
| 4587 or buffer-local variable. | |
| 4157 | 4588 When the tab, window or variable doesn't exist {def} or an |
| 4589 empty string is returned, there is no error message. | |
| 831 | 4590 Examples: > |
| 4591 :let list_is_on = gettabwinvar(1, 2, '&list') | |
| 4592 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
| 1266 | 4593 < |
| 7 | 4594 *getwinposx()* |
| 4595 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
| 4596 the left hand side of the GUI Vim window. The result will be | |
| 4597 -1 if the information is not available. | |
| 4598 | |
| 4599 *getwinposy()* | |
| 4600 getwinposy() The result is a Number, which is the Y coordinate in pixels of | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4601 the top of the GUI Vim window. The result will be -1 if the |
| 7 | 4602 information is not available. |
| 4603 | |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4604 getwininfo([{winid}]) *getwininfo()* |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4605 Returns information about windows as a List with Dictionaries. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4606 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4607 If {winid} is given Information about the window with that ID |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4608 is returned. If the window does not exist the result is an |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4609 empty list. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4610 |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4611 Without {winid} information about all the windows in all the |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4612 tab pages is returned. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4613 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4614 Each List item is a Dictionary with the following entries: |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4615 bufnr number of buffer in the window |
|
9881
4b53f6be10c0
commit https://github.com/vim/vim/commit/386600f0cbcb8add099c723cf84634f46df2f788
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
4616 height window height |
|
4b53f6be10c0
commit https://github.com/vim/vim/commit/386600f0cbcb8add099c723cf84634f46df2f788
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
4617 loclist 1 if showing a location list |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
4618 {only with the +quickfix feature} |
|
9881
4b53f6be10c0
commit https://github.com/vim/vim/commit/386600f0cbcb8add099c723cf84634f46df2f788
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
4619 quickfix 1 if quickfix or location list window |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
4620 {only with the +quickfix feature} |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4621 tabnr tab page number |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4622 variables a reference to the dictionary with |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4623 window-local variables |
|
9881
4b53f6be10c0
commit https://github.com/vim/vim/commit/386600f0cbcb8add099c723cf84634f46df2f788
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
4624 width window width |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4625 winid |window-ID| |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4626 winnr window number |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4627 |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4628 To obtain all window-local variables use: > |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4629 gettabwinvar({tabnr}, {winnr}, '&') |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4630 |
| 4157 | 4631 getwinvar({winnr}, {varname} [, {def}]) *getwinvar()* |
| 831 | 4632 Like |gettabwinvar()| for the current tabpage. |
| 7 | 4633 Examples: > |
| 4634 :let list_is_on = getwinvar(2, '&list') | |
| 4635 :echo "myvar = " . getwinvar(1, 'myvar') | |
| 4636 < | |
| 6663 | 4637 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()* |
| 1754 | 4638 Expand the file wildcards in {expr}. See |wildcards| for the |
| 1156 | 4639 use of special characters. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4640 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4641 Unless the optional {nosuf} argument is given and is |TRUE|, |
| 1754 | 4642 the 'suffixes' and 'wildignore' options apply: Names matching |
| 4643 one of the patterns in 'wildignore' will be skipped and | |
| 4644 'suffixes' affect the ordering of matches. | |
| 2662 | 4645 'wildignorecase' always applies. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4646 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4647 When {list} is present and it is |TRUE| the result is a List |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4648 with all matching files. The advantage of using a List is, |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4649 you also get filenames containing newlines correctly. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4650 Otherwise the result is a String and when there are several |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4651 matches, they are separated by <NL> characters. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4652 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4653 If the expansion fails, the result is an empty String or List. |
| 6663 | 4654 |
| 3445 | 4655 A name for a non-existing file is not included. A symbolic |
| 4656 link is only included if it points to an existing file. | |
| 6663 | 4657 However, when the {alllinks} argument is present and it is |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4658 |TRUE| then all symbolic links are included. |
| 7 | 4659 |
| 4660 For most systems backticks can be used to get files names from | |
| 4661 any external command. Example: > | |
| 4662 :let tagfiles = glob("`find . -name tags -print`") | |
| 4663 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
| 4664 < The result of the program inside the backticks should be one | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4665 item per line. Spaces inside an item are allowed. |
| 7 | 4666 |
| 4667 See |expand()| for expanding special Vim variables. See | |
| 4668 |system()| for getting the raw output of an external command. | |
| 4669 | |
| 6697 | 4670 glob2regpat({expr}) *glob2regpat()* |
| 4671 Convert a file pattern, as used by glob(), into a search | |
| 4672 pattern. The result can be used to match with a string that | |
| 4673 is a file name. E.g. > | |
| 4674 if filename =~ glob2regpat('Make*.mak') | |
| 4675 < This is equivalent to: > | |
| 4676 if filename =~ '^Make.*\.mak$' | |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
4677 < When {expr} is an empty string the result is "^$", match an |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
4678 empty string. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4679 Note that the result depends on the system. On MS-Windows |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4680 a backslash usually means a path separator. |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
4681 |
| 6663 | 4682 *globpath()* |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4683 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 7 | 4684 Perform glob() on all directories in {path} and concatenate |
| 4685 the results. Example: > | |
| 4686 :echo globpath(&rtp, "syntax/c.vim") | |
| 5873 | 4687 < |
| 4688 {path} is a comma-separated list of directory names. Each | |
| 7 | 4689 directory name is prepended to {expr} and expanded like with |
| 1754 | 4690 |glob()|. A path separator is inserted when needed. |
| 7 | 4691 To add a comma inside a directory name escape it with a |
| 4692 backslash. Note that on MS-Windows a directory may have a | |
| 4693 trailing backslash, remove it if you put a comma after it. | |
| 4694 If the expansion fails for one of the directories, there is no | |
| 4695 error message. | |
| 5873 | 4696 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4697 Unless the optional {nosuf} argument is given and is |TRUE|, |
| 1754 | 4698 the 'suffixes' and 'wildignore' options apply: Names matching |
| 4699 one of the patterns in 'wildignore' will be skipped and | |
| 4700 'suffixes' affect the ordering of matches. | |
| 7 | 4701 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4702 When {list} is present and it is |TRUE| the result is a List |
| 5873 | 4703 with all matching files. The advantage of using a List is, you |
| 4704 also get filenames containing newlines correctly. Otherwise | |
| 4705 the result is a String and when there are several matches, | |
| 4706 they are separated by <NL> characters. Example: > | |
| 4707 :echo globpath(&rtp, "syntax/c.vim", 0, 1) | |
| 4708 < | |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4709 {alllinks} is used as with |glob()|. |
| 6663 | 4710 |
| 444 | 4711 The "**" item can be used to search in a directory tree. |
| 4712 For example, to find all "README.txt" files in the directories | |
| 4713 in 'runtimepath' and below: > | |
| 4714 :echo globpath(&rtp, "**/README.txt") | |
| 1668 | 4715 < Upwards search and limiting the depth of "**" is not |
| 4716 supported, thus using 'path' will not always work properly. | |
| 4717 | |
| 7 | 4718 *has()* |
| 4719 has({feature}) The result is a Number, which is 1 if the feature {feature} is | |
| 4720 supported, zero otherwise. The {feature} argument is a | |
| 4721 string. See |feature-list| below. | |
| 4722 Also see |exists()|. | |
| 4723 | |
| 102 | 4724 |
| 4725 has_key({dict}, {key}) *has_key()* | |
| 685 | 4726 The result is a Number, which is 1 if |Dictionary| {dict} has |
| 4727 an entry with key {key}. Zero otherwise. | |
| 102 | 4728 |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4729 haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()* |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4730 The result is a Number, which is 1 when the window has set a |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4731 local path via |:lcd|, and 0 otherwise. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4732 |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4733 Without arguments use the current window. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4734 With {winnr} use this window in the current tab page. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4735 With {winnr} and {tabnr} use the window in the specified tab |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4736 page. |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4737 {winnr} can be the window number or the |window-ID|. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4738 Return 0 if the arguments are invalid. |
| 102 | 4739 |
| 782 | 4740 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
| 7 | 4741 The result is a Number, which is 1 if there is a mapping that |
| 4742 contains {what} in somewhere in the rhs (what it is mapped to) | |
| 4743 and this mapping exists in one of the modes indicated by | |
| 4744 {mode}. | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4745 When {abbr} is there and it is |TRUE| use abbreviations |
| 786 | 4746 instead of mappings. Don't forget to specify Insert and/or |
| 4747 Command-line mode. | |
| 7 | 4748 Both the global mappings and the mappings local to the current |
| 4749 buffer are checked for a match. | |
| 4750 If no matching mapping is found 0 is returned. | |
| 4751 The following characters are recognized in {mode}: | |
| 4752 n Normal mode | |
| 4753 v Visual mode | |
| 4754 o Operator-pending mode | |
| 4755 i Insert mode | |
| 4756 l Language-Argument ("r", "f", "t", etc.) | |
| 4757 c Command-line mode | |
| 4758 When {mode} is omitted, "nvo" is used. | |
| 4759 | |
| 4760 This function is useful to check if a mapping already exists | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4761 to a function in a Vim script. Example: > |
| 7 | 4762 :if !hasmapto('\ABCdoit') |
| 4763 : map <Leader>d \ABCdoit | |
| 4764 :endif | |
| 4765 < This installs the mapping to "\ABCdoit" only if there isn't | |
| 4766 already a mapping to "\ABCdoit". | |
| 4767 | |
| 4768 histadd({history}, {item}) *histadd()* | |
| 4769 Add the String {item} to the history {history} which can be | |
| 4770 one of: *hist-names* | |
| 4771 "cmd" or ":" command line history | |
| 4772 "search" or "/" search pattern history | |
| 1621 | 4773 "expr" or "=" typed expression history |
| 7 | 4774 "input" or "@" input line history |
| 3682 | 4775 "debug" or ">" debug command history |
| 4776 The {history} string does not need to be the whole name, one | |
| 4777 character is sufficient. | |
| 7 | 4778 If {item} does already exist in the history, it will be |
| 4779 shifted to become the newest entry. | |
| 4780 The result is a Number: 1 if the operation was successful, | |
| 4781 otherwise 0 is returned. | |
| 4782 | |
| 4783 Example: > | |
| 4784 :call histadd("input", strftime("%Y %b %d")) | |
| 4785 :let date=input("Enter date: ") | |
| 4786 < This function is not available in the |sandbox|. | |
| 4787 | |
| 4788 histdel({history} [, {item}]) *histdel()* | |
| 236 | 4789 Clear {history}, i.e. delete all its entries. See |hist-names| |
| 7 | 4790 for the possible values of {history}. |
| 4791 | |
| 1668 | 4792 If the parameter {item} evaluates to a String, it is used as a |
| 4793 regular expression. All entries matching that expression will | |
| 4794 be removed from the history (if there are any). | |
| 7 | 4795 Upper/lowercase must match, unless "\c" is used |/\c|. |
| 1668 | 4796 If {item} evaluates to a Number, it will be interpreted as |
| 4797 an index, see |:history-indexing|. The respective entry will | |
| 4798 be removed if it exists. | |
| 7 | 4799 |
| 4800 The result is a Number: 1 for a successful operation, | |
| 4801 otherwise 0 is returned. | |
| 4802 | |
| 4803 Examples: | |
| 4804 Clear expression register history: > | |
| 4805 :call histdel("expr") | |
| 4806 < | |
| 4807 Remove all entries starting with "*" from the search history: > | |
| 4808 :call histdel("/", '^\*') | |
| 4809 < | |
| 4810 The following three are equivalent: > | |
| 4811 :call histdel("search", histnr("search")) | |
| 4812 :call histdel("search", -1) | |
| 4813 :call histdel("search", '^'.histget("search", -1).'$') | |
| 4814 < | |
| 4815 To delete the last search pattern and use the last-but-one for | |
| 4816 the "n" command and 'hlsearch': > | |
| 4817 :call histdel("search", -1) | |
| 4818 :let @/ = histget("search", -1) | |
| 4819 | |
| 4820 histget({history} [, {index}]) *histget()* | |
| 4821 The result is a String, the entry with Number {index} from | |
| 4822 {history}. See |hist-names| for the possible values of | |
| 4823 {history}, and |:history-indexing| for {index}. If there is | |
| 4824 no such entry, an empty String is returned. When {index} is | |
| 4825 omitted, the most recent item from the history is used. | |
| 4826 | |
| 4827 Examples: | |
| 4828 Redo the second last search from history. > | |
| 4829 :execute '/' . histget("search", -2) | |
| 4830 | |
| 4831 < Define an Ex command ":H {num}" that supports re-execution of | |
| 4832 the {num}th entry from the output of |:history|. > | |
| 4833 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
| 4834 < | |
| 4835 histnr({history}) *histnr()* | |
| 4836 The result is the Number of the current entry in {history}. | |
| 4837 See |hist-names| for the possible values of {history}. | |
| 4838 If an error occurred, -1 is returned. | |
| 4839 | |
| 4840 Example: > | |
| 4841 :let inp_index = histnr("expr") | |
| 4842 < | |
| 4843 hlexists({name}) *hlexists()* | |
| 4844 The result is a Number, which is non-zero if a highlight group | |
| 4845 called {name} exists. This is when the group has been | |
| 4846 defined in some way. Not necessarily when highlighting has | |
| 4847 been defined for it, it may also have been used for a syntax | |
| 4848 item. | |
| 4849 *highlight_exists()* | |
| 4850 Obsolete name: highlight_exists(). | |
| 4851 | |
| 4852 *hlID()* | |
| 4853 hlID({name}) The result is a Number, which is the ID of the highlight group | |
| 4854 with name {name}. When the highlight group doesn't exist, | |
| 4855 zero is returned. | |
| 4856 This can be used to retrieve information about the highlight | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4857 group. For example, to get the background color of the |
| 7 | 4858 "Comment" group: > |
| 4859 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
| 4860 < *highlightID()* | |
| 4861 Obsolete name: highlightID(). | |
| 4862 | |
| 4863 hostname() *hostname()* | |
| 4864 The result is a String, which is the name of the machine on | |
| 236 | 4865 which Vim is currently running. Machine names greater than |
| 7 | 4866 256 characters long are truncated. |
| 4867 | |
| 4868 iconv({expr}, {from}, {to}) *iconv()* | |
| 4869 The result is a String, which is the text {expr} converted | |
| 4870 from encoding {from} to encoding {to}. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4871 When the conversion completely fails an empty string is |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4872 returned. When some characters could not be converted they |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4873 are replaced with "?". |
| 7 | 4874 The encoding names are whatever the iconv() library function |
| 4875 can accept, see ":!man 3 iconv". | |
| 4876 Most conversions require Vim to be compiled with the |+iconv| | |
| 4877 feature. Otherwise only UTF-8 to latin1 conversion and back | |
| 4878 can be done. | |
| 4879 This can be used to display messages with special characters, | |
| 4880 no matter what 'encoding' is set to. Write the message in | |
| 4881 UTF-8 and use: > | |
| 4882 echo iconv(utf8_str, "utf-8", &enc) | |
| 4883 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
| 4884 from/to UCS-2 is automatically changed to use UTF-8. You | |
| 4885 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
|
4886 {only available when compiled with the |+multi_byte| feature} |
| 7 | 4887 |
| 4888 *indent()* | |
| 4889 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
| 4890 current buffer. The indent is counted in spaces, the value | |
| 4891 of 'tabstop' is relevant. {lnum} is used just like in | |
| 4892 |getline()|. | |
| 4893 When {lnum} is invalid -1 is returned. | |
| 4894 | |
| 79 | 4895 |
| 95 | 4896 index({list}, {expr} [, {start} [, {ic}]]) *index()* |
| 685 | 4897 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
|
4898 value equal to {expr}. There is no automatic conversion, so |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4899 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
|
4900 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
|
4901 is not used here, case always matters. |
| 153 | 4902 If {start} is given then start looking at the item with index |
| 4903 {start} (may be negative for an item relative to the end). | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4904 When {ic} is given and it is |TRUE|, ignore case. Otherwise |
| 79 | 4905 case must match. |
| 4906 -1 is returned when {expr} is not found in {list}. | |
| 4907 Example: > | |
| 4908 :let idx = index(words, "the") | |
| 87 | 4909 :if index(numbers, 123) >= 0 |
| 79 | 4910 |
| 4911 | |
| 531 | 4912 input({prompt} [, {text} [, {completion}]]) *input()* |
| 7 | 4913 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
|
4914 the command-line. The {prompt} argument is either a prompt |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4915 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
|
4916 in the prompt to start a new line. |
| 531 | 4917 The highlighting set with |:echohl| is used for the prompt. |
| 4918 The input is entered just like a command-line, with the same | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4919 editing commands and mappings. There is a separate history |
| 531 | 4920 for lines typed for input(). |
| 4921 Example: > | |
| 4922 :if input("Coffee or beer? ") == "beer" | |
| 4923 : echo "Cheers!" | |
| 4924 :endif | |
| 4925 < | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4926 If the optional {text} argument is present and not empty, this |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4927 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
|
4928 Example: > |
| 531 | 4929 :let color = input("Color? ", "white") |
| 4930 | |
| 4931 < The optional {completion} argument specifies the type of | |
| 4932 completion supported for the input. Without it completion is | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4933 not performed. The supported completion types are the same as |
| 531 | 4934 that can be supplied to a user-defined command using the |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4935 "-complete=" argument. Refer to |:command-completion| for |
| 531 | 4936 more information. Example: > |
| 4937 let fname = input("File: ", "", "file") | |
| 4938 < | |
| 4939 NOTE: This function must not be used in a startup file, for | |
| 4940 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
| 7 | 4941 Note: When input() is called from within a mapping it will |
| 4942 consume remaining characters from that mapping, because a | |
| 4943 mapping is handled like the characters were typed. | |
| 4944 Use |inputsave()| before input() and |inputrestore()| | |
| 4945 after input() to avoid that. Another solution is to avoid | |
| 4946 that further characters follow in the mapping, e.g., by using | |
| 4947 |:execute| or |:normal|. | |
| 4948 | |
| 531 | 4949 Example with a mapping: > |
| 7 | 4950 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
| 4951 :function GetFoo() | |
| 4952 : call inputsave() | |
| 4953 : let g:Foo = input("enter search pattern: ") | |
| 4954 : call inputrestore() | |
| 4955 :endfunction | |
| 4956 | |
| 4957 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4958 Like |input()|, but when the GUI is running and text dialogs |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4959 are supported, a dialog window pops up to input the text. |
| 7 | 4960 Example: > |
| 3875 | 4961 :let n = inputdialog("value for shiftwidth", shiftwidth()) |
| 4962 :if n != "" | |
| 4963 : let &sw = n | |
| 4964 :endif | |
| 7 | 4965 < When the dialog is cancelled {cancelreturn} is returned. When |
| 4966 omitted an empty string is returned. | |
| 4967 Hitting <Enter> works like pressing the OK button. Hitting | |
| 4968 <Esc> works like pressing the Cancel button. | |
| 531 | 4969 NOTE: Command-line completion is not supported. |
| 7 | 4970 |
| 519 | 4971 inputlist({textlist}) *inputlist()* |
| 819 | 4972 {textlist} must be a |List| of strings. This |List| is |
| 4973 displayed, one string per line. The user will be prompted to | |
| 4974 enter a number, which is returned. | |
| 519 | 4975 The user can also select an item by clicking on it with the |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4976 mouse. For the first string 0 is returned. When clicking |
| 519 | 4977 above the first item a negative number is returned. When |
| 4978 clicking on the prompt one more than the length of {textlist} | |
| 4979 is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4980 Make sure {textlist} has less than 'lines' entries, otherwise |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4981 it won't work. It's a good idea to put the entry number at |
| 1156 | 4982 the start of the string. And put a prompt in the first item. |
| 4983 Example: > | |
| 519 | 4984 let color = inputlist(['Select color:', '1. red', |
| 4985 \ '2. green', '3. blue']) | |
| 4986 | |
| 7 | 4987 inputrestore() *inputrestore()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4988 Restore typeahead that was saved with a previous |inputsave()|. |
| 7 | 4989 Should be called the same number of times inputsave() is |
| 4990 called. Calling it more often is harmless though. | |
| 4991 Returns 1 when there is nothing to restore, 0 otherwise. | |
| 4992 | |
| 4993 inputsave() *inputsave()* | |
| 4994 Preserve typeahead (also from mappings) and clear it, so that | |
| 4995 a following prompt gets input from the user. Should be | |
| 4996 followed by a matching inputrestore() after the prompt. Can | |
| 4997 be used several times, in which case there must be just as | |
| 4998 many inputrestore() calls. | |
| 4999 Returns 1 when out of memory, 0 otherwise. | |
| 5000 | |
| 5001 inputsecret({prompt} [, {text}]) *inputsecret()* | |
| 5002 This function acts much like the |input()| function with but | |
| 5003 two exceptions: | |
| 5004 a) the user's response will be displayed as a sequence of | |
| 5005 asterisks ("*") thereby keeping the entry secret, and | |
| 5006 b) the user's response will not be recorded on the input | |
| 5007 |history| stack. | |
| 5008 The result is a String, which is whatever the user actually | |
| 5009 typed on the command-line in response to the issued prompt. | |
| 531 | 5010 NOTE: Command-line completion is not supported. |
| 7 | 5011 |
| 55 | 5012 insert({list}, {item} [, {idx}]) *insert()* |
| 685 | 5013 Insert {item} at the start of |List| {list}. |
| 55 | 5014 If {idx} is specified insert {item} before the item with index |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
5015 {idx}. If {idx} is zero it goes before the first item, just |
| 55 | 5016 like omitting {idx}. A negative {idx} is also possible, see |
| 5017 |list-index|. -1 inserts just before the last item. | |
| 685 | 5018 Returns the resulting |List|. Examples: > |
| 55 | 5019 :let mylist = insert([2, 3, 5], 1) |
| 5020 :call insert(mylist, 4, -1) | |
| 5021 :call insert(mylist, 6, len(mylist)) | |
| 82 | 5022 < The last example can be done simpler with |add()|. |
| 685 | 5023 Note that when {item} is a |List| it is inserted as a single |
| 692 | 5024 item. Use |extend()| to concatenate |Lists|. |
| 55 | 5025 |
| 3214 | 5026 invert({expr}) *invert()* |
| 5027 Bitwise invert. The argument is converted to a number. A | |
| 5028 List, Dict or Float argument causes an error. Example: > | |
| 5029 :let bits = invert(bits) | |
| 5030 | |
| 7 | 5031 isdirectory({directory}) *isdirectory()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5032 The result is a Number, which is |TRUE| when a directory |
| 7 | 5033 with the name {directory} exists. If {directory} doesn't |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5034 exist, or isn't a directory, the result is |FALSE|. {directory} |
| 7 | 5035 is any expression, which is used as a String. |
| 5036 | |
| 819 | 5037 islocked({expr}) *islocked()* *E786* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5038 The result is a Number, which is |TRUE| when {expr} is the |
| 148 | 5039 name of a locked variable. |
| 685 | 5040 {expr} must be the name of a variable, |List| item or |
| 5041 |Dictionary| entry, not the variable itself! Example: > | |
| 148 | 5042 :let alist = [0, ['a', 'b'], 2, 3] |
| 5043 :lockvar 1 alist | |
| 5044 :echo islocked('alist') " 1 | |
| 5045 :echo islocked('alist[1]') " 0 | |
| 5046 | |
| 5047 < When {expr} is a variable that does not exist you get an error | |
| 843 | 5048 message. Use |exists()| to check for existence. |
| 148 | 5049 |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5050 isnan({expr}) *isnan()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5051 Return |TRUE| if {expr} is a float with value NaN. > |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5052 echo isnan(0.0 / 0.0) |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5053 < 1 ~ |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5054 |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5055 {only available when compiled with the |+float| feature} |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5056 |
| 140 | 5057 items({dict}) *items()* |
| 685 | 5058 Return a |List| with all the key-value pairs of {dict}. Each |
| 5059 |List| item is a list with two items: the key of a {dict} | |
| 5060 entry and the value of this entry. The |List| is in arbitrary | |
| 5061 order. | |
| 140 | 5062 |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5063 job_getchannel({job}) *job_getchannel()* |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5064 Get the channel handle that {job} is using. |
|
8497
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8451
diff
changeset
|
5065 To check if the job has no channel: > |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8451
diff
changeset
|
5066 if string(job_getchannel()) == 'channel fail' |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8451
diff
changeset
|
5067 < |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5068 {only available when compiled with the |+job| feature} |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5069 |
|
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5070 job_info({job}) *job_info()* |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5071 Returns a Dictionary with information about {job}: |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5072 "status" what |job_status()| returns |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5073 "channel" what |job_getchannel()| returns |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5074 "exitval" only valid when "status" is "dead" |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
5075 "exit_cb" function to be called on exit |
|
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5076 "stoponexit" |job-stoponexit| |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5077 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5078 job_setoptions({job}, {options}) *job_setoptions()* |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5079 Change options for {job}. Supported are: |
|
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5080 "stoponexit" |job-stoponexit| |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
5081 "exit_cb" |job-exit_cb| |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5082 |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5083 job_start({command} [, {options}]) *job_start()* |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5084 Start a job and return a Job object. Unlike |system()| and |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5085 |:!cmd| this does not wait for the job to finish. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5086 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5087 {command} can be a String. This works best on MS-Windows. On |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5088 Unix it is split up in white-separated parts to be passed to |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5089 execvp(). Arguments in double quotes can contain white space. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5090 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5091 {command} can be a List, where the first item is the executable |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5092 and further items are the arguments. All items are converted |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5093 to String. This works best on Unix. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5094 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5095 On MS-Windows, job_start() makes a GUI application hidden. If |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5096 want to show it, Use |:!start| instead. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5097 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5098 The command is executed directly, not through a shell, the |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5099 'shell' option is not used. To use the shell: > |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5100 let job = job_start(["/bin/sh", "-c", "echo hello"]) |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5101 < Or: > |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5102 let job = job_start('/bin/sh -c "echo hello"') |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5103 < Note that this will start two processes, the shell and the |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5104 command it executes. If you don't want this use the "exec" |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5105 shell command. |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5106 |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5107 On Unix $PATH is used to search for the executable only when |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5108 the command does not contain a slash. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5109 |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5110 The job will use the same terminal as Vim. If it reads from |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5111 stdin the job and Vim will be fighting over input, that |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5112 doesn't work. Redirect stdin and stdout to avoid problems: > |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5113 let job = job_start(['sh', '-c', "myserver </dev/null >/dev/null"]) |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5114 < |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5115 The returned Job object can be used to get the status with |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5116 |job_status()| and stop the job with |job_stop()|. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5117 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5118 {options} must be a Dictionary. It can contain many optional |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5119 items, see |job-options|. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5120 |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5121 {only available when compiled with the |+job| feature} |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5122 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5123 job_status({job}) *job_status()* *E916* |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5124 Returns a String with the status of {job}: |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5125 "run" job is running |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5126 "fail" job failed to start |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5127 "dead" job died or was stopped after running |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5128 |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
5129 On Unix a non-existing command results in "dead" instead of |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
5130 "fail", because a fork happens before the failure can be |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
5131 detected. |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
5132 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5133 If an exit callback was set with the "exit_cb" option and the |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5134 job is now detected to be "dead" the callback will be invoked. |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5135 |
|
8502
ee5cb2e9ed5a
commit https://github.com/vim/vim/commit/8950a563b306ce76f259573d91c2ddccdf52e32e
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
5136 For more information see |job_info()|. |
|
ee5cb2e9ed5a
commit https://github.com/vim/vim/commit/8950a563b306ce76f259573d91c2ddccdf52e32e
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
5137 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5138 {only available when compiled with the |+job| feature} |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5139 |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5140 job_stop({job} [, {how}]) *job_stop()* |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5141 Stop the {job}. This can also be used to signal the job. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5142 |
|
8251
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5143 When {how} is omitted or is "term" the job will be terminated. |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5144 For Unix SIGTERM is sent. On MS-Windows the job will be |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5145 terminated forcedly (there is no "gentle" way). |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5146 This goes to the process group, thus children may also be |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5147 affected. |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5148 |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5149 Effect for Unix: |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5150 "term" SIGTERM (default) |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5151 "hup" SIGHUP |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5152 "quit" SIGQUIT |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5153 "int" SIGINT |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5154 "kill" SIGKILL (strongest way to stop) |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5155 number signal with that number |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5156 |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5157 Effect for MS-Windows: |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5158 "term" terminate process forcedly (default) |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5159 "hup" CTRL_BREAK |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5160 "quit" CTRL_BREAK |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5161 "int" CTRL_C |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5162 "kill" terminate process forcedly |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5163 Others CTRL_BREAK |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5164 |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5165 On Unix the signal is sent to the process group. This means |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5166 that when the job is "sh -c command" it affects both the shell |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5167 and the command. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5168 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5169 The result is a Number: 1 if the operation could be executed, |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5170 0 if "how" is not supported on the system. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5171 Note that even when the operation was executed, whether the |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5172 job was actually stopped needs to be checked with |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5173 job_status(). |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5174 The status of the job isn't checked, the operation will even |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5175 be done when Vim thinks the job isn't running. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5176 |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5177 {only available when compiled with the |+job| feature} |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5178 |
| 95 | 5179 join({list} [, {sep}]) *join()* |
| 5180 Join the items in {list} together into one String. | |
| 5181 When {sep} is specified it is put in between the items. If | |
| 5182 {sep} is omitted a single space is used. | |
| 5183 Note that {sep} is not added at the end. You might want to | |
| 5184 add it there too: > | |
| 5185 let lines = join(mylist, "\n") . "\n" | |
| 692 | 5186 < String items are used as-is. |Lists| and |Dictionaries| are |
| 95 | 5187 converted into a string like with |string()|. |
| 5188 The opposite function is |split()|. | |
| 5189 | |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5190 js_decode({string}) *js_decode()* |
|
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5191 This is similar to |json_decode()| with these differences: |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5192 - Object key names do not have to be in quotes. |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5193 - Empty items in an array (between two commas) are allowed and |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5194 result in v:none items. |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5195 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5196 js_encode({expr}) *js_encode()* |
|
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5197 This is similar to |json_encode()| with these differences: |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5198 - Object key names are not in quotes. |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5199 - v:none items in an array result in an empty item between |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5200 commas. |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5201 For example, the Vim object: |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5202 [1,v:none,{"one":1},v:none] ~ |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5203 Will be encoded as: |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5204 [1,,{one:1},,] ~ |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5205 While json_encode() would produce: |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5206 [1,null,{"one":1},null] ~ |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5207 This encoding is valid for JavaScript. It is more efficient |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5208 than JSON, especially when using an array with optional items. |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5209 |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5210 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5211 json_decode({string}) *json_decode()* |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5212 This parses a JSON formatted string and returns the equivalent |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5213 in Vim values. See |json_encode()| for the relation between |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5214 JSON and Vim values. |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5215 The decoding is permissive: |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5216 - A trailing comma in an array and object is ignored. |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5217 - More floating point numbers are recognized, e.g. "1." for |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5218 "1.0". |
|
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
5219 The result must be a valid Vim type: |
|
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
5220 - An empty object member name is not allowed. |
|
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
5221 - Duplicate object member names are not allowed. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5222 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5223 json_encode({expr}) *json_encode()* |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5224 Encode {expr} as JSON and return this as a string. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5225 The encoding is specified in: |
|
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
5226 https://tools.ietf.org/html/rfc7159.html |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5227 Vim values are converted as follows: |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5228 Number decimal number |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5229 Float floating point number |
|
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
5230 Float nan "NaN" |
|
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
5231 Float inf "Infinity" |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5232 String in double quotes (possibly null) |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5233 Funcref not possible, error |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5234 List as an array (possibly null); when |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
5235 used recursively: [] |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5236 Dict as an object (possibly null); when |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
5237 used recursively: {} |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5238 v:false "false" |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5239 v:true "true" |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5240 v:none "null" |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5241 v:null "null" |
|
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
5242 Note that NaN and Infinity are passed on as values. This is |
|
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
5243 missing in the JSON standard, but several implementations do |
|
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
5244 allow it. If not then you will get an error. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5245 |
| 99 | 5246 keys({dict}) *keys()* |
| 685 | 5247 Return a |List| with all the keys of {dict}. The |List| is in |
| 99 | 5248 arbitrary order. |
| 5249 | |
| 85 | 5250 *len()* *E701* |
| 55 | 5251 len({expr}) The result is a Number, which is the length of the argument. |
| 5252 When {expr} is a String or a Number the length in bytes is | |
| 5253 used, as with |strlen()|. | |
| 685 | 5254 When {expr} is a |List| the number of items in the |List| is |
| 55 | 5255 returned. |
| 685 | 5256 When {expr} is a |Dictionary| the number of entries in the |
| 5257 |Dictionary| is returned. | |
| 55 | 5258 Otherwise an error is given. |
| 5259 | |
| 7 | 5260 *libcall()* *E364* *E368* |
| 5261 libcall({libname}, {funcname}, {argument}) | |
| 5262 Call function {funcname} in the run-time library {libname} | |
| 5263 with single argument {argument}. | |
| 5264 This is useful to call functions in a library that you | |
| 5265 especially made to be used with Vim. Since only one argument | |
| 5266 is possible, calling standard library functions is rather | |
| 5267 limited. | |
| 5268 The result is the String returned by the function. If the | |
| 5269 function returns NULL, this will appear as an empty string "" | |
| 5270 to Vim. | |
| 5271 If the function returns a number, use libcallnr()! | |
| 5272 If {argument} is a number, it is passed to the function as an | |
| 5273 int; if {argument} is a string, it is passed as a | |
| 5274 null-terminated string. | |
| 5275 This function will fail in |restricted-mode|. | |
| 5276 | |
| 5277 libcall() allows you to write your own 'plug-in' extensions to | |
| 5278 Vim without having to recompile the program. It is NOT a | |
| 5279 means to call system functions! If you try to do so Vim will | |
| 5280 very probably crash. | |
| 5281 | |
| 5282 For Win32, the functions you write must be placed in a DLL | |
| 5283 and use the normal C calling convention (NOT Pascal which is | |
| 5284 used in Windows System DLLs). The function must take exactly | |
| 5285 one parameter, either a character pointer or a long integer, | |
| 5286 and must return a character pointer or NULL. The character | |
| 5287 pointer returned must point to memory that will remain valid | |
| 5288 after the function has returned (e.g. in static data in the | |
| 5289 DLL). If it points to allocated memory, that memory will | |
| 5290 leak away. Using a static buffer in the function should work, | |
| 5291 it's then freed when the DLL is unloaded. | |
| 5292 | |
| 5293 WARNING: If the function returns a non-valid pointer, Vim may | |
| 1621 | 5294 crash! This also happens if the function returns a number, |
| 7 | 5295 because Vim thinks it's a pointer. |
| 5296 For Win32 systems, {libname} should be the filename of the DLL | |
| 5297 without the ".DLL" suffix. A full path is only required if | |
| 5298 the DLL is not in the usual places. | |
| 5299 For Unix: When compiling your own plugins, remember that the | |
| 5300 object code must be compiled as position-independent ('PIC'). | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5301 {only in Win32 and some Unix versions, when the |+libcall| |
| 7 | 5302 feature is present} |
| 5303 Examples: > | |
| 5304 :echo libcall("libc.so", "getenv", "HOME") | |
| 5305 < | |
| 5306 *libcallnr()* | |
| 5307 libcallnr({libname}, {funcname}, {argument}) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5308 Just like |libcall()|, but used for a function that returns an |
| 7 | 5309 int instead of a string. |
| 5310 {only in Win32 on some Unix versions, when the |+libcall| | |
| 5311 feature is present} | |
| 1621 | 5312 Examples: > |
| 5313 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
| 7 | 5314 :call libcallnr("libc.so", "printf", "Hello World!\n") |
| 5315 :call libcallnr("libc.so", "sleep", 10) | |
| 5316 < | |
| 5317 *line()* | |
| 5318 line({expr}) The result is a Number, which is the line number of the file | |
| 5319 position given with {expr}. The accepted positions are: | |
| 5320 . the cursor position | |
| 5321 $ the last line in the current buffer | |
| 5322 'x position of mark x (if the mark is not set, 0 is | |
| 5323 returned) | |
| 665 | 5324 w0 first line visible in current window |
| 5325 w$ last line visible in current window | |
| 1609 | 5326 v In Visual mode: the start of the Visual area (the |
| 5327 cursor is the end). When not in Visual mode | |
| 5328 returns the cursor position. Differs from |'<| in | |
| 5329 that it's updated right away. | |
| 1156 | 5330 Note that a mark in another file can be used. The line number |
| 5331 then applies to another buffer. | |
| 703 | 5332 To get the column number use |col()|. To get both use |
| 5333 |getpos()|. | |
| 7 | 5334 Examples: > |
| 5335 line(".") line number of the cursor | |
| 5336 line("'t") line number of mark t | |
| 5337 line("'" . marker) line number of mark marker | |
| 5338 < *last-position-jump* | |
| 5339 This autocommand jumps to the last known position in a file | |
| 5340 just after opening it, if the '" mark is set: > | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5341 :au BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g`\"" | endif |
| 9 | 5342 |
| 7 | 5343 line2byte({lnum}) *line2byte()* |
| 5344 Return the byte count from the start of the buffer for line | |
| 5345 {lnum}. This includes the end-of-line character, depending on | |
| 5346 the 'fileformat' option for the current buffer. The first | |
| 3237 | 5347 line returns 1. 'encoding' matters, 'fileencoding' is ignored. |
| 7 | 5348 This can also be used to get the byte count for the line just |
| 5349 below the last line: > | |
| 5350 line2byte(line("$") + 1) | |
| 3237 | 5351 < This is the buffer size plus one. If 'fileencoding' is empty |
| 5352 it is the file size plus one. | |
| 7 | 5353 When {lnum} is invalid, or the |+byte_offset| feature has been |
| 5354 disabled at compile time, -1 is returned. | |
| 5355 Also see |byte2line()|, |go| and |:goto|. | |
| 5356 | |
| 5357 lispindent({lnum}) *lispindent()* | |
| 5358 Get the amount of indent for line {lnum} according the lisp | |
| 5359 indenting rules, as with 'lisp'. | |
| 5360 The indent is counted in spaces, the value of 'tabstop' is | |
| 5361 relevant. {lnum} is used just like in |getline()|. | |
| 5362 When {lnum} is invalid or Vim was not compiled the | |
| 5363 |+lispindent| feature, -1 is returned. | |
| 5364 | |
| 5365 localtime() *localtime()* | |
| 5366 Return the current time, measured as seconds since 1st Jan | |
| 5367 1970. See also |strftime()| and |getftime()|. | |
| 5368 | |
| 95 | 5369 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5370 log({expr}) *log()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5371 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
|
5372 {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
|
5373 (0, inf]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5374 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5375 :echo log(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5376 < 2.302585 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5377 :echo log(exp(5)) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5378 < 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
|
5379 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5380 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5381 |
| 1621 | 5382 log10({expr}) *log10()* |
| 5383 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
| 5384 {expr} must evaluate to a |Float| or a |Number|. | |
| 5385 Examples: > | |
| 5386 :echo log10(1000) | |
| 5387 < 3.0 > | |
| 5388 :echo log10(0.01) | |
| 5389 < -2.0 | |
| 5390 {only available when compiled with the |+float| feature} | |
| 5391 | |
| 3492 | 5392 luaeval({expr}[, {expr}]) *luaeval()* |
| 5393 Evaluate Lua expression {expr} and return its result converted | |
| 5394 to Vim data structures. Second {expr} may hold additional | |
| 5395 argument accessible as _A inside first {expr}. | |
| 5396 Strings are returned as they are. | |
| 5397 Boolean objects are converted to numbers. | |
| 5398 Numbers are converted to |Float| values if vim was compiled | |
| 5399 with |+float| and to numbers otherwise. | |
| 5400 Dictionaries and lists obtained by vim.eval() are returned | |
| 5401 as-is. | |
| 5402 Other objects are returned as zero without any errors. | |
| 5403 See |lua-luaeval| for more details. | |
| 5404 {only available when compiled with the |+lua| feature} | |
| 5405 | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5406 map({expr1}, {expr2}) *map()* |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5407 {expr1} must be a |List| or a |Dictionary|. |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5408 Replace each item in {expr1} with the result of evaluating |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5409 {expr2}. {expr2} must be a |string| or |Funcref|. |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5410 |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5411 If {expr2} is a |string|, inside {expr2} |v:val| has the value |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5412 of the current item. For a |Dictionary| |v:key| has the key |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5413 of the current item and for a |List| |v:key| has the index of |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5414 the current item. |
| 102 | 5415 Example: > |
| 5416 :call map(mylist, '"> " . v:val . " <"') | |
| 95 | 5417 < This puts "> " before and " <" after each item in "mylist". |
| 102 | 5418 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5419 Note that {expr2} is the result of an expression and is then |
| 102 | 5420 used as an expression again. Often it is good to use a |
| 158 | 5421 |literal-string| to avoid having to double backslashes. You |
| 5422 still have to double ' quotes | |
| 102 | 5423 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5424 If {expr2} is a |Funcref| it is called with two arguments: |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5425 1. The key or the index of the current item. |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5426 2. the value of the current item. |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5427 The function must return the new value of the item. Example |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5428 that changes each value by "key-value": > |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5429 func KeyValue(key, val) |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5430 return a:key . '-' . a:val |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5431 endfunc |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5432 call map(myDict, function('KeyValue')) |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5433 < |
| 685 | 5434 The operation is done in-place. If you want a |List| or |
| 5435 |Dictionary| to remain unmodified make a copy first: > | |
| 3682 | 5436 :let tlist = map(copy(mylist), ' v:val . "\t"') |
| 102 | 5437 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5438 < Returns {expr1}, the |List| or |Dictionary| that was filtered. |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5439 When an error is encountered while evaluating {expr2} no |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5440 further items in {expr1} are processed. When {expr2} is a |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5441 Funcref errors inside a function are ignored, unless it was |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5442 defined with the "abort" flag. |
| 95 | 5443 |
| 5444 | |
| 2610 | 5445 maparg({name}[, {mode} [, {abbr} [, {dict}]]]) *maparg()* |
| 5446 When {dict} is omitted or zero: Return the rhs of mapping | |
| 5447 {name} in mode {mode}. The returned String has special | |
| 5448 characters translated like in the output of the ":map" command | |
| 5449 listing. | |
| 5450 | |
| 5451 When there is no mapping for {name}, an empty String is | |
| 5452 returned. | |
| 5453 | |
| 5454 The {name} can have special key names, like in the ":map" | |
| 5455 command. | |
| 5456 | |
| 644 | 5457 {mode} can be one of these strings: |
| 7 | 5458 "n" Normal |
| 2610 | 5459 "v" Visual (including Select) |
| 7 | 5460 "o" Operator-pending |
| 5461 "i" Insert | |
| 5462 "c" Cmd-line | |
| 2610 | 5463 "s" Select |
| 5464 "x" Visual | |
| 7 | 5465 "l" langmap |language-mapping| |
| 5466 "" Normal, Visual and Operator-pending | |
| 644 | 5467 When {mode} is omitted, the modes for "" are used. |
| 2610 | 5468 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5469 When {abbr} is there and it is |TRUE| use abbreviations |
| 782 | 5470 instead of mappings. |
| 2610 | 5471 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5472 When {dict} is there and it is |TRUE| return a dictionary |
| 2610 | 5473 containing all the information of the mapping with the |
| 5474 following items: | |
| 5475 "lhs" The {lhs} of the mapping. | |
| 5476 "rhs" The {rhs} of the mapping as typed. | |
| 5477 "silent" 1 for a |:map-silent| mapping, else 0. | |
| 2625 | 5478 "noremap" 1 if the {rhs} of the mapping is not remappable. |
| 2610 | 5479 "expr" 1 for an expression mapping (|:map-<expr>|). |
| 5480 "buffer" 1 for a buffer local mapping (|:map-local|). | |
| 5481 "mode" Modes for which the mapping is defined. In | |
| 5482 addition to the modes mentioned above, these | |
| 5483 characters will be used: | |
| 5484 " " Normal, Visual and Operator-pending | |
| 5485 "!" Insert and Commandline mode | |
| 2642 | 5486 (|mapmode-ic|) |
| 2625 | 5487 "sid" The script local ID, used for <sid> mappings |
| 5488 (|<SID>|). | |
| 5555 | 5489 "nowait" Do not wait for other, longer mappings. |
| 5490 (|:map-<nowait>|). | |
| 2610 | 5491 |
| 7 | 5492 The mappings local to the current buffer are checked first, |
| 5493 then the global mappings. | |
| 626 | 5494 This function can be used to map a key even when it's already |
| 5495 mapped, and have it do the original mapping too. Sketch: > | |
| 5496 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
| 5497 | |
| 7 | 5498 |
| 782 | 5499 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()* |
| 7 | 5500 Check if there is a mapping that matches with {name} in mode |
| 5501 {mode}. See |maparg()| for {mode} and special names in | |
| 5502 {name}. | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5503 When {abbr} is there and it is |TRUE| use abbreviations |
| 782 | 5504 instead of mappings. |
| 7 | 5505 A match happens with a mapping that starts with {name} and |
| 5506 with a mapping which is equal to the start of {name}. | |
| 5507 | |
| 1621 | 5508 matches mapping "a" "ab" "abc" ~ |
| 7 | 5509 mapcheck("a") yes yes yes |
| 5510 mapcheck("abc") yes yes yes | |
| 5511 mapcheck("ax") yes no no | |
| 5512 mapcheck("b") no no no | |
| 5513 | |
| 5514 The difference with maparg() is that mapcheck() finds a | |
| 5515 mapping that matches with {name}, while maparg() only finds a | |
| 5516 mapping for {name} exactly. | |
| 5517 When there is no mapping that starts with {name}, an empty | |
| 5518 String is returned. If there is one, the rhs of that mapping | |
| 5519 is returned. If there are several mappings that start with | |
| 5520 {name}, the rhs of one of them is returned. | |
| 5521 The mappings local to the current buffer are checked first, | |
| 5522 then the global mappings. | |
| 5523 This function can be used to check if a mapping can be added | |
| 5524 without being ambiguous. Example: > | |
| 5525 :if mapcheck("_vv") == "" | |
| 5526 : map _vv :set guifont=7x13<CR> | |
| 5527 :endif | |
| 5528 < This avoids adding the "_vv" mapping when there already is a | |
| 5529 mapping for "_v" or for "_vvv". | |
| 5530 | |
| 19 | 5531 match({expr}, {pat}[, {start}[, {count}]]) *match()* |
| 685 | 5532 When {expr} is a |List| then this returns the index of the |
| 5533 first item where {pat} matches. Each item is used as a | |
| 692 | 5534 String, |Lists| and |Dictionaries| are used as echoed. |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
5535 Otherwise, {expr} is used as a String. The result is a |
| 95 | 5536 Number, which gives the index (byte offset) in {expr} where |
| 5537 {pat} matches. | |
| 685 | 5538 A match at the first character or |List| item returns zero. |
| 19 | 5539 If there is no match -1 is returned. |
| 2833 | 5540 For getting submatches see |matchlist()|. |
| 19 | 5541 Example: > |
| 95 | 5542 :echo match("testing", "ing") " results in 4 |
| 714 | 5543 :echo match([1, 'x'], '\a') " results in 1 |
| 95 | 5544 < See |string-match| for how {pat} is used. |
| 170 | 5545 *strpbrk()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
5546 Vim doesn't have a strpbrk() function. But you can do: > |
| 170 | 5547 :let sepidx = match(line, '[.,;: \t]') |
| 5548 < *strcasestr()* | |
| 5549 Vim doesn't have a strcasestr() function. But you can add | |
| 5550 "\c" to the pattern to ignore case: > | |
| 5551 :let idx = match(haystack, '\cneedle') | |
| 5552 < | |
| 95 | 5553 If {start} is given, the search starts from byte index |
| 685 | 5554 {start} in a String or item {start} in a |List|. |
| 7 | 5555 The result, however, is still the index counted from the |
| 236 | 5556 first character/item. Example: > |
| 7 | 5557 :echo match("testing", "ing", 2) |
| 5558 < result is again "4". > | |
| 5559 :echo match("testing", "ing", 4) | |
| 5560 < result is again "4". > | |
| 5561 :echo match("testing", "t", 2) | |
| 5562 < result is "3". | |
| 694 | 5563 For a String, if {start} > 0 then it is like the string starts |
| 703 | 5564 {start} bytes later, thus "^" will match at {start}. Except |
| 5565 when {count} is given, then it's like matches before the | |
| 5566 {start} byte are ignored (this is a bit complicated to keep it | |
| 5567 backwards compatible). | |
| 95 | 5568 For a String, if {start} < 0, it will be set to 0. For a list |
| 5569 the index is counted from the end. | |
| 697 | 5570 If {start} is out of range ({start} > strlen({expr}) for a |
| 5571 String or {start} > len({expr}) for a |List|) -1 is returned. | |
| 95 | 5572 |
| 694 | 5573 When {count} is given use the {count}'th match. When a match |
| 697 | 5574 is found in a String the search for the next one starts one |
| 694 | 5575 character further. Thus this example results in 1: > |
| 5576 echo match("testing", "..", 0, 2) | |
| 5577 < In a |List| the search continues in the next item. | |
| 703 | 5578 Note that when {count} is added the way {start} works changes, |
| 5579 see above. | |
| 694 | 5580 |
| 7 | 5581 See |pattern| for the patterns that are accepted. |
| 5582 The 'ignorecase' option is used to set the ignore-caseness of | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
5583 the pattern. 'smartcase' is NOT used. The matching is always |
| 7 | 5584 done like 'magic' is set and 'cpoptions' is empty. |
| 5585 | |
| 1326 | 5586 *matchadd()* *E798* *E799* *E801* |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5587 matchadd({group}, {pattern}[, {priority}[, {id}[, {dict}]]]) |
| 1326 | 5588 Defines a pattern to be highlighted in the current window (a |
| 5589 "match"). It will be highlighted with {group}. Returns an | |
| 5590 identification number (ID), which can be used to delete the | |
| 5591 match using |matchdelete()|. | |
| 5466 | 5592 Matching is case sensitive and magic, unless case sensitivity |
| 5593 or magicness are explicitly overridden in {pattern}. The | |
| 5594 'magic', 'smartcase' and 'ignorecase' options are not used. | |
|
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
5595 The "Conceal" value is special, it causes the match to be |
|
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
5596 concealed. |
| 1326 | 5597 |
| 5598 The optional {priority} argument assigns a priority to the | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
5599 match. A match with a high priority will have its |
| 1326 | 5600 highlighting overrule that of a match with a lower priority. |
| 5601 A priority is specified as an integer (negative numbers are no | |
| 5602 exception). If the {priority} argument is not specified, the | |
| 5603 default priority is 10. The priority of 'hlsearch' is zero, | |
| 5604 hence all matches with a priority greater than zero will | |
| 5605 overrule it. Syntax highlighting (see 'syntax') is a separate | |
| 5606 mechanism, and regardless of the chosen priority a match will | |
| 5607 always overrule syntax highlighting. | |
| 5608 | |
| 5609 The optional {id} argument allows the request for a specific | |
| 5610 match ID. If a specified ID is already taken, an error | |
| 5611 message will appear and the match will not be added. An ID | |
| 5612 is specified as a positive integer (zero excluded). IDs 1, 2 | |
| 5613 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
| 6947 | 5614 respectively. If the {id} argument is not specified or -1, |
| 1326 | 5615 |matchadd()| automatically chooses a free ID. |
| 5616 | |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5617 The optional {dict} argument allows for further custom |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5618 values. Currently this is used to specify a match specific |
| 6947 | 5619 conceal character that will be shown for |hl-Conceal| |
| 5620 highlighted matches. The dict can have the following members: | |
| 5621 | |
| 5622 conceal Special character to show instead of the | |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5623 match (only for |hl-Conceal| highlighted |
| 6947 | 5624 matches, see |:syn-cchar|) |
| 5625 | |
| 1326 | 5626 The number of matches is not limited, as it is the case with |
| 5627 the |:match| commands. | |
| 5628 | |
| 5629 Example: > | |
| 5630 :highlight MyGroup ctermbg=green guibg=green | |
| 5631 :let m = matchadd("MyGroup", "TODO") | |
| 5632 < Deletion of the pattern: > | |
| 5633 :call matchdelete(m) | |
| 5634 | |
| 5635 < A list of matches defined by |matchadd()| and |:match| are | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
5636 available from |getmatches()|. All matches can be deleted in |
| 1326 | 5637 one operation by |clearmatches()|. |
| 819 | 5638 |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
5639 *matchaddpos()* |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
5640 matchaddpos({group}, {pos}[, {priority}[, {id}[, {dict}]]]) |
| 5979 | 5641 Same as |matchadd()|, but requires a list of positions {pos} |
| 5642 instead of a pattern. This command is faster than |matchadd()| | |
| 5643 because it does not require to handle regular expressions and | |
| 5644 sets buffer line boundaries to redraw screen. It is supposed | |
| 5645 to be used when fast match additions and deletions are | |
| 5646 required, for example to highlight matching parentheses. | |
| 5647 | |
| 5648 The list {pos} can contain one of these items: | |
| 6007 | 5649 - A number. This whole line will be highlighted. The first |
| 5979 | 5650 line has number 1. |
| 5651 - A list with one number, e.g., [23]. The whole line with this | |
| 5652 number will be highlighted. | |
| 5653 - A list with two numbers, e.g., [23, 11]. The first number is | |
| 6007 | 5654 the line number, the second one is the column number (first |
| 5655 column is 1, the value must correspond to the byte index as | |
| 5656 |col()| would return). The character at this position will | |
| 5657 be highlighted. | |
| 5979 | 5658 - A list with three numbers, e.g., [23, 11, 3]. As above, but |
| 6007 | 5659 the third number gives the length of the highlight in bytes. |
| 5979 | 5660 |
| 5661 The maximum number of positions is 8. | |
| 5662 | |
| 5663 Example: > | |
| 5664 :highlight MyGroup ctermbg=green guibg=green | |
| 5665 :let m = matchaddpos("MyGroup", [[23, 24], 34]) | |
| 5666 < Deletion of the pattern: > | |
| 5667 :call matchdelete(m) | |
| 5668 | |
| 5669 < Matches added by |matchaddpos()| are returned by | |
| 5670 |getmatches()| with an entry "pos1", "pos2", etc., with the | |
| 5671 value a list like the {pos} item. | |
| 5672 These matches cannot be set via |setmatches()|, however they | |
| 5673 can still be deleted by |clearmatches()|. | |
| 5674 | |
| 819 | 5675 matcharg({nr}) *matcharg()* |
| 856 | 5676 Selects the {nr} match item, as set with a |:match|, |
| 819 | 5677 |:2match| or |:3match| command. |
| 5678 Return a |List| with two elements: | |
| 5679 The name of the highlight group used | |
| 5680 The pattern used. | |
| 5681 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
| 5682 When there is no match item set returns ['', '']. | |
| 1326 | 5683 This is useful to save and restore a |:match|. |
| 5684 Highlighting matches using the |:match| commands are limited | |
| 5685 to three matches. |matchadd()| does not have this limitation. | |
| 5686 | |
| 5687 matchdelete({id}) *matchdelete()* *E802* *E803* | |
| 5688 Deletes a match with ID {id} previously defined by |matchadd()| | |
| 1621 | 5689 or one of the |:match| commands. Returns 0 if successful, |
| 1326 | 5690 otherwise -1. See example for |matchadd()|. All matches can |
| 5691 be deleted in one operation by |clearmatches()|. | |
| 819 | 5692 |
| 19 | 5693 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5694 Same as |match()|, but return the index of first character |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5695 after the match. Example: > |
| 7 | 5696 :echo matchend("testing", "ing") |
| 5697 < results in "7". | |
| 170 | 5698 *strspn()* *strcspn()* |
| 5699 Vim doesn't have a strspn() or strcspn() function, but you can | |
| 5700 do it with matchend(): > | |
| 5701 :let span = matchend(line, '[a-zA-Z]') | |
| 5702 :let span = matchend(line, '[^a-zA-Z]') | |
| 5703 < Except that -1 is returned when there are no matches. | |
| 5704 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5705 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 5706 :echo matchend("testing", "ing", 2) |
| 5707 < results in "7". > | |
| 5708 :echo matchend("testing", "ing", 5) | |
| 5709 < result is "-1". | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5710 When {expr} is a |List| the result is equal to |match()|. |
| 7 | 5711 |
| 158 | 5712 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5713 Same as |match()|, but return a |List|. The first item in the |
| 158 | 5714 list is the matched string, same as what matchstr() would |
| 5715 return. Following items are submatches, like "\1", "\2", etc. | |
| 842 | 5716 in |:substitute|. When an optional submatch didn't match an |
| 5717 empty string is used. Example: > | |
| 5718 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
| 5719 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
| 158 | 5720 When there is no match an empty list is returned. |
| 5721 | |
| 19 | 5722 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()* |
| 1621 | 5723 Same as |match()|, but return the matched string. Example: > |
| 7 | 5724 :echo matchstr("testing", "ing") |
| 5725 < results in "ing". | |
| 5726 When there is no match "" is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5727 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 5728 :echo matchstr("testing", "ing", 2) |
| 5729 < results in "ing". > | |
| 5730 :echo matchstr("testing", "ing", 5) | |
| 5731 < result is "". | |
| 685 | 5732 When {expr} is a |List| then the matching item is returned. |
| 95 | 5733 The type isn't changed, it's not necessarily a String. |
| 7 | 5734 |
|
8793
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5735 matchstrpos({expr}, {pat}[, {start}[, {count}]]) *matchstrpos()* |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5736 Same as |matchstr()|, but return the matched string, the start |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5737 position and the end position of the match. Example: > |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5738 :echo matchstrpos("testing", "ing") |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5739 < results in ["ing", 4, 7]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5740 When there is no match ["", -1, -1] is returned. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5741 The {start}, if given, has the same meaning as for |match()|. > |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5742 :echo matchstrpos("testing", "ing", 2) |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5743 < results in ["ing", 4, 7]. > |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5744 :echo matchstrpos("testing", "ing", 5) |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5745 < result is ["", -1, -1]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5746 When {expr} is a |List| then the matching item, the index |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5747 of first item where {pat} matches, the start position and the |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5748 end position of the match are returned. > |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5749 :echo matchstrpos([1, '__x'], '\a') |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5750 < result is ["x", 1, 2, 3]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5751 The type isn't changed, it's not necessarily a String. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5752 |
| 87 | 5753 *max()* |
| 5754 max({list}) Return the maximum value of all items in {list}. | |
| 5755 If {list} is not a list or one of the items in {list} cannot | |
| 5756 be used as a Number this results in an error. | |
| 685 | 5757 An empty |List| results in zero. |
| 87 | 5758 |
| 5759 *min()* | |
| 1215 | 5760 min({list}) Return the minimum value of all items in {list}. |
| 87 | 5761 If {list} is not a list or one of the items in {list} cannot |
| 5762 be used as a Number this results in an error. | |
| 685 | 5763 An empty |List| results in zero. |
| 87 | 5764 |
| 843 | 5765 *mkdir()* *E739* |
| 168 | 5766 mkdir({name} [, {path} [, {prot}]]) |
| 5767 Create directory {name}. | |
| 5768 If {path} is "p" then intermediate directories are created as | |
| 5769 necessary. Otherwise it must be "". | |
| 5770 If {prot} is given it is used to set the protection bits of | |
| 5771 the new directory. The default is 0755 (rwxr-xr-x: r/w for | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
5772 the user readable for others). Use 0700 to make it unreadable |
| 1702 | 5773 for others. This is only used for the last part of {name}. |
| 5774 Thus if you create /tmp/foo/bar then /tmp/foo will be created | |
| 5775 with 0755. | |
| 5776 Example: > | |
| 5777 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700) | |
| 5778 < This function is not available in the |sandbox|. | |
| 168 | 5779 Not available on all systems. To check use: > |
| 5780 :if exists("*mkdir") | |
| 5781 < | |
| 7 | 5782 *mode()* |
| 1621 | 5783 mode([expr]) Return a string that indicates the current mode. |
| 1661 | 5784 If [expr] is supplied and it evaluates to a non-zero Number or |
| 5785 a non-empty String (|non-zero-arg|), then the full mode is | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5786 returned, otherwise only the first letter is returned. |
| 1621 | 5787 |
| 7 | 5788 n Normal |
| 1621 | 5789 no Operator-pending |
| 7 | 5790 v Visual by character |
| 5791 V Visual by line | |
| 5792 CTRL-V Visual blockwise | |
| 5793 s Select by character | |
| 5794 S Select by line | |
| 5795 CTRL-S Select blockwise | |
| 5796 i Insert | |
| 1621 | 5797 R Replace |R| |
| 5798 Rv Virtual Replace |gR| | |
| 7 | 5799 c Command-line |
| 1621 | 5800 cv Vim Ex mode |gQ| |
| 5801 ce Normal Ex mode |Q| | |
| 7 | 5802 r Hit-enter prompt |
| 1621 | 5803 rm The -- more -- prompt |
| 5804 r? A |:confirm| query of some sort | |
| 5805 ! Shell or external command is executing | |
| 5806 This is useful in the 'statusline' option or when used | |
| 5807 with |remote_expr()| In most other places it always returns | |
| 5808 "c" or "n". | |
| 5809 Also see |visualmode()|. | |
| 7 | 5810 |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5811 mzeval({expr}) *mzeval()* |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5812 Evaluate MzScheme expression {expr} and return its result |
| 3492 | 5813 converted to Vim data structures. |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5814 Numbers and strings are returned as they are. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5815 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
|
5816 returned as Vim |Lists|. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5817 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
|
5818 converted to strings. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5819 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
|
5820 Examples: > |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5821 :mz (define l (list 1 2 3)) |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5822 :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
|
5823 :echo mzeval("l") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5824 :echo mzeval("h") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5825 < |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5826 {only available when compiled with the |+mzscheme| feature} |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
5827 |
| 7 | 5828 nextnonblank({lnum}) *nextnonblank()* |
| 5829 Return the line number of the first line at or below {lnum} | |
| 5830 that is not blank. Example: > | |
| 5831 if getline(nextnonblank(1)) =~ "Java" | |
| 5832 < When {lnum} is invalid or there is no non-blank line at or | |
| 5833 below it, zero is returned. | |
| 5834 See also |prevnonblank()|. | |
| 5835 | |
| 4051 | 5836 nr2char({expr}[, {utf8}]) *nr2char()* |
| 7 | 5837 Return a string with a single character, which has the number |
| 5838 value {expr}. Examples: > | |
| 5839 nr2char(64) returns "@" | |
| 5840 nr2char(32) returns " " | |
| 4051 | 5841 < When {utf8} is omitted or zero, the current 'encoding' is used. |
| 5842 Example for "utf-8": > | |
| 7 | 5843 nr2char(300) returns I with bow character |
| 4051 | 5844 < With {utf8} set to 1, always return utf-8 characters. |
| 5845 Note that a NUL character in the file is specified with | |
| 7 | 5846 nr2char(10), because NULs are represented with newline |
| 5847 characters. nr2char(0) is a real NUL and terminates the | |
| 119 | 5848 string, thus results in an empty string. |
| 7 | 5849 |
| 3214 | 5850 or({expr}, {expr}) *or()* |
| 5851 Bitwise OR on the two arguments. The arguments are converted | |
| 5852 to a number. A List, Dict or Float argument causes an error. | |
| 5853 Example: > | |
| 5854 :let bits = or(bits, 0x80) | |
| 5855 | |
| 5856 | |
| 819 | 5857 pathshorten({expr}) *pathshorten()* |
| 5858 Shorten directory names in the path {expr} and return the | |
| 5859 result. The tail, the file name, is kept as-is. The other | |
| 5860 components in the path are reduced to single letters. Leading | |
| 5861 '~' and '.' characters are kept. Example: > | |
| 5862 :echo pathshorten('~/.vim/autoload/myfile.vim') | |
| 5863 < ~/.v/a/myfile.vim ~ | |
| 5864 It doesn't matter if the path exists or not. | |
| 5865 | |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5866 perleval({expr}) *perleval()* |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5867 Evaluate Perl expression {expr} in scalar context and return |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5868 its result converted to Vim data structures. If value can't be |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5869 converted, it is returned as a string Perl representation. |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5870 Note: If you want an array or hash, {expr} must return a |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5871 reference to it. |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5872 Example: > |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5873 :echo perleval('[1 .. 4]') |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5874 < [1, 2, 3, 4] |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5875 {only available when compiled with the |+perl| feature} |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
5876 |
| 1621 | 5877 pow({x}, {y}) *pow()* |
| 5878 Return the power of {x} to the exponent {y} as a |Float|. | |
| 5879 {x} and {y} must evaluate to a |Float| or a |Number|. | |
| 5880 Examples: > | |
| 5881 :echo pow(3, 3) | |
| 5882 < 27.0 > | |
| 5883 :echo pow(2, 16) | |
| 5884 < 65536.0 > | |
| 5885 :echo pow(32, 0.20) | |
| 5886 < 2.0 | |
| 5887 {only available when compiled with the |+float| feature} | |
| 5888 | |
| 667 | 5889 prevnonblank({lnum}) *prevnonblank()* |
| 5890 Return the line number of the first line at or above {lnum} | |
| 5891 that is not blank. Example: > | |
| 5892 let ind = indent(prevnonblank(v:lnum - 1)) | |
| 5893 < When {lnum} is invalid or there is no non-blank line at or | |
| 5894 above it, zero is returned. | |
| 5895 Also see |nextnonblank()|. | |
| 5896 | |
| 5897 | |
| 449 | 5898 printf({fmt}, {expr1} ...) *printf()* |
| 5899 Return a String with {fmt}, where "%" items are replaced by | |
| 5900 the formatted form of their respective arguments. Example: > | |
| 452 | 5901 printf("%4d: E%d %.30s", lnum, errno, msg) |
| 449 | 5902 < May result in: |
| 452 | 5903 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
| 449 | 5904 |
| 5905 Often used items are: | |
| 856 | 5906 %s string |
| 3914 | 5907 %6S string right-aligned in 6 display cells |
| 653 | 5908 %6s string right-aligned in 6 bytes |
| 1621 | 5909 %.9s string truncated to 9 bytes |
| 5910 %c single byte | |
| 5911 %d decimal number | |
| 5912 %5d decimal number padded with spaces to 5 characters | |
| 5913 %x hex number | |
| 5914 %04x hex number padded with zeros to at least 4 characters | |
| 5915 %X hex number using upper case letters | |
| 5916 %o octal number | |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
5917 %08b binary number padded with zeros to at least 8 chars |
|
10038
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
5918 %f floating point number as 12.23, inf, -inf or nan |
|
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
5919 %F floating point number as 12.23, INF, -INF or NAN |
|
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
5920 %e floating point number as 1.23e3, inf, -inf or nan |
|
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
5921 %E floating point number as 1.23E3, INF, -INF or NAN |
| 1621 | 5922 %g floating point number, as %f or %e depending on value |
| 5923 %G floating point number, as %f or %E depending on value | |
| 5924 %% the % character itself | |
| 449 | 5925 |
| 5926 Conversion specifications start with '%' and end with the | |
| 5927 conversion type. All other characters are copied unchanged to | |
| 5928 the result. | |
| 5929 | |
| 5930 The "%" starts a conversion specification. The following | |
| 452 | 5931 arguments appear in sequence: |
| 5932 | |
| 5933 % [flags] [field-width] [.precision] type | |
| 5934 | |
| 856 | 5935 flags |
| 452 | 5936 Zero or more of the following flags: |
| 5937 | |
| 449 | 5938 # The value should be converted to an "alternate |
| 5939 form". For c, d, and s conversions, this option | |
| 5940 has no effect. For o conversions, the precision | |
| 5941 of the number is increased to force the first | |
| 5942 character of the output string to a zero (except | |
| 5943 if a zero value is printed with an explicit | |
| 5944 precision of zero). | |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
5945 For b and B conversions, a non-zero result has |
|
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
5946 the string "0b" (or "0B" for B conversions) |
|
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
5947 prepended to it. |
| 449 | 5948 For x and X conversions, a non-zero result has |
| 5949 the string "0x" (or "0X" for X conversions) | |
| 5950 prepended to it. | |
| 452 | 5951 |
| 449 | 5952 0 (zero) Zero padding. For all conversions the converted |
| 5953 value is padded on the left with zeros rather | |
| 5954 than blanks. If a precision is given with a | |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
5955 numeric conversion (d, b, B, o, x, and X), the 0 |
|
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
5956 flag is ignored. |
| 452 | 5957 |
| 449 | 5958 - A negative field width flag; the converted value |
| 5959 is to be left adjusted on the field boundary. | |
| 5960 The converted value is padded on the right with | |
| 5961 blanks, rather than on the left with blanks or | |
| 5962 zeros. A - overrides a 0 if both are given. | |
| 452 | 5963 |
| 449 | 5964 ' ' (space) A blank should be left before a positive |
| 5965 number produced by a signed conversion (d). | |
| 452 | 5966 |
| 449 | 5967 + A sign must always be placed before a number |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
5968 produced by a signed conversion. A + overrides |
| 449 | 5969 a space if both are used. |
| 452 | 5970 |
| 5971 field-width | |
| 5972 An optional decimal digit string specifying a minimum | |
| 653 | 5973 field width. If the converted value has fewer bytes |
| 5974 than the field width, it will be padded with spaces on | |
| 5975 the left (or right, if the left-adjustment flag has | |
| 5976 been given) to fill out the field width. | |
| 452 | 5977 |
| 5978 .precision | |
| 5979 An optional precision, in the form of a period '.' | |
| 5980 followed by an optional digit string. If the digit | |
| 5981 string is omitted, the precision is taken as zero. | |
| 5982 This gives the minimum number of digits to appear for | |
| 5983 d, o, x, and X conversions, or the maximum number of | |
| 653 | 5984 bytes to be printed from a string for s conversions. |
| 1621 | 5985 For floating point it is the number of digits after |
| 5986 the decimal point. | |
| 452 | 5987 |
| 5988 type | |
| 5989 A character that specifies the type of conversion to | |
| 5990 be applied, see below. | |
| 5991 | |
| 449 | 5992 A field width or precision, or both, may be indicated by an |
| 5993 asterisk '*' instead of a digit string. In this case, a | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
5994 Number argument supplies the field width or precision. A |
| 449 | 5995 negative field width is treated as a left adjustment flag |
| 5996 followed by a positive field width; a negative precision is | |
| 5997 treated as though it were missing. Example: > | |
| 452 | 5998 :echo printf("%d: %.*s", nr, width, line) |
| 449 | 5999 < This limits the length of the text used from "line" to |
| 452 | 6000 "width" bytes. |
| 449 | 6001 |
| 856 | 6002 The conversion specifiers and their meanings are: |
| 452 | 6003 |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6004 *printf-d* *printf-b* *printf-B* *printf-o* |
|
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6005 *printf-x* *printf-X* |
|
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6006 dbBoxX The Number argument is converted to signed decimal |
|
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6007 (d), unsigned binary (b and B), unsigned octal (o), or |
|
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6008 unsigned hexadecimal (x and X) notation. The letters |
|
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6009 "abcdef" are used for x conversions; the letters |
|
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6010 "ABCDEF" are used for X conversions. |
| 452 | 6011 The precision, if any, gives the minimum number of |
| 6012 digits that must appear; if the converted value | |
| 6013 requires fewer digits, it is padded on the left with | |
| 6014 zeros. | |
| 6015 In no case does a non-existent or small field width | |
| 6016 cause truncation of a numeric field; if the result of | |
| 6017 a conversion is wider than the field width, the field | |
| 6018 is expanded to contain the conversion result. | |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6019 The 'h' modifier indicates the argument is 16 bits. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6020 The 'l' modifier indicates the argument is 32 bits. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6021 The 'L' modifier indicates the argument is 64 bits. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6022 Generally, these modifiers are not useful. They are |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6023 ignored when type is known from the argument. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6024 |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6025 i alias for d |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6026 D alias for ld |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6027 U alias for lu |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6028 O alias for lo |
| 452 | 6029 |
| 1621 | 6030 *printf-c* |
| 452 | 6031 c The Number argument is converted to a byte, and the |
| 6032 resulting character is written. | |
| 6033 | |
| 1621 | 6034 *printf-s* |
| 452 | 6035 s The text of the String argument is used. If a |
| 6036 precision is specified, no more bytes than the number | |
| 6037 specified are used. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
6038 If the argument is not a String type, it is |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
6039 automatically converted to text with the same format |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
6040 as ":echo". |
| 6583 | 6041 *printf-S* |
| 3914 | 6042 S The text of the String argument is used. If a |
| 6043 precision is specified, no more display cells than the | |
| 6044 number specified are used. Without the |+multi_byte| | |
| 6045 feature works just like 's'. | |
| 452 | 6046 |
| 1621 | 6047 *printf-f* *E807* |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6048 f F The Float argument is converted into a string of the |
| 1621 | 6049 form 123.456. The precision specifies the number of |
| 6050 digits after the decimal point. When the precision is | |
| 6051 zero the decimal point is omitted. When the precision | |
| 6052 is not specified 6 is used. A really big number | |
|
10038
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
6053 (out of range or dividing by zero) results in "inf" |
|
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
6054 or "-inf" with %f (INF or -INF with %F). |
|
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
6055 "0.0 / 0.0" results in "nan" with %f (NAN with %F). |
| 1621 | 6056 Example: > |
| 6057 echo printf("%.2f", 12.115) | |
| 6058 < 12.12 | |
| 6059 Note that roundoff depends on the system libraries. | |
| 6060 Use |round()| when in doubt. | |
| 6061 | |
| 6062 *printf-e* *printf-E* | |
| 6063 e E The Float argument is converted into a string of the | |
| 6064 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
| 6065 precision specifies the number of digits after the | |
| 6066 decimal point, like with 'f'. | |
| 6067 | |
| 6068 *printf-g* *printf-G* | |
| 6069 g G The Float argument is converted like with 'f' if the | |
| 6070 value is between 0.001 (inclusive) and 10000000.0 | |
| 6071 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
| 6072 for 'G'. When no precision is specified superfluous | |
| 6073 zeroes and '+' signs are removed, except for the zero | |
| 6074 immediately after the decimal point. Thus 10000000.0 | |
| 6075 results in 1.0e7. | |
| 6076 | |
| 6077 *printf-%* | |
| 449 | 6078 % A '%' is written. No argument is converted. The |
| 6079 complete conversion specification is "%%". | |
| 452 | 6080 |
| 1668 | 6081 When a Number argument is expected a String argument is also |
| 6082 accepted and automatically converted. | |
| 6083 When a Float or String argument is expected a Number argument | |
| 6084 is also accepted and automatically converted. | |
| 6085 Any other argument type results in an error message. | |
| 449 | 6086 |
| 459 | 6087 *E766* *E767* |
| 449 | 6088 The number of {exprN} arguments must exactly match the number |
| 6089 of "%" items. If there are not sufficient or too many | |
| 452 | 6090 arguments an error is given. Up to 18 arguments can be used. |
| 449 | 6091 |
| 6092 | |
| 667 | 6093 pumvisible() *pumvisible()* |
| 6094 Returns non-zero when the popup menu is visible, zero | |
| 6095 otherwise. See |ins-completion-menu|. | |
| 712 | 6096 This can be used to avoid some things that would remove the |
| 6097 popup menu. | |
| 7 | 6098 |
| 3682 | 6099 py3eval({expr}) *py3eval()* |
| 6100 Evaluate Python expression {expr} and return its result | |
| 6101 converted to Vim data structures. | |
| 6102 Numbers and strings are returned as they are (strings are | |
| 6647 | 6103 copied though, Unicode strings are additionally converted to |
| 3682 | 6104 'encoding'). |
| 6105 Lists are represented as Vim |List| type. | |
| 6106 Dictionaries are represented as Vim |Dictionary| type with | |
| 6107 keys converted to strings. | |
| 6108 {only available when compiled with the |+python3| feature} | |
| 6109 | |
| 6110 *E858* *E859* | |
| 6111 pyeval({expr}) *pyeval()* | |
| 6112 Evaluate Python expression {expr} and return its result | |
| 6113 converted to Vim data structures. | |
| 6114 Numbers and strings are returned as they are (strings are | |
| 6115 copied though). | |
| 6116 Lists are represented as Vim |List| type. | |
| 3830 | 6117 Dictionaries are represented as Vim |Dictionary| type, |
| 6118 non-string keys result in error. | |
| 3682 | 6119 {only available when compiled with the |+python| feature} |
| 6120 | |
| 114 | 6121 *E726* *E727* |
| 99 | 6122 range({expr} [, {max} [, {stride}]]) *range()* |
| 685 | 6123 Returns a |List| with Numbers: |
| 99 | 6124 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
| 6125 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
| 6126 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
| 6127 {max}] (increasing {expr} with {stride} each time, not | |
| 6128 producing a value past {max}). | |
| 336 | 6129 When the maximum is one before the start the result is an |
| 6130 empty list. When the maximum is more than one before the | |
| 6131 start this is an error. | |
| 99 | 6132 Examples: > |
| 856 | 6133 range(4) " [0, 1, 2, 3] |
| 99 | 6134 range(2, 4) " [2, 3, 4] |
| 6135 range(2, 9, 3) " [2, 5, 8] | |
| 856 | 6136 range(2, -2, -1) " [2, 1, 0, -1, -2] |
| 336 | 6137 range(0) " [] |
| 6138 range(2, 0) " error! | |
| 99 | 6139 < |
| 158 | 6140 *readfile()* |
| 168 | 6141 readfile({fname} [, {binary} [, {max}]]) |
| 685 | 6142 Read file {fname} and return a |List|, each line of the file |
| 6143 as an item. Lines broken at NL characters. Macintosh files | |
| 158 | 6144 separated with CR will result in a single long line (unless a |
| 6145 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
|
6146 All NUL characters are replaced with a NL character. |
| 6918 | 6147 When {binary} contains "b" binary mode is used: |
| 158 | 6148 - When the last line ends in a NL an extra empty list item is |
| 6149 added. | |
| 6150 - No CR characters are removed. | |
| 6151 Otherwise: | |
| 6152 - CR characters that appear before a NL are removed. | |
| 6153 - 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
|
6154 - 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
|
6155 removed from the text. |
| 168 | 6156 When {max} is given this specifies the maximum number of lines |
| 6157 to be read. Useful if you only want to check the first ten | |
| 6158 lines of a file: > | |
| 6159 :for line in readfile(fname, '', 10) | |
| 6160 : if line =~ 'Date' | echo line | endif | |
| 6161 :endfor | |
| 233 | 6162 < When {max} is negative -{max} lines from the end of the file |
| 6163 are returned, or as many as there are. | |
| 6164 When {max} is zero the result is an empty list. | |
| 168 | 6165 Note that without {max} the whole file is read into memory. |
| 6166 Also note that there is no recognition of encoding. Read a | |
| 6167 file into a buffer if you need to. | |
| 158 | 6168 When the file can't be opened an error message is given and |
| 6169 the result is an empty list. | |
| 6170 Also see |writefile()|. | |
| 6171 | |
| 794 | 6172 reltime([{start} [, {end}]]) *reltime()* |
| 6173 Return an item that represents a time value. The format of | |
| 6174 the item depends on the system. It can be passed to | |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6175 |reltimestr()| to convert it to a string or |reltimefloat()| |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6176 to convert to a Float. |
| 794 | 6177 Without an argument it returns the current time. |
| 6178 With one argument is returns the time passed since the time | |
| 6179 specified in the argument. | |
| 843 | 6180 With two arguments it returns the time passed between {start} |
| 794 | 6181 and {end}. |
| 6182 The {start} and {end} arguments must be values returned by | |
| 6183 reltime(). | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
6184 {only available when compiled with the |+reltime| feature} |
| 794 | 6185 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6186 reltimefloat({time}) *reltimefloat()* |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6187 Return a Float that represents the time value of {time}. |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6188 Example: > |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6189 let start = reltime() |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6190 call MyFunction() |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6191 let seconds = reltimefloat(reltime(start)) |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6192 < See the note of reltimestr() about overhead. |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6193 Also see |profiling|. |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6194 {only available when compiled with the |+reltime| feature} |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6195 |
| 794 | 6196 reltimestr({time}) *reltimestr()* |
| 6197 Return a String that represents the time value of {time}. | |
| 6198 This is the number of seconds, a dot and the number of | |
| 6199 microseconds. Example: > | |
| 6200 let start = reltime() | |
| 6201 call MyFunction() | |
| 6202 echo reltimestr(reltime(start)) | |
| 6203 < Note that overhead for the commands will be added to the time. | |
| 6204 The accuracy depends on the system. | |
| 1156 | 6205 Leading spaces are used to make the string align nicely. You |
| 6206 can use split() to remove it. > | |
| 6207 echo split(reltimestr(reltime(start)))[0] | |
| 6208 < 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
|
6209 {only available when compiled with the |+reltime| feature} |
| 794 | 6210 |
| 7 | 6211 *remote_expr()* *E449* |
| 6212 remote_expr({server}, {string} [, {idvar}]) | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6213 Send the {string} to {server}. The string is sent as an |
| 7 | 6214 expression and the result is returned after evaluation. |
| 714 | 6215 The result must be a String or a |List|. A |List| is turned |
| 6216 into a String by joining the items with a line break in | |
| 6217 between (not at the end), like with join(expr, "\n"). | |
| 7 | 6218 If {idvar} is present, it is taken as the name of a |
| 6219 variable and a {serverid} for later use with | |
| 6220 remote_read() is stored there. | |
| 6221 See also |clientserver| |RemoteReply|. | |
| 6222 This function is not available in the |sandbox|. | |
| 6223 {only available when compiled with the |+clientserver| feature} | |
| 6224 Note: Any errors will cause a local error message to be issued | |
| 6225 and the result will be the empty string. | |
| 6226 Examples: > | |
| 6227 :echo remote_expr("gvim", "2+2") | |
| 6228 :echo remote_expr("gvim1", "b:current_syntax") | |
| 6229 < | |
| 6230 | |
| 6231 remote_foreground({server}) *remote_foreground()* | |
| 6232 Move the Vim server with the name {server} to the foreground. | |
| 6233 This works like: > | |
| 6234 remote_expr({server}, "foreground()") | |
| 6235 < Except that on Win32 systems the client does the work, to work | |
| 6236 around the problem that the OS doesn't always allow the server | |
| 6237 to bring itself to the foreground. | |
| 574 | 6238 Note: This does not restore the window if it was minimized, |
| 6239 like foreground() does. | |
| 7 | 6240 This function is not available in the |sandbox|. |
| 6241 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 6242 Win32 console version} | |
| 6243 | |
| 6244 | |
| 6245 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
| 6246 Returns a positive number if there are available strings | |
| 6247 from {serverid}. Copies any reply string into the variable | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6248 {retvar} if specified. {retvar} must be a string with the |
| 7 | 6249 name of a variable. |
| 6250 Returns zero if none are available. | |
| 6251 Returns -1 if something is wrong. | |
| 6252 See also |clientserver|. | |
| 6253 This function is not available in the |sandbox|. | |
| 6254 {only available when compiled with the |+clientserver| feature} | |
| 6255 Examples: > | |
| 6256 :let repl = "" | |
| 6257 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
| 6258 | |
| 6259 remote_read({serverid}) *remote_read()* | |
| 6260 Return the oldest available reply from {serverid} and consume | |
| 6261 it. It blocks until a reply is available. | |
| 6262 See also |clientserver|. | |
| 6263 This function is not available in the |sandbox|. | |
| 6264 {only available when compiled with the |+clientserver| feature} | |
| 6265 Example: > | |
| 6266 :echo remote_read(id) | |
| 6267 < | |
| 6268 *remote_send()* *E241* | |
| 6269 remote_send({server}, {string} [, {idvar}]) | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6270 Send the {string} to {server}. The string is sent as input |
| 22 | 6271 keys and the function returns immediately. At the Vim server |
| 6272 the keys are not mapped |:map|. | |
| 667 | 6273 If {idvar} is present, it is taken as the name of a variable |
| 6274 and a {serverid} for later use with remote_read() is stored | |
| 6275 there. | |
| 7 | 6276 See also |clientserver| |RemoteReply|. |
| 6277 This function is not available in the |sandbox|. | |
| 6278 {only available when compiled with the |+clientserver| feature} | |
| 6279 Note: Any errors will be reported in the server and may mess | |
| 6280 up the display. | |
| 6281 Examples: > | |
| 6282 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
| 6283 \ remote_read(serverid) | |
| 6284 | |
| 6285 :autocmd NONE RemoteReply * | |
| 6286 \ echo remote_read(expand("<amatch>")) | |
| 6287 :echo remote_send("gvim", ":sleep 10 | echo ". | |
| 6288 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
| 82 | 6289 < |
| 79 | 6290 remove({list}, {idx} [, {end}]) *remove()* |
| 685 | 6291 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
|
6292 return the item. |
| 79 | 6293 With {end}: Remove items from {idx} to {end} (inclusive) and |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6294 return a List with these items. When {idx} points to the same |
| 79 | 6295 item as {end} a list with one item is returned. When {end} |
| 6296 points to an item before {idx} this is an error. | |
| 6297 See |list-index| for possible values of {idx} and {end}. | |
| 55 | 6298 Example: > |
| 6299 :echo "last item: " . remove(mylist, -1) | |
| 79 | 6300 :call remove(mylist, 0, 9) |
| 99 | 6301 remove({dict}, {key}) |
| 6302 Remove the entry from {dict} with key {key}. Example: > | |
| 6303 :echo "removed " . remove(dict, "one") | |
| 6304 < If there is no {key} in {dict} this is an error. | |
| 6305 | |
| 6306 Use |delete()| to remove a file. | |
| 55 | 6307 |
| 7 | 6308 rename({from}, {to}) *rename()* |
| 6309 Rename the file by the name {from} to the name {to}. This | |
| 6310 should also work to move files across file systems. The | |
| 6311 result is a Number, which is 0 if the file was renamed | |
| 6312 successfully, and non-zero when the renaming failed. | |
| 1851 | 6313 NOTE: If {to} exists it is overwritten without warning. |
| 7 | 6314 This function is not available in the |sandbox|. |
| 6315 | |
| 18 | 6316 repeat({expr}, {count}) *repeat()* |
| 6317 Repeat {expr} {count} times and return the concatenated | |
| 6318 result. Example: > | |
| 843 | 6319 :let separator = repeat('-', 80) |
| 18 | 6320 < When {count} is zero or negative the result is empty. |
| 685 | 6321 When {expr} is a |List| the result is {expr} concatenated |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6322 {count} times. Example: > |
| 79 | 6323 :let longlist = repeat(['a', 'b'], 3) |
| 6324 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
| 18 | 6325 |
| 82 | 6326 |
| 7 | 6327 resolve({filename}) *resolve()* *E655* |
| 6328 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
| 6329 returns the path the shortcut points to in a simplified form. | |
| 6330 On Unix, repeat resolving symbolic links in all path | |
| 6331 components of {filename} and return the simplified result. | |
| 6332 To cope with link cycles, resolving of symbolic links is | |
| 6333 stopped after 100 iterations. | |
| 6334 On other systems, return the simplified {filename}. | |
| 6335 The simplification step is done as by |simplify()|. | |
| 6336 resolve() keeps a leading path component specifying the | |
| 6337 current directory (provided the result is still a relative | |
| 6338 path name) and also keeps a trailing path separator. | |
| 6339 | |
| 82 | 6340 *reverse()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6341 reverse({list}) Reverse the order of items in {list} in-place. Returns |
| 82 | 6342 {list}. |
| 6343 If you want a list to remain unmodified make a copy first: > | |
| 6344 :let revlist = reverse(copy(mylist)) | |
| 6345 | |
| 1621 | 6346 round({expr}) *round()* |
| 1668 | 6347 Round off {expr} to the nearest integral value and return it |
| 1621 | 6348 as a |Float|. If {expr} lies halfway between two integral |
| 6349 values, then use the larger one (away from zero). | |
| 6350 {expr} must evaluate to a |Float| or a |Number|. | |
| 6351 Examples: > | |
| 6352 echo round(0.456) | |
| 6353 < 0.0 > | |
| 6354 echo round(4.5) | |
| 6355 < 5.0 > | |
| 6356 echo round(-4.5) | |
| 6357 < -5.0 | |
| 6358 {only available when compiled with the |+float| feature} | |
| 3996 | 6359 |
|
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6360 screenattr(row, col) *screenattr()* |
|
10027
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
10004
diff
changeset
|
6361 Like |screenchar()|, but return the attribute. This is a rather |
|
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6362 arbitrary number that can only be used to compare to the |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6363 attribute at other positions. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6364 |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6365 screenchar(row, col) *screenchar()* |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6366 The result is a Number, which is the character at position |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6367 [row, col] on the screen. This works for every possible |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6368 screen position, also status lines, window separators and the |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6369 command line. The top left position is row one, column one |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6370 The character excludes composing characters. For double-byte |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6371 encodings it may only be the first byte. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6372 This is mainly to be used for testing. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6373 Returns -1 when row or col is out of range. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6374 |
| 3996 | 6375 screencol() *screencol()* |
| 6376 The result is a Number, which is the current screen column of | |
| 6377 the cursor. The leftmost column has number 1. | |
| 6378 This function is mainly used for testing. | |
| 6379 | |
| 6380 Note: Always returns the current screen column, thus if used | |
| 6381 in a command (e.g. ":echo screencol()") it will return the | |
| 6382 column inside the command line, which is 1 when the command is | |
| 6383 executed. To get the cursor position in the file use one of | |
| 6384 the following mappings: > | |
| 6385 nnoremap <expr> GG ":echom ".screencol()."\n" | |
| 6386 nnoremap <silent> GG :echom screencol()<CR> | |
| 6387 < | |
| 6388 screenrow() *screenrow()* | |
| 6389 The result is a Number, which is the current screen row of the | |
| 6390 cursor. The top line has number one. | |
| 6391 This function is mainly used for testing. | |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
6392 Alternatively you can use |winline()|. |
| 3996 | 6393 |
| 6394 Note: Same restrictions as with |screencol()|. | |
| 6395 | |
| 1496 | 6396 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()* |
| 7 | 6397 Search for regexp pattern {pattern}. The search starts at the |
| 119 | 6398 cursor position (you can use |cursor()| to set it). |
| 707 | 6399 |
| 3967 | 6400 When a match has been found its line number is returned. |
| 3312 | 6401 If there is no match a 0 is returned and the cursor doesn't |
| 6402 move. No error message is given. | |
| 6403 | |
| 7 | 6404 {flags} is a String, which can contain these character flags: |
|
7358
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
6405 'b' search Backward instead of forward |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
6406 'c' accept a match at the Cursor position |
| 712 | 6407 'e' move to the End of the match |
| 20 | 6408 'n' do Not move the cursor |
|
7358
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
6409 'p' return number of matching sub-Pattern (see below) |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
6410 's' Set the ' mark at the previous location of the cursor |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
6411 'w' Wrap around the end of the file |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
6412 'W' don't Wrap around the end of the file |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
6413 'z' start searching at the cursor column instead of zero |
| 7 | 6414 If neither 'w' or 'W' is given, the 'wrapscan' option applies. |
| 6415 | |
| 444 | 6416 If the 's' flag is supplied, the ' mark is set, only if the |
| 6417 cursor is moved. The 's' flag cannot be combined with the 'n' | |
| 6418 flag. | |
| 6419 | |
| 1156 | 6420 'ignorecase', 'smartcase' and 'magic' are used. |
|
7358
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
6421 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
6422 When the 'z' flag is not given, searching always starts in |
|
7358
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
6423 column zero and then matches before the cursor are skipped. |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
6424 When the 'c' flag is present in 'cpo' the next search starts |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
6425 after the match. Without the 'c' flag the next search starts |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
6426 one column further. |
| 1156 | 6427 |
| 692 | 6428 When the {stopline} argument is given then the search stops |
| 6429 after searching this line. This is useful to restrict the | |
| 6430 search to a range of lines. Examples: > | |
| 6431 let match = search('(', 'b', line("w0")) | |
| 6432 let end = search('END', '', line("w$")) | |
| 6433 < When {stopline} is used and it is not zero this also implies | |
| 6434 that the search does not wrap around the end of the file. | |
| 1496 | 6435 A zero value is equal to not giving the argument. |
| 6436 | |
| 6437 When the {timeout} argument is given the search stops when | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6438 more than this many milliseconds have passed. Thus when |
| 1496 | 6439 {timeout} is 500 the search stops after half a second. |
| 6440 The value must not be negative. A zero value is like not | |
| 6441 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
|
6442 {only available when compiled with the |+reltime| feature} |
| 692 | 6443 |
| 714 | 6444 *search()-sub-match* |
| 6445 With the 'p' flag the returned value is one more than the | |
| 6446 first sub-match in \(\). One if none of them matched but the | |
| 6447 whole pattern did match. | |
| 712 | 6448 To get the column number too use |searchpos()|. |
| 6449 | |
| 20 | 6450 The cursor will be positioned at the match, unless the 'n' |
| 707 | 6451 flag is used. |
| 7 | 6452 |
| 6453 Example (goes over all files in the argument list): > | |
| 6454 :let n = 1 | |
| 6455 :while n <= argc() " loop over all files in arglist | |
| 6456 : exe "argument " . n | |
| 6457 : " start at the last char in the file and wrap for the | |
| 6458 : " first search to find match at start of file | |
| 6459 : normal G$ | |
| 6460 : let flags = "w" | |
| 6461 : while search("foo", flags) > 0 | |
| 1621 | 6462 : s/foo/bar/g |
| 7 | 6463 : let flags = "W" |
| 6464 : endwhile | |
| 6465 : update " write the file if modified | |
| 6466 : let n = n + 1 | |
| 6467 :endwhile | |
| 6468 < | |
| 712 | 6469 Example for using some flags: > |
| 6470 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
| 6471 < This will search for the keywords "if", "else", and "endif" | |
| 6472 under or after the cursor. Because of the 'p' flag, it | |
| 6473 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
| 6474 if the search fails. With the cursor on the first word of the | |
| 6475 line: | |
| 6476 if (foo == 0) | let foo = foo + 1 | endif ~ | |
| 6477 the function returns 1. Without the 'c' flag, the function | |
| 6478 finds the "endif" and returns 3. The same thing happens | |
| 6479 without the 'e' flag if the cursor is on the "f" of "if". | |
| 6480 The 'n' flag tells the function not to move the cursor. | |
| 6481 | |
| 504 | 6482 |
| 523 | 6483 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
| 6484 Search for the declaration of {name}. | |
| 856 | 6485 |
| 523 | 6486 With a non-zero {global} argument it works like |gD|, find |
| 6487 first match in the file. Otherwise it works like |gd|, find | |
| 6488 first match in the function. | |
| 6489 | |
| 6490 With a non-zero {thisblock} argument matches in a {} block | |
| 6491 that ends before the cursor position are ignored. Avoids | |
| 6492 finding variable declarations only valid in another scope. | |
| 6493 | |
| 504 | 6494 Moves the cursor to the found match. |
| 6495 Returns zero for success, non-zero for failure. | |
| 6496 Example: > | |
| 6497 if searchdecl('myvar') == 0 | |
| 6498 echo getline('.') | |
| 6499 endif | |
| 6500 < | |
| 7 | 6501 *searchpair()* |
| 1496 | 6502 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
| 6503 [, {stopline} [, {timeout}]]]]) | |
| 7 | 6504 Search for the match of a nested start-end pair. This can be |
| 6505 used to find the "endif" that matches an "if", while other | |
| 6506 if/endif pairs in between are ignored. | |
| 677 | 6507 The search starts at the cursor. The default is to search |
| 6508 forward, include 'b' in {flags} to search backward. | |
| 6509 If a match is found, the cursor is positioned at it and the | |
| 6510 line number is returned. If no match is found 0 or -1 is | |
| 6511 returned and the cursor doesn't move. No error message is | |
| 6512 given. | |
| 7 | 6513 |
| 6514 {start}, {middle} and {end} are patterns, see |pattern|. They | |
| 6515 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
| 6516 {middle} is not empty, it is found when searching from either | |
| 6517 direction, but only when not in a nested start-end pair. A | |
| 6518 typical use is: > | |
| 6519 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
| 6520 < By leaving {middle} empty the "else" is skipped. | |
| 6521 | |
| 712 | 6522 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
| 6523 |search()|. Additionally: | |
| 7 | 6524 'r' Repeat until no more matches found; will find the |
| 1621 | 6525 outer pair. Implies the 'W' flag. |
| 6526 'm' Return number of matches instead of line number with | |
| 712 | 6527 the match; will be > 1 when 'r' is used. |
| 1621 | 6528 Note: it's nearly always a good idea to use the 'W' flag, to |
| 6529 avoid wrapping around the end of the file. | |
| 7 | 6530 |
| 6531 When a match for {start}, {middle} or {end} is found, the | |
| 6532 {skip} expression is evaluated with the cursor positioned on | |
| 6533 the start of the match. It should return non-zero if this | |
| 6534 match is to be skipped. E.g., because it is inside a comment | |
| 6535 or a string. | |
| 6536 When {skip} is omitted or empty, every match is accepted. | |
| 6537 When evaluating {skip} causes an error the search is aborted | |
| 6538 and -1 returned. | |
| 6539 | |
| 1496 | 6540 For {stopline} and {timeout} see |search()|. |
| 692 | 6541 |
| 7 | 6542 The value of 'ignorecase' is used. 'magic' is ignored, the |
| 6543 patterns are used like it's on. | |
| 6544 | |
| 6545 The search starts exactly at the cursor. A match with | |
| 6546 {start}, {middle} or {end} at the next character, in the | |
| 6547 direction of searching, is the first one found. Example: > | |
| 6548 if 1 | |
| 6549 if 2 | |
| 6550 endif 2 | |
| 6551 endif 1 | |
| 6552 < When starting at the "if 2", with the cursor on the "i", and | |
| 6553 searching forwards, the "endif 2" is found. When starting on | |
| 6554 the character just before the "if 2", the "endif 1" will be | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6555 found. That's because the "if 2" will be found first, and |
| 7 | 6556 then this is considered to be a nested if/endif from "if 2" to |
| 6557 "endif 2". | |
| 6558 When searching backwards and {end} is more than one character, | |
| 6559 it may be useful to put "\zs" at the end of the pattern, so | |
| 6560 that when the cursor is inside a match with the end it finds | |
| 6561 the matching start. | |
| 6562 | |
| 6563 Example, to find the "endif" command in a Vim script: > | |
| 6564 | |
| 6565 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
| 6566 \ 'getline(".") =~ "^\\s*\""') | |
| 6567 | |
| 6568 < The cursor must be at or after the "if" for which a match is | |
| 6569 to be found. Note that single-quote strings are used to avoid | |
| 6570 having to double the backslashes. The skip expression only | |
| 6571 catches comments at the start of a line, not after a command. | |
| 6572 Also, a word "en" or "if" halfway a line is considered a | |
| 6573 match. | |
| 6574 Another example, to search for the matching "{" of a "}": > | |
| 6575 | |
| 6576 :echo searchpair('{', '', '}', 'bW') | |
| 6577 | |
| 6578 < This works when the cursor is at or before the "}" for which a | |
| 6579 match is to be found. To reject matches that syntax | |
| 6580 highlighting recognized as strings: > | |
| 6581 | |
| 6582 :echo searchpair('{', '', '}', 'bW', | |
| 6583 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
| 6584 < | |
| 667 | 6585 *searchpairpos()* |
| 1496 | 6586 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
| 6587 [, {stopline} [, {timeout}]]]]) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6588 Same as |searchpair()|, but returns a |List| with the line and |
| 685 | 6589 column position of the match. The first element of the |List| |
| 6590 is the line number and the second element is the byte index of | |
| 667 | 6591 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
|
6592 returns [0, 0]. > |
|
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6593 |
| 667 | 6594 :let [lnum,col] = searchpairpos('{', '', '}', 'n') |
| 6595 < | |
| 6596 See |match-parens| for a bigger and more useful example. | |
| 6597 | |
| 1496 | 6598 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()* |
| 692 | 6599 Same as |search()|, but returns a |List| with the line and |
| 685 | 6600 column position of the match. The first element of the |List| |
| 6601 is the line number and the second element is the byte index of | |
| 6602 the column position of the match. If no match is found, | |
| 6603 returns [0, 0]. | |
| 714 | 6604 Example: > |
| 6605 :let [lnum, col] = searchpos('mypattern', 'n') | |
| 6606 | |
| 6607 < When the 'p' flag is given then there is an extra item with | |
| 6608 the sub-pattern match number |search()-sub-match|. Example: > | |
| 6609 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
| 6610 < In this example "submatch" is 2 when a lowercase letter is | |
| 6611 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
| 6612 | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
6613 server2client({clientid}, {string}) *server2client()* |
| 7 | 6614 Send a reply string to {clientid}. The most recent {clientid} |
| 6615 that sent a string can be retrieved with expand("<client>"). | |
| 6616 {only available when compiled with the |+clientserver| feature} | |
| 6617 Note: | |
| 6618 This id has to be stored before the next command can be | |
| 236 | 6619 received. I.e. before returning from the received command and |
| 7 | 6620 before calling any commands that waits for input. |
| 6621 See also |clientserver|. | |
| 6622 Example: > | |
| 6623 :echo server2client(expand("<client>"), "HELLO") | |
| 6624 < | |
| 6625 serverlist() *serverlist()* | |
| 6626 Return a list of available server names, one per line. | |
| 6627 When there are no servers or the information is not available | |
| 6628 an empty string is returned. See also |clientserver|. | |
| 6629 {only available when compiled with the |+clientserver| feature} | |
| 6630 Example: > | |
| 6631 :echo serverlist() | |
| 6632 < | |
| 6633 setbufvar({expr}, {varname}, {val}) *setbufvar()* | |
| 6634 Set option or local variable {varname} in buffer {expr} to | |
| 6635 {val}. | |
| 6636 This also works for a global or local window option, but it | |
| 6637 doesn't work for a global or local window variable. | |
| 6638 For a local window option the global value is unchanged. | |
| 6639 For the use of {expr}, see |bufname()| above. | |
| 6640 Note that the variable name without "b:" must be used. | |
| 6641 Examples: > | |
| 6642 :call setbufvar(1, "&mod", 1) | |
| 6643 :call setbufvar("todo", "myvar", "foobar") | |
| 6644 < This function is not available in the |sandbox|. | |
| 6645 | |
|
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
6646 setcharsearch({dict}) *setcharsearch()* |
| 6991 | 6647 Set the current character search information to {dict}, |
| 6648 which contains one or more of the following entries: | |
| 6649 | |
| 6650 char character which will be used for a subsequent | |
| 6651 |,| or |;| command; an empty string clears the | |
| 6652 character search | |
| 6653 forward direction of character search; 1 for forward, | |
| 6654 0 for backward | |
| 6655 until type of character search; 1 for a |t| or |T| | |
| 6656 character search, 0 for an |f| or |F| | |
| 6657 character search | |
| 6658 | |
| 6659 This can be useful to save/restore a user's character search | |
| 6660 from a script: > | |
| 6661 :let prevsearch = getcharsearch() | |
| 6662 :" Perform a command which clobbers user's search | |
| 6663 :call setcharsearch(prevsearch) | |
| 6664 < Also see |getcharsearch()|. | |
| 6665 | |
| 7 | 6666 setcmdpos({pos}) *setcmdpos()* |
| 6667 Set the cursor position in the command line to byte position | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6668 {pos}. The first position is 1. |
| 7 | 6669 Use |getcmdpos()| to obtain the current position. |
| 6670 Only works while editing the command line, thus you must use | |
| 99 | 6671 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
| 6672 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
| 6673 set after the command line is set to the expression. For | |
| 6674 |c_CTRL-R_=| it is set after evaluating the expression but | |
| 6675 before inserting the resulting text. | |
| 7 | 6676 When the number is too big the cursor is put at the end of the |
| 6677 line. A number smaller than one has undefined results. | |
| 6678 Returns 0 when successful, 1 when not editing the command | |
| 6679 line. | |
| 6680 | |
|
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6681 setfperm({fname}, {mode}) *setfperm()* *chmod* |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6682 Set the file permissions for {fname} to {mode}. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6683 {mode} must be a string with 9 characters. It is of the form |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6684 "rwxrwxrwx", where each group of "rwx" flags represent, in |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6685 turn, the permissions of the owner of the file, the group the |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6686 file belongs to, and other users. A '-' character means the |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6687 permission is off, any other character means on. Multi-byte |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6688 characters are not supported. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6689 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6690 For example "rw-r-----" means read-write for the user, |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6691 readable by the group, not accessible by others. "xx-x-----" |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6692 would do the same thing. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6693 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6694 Returns non-zero for success, zero for failure. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6695 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6696 To read permissions see |getfperm()|. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6697 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6698 |
| 1621 | 6699 setline({lnum}, {text}) *setline()* |
| 3312 | 6700 Set line {lnum} of the current buffer to {text}. To insert |
| 6701 lines use |append()|. | |
| 236 | 6702 {lnum} is used like with |getline()|. |
| 1621 | 6703 When {lnum} is just below the last line the {text} will be |
| 282 | 6704 added as a new line. |
| 236 | 6705 If this succeeds, 0 is returned. If this fails (most likely |
| 6706 because {lnum} is invalid) 1 is returned. Example: > | |
| 7 | 6707 :call setline(5, strftime("%c")) |
| 1621 | 6708 < When {text} is a |List| then line {lnum} and following lines |
| 282 | 6709 will be set to the items in the list. Example: > |
| 6710 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
| 6711 < This is equivalent to: > | |
| 3465 | 6712 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']] |
| 282 | 6713 : call setline(n, l) |
| 6714 :endfor | |
| 7 | 6715 < Note: The '[ and '] marks are not set. |
| 6716 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6717 setloclist({nr}, {list}[, {action}[, {what}]]) *setloclist()* |
| 647 | 6718 Create or replace or add to the location list for window {nr}. |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
6719 {nr} can be the window number or the |window-ID|. |
|
9223
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
6720 When {nr} is zero the current window is used. |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
6721 |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
6722 For a location list window, the displayed location list is |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
6723 modified. For an invalid window number {nr}, -1 is returned. |
| 1326 | 6724 Otherwise, same as |setqflist()|. |
| 6725 Also see |location-list|. | |
| 6726 | |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6727 If the optional {what} dictionary argument is supplied, then |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6728 only the items listed in {what} are set. Refer to |setqflist()| |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6729 for the list of supported keys in {what}. |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6730 |
| 1326 | 6731 setmatches({list}) *setmatches()* |
| 6732 Restores a list of matches saved by |getmatches()|. Returns 0 | |
| 1621 | 6733 if successful, otherwise -1. All current matches are cleared |
| 1326 | 6734 before the list is restored. See example for |getmatches()|. |
| 230 | 6735 |
| 707 | 6736 *setpos()* |
| 6737 setpos({expr}, {list}) | |
| 6738 Set the position for {expr}. Possible values: | |
| 6739 . the cursor | |
| 6740 'x mark x | |
| 6741 | |
| 5938 | 6742 {list} must be a |List| with four or five numbers: |
| 707 | 6743 [bufnum, lnum, col, off] |
| 5938 | 6744 [bufnum, lnum, col, off, curswant] |
| 707 | 6745 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6746 "bufnum" is the buffer number. Zero can be used for the |
| 856 | 6747 current buffer. Setting the cursor is only possible for |
| 707 | 6748 the current buffer. To set a mark in another buffer you can |
| 6749 use the |bufnr()| function to turn a file name into a buffer | |
| 6750 number. | |
| 798 | 6751 Does not change the jumplist. |
| 707 | 6752 |
| 6753 "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
|
6754 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
|
6755 smaller than 1 then 1 is used. |
| 707 | 6756 |
| 6757 The "off" number is only used when 'virtualedit' is set. Then | |
| 6758 it is the offset in screen columns from the start of the | |
| 1266 | 6759 character. E.g., a position within a <Tab> or after the last |
| 707 | 6760 character. |
| 6761 | |
| 5938 | 6762 The "curswant" number is only used when setting the cursor |
| 6763 position. It sets the preferred column for when moving the | |
| 6764 cursor vertically. When the "curswant" number is missing the | |
| 6765 preferred column is not set. When it is present and setting a | |
| 6766 mark position it is not used. | |
| 6767 | |
| 5555 | 6768 Note that for '< and '> changing the line number may result in |
| 6769 the marks to be effectively be swapped, so that '< is always | |
| 6770 before '>. | |
| 6771 | |
| 1533 | 6772 Returns 0 when the position could be set, -1 otherwise. |
| 6773 An error message is given if {expr} is invalid. | |
| 6774 | |
| 5944 | 6775 Also see |getpos()| and |getcurpos()|. |
| 707 | 6776 |
| 1156 | 6777 This does not restore the preferred column for moving |
| 5938 | 6778 vertically; if you set the cursor position with this, |j| and |
| 6779 |k| motions will jump to previous columns! Use |cursor()| to | |
| 6780 also set the preferred column. Also see the "curswant" key in | |
| 6781 |winrestview()|. | |
| 1156 | 6782 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6783 setqflist({list} [, {action}[, {what}]]) *setqflist()* |
| 647 | 6784 Create or replace or add to the quickfix list using the items |
| 6785 in {list}. Each item in {list} is a dictionary. | |
| 6786 Non-dictionary items in {list} are ignored. Each dictionary | |
| 6787 item can contain the following entries: | |
| 230 | 6788 |
| 1065 | 6789 bufnr buffer number; must be the number of a valid |
| 1621 | 6790 buffer |
| 1065 | 6791 filename name of a file; only used when "bufnr" is not |
| 1621 | 6792 present or it is invalid. |
| 230 | 6793 lnum line number in the file |
| 233 | 6794 pattern search pattern used to locate the error |
| 230 | 6795 col column number |
| 233 | 6796 vcol when non-zero: "col" is visual column |
| 856 | 6797 when zero: "col" is byte index |
| 233 | 6798 nr error number |
| 230 | 6799 text description of the error |
| 233 | 6800 type single-character error type, 'E', 'W', etc. |
| 6801 | |
| 6802 The "col", "vcol", "nr", "type" and "text" entries are | |
| 6803 optional. Either "lnum" or "pattern" entry can be used to | |
| 6804 locate a matching error line. | |
| 1065 | 6805 If the "filename" and "bufnr" entries are not present or |
| 6806 neither the "lnum" or "pattern" entries are present, then the | |
| 6807 item will not be handled as an error line. | |
| 230 | 6808 If both "pattern" and "lnum" are present then "pattern" will |
| 6809 be used. | |
| 2152 | 6810 If you supply an empty {list}, the quickfix list will be |
| 6811 cleared. | |
| 1065 | 6812 Note that the list is not exactly the same as what |
| 6813 |getqflist()| returns. | |
| 230 | 6814 |
|
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
6815 *E927* |
| 277 | 6816 If {action} is set to 'a', then the items from {list} are |
| 6817 added to the existing quickfix list. If there is no existing | |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
6818 list, then a new list is created. |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
6819 |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
6820 If {action} is set to 'r', then the items from the current |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
6821 quickfix list are replaced with the items from {list}. This |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
6822 can also be used to clear the list: > |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
6823 :call setqflist([], 'r') |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
6824 < |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
6825 If {action} is not present or is set to ' ', then a new list |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
6826 is created. |
| 277 | 6827 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6828 If the optional {what} dictionary argument is supplied, then |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6829 only the items listed in {what} are set. The first {list} |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6830 argument is ignored. The following items can be specified in |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6831 {what}: |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6832 nr list number in the quickfix stack |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6833 title quickfix list title text |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6834 Unsupported keys in {what} are ignored. |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6835 If the "nr" item is not present, then the current quickfix list |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6836 is modified. |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6837 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6838 Examples: > |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6839 :call setqflist([], 'r', {'title': 'My search'}) |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6840 :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'}) |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6841 < |
| 230 | 6842 Returns zero for success, -1 for failure. |
| 6843 | |
| 6844 This function can be used to create a quickfix list | |
| 6845 independent of the 'errorformat' setting. Use a command like | |
| 6846 ":cc 1" to jump to the first position. | |
| 6847 | |
| 6848 | |
| 7 | 6849 *setreg()* |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
6850 setreg({regname}, {value} [, {options}]) |
| 7 | 6851 Set the register {regname} to {value}. |
| 5798 | 6852 {value} may be any value returned by |getreg()|, including |
| 6853 a |List|. | |
| 7 | 6854 If {options} contains "a" or {regname} is upper case, |
| 6855 then the value is appended. | |
| 2423 | 6856 {options} can also contain a register type specification: |
| 7 | 6857 "c" or "v" |characterwise| mode |
| 6858 "l" or "V" |linewise| mode | |
| 6859 "b" or "<CTRL-V>" |blockwise-visual| mode | |
| 6860 If a number immediately follows "b" or "<CTRL-V>" then this is | |
| 6861 used as the width of the selection - if it is not specified | |
| 6862 then the width of the block is set to the number of characters | |
| 1266 | 6863 in the longest line (counting a <Tab> as 1 character). |
| 7 | 6864 |
| 6865 If {options} contains no register settings, then the default | |
| 5798 | 6866 is to use character mode unless {value} ends in a <NL> for |
| 6867 string {value} and linewise mode for list {value}. Blockwise | |
| 6868 mode is never selected automatically. | |
| 6869 Returns zero for success, non-zero for failure. | |
| 6870 | |
| 6871 *E883* | |
| 6180 | 6872 Note: you may not use |List| containing more than one item to |
| 5798 | 6873 set search and expression registers. Lists containing no |
| 6874 items act like empty strings. | |
| 7 | 6875 |
| 6876 Examples: > | |
| 6877 :call setreg(v:register, @*) | |
| 6878 :call setreg('*', @%, 'ac') | |
| 6879 :call setreg('a', "1\n2\n3", 'b5') | |
| 6880 | |
| 6881 < This example shows using the functions to save and restore a | |
| 5798 | 6882 register (note: you may not reliably restore register value |
| 6883 without using the third argument to |getreg()| as without it | |
| 6884 newlines are represented as newlines AND Nul bytes are | |
| 6885 represented as newlines as well, see |NL-used-for-Nul|). > | |
| 6886 :let var_a = getreg('a', 1, 1) | |
| 7 | 6887 :let var_amode = getregtype('a') |
| 6888 .... | |
| 6889 :call setreg('a', var_a, var_amode) | |
| 6890 | |
| 6891 < You can also change the type of a register by appending | |
| 6892 nothing: > | |
| 6893 :call setreg('a', '', 'al') | |
| 6894 | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
6895 settabvar({tabnr}, {varname}, {val}) *settabvar()* |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
6896 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
|
6897 |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
6898 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
|
6899 Tabs are numbered starting with one. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
6900 This function is not available in the |sandbox|. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
6901 |
| 831 | 6902 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
| 6903 Set option or local variable {varname} in window {winnr} to | |
| 6904 {val}. | |
| 6905 Tabs are numbered starting with one. For the current tabpage | |
| 6906 use |setwinvar()|. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
6907 {winnr} can be the window number or the |window-ID|. |
| 831 | 6908 When {winnr} is zero the current window is used. |
| 7 | 6909 This also works for a global or local buffer option, but it |
| 6910 doesn't work for a global or local buffer variable. | |
| 6911 For a local buffer option the global value is unchanged. | |
| 6912 Note that the variable name without "w:" must be used. | |
| 831 | 6913 Examples: > |
| 6914 :call settabwinvar(1, 1, "&list", 0) | |
| 6915 :call settabwinvar(3, 2, "myvar", "foobar") | |
| 6916 < This function is not available in the |sandbox|. | |
| 6917 | |
| 6918 setwinvar({nr}, {varname}, {val}) *setwinvar()* | |
| 6919 Like |settabwinvar()| for the current tab page. | |
| 7 | 6920 Examples: > |
| 6921 :call setwinvar(1, "&list", 0) | |
| 6922 :call setwinvar(2, "myvar", "foobar") | |
| 6923 | |
| 4126 | 6924 sha256({string}) *sha256()* |
| 6647 | 6925 Returns a String with 64 hex characters, which is the SHA256 |
| 4126 | 6926 checksum of {string}. |
| 6927 {only available when compiled with the |+cryptv| feature} | |
| 6928 | |
| 1661 | 6929 shellescape({string} [, {special}]) *shellescape()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6930 Escape {string} for use as a shell command argument. |
| 985 | 6931 On MS-Windows and MS-DOS, when 'shellslash' is not set, it |
| 1661 | 6932 will enclose {string} in double quotes and double all double |
| 985 | 6933 quotes within {string}. |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6934 Otherwise it will enclose {string} in single quotes and |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6935 replace all "'" with "'\''". |
| 1661 | 6936 When the {special} argument is present and it's a non-zero |
| 6937 Number or a non-empty String (|non-zero-arg|), then special | |
| 1698 | 6938 items such as "!", "%", "#" and "<cword>" will be preceded by |
| 6939 a backslash. This backslash will be removed again by the |:!| | |
| 1661 | 6940 command. |
| 1698 | 6941 The "!" character will be escaped (again with a |non-zero-arg| |
| 6942 {special}) when 'shell' contains "csh" in the tail. That is | |
| 6943 because for csh and tcsh "!" is used for history replacement | |
| 6944 even when inside single quotes. | |
| 6945 The <NL> character is also escaped. With a |non-zero-arg| | |
| 6946 {special} and 'shell' containing "csh" in the tail it's | |
| 6947 escaped a second time. | |
| 1661 | 6948 Example of use with a |:!| command: > |
| 6949 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
| 6950 < This results in a directory listing for the file under the | |
| 6951 cursor. Example of use with |system()|: > | |
| 6952 :call system("chmod +w -- " . shellescape(expand("%"))) | |
| 5690 | 6953 < See also |::S|. |
| 985 | 6954 |
| 6955 | |
| 3875 | 6956 shiftwidth() *shiftwidth()* |
| 6957 Returns the effective value of 'shiftwidth'. This is the | |
| 6958 'shiftwidth' value unless it is zero, in which case it is the | |
|
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
6959 'tabstop' value. This function was introduced with patch |
|
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
6960 7.3.694 in 2012, everybody should have it by now. |
| 3875 | 6961 |
| 6962 | |
| 7 | 6963 simplify({filename}) *simplify()* |
| 6964 Simplify the file name as much as possible without changing | |
| 6965 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
| 6966 Unix) are not resolved. If the first path component in | |
| 6967 {filename} designates the current directory, this will be | |
| 6968 valid for the result as well. A trailing path separator is | |
| 6969 not removed either. | |
| 6970 Example: > | |
| 6971 simplify("./dir/.././/file/") == "./file/" | |
| 6972 < Note: The combination "dir/.." is only removed if "dir" is | |
| 6973 a searchable directory or does not exist. On Unix, it is also | |
| 6974 removed when "dir" is a symbolic link within the same | |
| 6975 directory. In order to resolve all the involved symbolic | |
| 6976 links before simplifying the path name, use |resolve()|. | |
| 6977 | |
| 82 | 6978 |
| 1621 | 6979 sin({expr}) *sin()* |
| 6980 Return the sine of {expr}, measured in radians, as a |Float|. | |
| 6981 {expr} must evaluate to a |Float| or a |Number|. | |
| 6982 Examples: > | |
| 6983 :echo sin(100) | |
| 6984 < -0.506366 > | |
| 6985 :echo sin(-4.01) | |
| 6986 < 0.763301 | |
| 6987 {only available when compiled with the |+float| feature} | |
| 6988 | |
| 6989 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6990 sinh({expr}) *sinh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6991 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
|
6992 [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6993 {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
|
6994 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6995 :echo sinh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6996 < 0.521095 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6997 :echo sinh(-0.9) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6998 < -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
|
6999 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7000 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7001 |
| 2902 | 7002 sort({list} [, {func} [, {dict}]]) *sort()* *E702* |
| 5747 | 7003 Sort the items in {list} in-place. Returns {list}. |
| 7004 | |
| 7005 If you want a list to remain unmodified make a copy first: > | |
| 82 | 7006 :let sortedlist = sort(copy(mylist)) |
| 5968 | 7007 |
| 6009 | 7008 < When {func} is omitted, is empty or zero, then sort() uses the |
| 7009 string representation of each item to sort on. Numbers sort | |
| 7010 after Strings, |Lists| after Numbers. For sorting text in the | |
| 7011 current buffer use |:sort|. | |
| 7012 | |
| 6180 | 7013 When {func} is given and it is '1' or 'i' then case is |
| 6009 | 7014 ignored. |
| 7015 | |
| 7016 When {func} is given and it is 'n' then all items will be | |
| 7017 sorted numerical (Implementation detail: This uses the | |
| 7018 strtod() function to parse numbers, Strings, Lists, Dicts and | |
| 7019 Funcrefs will be considered as being 0). | |
| 7020 | |
|
7291
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
7021 When {func} is given and it is 'N' then all items will be |
|
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
7022 sorted numerical. This is like 'n' but a string containing |
|
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
7023 digits will be used as the number they represent. |
|
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
7024 |
|
7707
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
7025 When {func} is given and it is 'f' then all items will be |
|
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
7026 sorted numerical. All values must be a Number or a Float. |
|
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
7027 |
| 685 | 7028 When {func} is a |Funcref| or a function name, this function |
| 7029 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
|
7030 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
|
7031 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
|
7032 smaller if the first one sorts before the second one. |
| 5747 | 7033 |
| 7034 {dict} is for functions with the "dict" attribute. It will be | |
| 7035 used to set the local variable "self". |Dictionary-function| | |
| 7036 | |
|
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
7037 The sort is stable, items which compare equal (as number or as |
|
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
7038 string) will keep their relative position. E.g., when sorting |
| 6051 | 7039 on numbers, text strings will sort next to each other, in the |
|
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
7040 same order as they were originally. |
|
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
7041 |
| 5747 | 7042 Also see |uniq()|. |
| 7043 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7044 Example: > |
| 82 | 7045 func MyCompare(i1, i2) |
| 7046 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
| 7047 endfunc | |
| 7048 let sortedlist = sort(mylist, "MyCompare") | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7049 < A shorter compare version for this specific simple case, which |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7050 ignores overflow: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7051 func MyCompare(i1, i2) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7052 return a:i1 - a:i2 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7053 endfunc |
| 344 | 7054 < |
| 374 | 7055 *soundfold()* |
| 7056 soundfold({word}) | |
| 7057 Return the sound-folded equivalent of {word}. Uses the first | |
| 1621 | 7058 language in 'spelllang' for the current window that supports |
| 375 | 7059 soundfolding. 'spell' must be set. When no sound folding is |
| 7060 possible the {word} is returned unmodified. | |
| 374 | 7061 This can be used for making spelling suggestions. Note that |
| 7062 the method can be quite slow. | |
| 7063 | |
| 344 | 7064 *spellbadword()* |
| 532 | 7065 spellbadword([{sentence}]) |
| 7066 Without argument: The result is the badly spelled word under | |
| 7067 or after the cursor. The cursor is moved to the start of the | |
| 7068 bad word. When no bad word is found in the cursor line the | |
| 7069 result is an empty string and the cursor doesn't move. | |
| 7070 | |
| 7071 With argument: The result is the first word in {sentence} that | |
| 7072 is badly spelled. If there are no spelling mistakes the | |
| 7073 result is an empty string. | |
| 7074 | |
| 7075 The return value is a list with two items: | |
| 7076 - The badly spelled word or an empty string. | |
| 7077 - The type of the spelling error: | |
| 856 | 7078 "bad" spelling mistake |
| 532 | 7079 "rare" rare word |
| 7080 "local" word only valid in another region | |
| 7081 "caps" word should start with Capital | |
| 7082 Example: > | |
| 7083 echo spellbadword("the quik brown fox") | |
| 7084 < ['quik', 'bad'] ~ | |
| 7085 | |
| 7086 The spelling information for the current window is used. The | |
| 7087 'spell' option must be set and the value of 'spelllang' is | |
| 7088 used. | |
| 344 | 7089 |
| 7090 *spellsuggest()* | |
| 537 | 7091 spellsuggest({word} [, {max} [, {capital}]]) |
| 685 | 7092 Return a |List| with spelling suggestions to replace {word}. |
| 344 | 7093 When {max} is given up to this number of suggestions are |
| 7094 returned. Otherwise up to 25 suggestions are returned. | |
| 7095 | |
| 537 | 7096 When the {capital} argument is given and it's non-zero only |
| 7097 suggestions with a leading capital will be given. Use this | |
| 7098 after a match with 'spellcapcheck'. | |
| 7099 | |
| 344 | 7100 {word} can be a badly spelled word followed by other text. |
| 7101 This allows for joining two words that were split. The | |
| 359 | 7102 suggestions also include the following text, thus you can |
| 7103 replace a line. | |
| 7104 | |
| 7105 {word} may also be a good word. Similar words will then be | |
| 537 | 7106 returned. {word} itself is not included in the suggestions, |
| 7107 although it may appear capitalized. | |
| 344 | 7108 |
| 7109 The spelling information for the current window is used. The | |
| 375 | 7110 'spell' option must be set and the values of 'spelllang' and |
| 7111 'spellsuggest' are used. | |
| 344 | 7112 |
| 82 | 7113 |
| 282 | 7114 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
| 685 | 7115 Make a |List| out of {expr}. When {pattern} is omitted or |
| 7116 empty each white-separated sequence of characters becomes an | |
| 7117 item. | |
| 82 | 7118 Otherwise the string is split where {pattern} matches, |
| 3920 | 7119 removing the matched characters. 'ignorecase' is not used |
| 7120 here, add \c to ignore case. |/\c| | |
| 282 | 7121 When the first or last item is empty it is omitted, unless the |
| 7122 {keepempty} argument is given and it's non-zero. | |
| 293 | 7123 Other empty items are kept when {pattern} matches at least one |
| 7124 character or when {keepempty} is non-zero. | |
| 82 | 7125 Example: > |
| 95 | 7126 :let words = split(getline('.'), '\W\+') |
| 282 | 7127 < To split a string in individual characters: > |
| 236 | 7128 :for c in split(mystring, '\zs') |
|
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
7129 < If you want to keep the separator you can also use '\zs' at |
|
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
7130 the end of the pattern: > |
| 258 | 7131 :echo split('abc:def:ghi', ':\zs') |
| 7132 < ['abc:', 'def:', 'ghi'] ~ | |
| 282 | 7133 Splitting a table where the first element can be empty: > |
| 7134 :let items = split(line, ':', 1) | |
| 7135 < The opposite function is |join()|. | |
| 82 | 7136 |
| 7137 | |
| 1621 | 7138 sqrt({expr}) *sqrt()* |
| 7139 Return the non-negative square root of Float {expr} as a | |
| 7140 |Float|. | |
| 7141 {expr} must evaluate to a |Float| or a |Number|. When {expr} | |
| 7142 is negative the result is NaN (Not a Number). | |
| 7143 Examples: > | |
| 7144 :echo sqrt(100) | |
| 7145 < 10.0 > | |
| 7146 :echo sqrt(-4.01) | |
| 7147 < nan | |
| 1668 | 7148 "nan" may be different, it depends on system libraries. |
| 1621 | 7149 {only available when compiled with the |+float| feature} |
| 7150 | |
| 7151 | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
7152 str2float({expr}) *str2float()* |
| 1621 | 7153 Convert String {expr} to a Float. This mostly works the same |
| 7154 as when using a floating point number in an expression, see | |
| 7155 |floating-point-format|. But it's a bit more permissive. | |
| 7156 E.g., "1e40" is accepted, while in an expression you need to | |
| 7157 write "1.0e40". | |
| 7158 Text after the number is silently ignored. | |
| 7159 The decimal point is always '.', no matter what the locale is | |
| 7160 set to. A comma ends the number: "12,345.67" is converted to | |
| 7161 12.0. You can strip out thousands separators with | |
| 7162 |substitute()|: > | |
| 7163 let f = str2float(substitute(text, ',', '', 'g')) | |
| 7164 < {only available when compiled with the |+float| feature} | |
| 7165 | |
| 7166 | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
7167 str2nr({expr} [, {base}]) *str2nr()* |
| 782 | 7168 Convert string {expr} to a number. |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
7169 {base} is the conversion base, it can be 2, 8, 10 or 16. |
| 782 | 7170 When {base} is omitted base 10 is used. This also means that |
| 7171 a leading zero doesn't cause octal conversion to be used, as | |
| 7172 with the default String to Number conversion. | |
| 7173 When {base} is 16 a leading "0x" or "0X" is ignored. With a | |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
7174 different base the result will be zero. Similarly, when |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
7175 {base} is 8 a leading "0" is ignored, and when {base} is 2 a |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
7176 leading "0b" or "0B" is ignored. |
| 782 | 7177 Text after the number is silently ignored. |
| 856 | 7178 |
| 782 | 7179 |
| 6884 | 7180 strchars({expr} [, {skipcc}]) *strchars()* |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7181 The result is a Number, which is the number of characters |
| 6884 | 7182 in String {expr}. |
| 7183 When {skipcc} is omitted or zero, composing characters are | |
| 7184 counted separately. | |
| 7185 When {skipcc} set to 1, Composing characters are ignored. | |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7186 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
| 6918 | 7187 |
| 7188 {skipcc} is only available after 7.4.755. For backward | |
| 7189 compatibility, you can define a wrapper function: > | |
| 7190 if has("patch-7.4.755") | |
| 7191 function s:strchars(str, skipcc) | |
| 7192 return strchars(a:str, a:skipcc) | |
| 7193 endfunction | |
| 7194 else | |
| 7195 function s:strchars(str, skipcc) | |
| 7196 if a:skipcc | |
| 7197 return strlen(substitute(a:str, ".", "x", "g")) | |
| 7198 else | |
| 7199 return strchars(a:str) | |
| 7200 endif | |
| 7201 endfunction | |
| 7202 endif | |
| 7203 < | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7204 strcharpart({src}, {start}[, {len}]) *strcharpart()* |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7205 Like |strpart()| but using character index and length instead |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7206 of byte index and length. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7207 When a character index is used where a character does not |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7208 exist it is assumed to be one byte. For example: > |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7209 strcharpart('abc', -1, 2) |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7210 < results in 'a'. |
| 6918 | 7211 |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7212 strdisplaywidth({expr}[, {col}]) *strdisplaywidth()* |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7213 The result is a Number, which is the number of display cells |
| 6884 | 7214 String {expr} occupies on the screen when it starts at {col}. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7215 When {col} is omitted zero is used. Otherwise it is the |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7216 screen column where to start. This matters for Tab |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7217 characters. |
|
2343
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
7218 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
|
7219 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
|
7220 'tabstop' and 'display'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7221 When {expr} contains characters with East Asian Width Class |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7222 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7223 Also see |strlen()|, |strwidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7224 |
| 7 | 7225 strftime({format} [, {time}]) *strftime()* |
| 7226 The result is a String, which is a formatted date and time, as | |
| 7227 specified by the {format} string. The given {time} is used, | |
| 7228 or the current time if no time is given. The accepted | |
| 7229 {format} depends on your system, thus this is not portable! | |
| 7230 See the manual page of the C function strftime() for the | |
| 7231 format. The maximum length of the result is 80 characters. | |
| 7232 See also |localtime()| and |getftime()|. | |
| 7233 The language can be changed with the |:language| command. | |
| 7234 Examples: > | |
| 7235 :echo strftime("%c") Sun Apr 27 11:49:23 1997 | |
| 7236 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 | |
| 7237 :echo strftime("%y%m%d %T") 970427 11:53:55 | |
| 7238 :echo strftime("%H:%M") 11:55 | |
| 7239 :echo strftime("%c", getftime("file.c")) | |
| 7240 Show mod time of file.c. | |
| 82 | 7241 < Not available on all systems. To check use: > |
| 7242 :if exists("*strftime") | |
| 7243 | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7244 strgetchar({str}, {index}) *strgetchar()* |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7245 Get character {index} from {str}. This uses a character |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7246 index, not a byte index. Composing characters are considered |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7247 separate characters here. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7248 Also see |strcharpart()| and |strchars()|. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7249 |
| 133 | 7250 stridx({haystack}, {needle} [, {start}]) *stridx()* |
| 7251 The result is a Number, which gives the byte index in | |
| 7252 {haystack} of the first occurrence of the String {needle}. | |
| 140 | 7253 If {start} is specified, the search starts at index {start}. |
| 7254 This can be used to find a second match: > | |
| 2662 | 7255 :let colon1 = stridx(line, ":") |
| 7256 :let colon2 = stridx(line, ":", colon1 + 1) | |
| 140 | 7257 < The search is done case-sensitive. |
| 205 | 7258 For pattern searches use |match()|. |
| 133 | 7259 -1 is returned if the {needle} does not occur in {haystack}. |
| 140 | 7260 See also |strridx()|. |
| 7261 Examples: > | |
| 7 | 7262 :echo stridx("An Example", "Example") 3 |
| 7263 :echo stridx("Starting point", "Start") 0 | |
| 7264 :echo stridx("Starting point", "start") -1 | |
| 856 | 7265 < *strstr()* *strchr()* |
| 170 | 7266 stridx() works similar to the C function strstr(). When used |
| 7267 with a single character it works similar to strchr(). | |
| 7268 | |
| 55 | 7269 *string()* |
| 95 | 7270 string({expr}) Return {expr} converted to a String. If {expr} is a Number, |
| 1621 | 7271 Float, String or a composition of them, then the result can be |
| 7272 parsed back with |eval()|. | |
| 55 | 7273 {expr} type result ~ |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
7274 String 'string' (single quotes are doubled) |
| 95 | 7275 Number 123 |
| 1621 | 7276 Float 123.123456 or 1.123456e8 |
| 99 | 7277 Funcref function('name') |
| 95 | 7278 List [item, item] |
| 323 | 7279 Dictionary {key: value, key: value} |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
7280 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
7281 When a List or Dictionary has a recursive reference it is |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
7282 replaced by "[...]" or "{...}". Using eval() on the result |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
7283 will then fail. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
7284 |
| 1156 | 7285 Also see |strtrans()|. |
| 55 | 7286 |
| 7 | 7287 *strlen()* |
| 7288 strlen({expr}) The result is a Number, which is the length of the String | |
| 502 | 7289 {expr} in bytes. |
| 55 | 7290 If the argument is a Number it is first converted to a String. |
| 7291 For other types an error is given. | |
| 6870 | 7292 If you want to count the number of multi-byte characters use |
| 7293 |strchars()|. | |
| 7294 Also see |len()|, |strdisplaywidth()| and |strwidth()|. | |
| 7 | 7295 |
| 7296 strpart({src}, {start}[, {len}]) *strpart()* | |
| 7297 The result is a String, which is part of {src}, starting from | |
| 574 | 7298 byte {start}, with the byte length {len}. |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7299 To count characters instead of bytes use |strcharpart()|. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7300 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7301 When bytes are selected which do not exist, this doesn't |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7302 result in an error, the bytes are simply omitted. |
| 7 | 7303 If {len} is missing, the copy continues from {start} till the |
| 7304 end of the {src}. > | |
| 7305 strpart("abcdefg", 3, 2) == "de" | |
| 7306 strpart("abcdefg", -2, 4) == "ab" | |
| 7307 strpart("abcdefg", 5, 4) == "fg" | |
| 1621 | 7308 strpart("abcdefg", 3) == "defg" |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7309 |
| 7 | 7310 < Note: To get the first character, {start} must be 0. For |
| 7311 example, to get three bytes under and after the cursor: > | |
| 823 | 7312 strpart(getline("."), col(".") - 1, 3) |
| 7 | 7313 < |
| 140 | 7314 strridx({haystack}, {needle} [, {start}]) *strridx()* |
| 7315 The result is a Number, which gives the byte index in | |
| 7316 {haystack} of the last occurrence of the String {needle}. | |
| 7317 When {start} is specified, matches beyond this index are | |
| 7318 ignored. This can be used to find a match before a previous | |
| 7319 match: > | |
| 7320 :let lastcomma = strridx(line, ",") | |
| 7321 :let comma2 = strridx(line, ",", lastcomma - 1) | |
| 7322 < The search is done case-sensitive. | |
| 133 | 7323 For pattern searches use |match()|. |
| 7324 -1 is returned if the {needle} does not occur in {haystack}. | |
| 22 | 7325 If the {needle} is empty the length of {haystack} is returned. |
| 236 | 7326 See also |stridx()|. Examples: > |
| 7 | 7327 :echo strridx("an angry armadillo", "an") 3 |
| 856 | 7328 < *strrchr()* |
| 170 | 7329 When used with a single character it works similar to the C |
| 7330 function strrchr(). | |
| 7331 | |
| 7 | 7332 strtrans({expr}) *strtrans()* |
| 7333 The result is a String, which is {expr} with all unprintable | |
| 7334 characters translated into printable characters |'isprint'|. | |
| 7335 Like they are shown in a window. Example: > | |
| 7336 echo strtrans(@a) | |
| 7337 < This displays a newline in register a as "^@" instead of | |
| 7338 starting a new line. | |
| 7339 | |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7340 strwidth({expr}) *strwidth()* |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7341 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
|
7342 String {expr} occupies. A Tab character is counted as one |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7343 cell, alternatively use |strdisplaywidth()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7344 When {expr} contains characters with East Asian Width Class |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7345 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7346 Also see |strlen()|, |strdisplaywidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7347 |
|
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9908
diff
changeset
|
7348 submatch({nr}[, {list}]) *submatch()* *E935* |
| 2908 | 7349 Only for an expression in a |:substitute| command or |
| 7350 substitute() function. | |
| 7351 Returns the {nr}'th submatch of the matched text. When {nr} | |
| 7352 is 0 the whole matched text is returned. | |
| 5794 | 7353 Note that a NL in the string can stand for a line break of a |
| 7354 multi-line match or a NUL character in the text. | |
| 2908 | 7355 Also see |sub-replace-expression|. |
| 5794 | 7356 |
| 7357 If {list} is present and non-zero then submatch() returns | |
| 7358 a list of strings, similar to |getline()| with two arguments. | |
| 7359 NL characters in the text represent NUL characters in the | |
| 7360 text. | |
| 7361 Only returns more than one item for |:substitute|, inside | |
| 7362 |substitute()| this list will always contain one or zero | |
| 7363 items, since there are no real line breaks. | |
| 7364 | |
| 7 | 7365 Example: > |
| 7366 :s/\d\+/\=submatch(0) + 1/ | |
| 7367 < This finds the first number in the line and adds one to it. | |
| 7368 A line break is included as a newline character. | |
| 7369 | |
| 7370 substitute({expr}, {pat}, {sub}, {flags}) *substitute()* | |
| 7371 The result is a String, which is a copy of {expr}, in which | |
| 2908 | 7372 the first match of {pat} is replaced with {sub}. |
| 7373 When {flags} is "g", all matches of {pat} in {expr} are | |
| 7374 replaced. Otherwise {flags} should be "". | |
| 7375 | |
| 7376 This works like the ":substitute" command (without any flags). | |
| 7377 But the matching with {pat} is always done like the 'magic' | |
| 7378 option is set and 'cpoptions' is empty (to make scripts | |
| 3967 | 7379 portable). 'ignorecase' is still relevant, use |/\c| or |/\C| |
| 7380 if you want to ignore or match case and ignore 'ignorecase'. | |
| 7381 'smartcase' is not used. See |string-match| for how {pat} is | |
| 7382 used. | |
| 2908 | 7383 |
| 7384 A "~" in {sub} is not replaced with the previous {sub}. | |
| 7 | 7385 Note that some codes in {sub} have a special meaning |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7386 |sub-replace-special|. For example, to replace something with |
| 7 | 7387 "\n" (two characters), use "\\\\n" or '\\n'. |
| 2908 | 7388 |
| 7 | 7389 When {pat} does not match in {expr}, {expr} is returned |
| 7390 unmodified. | |
| 2908 | 7391 |
| 7 | 7392 Example: > |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7393 :let &path = substitute(&path, ",\\=[^,]*$", "", "") |
| 7 | 7394 < This removes the last component of the 'path' option. > |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7395 :echo substitute("testing", ".*", "\\U\\0", "") |
| 7 | 7396 < results in "TESTING". |
| 2908 | 7397 |
| 7398 When {sub} starts with "\=", the remainder is interpreted as | |
| 7399 an expression. See |sub-replace-expression|. Example: > | |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7400 :echo substitute(s, '%\(\x\x\)', |
| 2833 | 7401 \ '\=nr2char("0x" . submatch(1))', 'g') |
| 7 | 7402 |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7403 < When {sub} is a Funcref that function is called, with one |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7404 optional argument. Example: > |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7405 :echo substitute(s, '%\(\x\x\)', SubNr, 'g') |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7406 < The optional argument is a list which contains the whole |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7407 matched string and up to nine submatches, like what |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7408 |submatch()| returns. Example: > |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7409 :echo substitute(s, '%\(\x\x\)', {m -> '0x' . m[1]}, 'g') |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7410 |
| 32 | 7411 synID({lnum}, {col}, {trans}) *synID()* |
| 7 | 7412 The result is a Number, which is the syntax ID at the position |
| 32 | 7413 {lnum} and {col} in the current window. |
| 7 | 7414 The syntax ID can be used with |synIDattr()| and |
| 7415 |synIDtrans()| to obtain syntax information about text. | |
| 419 | 7416 |
| 32 | 7417 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
| 419 | 7418 line. 'synmaxcol' applies, in a longer line zero is returned. |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
7419 Note that when the position is after the last character, |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
7420 that's where the cursor can be in Insert mode, synID() returns |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
7421 zero. |
| 419 | 7422 |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
7423 When {trans} is |TRUE|, transparent items are reduced to the |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7424 item that they reveal. This is useful when wanting to know |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
7425 the effective color. When {trans} is |FALSE|, the transparent |
| 7 | 7426 item is returned. This is useful when wanting to know which |
| 7427 syntax item is effective (e.g. inside parens). | |
| 7428 Warning: This function can be very slow. Best speed is | |
| 7429 obtained by going through the file in forward direction. | |
| 7430 | |
| 7431 Example (echoes the name of the syntax item under the cursor): > | |
| 7432 :echo synIDattr(synID(line("."), col("."), 1), "name") | |
| 7433 < | |
|
2401
e7751177126b
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
7434 |
| 7 | 7435 synIDattr({synID}, {what} [, {mode}]) *synIDattr()* |
| 7436 The result is a String, which is the {what} attribute of | |
| 7437 syntax ID {synID}. This can be used to obtain information | |
| 7438 about a syntax item. | |
| 7439 {mode} can be "gui", "cterm" or "term", to get the attributes | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7440 for that mode. When {mode} is omitted, or an invalid value is |
| 7 | 7441 used, the attributes for the currently active highlighting are |
| 7442 used (GUI, cterm or term). | |
| 7443 Use synIDtrans() to follow linked highlight groups. | |
| 7444 {what} result | |
| 7445 "name" the name of the syntax item | |
| 7446 "fg" foreground color (GUI: color name used to set | |
| 7447 the color, cterm: color number as a string, | |
| 7448 term: empty string) | |
| 1755 | 7449 "bg" background color (as with "fg") |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
7450 "font" font name (only available in the GUI) |
|
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
7451 |highlight-font| |
| 1755 | 7452 "sp" special color (as with "fg") |highlight-guisp| |
| 7 | 7453 "fg#" like "fg", but for the GUI and the GUI is |
| 7454 running the name in "#RRGGBB" form | |
| 7455 "bg#" like "fg#" for "bg" | |
| 1755 | 7456 "sp#" like "fg#" for "sp" |
| 7 | 7457 "bold" "1" if bold |
| 7458 "italic" "1" if italic | |
| 7459 "reverse" "1" if reverse | |
| 7460 "inverse" "1" if inverse (= reverse) | |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
7461 "standout" "1" if standout |
| 7 | 7462 "underline" "1" if underlined |
| 205 | 7463 "undercurl" "1" if undercurled |
| 7 | 7464 |
| 7465 Example (echoes the color of the syntax item under the | |
| 7466 cursor): > | |
| 7467 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
| 7468 < | |
| 7469 synIDtrans({synID}) *synIDtrans()* | |
| 7470 The result is a Number, which is the translated syntax ID of | |
| 7471 {synID}. This is the syntax group ID of what is being used to | |
| 7472 highlight the character. Highlight links given with | |
| 7473 ":highlight link" are followed. | |
| 7474 | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
7475 synconcealed({lnum}, {col}) *synconcealed()* |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
7476 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
|
7477 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
|
7478 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
|
7479 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
|
7480 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
|
7481 depending on the current setting of 'conceallevel'. The third |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
7482 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
|
7483 specific syntax region matched. This allows detection of the |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
7484 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
|
7485 consecutive regions with the same replacement character. |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
7486 For an example use see $VIMRUNTIME/syntax/2html.vim . |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
7487 |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
7488 |
| 1500 | 7489 synstack({lnum}, {col}) *synstack()* |
| 7490 Return a |List|, which is the stack of syntax items at the | |
| 7491 position {lnum} and {col} in the current window. Each item in | |
| 7492 the List is an ID like what |synID()| returns. | |
| 7493 The first item in the List is the outer region, following are | |
| 7494 items contained in that one. The last one is what |synID()| | |
| 7495 returns, unless not the whole item is highlighted or it is a | |
| 7496 transparent item. | |
| 7497 This function is useful for debugging a syntax file. | |
| 7498 Example that shows the syntax stack under the cursor: > | |
| 7499 for id in synstack(line("."), col(".")) | |
| 7500 echo synIDattr(id, "name") | |
| 7501 endfor | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
7502 < 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
|
7503 nothing is returned. The position just after the last |
|
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
7504 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
|
7505 valid positions. |
| 1500 | 7506 |
| 24 | 7507 system({expr} [, {input}]) *system()* *E677* |
| 5808 | 7508 Get the output of the shell command {expr} as a string. See |
| 7509 |systemlist()| to get the output as a List. | |
| 5806 | 7510 |
| 7511 When {input} is given and is a string this string is written | |
| 7512 to a file and passed as stdin to the command. The string is | |
| 7513 written as-is, you need to take care of using the correct line | |
| 7514 separators yourself. | |
| 7515 If {input} is given and is a |List| it is written to the file | |
| 7516 in a way |writefile()| does with {binary} set to "b" (i.e. | |
| 7517 with a newline between each list item with newlines inside | |
| 7518 list items converted to NULs). | |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
7519 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
7520 Pipes are not used, the 'shelltemp' option is not used. |
| 5806 | 7521 |
|
10038
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
7522 When prepended by |:silent| the terminal will not be set to |
| 6183 | 7523 cooked mode. This is meant to be used for commands that do |
| 7524 not need the user to type. It avoids stray characters showing | |
| 7525 up on the screen which require |CTRL-L| to remove. > | |
| 7526 :silent let f = system('ls *.vim') | |
| 7527 < | |
| 5690 | 7528 Note: Use |shellescape()| or |::S| with |expand()| or |
| 7529 |fnamemodify()| to escape special characters in a command | |
| 7530 argument. Newlines in {expr} may cause the command to fail. | |
| 7531 The characters in 'shellquote' and 'shellxquote' may also | |
| 7532 cause trouble. | |
| 7 | 7533 This is not to be used for interactive commands. |
| 1661 | 7534 |
| 7 | 7535 The result is a String. Example: > |
| 1661 | 7536 :let files = system("ls " . shellescape(expand('%:h'))) |
| 5690 | 7537 :let files = system('ls ' . expand('%:h:S')) |
| 7 | 7538 |
| 7539 < To make the result more system-independent, the shell output | |
| 7540 is filtered to replace <CR> with <NL> for Macintosh, and | |
| 7541 <CR><NL> with <NL> for DOS-like systems. | |
| 5277 | 7542 To avoid the string being truncated at a NUL, all NUL |
| 7543 characters are replaced with SOH (0x01). | |
| 7544 | |
| 7 | 7545 The command executed is constructed using several options: |
| 7546 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
| 7547 ({tmp} is an automatically generated file name). | |
| 7548 For Unix and OS/2 braces are put around {expr} to allow for | |
| 7549 concatenated commands. | |
| 7550 | |
| 794 | 7551 The command will be executed in "cooked" mode, so that a |
| 7552 CTRL-C will interrupt the command (on Unix at least). | |
| 7553 | |
| 7 | 7554 The resulting error code can be found in |v:shell_error|. |
| 7555 This function will fail in |restricted-mode|. | |
| 625 | 7556 |
| 7557 Note that any wrong value in the options mentioned above may | |
| 7558 make the function fail. It has also been reported to fail | |
| 7559 when using a security agent application. | |
| 7 | 7560 Unlike ":!cmd" there is no automatic check for changed files. |
| 7561 Use |:checktime| to force a check. | |
| 7562 | |
| 205 | 7563 |
| 5808 | 7564 systemlist({expr} [, {input}]) *systemlist()* |
| 7565 Same as |system()|, but returns a |List| with lines (parts of | |
| 7566 output separated by NL) with NULs transformed into NLs. Output | |
| 7567 is the same as |readfile()| will output with {binary} argument | |
| 7568 set to "b". | |
| 7569 | |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7570 Returns an empty string on error. |
| 5808 | 7571 |
| 7572 | |
| 677 | 7573 tabpagebuflist([{arg}]) *tabpagebuflist()* |
| 685 | 7574 The result is a |List|, where each item is the number of the |
| 677 | 7575 buffer associated with each window in the current tab page. |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
7576 {arg} specifies the number of the tab page to be used. When |
| 677 | 7577 omitted the current tab page is used. |
| 7578 When {arg} is invalid the number zero is returned. | |
| 7579 To get a list of all buffers in all tabs use this: > | |
| 3445 | 7580 let buflist = [] |
| 677 | 7581 for i in range(tabpagenr('$')) |
| 3445 | 7582 call extend(buflist, tabpagebuflist(i + 1)) |
| 677 | 7583 endfor |
| 7584 < Note that a buffer may appear in more than one window. | |
| 7585 | |
| 7586 | |
| 7587 tabpagenr([{arg}]) *tabpagenr()* | |
| 674 | 7588 The result is a Number, which is the number of the current |
| 7589 tab page. The first tab page has number 1. | |
| 7590 When the optional argument is "$", the number of the last tab | |
| 7591 page is returned (the tab page count). | |
| 7592 The number can be used with the |:tab| command. | |
| 7593 | |
| 7594 | |
| 5763 | 7595 tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()* |
|
2569
f612f6b0b883
Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7596 Like |winnr()| but for tab page {tabarg}. |
| 677 | 7597 {tabarg} specifies the number of tab page to be used. |
| 7598 {arg} is used like with |winnr()|: | |
| 7599 - When omitted the current window number is returned. This is | |
| 7600 the window which will be used when going to this tab page. | |
| 7601 - When "$" the number of windows is returned. | |
| 7602 - When "#" the previous window nr is returned. | |
| 7603 Useful examples: > | |
| 7604 tabpagewinnr(1) " current window of tab page 1 | |
| 7605 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
| 7606 < When {tabarg} is invalid zero is returned. | |
| 7607 | |
| 805 | 7608 *tagfiles()* |
| 7609 tagfiles() Returns a |List| with the file names used to search for tags | |
| 7610 for the current buffer. This is the 'tags' option expanded. | |
| 7611 | |
| 7612 | |
| 205 | 7613 taglist({expr}) *taglist()* |
| 7614 Returns a list of tags matching the regular expression {expr}. | |
| 438 | 7615 Each list item is a dictionary with at least the following |
| 7616 entries: | |
| 648 | 7617 name Name of the tag. |
| 7618 filename Name of the file where the tag is | |
| 1156 | 7619 defined. It is either relative to the |
| 7620 current directory or a full path. | |
| 205 | 7621 cmd Ex command used to locate the tag in |
| 7622 the file. | |
| 648 | 7623 kind Type of the tag. The value for this |
| 205 | 7624 entry depends on the language specific |
| 1156 | 7625 kind values. Only available when |
| 7626 using a tags file generated by | |
| 7627 Exuberant ctags or hdrtag. | |
| 648 | 7628 static A file specific tag. Refer to |
| 205 | 7629 |static-tag| for more information. |
| 1156 | 7630 More entries may be present, depending on the content of the |
| 7631 tags file: access, implementation, inherits and signature. | |
| 7632 Refer to the ctags documentation for information about these | |
| 7633 fields. For C code the fields "struct", "class" and "enum" | |
| 7634 may appear, they give the name of the entity the tag is | |
| 7635 contained in. | |
| 452 | 7636 |
| 216 | 7637 The ex-command 'cmd' can be either an ex search pattern, a |
| 7638 line number or a line number followed by a byte number. | |
| 205 | 7639 |
| 7640 If there are no matching tags, then an empty list is returned. | |
| 7641 | |
| 7642 To get an exact tag match, the anchors '^' and '$' should be | |
| 4073 | 7643 used in {expr}. This also make the function work faster. |
| 7644 Refer to |tag-regexp| for more information about the tag | |
| 7645 search regular expression pattern. | |
| 205 | 7646 |
| 7647 Refer to |'tags'| for information about how the tags file is | |
| 7648 located by Vim. Refer to |tags-file-format| for the format of | |
| 7649 the tags file generated by the different ctags tools. | |
| 7650 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7651 tan({expr}) *tan()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7652 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
|
7653 in the range [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7654 {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
|
7655 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7656 :echo tan(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7657 < 0.648361 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7658 :echo tan(-4.01) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7659 < -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
|
7660 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7661 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7662 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7663 tanh({expr}) *tanh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7664 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
|
7665 range [-1, 1]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7666 {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
|
7667 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7668 :echo tanh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7669 < 0.462117 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7670 :echo tanh(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7671 < -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
|
7672 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7673 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7674 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7675 tempname() *tempname()* *temp-file-name* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7676 The result is a String, which is the name of a file that |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7677 doesn't exist. It can be used for a temporary file. The name |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7678 is different for at least 26 consecutive calls. Example: > |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7679 :let tmpfile = tempname() |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7680 :exe "redir > " . tmpfile |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7681 < For Unix, the file will be in a private directory |tempfile|. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7682 For MS-Windows forward slashes are used when the 'shellslash' |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7683 option is set or when 'shellcmdflag' starts with '-'. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7684 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7685 |
|
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
7686 test_alloc_fail({id}, {countdown}, {repeat}) *test_alloc_fail()* |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
7687 This is for testing: If the memory allocation with {id} is |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
7688 called, then decrement {countdown}, and when it reaches zero |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
7689 let memory allocation fail {repeat} times. When {repeat} is |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
7690 smaller than one it fails one time. |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
7691 |
|
9644
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
7692 test_autochdir() *test_autochdir()* |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
7693 Set a flag to enable the effect of 'autochdir' before Vim |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
7694 startup has finished. |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
7695 |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
7696 *test_disable_char_avail()* |
|
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
7697 test_disable_char_avail({expr}) |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
7698 When {expr} is 1 the internal char_avail() function will |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
7699 return |FALSE|. When {expr} is 0 the char_avail() function will |
|
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
7700 function normally. |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
7701 Only use this for a test where typeahead causes the test not |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
7702 to work. E.g., to trigger the CursorMovedI autocommand event. |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
7703 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7704 test_garbagecollect_now() *test_garbagecollect_now()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7705 Like garbagecollect(), but executed right away. This must |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7706 only be called directly to avoid any structure to exist |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7707 internally, and |v:testing| must have been set before calling |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7708 any function. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7709 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7710 test_null_channel() *test_null_channel()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7711 Return a Channel that is null. Only useful for testing. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7712 {only available when compiled with the +channel feature} |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7713 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7714 test_null_dict() *test_null_dict()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7715 Return a Dict that is null. Only useful for testing. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7716 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7717 test_null_job() *test_null_job()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7718 Return a Job that is null. Only useful for testing. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7719 {only available when compiled with the +job feature} |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7720 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7721 test_null_list() *test_null_list()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7722 Return a List that is null. Only useful for testing. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7723 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7724 test_null_partial() *test_null_partial()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7725 Return a Partial that is null. Only useful for testing. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7726 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7727 test_null_string() *test_null_string()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7728 Return a String that is null. Only useful for testing. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7729 |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
7730 test_settime({expr}) *test_settime()* |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
7731 Set the time Vim uses internally. Currently only used for |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
7732 timestamps in the history, as they are used in viminfo, and |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
7733 for undo. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
7734 {expr} must evaluate to a number. When the value is zero the |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
7735 normal behavior is restored. |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
7736 |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7737 *timer_info()* |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7738 timer_info([{id}]) |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7739 Return a list with information about timers. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7740 When {id} is given only information about this timer is |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7741 returned. When timer {id} does not exist an empty list is |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7742 returned. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7743 When {id} is omitted information about all timers is returned. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7744 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7745 For each timer the information is stored in a Dictionary with |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7746 these items: |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7747 "id" the timer ID |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7748 "time" time the timer was started with |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7749 "remaining" time until the timer fires |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7750 "repeat" number of times the timer will still fire; |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7751 -1 means forever |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7752 "callback" the callback |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7753 "paused" 1 if the timer is paused, 0 otherwise |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7754 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7755 {only available when compiled with the |+timers| feature} |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7756 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7757 timer_pause({timer}, {paused}) *timer_pause()* |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7758 Pause or unpause a timer. A paused timer does not invoke its |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
7759 callback when its time expires. Unpausing a timer may cause |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
7760 the callback to be invoked almost immediately if enough time |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
7761 has passed. |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7762 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7763 Pausing a timer is useful to avoid the callback to be called |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7764 for a short time. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7765 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7766 If {paused} evaluates to a non-zero Number or a non-empty |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7767 String, then the timer is paused, otherwise it is unpaused. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7768 See |non-zero-arg|. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7769 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7770 {only available when compiled with the |+timers| feature} |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7771 |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
7772 *timer_start()* *timer* *timers* |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7773 timer_start({time}, {callback} [, {options}]) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7774 Create a timer and return the timer ID. |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7775 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7776 {time} is the waiting time in milliseconds. This is the |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7777 minimum time before invoking the callback. When the system is |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7778 busy or Vim is not waiting for input the time will be longer. |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7779 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7780 {callback} is the function to call. It can be the name of a |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7781 function or a Funcref. It is called with one argument, which |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7782 is the timer ID. The callback is only invoked when Vim is |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7783 waiting for input. |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7784 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7785 {options} is a dictionary. Supported entries: |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7786 "repeat" Number of times to repeat calling the |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
7787 callback. -1 means forever. |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7788 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7789 Example: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7790 func MyHandler(timer) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7791 echo 'Handler called' |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7792 endfunc |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7793 let timer = timer_start(500, 'MyHandler', |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7794 \ {'repeat': 3}) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7795 < This will invoke MyHandler() three times at 500 msec |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7796 intervals. |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7797 |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7798 {only available when compiled with the |+timers| feature} |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7799 |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
7800 timer_stop({timer}) *timer_stop()* |
|
9097
071f9da012fb
commit https://github.com/vim/vim/commit/06d2d38ab7564e1f784b1058a4ef4580cd6d1810
Christian Brabandt <cb@256bit.org>
parents:
9076
diff
changeset
|
7801 Stop a timer. The timer callback will no longer be invoked. |
|
071f9da012fb
commit https://github.com/vim/vim/commit/06d2d38ab7564e1f784b1058a4ef4580cd6d1810
Christian Brabandt <cb@256bit.org>
parents:
9076
diff
changeset
|
7802 {timer} is an ID returned by timer_start(), thus it must be a |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7803 Number. If {timer} does not exist there is no error. |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
7804 |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7805 {only available when compiled with the |+timers| feature} |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7806 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7807 timer_stopall() *timer_stopall()* |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7808 Stop all timers. The timer callbacks will no longer be |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7809 invoked. Useful if some timers is misbehaving. If there are |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7810 no timers there is no error. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7811 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7812 {only available when compiled with the |+timers| feature} |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
7813 |
| 7 | 7814 tolower({expr}) *tolower()* |
| 7815 The result is a copy of the String given, with all uppercase | |
| 7816 characters turned into lowercase (just like applying |gu| to | |
| 7817 the string). | |
| 7818 | |
| 7819 toupper({expr}) *toupper()* | |
| 7820 The result is a copy of the String given, with all lowercase | |
| 7821 characters turned into uppercase (just like applying |gU| to | |
| 7822 the string). | |
| 7823 | |
| 15 | 7824 tr({src}, {fromstr}, {tostr}) *tr()* |
| 7825 The result is a copy of the {src} string with all characters | |
| 7826 which appear in {fromstr} replaced by the character in that | |
| 7827 position in the {tostr} string. Thus the first character in | |
| 7828 {fromstr} is translated into the first character in {tostr} | |
| 7829 and so on. Exactly like the unix "tr" command. | |
| 7830 This code also deals with multibyte characters properly. | |
| 7831 | |
| 7832 Examples: > | |
| 7833 echo tr("hello there", "ht", "HT") | |
| 7834 < returns "Hello THere" > | |
| 7835 echo tr("<blob>", "<>", "{}") | |
| 7836 < returns "{blob}" | |
| 7837 | |
| 1621 | 7838 trunc({expr}) *trunc()* |
| 1668 | 7839 Return the largest integral value with magnitude less than or |
| 1621 | 7840 equal to {expr} as a |Float| (truncate towards zero). |
| 7841 {expr} must evaluate to a |Float| or a |Number|. | |
| 7842 Examples: > | |
| 7843 echo trunc(1.456) | |
| 7844 < 1.0 > | |
| 7845 echo trunc(-5.456) | |
| 7846 < -5.0 > | |
| 7847 echo trunc(4.0) | |
| 7848 < 4.0 | |
| 7849 {only available when compiled with the |+float| feature} | |
| 7850 | |
| 87 | 7851 *type()* |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7852 type({expr}) The result is a Number representing the type of {expr}. |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7853 Instead of using the number directly, it is better to use the |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7854 v:t_ variable that has the value: |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7855 Number: 0 |v:t_number| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7856 String: 1 |v:t_string| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7857 Funcref: 2 |v:t_func| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7858 List: 3 |v:t_list| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7859 Dictionary: 4 |v:t_dict| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7860 Float: 5 |v:t_float| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7861 Boolean: 6 |v:t_bool| (v:false and v:true) |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7862 None 7 |v:t_none| (v:null and v:none) |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7863 Job 8 |v:t_job| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7864 Channel 9 |v:t_channel| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7865 For backward compatibility, this method can be used: > |
| 87 | 7866 :if type(myvar) == type(0) |
| 7867 :if type(myvar) == type("") | |
| 7868 :if type(myvar) == type(function("tr")) | |
| 7869 :if type(myvar) == type([]) | |
| 153 | 7870 :if type(myvar) == type({}) |
| 1621 | 7871 :if type(myvar) == type(0.0) |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
7872 :if type(myvar) == type(v:false) |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
7873 :if type(myvar) == type(v:none) |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7874 < To check if the v:t_ variables exist use this: > |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7875 :if exists('v:t_number') |
| 7 | 7876 |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
7877 undofile({name}) *undofile()* |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
7878 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
|
7879 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
|
7880 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
|
7881 the undo file exists. |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
7882 {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
|
7883 is used internally. |
|
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
7884 If {name} is empty undofile() returns an empty string, since a |
|
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
7885 buffer without a file name will not write an undo file. |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
7886 Useful in combination with |:wundo| and |:rundo|. |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
7887 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
|
7888 returns an empty string. |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
7889 |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7890 undotree() *undotree()* |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7891 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
|
7892 the following items: |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7893 "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
|
7894 "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
|
7895 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
|
7896 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
|
7897 "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
|
7898 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
|
7899 something readable. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7900 "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
|
7901 write yet. |
|
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
7902 "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
|
7903 tree. |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7904 "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
|
7905 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
|
7906 user. See |undo-blocks|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7907 "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
|
7908 undo blocks. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7909 |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7910 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
|
7911 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
|
7912 "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
|
7913 |:undolist|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7914 "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
|
7915 |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
|
7916 "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
|
7917 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
|
7918 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
|
7919 "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
|
7920 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
|
7921 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
|
7922 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
|
7923 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
|
7924 not appear anywhere. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7925 "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
|
7926 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
|
7927 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
|
7928 "save_last" mentioned above. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7929 "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
|
7930 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
|
7931 item. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
7932 |
| 5747 | 7933 uniq({list} [, {func} [, {dict}]]) *uniq()* *E882* |
| 7934 Remove second and succeeding copies of repeated adjacent | |
| 7935 {list} items in-place. Returns {list}. If you want a list | |
| 7936 to remain unmodified make a copy first: > | |
| 7937 :let newlist = uniq(copy(mylist)) | |
| 7938 < The default compare function uses the string representation of | |
| 7939 each item. For the use of {func} and {dict} see |sort()|. | |
| 7940 | |
| 140 | 7941 values({dict}) *values()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7942 Return a |List| with all the values of {dict}. The |List| is |
| 685 | 7943 in arbitrary order. |
| 140 | 7944 |
| 7945 | |
| 7 | 7946 virtcol({expr}) *virtcol()* |
| 7947 The result is a Number, which is the screen column of the file | |
| 7948 position given with {expr}. That is, the last screen position | |
| 7949 occupied by the character at that position, when the screen | |
| 7950 would be of unlimited width. When there is a <Tab> at the | |
| 7951 position, the returned Number will be the column at the end of | |
| 7952 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
| 3445 | 7953 set to 8, it returns 8. |conceal| is ignored. |
| 1317 | 7954 For the byte position use |col()|. |
| 7955 For the use of {expr} see |col()|. | |
| 7956 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
| 703 | 7957 "off" is the offset in screen columns from the start of the |
| 1266 | 7958 character. E.g., a position within a <Tab> or after the last |
| 2965 | 7959 character. When "off" is omitted zero is used. |
| 7 | 7960 When Virtual editing is active in the current mode, a position |
| 7961 beyond the end of the line can be returned. |'virtualedit'| | |
| 7962 The accepted positions are: | |
| 7963 . the cursor position | |
| 7964 $ the end of the cursor line (the result is the | |
| 7965 number of displayed characters in the cursor line | |
| 7966 plus one) | |
| 7967 'x position of mark x (if the mark is not set, 0 is | |
| 7968 returned) | |
| 6447 | 7969 v In Visual mode: the start of the Visual area (the |
| 7970 cursor is the end). When not in Visual mode | |
| 7971 returns the cursor position. Differs from |'<| in | |
| 7972 that it's updated right away. | |
| 7 | 7973 Note that only marks in the current file can be used. |
| 7974 Examples: > | |
| 7975 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
| 7976 virtcol("$") with text "foo^Lbar", returns 9 | |
| 1621 | 7977 virtcol("'t") with text " there", with 't at 'h', returns 6 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7978 < The first column is 1. 0 is returned for an error. |
| 1156 | 7979 A more advanced example that echoes the maximum length of |
| 7980 all lines: > | |
| 7981 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
| 7982 | |
| 7 | 7983 |
| 7984 visualmode([expr]) *visualmode()* | |
| 7985 The result is a String, which describes the last Visual mode | |
| 856 | 7986 used in the current buffer. Initially it returns an empty |
| 7987 string, but once Visual mode has been used, it returns "v", | |
| 7988 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
| 7989 character-wise, line-wise, or block-wise Visual mode | |
| 7990 respectively. | |
| 7 | 7991 Example: > |
| 7992 :exe "normal " . visualmode() | |
| 7993 < This enters the same Visual mode as before. It is also useful | |
| 7994 in scripts if you wish to act differently depending on the | |
| 7995 Visual mode that was used. | |
| 1621 | 7996 If Visual mode is active, use |mode()| to get the Visual mode |
| 7997 (e.g., in a |:vmap|). | |
| 1661 | 7998 If [expr] is supplied and it evaluates to a non-zero Number or |
| 7999 a non-empty String, then the Visual mode will be cleared and | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
8000 the old value is returned. See |non-zero-arg|. |
| 7 | 8001 |
| 4151 | 8002 wildmenumode() *wildmenumode()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
8003 Returns |TRUE| when the wildmenu is active and |FALSE| |
| 4151 | 8004 otherwise. See 'wildmenu' and 'wildmode'. |
| 8005 This can be used in mappings to handle the 'wildcharm' option | |
| 8006 gracefully. (Makes only sense with |mapmode-c| mappings). | |
| 8007 | |
| 8008 For example to make <c-j> work like <down> in wildmode, use: > | |
| 8009 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>" | |
| 8010 < | |
| 8011 (Note, this needs the 'wildcharm' option set appropriately). | |
| 8012 | |
| 8013 | |
|
8536
09041d2fd7d0
commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents:
8534
diff
changeset
|
8014 win_findbuf({bufnr}) *win_findbuf()* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
8015 Returns a list with |window-ID|s for windows that contain |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
8016 buffer {bufnr}. When there is none the list is empty. |
|
8536
09041d2fd7d0
commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents:
8534
diff
changeset
|
8017 |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8018 win_getid([{win} [, {tab}]]) *win_getid()* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
8019 Get the |window-ID| for the specified window. |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8020 When {win} is missing use the current window. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8021 With {win} this is the window number. The top window has |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8022 number 1. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8023 Without {tab} use the current tab, otherwise the tab with |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8024 number {tab}. The first tab has number one. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8025 Return zero if the window cannot be found. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8026 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8027 win_gotoid({expr}) *win_gotoid()* |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8028 Go to window with ID {expr}. This may also change the current |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8029 tabpage. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8030 Return 1 if successful, 0 if the window cannot be found. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8031 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8032 win_id2tabwin({expr}) *win_id2tabwin()* |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8033 Return a list with the tab number and window number of window |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8034 with ID {expr}: [tabnr, winnr]. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8035 Return [0, 0] if the window cannot be found. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8036 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8037 win_id2win({expr}) *win_id2win()* |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8038 Return the window number of window with ID {expr}. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8039 Return 0 if the window cannot be found in the current tabpage. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8040 |
| 7 | 8041 *winbufnr()* |
| 8042 winbufnr({nr}) The result is a Number, which is the number of the buffer | |
|
9223
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
8043 associated with window {nr}. {nr} can be the window number or |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
8044 the |window-ID|. |
|
9223
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
8045 When {nr} is zero, the number of the buffer in the current |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
8046 window is returned. |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
8047 When window {nr} doesn't exist, -1 is returned. |
| 7 | 8048 Example: > |
| 8049 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
| 8050 < | |
| 8051 *wincol()* | |
| 8052 wincol() The result is a Number, which is the virtual column of the | |
| 8053 cursor in the window. This is counting screen cells from the | |
| 8054 left side of the window. The leftmost column is one. | |
| 8055 | |
| 8056 winheight({nr}) *winheight()* | |
| 8057 The result is a Number, which is the height of window {nr}. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
8058 {nr} can be the window number or the |window-ID|. |
| 7 | 8059 When {nr} is zero, the height of the current window is |
| 8060 returned. When window {nr} doesn't exist, -1 is returned. | |
| 8061 An existing window always has a height of zero or more. | |
| 8062 Examples: > | |
| 8063 :echo "The current window has " . winheight(0) . " lines." | |
| 8064 < | |
| 8065 *winline()* | |
| 8066 winline() The result is a Number, which is the screen line of the cursor | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8067 in the window. This is counting screen lines from the top of |
| 7 | 8068 the window. The first line is one. |
| 531 | 8069 If the cursor was moved the view on the file will be updated |
| 8070 first, this may cause a scroll. | |
| 7 | 8071 |
| 8072 *winnr()* | |
| 20 | 8073 winnr([{arg}]) The result is a Number, which is the number of the current |
| 8074 window. The top window has number 1. | |
| 8075 When the optional argument is "$", the number of the | |
| 3967 | 8076 last window is returned (the window count). > |
| 8077 let window_count = winnr('$') | |
| 8078 < When the optional argument is "#", the number of the last | |
| 20 | 8079 accessed window is returned (where |CTRL-W_p| goes to). |
| 1156 | 8080 If there is no previous window or it is in another tab page 0 |
| 8081 is returned. | |
| 20 | 8082 The number can be used with |CTRL-W_w| and ":wincmd w" |
| 8083 |:wincmd|. | |
| 1156 | 8084 Also see |tabpagewinnr()|. |
| 7 | 8085 |
| 8086 *winrestcmd()* | |
| 8087 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
| 8088 the current window sizes. Only works properly when no windows | |
| 712 | 8089 are opened or closed and the current window and tab page is |
| 8090 unchanged. | |
| 7 | 8091 Example: > |
| 8092 :let cmd = winrestcmd() | |
| 8093 :call MessWithWindowSizes() | |
| 8094 :exe cmd | |
| 712 | 8095 < |
| 8096 *winrestview()* | |
| 8097 winrestview({dict}) | |
| 8098 Uses the |Dictionary| returned by |winsaveview()| to restore | |
| 8099 the view of the current window. | |
| 5940 | 8100 Note: The {dict} does not have to contain all values, that are |
| 8101 returned by |winsaveview()|. If values are missing, those | |
| 8102 settings won't be restored. So you can use: > | |
| 8103 :call winrestview({'curswant': 4}) | |
| 8104 < | |
| 8105 This will only set the curswant value (the column the cursor | |
| 8106 wants to move on vertical movements) of the cursor to column 5 | |
| 8107 (yes, that is 5), while all other settings will remain the | |
| 8108 same. This is useful, if you set the cursor position manually. | |
| 8109 | |
| 712 | 8110 If you have changed the values the result is unpredictable. |
| 8111 If the window size changed the result won't be the same. | |
| 8112 | |
| 8113 *winsaveview()* | |
| 8114 winsaveview() Returns a |Dictionary| that contains information to restore | |
| 8115 the view of the current window. Use |winrestview()| to | |
| 8116 restore the view. | |
| 8117 This is useful if you have a mapping that jumps around in the | |
| 8118 buffer and you want to go back to the original view. | |
| 8119 This does not save fold information. Use the 'foldenable' | |
| 798 | 8120 option to temporarily switch off folding, so that folds are |
|
6070
32a77cc160d9
Update runtime files. Make matchparen plugin backwards compatible.
Bram Moolenaar <bram@vim.org>
parents:
6051
diff
changeset
|
8121 not opened when moving around. This may have side effects. |
| 712 | 8122 The return value includes: |
| 8123 lnum cursor line number | |
| 5940 | 8124 col cursor column (Note: the first column |
| 8125 zero, as opposed to what getpos() | |
| 8126 returns) | |
| 712 | 8127 coladd cursor column offset for 'virtualedit' |
| 8128 curswant column for vertical movement | |
| 8129 topline first line in the window | |
| 8130 topfill filler lines, only in diff mode | |
| 8131 leftcol first column displayed | |
| 8132 skipcol columns skipped | |
| 8133 Note that no option values are saved. | |
| 8134 | |
| 7 | 8135 |
| 8136 winwidth({nr}) *winwidth()* | |
| 8137 The result is a Number, which is the width of window {nr}. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
8138 {nr} can be the window number or the |window-ID|. |
| 7 | 8139 When {nr} is zero, the width of the current window is |
| 8140 returned. When window {nr} doesn't exist, -1 is returned. | |
| 8141 An existing window always has a width of zero or more. | |
| 8142 Examples: > | |
| 8143 :echo "The current window has " . winwidth(0) . " columns." | |
| 8144 :if winwidth(0) <= 50 | |
| 8145 : exe "normal 50\<C-W>|" | |
| 8146 :endif | |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
8147 < For getting the terminal or screen size, see the 'columns' |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
8148 option. |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
8149 |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
8150 |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8151 wordcount() *wordcount()* |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8152 The result is a dictionary of byte/chars/word statistics for |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8153 the current buffer. This is the same info as provided by |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8154 |g_CTRL-G| |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8155 The return value includes: |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8156 bytes Number of bytes in the buffer |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8157 chars Number of chars in the buffer |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8158 words Number of words in the buffer |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8159 cursor_bytes Number of bytes before cursor position |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8160 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8161 cursor_chars Number of chars before cursor position |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8162 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8163 cursor_words Number of words before cursor position |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8164 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8165 visual_bytes Number of bytes visually selected |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8166 (only in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8167 visual_chars Number of chars visually selected |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8168 (only in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8169 visual_words Number of chars visually selected |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8170 (only in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8171 |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8172 |
| 158 | 8173 *writefile()* |
| 6341 | 8174 writefile({list}, {fname} [, {flags}]) |
| 685 | 8175 Write |List| {list} to file {fname}. Each list item is |
| 158 | 8176 separated with a NL. Each list item must be a String or |
| 8177 Number. | |
| 6341 | 8178 When {flags} contains "b" then binary mode is used: There will |
| 158 | 8179 not be a NL after the last list item. An empty item at the |
| 8180 end does cause the last line in the file to end in a NL. | |
| 6341 | 8181 |
| 8182 When {flags} contains "a" then append mode is used, lines are | |
| 8183 append to the file: > | |
| 8184 :call writefile(["foo"], "event.log", "a") | |
| 8185 :call writefile(["bar"], "event.log", "a") | |
| 8186 > | |
| 8187 < All NL characters are replaced with a NUL character. | |
| 158 | 8188 Inserting CR characters needs to be done before passing {list} |
| 8189 to writefile(). | |
| 8190 An existing file is overwritten, if possible. | |
| 8191 When the write fails -1 is returned, otherwise 0. There is an | |
| 8192 error message if the file can't be created or when writing | |
| 8193 fails. | |
| 8194 Also see |readfile()|. | |
| 8195 To copy a file byte for byte: > | |
| 8196 :let fl = readfile("foo", "b") | |
| 8197 :call writefile(fl, "foocopy", "b") | |
| 3214 | 8198 |
| 8199 | |
| 8200 xor({expr}, {expr}) *xor()* | |
| 8201 Bitwise XOR on the two arguments. The arguments are converted | |
| 8202 to a number. A List, Dict or Float argument causes an error. | |
| 8203 Example: > | |
| 8204 :let bits = xor(bits, 0x80) | |
| 3256 | 8205 < |
| 3214 | 8206 |
| 7 | 8207 |
| 8208 *feature-list* | |
| 6009 | 8209 There are four types of features: |
| 7 | 8210 1. Features that are only supported when they have been enabled when Vim |
| 8211 was compiled |+feature-list|. Example: > | |
| 8212 :if has("cindent") | |
| 8213 2. Features that are only supported when certain conditions have been met. | |
| 8214 Example: > | |
| 8215 :if has("gui_running") | |
| 8216 < *has-patch* | |
| 5814 | 8217 3. Included patches. The "patch123" feature means that patch 123 has been |
| 8218 included. Note that this form does not check the version of Vim, you need | |
| 8219 to inspect |v:version| for that. | |
| 8220 Example (checking version 6.2.148 or later): > | |
| 7 | 8221 :if v:version > 602 || v:version == 602 && has("patch148") |
| 5814 | 8222 < Note that it's possible for patch 147 to be omitted even though 148 is |
| 8223 included. | |
| 8224 | |
| 8225 4. Beyond a certain version or at a certain version and including a specific | |
| 5862 | 8226 patch. The "patch-7.4.237" feature means that the Vim version is 7.5 or |
| 8227 later, or it is version 7.4 and patch 237 was included. | |
| 8228 Note that this only works for patch 7.4.237 and later, before that you | |
| 8229 need to use the example above that checks v:version. Example: > | |
| 8230 :if has("patch-7.4.248") | |
| 5814 | 8231 < Note that it's possible for patch 147 to be omitted even though 148 is |
| 1156 | 8232 included. |
| 7 | 8233 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
8234 Hint: To find out if Vim supports backslashes in a file name (MS-Windows), |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
8235 use: `if exists('+shellslash')` |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
8236 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
8237 |
| 5340 | 8238 acl Compiled with |ACL| support. |
| 7 | 8239 all_builtin_terms Compiled with all builtin terminals enabled. |
| 8240 amiga Amiga version of Vim. | |
| 8241 arabic Compiled with Arabic support |Arabic|. | |
| 8242 arp Compiled with ARP support (Amiga). | |
| 613 | 8243 autocmd Compiled with autocommand support. |autocommand| |
| 7 | 8244 balloon_eval Compiled with |balloon-eval| support. |
| 435 | 8245 balloon_multiline GUI supports multiline balloons. |
| 7 | 8246 beos BeOS version of Vim. |
| 8247 browse Compiled with |:browse| support, and browse() will | |
| 8248 work. | |
| 3682 | 8249 browsefilter Compiled with support for |browsefilter|. |
| 7 | 8250 builtin_terms Compiled with some builtin terminals. |
| 8251 byte_offset Compiled with support for 'o' in 'statusline' | |
| 8252 cindent Compiled with 'cindent' support. | |
| 8253 clientserver Compiled with remote invocation support |clientserver|. | |
| 8254 clipboard Compiled with 'clipboard' support. | |
| 8255 cmdline_compl Compiled with |cmdline-completion| support. | |
| 8256 cmdline_hist Compiled with |cmdline-history| support. | |
| 8257 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
| 8258 comments Compiled with |'comments'| support. | |
| 2681 | 8259 compatible Compiled to be very Vi compatible. |
| 7 | 8260 cryptv Compiled with encryption support |encryption|. |
| 8261 cscope Compiled with |cscope| support. | |
| 8262 debug Compiled with "DEBUG" defined. | |
| 8263 dialog_con Compiled with console dialog support. | |
| 8264 dialog_gui Compiled with GUI dialog support. | |
| 8265 diff Compiled with |vimdiff| and 'diff' support. | |
| 8266 digraphs Compiled with support for digraphs. | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8267 directx Compiled with support for DirectX and 'renderoptions'. |
| 7 | 8268 dnd Compiled with support for the "~ register |quote_~|. |
| 8269 ebcdic Compiled on a machine with ebcdic character set. | |
| 8270 emacs_tags Compiled with support for Emacs tags. | |
| 8271 eval Compiled with expression evaluation support. Always | |
| 8272 true, of course! | |
|
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7788
diff
changeset
|
8273 ex_extra |+ex_extra|, always true now |
| 7 | 8274 extra_search Compiled with support for |'incsearch'| and |
| 8275 |'hlsearch'| | |
| 8276 farsi Compiled with Farsi support |farsi|. | |
| 8277 file_in_path Compiled with support for |gf| and |<cfile>| | |
| 168 | 8278 filterpipe When 'shelltemp' is off pipes are used for shell |
| 8279 read/write/filter commands | |
| 7 | 8280 find_in_path Compiled with support for include file searches |
| 8281 |+find_in_path|. | |
| 1621 | 8282 float Compiled with support for |Float|. |
| 7 | 8283 fname_case Case in file names matters (for Amiga, MS-DOS, and |
| 8284 Windows this is not present). | |
| 8285 folding Compiled with |folding| support. | |
| 8286 footer Compiled with GUI footer support. |gui-footer| | |
| 8287 fork Compiled to use fork()/exec() instead of system(). | |
| 8288 gettext Compiled with message translation |multi-lang| | |
| 8289 gui Compiled with GUI enabled. | |
| 8290 gui_athena Compiled with Athena GUI. | |
| 2681 | 8291 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
| 7 | 8292 gui_gtk Compiled with GTK+ GUI (any version). |
| 8293 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined). | |
|
8218
3456e2ebebd4
commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents:
8178
diff
changeset
|
8294 gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined). |
| 7 | 8295 gui_mac Compiled with Macintosh GUI. |
| 8296 gui_motif Compiled with Motif GUI. | |
| 8297 gui_photon Compiled with Photon GUI. | |
| 2681 | 8298 gui_running Vim is running in the GUI, or it will start soon. |
| 7 | 8299 gui_win32 Compiled with MS Windows Win32 GUI. |
| 8300 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
| 8301 hangul_input Compiled with Hangul input support. |hangul| | |
| 8302 iconv Can use iconv() for conversion. | |
| 8303 insert_expand Compiled with support for CTRL-X expansion commands in | |
| 8304 Insert mode. | |
| 8305 jumplist Compiled with |jumplist| support. | |
| 8306 keymap Compiled with 'keymap' support. | |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
8307 lambda Compiled with |lambda| support. |
| 7 | 8308 langmap Compiled with 'langmap' support. |
| 8309 libcall Compiled with |libcall()| support. | |
| 5995 | 8310 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and |
| 8311 'breakindent' support. | |
| 7 | 8312 lispindent Compiled with support for lisp indenting. |
| 8313 listcmds Compiled with commands for the buffer list |:files| | |
| 8314 and the argument list |arglist|. | |
| 8315 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
|
8316 lua Compiled with Lua interface |Lua|. |
|
8094
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
8317 mac Any Macintosh version of Vim. |
|
8078
7676818d486b
commit https://github.com/vim/vim/commit/f8df7addc5f741c16fa2a458f8777ac1fdf2e01e
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
8318 macunix Compiled for OS X, with darwin |
|
7676818d486b
commit https://github.com/vim/vim/commit/f8df7addc5f741c16fa2a458f8777ac1fdf2e01e
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
8319 osx Compiled for OS X, with or without darwin |
| 7 | 8320 menu Compiled with support for |:menu|. |
| 8321 mksession Compiled with support for |:mksession|. | |
| 8322 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
| 8323 mouse Compiled with support mouse. | |
| 8324 mouse_dec Compiled with support for Dec terminal mouse. | |
| 8325 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
| 8326 mouse_netterm Compiled with support for netterm mouse. | |
| 8327 mouse_pterm Compiled with support for qnx pterm mouse. | |
| 1621 | 8328 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
| 3750 | 8329 mouse_sgr Compiled with support for sgr mouse. |
| 3224 | 8330 mouse_urxvt Compiled with support for urxvt mouse. |
| 7 | 8331 mouse_xterm Compiled with support for xterm mouse. |
| 2681 | 8332 mouseshape Compiled with support for 'mouseshape'. |
| 1768 | 8333 multi_byte Compiled with support for 'encoding' |
| 8334 multi_byte_encoding 'encoding' is set to a multi-byte encoding. | |
| 7 | 8335 multi_byte_ime Compiled with support for IME input method. |
| 8336 multi_lang Compiled with support for multiple languages. | |
| 14 | 8337 mzscheme Compiled with MzScheme interface |mzscheme|. |
| 2681 | 8338 netbeans_enabled Compiled with support for |netbeans| and connected. |
| 7 | 8339 netbeans_intg Compiled with support for |netbeans|. |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
8340 num64 Compiled with 64-bit |Number| support. |
| 7 | 8341 ole Compiled with OLE automation support for Win32. |
|
9076
9305a1251e51
commit https://github.com/vim/vim/commit/91c4937be15b0b743b6bc495df602c1abbff6b87
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
8342 packages Compiled with |packages| support. |
| 7 | 8343 path_extra Compiled with up/downwards search in 'path' and 'tags' |
| 8344 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
|
8345 persistent_undo Compiled with support for persistent undo history. |
| 7 | 8346 postscript Compiled with PostScript file printing. |
| 8347 printer Compiled with |:hardcopy| support. | |
| 170 | 8348 profile Compiled with |:profile| support. |
| 2826 | 8349 python Compiled with Python 2.x interface. |has-python| |
| 8350 python3 Compiled with Python 3.x interface. |has-python| | |
| 7 | 8351 qnx QNX version of Vim. |
| 8352 quickfix Compiled with |quickfix| support. | |
| 857 | 8353 reltime Compiled with |reltime()| support. |
| 7 | 8354 rightleft Compiled with 'rightleft' support. |
| 8355 ruby Compiled with Ruby interface |ruby|. | |
| 8356 scrollbind Compiled with 'scrollbind' support. | |
| 8357 showcmd Compiled with 'showcmd' support. | |
| 8358 signs Compiled with |:sign| support. | |
| 8359 smartindent Compiled with 'smartindent' support. | |
| 2681 | 8360 spell Compiled with spell checking support |spell|. |
| 1989 | 8361 startuptime Compiled with |--startuptime| support. |
| 7 | 8362 statusline Compiled with support for 'statusline', 'rulerformat' |
| 8363 and special formats of 'titlestring' and 'iconstring'. | |
| 8364 sun_workshop Compiled with support for Sun |workshop|. | |
| 314 | 8365 syntax Compiled with syntax highlighting support |syntax|. |
| 7 | 8366 syntax_items There are active syntax highlighting items for the |
| 8367 current buffer. | |
| 8368 system Compiled to use system() instead of fork()/exec(). | |
| 8369 tag_binary Compiled with binary searching in tags files | |
| 8370 |tag-binary-search|. | |
| 8371 tag_old_static Compiled with support for old static tags | |
| 8372 |tag-old-static|. | |
| 8373 tag_any_white Compiled with support for any white characters in tags | |
| 8374 files |tag-any-white|. | |
| 8375 tcl Compiled with Tcl interface. | |
|
9076
9305a1251e51
commit https://github.com/vim/vim/commit/91c4937be15b0b743b6bc495df602c1abbff6b87
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
8376 termguicolors Compiled with true color in terminal support. |
| 7 | 8377 terminfo Compiled with terminfo instead of termcap. |
| 8378 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
| 8379 textobjects Compiled with support for |text-objects|. | |
| 8380 tgetent Compiled with tgetent support, able to use a termcap | |
| 8381 or terminfo file. | |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8382 timers Compiled with |timer_start()| support. |
| 7 | 8383 title Compiled with window title support |'title'|. |
| 8384 toolbar Compiled with support for |gui-toolbar|. | |
| 8385 unix Unix version of Vim. | |
| 8386 user_commands User-defined commands. | |
| 2681 | 8387 vertsplit Compiled with vertically split windows |:vsplit|. |
| 2581 | 8388 vim_starting True while initial source'ing takes place. |startup| |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
8389 *vim_starting* |
| 2681 | 8390 viminfo Compiled with viminfo support. |
| 7 | 8391 virtualedit Compiled with 'virtualedit' option. |
| 8392 visual Compiled with Visual mode. | |
| 8393 visualextra Compiled with extra Visual mode commands. | |
| 8394 |blockwise-operators|. | |
| 8395 vms VMS version of Vim. | |
| 8396 vreplace Compiled with |gR| and |gr| commands. | |
| 8397 wildignore Compiled with 'wildignore' option. | |
| 8398 wildmenu Compiled with 'wildmenu' option. | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
8399 win32 Win32 version of Vim (MS-Windows 95 and later, 32 or |
|
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
8400 64 bits) |
| 2681 | 8401 win32unix Win32 version of Vim, using Unix files (Cygwin) |
| 7 | 8402 win64 Win64 version of Vim (MS-Windows 64 bit). |
| 8403 win95 Win32 version for MS-Windows 95/98/ME. | |
| 2681 | 8404 winaltkeys Compiled with 'winaltkeys' option. |
| 8405 windows Compiled with support for more than one window. | |
| 7 | 8406 writebackup Compiled with 'writebackup' default on. |
| 8407 xfontset Compiled with X fontset support |xfontset|. | |
| 8408 xim Compiled with X input method support |xim|. | |
| 5340 | 8409 xpm Compiled with pixmap support. |
| 8410 xpm_w32 Compiled with pixmap support for Win32. (Only for | |
| 8411 backward compatibility. Use "xpm" instead.) | |
| 7 | 8412 xsmp Compiled with X session management support. |
| 8413 xsmp_interact Compiled with interactive X session management support. | |
| 8414 xterm_clipboard Compiled with support for xterm clipboard. | |
| 8415 xterm_save Compiled with support for saving and restoring the | |
| 8416 xterm screen. | |
| 8417 x11 Compiled with X11 support. | |
| 8418 | |
| 8419 *string-match* | |
| 8420 Matching a pattern in a String | |
| 8421 | |
| 8422 A regexp pattern as explained at |pattern| is normally used to find a match in | |
| 8423 the buffer lines. When a pattern is used to find a match in a String, almost | |
| 8424 everything works in the same way. The difference is that a String is handled | |
| 8425 like it is one line. When it contains a "\n" character, this is not seen as a | |
| 8426 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
| 8427 with ".". Example: > | |
| 8428 :let a = "aaaa\nxxxx" | |
| 8429 :echo matchstr(a, "..\n..") | |
| 8430 aa | |
| 8431 xx | |
| 8432 :echo matchstr(a, "a.x") | |
| 8433 a | |
| 8434 x | |
| 8435 | |
| 8436 Don't forget that "^" will only match at the first character of the String and | |
| 8437 "$" at the last character of the string. They don't match after or before a | |
| 8438 "\n". | |
| 8439 | |
| 8440 ============================================================================== | |
| 8441 5. Defining functions *user-functions* | |
| 8442 | |
| 8443 New functions can be defined. These can be called just like builtin | |
| 8444 functions. The function executes a sequence of Ex commands. Normal mode | |
| 8445 commands can be executed with the |:normal| command. | |
| 8446 | |
| 8447 The function name must start with an uppercase letter, to avoid confusion with | |
| 8448 builtin functions. To prevent from using the same name in different scripts | |
| 8449 avoid obvious, short names. A good habit is to start the function name with | |
| 8450 the name of the script, e.g., "HTMLcolor()". | |
| 8451 | |
| 504 | 8452 It's also possible to use curly braces, see |curly-braces-names|. And the |
| 8453 |autoload| facility is useful to define a function only when it's called. | |
| 7 | 8454 |
| 8455 *local-function* | |
| 8456 A function local to a script must start with "s:". A local script function | |
| 8457 can only be called from within the script and from functions, user commands | |
| 8458 and autocommands defined in the script. It is also possible to call the | |
| 1698 | 8459 function from a mapping defined in the script, but then |<SID>| must be used |
| 7 | 8460 instead of "s:" when the mapping is expanded outside of the script. |
| 5862 | 8461 There are only script-local functions, no buffer-local or window-local |
| 8462 functions. | |
| 7 | 8463 |
| 8464 *:fu* *:function* *E128* *E129* *E123* | |
| 8465 :fu[nction] List all functions and their arguments. | |
| 8466 | |
| 8467 :fu[nction] {name} List function {name}. | |
| 685 | 8468 {name} can also be a |Dictionary| entry that is a |
| 8469 |Funcref|: > | |
| 114 | 8470 :function dict.init |
| 504 | 8471 |
| 8472 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
| 8473 Example that lists all functions ending with "File": > | |
| 8474 :function /File$ | |
| 482 | 8475 < |
| 8476 *:function-verbose* | |
| 8477 When 'verbose' is non-zero, listing a function will also display where it was | |
| 8478 last defined. Example: > | |
| 8479 | |
| 8480 :verbose function SetFileTypeSH | |
| 8481 function SetFileTypeSH(name) | |
| 8482 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
| 8483 < | |
| 484 | 8484 See |:verbose-cmd| for more information. |
| 482 | 8485 |
| 5862 | 8486 *E124* *E125* *E853* *E884* |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8487 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] [closure] |
| 7 | 8488 Define a new function by the name {name}. The name |
| 8489 must be made of alphanumeric characters and '_', and | |
| 5862 | 8490 must start with a capital or "s:" (see above). Note |
| 8491 that using "b:" or "g:" is not allowed. (since patch | |
| 8492 7.4.260 E884 is given if the function name has a colon | |
| 8493 in the name, e.g. for "foo:bar()". Before that patch | |
| 8494 no error was given). | |
| 114 | 8495 |
| 685 | 8496 {name} can also be a |Dictionary| entry that is a |
| 8497 |Funcref|: > | |
| 114 | 8498 :function dict.init(arg) |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8499 < "dict" must be an existing dictionary. The entry |
| 114 | 8500 "init" is added if it didn't exist yet. Otherwise [!] |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8501 is required to overwrite an existing function. The |
| 114 | 8502 result is a |Funcref| to a numbered function. The |
| 8503 function can only be used with a |Funcref| and will be | |
| 8504 deleted if there are no more references to it. | |
| 7 | 8505 *E127* *E122* |
| 8506 When a function by this name already exists and [!] is | |
| 8507 not used an error message is given. When [!] is used, | |
| 8508 an existing function is silently replaced. Unless it | |
| 8509 is currently being executed, that is an error. | |
| 133 | 8510 |
| 8511 For the {arguments} see |function-argument|. | |
| 8512 | |
| 5618 | 8513 *:func-range* *a:firstline* *a:lastline* |
| 7 | 8514 When the [range] argument is added, the function is |
| 8515 expected to take care of a range itself. The range is | |
| 8516 passed as "a:firstline" and "a:lastline". If [range] | |
| 8517 is excluded, ":{range}call" will call the function for | |
| 8518 each line in the range, with the cursor on the start | |
| 8519 of each line. See |function-range-example|. | |
| 3967 | 8520 The cursor is still moved to the first line of the |
| 8521 range, as is the case with all Ex commands. | |
| 5618 | 8522 *:func-abort* |
| 7 | 8523 When the [abort] argument is added, the function will |
| 8524 abort as soon as an error is detected. | |
| 5618 | 8525 *:func-dict* |
| 102 | 8526 When the [dict] argument is added, the function must |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8527 be invoked through an entry in a |Dictionary|. The |
| 102 | 8528 local variable "self" will then be set to the |
| 8529 dictionary. See |Dictionary-function|. | |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8530 *:func-closure* *E932* |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8531 When the [closure] argument is added, the function |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8532 can access variables and arguments from the outer |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8533 scope. This is usually called a closure. In this |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8534 example Bar() uses "x" from the scope of Foo(). It |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8535 remains referenced even after Foo() returns: > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8536 :function! Foo() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8537 : let x = 0 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8538 : function! Bar() closure |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8539 : let x += 1 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8540 : return x |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8541 : endfunction |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
8542 : return funcref('Bar') |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8543 :endfunction |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8544 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8545 :let F = Foo() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8546 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8547 < 1 > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8548 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8549 < 2 > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8550 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
8551 < 3 |
| 7 | 8552 |
| 1621 | 8553 *function-search-undo* |
| 653 | 8554 The last used search pattern and the redo command "." |
| 1621 | 8555 will not be changed by the function. This also |
| 8556 implies that the effect of |:nohlsearch| is undone | |
| 8557 when the function returns. | |
| 653 | 8558 |
| 7 | 8559 *:endf* *:endfunction* *E126* *E193* |
| 8560 :endf[unction] The end of a function definition. Must be on a line | |
| 8561 by its own, without other commands. | |
| 8562 | |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
8563 *:delf* *:delfunction* *E130* *E131* *E933* |
| 7 | 8564 :delf[unction] {name} Delete function {name}. |
| 685 | 8565 {name} can also be a |Dictionary| entry that is a |
| 8566 |Funcref|: > | |
| 114 | 8567 :delfunc dict.init |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8568 < This will remove the "init" entry from "dict". The |
| 114 | 8569 function is deleted if there are no more references to |
| 8570 it. | |
| 7 | 8571 *:retu* *:return* *E133* |
| 8572 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
| 8573 evaluated and returned as the result of the function. | |
| 8574 If "[expr]" is not given, the number 0 is returned. | |
| 8575 When a function ends without an explicit ":return", | |
| 8576 the number 0 is returned. | |
| 8577 Note that there is no check for unreachable lines, | |
| 8578 thus there is no warning if commands follow ":return". | |
| 8579 | |
| 8580 If the ":return" is used after a |:try| but before the | |
| 8581 matching |:finally| (if present), the commands | |
| 8582 following the ":finally" up to the matching |:endtry| | |
| 8583 are executed first. This process applies to all | |
| 8584 nested ":try"s inside the function. The function | |
| 8585 returns at the outermost ":endtry". | |
| 8586 | |
| 133 | 8587 *function-argument* *a:var* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8588 An argument can be defined by giving its name. In the function this can then |
| 133 | 8589 be used as "a:name" ("a:" for argument). |
| 1156 | 8590 *a:0* *a:1* *a:000* *E740* *...* |
| 133 | 8591 Up to 20 arguments can be given, separated by commas. After the named |
| 8592 arguments an argument "..." can be specified, which means that more arguments | |
| 8593 may optionally be following. In the function the extra arguments can be used | |
| 8594 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
| 685 | 8595 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
| 8596 that "a:1" is the same as "a:000[0]". | |
| 148 | 8597 *E742* |
| 8598 The a: scope and the variables in it cannot be changed, they are fixed. | |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
8599 However, if a composite type is used, such as |List| or |Dictionary| , you can |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
8600 change their contents. Thus you can pass a |List| to a function and have the |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
8601 function add an item to it. If you want to make sure the function cannot |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
8602 change a |List| or |Dictionary| use |:lockvar|. |
| 133 | 8603 |
| 8604 When not using "...", the number of arguments in a function call must be equal | |
| 8605 to the number of named arguments. When using "...", the number of arguments | |
| 8606 may be larger. | |
| 8607 | |
| 8608 It is also possible to define a function without any arguments. You must | |
| 8609 still supply the () then. The body of the function follows in the next lines, | |
| 8610 until the matching |:endfunction|. It is allowed to define another function | |
| 8611 inside a function body. | |
| 8612 | |
| 8613 *local-variables* | |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
8614 Inside a function local variables can be used. These will disappear when the |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
8615 function returns. Global variables need to be accessed with "g:". |
| 7 | 8616 |
| 8617 Example: > | |
| 8618 :function Table(title, ...) | |
| 8619 : echohl Title | |
| 8620 : echo a:title | |
| 8621 : echohl None | |
| 140 | 8622 : echo a:0 . " items:" |
| 8623 : for s in a:000 | |
| 8624 : echon ' ' . s | |
| 8625 : endfor | |
| 7 | 8626 :endfunction |
| 8627 | |
| 8628 This function can then be called with: > | |
| 140 | 8629 call Table("Table", "line1", "line2") |
| 8630 call Table("Empty Table") | |
| 7 | 8631 |
| 1156 | 8632 To return more than one value, return a |List|: > |
| 8633 :function Compute(n1, n2) | |
| 7 | 8634 : if a:n2 == 0 |
| 1156 | 8635 : return ["fail", 0] |
| 7 | 8636 : endif |
| 1156 | 8637 : return ["ok", a:n1 / a:n2] |
| 7 | 8638 :endfunction |
| 8639 | |
| 8640 This function can then be called with: > | |
| 1156 | 8641 :let [success, div] = Compute(102, 6) |
| 7 | 8642 :if success == "ok" |
| 8643 : echo div | |
| 8644 :endif | |
| 1156 | 8645 < |
| 786 | 8646 *:cal* *:call* *E107* *E117* |
| 7 | 8647 :[range]cal[l] {name}([arguments]) |
| 8648 Call a function. The name of the function and its arguments | |
| 8649 are as specified with |:function|. Up to 20 arguments can be | |
| 1156 | 8650 used. The returned value is discarded. |
| 7 | 8651 Without a range and for functions that accept a range, the |
| 8652 function is called once. When a range is given the cursor is | |
| 8653 positioned at the start of the first line before executing the | |
| 8654 function. | |
| 8655 When a range is given and the function doesn't handle it | |
| 8656 itself, the function is executed for each line in the range, | |
| 8657 with the cursor in the first column of that line. The cursor | |
| 8658 is left at the last line (possibly moved by the last function | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8659 call). The arguments are re-evaluated for each line. Thus |
| 7 | 8660 this works: |
| 8661 *function-range-example* > | |
| 8662 :function Mynumber(arg) | |
| 8663 : echo line(".") . " " . a:arg | |
| 8664 :endfunction | |
| 8665 :1,5call Mynumber(getline(".")) | |
| 8666 < | |
| 8667 The "a:firstline" and "a:lastline" are defined anyway, they | |
| 8668 can be used to do something different at the start or end of | |
| 8669 the range. | |
| 8670 | |
| 8671 Example of a function that handles the range itself: > | |
| 8672 | |
| 8673 :function Cont() range | |
| 8674 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
| 8675 :endfunction | |
| 8676 :4,8call Cont() | |
| 8677 < | |
| 8678 This function inserts the continuation character "\" in front | |
| 8679 of all the lines in the range, except the first one. | |
| 8680 | |
| 1156 | 8681 When the function returns a composite value it can be further |
| 8682 dereferenced, but the range will not be used then. Example: > | |
| 8683 :4,8call GetDict().method() | |
| 8684 < Here GetDict() gets the range but method() does not. | |
| 8685 | |
| 7 | 8686 *E132* |
| 8687 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
| 8688 option. | |
| 8689 | |
| 161 | 8690 |
| 8691 AUTOMATICALLY LOADING FUNCTIONS ~ | |
| 7 | 8692 *autoload-functions* |
| 8693 When using many or large functions, it's possible to automatically define them | |
| 161 | 8694 only when they are used. There are two methods: with an autocommand and with |
| 8695 the "autoload" directory in 'runtimepath'. | |
| 8696 | |
| 8697 | |
| 8698 Using an autocommand ~ | |
| 8699 | |
| 170 | 8700 This is introduced in the user manual, section |41.14|. |
| 8701 | |
| 161 | 8702 The autocommand is useful if you have a plugin that is a long Vim script file. |
| 8703 You can define the autocommand and quickly quit the script with |:finish|. | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8704 That makes Vim startup faster. The autocommand should then load the same file |
| 161 | 8705 again, setting a variable to skip the |:finish| command. |
| 8706 | |
| 8707 Use the FuncUndefined autocommand event with a pattern that matches the | |
| 8708 function(s) to be defined. Example: > | |
| 7 | 8709 |
| 8710 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
| 8711 | |
| 8712 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
| 8713 "BufNet". Also see |FuncUndefined|. | |
| 8714 | |
| 161 | 8715 |
| 8716 Using an autoload script ~ | |
| 168 | 8717 *autoload* *E746* |
| 170 | 8718 This is introduced in the user manual, section |41.15|. |
| 8719 | |
| 161 | 8720 Using a script in the "autoload" directory is simpler, but requires using |
| 8721 exactly the right file name. A function that can be autoloaded has a name | |
| 8722 like this: > | |
| 8723 | |
| 270 | 8724 :call filename#funcname() |
| 161 | 8725 |
| 8726 When such a function is called, and it is not defined yet, Vim will search the | |
| 8727 "autoload" directories in 'runtimepath' for a script file called | |
| 8728 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
| 8729 then define the function like this: > | |
| 8730 | |
| 270 | 8731 function filename#funcname() |
| 161 | 8732 echo "Done!" |
| 8733 endfunction | |
| 8734 | |
| 530 | 8735 The file name and the name used before the # in the function must match |
| 161 | 8736 exactly, and the defined function must have the name exactly as it will be |
| 8737 called. | |
| 8738 | |
| 270 | 8739 It is possible to use subdirectories. Every # in the function name works like |
| 8740 a path separator. Thus when calling a function: > | |
| 8741 | |
| 8742 :call foo#bar#func() | |
| 161 | 8743 |
| 8744 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
| 8745 | |
| 168 | 8746 This also works when reading a variable that has not been set yet: > |
| 8747 | |
| 270 | 8748 :let l = foo#bar#lvar |
| 168 | 8749 |
| 557 | 8750 However, when the autoload script was already loaded it won't be loaded again |
| 8751 for an unknown variable. | |
| 8752 | |
| 168 | 8753 When assigning a value to such a variable nothing special happens. This can |
| 8754 be used to pass settings to the autoload script before it's loaded: > | |
| 8755 | |
| 270 | 8756 :let foo#bar#toggle = 1 |
| 8757 :call foo#bar#func() | |
| 168 | 8758 |
| 164 | 8759 Note that when you make a mistake and call a function that is supposed to be |
| 8760 defined in an autoload script, but the script doesn't actually define the | |
| 8761 function, the script will be sourced every time you try to call the function. | |
| 168 | 8762 And you will get an error message every time. |
| 8763 | |
| 8764 Also note that if you have two script files, and one calls a function in the | |
| 1621 | 8765 other and vice versa, before the used function is defined, it won't work. |
| 168 | 8766 Avoid using the autoload functionality at the toplevel. |
| 161 | 8767 |
| 794 | 8768 Hint: If you distribute a bunch of scripts you can pack them together with the |
| 8769 |vimball| utility. Also read the user manual |distribute-script|. | |
| 8770 | |
| 7 | 8771 ============================================================================== |
| 8772 6. Curly braces names *curly-braces-names* | |
| 8773 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8774 In most places where you can use a variable, you can use a "curly braces name" |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8775 variable. This is a regular variable name with one or more expressions |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8776 wrapped in braces {} like this: > |
| 7 | 8777 my_{adjective}_variable |
| 8778 | |
| 8779 When Vim encounters this, it evaluates the expression inside the braces, puts | |
| 8780 that in place of the expression, and re-interprets the whole as a variable | |
| 8781 name. So in the above example, if the variable "adjective" was set to | |
| 8782 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
| 8783 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
| 8784 | |
| 8785 One application for this is to create a set of variables governed by an option | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8786 value. For example, the statement > |
| 7 | 8787 echo my_{&background}_message |
| 8788 | |
| 8789 would output the contents of "my_dark_message" or "my_light_message" depending | |
| 8790 on the current value of 'background'. | |
| 8791 | |
| 8792 You can use multiple brace pairs: > | |
| 8793 echo my_{adverb}_{adjective}_message | |
| 8794 ..or even nest them: > | |
| 8795 echo my_{ad{end_of_word}}_message | |
| 8796 where "end_of_word" is either "verb" or "jective". | |
| 8797 | |
| 8798 However, the expression inside the braces must evaluate to a valid single | |
| 236 | 8799 variable name, e.g. this is invalid: > |
| 7 | 8800 :let foo='a + b' |
| 8801 :echo c{foo}d | |
| 8802 .. since the result of expansion is "ca + bd", which is not a variable name. | |
| 8803 | |
| 8804 *curly-braces-function-names* | |
| 8805 You can call and define functions by an evaluated name in a similar way. | |
| 8806 Example: > | |
| 8807 :let func_end='whizz' | |
| 8808 :call my_func_{func_end}(parameter) | |
| 8809 | |
| 8810 This would call the function "my_func_whizz(parameter)". | |
| 8811 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8812 This does NOT work: > |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8813 :let i = 3 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8814 :let @{i} = '' " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8815 :echo @{i} " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
8816 |
| 7 | 8817 ============================================================================== |
| 8818 7. Commands *expression-commands* | |
| 8819 | |
| 8820 :let {var-name} = {expr1} *:let* *E18* | |
| 8821 Set internal variable {var-name} to the result of the | |
| 8822 expression {expr1}. The variable will get the type | |
| 8823 from the {expr}. If {var-name} didn't exist yet, it | |
| 8824 is created. | |
| 8825 | |
| 85 | 8826 :let {var-name}[{idx}] = {expr1} *E689* |
| 8827 Set a list item to the result of the expression | |
| 8828 {expr1}. {var-name} must refer to a list and {idx} | |
| 8829 must be a valid index in that list. For nested list | |
| 8830 the index can be repeated. | |
| 1621 | 8831 This cannot be used to add an item to a |List|. |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8832 This cannot be used to set a byte in a String. You |
| 1621 | 8833 can do that like this: > |
| 8834 :let var = var[0:2] . 'X' . var[4:] | |
| 8835 < | |
| 114 | 8836 *E711* *E719* |
| 8837 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
| 685 | 8838 Set a sequence of items in a |List| to the result of |
| 8839 the expression {expr1}, which must be a list with the | |
| 87 | 8840 correct number of items. |
| 8841 {idx1} can be omitted, zero is used instead. | |
| 8842 {idx2} can be omitted, meaning the end of the list. | |
| 8843 When the selected range of items is partly past the | |
| 8844 end of the list, items will be added. | |
| 8845 | |
| 153 | 8846 *:let+=* *:let-=* *:let.=* *E734* |
| 114 | 8847 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
| 8848 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
| 8849 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". | |
| 8850 These fail if {var} was not set yet and when the type | |
| 8851 of {var} and {expr1} don't fit the operator. | |
| 8852 | |
| 8853 | |
| 7 | 8854 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
| 8855 Set environment variable {env-name} to the result of | |
| 8856 the expression {expr1}. The type is always String. | |
| 114 | 8857 :let ${env-name} .= {expr1} |
| 8858 Append {expr1} to the environment variable {env-name}. | |
| 8859 If the environment variable didn't exist yet this | |
| 8860 works like "=". | |
| 7 | 8861 |
| 8862 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
| 8863 Write the result of the expression {expr1} in register | |
| 8864 {reg-name}. {reg-name} must be a single letter, and | |
| 8865 must be the name of a writable register (see | |
| 8866 |registers|). "@@" can be used for the unnamed | |
| 8867 register, "@/" for the search pattern. | |
| 8868 If the result of {expr1} ends in a <CR> or <NL>, the | |
| 8869 register will be linewise, otherwise it will be set to | |
| 8870 characterwise. | |
| 8871 This can be used to clear the last search pattern: > | |
| 8872 :let @/ = "" | |
| 8873 < This is different from searching for an empty string, | |
| 8874 that would match everywhere. | |
| 8875 | |
| 114 | 8876 :let @{reg-name} .= {expr1} |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8877 Append {expr1} to register {reg-name}. If the |
| 114 | 8878 register was empty it's like setting it to {expr1}. |
| 8879 | |
| 1156 | 8880 :let &{option-name} = {expr1} *:let-option* *:let-&* |
| 7 | 8881 Set option {option-name} to the result of the |
| 68 | 8882 expression {expr1}. A String or Number value is |
| 8883 always converted to the type of the option. | |
| 7 | 8884 For an option local to a window or buffer the effect |
| 8885 is just like using the |:set| command: both the local | |
| 555 | 8886 value and the global value are changed. |
| 68 | 8887 Example: > |
| 8888 :let &path = &path . ',/usr/local/include' | |
| 7 | 8889 |
| 114 | 8890 :let &{option-name} .= {expr1} |
| 8891 For a string option: Append {expr1} to the value. | |
| 8892 Does not insert a comma like |:set+=|. | |
| 8893 | |
| 8894 :let &{option-name} += {expr1} | |
| 8895 :let &{option-name} -= {expr1} | |
| 8896 For a number or boolean option: Add or subtract | |
| 8897 {expr1}. | |
| 8898 | |
| 7 | 8899 :let &l:{option-name} = {expr1} |
| 114 | 8900 :let &l:{option-name} .= {expr1} |
| 8901 :let &l:{option-name} += {expr1} | |
| 8902 :let &l:{option-name} -= {expr1} | |
| 7 | 8903 Like above, but only set the local value of an option |
| 8904 (if there is one). Works like |:setlocal|. | |
| 8905 | |
| 8906 :let &g:{option-name} = {expr1} | |
| 114 | 8907 :let &g:{option-name} .= {expr1} |
| 8908 :let &g:{option-name} += {expr1} | |
| 8909 :let &g:{option-name} -= {expr1} | |
| 7 | 8910 Like above, but only set the global value of an option |
| 8911 (if there is one). Works like |:setglobal|. | |
| 8912 | |
| 85 | 8913 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
| 685 | 8914 {expr1} must evaluate to a |List|. The first item in |
| 68 | 8915 the list is assigned to {name1}, the second item to |
| 8916 {name2}, etc. | |
| 8917 The number of names must match the number of items in | |
| 685 | 8918 the |List|. |
| 68 | 8919 Each name can be one of the items of the ":let" |
| 8920 command as mentioned above. | |
| 8921 Example: > | |
| 8922 :let [s, item] = GetItem(s) | |
| 114 | 8923 < Detail: {expr1} is evaluated first, then the |
| 8924 assignments are done in sequence. This matters if | |
| 8925 {name2} depends on {name1}. Example: > | |
| 8926 :let x = [0, 1] | |
| 8927 :let i = 0 | |
| 8928 :let [i, x[i]] = [1, 2] | |
| 8929 :echo x | |
| 8930 < The result is [0, 2]. | |
| 8931 | |
| 8932 :let [{name1}, {name2}, ...] .= {expr1} | |
| 8933 :let [{name1}, {name2}, ...] += {expr1} | |
| 8934 :let [{name1}, {name2}, ...] -= {expr1} | |
| 8935 Like above, but append/add/subtract the value for each | |
| 685 | 8936 |List| item. |
| 68 | 8937 |
| 8938 :let [{name}, ..., ; {lastname}] = {expr1} | |
| 685 | 8939 Like |:let-unpack| above, but the |List| may have more |
| 114 | 8940 items than there are names. A list of the remaining |
| 8941 items is assigned to {lastname}. If there are no | |
| 8942 remaining items {lastname} is set to an empty list. | |
| 68 | 8943 Example: > |
| 8944 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
| 8945 < | |
| 114 | 8946 :let [{name}, ..., ; {lastname}] .= {expr1} |
| 8947 :let [{name}, ..., ; {lastname}] += {expr1} | |
| 8948 :let [{name}, ..., ; {lastname}] -= {expr1} | |
| 8949 Like above, but append/add/subtract the value for each | |
| 685 | 8950 |List| item. |
| 2596 | 8951 |
| 8952 *E121* | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8953 :let {var-name} .. List the value of variable {var-name}. Multiple |
| 123 | 8954 variable names may be given. Special names recognized |
| 8955 here: *E738* | |
| 777 | 8956 g: global variables |
| 8957 b: local buffer variables | |
| 8958 w: local window variables | |
| 819 | 8959 t: local tab page variables |
| 777 | 8960 s: script-local variables |
| 8961 l: local function variables | |
| 123 | 8962 v: Vim variables. |
| 7 | 8963 |
| 55 | 8964 :let List the values of all variables. The type of the |
| 8965 variable is indicated before the value: | |
| 8966 <nothing> String | |
| 8967 # Number | |
| 856 | 8968 * Funcref |
| 7 | 8969 |
| 148 | 8970 |
| 1156 | 8971 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
| 148 | 8972 Remove the internal variable {name}. Several variable |
| 8973 names can be given, they are all removed. The name | |
| 685 | 8974 may also be a |List| or |Dictionary| item. |
| 7 | 8975 With [!] no error message is given for non-existing |
| 8976 variables. | |
| 685 | 8977 One or more items from a |List| can be removed: > |
| 108 | 8978 :unlet list[3] " remove fourth item |
| 8979 :unlet list[3:] " remove fourth item to last | |
| 685 | 8980 < One item from a |Dictionary| can be removed at a time: > |
| 108 | 8981 :unlet dict['two'] |
| 8982 :unlet dict.two | |
| 1668 | 8983 < This is especially useful to clean up used global |
| 8984 variables and script-local variables (these are not | |
| 8985 deleted when the script ends). Function-local | |
| 8986 variables are automatically deleted when the function | |
| 8987 ends. | |
| 7 | 8988 |
| 148 | 8989 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
| 8990 Lock the internal variable {name}. Locking means that | |
| 8991 it can no longer be changed (until it is unlocked). | |
| 8992 A locked variable can be deleted: > | |
| 8993 :lockvar v | |
| 8994 :let v = 'asdf' " fails! | |
| 8995 :unlet v | |
| 8996 < *E741* | |
| 8997 If you try to change a locked variable you get an | |
| 6530 | 8998 error message: "E741: Value is locked: {name}" |
| 148 | 8999 |
| 685 | 9000 [depth] is relevant when locking a |List| or |
| 9001 |Dictionary|. It specifies how deep the locking goes: | |
| 9002 1 Lock the |List| or |Dictionary| itself, | |
| 148 | 9003 cannot add or remove items, but can |
| 9004 still change their values. | |
| 9005 2 Also lock the values, cannot change | |
| 685 | 9006 the items. If an item is a |List| or |
| 9007 |Dictionary|, cannot add or remove | |
| 148 | 9008 items, but can still change the |
| 9009 values. | |
| 685 | 9010 3 Like 2 but for the |List| / |
| 9011 |Dictionary| in the |List| / | |
| 9012 |Dictionary|, one level deeper. | |
| 9013 The default [depth] is 2, thus when {name} is a |List| | |
| 9014 or |Dictionary| the values cannot be changed. | |
| 148 | 9015 *E743* |
| 9016 For unlimited depth use [!] and omit [depth]. | |
| 9017 However, there is a maximum depth of 100 to catch | |
| 9018 loops. | |
| 9019 | |
| 685 | 9020 Note that when two variables refer to the same |List| |
| 9021 and you lock one of them, the |List| will also be | |
| 819 | 9022 locked when used through the other variable. |
| 9023 Example: > | |
| 148 | 9024 :let l = [0, 1, 2, 3] |
| 9025 :let cl = l | |
| 9026 :lockvar l | |
| 9027 :let cl[1] = 99 " won't work! | |
| 9028 < You may want to make a copy of a list to avoid this. | |
| 9029 See |deepcopy()|. | |
| 9030 | |
| 9031 | |
| 9032 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
| 9033 Unlock the internal variable {name}. Does the | |
| 9034 opposite of |:lockvar|. | |
| 9035 | |
| 9036 | |
| 7 | 9037 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580* |
| 9038 :en[dif] Execute the commands until the next matching ":else" | |
| 9039 or ":endif" if {expr1} evaluates to non-zero. | |
| 9040 | |
| 9041 From Vim version 4.5 until 5.0, every Ex command in | |
| 9042 between the ":if" and ":endif" is ignored. These two | |
| 9043 commands were just to allow for future expansions in a | |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
9044 backward compatible way. Nesting was allowed. Note |
| 7 | 9045 that any ":else" or ":elseif" was ignored, the "else" |
| 9046 part was not executed either. | |
| 9047 | |
| 9048 You can use this to remain compatible with older | |
| 9049 versions: > | |
| 9050 :if version >= 500 | |
| 9051 : version-5-specific-commands | |
| 9052 :endif | |
| 9053 < The commands still need to be parsed to find the | |
| 9054 "endif". Sometimes an older Vim has a problem with a | |
| 9055 new command. For example, ":silent" is recognized as | |
| 9056 a ":substitute" command. In that case ":execute" can | |
| 9057 avoid problems: > | |
| 9058 :if version >= 600 | |
| 9059 : execute "silent 1,$delete" | |
| 9060 :endif | |
| 9061 < | |
| 9062 NOTE: The ":append" and ":insert" commands don't work | |
| 9063 properly in between ":if" and ":endif". | |
| 9064 | |
| 9065 *:else* *:el* *E581* *E583* | |
| 9066 :el[se] Execute the commands until the next matching ":else" | |
| 9067 or ":endif" if they previously were not being | |
| 9068 executed. | |
| 9069 | |
| 9070 *:elseif* *:elsei* *E582* *E584* | |
| 9071 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
| 9072 is no extra ":endif". | |
| 9073 | |
| 9074 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
| 114 | 9075 *E170* *E585* *E588* *E733* |
| 7 | 9076 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
| 9077 as long as {expr1} evaluates to non-zero. | |
| 9078 When an error is detected from a command inside the | |
| 9079 loop, execution continues after the "endwhile". | |
| 75 | 9080 Example: > |
| 9081 :let lnum = 1 | |
| 9082 :while lnum <= line("$") | |
| 9083 :call FixLine(lnum) | |
| 9084 :let lnum = lnum + 1 | |
| 9085 :endwhile | |
| 9086 < | |
| 7 | 9087 NOTE: The ":append" and ":insert" commands don't work |
| 99 | 9088 properly inside a ":while" and ":for" loop. |
| 75 | 9089 |
| 114 | 9090 :for {var} in {list} *:for* *E690* *E732* |
| 75 | 9091 :endfo[r] *:endfo* *:endfor* |
| 9092 Repeat the commands between ":for" and ":endfor" for | |
| 158 | 9093 each item in {list}. Variable {var} is set to the |
| 79 | 9094 value of each item. |
| 9095 When an error is detected for a command inside the | |
| 75 | 9096 loop, execution continues after the "endfor". |
| 464 | 9097 Changing {list} inside the loop affects what items are |
| 9098 used. Make a copy if this is unwanted: > | |
| 79 | 9099 :for item in copy(mylist) |
| 9100 < When not making a copy, Vim stores a reference to the | |
| 9101 next item in the list, before executing the commands | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9102 with the current item. Thus the current item can be |
| 79 | 9103 removed without effect. Removing any later item means |
| 9104 it will not be found. Thus the following example | |
| 9105 works (an inefficient way to make a list empty): > | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9106 for item in mylist |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9107 call remove(mylist, 0) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9108 endfor |
| 87 | 9109 < Note that reordering the list (e.g., with sort() or |
| 9110 reverse()) may have unexpected effects. | |
| 75 | 9111 |
| 9112 :for [{var1}, {var2}, ...] in {listlist} | |
| 9113 :endfo[r] | |
| 9114 Like ":for" above, but each item in {listlist} must be | |
| 9115 a list, of which each item is assigned to {var1}, | |
| 9116 {var2}, etc. Example: > | |
| 9117 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
| 9118 :echo getline(lnum)[col] | |
| 9119 :endfor | |
| 9120 < | |
| 7 | 9121 *:continue* *:con* *E586* |
| 75 | 9122 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
| 9123 to the start of the loop. | |
| 9124 If it is used after a |:try| inside the loop but | |
| 9125 before the matching |:finally| (if present), the | |
| 9126 commands following the ":finally" up to the matching | |
| 9127 |:endtry| are executed first. This process applies to | |
| 9128 all nested ":try"s inside the loop. The outermost | |
| 9129 ":endtry" then jumps back to the start of the loop. | |
| 7 | 9130 |
| 9131 *:break* *:brea* *E587* | |
| 75 | 9132 :brea[k] When used inside a ":while" or ":for" loop, skips to |
| 9133 the command after the matching ":endwhile" or | |
| 9134 ":endfor". | |
| 9135 If it is used after a |:try| inside the loop but | |
| 9136 before the matching |:finally| (if present), the | |
| 9137 commands following the ":finally" up to the matching | |
| 9138 |:endtry| are executed first. This process applies to | |
| 9139 all nested ":try"s inside the loop. The outermost | |
| 9140 ":endtry" then jumps to the command after the loop. | |
| 7 | 9141 |
| 9142 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
| 9143 :endt[ry] Change the error handling for the commands between | |
| 9144 ":try" and ":endtry" including everything being | |
| 9145 executed across ":source" commands, function calls, | |
| 9146 or autocommand invocations. | |
| 9147 | |
| 9148 When an error or interrupt is detected and there is | |
| 9149 a |:finally| command following, execution continues | |
| 9150 after the ":finally". Otherwise, or when the | |
| 9151 ":endtry" is reached thereafter, the next | |
| 9152 (dynamically) surrounding ":try" is checked for | |
| 9153 a corresponding ":finally" etc. Then the script | |
| 9154 processing is terminated. (Whether a function | |
| 9155 definition has an "abort" argument does not matter.) | |
| 9156 Example: > | |
| 9157 :try | edit too much | finally | echo "cleanup" | endtry | |
| 9158 :echo "impossible" " not reached, script terminated above | |
| 9159 < | |
| 9160 Moreover, an error or interrupt (dynamically) inside | |
| 9161 ":try" and ":endtry" is converted to an exception. It | |
| 9162 can be caught as if it were thrown by a |:throw| | |
| 9163 command (see |:catch|). In this case, the script | |
| 9164 processing is not terminated. | |
| 9165 | |
| 9166 The value "Vim:Interrupt" is used for an interrupt | |
| 9167 exception. An error in a Vim command is converted | |
| 9168 to a value of the form "Vim({command}):{errmsg}", | |
| 9169 other errors are converted to a value of the form | |
| 9170 "Vim:{errmsg}". {command} is the full command name, | |
| 9171 and {errmsg} is the message that is displayed if the | |
| 9172 error exception is not caught, always beginning with | |
| 9173 the error number. | |
| 9174 Examples: > | |
| 9175 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry | |
| 9176 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
| 9177 < | |
| 9178 *:cat* *:catch* *E603* *E604* *E605* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9179 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
| 7 | 9180 |:finally|, or |:endtry| that belongs to the same |
| 9181 |:try| as the ":catch" are executed when an exception | |
| 9182 matching {pattern} is being thrown and has not yet | |
| 9183 been caught by a previous ":catch". Otherwise, these | |
| 9184 commands are skipped. | |
| 9185 When {pattern} is omitted all errors are caught. | |
| 9186 Examples: > | |
| 9187 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) | |
| 9188 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors | |
| 9189 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts | |
| 9190 :catch /^Vim(write):/ " catch all errors in :write | |
| 9191 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123 | |
| 9192 :catch /my-exception/ " catch user exception | |
| 9193 :catch /.*/ " catch everything | |
| 9194 :catch " same as /.*/ | |
| 9195 < | |
| 9196 Another character can be used instead of / around the | |
| 9197 {pattern}, so long as it does not have a special | |
| 9198 meaning (e.g., '|' or '"') and doesn't occur inside | |
| 9199 {pattern}. | |
| 5814 | 9200 Information about the exception is available in |
| 9201 |v:exception|. Also see |throw-variables|. | |
| 7 | 9202 NOTE: It is not reliable to ":catch" the TEXT of |
| 9203 an error message because it may vary in different | |
| 9204 locales. | |
| 9205 | |
| 9206 *:fina* *:finally* *E606* *E607* | |
| 9207 :fina[lly] The following commands until the matching |:endtry| | |
| 9208 are executed whenever the part between the matching | |
| 9209 |:try| and the ":finally" is left: either by falling | |
| 9210 through to the ":finally" or by a |:continue|, | |
| 9211 |:break|, |:finish|, or |:return|, or by an error or | |
| 9212 interrupt or exception (see |:throw|). | |
| 9213 | |
| 9214 *:th* *:throw* *E608* | |
| 9215 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
| 9216 If the ":throw" is used after a |:try| but before the | |
| 9217 first corresponding |:catch|, commands are skipped | |
| 9218 until the first ":catch" matching {expr1} is reached. | |
| 9219 If there is no such ":catch" or if the ":throw" is | |
| 9220 used after a ":catch" but before the |:finally|, the | |
| 9221 commands following the ":finally" (if present) up to | |
| 9222 the matching |:endtry| are executed. If the ":throw" | |
| 9223 is after the ":finally", commands up to the ":endtry" | |
| 9224 are skipped. At the ":endtry", this process applies | |
| 9225 again for the next dynamically surrounding ":try" | |
| 9226 (which may be found in a calling function or sourcing | |
| 9227 script), until a matching ":catch" has been found. | |
| 9228 If the exception is not caught, the command processing | |
| 9229 is terminated. | |
| 9230 Example: > | |
| 9231 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
| 2725 | 9232 < Note that "catch" may need to be on a separate line |
| 9233 for when an error causes the parsing to skip the whole | |
| 9234 line and not see the "|" that separates the commands. | |
| 7 | 9235 |
| 9236 *:ec* *:echo* | |
| 9237 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
| 9238 first {expr1} starts on a new line. | |
| 9239 Also see |:comment|. | |
| 9240 Use "\n" to start a new line. Use "\r" to move the | |
| 9241 cursor to the first column. | |
| 9242 Uses the highlighting set by the |:echohl| command. | |
| 9243 Cannot be followed by a comment. | |
| 9244 Example: > | |
| 9245 :echo "the value of 'shell' is" &shell | |
| 1156 | 9246 < *:echo-redraw* |
| 9247 A later redraw may make the message disappear again. | |
| 9248 And since Vim mostly postpones redrawing until it's | |
| 9249 finished with a sequence of commands this happens | |
| 9250 quite often. To avoid that a command from before the | |
| 9251 ":echo" causes a redraw afterwards (redraws are often | |
| 9252 postponed until you type something), force a redraw | |
| 9253 with the |:redraw| command. Example: > | |
| 7 | 9254 :new | redraw | echo "there is a new window" |
| 9255 < | |
| 9256 *:echon* | |
| 9257 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
| 9258 |:comment|. | |
| 9259 Uses the highlighting set by the |:echohl| command. | |
| 9260 Cannot be followed by a comment. | |
| 9261 Example: > | |
| 9262 :echon "the value of 'shell' is " &shell | |
| 9263 < | |
| 9264 Note the difference between using ":echo", which is a | |
| 9265 Vim command, and ":!echo", which is an external shell | |
| 9266 command: > | |
| 9267 :!echo % --> filename | |
| 9268 < The arguments of ":!" are expanded, see |:_%|. > | |
| 9269 :!echo "%" --> filename or "filename" | |
| 9270 < Like the previous example. Whether you see the double | |
| 9271 quotes or not depends on your 'shell'. > | |
| 9272 :echo % --> nothing | |
| 9273 < The '%' is an illegal character in an expression. > | |
| 9274 :echo "%" --> % | |
| 9275 < This just echoes the '%' character. > | |
| 9276 :echo expand("%") --> filename | |
| 9277 < This calls the expand() function to expand the '%'. | |
| 9278 | |
| 9279 *:echoh* *:echohl* | |
| 9280 :echoh[l] {name} Use the highlight group {name} for the following | |
| 9281 |:echo|, |:echon| and |:echomsg| commands. Also used | |
| 9282 for the |input()| prompt. Example: > | |
| 9283 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
| 9284 < Don't forget to set the group back to "None", | |
| 9285 otherwise all following echo's will be highlighted. | |
| 9286 | |
| 9287 *:echom* *:echomsg* | |
| 9288 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
| 9289 message in the |message-history|. | |
| 9290 Spaces are placed between the arguments as with the | |
| 9291 |:echo| command. But unprintable characters are | |
| 9292 displayed, not interpreted. | |
| 1156 | 9293 The parsing works slightly different from |:echo|, |
| 9294 more like |:execute|. All the expressions are first | |
| 9295 evaluated and concatenated before echoing anything. | |
| 9296 The expressions must evaluate to a Number or String, a | |
| 9297 Dictionary or List causes an error. | |
| 7 | 9298 Uses the highlighting set by the |:echohl| command. |
| 9299 Example: > | |
| 9300 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
| 1156 | 9301 < See |:echo-redraw| to avoid the message disappearing |
| 9302 when the screen is redrawn. | |
| 7 | 9303 *:echoe* *:echoerr* |
| 9304 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
| 9305 message in the |message-history|. When used in a | |
| 9306 script or function the line number will be added. | |
| 9307 Spaces are placed between the arguments as with the | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9308 :echo command. When used inside a try conditional, |
| 7 | 9309 the message is raised as an error exception instead |
| 9310 (see |try-echoerr|). | |
| 9311 Example: > | |
| 9312 :echoerr "This script just failed!" | |
| 9313 < If you just want a highlighted message use |:echohl|. | |
| 9314 And to get a beep: > | |
| 9315 :exe "normal \<Esc>" | |
| 9316 < | |
| 9317 *:exe* *:execute* | |
| 9318 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
| 2152 | 9319 of {expr1} as an Ex command. |
| 9320 Multiple arguments are concatenated, with a space in | |
| 9321 between. To avoid the extra space use the "." | |
| 9322 operator to concatenate strings into one argument. | |
| 9323 {expr1} is used as the processed command, command line | |
| 9324 editing keys are not recognized. | |
| 7 | 9325 Cannot be followed by a comment. |
| 9326 Examples: > | |
| 2152 | 9327 :execute "buffer" nextbuf |
| 9328 :execute "normal" count . "w" | |
| 7 | 9329 < |
| 9330 ":execute" can be used to append a command to commands | |
| 9331 that don't accept a '|'. Example: > | |
| 9332 :execute '!ls' | echo "theend" | |
| 9333 | |
| 9334 < ":execute" is also a nice way to avoid having to type | |
| 9335 control characters in a Vim script for a ":normal" | |
| 9336 command: > | |
| 9337 :execute "normal ixxx\<Esc>" | |
| 9338 < This has an <Esc> character, see |expr-string|. | |
| 9339 | |
| 1621 | 9340 Be careful to correctly escape special characters in |
| 9341 file names. The |fnameescape()| function can be used | |
| 1661 | 9342 for Vim commands, |shellescape()| for |:!| commands. |
| 9343 Examples: > | |
| 1621 | 9344 :execute "e " . fnameescape(filename) |
|
5692
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5690
diff
changeset
|
9345 :execute "!ls " . shellescape(filename, 1) |
| 1621 | 9346 < |
| 7 | 9347 Note: The executed string may be any command-line, but |
| 5763 | 9348 starting or ending "if", "while" and "for" does not |
| 9349 always work, because when commands are skipped the | |
| 9350 ":execute" is not evaluated and Vim loses track of | |
| 9351 where blocks start and end. Also "break" and | |
| 9352 "continue" should not be inside ":execute". | |
| 9353 This example does not work, because the ":execute" is | |
| 9354 not evaluated and Vim does not see the "while", and | |
| 9355 gives an error for finding an ":endwhile": > | |
| 9356 :if 0 | |
| 9357 : execute 'while i > 5' | |
| 9358 : echo "test" | |
| 9359 : endwhile | |
| 9360 :endif | |
| 7 | 9361 < |
| 9362 It is allowed to have a "while" or "if" command | |
| 9363 completely in the executed string: > | |
| 9364 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
| 9365 < | |
| 9366 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9367 *:exe-comment* |
| 7 | 9368 ":execute", ":echo" and ":echon" cannot be followed by |
| 9369 a comment directly, because they see the '"' as the | |
| 9370 start of a string. But, you can use '|' followed by a | |
| 9371 comment. Example: > | |
| 9372 :echo "foo" | "this is a comment | |
| 9373 | |
| 9374 ============================================================================== | |
| 9375 8. Exception handling *exception-handling* | |
| 9376 | |
| 9377 The Vim script language comprises an exception handling feature. This section | |
| 9378 explains how it can be used in a Vim script. | |
| 9379 | |
| 9380 Exceptions may be raised by Vim on an error or on interrupt, see | |
| 9381 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
| 9382 exception by using the ":throw" command, see |throw-catch|. | |
| 9383 | |
| 9384 | |
| 9385 TRY CONDITIONALS *try-conditionals* | |
| 9386 | |
| 9387 Exceptions can be caught or can cause cleanup code to be executed. You can | |
| 9388 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
| 9389 a finally clause (to be executed for cleanup). | |
| 9390 A try conditional begins with a |:try| command and ends at the matching | |
| 9391 |:endtry| command. In between, you can use a |:catch| command to start | |
| 9392 a catch clause, or a |:finally| command to start a finally clause. There may | |
| 9393 be none or multiple catch clauses, but there is at most one finally clause, | |
| 9394 which must not be followed by any catch clauses. The lines before the catch | |
| 9395 clauses and the finally clause is called a try block. > | |
| 9396 | |
| 9397 :try | |
| 1621 | 9398 : ... |
| 9399 : ... TRY BLOCK | |
| 9400 : ... | |
| 7 | 9401 :catch /{pattern}/ |
| 1621 | 9402 : ... |
| 9403 : ... CATCH CLAUSE | |
| 9404 : ... | |
| 7 | 9405 :catch /{pattern}/ |
| 1621 | 9406 : ... |
| 9407 : ... CATCH CLAUSE | |
| 9408 : ... | |
| 7 | 9409 :finally |
| 1621 | 9410 : ... |
| 9411 : ... FINALLY CLAUSE | |
| 9412 : ... | |
| 7 | 9413 :endtry |
| 9414 | |
| 9415 The try conditional allows to watch code for exceptions and to take the | |
| 9416 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
| 9417 from the try block and also the catch clauses may cause cleanup actions. | |
| 9418 When no exception is thrown during execution of the try block, the control | |
| 9419 is transferred to the finally clause, if present. After its execution, the | |
| 9420 script continues with the line following the ":endtry". | |
| 9421 When an exception occurs during execution of the try block, the remaining | |
| 9422 lines in the try block are skipped. The exception is matched against the | |
| 9423 patterns specified as arguments to the ":catch" commands. The catch clause | |
| 9424 after the first matching ":catch" is taken, other catch clauses are not | |
| 9425 executed. The catch clause ends when the next ":catch", ":finally", or | |
| 9426 ":endtry" command is reached - whatever is first. Then, the finally clause | |
| 9427 (if present) is executed. When the ":endtry" is reached, the script execution | |
| 9428 continues in the following line as usual. | |
| 9429 When an exception that does not match any of the patterns specified by the | |
| 9430 ":catch" commands is thrown in the try block, the exception is not caught by | |
| 9431 that try conditional and none of the catch clauses is executed. Only the | |
| 9432 finally clause, if present, is taken. The exception pends during execution of | |
| 9433 the finally clause. It is resumed at the ":endtry", so that commands after | |
| 9434 the ":endtry" are not executed and the exception might be caught elsewhere, | |
| 9435 see |try-nesting|. | |
| 9436 When during execution of a catch clause another exception is thrown, the | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9437 remaining lines in that catch clause are not executed. The new exception is |
| 7 | 9438 not matched against the patterns in any of the ":catch" commands of the same |
| 9439 try conditional and none of its catch clauses is taken. If there is, however, | |
| 9440 a finally clause, it is executed, and the exception pends during its | |
| 9441 execution. The commands following the ":endtry" are not executed. The new | |
| 9442 exception might, however, be caught elsewhere, see |try-nesting|. | |
| 9443 When during execution of the finally clause (if present) an exception is | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9444 thrown, the remaining lines in the finally clause are skipped. If the finally |
| 7 | 9445 clause has been taken because of an exception from the try block or one of the |
| 9446 catch clauses, the original (pending) exception is discarded. The commands | |
| 9447 following the ":endtry" are not executed, and the exception from the finally | |
| 9448 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
| 9449 | |
| 9450 The finally clause is also executed, when a ":break" or ":continue" for | |
| 9451 a ":while" loop enclosing the complete try conditional is executed from the | |
| 9452 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
| 9453 from the try block or a catch clause of a try conditional in a function or | |
| 9454 sourced script, respectively. The ":break", ":continue", ":return", or | |
| 9455 ":finish" pends during execution of the finally clause and is resumed when the | |
| 9456 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
| 9457 from the finally clause. | |
| 9458 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
| 9459 try conditional or when a ":return" or ":finish" is encountered in the finally | |
| 9460 clause, the rest of the finally clause is skipped, and the ":break", | |
| 9461 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
| 9462 clause has been taken because of an exception or an earlier ":break", | |
| 9463 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
| 9464 this pending exception or command is discarded. | |
| 9465 | |
| 9466 For examples see |throw-catch| and |try-finally|. | |
| 9467 | |
| 9468 | |
| 9469 NESTING OF TRY CONDITIONALS *try-nesting* | |
| 9470 | |
| 9471 Try conditionals can be nested arbitrarily. That is, a complete try | |
| 9472 conditional can be put into the try block, a catch clause, or the finally | |
| 9473 clause of another try conditional. If the inner try conditional does not | |
| 9474 catch an exception thrown in its try block or throws a new exception from one | |
| 9475 of its catch clauses or its finally clause, the outer try conditional is | |
| 9476 checked according to the rules above. If the inner try conditional is in the | |
| 9477 try block of the outer try conditional, its catch clauses are checked, but | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9478 otherwise only the finally clause is executed. It does not matter for |
| 7 | 9479 nesting, whether the inner try conditional is directly contained in the outer |
| 9480 one, or whether the outer one sources a script or calls a function containing | |
| 9481 the inner try conditional. | |
| 9482 | |
| 9483 When none of the active try conditionals catches an exception, just their | |
| 9484 finally clauses are executed. Thereafter, the script processing terminates. | |
| 9485 An error message is displayed in case of an uncaught exception explicitly | |
| 9486 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
| 9487 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
| 9488 as usual. | |
| 9489 | |
| 9490 For examples see |throw-catch|. | |
| 9491 | |
| 9492 | |
| 9493 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
| 9494 | |
| 9495 Exception handling code can get tricky. If you are in doubt what happens, set | |
| 9496 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
| 9497 script file. Then you see when an exception is thrown, discarded, caught, or | |
| 9498 finished. When using a verbosity level of at least 14, things pending in | |
| 9499 a finally clause are also shown. This information is also given in debug mode | |
| 9500 (see |debug-scripts|). | |
| 9501 | |
| 9502 | |
| 9503 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
| 9504 | |
| 9505 You can throw any number or string as an exception. Use the |:throw| command | |
| 9506 and pass the value to be thrown as argument: > | |
| 9507 :throw 4711 | |
| 9508 :throw "string" | |
| 9509 < *throw-expression* | |
| 9510 You can also specify an expression argument. The expression is then evaluated | |
| 9511 first, and the result is thrown: > | |
| 9512 :throw 4705 + strlen("string") | |
| 9513 :throw strpart("strings", 0, 6) | |
| 9514 | |
| 9515 An exception might be thrown during evaluation of the argument of the ":throw" | |
| 9516 command. Unless it is caught there, the expression evaluation is abandoned. | |
| 9517 The ":throw" command then does not throw a new exception. | |
| 9518 Example: > | |
| 9519 | |
| 9520 :function! Foo(arg) | |
| 9521 : try | |
| 9522 : throw a:arg | |
| 9523 : catch /foo/ | |
| 9524 : endtry | |
| 9525 : return 1 | |
| 9526 :endfunction | |
| 9527 : | |
| 9528 :function! Bar() | |
| 9529 : echo "in Bar" | |
| 9530 : return 4710 | |
| 9531 :endfunction | |
| 9532 : | |
| 9533 :throw Foo("arrgh") + Bar() | |
| 9534 | |
| 9535 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
| 9536 executed. > | |
| 9537 :throw Foo("foo") + Bar() | |
| 9538 however displays "in Bar" and throws 4711. | |
| 9539 | |
| 9540 Any other command that takes an expression as argument might also be | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9541 abandoned by an (uncaught) exception during the expression evaluation. The |
| 7 | 9542 exception is then propagated to the caller of the command. |
| 9543 Example: > | |
| 9544 | |
| 9545 :if Foo("arrgh") | |
| 9546 : echo "then" | |
| 9547 :else | |
| 9548 : echo "else" | |
| 9549 :endif | |
| 9550 | |
| 9551 Here neither of "then" or "else" is displayed. | |
| 9552 | |
| 9553 *catch-order* | |
| 9554 Exceptions can be caught by a try conditional with one or more |:catch| | |
| 9555 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
| 9556 command can be specified as a pattern argument. The subsequent catch clause | |
| 9557 gets executed when a matching exception is caught. | |
| 9558 Example: > | |
| 9559 | |
| 9560 :function! Foo(value) | |
| 9561 : try | |
| 9562 : throw a:value | |
| 9563 : catch /^\d\+$/ | |
| 9564 : echo "Number thrown" | |
| 9565 : catch /.*/ | |
| 9566 : echo "String thrown" | |
| 9567 : endtry | |
| 9568 :endfunction | |
| 9569 : | |
| 9570 :call Foo(0x1267) | |
| 9571 :call Foo('string') | |
| 9572 | |
| 9573 The first call to Foo() displays "Number thrown", the second "String thrown". | |
| 9574 An exception is matched against the ":catch" commands in the order they are | |
| 9575 specified. Only the first match counts. So you should place the more | |
| 9576 specific ":catch" first. The following order does not make sense: > | |
| 9577 | |
| 9578 : catch /.*/ | |
| 9579 : echo "String thrown" | |
| 9580 : catch /^\d\+$/ | |
| 9581 : echo "Number thrown" | |
| 9582 | |
| 9583 The first ":catch" here matches always, so that the second catch clause is | |
| 9584 never taken. | |
| 9585 | |
| 9586 *throw-variables* | |
| 9587 If you catch an exception by a general pattern, you may access the exact value | |
| 9588 in the variable |v:exception|: > | |
| 9589 | |
| 9590 : catch /^\d\+$/ | |
| 9591 : echo "Number thrown. Value is" v:exception | |
| 9592 | |
| 9593 You may also be interested where an exception was thrown. This is stored in | |
| 9594 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
| 9595 exception most recently caught as long it is not finished. | |
| 9596 Example: > | |
| 9597 | |
| 9598 :function! Caught() | |
| 9599 : if v:exception != "" | |
| 9600 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
| 9601 : else | |
| 9602 : echo 'Nothing caught' | |
| 9603 : endif | |
| 9604 :endfunction | |
| 9605 : | |
| 9606 :function! Foo() | |
| 9607 : try | |
| 9608 : try | |
| 9609 : try | |
| 9610 : throw 4711 | |
| 9611 : finally | |
| 9612 : call Caught() | |
| 9613 : endtry | |
| 9614 : catch /.*/ | |
| 9615 : call Caught() | |
| 9616 : throw "oops" | |
| 9617 : endtry | |
| 9618 : catch /.*/ | |
| 9619 : call Caught() | |
| 9620 : finally | |
| 9621 : call Caught() | |
| 9622 : endtry | |
| 9623 :endfunction | |
| 9624 : | |
| 9625 :call Foo() | |
| 9626 | |
| 9627 This displays > | |
| 9628 | |
| 9629 Nothing caught | |
| 9630 Caught "4711" in function Foo, line 4 | |
| 9631 Caught "oops" in function Foo, line 10 | |
| 9632 Nothing caught | |
| 9633 | |
| 9634 A practical example: The following command ":LineNumber" displays the line | |
| 9635 number in the script or function where it has been used: > | |
| 9636 | |
| 9637 :function! LineNumber() | |
| 9638 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
| 9639 :endfunction | |
| 9640 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
| 9641 < | |
| 9642 *try-nested* | |
| 9643 An exception that is not caught by a try conditional can be caught by | |
| 9644 a surrounding try conditional: > | |
| 9645 | |
| 9646 :try | |
| 9647 : try | |
| 9648 : throw "foo" | |
| 9649 : catch /foobar/ | |
| 9650 : echo "foobar" | |
| 9651 : finally | |
| 9652 : echo "inner finally" | |
| 9653 : endtry | |
| 9654 :catch /foo/ | |
| 9655 : echo "foo" | |
| 9656 :endtry | |
| 9657 | |
| 9658 The inner try conditional does not catch the exception, just its finally | |
| 9659 clause is executed. The exception is then caught by the outer try | |
| 9660 conditional. The example displays "inner finally" and then "foo". | |
| 9661 | |
| 9662 *throw-from-catch* | |
| 9663 You can catch an exception and throw a new one to be caught elsewhere from the | |
| 9664 catch clause: > | |
| 9665 | |
| 9666 :function! Foo() | |
| 9667 : throw "foo" | |
| 9668 :endfunction | |
| 9669 : | |
| 9670 :function! Bar() | |
| 9671 : try | |
| 9672 : call Foo() | |
| 9673 : catch /foo/ | |
| 9674 : echo "Caught foo, throw bar" | |
| 9675 : throw "bar" | |
| 9676 : endtry | |
| 9677 :endfunction | |
| 9678 : | |
| 9679 :try | |
| 9680 : call Bar() | |
| 9681 :catch /.*/ | |
| 9682 : echo "Caught" v:exception | |
| 9683 :endtry | |
| 9684 | |
| 9685 This displays "Caught foo, throw bar" and then "Caught bar". | |
| 9686 | |
| 9687 *rethrow* | |
| 9688 There is no real rethrow in the Vim script language, but you may throw | |
| 9689 "v:exception" instead: > | |
| 9690 | |
| 9691 :function! Bar() | |
| 9692 : try | |
| 9693 : call Foo() | |
| 9694 : catch /.*/ | |
| 9695 : echo "Rethrow" v:exception | |
| 9696 : throw v:exception | |
| 9697 : endtry | |
| 9698 :endfunction | |
| 9699 < *try-echoerr* | |
| 9700 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
| 9701 exceptions, because it is not possible to fake Vim internal exceptions. | |
| 9702 Trying so causes an error exception. You should throw your own exception | |
| 9703 denoting the situation. If you want to cause a Vim error exception containing | |
| 9704 the original error exception value, you can use the |:echoerr| command: > | |
| 9705 | |
| 9706 :try | |
| 9707 : try | |
| 9708 : asdf | |
| 9709 : catch /.*/ | |
| 9710 : echoerr v:exception | |
| 9711 : endtry | |
| 9712 :catch /.*/ | |
| 9713 : echo v:exception | |
| 9714 :endtry | |
| 9715 | |
| 9716 This code displays | |
| 9717 | |
| 1621 | 9718 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
| 7 | 9719 |
| 9720 | |
| 9721 CLEANUP CODE *try-finally* | |
| 9722 | |
| 9723 Scripts often change global settings and restore them at their end. If the | |
| 9724 user however interrupts the script by pressing CTRL-C, the settings remain in | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9725 an inconsistent state. The same may happen to you in the development phase of |
| 7 | 9726 a script when an error occurs or you explicitly throw an exception without |
| 9727 catching it. You can solve these problems by using a try conditional with | |
| 9728 a finally clause for restoring the settings. Its execution is guaranteed on | |
| 9729 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
| 9730 (Note that errors and interrupts from inside the try conditional are converted | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9731 to exceptions. When not caught, they terminate the script after the finally |
| 7 | 9732 clause has been executed.) |
| 9733 Example: > | |
| 9734 | |
| 9735 :try | |
| 9736 : let s:saved_ts = &ts | |
| 9737 : set ts=17 | |
| 9738 : | |
| 9739 : " Do the hard work here. | |
| 9740 : | |
| 9741 :finally | |
| 9742 : let &ts = s:saved_ts | |
| 9743 : unlet s:saved_ts | |
| 9744 :endtry | |
| 9745 | |
| 9746 This method should be used locally whenever a function or part of a script | |
| 9747 changes global settings which need to be restored on failure or normal exit of | |
| 9748 that function or script part. | |
| 9749 | |
| 9750 *break-finally* | |
| 9751 Cleanup code works also when the try block or a catch clause is left by | |
| 9752 a ":continue", ":break", ":return", or ":finish". | |
| 9753 Example: > | |
| 9754 | |
| 9755 :let first = 1 | |
| 9756 :while 1 | |
| 9757 : try | |
| 9758 : if first | |
| 9759 : echo "first" | |
| 9760 : let first = 0 | |
| 9761 : continue | |
| 9762 : else | |
| 9763 : throw "second" | |
| 9764 : endif | |
| 9765 : catch /.*/ | |
| 9766 : echo v:exception | |
| 9767 : break | |
| 9768 : finally | |
| 9769 : echo "cleanup" | |
| 9770 : endtry | |
| 9771 : echo "still in while" | |
| 9772 :endwhile | |
| 9773 :echo "end" | |
| 9774 | |
| 9775 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
| 9776 | |
| 9777 :function! Foo() | |
| 9778 : try | |
| 9779 : return 4711 | |
| 9780 : finally | |
| 9781 : echo "cleanup\n" | |
| 9782 : endtry | |
| 9783 : echo "Foo still active" | |
| 9784 :endfunction | |
| 9785 : | |
| 9786 :echo Foo() "returned by Foo" | |
| 9787 | |
| 9788 This displays "cleanup" and "4711 returned by Foo". You don't need to add an | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9789 extra ":return" in the finally clause. (Above all, this would override the |
| 7 | 9790 return value.) |
| 9791 | |
| 9792 *except-from-finally* | |
| 9793 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
| 9794 a finally clause is possible, but not recommended since it abandons the | |
| 9795 cleanup actions for the try conditional. But, of course, interrupt and error | |
| 9796 exceptions might get raised from a finally clause. | |
| 9797 Example where an error in the finally clause stops an interrupt from | |
| 9798 working correctly: > | |
| 9799 | |
| 9800 :try | |
| 9801 : try | |
| 9802 : echo "Press CTRL-C for interrupt" | |
| 9803 : while 1 | |
| 9804 : endwhile | |
| 9805 : finally | |
| 9806 : unlet novar | |
| 9807 : endtry | |
| 9808 :catch /novar/ | |
| 9809 :endtry | |
| 9810 :echo "Script still running" | |
| 9811 :sleep 1 | |
| 9812 | |
| 9813 If you need to put commands that could fail into a finally clause, you should | |
| 9814 think about catching or ignoring the errors in these commands, see | |
| 9815 |catch-errors| and |ignore-errors|. | |
| 9816 | |
| 9817 | |
| 9818 CATCHING ERRORS *catch-errors* | |
| 9819 | |
| 9820 If you want to catch specific errors, you just have to put the code to be | |
| 9821 watched in a try block and add a catch clause for the error message. The | |
| 9822 presence of the try conditional causes all errors to be converted to an | |
| 9823 exception. No message is displayed and |v:errmsg| is not set then. To find | |
| 9824 the right pattern for the ":catch" command, you have to know how the format of | |
| 9825 the error exception is. | |
| 9826 Error exceptions have the following format: > | |
| 9827 | |
| 9828 Vim({cmdname}):{errmsg} | |
| 9829 or > | |
| 9830 Vim:{errmsg} | |
| 9831 | |
| 9832 {cmdname} is the name of the command that failed; the second form is used when | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9833 the command name is not known. {errmsg} is the error message usually produced |
| 7 | 9834 when the error occurs outside try conditionals. It always begins with |
| 9835 a capital "E", followed by a two or three-digit error number, a colon, and | |
| 9836 a space. | |
| 9837 | |
| 9838 Examples: | |
| 9839 | |
| 9840 The command > | |
| 9841 :unlet novar | |
| 9842 normally produces the error message > | |
| 9843 E108: No such variable: "novar" | |
| 9844 which is converted inside try conditionals to an exception > | |
| 9845 Vim(unlet):E108: No such variable: "novar" | |
| 9846 | |
| 9847 The command > | |
| 9848 :dwim | |
| 9849 normally produces the error message > | |
| 9850 E492: Not an editor command: dwim | |
| 9851 which is converted inside try conditionals to an exception > | |
| 9852 Vim:E492: Not an editor command: dwim | |
| 9853 | |
| 9854 You can catch all ":unlet" errors by a > | |
| 9855 :catch /^Vim(unlet):/ | |
| 9856 or all errors for misspelled command names by a > | |
| 9857 :catch /^Vim:E492:/ | |
| 9858 | |
| 9859 Some error messages may be produced by different commands: > | |
| 9860 :function nofunc | |
| 9861 and > | |
| 9862 :delfunction nofunc | |
| 9863 both produce the error message > | |
| 9864 E128: Function name must start with a capital: nofunc | |
| 9865 which is converted inside try conditionals to an exception > | |
| 9866 Vim(function):E128: Function name must start with a capital: nofunc | |
| 9867 or > | |
| 9868 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
| 9869 respectively. You can catch the error by its number independently on the | |
| 9870 command that caused it if you use the following pattern: > | |
| 9871 :catch /^Vim(\a\+):E128:/ | |
| 9872 | |
| 9873 Some commands like > | |
| 9874 :let x = novar | |
| 9875 produce multiple error messages, here: > | |
| 9876 E121: Undefined variable: novar | |
| 9877 E15: Invalid expression: novar | |
| 9878 Only the first is used for the exception value, since it is the most specific | |
| 9879 one (see |except-several-errors|). So you can catch it by > | |
| 9880 :catch /^Vim(\a\+):E121:/ | |
| 9881 | |
| 9882 You can catch all errors related to the name "nofunc" by > | |
| 9883 :catch /\<nofunc\>/ | |
| 9884 | |
| 9885 You can catch all Vim errors in the ":write" and ":read" commands by > | |
| 9886 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
| 9887 | |
| 9888 You can catch all Vim errors by the pattern > | |
| 9889 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
| 9890 < | |
| 9891 *catch-text* | |
| 9892 NOTE: You should never catch the error message text itself: > | |
| 9893 :catch /No such variable/ | |
| 6647 | 9894 only works in the English locale, but not when the user has selected |
| 7 | 9895 a different language by the |:language| command. It is however helpful to |
| 9896 cite the message text in a comment: > | |
| 9897 :catch /^Vim(\a\+):E108:/ " No such variable | |
| 9898 | |
| 9899 | |
| 9900 IGNORING ERRORS *ignore-errors* | |
| 9901 | |
| 9902 You can ignore errors in a specific Vim command by catching them locally: > | |
| 9903 | |
| 9904 :try | |
| 9905 : write | |
| 9906 :catch | |
| 9907 :endtry | |
| 9908 | |
| 9909 But you are strongly recommended NOT to use this simple form, since it could | |
| 9910 catch more than you want. With the ":write" command, some autocommands could | |
| 9911 be executed and cause errors not related to writing, for instance: > | |
| 9912 | |
| 9913 :au BufWritePre * unlet novar | |
| 9914 | |
| 9915 There could even be such errors you are not responsible for as a script | |
| 9916 writer: a user of your script might have defined such autocommands. You would | |
| 9917 then hide the error from the user. | |
| 9918 It is much better to use > | |
| 9919 | |
| 9920 :try | |
| 9921 : write | |
| 9922 :catch /^Vim(write):/ | |
| 9923 :endtry | |
| 9924 | |
| 9925 which only catches real write errors. So catch only what you'd like to ignore | |
| 9926 intentionally. | |
| 9927 | |
| 9928 For a single command that does not cause execution of autocommands, you could | |
| 9929 even suppress the conversion of errors to exceptions by the ":silent!" | |
| 9930 command: > | |
| 9931 :silent! nunmap k | |
| 9932 This works also when a try conditional is active. | |
| 9933 | |
| 9934 | |
| 9935 CATCHING INTERRUPTS *catch-interrupt* | |
| 9936 | |
| 9937 When there are active try conditionals, an interrupt (CTRL-C) is converted to | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9938 the exception "Vim:Interrupt". You can catch it like every exception. The |
| 7 | 9939 script is not terminated, then. |
| 9940 Example: > | |
| 9941 | |
| 9942 :function! TASK1() | |
| 9943 : sleep 10 | |
| 9944 :endfunction | |
| 9945 | |
| 9946 :function! TASK2() | |
| 9947 : sleep 20 | |
| 9948 :endfunction | |
| 9949 | |
| 9950 :while 1 | |
| 9951 : let command = input("Type a command: ") | |
| 9952 : try | |
| 9953 : if command == "" | |
| 9954 : continue | |
| 9955 : elseif command == "END" | |
| 9956 : break | |
| 9957 : elseif command == "TASK1" | |
| 9958 : call TASK1() | |
| 9959 : elseif command == "TASK2" | |
| 9960 : call TASK2() | |
| 9961 : else | |
| 9962 : echo "\nIllegal command:" command | |
| 9963 : continue | |
| 9964 : endif | |
| 9965 : catch /^Vim:Interrupt$/ | |
| 9966 : echo "\nCommand interrupted" | |
| 9967 : " Caught the interrupt. Continue with next prompt. | |
| 9968 : endtry | |
| 9969 :endwhile | |
| 9970 | |
| 9971 You can interrupt a task here by pressing CTRL-C; the script then asks for | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9972 a new command. If you press CTRL-C at the prompt, the script is terminated. |
| 7 | 9973 |
| 9974 For testing what happens when CTRL-C would be pressed on a specific line in | |
| 9975 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
| 9976 command on that line. See |debug-scripts|. | |
| 9977 | |
| 9978 | |
| 9979 CATCHING ALL *catch-all* | |
| 9980 | |
| 9981 The commands > | |
| 9982 | |
| 9983 :catch /.*/ | |
| 9984 :catch // | |
| 9985 :catch | |
| 9986 | |
| 9987 catch everything, error exceptions, interrupt exceptions and exceptions | |
| 9988 explicitly thrown by the |:throw| command. This is useful at the top level of | |
| 9989 a script in order to catch unexpected things. | |
| 9990 Example: > | |
| 9991 | |
| 9992 :try | |
| 9993 : | |
| 9994 : " do the hard work here | |
| 9995 : | |
| 9996 :catch /MyException/ | |
| 9997 : | |
| 9998 : " handle known problem | |
| 9999 : | |
| 10000 :catch /^Vim:Interrupt$/ | |
| 10001 : echo "Script interrupted" | |
| 10002 :catch /.*/ | |
| 10003 : echo "Internal error (" . v:exception . ")" | |
| 10004 : echo " - occurred at " . v:throwpoint | |
| 10005 :endtry | |
| 10006 :" end of script | |
| 10007 | |
| 10008 Note: Catching all might catch more things than you want. Thus, you are | |
| 10009 strongly encouraged to catch only for problems that you can really handle by | |
| 10010 specifying a pattern argument to the ":catch". | |
| 10011 Example: Catching all could make it nearly impossible to interrupt a script | |
| 10012 by pressing CTRL-C: > | |
| 10013 | |
| 10014 :while 1 | |
| 10015 : try | |
| 10016 : sleep 1 | |
| 10017 : catch | |
| 10018 : endtry | |
| 10019 :endwhile | |
| 10020 | |
| 10021 | |
| 10022 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
| 10023 | |
| 10024 Exceptions may be used during execution of autocommands. Example: > | |
| 10025 | |
| 10026 :autocmd User x try | |
| 10027 :autocmd User x throw "Oops!" | |
| 10028 :autocmd User x catch | |
| 10029 :autocmd User x echo v:exception | |
| 10030 :autocmd User x endtry | |
| 10031 :autocmd User x throw "Arrgh!" | |
| 10032 :autocmd User x echo "Should not be displayed" | |
| 10033 : | |
| 10034 :try | |
| 10035 : doautocmd User x | |
| 10036 :catch | |
| 10037 : echo v:exception | |
| 10038 :endtry | |
| 10039 | |
| 10040 This displays "Oops!" and "Arrgh!". | |
| 10041 | |
| 10042 *except-autocmd-Pre* | |
| 10043 For some commands, autocommands get executed before the main action of the | |
| 10044 command takes place. If an exception is thrown and not caught in the sequence | |
| 10045 of autocommands, the sequence and the command that caused its execution are | |
| 10046 abandoned and the exception is propagated to the caller of the command. | |
| 10047 Example: > | |
| 10048 | |
| 10049 :autocmd BufWritePre * throw "FAIL" | |
| 10050 :autocmd BufWritePre * echo "Should not be displayed" | |
| 10051 : | |
| 10052 :try | |
| 10053 : write | |
| 10054 :catch | |
| 10055 : echo "Caught:" v:exception "from" v:throwpoint | |
| 10056 :endtry | |
| 10057 | |
| 10058 Here, the ":write" command does not write the file currently being edited (as | |
| 10059 you can see by checking 'modified'), since the exception from the BufWritePre | |
| 10060 autocommand abandons the ":write". The exception is then caught and the | |
| 10061 script displays: > | |
| 10062 | |
| 10063 Caught: FAIL from BufWrite Auto commands for "*" | |
| 10064 < | |
| 10065 *except-autocmd-Post* | |
| 10066 For some commands, autocommands get executed after the main action of the | |
| 10067 command has taken place. If this main action fails and the command is inside | |
| 10068 an active try conditional, the autocommands are skipped and an error exception | |
| 10069 is thrown that can be caught by the caller of the command. | |
| 10070 Example: > | |
| 10071 | |
| 10072 :autocmd BufWritePost * echo "File successfully written!" | |
| 10073 : | |
| 10074 :try | |
| 10075 : write /i/m/p/o/s/s/i/b/l/e | |
| 10076 :catch | |
| 10077 : echo v:exception | |
| 10078 :endtry | |
| 10079 | |
| 10080 This just displays: > | |
| 10081 | |
| 10082 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
| 10083 | |
| 10084 If you really need to execute the autocommands even when the main action | |
| 10085 fails, trigger the event from the catch clause. | |
| 10086 Example: > | |
| 10087 | |
| 10088 :autocmd BufWritePre * set noreadonly | |
| 10089 :autocmd BufWritePost * set readonly | |
| 10090 : | |
| 10091 :try | |
| 10092 : write /i/m/p/o/s/s/i/b/l/e | |
| 10093 :catch | |
| 10094 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
| 10095 :endtry | |
| 10096 < | |
| 10097 You can also use ":silent!": > | |
| 10098 | |
| 10099 :let x = "ok" | |
| 10100 :let v:errmsg = "" | |
| 10101 :autocmd BufWritePost * if v:errmsg != "" | |
| 10102 :autocmd BufWritePost * let x = "after fail" | |
| 10103 :autocmd BufWritePost * endif | |
| 10104 :try | |
| 10105 : silent! write /i/m/p/o/s/s/i/b/l/e | |
| 10106 :catch | |
| 10107 :endtry | |
| 10108 :echo x | |
| 10109 | |
| 10110 This displays "after fail". | |
| 10111 | |
| 10112 If the main action of the command does not fail, exceptions from the | |
| 10113 autocommands will be catchable by the caller of the command: > | |
| 10114 | |
| 10115 :autocmd BufWritePost * throw ":-(" | |
| 10116 :autocmd BufWritePost * echo "Should not be displayed" | |
| 10117 : | |
| 10118 :try | |
| 10119 : write | |
| 10120 :catch | |
| 10121 : echo v:exception | |
| 10122 :endtry | |
| 10123 < | |
| 10124 *except-autocmd-Cmd* | |
| 10125 For some commands, the normal action can be replaced by a sequence of | |
| 10126 autocommands. Exceptions from that sequence will be catchable by the caller | |
| 10127 of the command. | |
| 10128 Example: For the ":write" command, the caller cannot know whether the file | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
10129 had actually been written when the exception occurred. You need to tell it in |
| 7 | 10130 some way. > |
| 10131 | |
| 10132 :if !exists("cnt") | |
| 10133 : let cnt = 0 | |
| 10134 : | |
| 10135 : autocmd BufWriteCmd * if &modified | |
| 10136 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
| 10137 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
| 10138 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 10139 : autocmd BufWriteCmd * endif | |
| 10140 : autocmd BufWriteCmd * write | set nomodified | |
| 10141 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
| 10142 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 10143 : autocmd BufWriteCmd * endif | |
| 10144 : autocmd BufWriteCmd * echo "File successfully written!" | |
| 10145 : autocmd BufWriteCmd * endif | |
| 10146 :endif | |
| 10147 : | |
| 10148 :try | |
| 10149 : write | |
| 10150 :catch /^BufWriteCmdError$/ | |
| 10151 : if &modified | |
| 10152 : echo "Error on writing (file contents not changed)" | |
| 10153 : else | |
| 10154 : echo "Error after writing" | |
| 10155 : endif | |
| 10156 :catch /^Vim(write):/ | |
| 10157 : echo "Error on writing" | |
| 10158 :endtry | |
| 10159 | |
| 10160 When this script is sourced several times after making changes, it displays | |
| 10161 first > | |
| 10162 File successfully written! | |
| 10163 then > | |
| 10164 Error on writing (file contents not changed) | |
| 10165 then > | |
| 10166 Error after writing | |
| 10167 etc. | |
| 10168 | |
| 10169 *except-autocmd-ill* | |
| 10170 You cannot spread a try conditional over autocommands for different events. | |
| 10171 The following code is ill-formed: > | |
| 10172 | |
| 10173 :autocmd BufWritePre * try | |
| 10174 : | |
| 10175 :autocmd BufWritePost * catch | |
| 10176 :autocmd BufWritePost * echo v:exception | |
| 10177 :autocmd BufWritePost * endtry | |
| 10178 : | |
| 10179 :write | |
| 10180 | |
| 10181 | |
| 10182 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
| 10183 | |
| 10184 Some programming languages allow to use hierarchies of exception classes or to | |
| 10185 pass additional information with the object of an exception class. You can do | |
| 10186 similar things in Vim. | |
| 10187 In order to throw an exception from a hierarchy, just throw the complete | |
| 10188 class name with the components separated by a colon, for instance throw the | |
| 10189 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
| 10190 When you want to pass additional information with your exception class, add | |
| 10191 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
| 10192 for an error when writing "myfile". | |
| 10193 With the appropriate patterns in the ":catch" command, you can catch for | |
| 10194 base classes or derived classes of your hierarchy. Additional information in | |
| 10195 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
| 10196 Example: > | |
| 10197 | |
| 10198 :function! CheckRange(a, func) | |
| 10199 : if a:a < 0 | |
| 10200 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
| 10201 : endif | |
| 10202 :endfunction | |
| 10203 : | |
| 10204 :function! Add(a, b) | |
| 10205 : call CheckRange(a:a, "Add") | |
| 10206 : call CheckRange(a:b, "Add") | |
| 10207 : let c = a:a + a:b | |
| 10208 : if c < 0 | |
| 10209 : throw "EXCEPT:MATHERR:OVERFLOW" | |
| 10210 : endif | |
| 10211 : return c | |
| 10212 :endfunction | |
| 10213 : | |
| 10214 :function! Div(a, b) | |
| 10215 : call CheckRange(a:a, "Div") | |
| 10216 : call CheckRange(a:b, "Div") | |
| 10217 : if (a:b == 0) | |
| 10218 : throw "EXCEPT:MATHERR:ZERODIV" | |
| 10219 : endif | |
| 10220 : return a:a / a:b | |
| 10221 :endfunction | |
| 10222 : | |
| 10223 :function! Write(file) | |
| 10224 : try | |
| 1621 | 10225 : execute "write" fnameescape(a:file) |
| 7 | 10226 : catch /^Vim(write):/ |
| 10227 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
| 10228 : endtry | |
| 10229 :endfunction | |
| 10230 : | |
| 10231 :try | |
| 10232 : | |
| 10233 : " something with arithmetics and I/O | |
| 10234 : | |
| 10235 :catch /^EXCEPT:MATHERR:RANGE/ | |
| 10236 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
| 10237 : echo "Range error in" function | |
| 10238 : | |
| 10239 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
| 10240 : echo "Math error" | |
| 10241 : | |
| 10242 :catch /^EXCEPT:IO/ | |
| 10243 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
| 10244 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
| 10245 : if file !~ '^/' | |
| 10246 : let file = dir . "/" . file | |
| 10247 : endif | |
| 10248 : echo 'I/O error for "' . file . '"' | |
| 10249 : | |
| 10250 :catch /^EXCEPT/ | |
| 10251 : echo "Unspecified error" | |
| 10252 : | |
| 10253 :endtry | |
| 10254 | |
| 10255 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
| 10256 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
| 10257 exceptions with the "Vim" prefix; they are reserved for Vim. | |
| 10258 Vim error exceptions are parameterized with the name of the command that | |
| 10259 failed, if known. See |catch-errors|. | |
| 10260 | |
| 10261 | |
| 10262 PECULIARITIES | |
| 10263 *except-compat* | |
| 10264 The exception handling concept requires that the command sequence causing the | |
| 10265 exception is aborted immediately and control is transferred to finally clauses | |
| 10266 and/or a catch clause. | |
| 10267 | |
| 10268 In the Vim script language there are cases where scripts and functions | |
| 10269 continue after an error: in functions without the "abort" flag or in a command | |
| 10270 after ":silent!", control flow goes to the following line, and outside | |
| 10271 functions, control flow goes to the line following the outermost ":endwhile" | |
| 10272 or ":endif". On the other hand, errors should be catchable as exceptions | |
| 10273 (thus, requiring the immediate abortion). | |
| 10274 | |
| 10275 This problem has been solved by converting errors to exceptions and using | |
| 10276 immediate abortion (if not suppressed by ":silent!") only when a try | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
10277 conditional is active. This is no restriction since an (error) exception can |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
10278 be caught only from an active try conditional. If you want an immediate |
| 7 | 10279 termination without catching the error, just use a try conditional without |
| 10280 catch clause. (You can cause cleanup code being executed before termination | |
| 10281 by specifying a finally clause.) | |
| 10282 | |
| 10283 When no try conditional is active, the usual abortion and continuation | |
| 10284 behavior is used instead of immediate abortion. This ensures compatibility of | |
| 10285 scripts written for Vim 6.1 and earlier. | |
| 10286 | |
| 10287 However, when sourcing an existing script that does not use exception handling | |
| 10288 commands (or when calling one of its functions) from inside an active try | |
| 10289 conditional of a new script, you might change the control flow of the existing | |
| 10290 script on error. You get the immediate abortion on error and can catch the | |
| 10291 error in the new script. If however the sourced script suppresses error | |
| 10292 messages by using the ":silent!" command (checking for errors by testing | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
10293 |v:errmsg| if appropriate), its execution path is not changed. The error is |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
10294 not converted to an exception. (See |:silent|.) So the only remaining cause |
| 7 | 10295 where this happens is for scripts that don't care about errors and produce |
| 10296 error messages. You probably won't want to use such code from your new | |
| 10297 scripts. | |
| 10298 | |
| 10299 *except-syntax-err* | |
| 10300 Syntax errors in the exception handling commands are never caught by any of | |
| 10301 the ":catch" commands of the try conditional they belong to. Its finally | |
| 10302 clauses, however, is executed. | |
| 10303 Example: > | |
| 10304 | |
| 10305 :try | |
| 10306 : try | |
| 10307 : throw 4711 | |
| 10308 : catch /\(/ | |
| 10309 : echo "in catch with syntax error" | |
| 10310 : catch | |
| 10311 : echo "inner catch-all" | |
| 10312 : finally | |
| 10313 : echo "inner finally" | |
| 10314 : endtry | |
| 10315 :catch | |
| 10316 : echo 'outer catch-all caught "' . v:exception . '"' | |
| 10317 : finally | |
| 10318 : echo "outer finally" | |
| 10319 :endtry | |
| 10320 | |
| 10321 This displays: > | |
| 10322 inner finally | |
| 10323 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
| 10324 outer finally | |
| 10325 The original exception is discarded and an error exception is raised, instead. | |
| 10326 | |
| 10327 *except-single-line* | |
| 10328 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
| 10329 a single line, but then syntax errors may make it difficult to recognize the | |
| 10330 "catch" line, thus you better avoid this. | |
| 10331 Example: > | |
| 10332 :try | unlet! foo # | catch | endtry | |
| 10333 raises an error exception for the trailing characters after the ":unlet!" | |
| 10334 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
| 10335 error exception is discarded and the "E488: Trailing characters" message gets | |
| 10336 displayed. | |
| 10337 | |
| 10338 *except-several-errors* | |
| 10339 When several errors appear in a single command, the first error message is | |
| 10340 usually the most specific one and therefor converted to the error exception. | |
| 10341 Example: > | |
| 10342 echo novar | |
| 10343 causes > | |
| 10344 E121: Undefined variable: novar | |
| 10345 E15: Invalid expression: novar | |
| 10346 The value of the error exception inside try conditionals is: > | |
| 10347 Vim(echo):E121: Undefined variable: novar | |
| 10348 < *except-syntax-error* | |
| 10349 But when a syntax error is detected after a normal error in the same command, | |
| 10350 the syntax error is used for the exception being thrown. | |
| 10351 Example: > | |
| 10352 unlet novar # | |
| 10353 causes > | |
| 10354 E108: No such variable: "novar" | |
| 10355 E488: Trailing characters | |
| 10356 The value of the error exception inside try conditionals is: > | |
| 10357 Vim(unlet):E488: Trailing characters | |
| 10358 This is done because the syntax error might change the execution path in a way | |
| 10359 not intended by the user. Example: > | |
| 10360 try | |
| 10361 try | unlet novar # | catch | echo v:exception | endtry | |
| 10362 catch /.*/ | |
| 10363 echo "outer catch:" v:exception | |
| 10364 endtry | |
| 10365 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
| 10366 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
| 10367 | |
| 10368 ============================================================================== | |
| 10369 9. Examples *eval-examples* | |
| 10370 | |
| 1156 | 10371 Printing in Binary ~ |
| 7 | 10372 > |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
10373 :" The function Nr2Bin() returns the binary string representation of a number. |
| 1156 | 10374 :func Nr2Bin(nr) |
| 7 | 10375 : let n = a:nr |
| 10376 : let r = "" | |
| 10377 : while n | |
| 1156 | 10378 : let r = '01'[n % 2] . r |
| 10379 : let n = n / 2 | |
| 7 | 10380 : endwhile |
| 10381 : return r | |
| 10382 :endfunc | |
| 10383 | |
| 1156 | 10384 :" The function String2Bin() converts each character in a string to a |
| 10385 :" binary string, separated with dashes. | |
| 10386 :func String2Bin(str) | |
| 7 | 10387 : let out = '' |
| 1156 | 10388 : for ix in range(strlen(a:str)) |
| 10389 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
| 10390 : endfor | |
| 10391 : return out[1:] | |
| 7 | 10392 :endfunc |
| 10393 | |
| 10394 Example of its use: > | |
| 1156 | 10395 :echo Nr2Bin(32) |
| 10396 result: "100000" > | |
| 10397 :echo String2Bin("32") | |
| 10398 result: "110011-110010" | |
| 10399 | |
| 10400 | |
| 10401 Sorting lines ~ | |
| 10402 | |
| 10403 This example sorts lines with a specific compare function. > | |
| 10404 | |
| 10405 :func SortBuffer() | |
| 10406 : let lines = getline(1, '$') | |
| 10407 : call sort(lines, function("Strcmp")) | |
| 10408 : call setline(1, lines) | |
| 7 | 10409 :endfunction |
| 10410 | |
| 1156 | 10411 As a one-liner: > |
| 10412 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
| 10413 | |
| 10414 | |
| 10415 scanf() replacement ~ | |
| 7 | 10416 *sscanf* |
| 10417 There is no sscanf() function in Vim. If you need to extract parts from a | |
| 10418 line, you can use matchstr() and substitute() to do it. This example shows | |
| 10419 how to get the file name, line number and column number out of a line like | |
| 10420 "foobar.txt, 123, 45". > | |
| 10421 :" Set up the match bit | |
| 10422 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
| 10423 :"get the part matching the whole expression | |
| 10424 :let l = matchstr(line, mx) | |
| 10425 :"get each item out of the match | |
| 10426 :let file = substitute(l, mx, '\1', '') | |
| 10427 :let lnum = substitute(l, mx, '\2', '') | |
| 10428 :let col = substitute(l, mx, '\3', '') | |
| 10429 | |
| 10430 The input is in the variable "line", the results in the variables "file", | |
| 10431 "lnum" and "col". (idea from Michael Geddes) | |
| 10432 | |
| 1156 | 10433 |
| 10434 getting the scriptnames in a Dictionary ~ | |
| 10435 *scriptnames-dictionary* | |
| 10436 The |:scriptnames| command can be used to get a list of all script files that | |
| 10437 have been sourced. There is no equivalent function or variable for this | |
| 10438 (because it's rarely needed). In case you need to manipulate the list this | |
| 10439 code can be used: > | |
| 10440 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
| 10441 let scriptnames_output = '' | |
| 10442 redir => scriptnames_output | |
| 10443 silent scriptnames | |
| 10444 redir END | |
| 10445 | |
| 1621 | 10446 " Split the output into lines and parse each line. Add an entry to the |
| 1156 | 10447 " "scripts" dictionary. |
| 10448 let scripts = {} | |
| 10449 for line in split(scriptnames_output, "\n") | |
| 10450 " Only do non-blank lines. | |
| 10451 if line =~ '\S' | |
| 10452 " Get the first number in the line. | |
| 1621 | 10453 let nr = matchstr(line, '\d\+') |
| 1156 | 10454 " Get the file name, remove the script number " 123: ". |
| 1621 | 10455 let name = substitute(line, '.\+:\s*', '', '') |
| 1156 | 10456 " Add an item to the Dictionary |
| 1621 | 10457 let scripts[nr] = name |
| 1156 | 10458 endif |
| 10459 endfor | |
| 10460 unlet scriptnames_output | |
| 10461 | |
| 7 | 10462 ============================================================================== |
| 10463 10. No +eval feature *no-eval-feature* | |
| 10464 | |
| 10465 When the |+eval| feature was disabled at compile time, none of the expression | |
| 10466 evaluation commands are available. To prevent this from causing Vim scripts | |
| 10467 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
| 10468 recognized, though the argument of the ":if" and everything between the ":if" | |
| 10469 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
| 10470 only if the commands are at the start of the line. The ":else" command is not | |
| 10471 recognized. | |
| 10472 | |
| 10473 Example of how to avoid executing commands when the |+eval| feature is | |
| 10474 missing: > | |
| 10475 | |
| 10476 :if 1 | |
| 10477 : echo "Expression evaluation is compiled in" | |
| 10478 :else | |
| 10479 : echo "You will _never_ see this message" | |
| 10480 :endif | |
| 10481 | |
| 10482 ============================================================================== | |
| 10483 11. The sandbox *eval-sandbox* *sandbox* *E48* | |
| 10484 | |
|
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
10485 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
|
10486 '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
|
10487 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
|
10488 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
|
10489 the command from a tags file is executed and for CTRL-R = in the command line. |
| 29 | 10490 The sandbox is also used for the |:sandbox| command. |
| 7 | 10491 |
| 10492 These items are not allowed in the sandbox: | |
| 10493 - changing the buffer text | |
| 10494 - defining or changing mapping, autocommands, functions, user commands | |
| 10495 - setting certain options (see |option-summary|) | |
| 1156 | 10496 - setting certain v: variables (see |v:var|) *E794* |
| 7 | 10497 - executing a shell command |
| 10498 - reading or writing a file | |
| 10499 - jumping to another buffer or editing a file | |
| 625 | 10500 - executing Python, Perl, etc. commands |
| 29 | 10501 This is not guaranteed 100% secure, but it should block most attacks. |
| 10502 | |
| 10503 *:san* *:sandbox* | |
| 401 | 10504 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
| 29 | 10505 option that may have been set from a modeline, e.g. |
| 10506 'foldexpr'. | |
| 10507 | |
| 634 | 10508 *sandbox-option* |
| 10509 A few options contain an expression. When this expression is evaluated it may | |
| 790 | 10510 have to be done in the sandbox to avoid a security risk. But the sandbox is |
| 634 | 10511 restrictive, thus this only happens when the option was set from an insecure |
| 10512 location. Insecure in this context are: | |
| 843 | 10513 - sourcing a .vimrc or .exrc in the current directory |
| 634 | 10514 - while executing in the sandbox |
| 10515 - value coming from a modeline | |
| 10516 | |
| 10517 Note that when in the sandbox and saving an option value and restoring it, the | |
| 10518 option will still be marked as it was set in the sandbox. | |
| 10519 | |
| 10520 ============================================================================== | |
| 10521 12. Textlock *textlock* | |
| 10522 | |
| 10523 In a few situations it is not allowed to change the text in the buffer, jump | |
| 10524 to another window and some other things that might confuse or break what Vim | |
| 10525 is currently doing. This mostly applies to things that happen when Vim is | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
10526 actually doing something else. For example, evaluating the 'balloonexpr' may |
| 634 | 10527 happen any moment the mouse cursor is resting at some position. |
| 10528 | |
| 10529 This is not allowed when the textlock is active: | |
| 10530 - changing the buffer text | |
| 10531 - jumping to another buffer or window | |
| 10532 - editing another file | |
| 10533 - closing a window or quitting Vim | |
| 10534 - etc. | |
| 10535 | |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10536 ============================================================================== |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10537 13. Testing *testing* |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10538 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10539 Vim can be tested after building it, usually with "make test". |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10540 The tests are located in the directory "src/testdir". |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10541 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10542 There are several types of tests added over time: |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10543 test33.in oldest, don't add any more |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10544 test_something.in old style tests |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10545 test_something.vim new style tests |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10546 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10547 *new-style-testing* |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10548 New tests should be added as new style tests. These use functions such as |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10549 |assert_equal()| to keep the test commands and the expected result in one |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10550 place. |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10551 *old-style-testing* |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10552 In some cases an old style test needs to be used. E.g. when testing Vim |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10553 without the |+eval| feature. |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10554 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10555 Find more information in the file src/testdir/README.txt. |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10556 |
| 7 | 10557 |
| 10558 vim:tw=78:ts=8:ft=help:norl: |