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