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