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