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