Mercurial > vim
annotate runtime/doc/eval.txt @ 28208:92e7aeb97a55
Added tag v8.2.4629 for changeset 0090c27f26d3987ebf8564fd9d024ef44bfda52c
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Sat, 26 Mar 2022 12:00:05 +0100 |
parents | c968191a8557 |
children | 6dd88e45d47d |
rev | line source |
---|---|
28010 | 1 *eval.txt* For Vim version 8.2. Last change: 2022 Mar 05 |
1621 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
7 | 5 |
6 | |
7 Expression evaluation *expression* *expr* *E15* *eval* | |
27321 | 8 *E1002* |
7 | 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 |
26777
629e7046ef63
patch 8.2.3917: the eval.txt help file is way too big
Bram Moolenaar <Bram@vim.org>
parents:
26769
diff
changeset
|
15 This file is mainly about the backwards compatible (legacy) Vim script. For |
27036 | 16 specifics of Vim9 script, which can execute much faster, supports type |
17 checking and much more, see |vim9.txt|. Where the syntax or semantics differ | |
18 a remark is given. | |
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
19 |
85 | 20 1. Variables |variables| |
21 1.1 Variable types | |
87 | 22 1.2 Function references |Funcref| |
161 | 23 1.3 Lists |Lists| |
99 | 24 1.4 Dictionaries |Dictionaries| |
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
25 1.5 Blobs |Blobs| |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
26 1.6 More about variables |more-variables| |
85 | 27 2. Expression syntax |expression-syntax| |
28 3. Internal variable |internal-variables| | |
29 4. Builtin Functions |functions| | |
30 5. Defining functions |user-functions| | |
31 6. Curly braces names |curly-braces-names| | |
32 7. Commands |expression-commands| | |
33 8. Exception handling |exception-handling| | |
34 9. Examples |eval-examples| | |
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
35 10. Vim script version |vimscript-version| |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
36 11. No +eval feature |no-eval-feature| |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
37 12. The sandbox |eval-sandbox| |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
38 13. Textlock |textlock| |
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
39 |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
40 Testing support is documented in |testing.txt|. |
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
41 Profiling is documented at |profiling|. |
7 | 42 |
43 ============================================================================== | |
44 1. Variables *variables* | |
45 | |
85 | 46 1.1 Variable types ~ |
27459 | 47 *E712* *E896* *E897* *E899* *E1098* |
48 *E1107* *E1135* *E1138* | |
17909 | 49 There are ten types of variables: |
1621 | 50 |
18831 | 51 *Number* *Integer* |
52 Number A 32 or 64 bit signed number. |expr-number| | |
19477
2bb0e80fcd32
patch 8.2.0296: mixing up "long long" and __int64 may cause problems
Bram Moolenaar <Bram@vim.org>
parents:
19400
diff
changeset
|
53 The number of bits is available in |v:numbersize|. |
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
54 Examples: -123 0x10 0177 0o177 0b1011 |
99 | 55 |
1621 | 56 Float A floating point number. |floating-point-format| *Float* |
27321 | 57 {only when compiled with the |+float| feature} *E1076* |
1621 | 58 Examples: 123.456 1.15e-6 -1.1e3 |
59 | |
99 | 60 String A NUL terminated string of 8-bit unsigned characters (bytes). |
1621 | 61 |expr-string| Examples: "ab\txx\"--" 'x-z''a,c' |
99 | 62 |
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
63 List An ordered sequence of items, see |List| for details. |
99 | 64 Example: [1, 2, ['a', 'b']] |
55 | 65 |
370 | 66 Dictionary An associative, unordered array: Each entry has a key and a |
67 value. |Dictionary| | |
17368
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
68 Examples: |
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
69 {'blue': "#0000ff", 'red': "#ff0000"} |
17413
40417757dffd
patch 8.1.1705: using ~{} for a literal dict is not nice
Bram Moolenaar <Bram@vim.org>
parents:
17387
diff
changeset
|
70 #{blue: "#0000ff", red: "#ff0000"} |
370 | 71 |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
72 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
|
73 Example: function("strlen") |
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
74 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
|
75 like a Partial. |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
76 Example: function("Callback", [arg], myDict) |
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
77 |
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
78 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
|
79 |
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
80 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
|
81 |
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
82 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
|
83 |
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
84 Blob Binary Large Object. Stores any sequence of bytes. See |Blob| |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
85 for details |
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
86 Example: 0zFF00ED015DAF |
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
87 0z is an empty Blob. |
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
88 |
55 | 89 The Number and String types are converted automatically, depending on how they |
90 are used. | |
7 | 91 |
92 Conversion from a Number to a String is by making the ASCII representation of | |
2581 | 93 the Number. Examples: |
94 Number 123 --> String "123" ~ | |
95 Number 0 --> String "0" ~ | |
96 Number -1 --> String "-1" ~ | |
2152 | 97 *octal* |
21409
2c40e60017a8
patch 8.2.1255: cannot use a lambda with quickfix functions
Bram Moolenaar <Bram@vim.org>
parents:
21381
diff
changeset
|
98 Conversion from a String to a Number only happens in legacy Vim script, not in |
2c40e60017a8
patch 8.2.1255: cannot use a lambda with quickfix functions
Bram Moolenaar <Bram@vim.org>
parents:
21381
diff
changeset
|
99 Vim9 script. It is done by converting the first digits to a number. |
2c40e60017a8
patch 8.2.1255: cannot use a lambda with quickfix functions
Bram Moolenaar <Bram@vim.org>
parents:
21381
diff
changeset
|
100 Hexadecimal "0xf9", Octal "017" or "0o17", and Binary "0b10" |
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
101 numbers are recognized |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
102 NOTE: when using |Vim9| script or |scriptversion-4| octal with a leading "0" |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
103 is not recognized. The 0o notation requires patch 8.2.0886. |
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
104 If the String doesn't start with digits, the result is zero. |
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
105 Examples: |
2581 | 106 String "456" --> Number 456 ~ |
107 String "6bar" --> Number 6 ~ | |
108 String "foo" --> Number 0 ~ | |
109 String "0xf1" --> Number 241 ~ | |
110 String "0100" --> Number 64 ~ | |
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
111 String "0o100" --> Number 64 ~ |
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
112 String "0b101" --> Number 5 ~ |
2581 | 113 String "-8" --> Number -8 ~ |
114 String "+8" --> Number 0 ~ | |
7 | 115 |
116 To force conversion from String to Number, add zero to it: > | |
117 :echo "0100" + 0 | |
782 | 118 < 64 ~ |
119 | |
120 To avoid a leading zero to cause octal conversion, or for using a different | |
121 base, use |str2nr()|. | |
7 | 122 |
15512 | 123 *TRUE* *FALSE* *Boolean* |
7 | 124 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE. |
25619 | 125 You can also use |v:false| and |v:true|, in Vim9 script |false| and |true|. |
22171 | 126 When TRUE is returned from a function it is the Number one, FALSE is the |
127 number zero. | |
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
128 |
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
129 Note that in the command: > |
7 | 130 :if "foo" |
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
131 :" NOT executed |
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
132 "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
|
133 non-zero number it means TRUE: > |
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
134 :if "8foo" |
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
135 :" executed |
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
136 To test for a non-empty string, use empty(): > |
3893 | 137 :if !empty("foo") |
22492
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
138 |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
139 < *falsy* *truthy* |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
140 An expression can be used as a condition, ignoring the type and only using |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
141 whether the value is "sort of true" or "sort of false". Falsy is: |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
142 the number zero |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
143 empty string, blob, list or dictionary |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
144 Other values are truthy. Examples: |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
145 0 falsy |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
146 1 truthy |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
147 -1 truthy |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
148 0.0 falsy |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
149 0.1 truthy |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
150 '' falsy |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
151 'x' truthy |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
152 [] falsy |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
153 [0] truthy |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
154 {} falsy |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
155 #{x: 1} truthy |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
156 0z falsy |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
157 0z00 truthy |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
158 |
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
159 *non-zero-arg* |
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
160 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
|
161 argument is present and it evaluates to a non-zero Number, |v:true| or a |
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
10054
diff
changeset
|
162 non-empty String, then the value is considered to be TRUE. |
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
163 Note that " " and "0" are also non-empty strings, thus considered to be TRUE. |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
164 A List, Dictionary or Float is not a Number or String, thus evaluate to FALSE. |
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
165 |
27036 | 166 *E611* *E745* *E728* *E703* *E729* *E730* *E731* *E908* *E910* |
167 *E913* *E974* *E975* *E976* | |
15512 | 168 |List|, |Dictionary|, |Funcref|, |Job|, |Channel| and |Blob| types are not |
169 automatically converted. | |
85 | 170 |
1621 | 171 *E805* *E806* *E808* |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
172 When mixing Number and Float the Number is converted to Float. Otherwise |
1621 | 173 there is no automatic conversion of Float. You can use str2float() for String |
174 to Float, printf() for Float to String and float2nr() for Float to Number. | |
175 | |
27036 | 176 *E362* *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
|
177 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
|
178 |
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
179 *no-type-checking* |
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
180 You will not get an error if you try to change the type of a variable. |
85 | 181 |
182 | |
87 | 183 1.2 Function references ~ |
27537 | 184 *Funcref* *E695* *E718* *E1086* *E1192* |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
185 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
|
186 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
|
187 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
|
188 around the arguments, to invoke the function it refers to. Example: > |
55 | 189 |
190 :let Fn = function("MyFunc") | |
191 :echo Fn() | |
114 | 192 < *E704* *E705* *E707* |
819 | 193 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You |
5340 | 194 can use "g:" but the following name must still start with a capital. You |
819 | 195 cannot have both a Funcref variable and a function with the same name. |
85 | 196 |
114 | 197 A special case is defining a function and directly assigning its Funcref to a |
198 Dictionary entry. Example: > | |
199 :function dict.init() dict | |
200 : let self.val = 0 | |
201 :endfunction | |
202 | |
203 The key of the Dictionary can start with a lower case letter. The actual | |
204 function name is not used here. Also see |numbered-function|. | |
205 | |
206 A Funcref can also be used with the |:call| command: > | |
207 :call Fn() | |
208 :call dict.init() | |
85 | 209 |
210 The name of the referenced function can be obtained with |string()|. > | |
119 | 211 :let func = string(Fn) |
85 | 212 |
213 You can use |call()| to invoke a Funcref and use a list variable for the | |
214 arguments: > | |
119 | 215 :let r = call(Fn, mylist) |
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
216 < |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
217 *Partial* |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
218 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
|
219 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
|
220 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
|
221 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
|
222 |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
223 let Cb = function('Callback', ['foo'], myDict) |
14999 | 224 call Cb('bar') |
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
225 |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
226 This will invoke the function as if using: > |
14999 | 227 call myDict.Callback('foo', 'bar') |
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
228 |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
229 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
|
230 |ch_open()|. |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
231 |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
232 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
|
233 a member of the Dictionary: > |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
234 |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
235 let myDict.myFunction = MyFunction |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
236 call myDict.myFunction() |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
237 |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
238 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
|
239 "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
|
240 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
|
241 |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
242 let otherDict.myFunction = myDict.myFunction |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
243 call otherDict.myFunction() |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
244 |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
245 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
|
246 this won't happen: > |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
247 |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
248 let myDict.myFunction = function(MyFunction, myDict) |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
249 let otherDict.myFunction = myDict.myFunction |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
250 call otherDict.myFunction() |
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
251 |
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
252 Here "self" will be "myDict", because it was bound explicitly. |
85 | 253 |
254 | |
87 | 255 1.3 Lists ~ |
5814 | 256 *list* *List* *Lists* *E686* |
55 | 257 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
|
258 can be accessed by their index number. Items can be added and removed at any |
55 | 259 position in the sequence. |
260 | |
85 | 261 |
262 List creation ~ | |
263 *E696* *E697* | |
55 | 264 A List is created with a comma separated list of items in square brackets. |
85 | 265 Examples: > |
266 :let mylist = [1, two, 3, "four"] | |
267 :let emptylist = [] | |
55 | 268 |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
269 An item can be any expression. Using a List for an item creates a |
842 | 270 List of Lists: > |
85 | 271 :let nestlist = [[11, 12], [21, 22], [31, 32]] |
55 | 272 |
273 An extra comma after the last item is ignored. | |
274 | |
85 | 275 |
276 List index ~ | |
277 *list-index* *E684* | |
55 | 278 An item in the List can be accessed by putting the index in square brackets |
85 | 279 after the List. Indexes are zero-based, thus the first item has index zero. > |
280 :let item = mylist[0] " get the first item: 1 | |
55 | 281 :let item = mylist[2] " get the third item: 3 |
85 | 282 |
87 | 283 When the resulting item is a list this can be repeated: > |
85 | 284 :let item = nestlist[0][1] " get the first list, second item: 12 |
55 | 285 < |
85 | 286 A negative index is counted from the end. Index -1 refers to the last item in |
287 the List, -2 to the last but one item, etc. > | |
55 | 288 :let last = mylist[-1] " get the last item: "four" |
289 | |
85 | 290 To avoid an error for an invalid index use the |get()| function. When an item |
87 | 291 is not available it returns zero or the default value you specify: > |
85 | 292 :echo get(mylist, idx) |
293 :echo get(mylist, idx, "NONE") | |
294 | |
295 | |
296 List concatenation ~ | |
23788
d12ef361d9de
patch 8.2.2435: setline() gives an error for some types
Bram Moolenaar <Bram@vim.org>
parents:
23737
diff
changeset
|
297 *list-concatenation* |
85 | 298 Two lists can be concatenated with the "+" operator: > |
299 :let longlist = mylist + [5, 6] | |
119 | 300 :let mylist += [7, 8] |
85 | 301 |
23788
d12ef361d9de
patch 8.2.2435: setline() gives an error for some types
Bram Moolenaar <Bram@vim.org>
parents:
23737
diff
changeset
|
302 To prepend or append an item, turn the item into a list by putting [] around |
d12ef361d9de
patch 8.2.2435: setline() gives an error for some types
Bram Moolenaar <Bram@vim.org>
parents:
23737
diff
changeset
|
303 it. To change a list in-place, refer to |list-modification| below. |
85 | 304 |
305 | |
306 Sublist ~ | |
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
307 *sublist* |
55 | 308 A part of the List can be obtained by specifying the first and last index, |
309 separated by a colon in square brackets: > | |
85 | 310 :let shortlist = mylist[2:-1] " get List [3, "four"] |
55 | 311 |
312 Omitting the first index is similar to zero. Omitting the last index is | |
1156 | 313 similar to -1. > |
90 | 314 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"] |
315 :let shortlist = mylist[2:2] " List with one item: [3] | |
316 :let otherlist = mylist[:] " make a copy of the List | |
85 | 317 |
23604
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
318 Notice that the last index is inclusive. If you prefer using an exclusive |
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
319 index use the |slice()| method. |
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
320 |
842 | 321 If the first index is beyond the last item of the List or the second item is |
322 before the first item, the result is an empty list. There is no error | |
323 message. | |
324 | |
325 If the second index is equal to or greater than the length of the list the | |
326 length minus one is used: > | |
829 | 327 :let mylist = [0, 1, 2, 3] |
328 :echo mylist[2:8] " result: [2, 3] | |
329 | |
270 | 330 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
|
331 using a single letter variable before the ":". Insert a space when needed: |
270 | 332 mylist[s : e]. |
333 | |
85 | 334 |
335 List identity ~ | |
99 | 336 *list-identity* |
85 | 337 When variable "aa" is a list and you assign it to another variable "bb", both |
338 variables refer to the same list. Thus changing the list "aa" will also | |
339 change "bb": > | |
340 :let aa = [1, 2, 3] | |
341 :let bb = aa | |
342 :call add(aa, 4) | |
343 :echo bb | |
114 | 344 < [1, 2, 3, 4] |
85 | 345 |
346 Making a copy of a list is done with the |copy()| function. Using [:] also | |
347 works, as explained above. This creates a shallow copy of the list: Changing | |
87 | 348 a list item in the list will also change the item in the copied list: > |
85 | 349 :let aa = [[1, 'a'], 2, 3] |
350 :let bb = copy(aa) | |
114 | 351 :call add(aa, 4) |
85 | 352 :let aa[0][1] = 'aaa' |
353 :echo aa | |
114 | 354 < [[1, aaa], 2, 3, 4] > |
85 | 355 :echo bb |
114 | 356 < [[1, aaa], 2, 3] |
85 | 357 |
87 | 358 To make a completely independent list use |deepcopy()|. This also makes a |
114 | 359 copy of the values in the list, recursively. Up to a hundred levels deep. |
85 | 360 |
361 The operator "is" can be used to check if two variables refer to the same | |
114 | 362 List. "isnot" does the opposite. In contrast "==" compares if two lists have |
87 | 363 the same value. > |
364 :let alist = [1, 2, 3] | |
365 :let blist = [1, 2, 3] | |
366 :echo alist is blist | |
114 | 367 < 0 > |
87 | 368 :echo alist == blist |
114 | 369 < 1 |
85 | 370 |
323 | 371 Note about comparing lists: Two lists are considered equal if they have the |
372 same length and all items compare equal, as with using "==". There is one | |
388 | 373 exception: When comparing a number with a string they are considered |
374 different. There is no automatic type conversion, as with using "==" on | |
375 variables. Example: > | |
376 echo 4 == "4" | |
323 | 377 < 1 > |
388 | 378 echo [4] == ["4"] |
323 | 379 < 0 |
380 | |
388 | 381 Thus comparing Lists is more strict than comparing numbers and strings. You |
1621 | 382 can compare simple values this way too by putting them in a list: > |
388 | 383 |
384 :let a = 5 | |
385 :let b = "5" | |
1621 | 386 :echo a == b |
388 | 387 < 1 > |
1621 | 388 :echo [a] == [b] |
388 | 389 < 0 |
323 | 390 |
85 | 391 |
392 List unpack ~ | |
393 | |
394 To unpack the items in a list to individual variables, put the variables in | |
395 square brackets, like list items: > | |
396 :let [var1, var2] = mylist | |
397 | |
398 When the number of variables does not match the number of items in the list | |
399 this produces an error. To handle any extra items from the list append ";" | |
400 and a variable name: > | |
401 :let [var1, var2; rest] = mylist | |
402 | |
403 This works like: > | |
404 :let var1 = mylist[0] | |
405 :let var2 = mylist[1] | |
95 | 406 :let rest = mylist[2:] |
85 | 407 |
408 Except that there is no error if there are only two items. "rest" will be an | |
409 empty list then. | |
410 | |
411 | |
412 List modification ~ | |
413 *list-modification* | |
87 | 414 To change a specific item of a list use |:let| this way: > |
85 | 415 :let list[4] = "four" |
416 :let listlist[0][3] = item | |
417 | |
87 | 418 To change part of a list you can specify the first and last item to be |
114 | 419 modified. The value must at least have the number of items in the range: > |
87 | 420 :let list[3:5] = [3, 4, 5] |
421 | |
85 | 422 Adding and removing items from a list is done with functions. Here are a few |
423 examples: > | |
424 :call insert(list, 'a') " prepend item 'a' | |
425 :call insert(list, 'a', 3) " insert item 'a' before list[3] | |
426 :call add(list, "new") " append String item | |
114 | 427 :call add(list, [1, 2]) " append a List as one new item |
85 | 428 :call extend(list, [1, 2]) " extend the list with two more items |
429 :let i = remove(list, 3) " remove item 3 | |
108 | 430 :unlet list[3] " idem |
85 | 431 :let l = remove(list, 3, -1) " remove items 3 to last item |
108 | 432 :unlet list[3 : ] " idem |
114 | 433 :call filter(list, 'v:val !~ "x"') " remove items with an 'x' |
434 | |
435 Changing the order of items in a list: > | |
87 | 436 :call sort(list) " sort a list alphabetically |
437 :call reverse(list) " reverse the order of items | |
5747 | 438 :call uniq(sort(list)) " sort and remove duplicates |
87 | 439 |
85 | 440 |
441 For loop ~ | |
442 | |
24234
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
443 The |:for| loop executes commands for each item in a List, String or Blob. |
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
444 A variable is set to each item in sequence. Example with a List: > |
114 | 445 :for item in mylist |
446 : call Doit(item) | |
85 | 447 :endfor |
448 | |
449 This works like: > | |
450 :let index = 0 | |
451 :while index < len(mylist) | |
114 | 452 : let item = mylist[index] |
453 : :call Doit(item) | |
85 | 454 : let index = index + 1 |
455 :endwhile | |
456 | |
95 | 457 If all you want to do is modify each item in the list then the |map()| |
114 | 458 function will be a simpler method than a for loop. |
95 | 459 |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
460 Just like the |:let| command, |:for| also accepts a list of variables. This |
24234
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
461 requires the argument to be a List of Lists. > |
85 | 462 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]] |
463 : call Doit(lnum, col) | |
464 :endfor | |
465 | |
466 This works like a |:let| command is done for each list item. Again, the types | |
467 must remain the same to avoid an error. | |
468 | |
114 | 469 It is also possible to put remaining items in a List variable: > |
85 | 470 :for [i, j; rest] in listlist |
471 : call Doit(i, j) | |
472 : if !empty(rest) | |
27903 | 473 : echo "remainder: " .. string(rest) |
85 | 474 : endif |
475 :endfor | |
476 | |
24234
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
477 For a Blob one byte at a time is used. |
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
478 |
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
479 For a String one character, including any composing characters, is used as a |
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
480 String. Example: > |
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
481 for c in text |
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
482 echo 'This character is ' .. c |
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
483 endfor |
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
484 |
85 | 485 |
486 List functions ~ | |
114 | 487 *E714* |
85 | 488 Functions that are useful with a List: > |
87 | 489 :let r = call(funcname, list) " call a function with an argument list |
85 | 490 :if empty(list) " check if list is empty |
102 | 491 :let l = len(list) " number of items in list |
492 :let big = max(list) " maximum value in list | |
493 :let small = min(list) " minimum value in list | |
87 | 494 :let xs = count(list, 'x') " count nr of times 'x' appears in list |
495 :let i = index(list, 'x') " index of first 'x' in list | |
85 | 496 :let lines = getline(1, 10) " get ten text lines from buffer |
497 :call append('$', lines) " append text lines in buffer | |
95 | 498 :let list = split("a b c") " create list from items in a string |
499 :let string = join(list, ', ') " create string from list items | |
102 | 500 :let s = string(list) " String representation of list |
27903 | 501 :call map(list, '">> " .. v:val') " prepend ">> " to each item |
99 | 502 |
258 | 503 Don't forget that a combination of features can make things simple. For |
504 example, to add up all the numbers in a list: > | |
27903 | 505 :exe 'let sum = ' .. join(nrlist, '+') |
258 | 506 |
99 | 507 |
508 1.4 Dictionaries ~ | |
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
509 *dict* *Dict* *Dictionaries* *Dictionary* |
99 | 510 A Dictionary is an associative array: Each entry has a key and a value. The |
114 | 511 entry can be located with the key. The entries are stored without a specific |
512 ordering. | |
99 | 513 |
514 | |
515 Dictionary creation ~ | |
114 | 516 *E720* *E721* *E722* *E723* |
99 | 517 A Dictionary is created with a comma separated list of entries in curly |
114 | 518 braces. Each entry has a key and a value, separated by a colon. Each key can |
519 only appear once. Examples: > | |
99 | 520 :let mydict = {1: 'one', 2: 'two', 3: 'three'} |
521 :let emptydict = {} | |
114 | 522 < *E713* *E716* *E717* |
99 | 523 A key is always a String. You can use a Number, it will be converted to a |
524 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
|
525 entry. Note that the String '04' and the Number 04 are different, since the |
17368
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
526 Number will be converted to the String '4'. The empty string can also be used |
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
527 as a key. |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
528 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
529 In |Vim9| script literaly keys can be used if the key consists of alphanumeric |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
530 characters, underscore and dash, see |vim9-literal-dict|. |
17758 | 531 *literal-Dict* *#{}* |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
532 To avoid having to put quotes around every key the #{} form can be used in |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
533 legacy script. This does require the key to consist only of ASCII letters, |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
534 digits, '-' and '_'. Example: > |
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
535 :let mydict = #{zero: 0, one_key: 1, two-key: 2, 333: 3} |
17413
40417757dffd
patch 8.1.1705: using ~{} for a literal dict is not nice
Bram Moolenaar <Bram@vim.org>
parents:
17387
diff
changeset
|
536 Note that 333 here is the string "333". Empty keys are not possible with #{}. |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
537 In |Vim9| script the #{} form cannot be used. |
114 | 538 |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
539 A value can be any expression. Using a Dictionary for a value creates a |
99 | 540 nested Dictionary: > |
541 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}} | |
542 | |
543 An extra comma after the last entry is ignored. | |
544 | |
545 | |
546 Accessing entries ~ | |
547 | |
548 The normal way to access an entry is by putting the key in square brackets: > | |
549 :let val = mydict["one"] | |
550 :let mydict["four"] = 4 | |
551 | |
114 | 552 You can add new entries to an existing Dictionary this way, unlike Lists. |
99 | 553 |
554 For keys that consist entirely of letters, digits and underscore the following | |
555 form can be used |expr-entry|: > | |
556 :let val = mydict.one | |
557 :let mydict.four = 4 | |
558 | |
559 Since an entry can be any type, also a List and a Dictionary, the indexing and | |
560 key lookup can be repeated: > | |
114 | 561 :echo dict.key[idx].key |
99 | 562 |
563 | |
564 Dictionary to List conversion ~ | |
565 | |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
566 You may want to loop over the entries in a dictionary. For this you need to |
99 | 567 turn the Dictionary into a List and pass it to |:for|. |
568 | |
569 Most often you want to loop over the keys, using the |keys()| function: > | |
570 :for key in keys(mydict) | |
27903 | 571 : echo key .. ': ' .. mydict[key] |
99 | 572 :endfor |
573 | |
574 The List of keys is unsorted. You may want to sort them first: > | |
575 :for key in sort(keys(mydict)) | |
576 | |
577 To loop over the values use the |values()| function: > | |
578 :for v in values(mydict) | |
27903 | 579 : echo "value: " .. v |
99 | 580 :endfor |
581 | |
582 If you want both the key and the value use the |items()| function. It returns | |
15131 | 583 a List in which each item is a List with two items, the key and the value: > |
1156 | 584 :for [key, value] in items(mydict) |
27903 | 585 : echo key .. ': ' .. value |
99 | 586 :endfor |
587 | |
588 | |
589 Dictionary identity ~ | |
161 | 590 *dict-identity* |
99 | 591 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a |
592 Dictionary. Otherwise, assignment results in referring to the same | |
593 Dictionary: > | |
594 :let onedict = {'a': 1, 'b': 2} | |
595 :let adict = onedict | |
596 :let adict['a'] = 11 | |
597 :echo onedict['a'] | |
598 11 | |
599 | |
327 | 600 Two Dictionaries compare equal if all the key-value pairs compare equal. For |
601 more info see |list-identity|. | |
99 | 602 |
603 | |
604 Dictionary modification ~ | |
605 *dict-modification* | |
606 To change an already existing entry of a Dictionary, or to add a new entry, | |
607 use |:let| this way: > | |
608 :let dict[4] = "four" | |
609 :let dict['one'] = item | |
610 | |
108 | 611 Removing an entry from a Dictionary is done with |remove()| or |:unlet|. |
612 Three ways to remove the entry with key "aaa" from dict: > | |
613 :let i = remove(dict, 'aaa') | |
614 :unlet dict.aaa | |
615 :unlet dict['aaa'] | |
99 | 616 |
617 Merging a Dictionary with another is done with |extend()|: > | |
114 | 618 :call extend(adict, bdict) |
619 This extends adict with all entries from bdict. Duplicate keys cause entries | |
620 in adict to be overwritten. An optional third argument can change this. | |
119 | 621 Note that the order of entries in a Dictionary is irrelevant, thus don't |
622 expect ":echo adict" to show the items from bdict after the older entries in | |
623 adict. | |
99 | 624 |
625 Weeding out entries from a Dictionary can be done with |filter()|: > | |
1156 | 626 :call filter(dict, 'v:val =~ "x"') |
114 | 627 This removes all entries from "dict" with a value not matching 'x'. |
20552 | 628 This can also be used to remove all entries: > |
629 call filter(dict, 0) | |
102 | 630 |
631 | |
632 Dictionary function ~ | |
4159 | 633 *Dictionary-function* *self* *E725* *E862* |
102 | 634 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
|
635 special way with a dictionary. Example: > |
102 | 636 :function Mylen() dict |
114 | 637 : return len(self.data) |
102 | 638 :endfunction |
114 | 639 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")} |
640 :echo mydict.len() | |
102 | 641 |
642 This is like a method in object oriented programming. The entry in the | |
643 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary | |
644 the function was invoked from. | |
645 | |
114 | 646 It is also possible to add a function without the "dict" attribute as a |
647 Funcref to a Dictionary, but the "self" variable is not available then. | |
648 | |
819 | 649 *numbered-function* *anonymous-function* |
102 | 650 To avoid the extra name for the function it can be defined and directly |
651 assigned to a Dictionary in this way: > | |
114 | 652 :let mydict = {'data': [0, 1, 2, 3]} |
6741 | 653 :function mydict.len() |
114 | 654 : return len(self.data) |
102 | 655 :endfunction |
114 | 656 :echo mydict.len() |
657 | |
658 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
|
659 that references this function. The function can only be used through a |
114 | 660 |Funcref|. It will automatically be deleted when there is no |Funcref| |
661 remaining that refers to it. | |
662 | |
663 It is not necessary to use the "dict" attribute for a numbered function. | |
102 | 664 |
2488
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
665 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
|
666 a trick. Assuming the function is 42, the command is: > |
25836 | 667 :function g:42 |
2488
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
668 |
102 | 669 |
670 Functions for Dictionaries ~ | |
114 | 671 *E715* |
672 Functions that can be used with a Dictionary: > | |
102 | 673 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo" |
674 :if empty(dict) " TRUE if dict is empty | |
675 :let l = len(dict) " number of items in dict | |
676 :let big = max(dict) " maximum value in dict | |
677 :let small = min(dict) " minimum value in dict | |
678 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict | |
679 :let s = string(dict) " String representation of dict | |
27903 | 680 :call map(dict, '">> " .. v:val') " prepend ">> " to each item |
99 | 681 |
682 | |
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
683 1.5 Blobs ~ |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
684 *blob* *Blob* *Blobs* *E978* |
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
685 A Blob is a binary object. It can be used to read an image from a file and |
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
686 send it over a channel, for example. |
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
687 |
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
688 A Blob mostly behaves like a |List| of numbers, where each number has the |
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
689 value of an 8-bit byte, from 0 to 255. |
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
690 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
691 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
692 Blob creation ~ |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
693 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
694 A Blob can be created with a |blob-literal|: > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
695 :let b = 0zFF00ED015DAF |
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
696 Dots can be inserted between bytes (pair of hex characters) for readability, |
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
697 they don't change the value: > |
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
698 :let b = 0zFF00.ED01.5DAF |
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
699 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
700 A blob can be read from a file with |readfile()| passing the {type} argument |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
701 set to "B", for example: > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
702 :let b = readfile('image.png', 'B') |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
703 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
704 A blob can be read from a channel with the |ch_readblob()| function. |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
705 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
706 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
707 Blob index ~ |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
708 *blob-index* *E979* |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
709 A byte in the Blob can be accessed by putting the index in square brackets |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
710 after the Blob. Indexes are zero-based, thus the first byte has index zero. > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
711 :let myblob = 0z00112233 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
712 :let byte = myblob[0] " get the first byte: 0x00 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
713 :let byte = myblob[2] " get the third byte: 0x22 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
714 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
715 A negative index is counted from the end. Index -1 refers to the last byte in |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
716 the Blob, -2 to the last but one byte, etc. > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
717 :let last = myblob[-1] " get the last byte: 0x33 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
718 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
719 To avoid an error for an invalid index use the |get()| function. When an item |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
720 is not available it returns -1 or the default value you specify: > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
721 :echo get(myblob, idx) |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
722 :echo get(myblob, idx, 999) |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
723 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
724 |
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
725 Blob iteration ~ |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
726 |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
727 The |:for| loop executes commands for each byte of a Blob. The loop variable is |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
728 set to each byte in the Blob. Example: > |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
729 :for byte in 0z112233 |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
730 : call Doit(byte) |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
731 :endfor |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
732 This calls Doit() with 0x11, 0x22 and 0x33. |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
733 |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
734 |
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
735 Blob concatenation ~ |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
736 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
737 Two blobs can be concatenated with the "+" operator: > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
738 :let longblob = myblob + 0z4455 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
739 :let myblob += 0z6677 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
740 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
741 To change a blob in-place see |blob-modification| below. |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
742 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
743 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
744 Part of a blob ~ |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
745 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
746 A part of the Blob can be obtained by specifying the first and last index, |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
747 separated by a colon in square brackets: > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
748 :let myblob = 0z00112233 |
15512 | 749 :let shortblob = myblob[1:2] " get 0z1122 |
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
750 :let shortblob = myblob[2:-1] " get 0z2233 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
751 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
752 Omitting the first index is similar to zero. Omitting the last index is |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
753 similar to -1. > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
754 :let endblob = myblob[2:] " from item 2 to the end: 0z2233 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
755 :let shortblob = myblob[2:2] " Blob with one byte: 0z22 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
756 :let otherblob = myblob[:] " make a copy of the Blob |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
757 |
15512 | 758 If the first index is beyond the last byte of the Blob or the second index is |
15725
a3e2e7948ee4
patch 8.1.0870: Vim doesn't use the new ConPTY support in Windows 10
Bram Moolenaar <Bram@vim.org>
parents:
15711
diff
changeset
|
759 before the first index, the result is an empty Blob. There is no error |
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
760 message. |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
761 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
762 If the second index is equal to or greater than the length of the list the |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
763 length minus one is used: > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
764 :echo myblob[2:8] " result: 0z2233 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
765 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
766 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
767 Blob modification ~ |
27537 | 768 *blob-modification* *E1182* *E1184* |
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
769 To change a specific byte of a blob use |:let| this way: > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
770 :let blob[4] = 0x44 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
771 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
772 When the index is just one beyond the end of the Blob, it is appended. Any |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
773 higher index is an error. |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
774 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
775 To change a sequence of bytes the [:] notation can be used: > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
776 let blob[1:3] = 0z445566 |
15512 | 777 The length of the replaced bytes must be exactly the same as the value |
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
778 provided. *E972* |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
779 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
780 To change part of a blob you can specify the first and last byte to be |
15512 | 781 modified. The value must have the same number of bytes in the range: > |
782 :let blob[3:5] = 0z334455 | |
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
783 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
784 You can also use the functions |add()|, |remove()| and |insert()|. |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
785 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
786 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
787 Blob identity ~ |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
788 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
789 Blobs can be compared for equality: > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
790 if blob == 0z001122 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
791 And for equal identity: > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
792 if blob is otherblob |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
793 < *blob-identity* *E977* |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
794 When variable "aa" is a Blob and you assign it to another variable "bb", both |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
795 variables refer to the same Blob. Then the "is" operator returns true. |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
796 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
797 When making a copy using [:] or |copy()| the values are the same, but the |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
798 identity is different: > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
799 :let blob = 0z112233 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
800 :let blob2 = blob |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
801 :echo blob == blob2 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
802 < 1 > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
803 :echo blob is blob2 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
804 < 1 > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
805 :let blob3 = blob[:] |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
806 :echo blob == blob3 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
807 < 1 > |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
808 :echo blob is blob3 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
809 < 0 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
810 |
15512 | 811 Making a copy of a Blob is done with the |copy()| function. Using [:] also |
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
812 works, as explained above. |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
813 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
814 |
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
815 1.6 More about variables ~ |
85 | 816 *more-variables* |
7 | 817 If you need to know the type of a variable or expression, use the |type()| |
818 function. | |
819 | |
820 When the '!' flag is included in the 'viminfo' option, global variables that | |
821 start with an uppercase letter, and don't contain a lowercase letter, are | |
822 stored in the viminfo file |viminfo-file|. | |
823 | |
824 When the 'sessionoptions' option contains "global", global variables that | |
825 start with an uppercase letter and contain at least one lowercase letter are | |
826 stored in the session file |session-file|. | |
827 | |
828 variable name can be stored where ~ | |
829 my_var_6 not | |
830 My_Var_6 session file | |
831 MY_VAR_6 viminfo file | |
832 | |
833 | |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
834 In legacy script it is possible to form a variable name with curly braces, see |
7 | 835 |curly-braces-names|. |
836 | |
837 ============================================================================== | |
838 2. Expression syntax *expression-syntax* | |
27459 | 839 *E1143* |
7 | 840 Expression syntax summary, from least to most significant: |
841 | |
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
842 |expr1| expr2 |
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
843 expr2 ? expr1 : expr1 if-then-else |
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
844 |
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
845 |expr2| expr3 |
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
846 expr3 || expr3 ... logical OR |
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
847 |
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
848 |expr3| expr4 |
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
849 expr4 && expr4 ... logical AND |
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
850 |
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
851 |expr4| expr5 |
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
852 expr5 == expr5 equal |
7 | 853 expr5 != expr5 not equal |
854 expr5 > expr5 greater than | |
855 expr5 >= expr5 greater than or equal | |
856 expr5 < expr5 smaller than | |
857 expr5 <= expr5 smaller than or equal | |
858 expr5 =~ expr5 regexp matches | |
859 expr5 !~ expr5 regexp doesn't match | |
860 | |
861 expr5 ==? expr5 equal, ignoring case | |
862 expr5 ==# expr5 equal, match case | |
863 etc. As above, append ? for ignoring case, # for | |
864 matching case | |
865 | |
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
866 expr5 is expr5 same |List|, |Dictionary| or |Blob| instance |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
867 expr5 isnot expr5 different |List|, |Dictionary| or |Blob| |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
868 instance |
79 | 869 |
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
870 |expr5| expr6 |
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
871 expr6 + expr6 ... number addition, list or blob concatenation |
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
872 expr6 - expr6 ... number subtraction |
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
873 expr6 . expr6 ... string concatenation |
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
874 expr6 .. expr6 ... string concatenation |
7 | 875 |
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
876 |expr6| expr7 |
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
877 expr7 * expr7 ... number multiplication |
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
878 expr7 / expr7 ... number division |
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
879 expr7 % expr7 ... number modulo |
7 | 880 |
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
881 |expr7| expr8 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
882 <type>expr8 type check and conversion (|Vim9| only) |
102 | 883 |
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
884 |expr8| expr9 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
885 ! expr8 logical NOT |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
886 - expr8 unary minus |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
887 + expr8 unary plus |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
888 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
889 |expr9| expr10 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
890 expr9[expr1] byte of a String or item of a |List| |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
891 expr9[expr1 : expr1] substring of a String or sublist of a |List| |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
892 expr9.name entry in a |Dictionary| |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
893 expr9(expr1, ...) function call with |Funcref| variable |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
894 expr9->name(expr1, ...) |method| call |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
895 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
896 |expr10| number number constant |
26 | 897 "string" string constant, backslash is special |
99 | 898 'string' string constant, ' is doubled |
685 | 899 [expr1, ...] |List| |
900 {expr1: expr1, ...} |Dictionary| | |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
901 #{key: expr1, ...} legacy |Dictionary| |
7 | 902 &option option value |
903 (expr1) nested expression | |
904 variable internal variable | |
905 va{ria}ble internal variable with curly braces | |
906 $VAR environment variable | |
907 @r contents of register 'r' | |
908 function(expr1, ...) function call | |
909 func{ti}on(expr1, ...) function call with curly braces | |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
910 {args -> expr1} legacy lambda expression |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
911 (args) => expr1 Vim9 lambda expression |
7 | 912 |
913 | |
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
914 "..." indicates that the operations in this level can be concatenated. |
7 | 915 Example: > |
916 &nu || &list && &shell == "csh" | |
917 | |
918 All expressions within one level are parsed from left to right. | |
919 | |
27459 | 920 Expression nesting is limited to 1000 levels deep (300 when build with MSVC) |
921 to avoid running out of stack and crashing. *E1169* | |
922 | |
7 | 923 |
27903 | 924 expr1 *expr1* *ternary* *falsy-operator* *??* *E109* |
7 | 925 ----- |
926 | |
27903 | 927 The ternary operator: expr2 ? expr1 : expr1 |
22492
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
928 The falsy operator: expr2 ?? expr1 |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
929 |
27903 | 930 Ternary operator ~ |
7 | 931 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
932 In legacy script the expression before the '?' is evaluated to a number. If |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
933 it evaluates to |TRUE|, the result is the value of the expression between the |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
934 '?' and ':', otherwise the result is the value of the expression after the |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
935 ':'. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
936 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
937 In |Vim9| script the first expression must evaluate to a boolean, see |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
938 |vim9-boolean|. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
939 |
7 | 940 Example: > |
941 :echo lnum == 1 ? "top" : lnum | |
942 | |
943 Since the first expression is an "expr2", it cannot contain another ?:. The | |
944 other two expressions can, thus allow for recursive use of ?:. | |
945 Example: > | |
946 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum | |
947 | |
948 To keep this readable, using |line-continuation| is suggested: > | |
949 :echo lnum == 1 | |
950 :\ ? "top" | |
951 :\ : lnum == 1000 | |
952 :\ ? "last" | |
953 :\ : lnum | |
954 | |
1156 | 955 You should always put a space before the ':', otherwise it can be mistaken for |
956 use in a variable such as "a:1". | |
957 | |
22492
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
958 Falsy operator ~ |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
959 |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
960 This is also known as the "null coalescing operator", but that's too |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
961 complicated, thus we just call it the falsy operator. |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
962 |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
963 The expression before the '??' is evaluated. If it evaluates to |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
964 |truthy|, this is used as the result. Otherwise the expression after the '??' |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
965 is evaluated and used as the result. This is most useful to have a default |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
966 value for an expression that may result in zero or empty: > |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
967 echo theList ?? 'list is empty' |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
968 echo GetName() ?? 'unknown' |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
969 |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
970 These are similar, but not equal: > |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
971 expr2 ?? expr1 |
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
972 expr2 ? expr2 : expr1 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
973 In the second line "expr2" is evaluated twice. And in |Vim9| script the type |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
974 of expr2 before "?" must be a boolean. |
22492
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
975 |
7 | 976 |
977 expr2 and expr3 *expr2* *expr3* | |
978 --------------- | |
979 | |
10038
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
980 expr3 || expr3 .. logical OR *expr-barbar* |
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
981 expr4 && expr4 .. logical AND *expr-&&* |
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
982 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
983 The "||" and "&&" operators take one argument on each side. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
984 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
985 In legacy script the arguments are (converted to) Numbers. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
986 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
987 In |Vim9| script the values must be boolean, see |vim9-boolean|. Use "!!" to |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
988 convert any type to a boolean. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
989 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
990 The result is: |
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
991 input output ~ |
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
992 n1 n2 n1 || n2 n1 && n2 ~ |
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
993 |FALSE| |FALSE| |FALSE| |FALSE| |
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
994 |FALSE| |TRUE| |TRUE| |FALSE| |
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
995 |TRUE| |FALSE| |TRUE| |FALSE| |
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
996 |TRUE| |TRUE| |TRUE| |TRUE| |
7 | 997 |
998 The operators can be concatenated, for example: > | |
999 | |
1000 &nu || &list && &shell == "csh" | |
1001 | |
1002 Note that "&&" takes precedence over "||", so this has the meaning of: > | |
1003 | |
1004 &nu || (&list && &shell == "csh") | |
1005 | |
1006 Once the result is known, the expression "short-circuits", that is, further | |
1007 arguments are not evaluated. This is like what happens in C. For example: > | |
1008 | |
1009 let a = 1 | |
1010 echo a || b | |
1011 | |
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
1012 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
|
1013 so the result must be |TRUE|. Similarly below: > |
7 | 1014 |
1015 echo exists("b") && b == "yes" | |
1016 | |
1017 This is valid whether "b" has been defined or not. The second clause will | |
1018 only be evaluated if "b" has been defined. | |
1019 | |
1020 | |
27537 | 1021 expr4 *expr4* *E1153* |
7 | 1022 ----- |
1023 | |
1024 expr5 {cmp} expr5 | |
1025 | |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1026 Compare two expr5 expressions. In legacy script the result is a 0 if it |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1027 evaluates to false, or 1 if it evaluates to true. In |Vim9| script the result |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1028 is |true| or |false|. |
7 | 1029 |
1621 | 1030 *expr-==* *expr-!=* *expr->* *expr->=* |
7 | 1031 *expr-<* *expr-<=* *expr-=~* *expr-!~* |
1032 *expr-==#* *expr-!=#* *expr->#* *expr->=#* | |
1033 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#* | |
1034 *expr-==?* *expr-!=?* *expr->?* *expr->=?* | |
1035 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?* | |
2908 | 1036 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#* |
27321 | 1037 *expr-is?* *expr-isnot?* *E1072* |
7 | 1038 use 'ignorecase' match case ignore case ~ |
1039 equal == ==# ==? | |
1040 not equal != !=# !=? | |
1041 greater than > ># >? | |
1042 greater than or equal >= >=# >=? | |
1043 smaller than < <# <? | |
1044 smaller than or equal <= <=# <=? | |
1045 regexp matches =~ =~# =~? | |
1046 regexp doesn't match !~ !~# !~? | |
2908 | 1047 same instance is is# is? |
1048 different instance isnot isnot# isnot? | |
7 | 1049 |
1050 Examples: | |
1051 "abc" ==# "Abc" evaluates to 0 | |
1052 "abc" ==? "Abc" evaluates to 1 | |
1053 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise | |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1054 NOTE: In |Vim9| script 'ignorecase' is not used. |
7 | 1055 |
85 | 1056 *E691* *E692* |
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
1057 A |List| can only be compared with a |List| and only "equal", "not equal", |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
1058 "is" and "isnot" can be used. This compares the values of the list, |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
1059 recursively. Ignoring case means case is ignored when comparing item values. |
79 | 1060 |
114 | 1061 *E735* *E736* |
685 | 1062 A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not |
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
1063 equal", "is" and "isnot" can be used. This compares the key/values of the |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
1064 |Dictionary| recursively. Ignoring case means case is ignored when comparing |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
1065 item values. |
114 | 1066 |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
1067 *E694* |
9407
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
1068 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
|
1069 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
|
1070 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
|
1071 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
|
1072 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
|
1073 |
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
1074 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
|
1075 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
|
1076 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
|
1077 " Part1 and Part2 refer to the same function |
27321 | 1078 < *E1037* |
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1079 Using "is" or "isnot" with a |List|, |Dictionary| or |Blob| checks whether |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1080 the expressions are referring to the same |List|, |Dictionary| or |Blob| |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1081 instance. A copy of a |List| is different from the original |List|. When |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1082 using "is" without a |List|, |Dictionary| or |Blob|, it is equivalent to |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1083 using "equal", using "isnot" equivalent to using "not equal". Except that |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1084 a different type means the values are different: > |
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1085 echo 4 == '4' |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1086 1 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1087 echo 4 is '4' |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1088 0 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1089 echo 0 is [] |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1090 0 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1091 "is#"/"isnot#" and "is?"/"isnot?" can be used to match and ignore case. |
79 | 1092 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1093 In legacy script, when comparing a String with a Number, the String is |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1094 converted to a Number, and the comparison is done on Numbers. This means |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1095 that: > |
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1096 echo 0 == 'x' |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1097 1 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1098 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
|
1099 echo [0] == ['x'] |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1100 0 |
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1101 Inside a List or Dictionary this conversion is not used. |
7 | 1102 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1103 In |Vim9| script the types must match. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1104 |
7 | 1105 When comparing two Strings, this is done with strcmp() or stricmp(). This |
1106 results in the mathematical difference (comparing byte values), not | |
1107 necessarily the alphabetical difference in the local language. | |
1108 | |
1621 | 1109 When using the operators with a trailing '#', or the short version and |
1156 | 1110 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
7 | 1111 |
1112 When using the operators with a trailing '?', or the short version and | |
1156 | 1113 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
1114 | |
1115 'smartcase' is not used. | |
7 | 1116 |
1117 The "=~" and "!~" operators match the lefthand argument with the righthand | |
1118 argument, which is used as a pattern. See |pattern| for what a pattern is. | |
1119 This matching is always done like 'magic' was set and 'cpoptions' is empty, no | |
1120 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts | |
1121 portable. To avoid backslashes in the regexp pattern to be doubled, use a | |
1122 single-quote string, see |literal-string|. | |
1123 Since a string is considered to be a single line, a multi-line pattern | |
1124 (containing \n, backslash-n) will not match. However, a literal NL character | |
1125 can be matched like an ordinary character. Examples: | |
1126 "foo\nbar" =~ "\n" evaluates to 1 | |
1127 "foo\nbar" =~ "\\n" evaluates to 0 | |
1128 | |
1129 | |
27321 | 1130 expr5 and expr6 *expr5* *expr6* *E1036* *E1051* |
7 | 1131 --------------- |
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1132 expr6 + expr6 Number addition, |List| or |Blob| concatenation *expr-+* |
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1133 expr6 - expr6 Number subtraction *expr--* |
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1134 expr6 . expr6 String concatenation *expr-.* |
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1135 expr6 .. expr6 String concatenation *expr-..* |
79 | 1136 |
692 | 1137 For |Lists| only "+" is possible and then both expr6 must be a list. The |
685 | 1138 result is a new list with the two lists Concatenated. |
79 | 1139 |
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1140 For String concatenation ".." is preferred, since "." is ambiguous, it is also |
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1141 used for |Dict| member access and floating point numbers. |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1142 In |Vim9| script and when |vimscript-version| is 2 or higher, using "." is not |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1143 allowed. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1144 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1145 In |Vim9| script the arguments of ".." are converted to String for simple |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1146 types: Number, Float, Special and Bool. For other types |string()| should be |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1147 used. |
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1148 |
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1149 expr7 * expr7 Number multiplication *expr-star* |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1150 expr7 / expr7 Number division *expr-/* |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1151 expr7 % expr7 Number modulo *expr-%* |
7 | 1152 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1153 In legacy script, for all operators except "." and "..", Strings are converted |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1154 to Numbers. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1155 |
3214 | 1156 For bitwise operators see |and()|, |or()| and |xor()|. |
7 | 1157 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1158 Note the difference between "+" and ".." in legacy script: |
7 | 1159 "123" + "456" = 579 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1160 "123" .. "456" = "123456" |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1161 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1162 Since '..' has the same precedence as '+' and '-', you need to read: > |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1163 1 .. 90 + 90.0 |
1621 | 1164 As: > |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1165 (1 .. 90) + 90.0 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1166 That works in legacy script, since the String "190" is automatically converted |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1167 to the Number 190, which can be added to the Float 90.0. However: > |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1168 1 .. 90 * 90.0 |
1621 | 1169 Should be read as: > |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1170 1 .. (90 * 90.0) |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1171 Since '..' has lower precedence than '*'. This does NOT work, since this |
1621 | 1172 attempts to concatenate a Float and a String. |
1173 | |
1174 When dividing a Number by zero the result depends on the value: | |
1175 0 / 0 = -0x80000000 (like NaN for Float) | |
1176 >0 / 0 = 0x7fffffff (like positive infinity) | |
1177 <0 / 0 = -0x7fffffff (like negative infinity) | |
1178 (before Vim 7.2 it was always 0x7fffffff) | |
27537 | 1179 In |Vim9| script dividing a number by zero is an error. *E1154* |
1621 | 1180 |
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1181 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
|
1182 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
|
1183 >0 / 0 = 0x7fffffffffffffff (like positive infinity) |
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1184 <0 / 0 = -0x7fffffffffffffff (like negative infinity) |
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1185 |
7 | 1186 When the righthand side of '%' is zero, the result is 0. |
1187 | |
685 | 1188 None of these work for |Funcref|s. |
79 | 1189 |
27321 | 1190 ".", ".." and "%" do not work for Float. *E804* *E1035* |
1621 | 1191 |
7 | 1192 |
1193 expr7 *expr7* | |
1194 ----- | |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1195 <type>expr8 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1196 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1197 This is only available in |Vim9| script, see |type-casting|. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1198 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1199 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1200 expr8 *expr8* |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1201 ----- |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1202 ! expr8 logical NOT *expr-!* |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1203 - expr8 unary minus *expr-unary--* |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1204 + expr8 unary plus *expr-unary-+* |
7 | 1205 |
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
1206 For '!' |TRUE| becomes |FALSE|, |FALSE| becomes |TRUE| (one). |
7 | 1207 For '-' the sign of the number is changed. |
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
1208 For '+' the number is unchanged. Note: "++" has no effect. |
7 | 1209 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1210 In legacy script a String will be converted to a Number first. Note that if |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1211 the string does not start with a digit you likely don't get what you expect. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1212 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1213 In |Vim9| script an error is given when "-" or "+" is used and the type is not |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1214 a number. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1215 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1216 In |Vim9| script "!" can be used for any type and the result is always a |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1217 boolean. Use "!!" to convert any type to a boolean, according to whether the |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1218 value is |falsy|. |
7 | 1219 |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1220 These three can be repeated and mixed. Examples: |
7 | 1221 !-1 == 0 |
1222 !!8 == 1 | |
1223 --9 == 9 | |
1224 | |
1225 | |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1226 expr9 *expr9* |
7 | 1227 ----- |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1228 This expression is either |expr10| or a sequence of the alternatives below, |
14637 | 1229 in any order. E.g., these are all possible: |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1230 expr9[expr1].name |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1231 expr9.name[expr1] |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1232 expr9(expr1, ...)[expr1].name |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1233 expr9->(expr1, ...)[expr1] |
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
1234 Evaluation is always from left to right. |
14637 | 1235 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1236 expr9[expr1] item of String or |List| *expr-[]* *E111* |
27321 | 1237 *E909* *subscript* *E1062* |
21823
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1238 In legacy Vim script: |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1239 If expr9 is a Number or String this results in a String that contains the |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1240 expr1'th single byte from expr9. expr9 is used as a String (a number is |
21823
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1241 automatically converted to a String), expr1 as a Number. This doesn't |
21991 | 1242 recognize multibyte encodings, see `byteidx()` for an alternative, or use |
21823
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1243 `split()` to turn the string into a list of characters. Example, to get the |
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1244 byte under the cursor: > |
823 | 1245 :let c = getline(".")[col(".") - 1] |
7 | 1246 |
27537 | 1247 In |Vim9| script: *E1147* *E1148* |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1248 If expr9 is a String this results in a String that contains the expr1'th |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1249 single character (including any composing characters) from expr9. To use byte |
24132
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
1250 indexes use |strpart()|. |
21823
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1251 |
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1252 Index zero gives the first byte or character. Careful: text column numbers |
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1253 start with one! |
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1254 |
7 | 1255 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
|
1256 String. A negative index always results in an empty string (reason: backward |
21823
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1257 compatibility). Use [-1:] to get the last byte or character. |
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
1258 In Vim9 script a negative index is used like with a list: count from the end. |
55 | 1259 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1260 If expr9 is a |List| then it results the item at index expr1. See |list-index| |
55 | 1261 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
|
1262 error. Example: > |
55 | 1263 :let item = mylist[-1] " get last item |
1264 | |
685 | 1265 Generally, if a |List| index is equal to or higher than the length of the |
1266 |List|, or more negative than the length of the |List|, this results in an | |
1267 error. | |
55 | 1268 |
99 | 1269 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1270 expr9[expr1a : expr1b] substring or sublist *expr-[:]* |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1271 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1272 If expr9 is a String this results in the substring with the bytes or |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1273 characters from expr1a to and including expr1b. expr9 is used as a String, |
21991 | 1274 expr1a and expr1b are used as a Number. |
21823
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1275 |
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1276 In legacy Vim script the indexes are byte indexes. This doesn't recognize |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1277 multibyte encodings, see |byteidx()| for computing the indexes. If expr9 is |
21823
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1278 a Number it is first converted to a String. |
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1279 |
24132
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
1280 In Vim9 script the indexes are character indexes and include composing |
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
1281 characters. To use byte indexes use |strpart()|. To use character indexes |
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
1282 without including composing characters use |strcharpart()|. |
55 | 1283 |
23604
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
1284 The item at index expr1b is included, it is inclusive. For an exclusive index |
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
1285 use the |slice()| function. |
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
1286 |
55 | 1287 If expr1a is omitted zero is used. If expr1b is omitted the length of the |
1288 string minus one is used. | |
1289 | |
1290 A negative number can be used to measure from the end of the string. -1 is | |
1291 the last character, -2 the last but one, etc. | |
1292 | |
1293 If an index goes out of range for the string characters are omitted. If | |
1294 expr1b is smaller than expr1a the result is an empty string. | |
1295 | |
1296 Examples: > | |
1297 :let c = name[-1:] " last byte of a string | |
21991 | 1298 :let c = name[0:-1] " the whole string |
55 | 1299 :let c = name[-2:-2] " last but one byte of a string |
1300 :let s = line(".")[4:] " from the fifth byte to the end | |
1301 :let s = s[:-3] " remove last two bytes | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1302 < |
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
1303 *slice* |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1304 If expr9 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
|
1305 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
|
1306 just above. Also see |sublist| below. Examples: > |
55 | 1307 :let l = mylist[:3] " first four items |
1308 :let l = mylist[4:4] " List with one item | |
1309 :let l = mylist[:] " shallow copy of a List | |
1310 | |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1311 If expr9 is a |Blob| this results in a new |Blob| with the bytes in the |
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1312 indexes expr1a and expr1b, inclusive. Examples: > |
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1313 :let b = 0zDEADBEEF |
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1314 :let bs = b[1:2] " 0zADBE |
15512 | 1315 :let bs = b[:] " copy of 0zDEADBEEF |
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1316 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1317 Using expr9[expr1] or expr9[expr1a : expr1b] on a |Funcref| results in an |
685 | 1318 error. |
1319 | |
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1320 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
|
1321 for a sublist: > |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1322 mylist[n:] " uses variable n |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1323 mylist[s:] " uses namespace s:, error! |
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1324 |
685 | 1325 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1326 expr9.name entry in a |Dictionary| *expr-entry* |
27537 | 1327 *E1203* *E1229* |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1328 If expr9 is a |Dictionary| and it is followed by a dot, then the following |
685 | 1329 name will be used as a key in the |Dictionary|. This is just like: |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1330 expr9[name]. |
99 | 1331 |
1332 The name must consist of alphanumeric characters, just like a variable name, | |
1333 but it may start with a number. Curly braces cannot be used. | |
1334 | |
1335 There must not be white space before or after the dot. | |
1336 | |
1337 Examples: > | |
1338 :let dict = {"one": 1, 2: "two"} | |
16808 | 1339 :echo dict.one " shows "1" |
1340 :echo dict.2 " shows "two" | |
1341 :echo dict .2 " error because of space before the dot | |
99 | 1342 |
1343 Note that the dot is also used for String concatenation. To avoid confusion | |
1344 always put spaces around the dot for String concatenation. | |
1345 | |
1346 | |
27459 | 1347 expr9(expr1, ...) |Funcref| function call *E1085* |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1348 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1349 When expr9 is a |Funcref| type variable, invoke the function it refers to. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1350 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1351 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1352 expr9->name([args]) method call *method* *->* |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1353 expr9->{lambda}([args]) |
27537 | 1354 *E260* *E276* *E1265* |
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1355 For methods that are also available as global functions this is the same as: > |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1356 name(expr9 [, args]) |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1357 There can also be methods specifically for the type of "expr9". |
102 | 1358 |
17661
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1359 This allows for chaining, passing the value that one method returns to the |
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1360 next method: > |
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1361 mylist->filter(filterexpr)->map(mapexpr)->sort()->join() |
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1362 < |
17674
06c3e15ad84d
patch 8.1.1834: cannot use a lambda as a method
Bram Moolenaar <Bram@vim.org>
parents:
17667
diff
changeset
|
1363 Example of using a lambda: > |
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
1364 GetPercentage()->{x -> x * 100}()->printf('%d%%') |
17758 | 1365 < |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1366 When using -> the |expr8| operators will be applied first, thus: > |
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1367 -1.234->string() |
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1368 Is equivalent to: > |
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1369 (-1.234)->string() |
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1370 And NOT: > |
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1371 -(1.234->string()) |
27321 | 1372 |
1373 What comes after "->" can be a name, a simple expression (not containing any | |
27804 | 1374 parenthesis), or any expression in parentheses: > |
27321 | 1375 base->name(args) |
1376 base->some.name(args) | |
1377 base->alist[idx](args) | |
1378 base->(getFuncRef())(args) | |
1379 Note that in the last call the base is passed to the function resulting from | |
1380 "(getFuncRef())", inserted before "args". | |
1381 | |
17661
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1382 *E274* |
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1383 "->name(" must not contain white space. There can be white space before the |
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1384 "->" and after the "(", thus you can split the lines like this: > |
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1385 mylist |
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1386 \ ->filter(filterexpr) |
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1387 \ ->map(mapexpr) |
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1388 \ ->sort() |
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1389 \ ->join() |
17758 | 1390 |
1391 When using the lambda form there must be no white space between the } and the | |
1392 (. | |
1393 | |
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1394 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1395 *expr10* |
7 | 1396 number |
1397 ------ | |
12785 | 1398 number number constant *expr-number* |
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
1399 |
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
1400 *0x* *hex-number* *0o* *octal-number* *binary-number* |
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1401 Decimal, Hexadecimal (starting with 0x or 0X), Binary (starting with 0b or 0B) |
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
1402 and Octal (starting with 0, 0o or 0O). |
7 | 1403 |
1621 | 1404 *floating-point-format* |
1405 Floating point numbers can be written in two forms: | |
1406 | |
1407 [-+]{N}.{M} | |
6530 | 1408 [-+]{N}.{M}[eE][-+]{exp} |
1621 | 1409 |
1410 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
25619 | 1411 contain digits, except that in |Vim9| script in {N} single quotes between |
1412 digits are ignored. | |
1621 | 1413 [-+] means there is an optional plus or minus sign. |
1414 {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
|
1415 Only a decimal point is accepted, not a comma. No matter what the current |
1621 | 1416 locale is. |
1417 {only when compiled with the |+float| feature} | |
1418 | |
1419 Examples: | |
1420 123.456 | |
1421 +0.0001 | |
1422 55.0 | |
1423 -0.123 | |
1424 1.234e03 | |
1425 1.0E-6 | |
1426 -3.1416e+88 | |
1427 | |
1428 These are INVALID: | |
1429 3. empty {M} | |
1430 1e40 missing .{M} | |
1431 | |
1432 Rationale: | |
1433 Before floating point was introduced, the text "123.456" was interpreted as | |
1434 the two numbers "123" and "456", both converted to a string and concatenated, | |
1435 resulting in the string "123456". Since this was considered pointless, and we | |
1698 | 1436 could not find it intentionally being used in Vim scripts, this backwards |
1621 | 1437 incompatibility was accepted in favor of being able to use the normal notation |
1438 for floating point numbers. | |
1439 | |
15131 | 1440 *float-pi* *float-e* |
1441 A few useful values to copy&paste: > | |
1442 :let pi = 3.14159265359 | |
1443 :let e = 2.71828182846 | |
1444 Or, if you don't want to write them in as floating-point literals, you can | |
1445 also use functions, like the following: > | |
1446 :let pi = acos(-1.0) | |
1447 :let e = exp(1.0) | |
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
1448 < |
1621 | 1449 *floating-point-precision* |
1450 The precision and range of floating points numbers depends on what "double" | |
1451 means in the library Vim was compiled with. There is no way to change this at | |
1452 runtime. | |
1453 | |
1454 The default for displaying a |Float| is to use 6 decimal places, like using | |
1455 printf("%g", f). You can select something else when using the |printf()| | |
1456 function. Example: > | |
1457 :echo printf('%.15e', atan(1)) | |
1458 < 7.853981633974483e-01 | |
1459 | |
1460 | |
7 | 1461 |
6884 | 1462 string *string* *String* *expr-string* *E114* |
7 | 1463 ------ |
1464 "string" string constant *expr-quote* | |
1465 | |
1466 Note that double quotes are used. | |
1467 | |
1468 A string constant accepts these special characters: | |
1469 \... three-digit octal number (e.g., "\316") | |
1470 \.. two-digit octal number (must be followed by non-digit) | |
1471 \. one-digit octal number (must be followed by non-digit) | |
1472 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
1473 \x. byte specified with one hex number (must be followed by non-hex char) | |
1474 \X.. same as \x.. | |
1475 \X. same as \x. | |
1621 | 1476 \u.... character specified with up to 4 hex numbers, stored according to the |
7 | 1477 current value of 'encoding' (e.g., "\u02a4") |
6840 | 1478 \U.... same as \u but allows up to 8 hex numbers. |
7 | 1479 \b backspace <BS> |
1480 \e escape <Esc> | |
25880 | 1481 \f formfeed 0x0C |
7 | 1482 \n newline <NL> |
1483 \r return <CR> | |
1484 \t tab <Tab> | |
1485 \\ backslash | |
1486 \" double quote | |
2152 | 1487 \<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
|
1488 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
|
1489 To use the double quote character it must be escaped: "<M-\">". |
25880 | 1490 Don't use <Char-xxxx> to get a UTF-8 character, use \uxxxx as |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1491 mentioned above. |
20627
8bce783af0cb
patch 8.2.0867: using {xxx} for encoding a modifier is not nice
Bram Moolenaar <Bram@vim.org>
parents:
20615
diff
changeset
|
1492 \<*xxx> Like \<xxx> but prepends a modifier instead of including it in the |
8bce783af0cb
patch 8.2.0867: using {xxx} for encoding a modifier is not nice
Bram Moolenaar <Bram@vim.org>
parents:
20615
diff
changeset
|
1493 character. E.g. "\<C-w>" is one character 0x17 while "\<*C-w>" is four |
20603
c2570baa2e4c
patch 8.2.0855: GUI tests fail because the test doesn't use a modifier
Bram Moolenaar <Bram@vim.org>
parents:
20593
diff
changeset
|
1494 bytes: 3 for the CTRL modifier and then character "W". |
7 | 1495 |
1156 | 1496 Note that "\xff" is stored as the byte 255, which may be invalid in some |
1497 encodings. Use "\u00ff" to store character 255 according to the current value | |
1498 of 'encoding'. | |
1499 | |
7 | 1500 Note that "\000" and "\x00" force the end of the string. |
1501 | |
1502 | |
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
1503 blob-literal *blob-literal* *E973* |
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1504 ------------ |
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1505 |
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1506 Hexadecimal starting with 0z or 0Z, with an arbitrary number of bytes. |
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1507 The sequence must be an even number of hex characters. Example: > |
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1508 :let b = 0zFF00ED015DAF |
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1509 |
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1510 |
7 | 1511 literal-string *literal-string* *E115* |
1512 --------------- | |
26 | 1513 'string' string constant *expr-'* |
7 | 1514 |
1515 Note that single quotes are used. | |
1516 | |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1517 This string is taken as it is. No backslashes are removed or have a special |
99 | 1518 meaning. The only exception is that two quotes stand for one quote. |
26 | 1519 |
1520 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
|
1521 to be doubled. These two commands are equivalent: > |
26 | 1522 if a =~ "\\s*" |
1523 if a =~ '\s*' | |
7 | 1524 |
1525 | |
1526 option *expr-option* *E112* *E113* | |
1527 ------ | |
1528 &option option value, local value if possible | |
1529 &g:option global option value | |
1530 &l:option local option value | |
1531 | |
1532 Examples: > | |
27903 | 1533 echo "tabstop is " .. &tabstop |
7 | 1534 if &insertmode |
1535 | |
1536 Any option name can be used here. See |options|. When using the local value | |
1537 and there is no buffer-local or window-local value, the global value is used | |
1538 anyway. | |
1539 | |
1540 | |
1156 | 1541 register *expr-register* *@r* |
7 | 1542 -------- |
1543 @r contents of register 'r' | |
1544 | |
1545 The result is the contents of the named register, as a single string. | |
1546 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
|
1547 register use @" or @@. See |registers| for an explanation of the available |
336 | 1548 registers. |
1549 | |
1550 When using the '=' register you get the expression itself, not what it | |
1551 evaluates to. Use |eval()| to evaluate it. | |
7 | 1552 |
1553 | |
27537 | 1554 nesting *expr-nesting* *E110* |
7 | 1555 ------- |
1556 (expr1) nested expression | |
1557 | |
1558 | |
1559 environment variable *expr-env* | |
1560 -------------------- | |
1561 $VAR environment variable | |
1562 | |
1563 The String value of any environment variable. When it is not defined, the | |
1564 result is an empty string. | |
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1565 |
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1566 The functions `getenv()` and `setenv()` can also be used and work for |
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1567 environment variables with non-alphanumeric names. |
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1568 The function `environ()` can be used to get a Dict with all environment |
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1569 variables. |
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1570 |
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1571 |
7 | 1572 *expr-env-expand* |
1573 Note that there is a difference between using $VAR directly and using | |
1574 expand("$VAR"). Using it directly will only expand environment variables that | |
1575 are known inside the current Vim session. Using expand() will first try using | |
1576 the environment variables known inside the current Vim session. If that | |
1577 fails, a shell will be used to expand the variable. This can be slow, but it | |
1578 does expand all variables that the shell knows about. Example: > | |
6180 | 1579 :echo $shell |
1580 :echo expand("$shell") | |
1581 The first one probably doesn't echo anything, the second echoes the $shell | |
7 | 1582 variable (if your shell supports it). |
1583 | |
1584 | |
27459 | 1585 internal variable *expr-variable* *E1015* *E1089* |
7 | 1586 ----------------- |
1587 variable internal variable | |
1588 See below |internal-variables|. | |
1589 | |
1590 | |
170 | 1591 function call *expr-function* *E116* *E118* *E119* *E120* |
7 | 1592 ------------- |
1593 function(expr1, ...) function call | |
1594 See below |functions|. | |
1595 | |
1596 | |
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1597 lambda expression *expr-lambda* *lambda* |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1598 ----------------- |
27036 | 1599 {args -> expr1} legacy lambda expression *E451* |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1600 (args) => expr1 |Vim9| lambda expression |
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1601 |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1602 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
|
1603 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
|
1604 the following ways: |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1605 |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1606 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
|
1607 commands. |
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1608 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
|
1609 :let F = {arg1, arg2 -> arg1 - arg2} |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1610 :echo F(5, 2) |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1611 < 3 |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1612 |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1613 The arguments are optional. Example: > |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1614 :let F = {-> 'error function'} |
24387 | 1615 :echo F('ignored') |
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1616 < error function |
24387 | 1617 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1618 The |Vim9| lambda does not only use a different syntax, it also adds type |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1619 checking and can be split over multiple lines, see |vim9-lambda|. |
24387 | 1620 |
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1621 *closure* |
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1622 Lambda expressions can access outer scope variables and arguments. This is |
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
1623 often called a closure. Example where "i" and "a:arg" are used in a lambda |
13329
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1624 while they already exist in the function scope. They remain valid even after |
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1625 the function returns: > |
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1626 :function Foo(arg) |
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1627 : let i = 3 |
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1628 : return {x -> x + i - a:arg} |
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1629 :endfunction |
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1630 :let Bar = Foo(4) |
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1631 :echo Bar(6) |
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1632 < 5 |
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
1633 |
20552 | 1634 Note that the variables must exist in the outer scope before the lambda is |
13329
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1635 defined for this to work. See also |:func-closure|. |
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1636 |
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1637 Lambda and closure support can be checked with: > |
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
1638 if has('lambda') |
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1639 |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1640 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
|
1641 :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
|
1642 < [2, 3, 4] > |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1643 :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
|
1644 < [1, 2, 3, 4, 7] |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1645 |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1646 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
|
1647 :let timer = timer_start(500, |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1648 \ {-> execute("echo 'Handler called'", "")}, |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1649 \ {'repeat': 3}) |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1650 < Handler called |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1651 Handler called |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1652 Handler called |
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1653 |
25161 | 1654 Note that it is possible to cause memory to be used and not freed if the |
1655 closure is referenced by the context it depends on: > | |
1656 function Function() | |
1657 let x = 0 | |
1658 let F = {-> x} | |
1659 endfunction | |
1660 The closure uses "x" from the function scope, and "F" in that same scope | |
1661 refers to the closure. This cycle results in the memory not being freed. | |
1662 Recommendation: don't do this. | |
1663 | |
1664 Notice how execute() is used to execute an Ex command. That's ugly though. | |
24387 | 1665 In Vim9 script you can use a command block, see |inline-function|. |
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1666 |
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1667 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
|
1668 for a lambda expression, you can find what it is with the following command: > |
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
1669 :function <lambda>42 |
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1670 See also: |numbered-function| |
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1671 |
7 | 1672 ============================================================================== |
27321 | 1673 3. Internal variable *internal-variables* *E461* *E1001* |
2596 | 1674 |
7 | 1675 An internal variable name can be made up of letters, digits and '_'. But it |
27036 | 1676 cannot start with a digit. In legacy script it is also possible to use curly |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1677 braces, see |curly-braces-names|. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1678 |
27036 | 1679 In legacy script an internal variable is created with the ":let" command |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1680 |:let|. An internal variable is explicitly destroyed with the ":unlet" |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1681 command |:unlet|. |
87 | 1682 Using a name that is not an internal variable or refers to a variable that has |
1683 been destroyed results in an error. | |
7 | 1684 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1685 In |Vim9| script `:let` is not used and variables work differently, see |:var|. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1686 |
20856 | 1687 *variable-scope* |
7 | 1688 There are several name spaces for variables. Which one is to be used is |
1689 specified by what is prepended: | |
1690 | |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1691 (nothing) In a function: local to the function; |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1692 in a legacy script: global; |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1693 in a |Vim9| script: local to the script |
7 | 1694 |buffer-variable| b: Local to the current buffer. |
1695 |window-variable| w: Local to the current window. | |
819 | 1696 |tabpage-variable| t: Local to the current tab page. |
7 | 1697 |global-variable| g: Global. |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1698 |local-variable| l: Local to a function (only in a legacy function) |
7 | 1699 |script-variable| s: Local to a |:source|'ed Vim script. |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1700 |function-argument| a: Function argument (only in a legacy function). |
5815 | 1701 |vim-variable| v: Global, predefined by Vim. |
7 | 1702 |
685 | 1703 The scope name by itself can be used as a |Dictionary|. For example, to |
1704 delete all script-local variables: > | |
133 | 1705 :for k in keys(s:) |
1706 : unlet s:[k] | |
1707 :endfor | |
20856 | 1708 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1709 Note: in Vim9 script variables can also be local to a block of commands, see |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1710 |vim9-scopes|. |
4358 | 1711 *buffer-variable* *b:var* *b:* |
7 | 1712 A variable name that is preceded with "b:" is local to the current buffer. |
1713 Thus you can have several "b:foo" variables, one for each buffer. | |
1714 This kind of variable is deleted when the buffer is wiped out or deleted with | |
1715 |:bdelete|. | |
1716 | |
1717 One local buffer variable is predefined: | |
4264 | 1718 *b:changedtick* *changetick* |
7 | 1719 b:changedtick The total number of changes to the current buffer. It is |
1720 incremented for each change. An undo command is also a change | |
16996
d5e1e09a829f
patch 8.1.1498: ":write" increments b:changedtick even though nothing changed
Bram Moolenaar <Bram@vim.org>
parents:
16971
diff
changeset
|
1721 in this case. Resetting 'modified' when writing the buffer is |
d5e1e09a829f
patch 8.1.1498: ":write" increments b:changedtick even though nothing changed
Bram Moolenaar <Bram@vim.org>
parents:
16971
diff
changeset
|
1722 also counted. |
d5e1e09a829f
patch 8.1.1498: ":write" increments b:changedtick even though nothing changed
Bram Moolenaar <Bram@vim.org>
parents:
16971
diff
changeset
|
1723 This can be used to perform an action only when the buffer has |
d5e1e09a829f
patch 8.1.1498: ":write" increments b:changedtick even though nothing changed
Bram Moolenaar <Bram@vim.org>
parents:
16971
diff
changeset
|
1724 changed. Example: > |
7 | 1725 :if my_changedtick != b:changedtick |
1621 | 1726 : let my_changedtick = b:changedtick |
1727 : call My_Update() | |
7 | 1728 :endif |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
1729 < You cannot change or delete the b:changedtick variable. |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
1730 |
4358 | 1731 *window-variable* *w:var* *w:* |
7 | 1732 A variable name that is preceded with "w:" is local to the current window. It |
1733 is deleted when the window is closed. | |
1734 | |
4437 | 1735 *tabpage-variable* *t:var* *t:* |
819 | 1736 A variable name that is preceded with "t:" is local to the current tab page, |
1737 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
|
1738 without the |+windows| feature} |
819 | 1739 |
4358 | 1740 *global-variable* *g:var* *g:* |
26847 | 1741 Inside functions and in |Vim9| script global variables are accessed with "g:". |
1742 Omitting this will access a variable local to a function or script. "g:" | |
1743 can also be used in any other place if you like. | |
7 | 1744 |
4358 | 1745 *local-variable* *l:var* *l:* |
7 | 1746 Inside functions local variables are accessed without prepending anything. |
1156 | 1747 But you can also prepend "l:" if you like. However, without prepending "l:" |
1748 you may run into reserved variable names. For example "count". By itself it | |
1749 refers to "v:count". Using "l:count" you can have a local variable with the | |
1750 same name. | |
7 | 1751 |
1752 *script-variable* *s:var* | |
26847 | 1753 In a legacy Vim script variables starting with "s:" can be used. They cannot |
1754 be accessed from outside of the scripts, thus are local to the script. | |
1755 In |Vim9| script the "s:" prefix can be omitted, variables are script-local by | |
1756 default. | |
7 | 1757 |
1758 They can be used in: | |
1759 - commands executed while the script is sourced | |
1760 - functions defined in the script | |
1761 - autocommands defined in the script | |
1762 - functions and autocommands defined in functions and autocommands which were | |
1763 defined in the script (recursively) | |
1764 - user defined commands defined in the script | |
1765 Thus not in: | |
1766 - other scripts sourced from this one | |
1767 - mappings | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1768 - menus |
7 | 1769 - etc. |
1770 | |
1156 | 1771 Script variables can be used to avoid conflicts with global variable names. |
1772 Take this example: > | |
7 | 1773 |
1774 let s:counter = 0 | |
1775 function MyCounter() | |
1776 let s:counter = s:counter + 1 | |
1777 echo s:counter | |
1778 endfunction | |
1779 command Tick call MyCounter() | |
1780 | |
1781 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
1782 that script will not be changed, only the "s:counter" in the script where | |
1783 "Tick" was defined is used. | |
1784 | |
1785 Another example that does the same: > | |
1786 | |
1787 let s:counter = 0 | |
1788 command Tick let s:counter = s:counter + 1 | echo s:counter | |
1789 | |
1790 When calling a function and invoking a user-defined command, the context for | |
9 | 1791 script variables is set to the script where the function or command was |
7 | 1792 defined. |
1793 | |
1794 The script variables are also available when a function is defined inside a | |
1795 function that is defined in a script. Example: > | |
1796 | |
1797 let s:counter = 0 | |
1798 function StartCounting(incr) | |
1799 if a:incr | |
1800 function MyCounter() | |
1801 let s:counter = s:counter + 1 | |
1802 endfunction | |
1803 else | |
1804 function MyCounter() | |
1805 let s:counter = s:counter - 1 | |
1806 endfunction | |
1807 endif | |
1808 endfunction | |
1809 | |
1810 This defines the MyCounter() function either for counting up or counting down | |
1811 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
1812 called, the s:counter variable will be accessible in MyCounter(). | |
1813 | |
1814 When the same script is sourced again it will use the same script variables. | |
1815 They will remain valid as long as Vim is running. This can be used to | |
1816 maintain a counter: > | |
1817 | |
1818 if !exists("s:counter") | |
1819 let s:counter = 1 | |
1820 echo "script executed for the first time" | |
1821 else | |
1822 let s:counter = s:counter + 1 | |
27903 | 1823 echo "script executed " .. s:counter .. " times now" |
7 | 1824 endif |
1825 | |
1826 Note that this means that filetype plugins don't get a different set of script | |
1827 variables for each buffer. Use local buffer variables instead |b:var|. | |
1828 | |
1829 | |
15131 | 1830 PREDEFINED VIM VARIABLES *vim-variable* *v:var* *v:* |
27321 | 1831 *E963* *E1063* |
15131 | 1832 Some variables can be set by the user, but the type cannot be changed. |
7 | 1833 |
18477
e93cab5d0f0f
patch 8.1.2233: cannot get the Vim command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
1834 *v:argv* *argv-variable* |
e93cab5d0f0f
patch 8.1.2233: cannot get the Vim command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
1835 v:argv The command line arguments Vim was invoked with. This is a |
e93cab5d0f0f
patch 8.1.2233: cannot get the Vim command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
1836 list of strings. The first item is the Vim command. |
28010 | 1837 See |v:progpath| for the command with full path. |
18477
e93cab5d0f0f
patch 8.1.2233: cannot get the Vim command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
1838 |
189 | 1839 *v:beval_col* *beval_col-variable* |
1840 v:beval_col The number of the column, over which the mouse pointer is. | |
1841 This is the byte index in the |v:beval_lnum| line. | |
1842 Only valid while evaluating the 'balloonexpr' option. | |
1843 | |
1844 *v:beval_bufnr* *beval_bufnr-variable* | |
1845 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
1846 valid while evaluating the 'balloonexpr' option. | |
1847 | |
1848 *v:beval_lnum* *beval_lnum-variable* | |
1849 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
1850 valid while evaluating the 'balloonexpr' option. | |
1851 | |
1852 *v:beval_text* *beval_text-variable* | |
374 | 1853 v:beval_text The text under or after the mouse pointer. Usually a word as |
1854 it is useful for debugging a C program. 'iskeyword' applies, | |
1855 but a dot and "->" before the position is included. When on a | |
1856 ']' the text before it is used, including the matching '[' and | |
189 | 1857 word before it. When on a Visual area within one line the |
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
1858 highlighted text is used. Also see |<cexpr>|. |
189 | 1859 Only valid while evaluating the 'balloonexpr' option. |
1860 | |
1861 *v:beval_winnr* *beval_winnr-variable* | |
1862 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
2709 | 1863 valid while evaluating the 'balloonexpr' option. The first |
1864 window has number zero (unlike most other places where a | |
1865 window gets a number). | |
189 | 1866 |
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1867 *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
|
1868 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
|
1869 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
|
1870 |
844 | 1871 *v:char* *char-variable* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1872 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
|
1873 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
|
1874 It is also used by the |InsertCharPre| and |InsertEnter| events. |
844 | 1875 |
7 | 1876 *v:charconvert_from* *charconvert_from-variable* |
1877 v:charconvert_from | |
1878 The name of the character encoding of a file to be converted. | |
1879 Only valid while evaluating the 'charconvert' option. | |
1880 | |
1881 *v:charconvert_to* *charconvert_to-variable* | |
1882 v:charconvert_to | |
1883 The name of the character encoding of a file after conversion. | |
1884 Only valid while evaluating the 'charconvert' option. | |
1885 | |
1886 *v:cmdarg* *cmdarg-variable* | |
1887 v:cmdarg This variable is used for two purposes: | |
1888 1. The extra arguments given to a file read/write command. | |
1889 Currently these are "++enc=" and "++ff=". This variable is | |
1890 set before an autocommand event for a file read/write | |
1891 command is triggered. There is a leading space to make it | |
1892 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
|
1893 read/write command. Note: The "+cmd" argument isn't |
7 | 1894 included here, because it will be executed anyway. |
1895 2. When printing a PostScript file with ":hardcopy" this is | |
1896 the argument for the ":hardcopy" command. This can be used | |
1897 in 'printexpr'. | |
1898 | |
1899 *v:cmdbang* *cmdbang-variable* | |
1900 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
1901 was used the value is 1, otherwise it is 0. Note that this | |
1902 can only be used in autocommands. For user commands |<bang>| | |
1903 can be used. | |
20873
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1904 *v:collate* *collate-variable* |
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1905 v:collate The current locale setting for collation order of the runtime |
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1906 environment. This allows Vim scripts to be aware of the |
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1907 current locale encoding. Technical: it's the value of |
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1908 LC_COLLATE. When not using a locale the value is "C". |
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1909 This variable can not be set directly, use the |:language| |
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1910 command. |
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1911 See |multi-lang|. |
7 | 1912 |
26057
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1913 *v:colornames* |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1914 v:colornames A dictionary that maps color names to hex color strings. These |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1915 color names can be used with the |highlight-guifg|, |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1916 |highlight-guibg|, and |highlight-guisp| parameters. Updating |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1917 an entry in v:colornames has no immediate effect on the syntax |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1918 highlighting. The highlight commands (probably in a |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1919 colorscheme script) need to be re-evaluated in order to use |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1920 the updated color values. For example: > |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1921 |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1922 :let v:colornames['fuscia'] = '#cf3ab4' |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1923 :let v:colornames['mauve'] = '#915f6d' |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1924 :highlight Normal guifg=fuscia guibg=mauve |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1925 < |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1926 This cannot be used to override the |cterm-colors| but it can |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1927 be used to override other colors. For example, the X11 colors |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1928 defined in the `colors/lists/default.vim` (previously defined |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1929 in |rgb.txt|). When defining new color names in a plugin, the |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1930 recommended practice is to set a color entry only when it does |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1931 not already exist. For example: > |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1932 |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1933 :call extend(v:colornames, { |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1934 \ 'fuscia': '#cf3ab4', |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1935 \ 'mauve': '#915f6d, |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1936 \ }, 'keep') |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1937 < |
26100 | 1938 Using |extend()| with the 'keep' option updates each color only |
26057
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1939 if it did not exist in |v:colornames|. Doing so allows the |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1940 user to choose the precise color value for a common name |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1941 by setting it in their |.vimrc|. |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1942 |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1943 It is possible to remove entries from this dictionary but |
26115
bb87ce13e7d6
patch 8.2.3590: test for v:colornames sometimes fails
Bram Moolenaar <Bram@vim.org>
parents:
26100
diff
changeset
|
1944 doing so is NOT recommended, because it is disruptive to |
26057
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1945 other scripts. It is also unlikely to achieve the desired |
26100 | 1946 result because the |:colorscheme| and |:highlight| commands will |
26057
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1947 both automatically load all `colors/lists/default.vim` color |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1948 scripts. |
92c424550367
patch 8.2.3562: cannot add color names
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1949 |
6909 | 1950 *v:completed_item* *completed_item-variable* |
1951 v:completed_item | |
1952 |Dictionary| containing the |complete-items| for the most | |
1953 recently completed word after |CompleteDone|. The | |
1954 |Dictionary| is empty if the completion failed. | |
1955 | |
7 | 1956 *v:count* *count-variable* |
1957 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
|
1958 to get the count before a mapping. Read-only. Example: > |
27903 | 1959 :map _x :<C-U>echo "the count is " .. v:count<CR> |
7 | 1960 < Note: The <C-U> is required to remove the line range that you |
1961 get when typing ':' after a count. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1962 When there are two counts, as in "3d2w", they are multiplied, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1963 just like what happens in the command, "d6w" for the example. |
667 | 1964 Also used for evaluating the 'formatexpr' option. |
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
1965 "count" also works, for backwards compatibility, unless |
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
1966 |scriptversion| is 3 or higher. |
7 | 1967 |
1968 *v:count1* *count1-variable* | |
1969 v:count1 Just like "v:count", but defaults to one when no count is | |
1970 used. | |
1971 | |
1972 *v:ctype* *ctype-variable* | |
1973 v:ctype The current locale setting for characters of the runtime | |
1974 environment. This allows Vim scripts to be aware of the | |
1975 current locale encoding. Technical: it's the value of | |
1976 LC_CTYPE. When not using a locale the value is "C". | |
1977 This variable can not be set directly, use the |:language| | |
1978 command. | |
1979 See |multi-lang|. | |
1980 | |
1981 *v:dying* *dying-variable* | |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1982 v:dying Normally zero. When a deadly signal is caught it's set to |
7 | 1983 one. When multiple signals are caught the number increases. |
1984 Can be used in an autocommand to check if Vim didn't | |
1985 terminate normally. {only works on Unix} | |
1986 Example: > | |
1987 :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
|
1988 < 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
|
1989 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
|
1990 |
23048
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1991 *v:exiting* *exiting-variable* |
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1992 v:exiting Vim exit code. Normally zero, non-zero when something went |
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1993 wrong. The value is v:null before invoking the |VimLeavePre| |
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1994 and |VimLeave| autocmds. See |:q|, |:x| and |:cquit|. |
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1995 Example: > |
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1996 :au VimLeave * echo "Exit value is " .. v:exiting |
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1997 < |
17833
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1998 *v:echospace* *echospace-variable* |
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1999 v:echospace Number of screen cells that can be used for an `:echo` message |
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
2000 in the last screen line before causing the |hit-enter-prompt|. |
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
2001 Depends on 'showcmd', 'ruler' and 'columns'. You need to |
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
2002 check 'cmdheight' for whether there are full-width lines |
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
2003 available above the last line. |
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
2004 |
7 | 2005 *v:errmsg* *errmsg-variable* |
2006 v:errmsg Last given error message. It's allowed to set this variable. | |
2007 Example: > | |
2008 :let v:errmsg = "" | |
2009 :silent! next | |
2010 :if v:errmsg != "" | |
2011 : ... handle error | |
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2012 < "errmsg" also works, for backwards compatibility, unless |
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2013 |scriptversion| is 3 or higher. |
7 | 2014 |
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2015 *v:errors* *errors-variable* *assert-return* |
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2016 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
|
2017 This is a list of strings. |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2018 The assert functions append an item when an assert fails. |
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2019 The return value indicates this: a one is returned if an item |
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2020 was added to v:errors, otherwise zero is returned. |
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2021 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
|
2022 :let v:errors = [] |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2023 < 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
|
2024 list by the assert function. |
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2025 |
13037
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
2026 *v:event* *event-variable* |
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
2027 v:event Dictionary containing information about the current |
19303 | 2028 |autocommand|. See the specific event for what it puts in |
2029 this dictionary. | |
20115 | 2030 The dictionary is emptied when the |autocommand| finishes, |
2031 please refer to |dict-identity| for how to get an independent | |
2032 copy of it. Use |deepcopy()| if you want to keep the | |
2033 information after the event triggers. Example: > | |
2034 au TextYankPost * let g:foo = deepcopy(v:event) | |
2035 < | |
7 | 2036 *v:exception* *exception-variable* |
2037 v:exception The value of the exception most recently caught and not | |
2038 finished. See also |v:throwpoint| and |throw-variables|. | |
2039 Example: > | |
2040 :try | |
2041 : throw "oops" | |
2042 :catch /.*/ | |
17571 | 2043 : echo "caught " .. v:exception |
7 | 2044 :endtry |
2045 < Output: "caught oops". | |
2046 | |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2047 *v:false* *false-variable* |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2048 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
|
2049 |json_encode()|. |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2050 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
|
2051 echo v:false |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2052 < v:false ~ |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2053 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
|
2054 value. Read-only. |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2055 In |Vim9| script "false" can be used which has a boolean type. |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2056 |
179 | 2057 *v:fcs_reason* *fcs_reason-variable* |
2058 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
2059 Can be used in an autocommand to decide what to do and/or what | |
2060 to set v:fcs_choice to. Possible values: | |
2061 deleted file no longer exists | |
2062 conflict file contents, mode or timestamp was | |
2063 changed and buffer is modified | |
2064 changed file contents has changed | |
2065 mode mode of file changed | |
2066 time only file timestamp changed | |
2067 | |
2068 *v:fcs_choice* *fcs_choice-variable* | |
2069 v:fcs_choice What should happen after a |FileChangedShell| event was | |
2070 triggered. Can be used in an autocommand to tell Vim what to | |
2071 do with the affected buffer: | |
2072 reload Reload the buffer (does not work if | |
2073 the file was deleted). | |
27635
6ca2d8f4cd32
patch 8.2.4343: when reloading not all properties are detected
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
2074 edit Reload the buffer and detect the |
6ca2d8f4cd32
patch 8.2.4343: when reloading not all properties are detected
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
2075 values for options such as |
6ca2d8f4cd32
patch 8.2.4343: when reloading not all properties are detected
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
2076 'fileformat', 'fileencoding', 'binary' |
6ca2d8f4cd32
patch 8.2.4343: when reloading not all properties are detected
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
2077 (does not work if the file was |
6ca2d8f4cd32
patch 8.2.4343: when reloading not all properties are detected
Bram Moolenaar <Bram@vim.org>
parents:
27537
diff
changeset
|
2078 deleted). |
179 | 2079 ask Ask the user what to do, as if there |
2080 was no autocommand. Except that when | |
2081 only the timestamp changed nothing | |
2082 will happen. | |
2083 <empty> Nothing, the autocommand should do | |
2084 everything that needs to be done. | |
2085 The default is empty. If another (invalid) value is used then | |
2086 Vim behaves like it is empty, there is no warning message. | |
2087 | |
24569 | 2088 *v:fname* *fname-variable* |
25161 | 2089 v:fname When evaluating 'includeexpr': the file name that was |
2090 detected. Empty otherwise. | |
24569 | 2091 |
7 | 2092 *v:fname_in* *fname_in-variable* |
579 | 2093 v:fname_in The name of the input file. Valid while evaluating: |
7 | 2094 option used for ~ |
2095 'charconvert' file to be converted | |
2096 'diffexpr' original file | |
2097 'patchexpr' original file | |
2098 'printexpr' file to be printed | |
593 | 2099 And set to the swap file name for |SwapExists|. |
7 | 2100 |
2101 *v:fname_out* *fname_out-variable* | |
2102 v:fname_out The name of the output file. Only valid while | |
2103 evaluating: | |
2104 option used for ~ | |
2105 'charconvert' resulting converted file (*) | |
2106 'diffexpr' output of diff | |
2107 'patchexpr' resulting patched file | |
2108 (*) 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
|
2109 file") it will be equal to v:fname_in. When doing conversion |
7 | 2110 for a read command (e.g., ":e file") it will be a temporary |
2111 file and different from v:fname_in. | |
2112 | |
2113 *v:fname_new* *fname_new-variable* | |
2114 v:fname_new The name of the new version of the file. Only valid while | |
2115 evaluating 'diffexpr'. | |
2116 | |
2117 *v:fname_diff* *fname_diff-variable* | |
2118 v:fname_diff The name of the diff (patch) file. Only valid while | |
2119 evaluating 'patchexpr'. | |
2120 | |
2121 *v:folddashes* *folddashes-variable* | |
2122 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
2123 fold. | |
29 | 2124 Read-only in the |sandbox|. |fold-foldtext| |
7 | 2125 |
2126 *v:foldlevel* *foldlevel-variable* | |
2127 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
29 | 2128 Read-only in the |sandbox|. |fold-foldtext| |
7 | 2129 |
2130 *v:foldend* *foldend-variable* | |
2131 v:foldend Used for 'foldtext': last line of closed fold. | |
29 | 2132 Read-only in the |sandbox|. |fold-foldtext| |
7 | 2133 |
2134 *v:foldstart* *foldstart-variable* | |
2135 v:foldstart Used for 'foldtext': first line of closed fold. | |
29 | 2136 Read-only in the |sandbox|. |fold-foldtext| |
7 | 2137 |
5460 | 2138 *v:hlsearch* *hlsearch-variable* |
12785 | 2139 v:hlsearch Variable that indicates whether search highlighting is on. |
6413 | 2140 Setting it makes sense only if 'hlsearch' is enabled which |
2141 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
|
2142 like the |:nohlsearch| command, setting it to one acts like > |
5460 | 2143 let &hlsearch = &hlsearch |
6918 | 2144 < Note that the value is restored when returning from a |
2145 function. |function-search-undo|. | |
2146 | |
11 | 2147 *v:insertmode* *insertmode-variable* |
2148 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
2149 events. Values: | |
2150 i Insert mode | |
2151 r Replace mode | |
2152 v Virtual Replace mode | |
2153 | |
102 | 2154 *v:key* *key-variable* |
685 | 2155 v:key Key of the current item of a |Dictionary|. Only valid while |
102 | 2156 evaluating the expression used with |map()| and |filter()|. |
2157 Read-only. | |
2158 | |
7 | 2159 *v:lang* *lang-variable* |
2160 v:lang The current locale setting for messages of the runtime | |
2161 environment. This allows Vim scripts to be aware of the | |
2162 current language. Technical: it's the value of LC_MESSAGES. | |
2163 The value is system dependent. | |
2164 This variable can not be set directly, use the |:language| | |
2165 command. | |
2166 It can be different from |v:ctype| when messages are desired | |
2167 in a different language than what is used for character | |
2168 encoding. See |multi-lang|. | |
2169 | |
2170 *v:lc_time* *lc_time-variable* | |
2171 v:lc_time The current locale setting for time messages of the runtime | |
2172 environment. This allows Vim scripts to be aware of the | |
2173 current language. Technical: it's the value of LC_TIME. | |
2174 This variable can not be set directly, use the |:language| | |
2175 command. See |multi-lang|. | |
2176 | |
2177 *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
|
2178 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
|
2179 '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
|
2180 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
|
2181 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
|
2182 |sandbox|. |
7 | 2183 |
26881
fb67cd7d30a7
patch 8.2.3969: value of MAXCOL not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
26847
diff
changeset
|
2184 *v:maxcol* *maxcol-variable* |
27036 | 2185 v:maxcol Maximum line length. Depending on where it is used it can be |
27804 | 2186 screen columns, characters or bytes. The value currently is |
2187 2147483647 on all systems. | |
26881
fb67cd7d30a7
patch 8.2.3969: value of MAXCOL not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
26847
diff
changeset
|
2188 |
1029 | 2189 *v:mouse_win* *mouse_win-variable* |
2190 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
2191 First window has number 1, like with |winnr()|. The value is | |
2192 zero when there was no mouse button click. | |
2193 | |
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
2194 *v:mouse_winid* *mouse_winid-variable* |
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
2195 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
|
2196 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
|
2197 |
1029 | 2198 *v:mouse_lnum* *mouse_lnum-variable* |
2199 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
2200 This is the text line number, not the screen line number. The | |
2201 value is zero when there was no mouse button click. | |
2202 | |
2203 *v:mouse_col* *mouse_col-variable* | |
2204 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
2205 This is the screen column number, like with |virtcol()|. The | |
2206 value is zero when there was no mouse button click. | |
2207 | |
15512 | 2208 *v:none* *none-variable* *None* |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2209 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
|
2210 |json_encode()|. |
21499 | 2211 This can also be used as a function argument to use the |
2212 default value, see |none-function_argument|. | |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
2213 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
|
2214 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
|
2215 echo v:none |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2216 < v:none ~ |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2217 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
|
2218 value. Read-only. |
28010 | 2219 Note that using `== v:none` and `!= v:none` will often give |
2220 an error. Instead, use `is v:none` and `isnot v:none` . | |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2221 |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2222 *v:null* *null-variable* |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2223 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
|
2224 |json_encode()|. |
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
2225 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
|
2226 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
|
2227 echo v:null |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2228 < v:null ~ |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2229 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
|
2230 value. Read-only. |
28010 | 2231 In |Vim9| script `null` can be used without "v:". |
2232 In some places `v:null` and `null` can be used for a List, | |
2233 Dict, Job, etc. that is not set. That is slightly different | |
2234 than an empty List, Dict, etc. | |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2235 |
23693
cd06cc37f53f
patch 8.2.2388: no easy way to get the maximum or mininum number value
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
2236 *v:numbermax* *numbermax-variable* |
cd06cc37f53f
patch 8.2.2388: no easy way to get the maximum or mininum number value
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
2237 v:numbermax Maximum value of a number. |
cd06cc37f53f
patch 8.2.2388: no easy way to get the maximum or mininum number value
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
2238 |
23737 | 2239 *v:numbermin* *numbermin-variable* |
24911 | 2240 v:numbermin Minimum value of a number (negative). |
23693
cd06cc37f53f
patch 8.2.2388: no easy way to get the maximum or mininum number value
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
2241 |
19477
2bb0e80fcd32
patch 8.2.0296: mixing up "long long" and __int64 may cause problems
Bram Moolenaar <Bram@vim.org>
parents:
19400
diff
changeset
|
2242 *v:numbersize* *numbersize-variable* |
2bb0e80fcd32
patch 8.2.0296: mixing up "long long" and __int64 may cause problems
Bram Moolenaar <Bram@vim.org>
parents:
19400
diff
changeset
|
2243 v:numbersize Number of bits in a Number. This is normally 64, but on some |
19523 | 2244 systems it may be 32. |
19477
2bb0e80fcd32
patch 8.2.0296: mixing up "long long" and __int64 may cause problems
Bram Moolenaar <Bram@vim.org>
parents:
19400
diff
changeset
|
2245 |
1733 | 2246 *v:oldfiles* *oldfiles-variable* |
2247 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
2248 startup. These are the files that Vim remembers marks for. | |
2249 The length of the List is limited by the ' argument of the | |
2250 'viminfo' option (default is 100). | |
5618 | 2251 When the |viminfo| file is not used the List is empty. |
1733 | 2252 Also see |:oldfiles| and |c_#<|. |
2253 The List can be modified, but this has no effect on what is | |
2254 stored in the |viminfo| file later. If you use values other | |
2255 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
|
2256 {only when compiled with the |+viminfo| feature} |
1733 | 2257 |
6935 | 2258 *v:option_new* |
2259 v:option_new New value of the option. Valid while executing an |OptionSet| | |
2260 autocommand. | |
2261 *v:option_old* | |
2262 v:option_old Old value of the option. Valid while executing an |OptionSet| | |
17085
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2263 autocommand. Depending on the command used for setting and the |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2264 kind of option this is either the local old value or the |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2265 global old value. |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2266 *v:option_oldlocal* |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2267 v:option_oldlocal |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2268 Old local value of the option. Valid while executing an |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2269 |OptionSet| autocommand. |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2270 *v:option_oldglobal* |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2271 v:option_oldglobal |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2272 Old global value of the option. Valid while executing an |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2273 |OptionSet| autocommand. |
6935 | 2274 *v:option_type* |
2275 v:option_type Scope of the set command. Valid while executing an | |
2276 |OptionSet| autocommand. Can be either "global" or "local" | |
17085
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2277 *v:option_command* |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2278 v:option_command |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2279 Command used to set the option. Valid while executing an |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2280 |OptionSet| autocommand. |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2281 value option was set via ~ |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2282 "setlocal" |:setlocal| or ":let l:xxx" |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2283 "setglobal" |:setglobal| or ":let g:xxx" |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2284 "set" |:set| or |:let| |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2285 "modeline" |modeline| |
1490 | 2286 *v:operator* *operator-variable* |
2287 v:operator The last operator given in Normal mode. This is a single | |
2288 character except for commands starting with <g> or <z>, | |
2289 in which case it is two characters. Best used alongside | |
2290 |v:prevcount| and |v:register|. Useful if you want to cancel | |
2291 Operator-pending mode and then use the operator, e.g.: > | |
2292 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
2293 < The value remains set until another operator is entered, thus | |
2294 don't expect it to be empty. | |
2295 v:operator is not set for |:delete|, |:yank| or other Ex | |
2296 commands. | |
2297 Read-only. | |
2298 | |
7 | 2299 *v:prevcount* *prevcount-variable* |
2300 v:prevcount The count given for the last but one Normal mode command. | |
2301 This is the v:count value of the previous command. Useful if | |
1490 | 2302 you want to cancel Visual or Operator-pending mode and then |
2303 use the count, e.g.: > | |
7 | 2304 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
2305 < Read-only. | |
2306 | |
170 | 2307 *v:profiling* *profiling-variable* |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2308 v:profiling Normally zero. Set to one after using ":profile start". |
170 | 2309 See |profiling|. |
2310 | |
7 | 2311 *v:progname* *progname-variable* |
2312 v:progname Contains the name (with path removed) with which Vim was | |
3492 | 2313 invoked. Allows you to do special initialisations for |view|, |
2314 |evim| etc., or any other name you might symlink to Vim. | |
7 | 2315 Read-only. |
2316 | |
5780 | 2317 *v:progpath* *progpath-variable* |
17758 | 2318 v:progpath Contains the command with which Vim was invoked, in a form |
2319 that when passed to the shell will run the same Vim executable | |
2320 as the current one (if $PATH remains unchanged). | |
2321 Useful if you want to message a Vim server using a | |
5780 | 2322 |--remote-expr|. |
5782 | 2323 To get the full path use: > |
2324 echo exepath(v:progpath) | |
17758 | 2325 < If the command has a relative path it will be expanded to the |
2326 full path, so that it still works after `:cd`. Thus starting | |
2327 "./vim" results in "/home/user/path/to/vim/src/vim". | |
2328 On Linux and other systems it will always be the full path. | |
2329 On Mac it may just be "vim" and using exepath() as mentioned | |
2330 above should be used to get the full path. | |
11032
516391d8865f
patch 8.0.0405: v:progpath may become invalid after :cd
Christian Brabandt <cb@256bit.org>
parents:
11014
diff
changeset
|
2331 On MS-Windows the executable may be called "vim.exe", but the |
516391d8865f
patch 8.0.0405: v:progpath may become invalid after :cd
Christian Brabandt <cb@256bit.org>
parents:
11014
diff
changeset
|
2332 ".exe" is not added to v:progpath. |
5780 | 2333 Read-only. |
2334 | |
7 | 2335 *v:register* *register-variable* |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2336 v:register The name of the register in effect for the current normal mode |
3492 | 2337 command (regardless of whether that command actually used a |
2338 register). Or for the currently executing normal mode mapping | |
2339 (use this in custom commands that take a register). | |
2340 If none is supplied it is the default register '"', unless | |
2341 'clipboard' contains "unnamed" or "unnamedplus", then it is | |
2342 '*' or '+'. | |
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2343 Also see |getreg()| and |setreg()| |
7 | 2344 |
540 | 2345 *v:scrollstart* *scrollstart-variable* |
2346 v:scrollstart String describing the script or function that caused the | |
2347 screen to scroll up. It's only set when it is empty, thus the | |
2348 first reason is remembered. It is set to "Unknown" for a | |
2349 typed command. | |
2350 This can be used to find out why your script causes the | |
2351 hit-enter prompt. | |
2352 | |
7 | 2353 *v:servername* *servername-variable* |
11904
40322e8f07e7
patch 8.0.0832: terminal function arguments are not consistent
Christian Brabandt <cb@256bit.org>
parents:
11882
diff
changeset
|
2354 v:servername The resulting registered |client-server-name| if any. |
7 | 2355 Read-only. |
2356 | |
12785 | 2357 |
1621 | 2358 v:searchforward *v:searchforward* *searchforward-variable* |
2359 Search direction: 1 after a forward search, 0 after a | |
2360 backward search. It is reset to forward when directly setting | |
2361 the last search pattern, see |quote/|. | |
2362 Note that the value is restored when returning from a | |
2363 function. |function-search-undo|. | |
2364 Read-write. | |
2365 | |
7 | 2366 *v:shell_error* *shell_error-variable* |
2367 v:shell_error Result of the last shell command. When non-zero, the last | |
2368 shell command had an error. When zero, there was no problem. | |
2369 This only works when the shell returns the error code to Vim. | |
2370 The value -1 is often used when the command could not be | |
2371 executed. Read-only. | |
2372 Example: > | |
2373 :!mv foo bar | |
2374 :if v:shell_error | |
2375 : echo 'could not rename "foo" to "bar"!' | |
2376 :endif | |
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2377 < "shell_error" also works, for backwards compatibility, unless |
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2378 |scriptversion| is 3 or higher. |
7 | 2379 |
26100 | 2380 *v:sizeofint* *sizeofint-variable* |
2381 v:sizeofint Number of bytes in an int. Depends on how Vim was compiled. | |
2382 This is only useful for deciding whether a test will give the | |
2383 expected result. | |
2384 | |
2385 *v:sizeoflong* *sizeoflong-variable* | |
2386 v:sizeoflong Number of bytes in a long. Depends on how Vim was compiled. | |
2387 This is only useful for deciding whether a test will give the | |
2388 expected result. | |
2389 | |
2390 *v:sizeofpointer* *sizeofpointer-variable* | |
2391 v:sizeofpointer Number of bytes in a pointer. Depends on how Vim was compiled. | |
2392 This is only useful for deciding whether a test will give the | |
2393 expected result. | |
2394 | |
7 | 2395 *v:statusmsg* *statusmsg-variable* |
2396 v:statusmsg Last given status message. It's allowed to set this variable. | |
2397 | |
579 | 2398 *v:swapname* *swapname-variable* |
2399 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
2400 the swap file found. Read-only. | |
2401 | |
2402 *v:swapchoice* *swapchoice-variable* | |
2403 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
2404 for handling an existing swap file: | |
2405 'o' Open read-only | |
2406 'e' Edit anyway | |
2407 'r' Recover | |
2408 'd' Delete swapfile | |
2409 'q' Quit | |
2410 'a' Abort | |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2411 The value should be a single-character string. An empty value |
579 | 2412 results in the user being asked, as would happen when there is |
2413 no SwapExists autocommand. The default is empty. | |
2414 | |
590 | 2415 *v:swapcommand* *swapcommand-variable* |
625 | 2416 v:swapcommand Normal mode command to be executed after a file has been |
590 | 2417 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
|
2418 another Vim open the file and jump to the right place. For |
590 | 2419 example, when jumping to a tag the value is ":tag tagname\r". |
716 | 2420 For ":edit +cmd file" the value is ":cmd\r". |
590 | 2421 |
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
2422 *v:t_TYPE* *v:t_bool* *t_bool-variable* |
15512 | 2423 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
|
2424 *v:t_channel* *t_channel-variable* |
15512 | 2425 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
|
2426 *v:t_dict* *t_dict-variable* |
15512 | 2427 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
|
2428 *v:t_float* *t_float-variable* |
15512 | 2429 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
|
2430 *v:t_func* *t_func-variable* |
15512 | 2431 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
|
2432 *v:t_job* *t_job-variable* |
15512 | 2433 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
|
2434 *v:t_list* *t_list-variable* |
15512 | 2435 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
|
2436 *v:t_none* *t_none-variable* |
15512 | 2437 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
|
2438 *v:t_number* *t_number-variable* |
15512 | 2439 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
|
2440 *v:t_string* *t_string-variable* |
15512 | 2441 v:t_string Value of |String| type. Read-only. See: |type()| |
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2442 *v:t_blob* *t_blob-variable* |
15512 | 2443 v:t_blob Value of |Blob| type. Read-only. See: |type()| |
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
2444 |
7 | 2445 *v:termresponse* *termresponse-variable* |
2446 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
|
2447 termcap entry. It is set when Vim receives an escape sequence |
16849
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
2448 that starts with ESC [ or CSI, then '>' or '?' and ends in a |
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
2449 'c', with only digits and ';' in between. |
7 | 2450 When this option is set, the TermResponse autocommand event is |
2451 fired, so that you can react to the response from the | |
20836
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
2452 terminal. You can use |terminalprops()| to see what Vim |
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
2453 figured out about the terminal. |
16849
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
2454 The response from a new xterm is: "<Esc>[> Pp ; Pv ; Pc c". Pp |
7 | 2455 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the |
2456 patch level (since this was introduced in patch 95, it's | |
26708 | 2457 always 95 or higher). Pc is always zero. |
2458 If Pv is 141 or higher then Vim will try to request terminal | |
2459 codes. This only works with xterm |xterm-codes|. | |
7 | 2460 {only when compiled with |+termresponse| feature} |
2461 | |
12273
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2462 *v:termblinkresp* |
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2463 v:termblinkresp The escape sequence returned by the terminal for the |t_RC| |
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2464 termcap entry. This is used to find out whether the terminal |
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2465 cursor is blinking. This is used by |term_getcursor()|. |
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2466 |
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2467 *v:termstyleresp* |
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2468 v:termstyleresp The escape sequence returned by the terminal for the |t_RS| |
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2469 termcap entry. This is used to find out what the shape of the |
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2470 cursor is. This is used by |term_getcursor()|. |
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2471 |
12632
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
2472 *v:termrbgresp* |
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
2473 v:termrbgresp The escape sequence returned by the terminal for the |t_RB| |
12273
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2474 termcap entry. This is used to find out what the terminal |
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2475 background color is, see 'background'. |
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2476 |
12632
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
2477 *v:termrfgresp* |
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
2478 v:termrfgresp The escape sequence returned by the terminal for the |t_RF| |
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
2479 termcap entry. This is used to find out what the terminal |
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
2480 foreground color is. |
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
2481 |
12273
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2482 *v:termu7resp* |
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2483 v:termu7resp The escape sequence returned by the terminal for the |t_u7| |
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2484 termcap entry. This is used to find out what the terminal |
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2485 does with ambiguous width characters, see 'ambiwidth'. |
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2486 |
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
2487 *v:testing* *testing-variable* |
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
2488 v:testing Must be set before using `test_garbagecollect_now()`. |
11160 | 2489 Also, when set certain error messages won't be shown for 2 |
12785 | 2490 seconds. (e.g. "'dictionary' option is empty") |
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
2491 |
7 | 2492 *v:this_session* *this_session-variable* |
2493 v:this_session Full filename of the last loaded or saved session file. See | |
2494 |:mksession|. It is allowed to set this variable. When no | |
2495 session file has been saved, this variable is empty. | |
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2496 "this_session" also works, for backwards compatibility, unless |
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2497 |scriptversion| is 3 or higher |
7 | 2498 |
2499 *v:throwpoint* *throwpoint-variable* | |
2500 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
|
2501 finished was thrown. Not set when commands are typed. See |
7 | 2502 also |v:exception| and |throw-variables|. |
2503 Example: > | |
2504 :try | |
2505 : throw "oops" | |
2506 :catch /.*/ | |
2507 : echo "Exception from" v:throwpoint | |
2508 :endtry | |
2509 < Output: "Exception from test.vim, line 2" | |
2510 | |
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2511 *v:true* *true-variable* |
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2512 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
|
2513 |json_encode()|. |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2514 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
|
2515 echo v:true |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2516 < v:true ~ |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2517 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
|
2518 value. Read-only. |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2519 In |Vim9| script "true" can be used which has a boolean type. |
102 | 2520 *v:val* *val-variable* |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2521 v:val Value of the current item of a |List| or |Dictionary|. Only |
685 | 2522 valid while evaluating the expression used with |map()| and |
102 | 2523 |filter()|. Read-only. |
2524 | |
7 | 2525 *v:version* *version-variable* |
2526 v:version Version number of Vim: Major version number times 100 plus | |
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
2527 minor version number. Version 5.0 is 500. Version 5.1 |
7 | 2528 is 501. Read-only. "version" also works, for backwards |
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2529 compatibility, unless |scriptversion| is 3 or higher. |
7 | 2530 Use |has()| to check if a certain patch was included, e.g.: > |
5786 | 2531 if has("patch-7.4.123") |
7 | 2532 < Note that patch numbers are specific to the version, thus both |
2533 version 5.0 and 5.1 may have a patch 123, but these are | |
2534 completely different. | |
2535 | |
17053
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2536 *v:versionlong* *versionlong-variable* |
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
2537 v:versionlong Like v:version, but also including the patchlevel in the last |
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
2538 four digits. Version 8.1 with patch 123 has value 8010123. |
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
2539 This can be used like this: > |
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
2540 if v:versionlong >= 8010123 |
17053
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2541 < However, if there are gaps in the list of patches included |
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2542 this will not work well. This can happen if a recent patch |
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2543 was included into an older version, e.g. for a security fix. |
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2544 Use the has() function to make sure the patch is actually |
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2545 included. |
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2546 |
8738
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
2547 *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
|
2548 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
|
2549 before |VimEnter| autocommands are triggered. |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
2550 |
7 | 2551 *v:warningmsg* *warningmsg-variable* |
2552 v:warningmsg Last given warning message. It's allowed to set this variable. | |
2553 | |
2609 | 2554 *v:windowid* *windowid-variable* |
2555 v:windowid When any X11 based GUI is running or when running in a | |
2556 terminal and Vim connects to the X server (|-X|) this will be | |
2616 | 2557 set to the window ID. |
2558 When an MS-Windows GUI is running this will be set to the | |
2559 window handle. | |
2560 Otherwise the value is zero. | |
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
2561 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
|
2562 see |window-ID|. |
2609 | 2563 |
7 | 2564 ============================================================================== |
2565 4. Builtin Functions *functions* | |
2566 | |
2567 See |function-list| for a list grouped by what the function is used for. | |
2568 | |
26777
629e7046ef63
patch 8.2.3917: the eval.txt help file is way too big
Bram Moolenaar <Bram@vim.org>
parents:
26769
diff
changeset
|
2569 The alphabetic list of all builtin functions and details are in a separate |
629e7046ef63
patch 8.2.3917: the eval.txt help file is way too big
Bram Moolenaar <Bram@vim.org>
parents:
26769
diff
changeset
|
2570 help file: |builtin-functions|. |
7 | 2571 |
2572 ============================================================================== | |
2573 5. Defining functions *user-functions* | |
2574 | |
2575 New functions can be defined. These can be called just like builtin | |
2576 functions. The function executes a sequence of Ex commands. Normal mode | |
2577 commands can be executed with the |:normal| command. | |
2578 | |
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
2579 This section is about the legacy functions. For the Vim9 functions, which |
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
2580 execute much faster, support type checking and more, see |vim9.txt|. |
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
2581 |
7 | 2582 The function name must start with an uppercase letter, to avoid confusion with |
2583 builtin functions. To prevent from using the same name in different scripts | |
2584 avoid obvious, short names. A good habit is to start the function name with | |
2585 the name of the script, e.g., "HTMLcolor()". | |
2586 | |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2587 In legacy script it is also possible to use curly braces, see |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2588 |curly-braces-names|. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2589 The |autoload| facility is useful to define a function only when it's called. |
7 | 2590 |
2591 *local-function* | |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2592 A function local to a legacy script must start with "s:". A local script |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2593 function can only be called from within the script and from functions, user |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2594 commands and autocommands defined in the script. It is also possible to call |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2595 the function from a mapping defined in the script, but then |<SID>| must be |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2596 used instead of "s:" when the mapping is expanded outside of the script. |
5862 | 2597 There are only script-local functions, no buffer-local or window-local |
2598 functions. | |
7 | 2599 |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2600 In |Vim9| script functions are local to the script by default, prefix "g:" to |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2601 define a global function. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2602 |
27036 | 2603 *:fu* *:function* *E128* *E129* *E123* *E454* |
7 | 2604 :fu[nction] List all functions and their arguments. |
2605 | |
2606 :fu[nction] {name} List function {name}. | |
685 | 2607 {name} can also be a |Dictionary| entry that is a |
2608 |Funcref|: > | |
114 | 2609 :function dict.init |
504 | 2610 |
2611 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
2612 Example that lists all functions ending with "File": > | |
2613 :function /File$ | |
482 | 2614 < |
2615 *:function-verbose* | |
2616 When 'verbose' is non-zero, listing a function will also display where it was | |
2617 last defined. Example: > | |
2618 | |
2619 :verbose function SetFileTypeSH | |
2620 function SetFileTypeSH(name) | |
2621 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
2622 < | |
484 | 2623 See |:verbose-cmd| for more information. |
482 | 2624 |
5862 | 2625 *E124* *E125* *E853* *E884* |
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2626 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] [closure] |
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
2627 Define a new function by the name {name}. The body of |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
2628 the function follows in the next lines, until the |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
2629 matching |:endfunction|. |
12785 | 2630 |
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
2631 The name must be made of alphanumeric characters and |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
2632 '_', and must start with a capital or "s:" (see |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
2633 above). Note that using "b:" or "g:" is not allowed. |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
2634 (since patch 7.4.260 E884 is given if the function |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
2635 name has a colon in the name, e.g. for "foo:bar()". |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
2636 Before that patch no error was given). |
114 | 2637 |
685 | 2638 {name} can also be a |Dictionary| entry that is a |
2639 |Funcref|: > | |
114 | 2640 :function dict.init(arg) |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2641 < "dict" must be an existing dictionary. The entry |
114 | 2642 "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
|
2643 is required to overwrite an existing function. The |
114 | 2644 result is a |Funcref| to a numbered function. The |
2645 function can only be used with a |Funcref| and will be | |
2646 deleted if there are no more references to it. | |
7 | 2647 *E127* *E122* |
2648 When a function by this name already exists and [!] is | |
15008
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
2649 not used an error message is given. There is one |
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
2650 exception: When sourcing a script again, a function |
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
2651 that was previously defined in that script will be |
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
2652 silently replaced. |
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
2653 When [!] is used, an existing function is silently |
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
2654 replaced. Unless it is currently being executed, that |
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
2655 is an error. |
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
2656 NOTE: Use ! wisely. If used without care it can cause |
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
2657 an existing function to be replaced unexpectedly, |
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
2658 which is hard to debug. |
20552 | 2659 NOTE: In Vim9 script script-local functions cannot be |
2660 deleted or redefined. | |
133 | 2661 |
2662 For the {arguments} see |function-argument|. | |
2663 | |
5618 | 2664 *:func-range* *a:firstline* *a:lastline* |
7 | 2665 When the [range] argument is added, the function is |
2666 expected to take care of a range itself. The range is | |
2667 passed as "a:firstline" and "a:lastline". If [range] | |
2668 is excluded, ":{range}call" will call the function for | |
2669 each line in the range, with the cursor on the start | |
2670 of each line. See |function-range-example|. | |
3967 | 2671 The cursor is still moved to the first line of the |
2672 range, as is the case with all Ex commands. | |
5618 | 2673 *:func-abort* |
7 | 2674 When the [abort] argument is added, the function will |
2675 abort as soon as an error is detected. | |
5618 | 2676 *:func-dict* |
102 | 2677 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
|
2678 be invoked through an entry in a |Dictionary|. The |
102 | 2679 local variable "self" will then be set to the |
2680 dictionary. See |Dictionary-function|. | |
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2681 *:func-closure* *E932* |
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2682 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
|
2683 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
|
2684 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
|
2685 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
|
2686 remains referenced even after Foo() returns: > |
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2687 :function! Foo() |
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2688 : let x = 0 |
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2689 : function! Bar() closure |
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2690 : let x += 1 |
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2691 : return x |
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2692 : endfunction |
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
2693 : return funcref('Bar') |
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2694 :endfunction |
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2695 |
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2696 :let F = Foo() |
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2697 :echo F() |
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2698 < 1 > |
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2699 :echo F() |
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2700 < 2 > |
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2701 :echo F() |
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
2702 < 3 |
7 | 2703 |
1621 | 2704 *function-search-undo* |
653 | 2705 The last used search pattern and the redo command "." |
1621 | 2706 will not be changed by the function. This also |
2707 implies that the effect of |:nohlsearch| is undone | |
2708 when the function returns. | |
653 | 2709 |
27537 | 2710 *:endf* *:endfunction* *E126* *E193* *W22* *E1151* |
11543
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
2711 :endf[unction] [argument] |
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
2712 The end of a function definition. Best is to put it |
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
2713 on a line by its own, without [argument]. |
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
2714 |
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
2715 [argument] can be: |
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
2716 | command command to execute next |
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
2717 \n command command to execute next |
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
2718 " comment always ignored |
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
2719 anything else ignored, warning given when |
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
2720 'verbose' is non-zero |
11543
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
2721 The support for a following command was added in Vim |
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
2722 8.0.0654, before that any argument was silently |
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
2723 ignored. |
7 | 2724 |
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
2725 To be able to define a function inside an `:execute` |
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
2726 command, use line breaks instead of |:bar|: > |
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
2727 :exe "func Foo()\necho 'foo'\nendfunc" |
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
2728 < |
27459 | 2729 *:delf* *:delfunction* *E131* *E933* *E1084* |
11543
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
2730 :delf[unction][!] {name} |
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
2731 Delete function {name}. |
685 | 2732 {name} can also be a |Dictionary| entry that is a |
2733 |Funcref|: > | |
114 | 2734 :delfunc dict.init |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2735 < This will remove the "init" entry from "dict". The |
114 | 2736 function is deleted if there are no more references to |
2737 it. | |
11543
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
2738 With the ! there is no error if the function does not |
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
2739 exist. |
7 | 2740 *:retu* *:return* *E133* |
2741 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
2742 evaluated and returned as the result of the function. | |
2743 If "[expr]" is not given, the number 0 is returned. | |
2744 When a function ends without an explicit ":return", | |
2745 the number 0 is returned. | |
27459 | 2746 In a :def function *E1095* is given if unreachable |
2747 code follows after the `:return`. | |
2748 In legacy script there is no check for unreachable | |
2749 lines, thus there is no warning if commands follow | |
2750 `:return`. | |
7 | 2751 |
2752 If the ":return" is used after a |:try| but before the | |
2753 matching |:finally| (if present), the commands | |
2754 following the ":finally" up to the matching |:endtry| | |
2755 are executed first. This process applies to all | |
2756 nested ":try"s inside the function. The function | |
2757 returns at the outermost ":endtry". | |
2758 | |
133 | 2759 *function-argument* *a:var* |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2760 An argument can be defined by giving its name. In the function this can then |
133 | 2761 be used as "a:name" ("a:" for argument). |
1156 | 2762 *a:0* *a:1* *a:000* *E740* *...* |
133 | 2763 Up to 20 arguments can be given, separated by commas. After the named |
2764 arguments an argument "..." can be specified, which means that more arguments | |
2765 may optionally be following. In the function the extra arguments can be used | |
2766 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
685 | 2767 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
2768 that "a:1" is the same as "a:000[0]". | |
27459 | 2769 *E742* *E1090* |
148 | 2770 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
|
2771 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
|
2772 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
|
2773 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
|
2774 change a |List| or |Dictionary| use |:lockvar|. |
133 | 2775 |
2776 It is also possible to define a function without any arguments. You must | |
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
2777 still supply the () then. |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
2778 |
13482
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13438
diff
changeset
|
2779 It is allowed to define another function inside a function body. |
133 | 2780 |
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2781 *optional-function-argument* |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2782 You can provide default values for positional named arguments. This makes |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2783 them optional for function calls. When a positional argument is not |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2784 specified at a call, the default expression is used to initialize it. |
19968 | 2785 This only works for functions declared with `:function` or `:def`, not for |
2786 lambda expressions |expr-lambda|. | |
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2787 |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2788 Example: > |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2789 function Something(key, value = 10) |
16648
a7f06505ad39
patch 8.1.1326: no test for listener with partial
Bram Moolenaar <Bram@vim.org>
parents:
16638
diff
changeset
|
2790 echo a:key .. ": " .. a:value |
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2791 endfunction |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2792 call Something('empty') "empty: 10" |
16648
a7f06505ad39
patch 8.1.1326: no test for listener with partial
Bram Moolenaar <Bram@vim.org>
parents:
16638
diff
changeset
|
2793 call Something('key', 20) "key: 20" |
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2794 |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2795 The argument default expressions are evaluated at the time of the function |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2796 call, not definition. Thus it is possible to use an expression which is |
16808 | 2797 invalid the moment the function is defined. The expressions are also only |
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2798 evaluated when arguments are not specified during a call. |
21499 | 2799 *none-function_argument* |
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2800 You can pass |v:none| to use the default expression. Note that this means you |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2801 cannot pass v:none as an ordinary value when an argument has a default |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2802 expression. |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2803 |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2804 Example: > |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2805 function Something(a = 10, b = 20, c = 30) |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2806 endfunction |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2807 call Something(1, v:none, 3) " b = 20 |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2808 < |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2809 *E989* |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2810 Optional arguments with default expressions must occur after any mandatory |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2811 arguments. You can use "..." after all optional named arguments. |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2812 |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2813 It is possible for later argument defaults to refer to prior arguments, |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2814 but not the other way around. They must be prefixed with "a:", as with all |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2815 arguments. |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2816 |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2817 Example that works: > |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2818 :function Okay(mandatory, optional = a:mandatory) |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2819 :endfunction |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2820 Example that does NOT work: > |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2821 :function NoGood(first = a:second, second = 10) |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2822 :endfunction |
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2823 < |
19968 | 2824 When not using "...", the number of arguments in a function call must be at |
2825 least equal to the number of mandatory named arguments. When using "...", the | |
2826 number of arguments may be larger than the total of mandatory and optional | |
2827 arguments. | |
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
2828 |
133 | 2829 *local-variables* |
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
2830 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
|
2831 function returns. Global variables need to be accessed with "g:". |
7 | 2832 |
2833 Example: > | |
2834 :function Table(title, ...) | |
2835 : echohl Title | |
2836 : echo a:title | |
2837 : echohl None | |
27903 | 2838 : echo a:0 .. " items:" |
140 | 2839 : for s in a:000 |
27903 | 2840 : echon ' ' .. s |
140 | 2841 : endfor |
7 | 2842 :endfunction |
2843 | |
2844 This function can then be called with: > | |
140 | 2845 call Table("Table", "line1", "line2") |
2846 call Table("Empty Table") | |
7 | 2847 |
1156 | 2848 To return more than one value, return a |List|: > |
2849 :function Compute(n1, n2) | |
7 | 2850 : if a:n2 == 0 |
1156 | 2851 : return ["fail", 0] |
7 | 2852 : endif |
1156 | 2853 : return ["ok", a:n1 / a:n2] |
7 | 2854 :endfunction |
2855 | |
2856 This function can then be called with: > | |
1156 | 2857 :let [success, div] = Compute(102, 6) |
7 | 2858 :if success == "ok" |
2859 : echo div | |
2860 :endif | |
1156 | 2861 < |
27321 | 2862 *:cal* *:call* *E107* |
7 | 2863 :[range]cal[l] {name}([arguments]) |
2864 Call a function. The name of the function and its arguments | |
16808 | 2865 are as specified with `:function`. Up to 20 arguments can be |
1156 | 2866 used. The returned value is discarded. |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2867 In |Vim9| script using `:call` is optional, these two lines do |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2868 the same thing: > |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2869 call SomeFunc(arg) |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2870 SomeFunc(arg) |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
2871 < Without a range and for functions that accept a range, the |
7 | 2872 function is called once. When a range is given the cursor is |
2873 positioned at the start of the first line before executing the | |
2874 function. | |
2875 When a range is given and the function doesn't handle it | |
2876 itself, the function is executed for each line in the range, | |
2877 with the cursor in the first column of that line. The cursor | |
2878 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
|
2879 call). The arguments are re-evaluated for each line. Thus |
7 | 2880 this works: |
2881 *function-range-example* > | |
2882 :function Mynumber(arg) | |
27903 | 2883 : echo line(".") .. " " .. a:arg |
7 | 2884 :endfunction |
2885 :1,5call Mynumber(getline(".")) | |
2886 < | |
2887 The "a:firstline" and "a:lastline" are defined anyway, they | |
2888 can be used to do something different at the start or end of | |
2889 the range. | |
2890 | |
2891 Example of a function that handles the range itself: > | |
2892 | |
2893 :function Cont() range | |
27903 | 2894 : execute (a:firstline + 1) .. "," .. a:lastline .. 's/^/\t\\ ' |
7 | 2895 :endfunction |
2896 :4,8call Cont() | |
2897 < | |
2898 This function inserts the continuation character "\" in front | |
2899 of all the lines in the range, except the first one. | |
2900 | |
1156 | 2901 When the function returns a composite value it can be further |
2902 dereferenced, but the range will not be used then. Example: > | |
2903 :4,8call GetDict().method() | |
2904 < Here GetDict() gets the range but method() does not. | |
2905 | |
27321 | 2906 *E117* |
2907 When a function cannot be found the error "E117: Unknown function" will be | |
2908 given. If the function was using an autoload path or an autoload import and | |
2909 the script is a |Vim9| script, this may also be caused by the function not | |
2910 being exported. | |
2911 | |
7 | 2912 *E132* |
2913 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
2914 option. | |
2915 | |
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
2916 It is also possible to use `:eval`. It does not support a range, but does |
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
2917 allow for method chaining, e.g.: > |
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
2918 eval GetList()->Filter()->append('$') |
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
2919 |
17667 | 2920 A function can also be called as part of evaluating an expression or when it |
2921 is used as a method: > | |
2922 let x = GetList() | |
2923 let y = GetList()->Filter() | |
2924 | |
161 | 2925 |
2926 AUTOMATICALLY LOADING FUNCTIONS ~ | |
7 | 2927 *autoload-functions* |
2928 When using many or large functions, it's possible to automatically define them | |
161 | 2929 only when they are used. There are two methods: with an autocommand and with |
2930 the "autoload" directory in 'runtimepath'. | |
2931 | |
2932 | |
2933 Using an autocommand ~ | |
2934 | |
170 | 2935 This is introduced in the user manual, section |41.14|. |
2936 | |
161 | 2937 The autocommand is useful if you have a plugin that is a long Vim script file. |
16808 | 2938 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
|
2939 That makes Vim startup faster. The autocommand should then load the same file |
16808 | 2940 again, setting a variable to skip the `:finish` command. |
161 | 2941 |
2942 Use the FuncUndefined autocommand event with a pattern that matches the | |
2943 function(s) to be defined. Example: > | |
7 | 2944 |
2945 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
2946 | |
2947 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
2948 "BufNet". Also see |FuncUndefined|. | |
2949 | |
161 | 2950 |
2951 Using an autoload script ~ | |
168 | 2952 *autoload* *E746* |
170 | 2953 This is introduced in the user manual, section |41.15|. |
2954 | |
161 | 2955 Using a script in the "autoload" directory is simpler, but requires using |
2956 exactly the right file name. A function that can be autoloaded has a name | |
2957 like this: > | |
2958 | |
270 | 2959 :call filename#funcname() |
161 | 2960 |
20856 | 2961 These functions are always global, in Vim9 script "g:" needs to be used: > |
2962 :call g:filename#funcname() | |
2963 | |
161 | 2964 When such a function is called, and it is not defined yet, Vim will search the |
2965 "autoload" directories in 'runtimepath' for a script file called | |
2966 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
2967 then define the function like this: > | |
2968 | |
270 | 2969 function filename#funcname() |
161 | 2970 echo "Done!" |
2971 endfunction | |
2972 | |
530 | 2973 The file name and the name used before the # in the function must match |
161 | 2974 exactly, and the defined function must have the name exactly as it will be |
20856 | 2975 called. In Vim9 script the "g:" prefix must be used: > |
2976 function g:filename#funcname() | |
2977 | |
2978 or for a compiled function: > | |
2979 def g:filename#funcname() | |
161 | 2980 |
270 | 2981 It is possible to use subdirectories. Every # in the function name works like |
2982 a path separator. Thus when calling a function: > | |
2983 | |
2984 :call foo#bar#func() | |
161 | 2985 |
2986 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
2987 | |
168 | 2988 This also works when reading a variable that has not been set yet: > |
2989 | |
270 | 2990 :let l = foo#bar#lvar |
168 | 2991 |
557 | 2992 However, when the autoload script was already loaded it won't be loaded again |
2993 for an unknown variable. | |
2994 | |
168 | 2995 When assigning a value to such a variable nothing special happens. This can |
2996 be used to pass settings to the autoload script before it's loaded: > | |
2997 | |
270 | 2998 :let foo#bar#toggle = 1 |
2999 :call foo#bar#func() | |
168 | 3000 |
164 | 3001 Note that when you make a mistake and call a function that is supposed to be |
3002 defined in an autoload script, but the script doesn't actually define the | |
22723 | 3003 function, you will get an error message for the missing function. If you fix |
3004 the autoload script it won't be automatically loaded again. Either restart | |
3005 Vim or manually source the script. | |
168 | 3006 |
3007 Also note that if you have two script files, and one calls a function in the | |
1621 | 3008 other and vice versa, before the used function is defined, it won't work. |
168 | 3009 Avoid using the autoload functionality at the toplevel. |
161 | 3010 |
27804 | 3011 In |Vim9| script you will get error *E1263* if you define a function with |
3012 a "#" character in the name. You should use a name without "#" and use | |
3013 `:export`. | |
27321 | 3014 |
794 | 3015 Hint: If you distribute a bunch of scripts you can pack them together with the |
3016 |vimball| utility. Also read the user manual |distribute-script|. | |
3017 | |
7 | 3018 ============================================================================== |
3019 6. Curly braces names *curly-braces-names* | |
3020 | |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3021 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
|
3022 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
|
3023 wrapped in braces {} like this: > |
7 | 3024 my_{adjective}_variable |
3025 | |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3026 This only works in legacy Vim script, not in |Vim9| script. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3027 |
7 | 3028 When Vim encounters this, it evaluates the expression inside the braces, puts |
3029 that in place of the expression, and re-interprets the whole as a variable | |
3030 name. So in the above example, if the variable "adjective" was set to | |
3031 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
3032 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
3033 | |
3034 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
|
3035 value. For example, the statement > |
7 | 3036 echo my_{&background}_message |
3037 | |
3038 would output the contents of "my_dark_message" or "my_light_message" depending | |
3039 on the current value of 'background'. | |
3040 | |
3041 You can use multiple brace pairs: > | |
3042 echo my_{adverb}_{adjective}_message | |
3043 ..or even nest them: > | |
3044 echo my_{ad{end_of_word}}_message | |
3045 where "end_of_word" is either "verb" or "jective". | |
3046 | |
3047 However, the expression inside the braces must evaluate to a valid single | |
236 | 3048 variable name, e.g. this is invalid: > |
7 | 3049 :let foo='a + b' |
3050 :echo c{foo}d | |
3051 .. since the result of expansion is "ca + bd", which is not a variable name. | |
3052 | |
3053 *curly-braces-function-names* | |
3054 You can call and define functions by an evaluated name in a similar way. | |
3055 Example: > | |
3056 :let func_end='whizz' | |
3057 :call my_func_{func_end}(parameter) | |
3058 | |
3059 This would call the function "my_func_whizz(parameter)". | |
3060 | |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3061 This does NOT work: > |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3062 :let i = 3 |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3063 :let @{i} = '' " error |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3064 :echo @{i} " error |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3065 |
7 | 3066 ============================================================================== |
3067 7. Commands *expression-commands* | |
3068 | |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3069 Note: in |Vim9| script `:let` is not used. `:var` is used for variable |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3070 declarations and assignments do not use a command. |vim9-declaration| |
20856 | 3071 |
7 | 3072 :let {var-name} = {expr1} *:let* *E18* |
3073 Set internal variable {var-name} to the result of the | |
3074 expression {expr1}. The variable will get the type | |
3075 from the {expr}. If {var-name} didn't exist yet, it | |
3076 is created. | |
3077 | |
27459 | 3078 :let {var-name}[{idx}] = {expr1} *E689* *E1141* |
85 | 3079 Set a list item to the result of the expression |
3080 {expr1}. {var-name} must refer to a list and {idx} | |
3081 must be a valid index in that list. For nested list | |
3082 the index can be repeated. | |
1621 | 3083 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
|
3084 This cannot be used to set a byte in a String. You |
1621 | 3085 can do that like this: > |
27903 | 3086 :let var = var[0:2] .. 'X' .. var[4:] |
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
3087 < When {var-name} is a |Blob| then {idx} can be the |
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
3088 length of the blob, in which case one byte is |
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
3089 appended. |
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
3090 |
27537 | 3091 *E711* *E719* *E1165* *E1166* *E1183* |
114 | 3092 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* |
685 | 3093 Set a sequence of items in a |List| to the result of |
3094 the expression {expr1}, which must be a list with the | |
87 | 3095 correct number of items. |
3096 {idx1} can be omitted, zero is used instead. | |
3097 {idx2} can be omitted, meaning the end of the list. | |
3098 When the selected range of items is partly past the | |
3099 end of the list, items will be added. | |
3100 | |
27321 | 3101 *:let+=* *:let-=* *:letstar=* *:let/=* *:let%=* |
3102 *:let.=* *:let..=* *E734* *E985* *E1019* | |
114 | 3103 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
3104 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
15790
05d836c8f1c4
patch 8.1.0902: incomplete set of assignment operators
Bram Moolenaar <Bram@vim.org>
parents:
15774
diff
changeset
|
3105 :let {var} *= {expr1} Like ":let {var} = {var} * {expr1}". |
05d836c8f1c4
patch 8.1.0902: incomplete set of assignment operators
Bram Moolenaar <Bram@vim.org>
parents:
15774
diff
changeset
|
3106 :let {var} /= {expr1} Like ":let {var} = {var} / {expr1}". |
05d836c8f1c4
patch 8.1.0902: incomplete set of assignment operators
Bram Moolenaar <Bram@vim.org>
parents:
15774
diff
changeset
|
3107 :let {var} %= {expr1} Like ":let {var} = {var} % {expr1}". |
114 | 3108 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". |
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
3109 :let {var} ..= {expr1} Like ":let {var} = {var} .. {expr1}". |
114 | 3110 These fail if {var} was not set yet and when the type |
3111 of {var} and {expr1} don't fit the operator. | |
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
3112 `.=` is not supported with Vim script version 2 and |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
3113 later, see |vimscript-version|. |
114 | 3114 |
3115 | |
7 | 3116 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
3117 Set environment variable {env-name} to the result of | |
3118 the expression {expr1}. The type is always String. | |
17758 | 3119 |
3120 On some systems making an environment variable empty | |
3121 causes it to be deleted. Many systems do not make a | |
3122 difference between an environment variable that is not | |
3123 set and an environment variable that is empty. | |
3124 | |
114 | 3125 :let ${env-name} .= {expr1} |
3126 Append {expr1} to the environment variable {env-name}. | |
3127 If the environment variable didn't exist yet this | |
3128 works like "=". | |
7 | 3129 |
3130 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
3131 Write the result of the expression {expr1} in register | |
3132 {reg-name}. {reg-name} must be a single letter, and | |
3133 must be the name of a writable register (see | |
3134 |registers|). "@@" can be used for the unnamed | |
3135 register, "@/" for the search pattern. | |
3136 If the result of {expr1} ends in a <CR> or <NL>, the | |
3137 register will be linewise, otherwise it will be set to | |
3138 characterwise. | |
3139 This can be used to clear the last search pattern: > | |
3140 :let @/ = "" | |
3141 < This is different from searching for an empty string, | |
3142 that would match everywhere. | |
3143 | |
114 | 3144 :let @{reg-name} .= {expr1} |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3145 Append {expr1} to register {reg-name}. If the |
114 | 3146 register was empty it's like setting it to {expr1}. |
3147 | |
1156 | 3148 :let &{option-name} = {expr1} *:let-option* *:let-&* |
7 | 3149 Set option {option-name} to the result of the |
68 | 3150 expression {expr1}. A String or Number value is |
3151 always converted to the type of the option. | |
7 | 3152 For an option local to a window or buffer the effect |
3153 is just like using the |:set| command: both the local | |
555 | 3154 value and the global value are changed. |
68 | 3155 Example: > |
27903 | 3156 :let &path = &path .. ',/usr/local/include' |
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
3157 < This also works for terminal codes in the form t_xx. |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
3158 But only for alphanumerical names. Example: > |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
3159 :let &t_k1 = "\<Esc>[234;" |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
3160 < When the code does not exist yet it will be created as |
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
3161 a terminal key code, there is no error. |
7 | 3162 |
114 | 3163 :let &{option-name} .= {expr1} |
3164 For a string option: Append {expr1} to the value. | |
3165 Does not insert a comma like |:set+=|. | |
3166 | |
3167 :let &{option-name} += {expr1} | |
3168 :let &{option-name} -= {expr1} | |
3169 For a number or boolean option: Add or subtract | |
3170 {expr1}. | |
3171 | |
7 | 3172 :let &l:{option-name} = {expr1} |
114 | 3173 :let &l:{option-name} .= {expr1} |
3174 :let &l:{option-name} += {expr1} | |
3175 :let &l:{option-name} -= {expr1} | |
7 | 3176 Like above, but only set the local value of an option |
3177 (if there is one). Works like |:setlocal|. | |
3178 | |
3179 :let &g:{option-name} = {expr1} | |
114 | 3180 :let &g:{option-name} .= {expr1} |
3181 :let &g:{option-name} += {expr1} | |
3182 :let &g:{option-name} -= {expr1} | |
7 | 3183 Like above, but only set the global value of an option |
3184 (if there is one). Works like |:setglobal|. | |
27459 | 3185 *E1093* |
85 | 3186 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
685 | 3187 {expr1} must evaluate to a |List|. The first item in |
68 | 3188 the list is assigned to {name1}, the second item to |
3189 {name2}, etc. | |
3190 The number of names must match the number of items in | |
685 | 3191 the |List|. |
68 | 3192 Each name can be one of the items of the ":let" |
3193 command as mentioned above. | |
3194 Example: > | |
3195 :let [s, item] = GetItem(s) | |
114 | 3196 < Detail: {expr1} is evaluated first, then the |
3197 assignments are done in sequence. This matters if | |
3198 {name2} depends on {name1}. Example: > | |
3199 :let x = [0, 1] | |
3200 :let i = 0 | |
3201 :let [i, x[i]] = [1, 2] | |
3202 :echo x | |
3203 < The result is [0, 2]. | |
3204 | |
3205 :let [{name1}, {name2}, ...] .= {expr1} | |
3206 :let [{name1}, {name2}, ...] += {expr1} | |
3207 :let [{name1}, {name2}, ...] -= {expr1} | |
3208 Like above, but append/add/subtract the value for each | |
685 | 3209 |List| item. |
68 | 3210 |
19968 | 3211 :let [{name}, ..., ; {lastname}] = {expr1} *E452* |
685 | 3212 Like |:let-unpack| above, but the |List| may have more |
114 | 3213 items than there are names. A list of the remaining |
3214 items is assigned to {lastname}. If there are no | |
3215 remaining items {lastname} is set to an empty list. | |
68 | 3216 Example: > |
3217 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
3218 < | |
114 | 3219 :let [{name}, ..., ; {lastname}] .= {expr1} |
3220 :let [{name}, ..., ; {lastname}] += {expr1} | |
3221 :let [{name}, ..., ; {lastname}] -= {expr1} | |
3222 Like above, but append/add/subtract the value for each | |
685 | 3223 |List| item. |
2596 | 3224 |
17450
509542f1fffb
patch 8.1.1723: heredoc assignment has no room for new features
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
3225 *:let=<<* *:let-heredoc* |
27459 | 3226 *E990* *E991* *E172* *E221* *E1145* |
18343 | 3227 :let {var-name} =<< [trim] {endmarker} |
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
3228 text... |
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
3229 text... |
18343 | 3230 {endmarker} |
21093 | 3231 Set internal variable {var-name} to a |List| |
3232 containing the lines of text bounded by the string | |
21608
24cb89db078d
patch 8.2.1354: test 59 is old style
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
3233 {endmarker}. The lines of text is used as a |
24cb89db078d
patch 8.2.1354: test 59 is old style
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
3234 |literal-string|. |
18343 | 3235 {endmarker} must not contain white space. |
3236 {endmarker} cannot start with a lower case character. | |
3237 The last line should end only with the {endmarker} | |
3238 string without any other character. Watch out for | |
3239 white space after {endmarker}! | |
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
3240 |
17172
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
3241 Without "trim" any white space characters in the lines |
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
3242 of text are preserved. If "trim" is specified before |
18343 | 3243 {endmarker}, then indentation is stripped so you can |
3244 do: > | |
17172
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
3245 let text =<< trim END |
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
3246 if ok |
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
3247 echo 'done' |
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
3248 endif |
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
3249 END |
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
3250 < Results in: ["if ok", " echo 'done'", "endif"] |
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
3251 The marker must line up with "let" and the indentation |
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
3252 of the first line is removed from all the text lines. |
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
3253 Specifically: all the leading indentation exactly |
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
3254 matching the leading indentation of the first |
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
3255 non-empty text line is stripped from the input lines. |
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
3256 All leading indentation exactly matching the leading |
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
3257 indentation before `let` is stripped from the line |
18343 | 3258 containing {endmarker}. Note that the difference |
3259 between space and tab matters here. | |
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
3260 |
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
3261 If {var-name} didn't exist yet, it is created. |
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
3262 Cannot be followed by another command, but can be |
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
3263 followed by a comment. |
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
3264 |
18343 | 3265 To avoid line continuation to be applied, consider |
3266 adding 'C' to 'cpoptions': > | |
3267 set cpo+=C | |
3268 let var =<< END | |
3269 \ leading backslash | |
3270 END | |
3271 set cpo-=C | |
3272 < | |
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
3273 Examples: > |
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
3274 let var1 =<< END |
18343 | 3275 Sample text 1 |
3276 Sample text 2 | |
3277 Sample text 3 | |
3278 END | |
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
3279 |
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
3280 let data =<< trim DATA |
18343 | 3281 1 2 3 4 |
3282 5 6 7 8 | |
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
3283 DATA |
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
3284 < |
2596 | 3285 *E121* |
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3286 :let {var-name} .. List the value of variable {var-name}. Multiple |
123 | 3287 variable names may be given. Special names recognized |
3288 here: *E738* | |
777 | 3289 g: global variables |
3290 b: local buffer variables | |
3291 w: local window variables | |
819 | 3292 t: local tab page variables |
777 | 3293 s: script-local variables |
3294 l: local function variables | |
123 | 3295 v: Vim variables. |
20856 | 3296 This does not work in Vim9 script. |vim9-declaration| |
7 | 3297 |
55 | 3298 :let List the values of all variables. The type of the |
3299 variable is indicated before the value: | |
3300 <nothing> String | |
3301 # Number | |
856 | 3302 * Funcref |
20856 | 3303 This does not work in Vim9 script. |vim9-declaration| |
7 | 3304 |
27321 | 3305 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* *E1081* |
148 | 3306 Remove the internal variable {name}. Several variable |
3307 names can be given, they are all removed. The name | |
685 | 3308 may also be a |List| or |Dictionary| item. |
7 | 3309 With [!] no error message is given for non-existing |
3310 variables. | |
685 | 3311 One or more items from a |List| can be removed: > |
108 | 3312 :unlet list[3] " remove fourth item |
3313 :unlet list[3:] " remove fourth item to last | |
685 | 3314 < One item from a |Dictionary| can be removed at a time: > |
108 | 3315 :unlet dict['two'] |
3316 :unlet dict.two | |
1668 | 3317 < This is especially useful to clean up used global |
3318 variables and script-local variables (these are not | |
3319 deleted when the script ends). Function-local | |
3320 variables are automatically deleted when the function | |
3321 ends. | |
7 | 3322 |
13923
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
3323 :unl[et] ${env-name} ... *:unlet-environment* *:unlet-$* |
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
3324 Remove environment variable {env-name}. |
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
3325 Can mix {name} and ${env-name} in one :unlet command. |
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
3326 No error message is given for a non-existing |
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
3327 variable, also without !. |
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
3328 If the system does not support deleting an environment |
17079
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3329 variable, it is made empty. |
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3330 |
27321 | 3331 *:cons* *:const* *E1018* |
17079
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3332 :cons[t] {var-name} = {expr1} |
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3333 :cons[t] [{name1}, {name2}, ...] = {expr1} |
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3334 :cons[t] [{name}, ..., ; {lastname}] = {expr1} |
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3335 :cons[t] {var-name} =<< [trim] {marker} |
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3336 text... |
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3337 text... |
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3338 {marker} |
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3339 Similar to |:let|, but additionally lock the variable |
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3340 after setting the value. This is the same as locking |
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3341 the variable with |:lockvar| just after |:let|, thus: > |
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3342 :const x = 1 |
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3343 < is equivalent to: > |
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3344 :let x = 1 |
21847
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
3345 :lockvar! x |
22298
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
3346 < NOTE: in Vim9 script `:const` works differently, see |
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
3347 |vim9-const| |
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
3348 This is useful if you want to make sure the variable |
21847
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
3349 is not modified. If the value is a List or Dictionary |
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
3350 literal then the items also cannot be changed: > |
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
3351 const ll = [1, 2, 3] |
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
3352 let ll[1] = 5 " Error! |
25880 | 3353 < Nested references are not locked: > |
21847
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
3354 let lvar = ['a'] |
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
3355 const lconst = [0, lvar] |
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
3356 let lconst[0] = 2 " Error! |
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
3357 let lconst[1][0] = 'b' " OK |
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
3358 < *E995* |
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
3359 |:const| does not allow to for changing a variable: > |
17079
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3360 :let x = 1 |
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
3361 :const x = 2 " Error! |
17109
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
3362 < *E996* |
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
3363 Note that environment variables, option values and |
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
3364 register values cannot be used here, since they cannot |
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
3365 be locked. |
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
3366 |
17433 | 3367 :cons[t] |
3368 :cons[t] {var-name} | |
3369 If no argument is given or only {var-name} is given, | |
3370 the behavior is the same as |:let|. | |
3371 | |
148 | 3372 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
3373 Lock the internal variable {name}. Locking means that | |
3374 it can no longer be changed (until it is unlocked). | |
3375 A locked variable can be deleted: > | |
3376 :lockvar v | |
24278 | 3377 :let v = 'asdf' " fails! |
3378 :unlet v " works | |
27459 | 3379 < *E741* *E940* *E1118* *E1119* *E1120* *E1121* *E1122* |
148 | 3380 If you try to change a locked variable you get an |
10908
6b6abffbdf59
patch 8.0.0343: b:changedtick can be unlocked
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
3381 error message: "E741: Value is locked: {name}". |
6b6abffbdf59
patch 8.0.0343: b:changedtick can be unlocked
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
3382 If you try to lock or unlock a built-in variable you |
6b6abffbdf59
patch 8.0.0343: b:changedtick can be unlocked
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
3383 get an error message: "E940: Cannot lock or unlock |
6b6abffbdf59
patch 8.0.0343: b:changedtick can be unlocked
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
3384 variable {name}". |
148 | 3385 |
685 | 3386 [depth] is relevant when locking a |List| or |
3387 |Dictionary|. It specifies how deep the locking goes: | |
22298
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
3388 0 Lock the variable {name} but not its |
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
3389 value. |
685 | 3390 1 Lock the |List| or |Dictionary| itself, |
148 | 3391 cannot add or remove items, but can |
3392 still change their values. | |
3393 2 Also lock the values, cannot change | |
685 | 3394 the items. If an item is a |List| or |
3395 |Dictionary|, cannot add or remove | |
148 | 3396 items, but can still change the |
3397 values. | |
685 | 3398 3 Like 2 but for the |List| / |
3399 |Dictionary| in the |List| / | |
3400 |Dictionary|, one level deeper. | |
3401 The default [depth] is 2, thus when {name} is a |List| | |
3402 or |Dictionary| the values cannot be changed. | |
22298
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
3403 |
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
3404 Example with [depth] 0: > |
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
3405 let mylist = [1, 2, 3] |
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
3406 lockvar 0 mylist |
25880 | 3407 let mylist[0] = 77 " OK |
3408 call add(mylist, 4] " OK | |
22298
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
3409 let mylist = [7, 8, 9] " Error! |
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
3410 < *E743* |
148 | 3411 For unlimited depth use [!] and omit [depth]. |
3412 However, there is a maximum depth of 100 to catch | |
3413 loops. | |
3414 | |
685 | 3415 Note that when two variables refer to the same |List| |
3416 and you lock one of them, the |List| will also be | |
819 | 3417 locked when used through the other variable. |
3418 Example: > | |
148 | 3419 :let l = [0, 1, 2, 3] |
3420 :let cl = l | |
3421 :lockvar l | |
3422 :let cl[1] = 99 " won't work! | |
3423 < You may want to make a copy of a list to avoid this. | |
3424 See |deepcopy()|. | |
3425 | |
3426 | |
27537 | 3427 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* *E1246* |
148 | 3428 Unlock the internal variable {name}. Does the |
3429 opposite of |:lockvar|. | |
3430 | |
16944 | 3431 :if {expr1} *:if* *:end* *:endif* *:en* *E171* *E579* *E580* |
28010 | 3432 :en[dif] Execute the commands until the next matching `:else` |
3433 or `:endif` if {expr1} evaluates to non-zero. | |
27903 | 3434 Although the short forms work, it is recommended to |
28010 | 3435 always use `:endif` to avoid confusion and to make |
3436 auto-indenting work properly. | |
7 | 3437 |
3438 From Vim version 4.5 until 5.0, every Ex command in | |
28010 | 3439 between the `:if` and `:endif` is ignored. These two |
7 | 3440 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
|
3441 backward compatible way. Nesting was allowed. Note |
28010 | 3442 that any `:else` or `:elseif` was ignored, the `else` |
7 | 3443 part was not executed either. |
3444 | |
3445 You can use this to remain compatible with older | |
3446 versions: > | |
3447 :if version >= 500 | |
3448 : version-5-specific-commands | |
3449 :endif | |
3450 < The commands still need to be parsed to find the | |
28010 | 3451 `endif`. Sometimes an older Vim has a problem with a |
3452 new command. For example, `:silent` is recognized as | |
3453 a `:substitute` command. In that case `:execute` can | |
7 | 3454 avoid problems: > |
3455 :if version >= 600 | |
3456 : execute "silent 1,$delete" | |
3457 :endif | |
3458 < | |
28010 | 3459 In |Vim9| script `:endif` cannot be shortened, to |
3460 improve script readability. | |
3461 NOTE: The `:append` and `:insert` commands don't work | |
3462 properly in between `:if` and `:endif`. | |
7 | 3463 |
3464 *:else* *:el* *E581* *E583* | |
28010 | 3465 :el[se] Execute the commands until the next matching `:else` |
3466 or `:endif` if they previously were not being | |
7 | 3467 executed. |
28010 | 3468 In |Vim9| script `:else` cannot be shortened, to |
3469 improve script readability. | |
7 | 3470 |
3471 *:elseif* *:elsei* *E582* *E584* | |
28010 | 3472 :elsei[f] {expr1} Short for `:else` `:if`, with the addition that there |
3473 is no extra `:endif`. | |
3474 In |Vim9| script `:elseif` cannot be shortened, to | |
3475 improve script readability. | |
7 | 3476 |
3477 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
114 | 3478 *E170* *E585* *E588* *E733* |
28010 | 3479 :endw[hile] Repeat the commands between `:while` and `:endwhile`, |
7 | 3480 as long as {expr1} evaluates to non-zero. |
3481 When an error is detected from a command inside the | |
28010 | 3482 loop, execution continues after the `endwhile`. |
75 | 3483 Example: > |
3484 :let lnum = 1 | |
3485 :while lnum <= line("$") | |
3486 :call FixLine(lnum) | |
3487 :let lnum = lnum + 1 | |
3488 :endwhile | |
3489 < | |
28010 | 3490 In |Vim9| script `:while` and `:endwhile` cannot be |
3491 shortened, to improve script readability. | |
3492 NOTE: The `:append` and `:insert` commands don't work | |
3493 properly inside a `:while` and `:for` loop. | |
75 | 3494 |
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
3495 :for {var} in {object} *:for* *E690* *E732* |
75 | 3496 :endfo[r] *:endfo* *:endfor* |
28010 | 3497 Repeat the commands between `:for` and `:endfor` for |
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
3498 each item in {object}. {object} can be a |List| or |
27537 | 3499 a |Blob|. *E1177* |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3500 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3501 Variable {var} is set to the value of each item. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3502 In |Vim9| script the loop variable must not have been |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3503 declared yet, unless when it is a |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3504 global/window/tab/buffer variable. |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3505 |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3506 When an error is detected for a command inside the |
28010 | 3507 loop, execution continues after the `endfor`. |
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
3508 Changing {object} inside the loop affects what items |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
3509 are used. Make a copy if this is unwanted: > |
79 | 3510 :for item in copy(mylist) |
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
3511 < |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3512 When {object} is a |List| and not making a copy, in |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3513 legacy script Vim stores a reference to the next item |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3514 in the |List| before executing the commands with the |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3515 current item. Thus the current item can be removed |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3516 without effect. Removing any later item means it will |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3517 not be found. Thus the following example works (an |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3518 inefficient way to make a |List| empty): > |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3519 for item in mylist |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3520 call remove(mylist, 0) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3521 endfor |
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
3522 < Note that reordering the |List| (e.g., with sort() or |
87 | 3523 reverse()) may have unexpected effects. |
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3524 In |Vim9| script the index is used. If an item before |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3525 the current one is deleted the next item will be |
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
3526 skipped. |
75 | 3527 |
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
3528 When {object} is a |Blob|, Vim always makes a copy to |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
3529 iterate over. Unlike with |List|, modifying the |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
3530 |Blob| does not affect the iteration. |
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
3531 |
28010 | 3532 In |Vim9| script `:endfor` cannot be shortened, to |
3533 improve script readability. | |
3534 | |
75 | 3535 :for [{var1}, {var2}, ...] in {listlist} |
27459 | 3536 :endfo[r] *E1140* |
28010 | 3537 Like `:for` above, but each item in {listlist} must be |
75 | 3538 a list, of which each item is assigned to {var1}, |
3539 {var2}, etc. Example: > | |
3540 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
3541 :echo getline(lnum)[col] | |
3542 :endfor | |
3543 < | |
7 | 3544 *:continue* *:con* *E586* |
28010 | 3545 :con[tinue] When used inside a `:while` or `:for` loop, jumps back |
75 | 3546 to the start of the loop. |
28010 | 3547 If it is used after a `:try` inside the loop but |
3548 before the matching `:finally` (if present), the | |
3549 commands following the `:finally` up to the matching | |
3550 `:endtry` are executed first. This process applies to | |
3551 all nested `:try`s inside the loop. The outermost | |
3552 `:endtry` then jumps back to the start of the loop. | |
3553 | |
3554 In |Vim9| script `:cont` is the shortest form, to | |
3555 improve script readability. | |
7 | 3556 *:break* *:brea* *E587* |
28010 | 3557 :brea[k] When used inside a `:while` or `:for` loop, skips to |
3558 the command after the matching `:endwhile` or | |
3559 `:endfor`. | |
3560 If it is used after a `:try` inside the loop but | |
3561 before the matching `:finally` (if present), the | |
3562 commands following the `:finally` up to the matching | |
3563 `:endtry` are executed first. This process applies to | |
3564 all nested `:try`s inside the loop. The outermost | |
3565 `:endtry` then jumps to the command after the loop. | |
3566 | |
3567 In |Vim9| script `:break` cannot be shortened, to | |
3568 improve script readability. | |
7 | 3569 |
27321 | 3570 :try *:try* *:endt* *:endtry* |
3571 *E600* *E601* *E602* *E1032* | |
7 | 3572 :endt[ry] Change the error handling for the commands between |
28010 | 3573 `:try` and `:endtry` including everything being |
3574 executed across `:source` commands, function calls, | |
7 | 3575 or autocommand invocations. |
3576 | |
3577 When an error or interrupt is detected and there is | |
28010 | 3578 a `:finally` command following, execution continues |
3579 after the `:finally`. Otherwise, or when the | |
3580 `:endtry` is reached thereafter, the next | |
3581 (dynamically) surrounding `:try` is checked for | |
3582 a corresponding `:finally` etc. Then the script | |
19523 | 3583 processing is terminated. Whether a function |
3584 definition has an "abort" argument does not matter. | |
7 | 3585 Example: > |
19523 | 3586 try | call Unknown() | finally | echomsg "cleanup" | endtry |
3587 echomsg "not reached" | |
7 | 3588 < |
3589 Moreover, an error or interrupt (dynamically) inside | |
28010 | 3590 `:try` and `:endtry` is converted to an exception. It |
3591 can be caught as if it were thrown by a `:throw` | |
3592 command (see `:catch`). In this case, the script | |
7 | 3593 processing is not terminated. |
3594 | |
3595 The value "Vim:Interrupt" is used for an interrupt | |
3596 exception. An error in a Vim command is converted | |
3597 to a value of the form "Vim({command}):{errmsg}", | |
3598 other errors are converted to a value of the form | |
3599 "Vim:{errmsg}". {command} is the full command name, | |
3600 and {errmsg} is the message that is displayed if the | |
3601 error exception is not caught, always beginning with | |
3602 the error number. | |
3603 Examples: > | |
19523 | 3604 try | sleep 100 | catch /^Vim:Interrupt$/ | endtry |
3605 try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
7 | 3606 < |
28010 | 3607 In |Vim9| script `:endtry` cannot be shortened, to |
3608 improve script readability. | |
3609 | |
27321 | 3610 *:cat* *:catch* |
3611 *E603* *E604* *E605* *E654* *E1033* | |
28010 | 3612 :cat[ch] /{pattern}/ The following commands until the next `:catch`, |
3613 `:finally`, or `:endtry` that belongs to the same | |
3614 `:try` as the `:catch` are executed when an exception | |
7 | 3615 matching {pattern} is being thrown and has not yet |
28010 | 3616 been caught by a previous `:catch`. Otherwise, these |
7 | 3617 commands are skipped. |
3618 When {pattern} is omitted all errors are caught. | |
3619 Examples: > | |
16019
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
3620 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) |
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
3621 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors |
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
3622 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts |
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
3623 :catch /^Vim(write):/ " catch all errors in :write |
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
3624 :catch /^Vim\%((\a\+)\)\=:E123:/ " catch error E123 |
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
3625 :catch /my-exception/ " catch user exception |
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
3626 :catch /.*/ " catch everything |
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
3627 :catch " same as /.*/ |
7 | 3628 < |
3629 Another character can be used instead of / around the | |
3630 {pattern}, so long as it does not have a special | |
3631 meaning (e.g., '|' or '"') and doesn't occur inside | |
27321 | 3632 {pattern}. *E1067* |
5814 | 3633 Information about the exception is available in |
3634 |v:exception|. Also see |throw-variables|. | |
7 | 3635 NOTE: It is not reliable to ":catch" the TEXT of |
3636 an error message because it may vary in different | |
3637 locales. | |
28010 | 3638 In |Vim9| script `:catch` cannot be shortened, to |
3639 improve script readability. | |
7 | 3640 |
3641 *:fina* *:finally* *E606* *E607* | |
28010 | 3642 :fina[lly] The following commands until the matching `:endtry` |
7 | 3643 are executed whenever the part between the matching |
28010 | 3644 `:try` and the `:finally` is left: either by falling |
3645 through to the `:finally` or by a `:continue`, | |
3646 `:break`, `:finish`, or `:return`, or by an error or | |
3647 interrupt or exception (see `:throw`). | |
3648 | |
3649 In |Vim9| script `:finally` cannot be shortened, to | |
3650 improve script readability and avoid confusion with | |
3651 `:final`. | |
7 | 3652 |
27459 | 3653 *:th* *:throw* *E608* *E1129* |
7 | 3654 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. |
28010 | 3655 If the ":throw" is used after a `:try` but before the |
3656 first corresponding `:catch`, commands are skipped | |
3657 until the first `:catch` matching {expr1} is reached. | |
3658 If there is no such `:catch` or if the ":throw" is | |
3659 used after a `:catch` but before the `:finally`, the | |
3660 commands following the `:finally` (if present) up to | |
3661 the matching `:endtry` are executed. If the `:throw` | |
3662 is after the `:finally`, commands up to the `:endtry` | |
7 | 3663 are skipped. At the ":endtry", this process applies |
28010 | 3664 again for the next dynamically surrounding `:try` |
7 | 3665 (which may be found in a calling function or sourcing |
28010 | 3666 script), until a matching `:catch` has been found. |
7 | 3667 If the exception is not caught, the command processing |
3668 is terminated. | |
3669 Example: > | |
3670 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
2725 | 3671 < Note that "catch" may need to be on a separate line |
3672 for when an error causes the parsing to skip the whole | |
3673 line and not see the "|" that separates the commands. | |
7 | 3674 |
28010 | 3675 In |Vim9| script `:throw` cannot be shortened, to |
3676 improve script readability. | |
3677 | |
7 | 3678 *:ec* *:echo* |
3679 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
3680 first {expr1} starts on a new line. | |
3681 Also see |:comment|. | |
3682 Use "\n" to start a new line. Use "\r" to move the | |
3683 cursor to the first column. | |
28010 | 3684 Uses the highlighting set by the `:echohl` command. |
7 | 3685 Cannot be followed by a comment. |
3686 Example: > | |
3687 :echo "the value of 'shell' is" &shell | |
1156 | 3688 < *:echo-redraw* |
3689 A later redraw may make the message disappear again. | |
3690 And since Vim mostly postpones redrawing until it's | |
3691 finished with a sequence of commands this happens | |
3692 quite often. To avoid that a command from before the | |
28010 | 3693 `:echo` causes a redraw afterwards (redraws are often |
1156 | 3694 postponed until you type something), force a redraw |
28010 | 3695 with the `:redraw` command. Example: > |
7 | 3696 :new | redraw | echo "there is a new window" |
3697 < | |
3698 *:echon* | |
3699 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
3700 |:comment|. | |
28010 | 3701 Uses the highlighting set by the `:echohl` command. |
7 | 3702 Cannot be followed by a comment. |
3703 Example: > | |
3704 :echon "the value of 'shell' is " &shell | |
3705 < | |
28010 | 3706 Note the difference between using `:echo`, which is a |
3707 Vim command, and `:!echo`, which is an external shell | |
7 | 3708 command: > |
3709 :!echo % --> filename | |
3710 < The arguments of ":!" are expanded, see |:_%|. > | |
3711 :!echo "%" --> filename or "filename" | |
3712 < Like the previous example. Whether you see the double | |
3713 quotes or not depends on your 'shell'. > | |
3714 :echo % --> nothing | |
3715 < The '%' is an illegal character in an expression. > | |
3716 :echo "%" --> % | |
3717 < This just echoes the '%' character. > | |
3718 :echo expand("%") --> filename | |
3719 < This calls the expand() function to expand the '%'. | |
3720 | |
3721 *:echoh* *:echohl* | |
3722 :echoh[l] {name} Use the highlight group {name} for the following | |
28010 | 3723 `:echo`, `:echon` and `:echomsg` commands. Also used |
3724 for the `input()` prompt. Example: > | |
7 | 3725 :echohl WarningMsg | echo "Don't panic!" | echohl None |
3726 < Don't forget to set the group back to "None", | |
3727 otherwise all following echo's will be highlighted. | |
3728 | |
3729 *:echom* *:echomsg* | |
3730 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
3731 message in the |message-history|. | |
3732 Spaces are placed between the arguments as with the | |
28010 | 3733 `:echo` command. But unprintable characters are |
7 | 3734 displayed, not interpreted. |
28010 | 3735 The parsing works slightly different from `:echo`, |
3736 more like `:execute`. All the expressions are first | |
1156 | 3737 evaluated and concatenated before echoing anything. |
15219
dada0b389d4f
patch 8.1.0619: :echomsg and :echoerr do not handle List and Dict
Bram Moolenaar <Bram@vim.org>
parents:
15209
diff
changeset
|
3738 If expressions does not evaluate to a Number or |
dada0b389d4f
patch 8.1.0619: :echomsg and :echoerr do not handle List and Dict
Bram Moolenaar <Bram@vim.org>
parents:
15209
diff
changeset
|
3739 String, string() is used to turn it into a string. |
28010 | 3740 Uses the highlighting set by the `:echohl` command. |
7 | 3741 Example: > |
3742 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
1156 | 3743 < See |:echo-redraw| to avoid the message disappearing |
3744 when the screen is redrawn. | |
7 | 3745 *:echoe* *:echoerr* |
3746 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
3747 message in the |message-history|. When used in a | |
3748 script or function the line number will be added. | |
3749 Spaces are placed between the arguments as with the | |
28010 | 3750 `:echomsg` command. When used inside a try conditional, |
7 | 3751 the message is raised as an error exception instead |
3752 (see |try-echoerr|). | |
3753 Example: > | |
3754 :echoerr "This script just failed!" | |
28010 | 3755 < If you just want a highlighted message use `:echohl`. |
7 | 3756 And to get a beep: > |
3757 :exe "normal \<Esc>" | |
24194
9f64c420f280
patch 8.2.2638: cannot write a message to the terminal from the GUI
Bram Moolenaar <Bram@vim.org>
parents:
24132
diff
changeset
|
3758 |
9f64c420f280
patch 8.2.2638: cannot write a message to the terminal from the GUI
Bram Moolenaar <Bram@vim.org>
parents:
24132
diff
changeset
|
3759 :echoc[onsole] {expr1} .. *:echoc* *:echoconsole* |
9f64c420f280
patch 8.2.2638: cannot write a message to the terminal from the GUI
Bram Moolenaar <Bram@vim.org>
parents:
24132
diff
changeset
|
3760 Intended for testing: works like `:echomsg` but when |
9f64c420f280
patch 8.2.2638: cannot write a message to the terminal from the GUI
Bram Moolenaar <Bram@vim.org>
parents:
24132
diff
changeset
|
3761 running in the GUI and started from a terminal write |
9f64c420f280
patch 8.2.2638: cannot write a message to the terminal from the GUI
Bram Moolenaar <Bram@vim.org>
parents:
24132
diff
changeset
|
3762 the text to stdout. |
9f64c420f280
patch 8.2.2638: cannot write a message to the terminal from the GUI
Bram Moolenaar <Bram@vim.org>
parents:
24132
diff
changeset
|
3763 |
18639 | 3764 *:eval* |
3765 :eval {expr} Evaluate {expr} and discard the result. Example: > | |
3766 :eval Getlist()->Filter()->append('$') | |
3767 | |
3768 < The expression is supposed to have a side effect, | |
3769 since the resulting value is not used. In the example | |
3770 the `append()` call appends the List with text to the | |
3771 buffer. This is similar to `:call` but works with any | |
3772 expression. | |
27537 | 3773 In |Vim9| script an expression without an effect will |
3774 result in error *E1207* . This should help noticing | |
3775 mistakes. | |
18639 | 3776 |
3777 The command can be shortened to `:ev` or `:eva`, but | |
3778 these are hard to recognize and therefore not to be | |
3779 used. | |
3780 | |
19523 | 3781 The command cannot be followed by "|" and another |
3782 command, since "|" is seen as part of the expression. | |
3783 | |
18639 | 3784 |
7 | 3785 *:exe* *:execute* |
3786 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
2152 | 3787 of {expr1} as an Ex command. |
3788 Multiple arguments are concatenated, with a space in | |
23466 | 3789 between. To avoid the extra space use the ".." |
2152 | 3790 operator to concatenate strings into one argument. |
3791 {expr1} is used as the processed command, command line | |
3792 editing keys are not recognized. | |
7 | 3793 Cannot be followed by a comment. |
3794 Examples: > | |
2152 | 3795 :execute "buffer" nextbuf |
24103 | 3796 :execute "normal" count .. "w" |
7 | 3797 < |
3798 ":execute" can be used to append a command to commands | |
3799 that don't accept a '|'. Example: > | |
3800 :execute '!ls' | echo "theend" | |
3801 | |
3802 < ":execute" is also a nice way to avoid having to type | |
3803 control characters in a Vim script for a ":normal" | |
3804 command: > | |
3805 :execute "normal ixxx\<Esc>" | |
3806 < This has an <Esc> character, see |expr-string|. | |
3807 | |
1621 | 3808 Be careful to correctly escape special characters in |
3809 file names. The |fnameescape()| function can be used | |
1661 | 3810 for Vim commands, |shellescape()| for |:!| commands. |
3811 Examples: > | |
24103 | 3812 :execute "e " .. fnameescape(filename) |
3813 :execute "!ls " .. shellescape(filename, 1) | |
1621 | 3814 < |
7 | 3815 Note: The executed string may be any command-line, but |
5763 | 3816 starting or ending "if", "while" and "for" does not |
3817 always work, because when commands are skipped the | |
3818 ":execute" is not evaluated and Vim loses track of | |
3819 where blocks start and end. Also "break" and | |
3820 "continue" should not be inside ":execute". | |
3821 This example does not work, because the ":execute" is | |
3822 not evaluated and Vim does not see the "while", and | |
3823 gives an error for finding an ":endwhile": > | |
3824 :if 0 | |
3825 : execute 'while i > 5' | |
3826 : echo "test" | |
3827 : endwhile | |
3828 :endif | |
7 | 3829 < |
3830 It is allowed to have a "while" or "if" command | |
3831 completely in the executed string: > | |
3832 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
3833 < | |
3834 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3835 *:exe-comment* |
7 | 3836 ":execute", ":echo" and ":echon" cannot be followed by |
3837 a comment directly, because they see the '"' as the | |
3838 start of a string. But, you can use '|' followed by a | |
3839 comment. Example: > | |
3840 :echo "foo" | "this is a comment | |
3841 | |
3842 ============================================================================== | |
3843 8. Exception handling *exception-handling* | |
3844 | |
3845 The Vim script language comprises an exception handling feature. This section | |
3846 explains how it can be used in a Vim script. | |
3847 | |
3848 Exceptions may be raised by Vim on an error or on interrupt, see | |
3849 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
3850 exception by using the ":throw" command, see |throw-catch|. | |
3851 | |
3852 | |
3853 TRY CONDITIONALS *try-conditionals* | |
3854 | |
3855 Exceptions can be caught or can cause cleanup code to be executed. You can | |
3856 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
3857 a finally clause (to be executed for cleanup). | |
3858 A try conditional begins with a |:try| command and ends at the matching | |
3859 |:endtry| command. In between, you can use a |:catch| command to start | |
3860 a catch clause, or a |:finally| command to start a finally clause. There may | |
3861 be none or multiple catch clauses, but there is at most one finally clause, | |
3862 which must not be followed by any catch clauses. The lines before the catch | |
3863 clauses and the finally clause is called a try block. > | |
3864 | |
3865 :try | |
1621 | 3866 : ... |
3867 : ... TRY BLOCK | |
3868 : ... | |
7 | 3869 :catch /{pattern}/ |
1621 | 3870 : ... |
3871 : ... CATCH CLAUSE | |
3872 : ... | |
7 | 3873 :catch /{pattern}/ |
1621 | 3874 : ... |
3875 : ... CATCH CLAUSE | |
3876 : ... | |
7 | 3877 :finally |
1621 | 3878 : ... |
3879 : ... FINALLY CLAUSE | |
3880 : ... | |
7 | 3881 :endtry |
3882 | |
3883 The try conditional allows to watch code for exceptions and to take the | |
3884 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
3885 from the try block and also the catch clauses may cause cleanup actions. | |
3886 When no exception is thrown during execution of the try block, the control | |
3887 is transferred to the finally clause, if present. After its execution, the | |
3888 script continues with the line following the ":endtry". | |
3889 When an exception occurs during execution of the try block, the remaining | |
3890 lines in the try block are skipped. The exception is matched against the | |
3891 patterns specified as arguments to the ":catch" commands. The catch clause | |
3892 after the first matching ":catch" is taken, other catch clauses are not | |
3893 executed. The catch clause ends when the next ":catch", ":finally", or | |
3894 ":endtry" command is reached - whatever is first. Then, the finally clause | |
3895 (if present) is executed. When the ":endtry" is reached, the script execution | |
3896 continues in the following line as usual. | |
3897 When an exception that does not match any of the patterns specified by the | |
3898 ":catch" commands is thrown in the try block, the exception is not caught by | |
3899 that try conditional and none of the catch clauses is executed. Only the | |
3900 finally clause, if present, is taken. The exception pends during execution of | |
3901 the finally clause. It is resumed at the ":endtry", so that commands after | |
3902 the ":endtry" are not executed and the exception might be caught elsewhere, | |
3903 see |try-nesting|. | |
3904 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
|
3905 remaining lines in that catch clause are not executed. The new exception is |
7 | 3906 not matched against the patterns in any of the ":catch" commands of the same |
3907 try conditional and none of its catch clauses is taken. If there is, however, | |
3908 a finally clause, it is executed, and the exception pends during its | |
3909 execution. The commands following the ":endtry" are not executed. The new | |
3910 exception might, however, be caught elsewhere, see |try-nesting|. | |
3911 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
|
3912 thrown, the remaining lines in the finally clause are skipped. If the finally |
7 | 3913 clause has been taken because of an exception from the try block or one of the |
3914 catch clauses, the original (pending) exception is discarded. The commands | |
3915 following the ":endtry" are not executed, and the exception from the finally | |
3916 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
3917 | |
3918 The finally clause is also executed, when a ":break" or ":continue" for | |
3919 a ":while" loop enclosing the complete try conditional is executed from the | |
3920 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
3921 from the try block or a catch clause of a try conditional in a function or | |
3922 sourced script, respectively. The ":break", ":continue", ":return", or | |
3923 ":finish" pends during execution of the finally clause and is resumed when the | |
3924 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
3925 from the finally clause. | |
3926 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
3927 try conditional or when a ":return" or ":finish" is encountered in the finally | |
3928 clause, the rest of the finally clause is skipped, and the ":break", | |
3929 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
3930 clause has been taken because of an exception or an earlier ":break", | |
3931 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
3932 this pending exception or command is discarded. | |
3933 | |
3934 For examples see |throw-catch| and |try-finally|. | |
3935 | |
3936 | |
3937 NESTING OF TRY CONDITIONALS *try-nesting* | |
3938 | |
3939 Try conditionals can be nested arbitrarily. That is, a complete try | |
3940 conditional can be put into the try block, a catch clause, or the finally | |
3941 clause of another try conditional. If the inner try conditional does not | |
3942 catch an exception thrown in its try block or throws a new exception from one | |
3943 of its catch clauses or its finally clause, the outer try conditional is | |
3944 checked according to the rules above. If the inner try conditional is in the | |
3945 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
|
3946 otherwise only the finally clause is executed. It does not matter for |
7 | 3947 nesting, whether the inner try conditional is directly contained in the outer |
3948 one, or whether the outer one sources a script or calls a function containing | |
3949 the inner try conditional. | |
3950 | |
3951 When none of the active try conditionals catches an exception, just their | |
3952 finally clauses are executed. Thereafter, the script processing terminates. | |
3953 An error message is displayed in case of an uncaught exception explicitly | |
3954 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
3955 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
3956 as usual. | |
3957 | |
3958 For examples see |throw-catch|. | |
3959 | |
3960 | |
3961 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
3962 | |
3963 Exception handling code can get tricky. If you are in doubt what happens, set | |
3964 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
3965 script file. Then you see when an exception is thrown, discarded, caught, or | |
3966 finished. When using a verbosity level of at least 14, things pending in | |
3967 a finally clause are also shown. This information is also given in debug mode | |
3968 (see |debug-scripts|). | |
3969 | |
3970 | |
3971 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
3972 | |
3973 You can throw any number or string as an exception. Use the |:throw| command | |
3974 and pass the value to be thrown as argument: > | |
3975 :throw 4711 | |
3976 :throw "string" | |
3977 < *throw-expression* | |
3978 You can also specify an expression argument. The expression is then evaluated | |
3979 first, and the result is thrown: > | |
3980 :throw 4705 + strlen("string") | |
3981 :throw strpart("strings", 0, 6) | |
3982 | |
3983 An exception might be thrown during evaluation of the argument of the ":throw" | |
3984 command. Unless it is caught there, the expression evaluation is abandoned. | |
3985 The ":throw" command then does not throw a new exception. | |
3986 Example: > | |
3987 | |
3988 :function! Foo(arg) | |
3989 : try | |
3990 : throw a:arg | |
3991 : catch /foo/ | |
3992 : endtry | |
3993 : return 1 | |
3994 :endfunction | |
3995 : | |
3996 :function! Bar() | |
3997 : echo "in Bar" | |
3998 : return 4710 | |
3999 :endfunction | |
4000 : | |
4001 :throw Foo("arrgh") + Bar() | |
4002 | |
4003 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
4004 executed. > | |
4005 :throw Foo("foo") + Bar() | |
4006 however displays "in Bar" and throws 4711. | |
4007 | |
4008 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
|
4009 abandoned by an (uncaught) exception during the expression evaluation. The |
7 | 4010 exception is then propagated to the caller of the command. |
4011 Example: > | |
4012 | |
4013 :if Foo("arrgh") | |
4014 : echo "then" | |
4015 :else | |
4016 : echo "else" | |
4017 :endif | |
4018 | |
4019 Here neither of "then" or "else" is displayed. | |
4020 | |
4021 *catch-order* | |
4022 Exceptions can be caught by a try conditional with one or more |:catch| | |
4023 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
4024 command can be specified as a pattern argument. The subsequent catch clause | |
4025 gets executed when a matching exception is caught. | |
4026 Example: > | |
4027 | |
4028 :function! Foo(value) | |
4029 : try | |
4030 : throw a:value | |
4031 : catch /^\d\+$/ | |
4032 : echo "Number thrown" | |
4033 : catch /.*/ | |
4034 : echo "String thrown" | |
4035 : endtry | |
4036 :endfunction | |
4037 : | |
4038 :call Foo(0x1267) | |
4039 :call Foo('string') | |
4040 | |
4041 The first call to Foo() displays "Number thrown", the second "String thrown". | |
4042 An exception is matched against the ":catch" commands in the order they are | |
4043 specified. Only the first match counts. So you should place the more | |
4044 specific ":catch" first. The following order does not make sense: > | |
4045 | |
4046 : catch /.*/ | |
4047 : echo "String thrown" | |
4048 : catch /^\d\+$/ | |
4049 : echo "Number thrown" | |
4050 | |
4051 The first ":catch" here matches always, so that the second catch clause is | |
4052 never taken. | |
4053 | |
4054 *throw-variables* | |
4055 If you catch an exception by a general pattern, you may access the exact value | |
4056 in the variable |v:exception|: > | |
4057 | |
4058 : catch /^\d\+$/ | |
4059 : echo "Number thrown. Value is" v:exception | |
4060 | |
4061 You may also be interested where an exception was thrown. This is stored in | |
4062 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
4063 exception most recently caught as long it is not finished. | |
4064 Example: > | |
4065 | |
4066 :function! Caught() | |
4067 : if v:exception != "" | |
27903 | 4068 : echo 'Caught "' . v:exception .. '" in ' .. v:throwpoint |
7 | 4069 : else |
4070 : echo 'Nothing caught' | |
4071 : endif | |
4072 :endfunction | |
4073 : | |
4074 :function! Foo() | |
4075 : try | |
4076 : try | |
4077 : try | |
4078 : throw 4711 | |
4079 : finally | |
4080 : call Caught() | |
4081 : endtry | |
4082 : catch /.*/ | |
4083 : call Caught() | |
4084 : throw "oops" | |
4085 : endtry | |
4086 : catch /.*/ | |
4087 : call Caught() | |
4088 : finally | |
4089 : call Caught() | |
4090 : endtry | |
4091 :endfunction | |
4092 : | |
4093 :call Foo() | |
4094 | |
4095 This displays > | |
4096 | |
4097 Nothing caught | |
4098 Caught "4711" in function Foo, line 4 | |
4099 Caught "oops" in function Foo, line 10 | |
4100 Nothing caught | |
4101 | |
4102 A practical example: The following command ":LineNumber" displays the line | |
4103 number in the script or function where it has been used: > | |
4104 | |
4105 :function! LineNumber() | |
4106 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
4107 :endfunction | |
4108 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
4109 < | |
4110 *try-nested* | |
4111 An exception that is not caught by a try conditional can be caught by | |
4112 a surrounding try conditional: > | |
4113 | |
4114 :try | |
4115 : try | |
4116 : throw "foo" | |
4117 : catch /foobar/ | |
4118 : echo "foobar" | |
4119 : finally | |
4120 : echo "inner finally" | |
4121 : endtry | |
4122 :catch /foo/ | |
4123 : echo "foo" | |
4124 :endtry | |
4125 | |
4126 The inner try conditional does not catch the exception, just its finally | |
4127 clause is executed. The exception is then caught by the outer try | |
4128 conditional. The example displays "inner finally" and then "foo". | |
4129 | |
4130 *throw-from-catch* | |
4131 You can catch an exception and throw a new one to be caught elsewhere from the | |
4132 catch clause: > | |
4133 | |
4134 :function! Foo() | |
4135 : throw "foo" | |
4136 :endfunction | |
4137 : | |
4138 :function! Bar() | |
4139 : try | |
4140 : call Foo() | |
4141 : catch /foo/ | |
4142 : echo "Caught foo, throw bar" | |
4143 : throw "bar" | |
4144 : endtry | |
4145 :endfunction | |
4146 : | |
4147 :try | |
4148 : call Bar() | |
4149 :catch /.*/ | |
4150 : echo "Caught" v:exception | |
4151 :endtry | |
4152 | |
4153 This displays "Caught foo, throw bar" and then "Caught bar". | |
4154 | |
4155 *rethrow* | |
4156 There is no real rethrow in the Vim script language, but you may throw | |
4157 "v:exception" instead: > | |
4158 | |
4159 :function! Bar() | |
4160 : try | |
4161 : call Foo() | |
4162 : catch /.*/ | |
4163 : echo "Rethrow" v:exception | |
4164 : throw v:exception | |
4165 : endtry | |
4166 :endfunction | |
4167 < *try-echoerr* | |
4168 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
4169 exceptions, because it is not possible to fake Vim internal exceptions. | |
4170 Trying so causes an error exception. You should throw your own exception | |
4171 denoting the situation. If you want to cause a Vim error exception containing | |
4172 the original error exception value, you can use the |:echoerr| command: > | |
4173 | |
4174 :try | |
4175 : try | |
4176 : asdf | |
4177 : catch /.*/ | |
4178 : echoerr v:exception | |
4179 : endtry | |
4180 :catch /.*/ | |
4181 : echo v:exception | |
4182 :endtry | |
4183 | |
4184 This code displays | |
4185 | |
1621 | 4186 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
7 | 4187 |
4188 | |
4189 CLEANUP CODE *try-finally* | |
4190 | |
4191 Scripts often change global settings and restore them at their end. If the | |
4192 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
|
4193 an inconsistent state. The same may happen to you in the development phase of |
7 | 4194 a script when an error occurs or you explicitly throw an exception without |
4195 catching it. You can solve these problems by using a try conditional with | |
4196 a finally clause for restoring the settings. Its execution is guaranteed on | |
4197 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
4198 (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
|
4199 to exceptions. When not caught, they terminate the script after the finally |
7 | 4200 clause has been executed.) |
4201 Example: > | |
4202 | |
4203 :try | |
4204 : let s:saved_ts = &ts | |
4205 : set ts=17 | |
4206 : | |
4207 : " Do the hard work here. | |
4208 : | |
4209 :finally | |
4210 : let &ts = s:saved_ts | |
4211 : unlet s:saved_ts | |
4212 :endtry | |
4213 | |
4214 This method should be used locally whenever a function or part of a script | |
4215 changes global settings which need to be restored on failure or normal exit of | |
4216 that function or script part. | |
4217 | |
4218 *break-finally* | |
4219 Cleanup code works also when the try block or a catch clause is left by | |
4220 a ":continue", ":break", ":return", or ":finish". | |
4221 Example: > | |
4222 | |
4223 :let first = 1 | |
4224 :while 1 | |
4225 : try | |
4226 : if first | |
4227 : echo "first" | |
4228 : let first = 0 | |
4229 : continue | |
4230 : else | |
4231 : throw "second" | |
4232 : endif | |
4233 : catch /.*/ | |
4234 : echo v:exception | |
4235 : break | |
4236 : finally | |
4237 : echo "cleanup" | |
4238 : endtry | |
4239 : echo "still in while" | |
4240 :endwhile | |
4241 :echo "end" | |
4242 | |
4243 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
4244 | |
4245 :function! Foo() | |
4246 : try | |
4247 : return 4711 | |
4248 : finally | |
4249 : echo "cleanup\n" | |
4250 : endtry | |
4251 : echo "Foo still active" | |
4252 :endfunction | |
4253 : | |
4254 :echo Foo() "returned by Foo" | |
4255 | |
4256 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
|
4257 extra ":return" in the finally clause. (Above all, this would override the |
7 | 4258 return value.) |
4259 | |
4260 *except-from-finally* | |
4261 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
4262 a finally clause is possible, but not recommended since it abandons the | |
4263 cleanup actions for the try conditional. But, of course, interrupt and error | |
4264 exceptions might get raised from a finally clause. | |
4265 Example where an error in the finally clause stops an interrupt from | |
4266 working correctly: > | |
4267 | |
4268 :try | |
4269 : try | |
4270 : echo "Press CTRL-C for interrupt" | |
4271 : while 1 | |
4272 : endwhile | |
4273 : finally | |
4274 : unlet novar | |
4275 : endtry | |
4276 :catch /novar/ | |
4277 :endtry | |
4278 :echo "Script still running" | |
4279 :sleep 1 | |
4280 | |
4281 If you need to put commands that could fail into a finally clause, you should | |
4282 think about catching or ignoring the errors in these commands, see | |
4283 |catch-errors| and |ignore-errors|. | |
4284 | |
4285 | |
4286 CATCHING ERRORS *catch-errors* | |
4287 | |
4288 If you want to catch specific errors, you just have to put the code to be | |
4289 watched in a try block and add a catch clause for the error message. The | |
4290 presence of the try conditional causes all errors to be converted to an | |
4291 exception. No message is displayed and |v:errmsg| is not set then. To find | |
4292 the right pattern for the ":catch" command, you have to know how the format of | |
4293 the error exception is. | |
4294 Error exceptions have the following format: > | |
4295 | |
4296 Vim({cmdname}):{errmsg} | |
4297 or > | |
4298 Vim:{errmsg} | |
4299 | |
4300 {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
|
4301 the command name is not known. {errmsg} is the error message usually produced |
7 | 4302 when the error occurs outside try conditionals. It always begins with |
4303 a capital "E", followed by a two or three-digit error number, a colon, and | |
4304 a space. | |
4305 | |
4306 Examples: | |
4307 | |
4308 The command > | |
4309 :unlet novar | |
4310 normally produces the error message > | |
4311 E108: No such variable: "novar" | |
4312 which is converted inside try conditionals to an exception > | |
4313 Vim(unlet):E108: No such variable: "novar" | |
4314 | |
4315 The command > | |
4316 :dwim | |
4317 normally produces the error message > | |
4318 E492: Not an editor command: dwim | |
4319 which is converted inside try conditionals to an exception > | |
4320 Vim:E492: Not an editor command: dwim | |
4321 | |
4322 You can catch all ":unlet" errors by a > | |
4323 :catch /^Vim(unlet):/ | |
4324 or all errors for misspelled command names by a > | |
4325 :catch /^Vim:E492:/ | |
4326 | |
4327 Some error messages may be produced by different commands: > | |
4328 :function nofunc | |
4329 and > | |
4330 :delfunction nofunc | |
4331 both produce the error message > | |
4332 E128: Function name must start with a capital: nofunc | |
4333 which is converted inside try conditionals to an exception > | |
4334 Vim(function):E128: Function name must start with a capital: nofunc | |
4335 or > | |
4336 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
4337 respectively. You can catch the error by its number independently on the | |
4338 command that caused it if you use the following pattern: > | |
4339 :catch /^Vim(\a\+):E128:/ | |
4340 | |
4341 Some commands like > | |
4342 :let x = novar | |
4343 produce multiple error messages, here: > | |
4344 E121: Undefined variable: novar | |
4345 E15: Invalid expression: novar | |
4346 Only the first is used for the exception value, since it is the most specific | |
4347 one (see |except-several-errors|). So you can catch it by > | |
4348 :catch /^Vim(\a\+):E121:/ | |
4349 | |
4350 You can catch all errors related to the name "nofunc" by > | |
4351 :catch /\<nofunc\>/ | |
4352 | |
4353 You can catch all Vim errors in the ":write" and ":read" commands by > | |
4354 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
4355 | |
4356 You can catch all Vim errors by the pattern > | |
4357 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
4358 < | |
4359 *catch-text* | |
4360 NOTE: You should never catch the error message text itself: > | |
4361 :catch /No such variable/ | |
6647 | 4362 only works in the English locale, but not when the user has selected |
7 | 4363 a different language by the |:language| command. It is however helpful to |
4364 cite the message text in a comment: > | |
4365 :catch /^Vim(\a\+):E108:/ " No such variable | |
4366 | |
4367 | |
4368 IGNORING ERRORS *ignore-errors* | |
4369 | |
4370 You can ignore errors in a specific Vim command by catching them locally: > | |
4371 | |
4372 :try | |
4373 : write | |
4374 :catch | |
4375 :endtry | |
4376 | |
4377 But you are strongly recommended NOT to use this simple form, since it could | |
4378 catch more than you want. With the ":write" command, some autocommands could | |
4379 be executed and cause errors not related to writing, for instance: > | |
4380 | |
4381 :au BufWritePre * unlet novar | |
4382 | |
4383 There could even be such errors you are not responsible for as a script | |
4384 writer: a user of your script might have defined such autocommands. You would | |
4385 then hide the error from the user. | |
4386 It is much better to use > | |
4387 | |
4388 :try | |
4389 : write | |
4390 :catch /^Vim(write):/ | |
4391 :endtry | |
4392 | |
4393 which only catches real write errors. So catch only what you'd like to ignore | |
4394 intentionally. | |
4395 | |
4396 For a single command that does not cause execution of autocommands, you could | |
4397 even suppress the conversion of errors to exceptions by the ":silent!" | |
4398 command: > | |
4399 :silent! nunmap k | |
4400 This works also when a try conditional is active. | |
4401 | |
4402 | |
4403 CATCHING INTERRUPTS *catch-interrupt* | |
4404 | |
4405 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
|
4406 the exception "Vim:Interrupt". You can catch it like every exception. The |
7 | 4407 script is not terminated, then. |
4408 Example: > | |
4409 | |
4410 :function! TASK1() | |
4411 : sleep 10 | |
4412 :endfunction | |
4413 | |
4414 :function! TASK2() | |
4415 : sleep 20 | |
4416 :endfunction | |
4417 | |
4418 :while 1 | |
4419 : let command = input("Type a command: ") | |
4420 : try | |
4421 : if command == "" | |
4422 : continue | |
4423 : elseif command == "END" | |
4424 : break | |
4425 : elseif command == "TASK1" | |
4426 : call TASK1() | |
4427 : elseif command == "TASK2" | |
4428 : call TASK2() | |
4429 : else | |
4430 : echo "\nIllegal command:" command | |
4431 : continue | |
4432 : endif | |
4433 : catch /^Vim:Interrupt$/ | |
4434 : echo "\nCommand interrupted" | |
4435 : " Caught the interrupt. Continue with next prompt. | |
4436 : endtry | |
4437 :endwhile | |
4438 | |
4439 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
|
4440 a new command. If you press CTRL-C at the prompt, the script is terminated. |
7 | 4441 |
4442 For testing what happens when CTRL-C would be pressed on a specific line in | |
4443 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
4444 command on that line. See |debug-scripts|. | |
4445 | |
4446 | |
4447 CATCHING ALL *catch-all* | |
4448 | |
4449 The commands > | |
4450 | |
4451 :catch /.*/ | |
4452 :catch // | |
4453 :catch | |
4454 | |
4455 catch everything, error exceptions, interrupt exceptions and exceptions | |
4456 explicitly thrown by the |:throw| command. This is useful at the top level of | |
4457 a script in order to catch unexpected things. | |
4458 Example: > | |
4459 | |
4460 :try | |
4461 : | |
4462 : " do the hard work here | |
4463 : | |
4464 :catch /MyException/ | |
4465 : | |
4466 : " handle known problem | |
4467 : | |
4468 :catch /^Vim:Interrupt$/ | |
4469 : echo "Script interrupted" | |
4470 :catch /.*/ | |
27903 | 4471 : echo "Internal error (" .. v:exception .. ")" |
4472 : echo " - occurred at " .. v:throwpoint | |
7 | 4473 :endtry |
4474 :" end of script | |
4475 | |
4476 Note: Catching all might catch more things than you want. Thus, you are | |
4477 strongly encouraged to catch only for problems that you can really handle by | |
4478 specifying a pattern argument to the ":catch". | |
4479 Example: Catching all could make it nearly impossible to interrupt a script | |
4480 by pressing CTRL-C: > | |
4481 | |
4482 :while 1 | |
4483 : try | |
4484 : sleep 1 | |
4485 : catch | |
4486 : endtry | |
4487 :endwhile | |
4488 | |
4489 | |
4490 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
4491 | |
4492 Exceptions may be used during execution of autocommands. Example: > | |
4493 | |
4494 :autocmd User x try | |
4495 :autocmd User x throw "Oops!" | |
4496 :autocmd User x catch | |
4497 :autocmd User x echo v:exception | |
4498 :autocmd User x endtry | |
4499 :autocmd User x throw "Arrgh!" | |
4500 :autocmd User x echo "Should not be displayed" | |
4501 : | |
4502 :try | |
4503 : doautocmd User x | |
4504 :catch | |
4505 : echo v:exception | |
4506 :endtry | |
4507 | |
4508 This displays "Oops!" and "Arrgh!". | |
4509 | |
4510 *except-autocmd-Pre* | |
4511 For some commands, autocommands get executed before the main action of the | |
4512 command takes place. If an exception is thrown and not caught in the sequence | |
4513 of autocommands, the sequence and the command that caused its execution are | |
4514 abandoned and the exception is propagated to the caller of the command. | |
4515 Example: > | |
4516 | |
4517 :autocmd BufWritePre * throw "FAIL" | |
4518 :autocmd BufWritePre * echo "Should not be displayed" | |
4519 : | |
4520 :try | |
4521 : write | |
4522 :catch | |
4523 : echo "Caught:" v:exception "from" v:throwpoint | |
4524 :endtry | |
4525 | |
4526 Here, the ":write" command does not write the file currently being edited (as | |
4527 you can see by checking 'modified'), since the exception from the BufWritePre | |
4528 autocommand abandons the ":write". The exception is then caught and the | |
4529 script displays: > | |
4530 | |
4531 Caught: FAIL from BufWrite Auto commands for "*" | |
4532 < | |
4533 *except-autocmd-Post* | |
4534 For some commands, autocommands get executed after the main action of the | |
4535 command has taken place. If this main action fails and the command is inside | |
4536 an active try conditional, the autocommands are skipped and an error exception | |
4537 is thrown that can be caught by the caller of the command. | |
4538 Example: > | |
4539 | |
4540 :autocmd BufWritePost * echo "File successfully written!" | |
4541 : | |
4542 :try | |
4543 : write /i/m/p/o/s/s/i/b/l/e | |
4544 :catch | |
4545 : echo v:exception | |
4546 :endtry | |
4547 | |
4548 This just displays: > | |
4549 | |
4550 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
4551 | |
4552 If you really need to execute the autocommands even when the main action | |
4553 fails, trigger the event from the catch clause. | |
4554 Example: > | |
4555 | |
4556 :autocmd BufWritePre * set noreadonly | |
4557 :autocmd BufWritePost * set readonly | |
4558 : | |
4559 :try | |
4560 : write /i/m/p/o/s/s/i/b/l/e | |
4561 :catch | |
4562 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
4563 :endtry | |
4564 < | |
4565 You can also use ":silent!": > | |
4566 | |
4567 :let x = "ok" | |
4568 :let v:errmsg = "" | |
4569 :autocmd BufWritePost * if v:errmsg != "" | |
4570 :autocmd BufWritePost * let x = "after fail" | |
4571 :autocmd BufWritePost * endif | |
4572 :try | |
4573 : silent! write /i/m/p/o/s/s/i/b/l/e | |
4574 :catch | |
4575 :endtry | |
4576 :echo x | |
4577 | |
4578 This displays "after fail". | |
4579 | |
4580 If the main action of the command does not fail, exceptions from the | |
4581 autocommands will be catchable by the caller of the command: > | |
4582 | |
4583 :autocmd BufWritePost * throw ":-(" | |
4584 :autocmd BufWritePost * echo "Should not be displayed" | |
4585 : | |
4586 :try | |
4587 : write | |
4588 :catch | |
4589 : echo v:exception | |
4590 :endtry | |
4591 < | |
4592 *except-autocmd-Cmd* | |
4593 For some commands, the normal action can be replaced by a sequence of | |
4594 autocommands. Exceptions from that sequence will be catchable by the caller | |
4595 of the command. | |
4596 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
|
4597 had actually been written when the exception occurred. You need to tell it in |
7 | 4598 some way. > |
4599 | |
4600 :if !exists("cnt") | |
4601 : let cnt = 0 | |
4602 : | |
4603 : autocmd BufWriteCmd * if &modified | |
4604 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
4605 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
4606 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
4607 : autocmd BufWriteCmd * endif | |
4608 : autocmd BufWriteCmd * write | set nomodified | |
4609 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
4610 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
4611 : autocmd BufWriteCmd * endif | |
4612 : autocmd BufWriteCmd * echo "File successfully written!" | |
4613 : autocmd BufWriteCmd * endif | |
4614 :endif | |
4615 : | |
4616 :try | |
4617 : write | |
4618 :catch /^BufWriteCmdError$/ | |
4619 : if &modified | |
4620 : echo "Error on writing (file contents not changed)" | |
4621 : else | |
4622 : echo "Error after writing" | |
4623 : endif | |
4624 :catch /^Vim(write):/ | |
4625 : echo "Error on writing" | |
4626 :endtry | |
4627 | |
4628 When this script is sourced several times after making changes, it displays | |
4629 first > | |
4630 File successfully written! | |
4631 then > | |
4632 Error on writing (file contents not changed) | |
4633 then > | |
4634 Error after writing | |
4635 etc. | |
4636 | |
4637 *except-autocmd-ill* | |
4638 You cannot spread a try conditional over autocommands for different events. | |
4639 The following code is ill-formed: > | |
4640 | |
4641 :autocmd BufWritePre * try | |
4642 : | |
4643 :autocmd BufWritePost * catch | |
4644 :autocmd BufWritePost * echo v:exception | |
4645 :autocmd BufWritePost * endtry | |
4646 : | |
4647 :write | |
4648 | |
4649 | |
4650 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
4651 | |
4652 Some programming languages allow to use hierarchies of exception classes or to | |
4653 pass additional information with the object of an exception class. You can do | |
4654 similar things in Vim. | |
4655 In order to throw an exception from a hierarchy, just throw the complete | |
4656 class name with the components separated by a colon, for instance throw the | |
4657 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
4658 When you want to pass additional information with your exception class, add | |
4659 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
4660 for an error when writing "myfile". | |
4661 With the appropriate patterns in the ":catch" command, you can catch for | |
4662 base classes or derived classes of your hierarchy. Additional information in | |
4663 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
4664 Example: > | |
4665 | |
4666 :function! CheckRange(a, func) | |
4667 : if a:a < 0 | |
27903 | 4668 : throw "EXCEPT:MATHERR:RANGE(" .. a:func .. ")" |
7 | 4669 : endif |
4670 :endfunction | |
4671 : | |
4672 :function! Add(a, b) | |
4673 : call CheckRange(a:a, "Add") | |
4674 : call CheckRange(a:b, "Add") | |
4675 : let c = a:a + a:b | |
4676 : if c < 0 | |
4677 : throw "EXCEPT:MATHERR:OVERFLOW" | |
4678 : endif | |
4679 : return c | |
4680 :endfunction | |
4681 : | |
4682 :function! Div(a, b) | |
4683 : call CheckRange(a:a, "Div") | |
4684 : call CheckRange(a:b, "Div") | |
4685 : if (a:b == 0) | |
4686 : throw "EXCEPT:MATHERR:ZERODIV" | |
4687 : endif | |
4688 : return a:a / a:b | |
4689 :endfunction | |
4690 : | |
4691 :function! Write(file) | |
4692 : try | |
1621 | 4693 : execute "write" fnameescape(a:file) |
7 | 4694 : catch /^Vim(write):/ |
27903 | 4695 : throw "EXCEPT:IO(" .. getcwd() .. ", " .. a:file .. "):WRITEERR" |
7 | 4696 : endtry |
4697 :endfunction | |
4698 : | |
4699 :try | |
4700 : | |
4701 : " something with arithmetics and I/O | |
4702 : | |
4703 :catch /^EXCEPT:MATHERR:RANGE/ | |
4704 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
4705 : echo "Range error in" function | |
4706 : | |
4707 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
4708 : echo "Math error" | |
4709 : | |
4710 :catch /^EXCEPT:IO/ | |
4711 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
4712 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
4713 : if file !~ '^/' | |
27903 | 4714 : let file = dir .. "/" .. file |
7 | 4715 : endif |
27903 | 4716 : echo 'I/O error for "' .. file .. '"' |
7 | 4717 : |
4718 :catch /^EXCEPT/ | |
4719 : echo "Unspecified error" | |
4720 : | |
4721 :endtry | |
4722 | |
4723 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
4724 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
4725 exceptions with the "Vim" prefix; they are reserved for Vim. | |
4726 Vim error exceptions are parameterized with the name of the command that | |
4727 failed, if known. See |catch-errors|. | |
4728 | |
4729 | |
4730 PECULIARITIES | |
4731 *except-compat* | |
4732 The exception handling concept requires that the command sequence causing the | |
4733 exception is aborted immediately and control is transferred to finally clauses | |
4734 and/or a catch clause. | |
4735 | |
4736 In the Vim script language there are cases where scripts and functions | |
4737 continue after an error: in functions without the "abort" flag or in a command | |
4738 after ":silent!", control flow goes to the following line, and outside | |
4739 functions, control flow goes to the line following the outermost ":endwhile" | |
4740 or ":endif". On the other hand, errors should be catchable as exceptions | |
4741 (thus, requiring the immediate abortion). | |
4742 | |
4743 This problem has been solved by converting errors to exceptions and using | |
4744 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
|
4745 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
|
4746 be caught only from an active try conditional. If you want an immediate |
7 | 4747 termination without catching the error, just use a try conditional without |
4748 catch clause. (You can cause cleanup code being executed before termination | |
4749 by specifying a finally clause.) | |
4750 | |
4751 When no try conditional is active, the usual abortion and continuation | |
4752 behavior is used instead of immediate abortion. This ensures compatibility of | |
4753 scripts written for Vim 6.1 and earlier. | |
4754 | |
4755 However, when sourcing an existing script that does not use exception handling | |
4756 commands (or when calling one of its functions) from inside an active try | |
4757 conditional of a new script, you might change the control flow of the existing | |
4758 script on error. You get the immediate abortion on error and can catch the | |
4759 error in the new script. If however the sourced script suppresses error | |
4760 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
|
4761 |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
|
4762 not converted to an exception. (See |:silent|.) So the only remaining cause |
7 | 4763 where this happens is for scripts that don't care about errors and produce |
4764 error messages. You probably won't want to use such code from your new | |
4765 scripts. | |
4766 | |
4767 *except-syntax-err* | |
4768 Syntax errors in the exception handling commands are never caught by any of | |
4769 the ":catch" commands of the try conditional they belong to. Its finally | |
4770 clauses, however, is executed. | |
4771 Example: > | |
4772 | |
4773 :try | |
4774 : try | |
4775 : throw 4711 | |
4776 : catch /\(/ | |
4777 : echo "in catch with syntax error" | |
4778 : catch | |
4779 : echo "inner catch-all" | |
4780 : finally | |
4781 : echo "inner finally" | |
4782 : endtry | |
4783 :catch | |
27903 | 4784 : echo 'outer catch-all caught "' .. v:exception .. '"' |
7 | 4785 : finally |
4786 : echo "outer finally" | |
4787 :endtry | |
4788 | |
4789 This displays: > | |
4790 inner finally | |
4791 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
4792 outer finally | |
4793 The original exception is discarded and an error exception is raised, instead. | |
4794 | |
4795 *except-single-line* | |
4796 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
4797 a single line, but then syntax errors may make it difficult to recognize the | |
4798 "catch" line, thus you better avoid this. | |
4799 Example: > | |
4800 :try | unlet! foo # | catch | endtry | |
4801 raises an error exception for the trailing characters after the ":unlet!" | |
4802 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
4803 error exception is discarded and the "E488: Trailing characters" message gets | |
4804 displayed. | |
4805 | |
4806 *except-several-errors* | |
4807 When several errors appear in a single command, the first error message is | |
25402 | 4808 usually the most specific one and therefore converted to the error exception. |
7 | 4809 Example: > |
4810 echo novar | |
4811 causes > | |
4812 E121: Undefined variable: novar | |
4813 E15: Invalid expression: novar | |
4814 The value of the error exception inside try conditionals is: > | |
4815 Vim(echo):E121: Undefined variable: novar | |
4816 < *except-syntax-error* | |
4817 But when a syntax error is detected after a normal error in the same command, | |
4818 the syntax error is used for the exception being thrown. | |
4819 Example: > | |
4820 unlet novar # | |
4821 causes > | |
4822 E108: No such variable: "novar" | |
4823 E488: Trailing characters | |
4824 The value of the error exception inside try conditionals is: > | |
4825 Vim(unlet):E488: Trailing characters | |
4826 This is done because the syntax error might change the execution path in a way | |
4827 not intended by the user. Example: > | |
4828 try | |
4829 try | unlet novar # | catch | echo v:exception | endtry | |
4830 catch /.*/ | |
4831 echo "outer catch:" v:exception | |
4832 endtry | |
4833 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
4834 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
4835 | |
4836 ============================================================================== | |
4837 9. Examples *eval-examples* | |
4838 | |
1156 | 4839 Printing in Binary ~ |
7 | 4840 > |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4841 :" The function Nr2Bin() returns the binary string representation of a number. |
1156 | 4842 :func Nr2Bin(nr) |
7 | 4843 : let n = a:nr |
4844 : let r = "" | |
4845 : while n | |
27903 | 4846 : let r = '01'[n % 2] .. r |
1156 | 4847 : let n = n / 2 |
7 | 4848 : endwhile |
4849 : return r | |
4850 :endfunc | |
4851 | |
1156 | 4852 :" The function String2Bin() converts each character in a string to a |
4853 :" binary string, separated with dashes. | |
4854 :func String2Bin(str) | |
7 | 4855 : let out = '' |
1156 | 4856 : for ix in range(strlen(a:str)) |
27903 | 4857 : let out = out .. '-' .. Nr2Bin(char2nr(a:str[ix])) |
1156 | 4858 : endfor |
4859 : return out[1:] | |
7 | 4860 :endfunc |
4861 | |
4862 Example of its use: > | |
1156 | 4863 :echo Nr2Bin(32) |
4864 result: "100000" > | |
4865 :echo String2Bin("32") | |
4866 result: "110011-110010" | |
4867 | |
4868 | |
4869 Sorting lines ~ | |
4870 | |
4871 This example sorts lines with a specific compare function. > | |
4872 | |
4873 :func SortBuffer() | |
4874 : let lines = getline(1, '$') | |
4875 : call sort(lines, function("Strcmp")) | |
4876 : call setline(1, lines) | |
7 | 4877 :endfunction |
4878 | |
1156 | 4879 As a one-liner: > |
4880 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
4881 | |
4882 | |
4883 scanf() replacement ~ | |
7 | 4884 *sscanf* |
4885 There is no sscanf() function in Vim. If you need to extract parts from a | |
4886 line, you can use matchstr() and substitute() to do it. This example shows | |
4887 how to get the file name, line number and column number out of a line like | |
4888 "foobar.txt, 123, 45". > | |
4889 :" Set up the match bit | |
4890 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
4891 :"get the part matching the whole expression | |
4892 :let l = matchstr(line, mx) | |
4893 :"get each item out of the match | |
4894 :let file = substitute(l, mx, '\1', '') | |
4895 :let lnum = substitute(l, mx, '\2', '') | |
4896 :let col = substitute(l, mx, '\3', '') | |
4897 | |
4898 The input is in the variable "line", the results in the variables "file", | |
4899 "lnum" and "col". (idea from Michael Geddes) | |
4900 | |
1156 | 4901 |
4902 getting the scriptnames in a Dictionary ~ | |
4903 *scriptnames-dictionary* | |
4904 The |:scriptnames| command can be used to get a list of all script files that | |
4905 have been sourced. There is no equivalent function or variable for this | |
4906 (because it's rarely needed). In case you need to manipulate the list this | |
4907 code can be used: > | |
4908 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
4909 let scriptnames_output = '' | |
4910 redir => scriptnames_output | |
4911 silent scriptnames | |
4912 redir END | |
12785 | 4913 |
1621 | 4914 " Split the output into lines and parse each line. Add an entry to the |
1156 | 4915 " "scripts" dictionary. |
4916 let scripts = {} | |
4917 for line in split(scriptnames_output, "\n") | |
4918 " Only do non-blank lines. | |
4919 if line =~ '\S' | |
4920 " Get the first number in the line. | |
1621 | 4921 let nr = matchstr(line, '\d\+') |
1156 | 4922 " Get the file name, remove the script number " 123: ". |
1621 | 4923 let name = substitute(line, '.\+:\s*', '', '') |
1156 | 4924 " Add an item to the Dictionary |
1621 | 4925 let scripts[nr] = name |
1156 | 4926 endif |
4927 endfor | |
4928 unlet scriptnames_output | |
4929 | |
7 | 4930 ============================================================================== |
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4931 10. Vim script versions *vimscript-version* *vimscript-versions* |
16380 | 4932 *scriptversion* |
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4933 Over time many features have been added to Vim script. This includes Ex |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4934 commands, functions, variable types, etc. Each individual feature can be |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4935 checked with the |has()| and |exists()| functions. |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4936 |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4937 Sometimes old syntax of functionality gets in the way of making Vim better. |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4938 When support is taken away this will break older Vim scripts. To make this |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4939 explicit the |:scriptversion| command can be used. When a Vim script is not |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4940 compatible with older versions of Vim this will give an explicit error, |
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
4941 instead of failing in mysterious ways. |
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
4942 |
27537 | 4943 When using a legacy function, defined with `:function`, in |Vim9| script then |
4944 scriptversion 4 is used. | |
4945 | |
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
4946 *scriptversion-1* > |
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4947 :scriptversion 1 |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4948 < This is the original Vim script, same as not using a |:scriptversion| |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4949 command. Can be used to go back to old syntax for a range of lines. |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4950 Test for support with: > |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4951 has('vimscript-1') |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4952 |
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
4953 < *scriptversion-2* > |
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4954 :scriptversion 2 |
16808 | 4955 < String concatenation with "." is not supported, use ".." instead. |
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4956 This avoids the ambiguity using "." for Dict member access and |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4957 floating point numbers. Now ".5" means the number 0.5. |
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
4958 |
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
4959 *scriptversion-3* > |
16380 | 4960 :scriptversion 3 |
4961 < All |vim-variable|s must be prefixed by "v:". E.g. "version" doesn't | |
4962 work as |v:version| anymore, it can be used as a normal variable. | |
4963 Same for some obvious names as "count" and others. | |
4964 | |
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4965 Test for support with: > |
16380 | 4966 has('vimscript-3') |
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
4967 < |
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
4968 *scriptversion-4* > |
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
4969 :scriptversion 4 |
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
4970 < Numbers with a leading zero are not recognized as octal. "0o" or "0O" |
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
4971 is still recognized as octal. With the |
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
4972 previous version you get: > |
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
4973 echo 017 " displays 15 (octal) |
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
4974 echo 0o17 " displays 15 (octal) |
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
4975 echo 018 " displays 18 (decimal) |
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
4976 < with script version 4: > |
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
4977 echo 017 " displays 17 (decimal) |
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
4978 echo 0o17 " displays 15 (octal) |
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
4979 echo 018 " displays 18 (decimal) |
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
4980 < Also, it is possible to use single quotes inside numbers to make them |
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
4981 easier to read: > |
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
4982 echo 1'000'000 |
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
4983 < The quotes must be surrounded by digits. |
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
4984 |
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
4985 Test for support with: > |
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
4986 has('vimscript-4') |
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4987 |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4988 ============================================================================== |
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
4989 11. No +eval feature *no-eval-feature* |
7 | 4990 |
4991 When the |+eval| feature was disabled at compile time, none of the expression | |
4992 evaluation commands are available. To prevent this from causing Vim scripts | |
4993 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
4994 recognized, though the argument of the ":if" and everything between the ":if" | |
4995 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
4996 only if the commands are at the start of the line. The ":else" command is not | |
4997 recognized. | |
4998 | |
4999 Example of how to avoid executing commands when the |+eval| feature is | |
5000 missing: > | |
5001 | |
5002 :if 1 | |
5003 : echo "Expression evaluation is compiled in" | |
5004 :else | |
5005 : echo "You will _never_ see this message" | |
5006 :endif | |
5007 | |
16971
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
5008 To execute a command only when the |+eval| feature is disabled can be done in |
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
5009 two ways. The simplest is to exit the script (or Vim) prematurely: > |
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
5010 if 1 |
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
5011 echo "commands executed with +eval" |
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
5012 finish |
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
5013 endif |
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
5014 args " command executed without +eval |
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
5015 |
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
5016 If you do not want to abort loading the script you can use a trick, as this |
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
5017 example shows: > |
11414
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
5018 |
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
5019 silent! while 0 |
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
5020 set history=111 |
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
5021 silent! endwhile |
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
5022 |
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
5023 When the |+eval| feature is available the command is skipped because of the |
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
5024 "while 0". Without the |+eval| feature the "while 0" is an error, which is |
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
5025 silently ignored, and the command is executed. |
11347 | 5026 |
7 | 5027 ============================================================================== |
27036 | 5028 12. The sandbox *eval-sandbox* *sandbox* |
7 | 5029 |
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
5030 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
|
5031 '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
|
5032 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
|
5033 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
|
5034 the command from a tags file is executed and for CTRL-R = in the command line. |
29 | 5035 The sandbox is also used for the |:sandbox| command. |
27036 | 5036 *E48* |
7 | 5037 These items are not allowed in the sandbox: |
5038 - changing the buffer text | |
14347 | 5039 - defining or changing mapping, autocommands, user commands |
7 | 5040 - setting certain options (see |option-summary|) |
1156 | 5041 - setting certain v: variables (see |v:var|) *E794* |
7 | 5042 - executing a shell command |
5043 - reading or writing a file | |
5044 - jumping to another buffer or editing a file | |
625 | 5045 - executing Python, Perl, etc. commands |
29 | 5046 This is not guaranteed 100% secure, but it should block most attacks. |
5047 | |
5048 *:san* *:sandbox* | |
401 | 5049 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
29 | 5050 option that may have been set from a modeline, e.g. |
5051 'foldexpr'. | |
5052 | |
634 | 5053 *sandbox-option* |
5054 A few options contain an expression. When this expression is evaluated it may | |
790 | 5055 have to be done in the sandbox to avoid a security risk. But the sandbox is |
634 | 5056 restrictive, thus this only happens when the option was set from an insecure |
5057 location. Insecure in this context are: | |
843 | 5058 - sourcing a .vimrc or .exrc in the current directory |
634 | 5059 - while executing in the sandbox |
5060 - value coming from a modeline | |
14347 | 5061 - executing a function that was defined in the sandbox |
634 | 5062 |
5063 Note that when in the sandbox and saving an option value and restoring it, the | |
5064 option will still be marked as it was set in the sandbox. | |
5065 | |
5066 ============================================================================== | |
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
5067 13. Textlock *textlock* |
634 | 5068 |
5069 In a few situations it is not allowed to change the text in the buffer, jump | |
5070 to another window and some other things that might confuse or break what Vim | |
5071 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
|
5072 actually doing something else. For example, evaluating the 'balloonexpr' may |
634 | 5073 happen any moment the mouse cursor is resting at some position. |
5074 | |
5075 This is not allowed when the textlock is active: | |
5076 - changing the buffer text | |
5077 - jumping to another buffer or window | |
5078 - editing another file | |
5079 - closing a window or quitting Vim | |
5080 - etc. | |
5081 | |
7 | 5082 |
14421 | 5083 vim:tw=78:ts=8:noet:ft=help:norl: |