vim: runtime/doc/eval.txt annotate

annotate runtime/doc/eval.txt @ 29704:5b3a88601317 v9.0.0192

patch 9.0.0192: possible invalid memory access when 'cmdheight' is zero Commit: https://github.com/vim/vim/commit/fdc5d17d58cc9c9edc9fb2816e1afaabc531bf1e Author: Bram Moolenaar <Bram@vim.org> Date: Thu Aug 11 15:52:14 2022 +0100 patch 9.0.0192: possible invalid memory access when 'cmdheight' is zero Problem: Possible invalid memory access when 'cmdheight' is zero. (Martin Tournoij) Solution: Avoid going over the end of w_lines[] when w_height is Rows. (closes #10882)

author	Bram Moolenaar <Bram@vim.org>
date	Thu, 11 Aug 2022 17:00:03 +0200
parents	e64e9ba15acc
children	2acb87ee55fc

rev	line source
29314 f8116058ca76 release version 9.0 Bram Moolenaar <Bram@vim.org> parents: 29290 diff changeset	1 eval.txt For Vim version 9.0. Last change: 2022 Jun 17
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	2
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	4 VIM REFERENCE MANUAL by Bram Moolenaar
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	6
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	7 Expression evaluation expression expr E15 eval
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	8 E1002
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	9 Using expressions is introduced in chapter 41 of the user manual \|usr_41.txt\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	10
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	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 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	13 \|no-eval-feature\|.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	14
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: 26769 diff changeset	15 This file is mainly about the backwards compatible (legacy) Vim script. For
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26881 diff changeset	16 specifics of Vim9 script, which can execute much faster, supports type
3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26881 diff changeset	17 checking and much more, see \|vim9.txt\|. Where the syntax or semantics differ
3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26881 diff changeset	18 a remark is given.
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: 19163 diff changeset	19
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	20 1. Variables \|variables\|
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	21 1.1 Variable types
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	22 1.2 Function references \|Funcref\|
161 6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	23 1.3 Lists \|Lists\|
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	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 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	27 2. Expression syntax \|expression-syntax\|
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	28 3. Internal variable \|internal-variables\|
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	29 4. Builtin Functions \|functions\|
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	30 5. Defining functions \|user-functions\|
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	31 6. Curly braces names \|curly-braces-names\|
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	32 7. Commands \|expression-commands\|
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	33 8. Exception handling \|exception-handling\|
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	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 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	42
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	43 ==============================================================================
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	44 1. Variables variables
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	45
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	46 1.1 Variable types ~
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	47 E712 E896 E897 E899 E1098
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	48 E1107 E1135 E1138
17909 cc953757ed2a Runtime files update. Bram Moolenaar <Bram@vim.org> parents: 17857 diff changeset	49 There are ten types of variables:
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	50
18831 6848b809a26e Runtime file updates. Bram Moolenaar <Bram@vim.org> parents: 18790 diff changeset	51 Number Integer
6848b809a26e Runtime file updates. Bram Moolenaar <Bram@vim.org> parents: 18790 diff changeset	52 Number A 32 or 64 bit signed number. \|expr-number\|
19477 2bb0e80fcd32 patch 8.2.0296: mixing up "long long" and __int64 may cause problems Bram Moolenaar <Bram@vim.org> parents: 19400 diff changeset	53 The number of bits is available in \|v:numbersize\|.
23563 87671ccc6c6b patch 8.2.2324: not easy to get mark en cursor posotion by character count Bram Moolenaar <Bram@vim.org> parents: 23475 diff changeset	54 Examples: -123 0x10 0177 0o177 0b1011
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	55
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	56 Float A floating point number. \|floating-point-format\| Float
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	57 {only when compiled with the \|+float\| feature} E1076
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	58 Examples: 123.456 1.15e-6 -1.1e3
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	59
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	60 String A NUL terminated string of 8-bit unsigned characters (bytes).
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	61 \|expr-string\| Examples: "ab\txx\"--" 'x-z''a,c'
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	62
15498 e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	63 List An ordered sequence of items, see \|List\| for details.
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	64 Example: [1, 2, ['a', 'b']]
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	65
370 3a21825ad207 updated for version 7.0095 vimboss parents: 359 diff changeset	66 Dictionary An associative, unordered array: Each entry has a key and a
3a21825ad207 updated for version 7.0095 vimboss parents: 359 diff changeset	67 value. \|Dictionary\|
17368 6604ecb7a615 patch 8.1.1683: dictionary with string keys is longer than needed Bram Moolenaar <Bram@vim.org> parents: 17366 diff changeset	68 Examples:
6604ecb7a615 patch 8.1.1683: dictionary with string keys is longer than needed Bram Moolenaar <Bram@vim.org> parents: 17366 diff changeset	69 {'blue': "#0000ff", 'red': "#ff0000"}
17413 40417757dffd patch 8.1.1705: using ~{} for a literal dict is not nice Bram Moolenaar <Bram@vim.org> parents: 17387 diff changeset	70 #{blue: "#0000ff", red: "#ff0000"}
370 3a21825ad207 updated for version 7.0095 vimboss parents: 359 diff changeset	71
7957 b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a Christian Brabandt <cb@256bit.org> parents: 7935 diff changeset	72 Funcref A reference to a function \|Funcref\|.
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a Christian Brabandt <cb@256bit.org> parents: 7935 diff changeset	73 Example: function("strlen")
9104 2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	74 It can be bound to a dictionary and arguments, it then works
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	75 like a Partial.
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	76 Example: function("Callback", [arg], myDict)
7957 b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a Christian Brabandt <cb@256bit.org> parents: 7935 diff changeset	77
8178 e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686 Christian Brabandt <cb@256bit.org> parents: 8148 diff changeset	78 Special \|v:false\|, \|v:true\|, \|v:none\| and \|v:null\|. Special
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686 Christian Brabandt <cb@256bit.org> parents: 8148 diff changeset	79
8881 ed0b39dd7fd6 commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e Christian Brabandt <cb@256bit.org> parents: 8876 diff changeset	80 Job Used for a job, see \|job_start()\|. Job Jobs
ed0b39dd7fd6 commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e Christian Brabandt <cb@256bit.org> parents: 8876 diff changeset	81
ed0b39dd7fd6 commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e Christian Brabandt <cb@256bit.org> parents: 8876 diff changeset	82 Channel Used for a channel, see \|ch_open()\|. Channel Channels
7957 b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a Christian Brabandt <cb@256bit.org> parents: 7935 diff changeset	83
15498 e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	84 Blob Binary Large Object. Stores any sequence of bytes. See \|Blob\|
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	85 for details
15454 1d2b5c016f17 patch 8.1.0735: cannot handle binary data Bram Moolenaar <Bram@vim.org> parents: 15446 diff changeset	86 Example: 0zFF00ED015DAF
1d2b5c016f17 patch 8.1.0735: cannot handle binary data Bram Moolenaar <Bram@vim.org> parents: 15446 diff changeset	87 0z is an empty Blob.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data Bram Moolenaar <Bram@vim.org> parents: 15446 diff changeset	88
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	89 The Number and String types are converted automatically, depending on how they
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	90 are used.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	91
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	92 Conversion from a Number to a String is by making the ASCII representation of
2581 e8a482a7fa6c Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	93 the Number. Examples:
e8a482a7fa6c Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	94 Number 123 --> String "123" ~
e8a482a7fa6c Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	95 Number 0 --> String "0" ~
e8a482a7fa6c Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	96 Number -1 --> String "-1" ~
2152 b9e314fe473f Updated runtime files. Bram Moolenaar <bram@zimbu.org> parents: 2120 diff changeset	97 octal
21409 2c40e60017a8 patch 8.2.1255: cannot use a lambda with quickfix functions Bram Moolenaar <Bram@vim.org> parents: 21381 diff changeset	98 Conversion from a String to a Number only happens in legacy Vim script, not in
2c40e60017a8 patch 8.2.1255: cannot use a lambda with quickfix functions Bram Moolenaar <Bram@vim.org> parents: 21381 diff changeset	99 Vim9 script. It is done by converting the first digits to a number.
2c40e60017a8 patch 8.2.1255: cannot use a lambda with quickfix functions Bram Moolenaar <Bram@vim.org> parents: 21381 diff changeset	100 Hexadecimal "0xf9", Octal "017" or "0o17", and Binary "0b10"
23563 87671ccc6c6b patch 8.2.2324: not easy to get mark en cursor posotion by character count Bram Moolenaar <Bram@vim.org> parents: 23475 diff changeset	101 numbers are recognized
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	102 NOTE: when using \|Vim9\| script or \|scriptversion-4\| octal with a leading "0"
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	103 is not recognized. The 0o notation requires patch 8.2.0886.
23563 87671ccc6c6b patch 8.2.2324: not easy to get mark en cursor posotion by character count Bram Moolenaar <Bram@vim.org> parents: 23475 diff changeset	104 If the String doesn't start with digits, the result is zero.
7477 05cf4cc72a9f commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023 Christian Brabandt <cb@256bit.org> parents: 7384 diff changeset	105 Examples:
2581 e8a482a7fa6c Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	106 String "456" --> Number 456 ~
e8a482a7fa6c Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	107 String "6bar" --> Number 6 ~
e8a482a7fa6c Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	108 String "foo" --> Number 0 ~
e8a482a7fa6c Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	109 String "0xf1" --> Number 241 ~
e8a482a7fa6c Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	110 String "0100" --> Number 64 ~
20665 6ff992bf4c82 patch 8.2.0886: cannot use octal numbers in scriptversion 4 Bram Moolenaar <Bram@vim.org> parents: 20649 diff changeset	111 String "0o100" --> Number 64 ~
7477 05cf4cc72a9f commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023 Christian Brabandt <cb@256bit.org> parents: 7384 diff changeset	112 String "0b101" --> Number 5 ~
2581 e8a482a7fa6c Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	113 String "-8" --> Number -8 ~
e8a482a7fa6c Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	114 String "+8" --> Number 0 ~
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	115
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	116 To force conversion from String to Number, add zero to it: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	117 :echo "0100" + 0
782 d20041a02ee5 updated for version 7.0228 vimboss parents: 777 diff changeset	118 < 64 ~
d20041a02ee5 updated for version 7.0228 vimboss parents: 777 diff changeset	119
d20041a02ee5 updated for version 7.0228 vimboss parents: 777 diff changeset	120 To avoid a leading zero to cause octal conversion, or for using a different
d20041a02ee5 updated for version 7.0228 vimboss parents: 777 diff changeset	121 base, use \|str2nr()\|.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	122
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	123 TRUE FALSE Boolean
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	124 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE.
25619 29ec2c198c8d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25573 diff changeset	125 You can also use \|v:false\| and \|v:true\|, in Vim9 script \|false\| and \|true\|.
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22077 diff changeset	126 When TRUE is returned from a function it is the Number one, FALSE is the
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22077 diff changeset	127 number zero.
9422 f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	128
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	129 Note that in the command: >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	130 :if "foo"
9422 f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	131 :" NOT executed
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	132 "foo" is converted to 0, which means FALSE. If the string starts with a
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	133 non-zero number it means TRUE: >
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	134 :if "8foo"
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	135 :" executed
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	136 To test for a non-empty string, use empty(): >
3893 c3036f1dca68 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3875 diff changeset	137 :if !empty("foo")
22492 0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	138
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	139 < falsy truthy
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	140 An expression can be used as a condition, ignoring the type and only using
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	141 whether the value is "sort of true" or "sort of false". Falsy is:
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	142 the number zero
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	143 empty string, blob, list or dictionary
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	144 Other values are truthy. Examples:
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	145 0 falsy
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	146 1 truthy
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	147 -1 truthy
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	148 0.0 falsy
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	149 0.1 truthy
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	150 '' falsy
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	151 'x' truthy
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	152 [] falsy
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	153 [0] truthy
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	154 {} falsy
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	155 #{x: 1} truthy
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	156 0z falsy
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	157 0z00 truthy
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	158
9422 f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	159 non-zero-arg
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	160 Function arguments often behave slightly different from \|TRUE\|: If the
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	161 argument is present and it evaluates to a non-zero Number, \|v:true\| or a
10140 b11ceef7116e commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab Christian Brabandt <cb@256bit.org> parents: 10054 diff changeset	162 non-empty String, then the value is considered to be TRUE.
12756 3b26420fc639 Long overdue runtime update. Christian Brabandt <cb@256bit.org> parents: 12722 diff changeset	163 Note that " " and "0" are also non-empty strings, thus considered to be TRUE.
3b26420fc639 Long overdue runtime update. Christian Brabandt <cb@256bit.org> parents: 12722 diff changeset	164 A List, Dictionary or Float is not a Number or String, thus evaluate to FALSE.
9422 f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	165
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26881 diff changeset	166 E611 E745 E728 E703 E729 E730 E731 E908 E910
3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26881 diff changeset	167 E913 E974 E975 E976
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	168 \|List\|, \|Dictionary\|, \|Funcref\|, \|Job\|, \|Channel\| and \|Blob\| types are not
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	169 automatically converted.
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	170
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	171 E805 E806 E808
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	172 When mixing Number and Float the Number is converted to Float. Otherwise
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	173 there is no automatic conversion of Float. You can use str2float() for String
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	174 to Float, printf() for Float to String and float2nr() for Float to Number.
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	175
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26881 diff changeset	176 E362 E891 E892 E893 E894 E907 E911 E914
7707 41768bcebc9b commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e Christian Brabandt <cb@256bit.org> parents: 7703 diff changeset	177 When expecting a Float a Number can also be used, but nothing else.
41768bcebc9b commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e Christian Brabandt <cb@256bit.org> parents: 7703 diff changeset	178
8512 5104f96b6ecf commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf Christian Brabandt <cb@256bit.org> parents: 8502 diff changeset	179 no-type-checking
5104f96b6ecf commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf Christian Brabandt <cb@256bit.org> parents: 8502 diff changeset	180 You will not get an error if you try to change the type of a variable.
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	181
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	182
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	183 1.2 Function references ~
29290 dc4de65a7fb7 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29236 diff changeset	184 Funcref E695 E718 E1192
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	185 A Funcref variable is obtained with the \|function()\| function, the \|funcref()\|
29066 f8e9d5023bf6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28964 diff changeset	186 function, (in \|Vim9\| script) the name of a function, or created with the
f8e9d5023bf6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28964 diff changeset	187 lambda expression \|expr-lambda\|. It can be used in an expression in the place
f8e9d5023bf6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28964 diff changeset	188 of a function name, before the parenthesis around the arguments, to invoke the
f8e9d5023bf6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28964 diff changeset	189 function it refers to. Example in \|Vim9\| script: >
f8e9d5023bf6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28964 diff changeset	190
f8e9d5023bf6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28964 diff changeset	191 :var Fn = MyFunc
f8e9d5023bf6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28964 diff changeset	192 :echo Fn()
f8e9d5023bf6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28964 diff changeset	193
f8e9d5023bf6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28964 diff changeset	194 Legacy script: >
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	195 :let Fn = function("MyFunc")
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	196 :echo Fn()
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	197 < E704 E705 E707
819 23f82b5d2814 updated for version 7.0c10 vimboss parents: 818 diff changeset	198 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You
5340 22da5ab9aaa1 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5294 diff changeset	199 can use "g:" but the following name must still start with a capital. You
819 23f82b5d2814 updated for version 7.0c10 vimboss parents: 818 diff changeset	200 cannot have both a Funcref variable and a function with the same name.
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	201
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	202 A special case is defining a function and directly assigning its Funcref to a
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	203 Dictionary entry. Example: >
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	204 :function dict.init() dict
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	205 : let self.val = 0
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	206 :endfunction
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	207
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	208 The key of the Dictionary can start with a lower case letter. The actual
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	209 function name is not used here. Also see \|numbered-function\|.
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	210
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	211 A Funcref can also be used with the \|:call\| command: >
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	212 :call Fn()
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	213 :call dict.init()
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	214
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	215 The name of the referenced function can be obtained with \|string()\|. >
119 e8f07016e34d updated for version 7.0042 vimboss parents: 114 diff changeset	216 :let func = string(Fn)
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	217
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	218 You can use \|call()\| to invoke a Funcref and use a list variable for the
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	219 arguments: >
119 e8f07016e34d updated for version 7.0042 vimboss parents: 114 diff changeset	220 :let r = call(Fn, mylist)
9104 2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	221 <
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	222 Partial
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	223 A Funcref optionally binds a Dictionary and/or arguments. This is also called
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	224 a Partial. This is created by passing the Dictionary and/or arguments to
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	225 function() or funcref(). When calling the function the Dictionary and/or
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	226 arguments will be passed to the function. Example: >
9104 2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	227
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	228 let Cb = function('Callback', ['foo'], myDict)
14999 2b30a2b4bde2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 14964 diff changeset	229 call Cb('bar')
9104 2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	230
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	231 This will invoke the function as if using: >
14999 2b30a2b4bde2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 14964 diff changeset	232 call myDict.Callback('foo', 'bar')
9104 2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	233
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	234 This is very useful when passing a function around, e.g. in the arguments of
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	235 \|ch_open()\|.
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	236
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	237 Note that binding a function to a Dictionary also happens when the function is
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	238 a member of the Dictionary: >
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	239
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	240 let myDict.myFunction = MyFunction
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	241 call myDict.myFunction()
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	242
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	243 Here MyFunction() will get myDict passed as "self". This happens when the
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	244 "myFunction" member is accessed. When making assigning "myFunction" to
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	245 otherDict and calling it, it will be bound to otherDict: >
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	246
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	247 let otherDict.myFunction = myDict.myFunction
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	248 call otherDict.myFunction()
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	249
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	250 Now "self" will be "otherDict". But when the dictionary was bound explicitly
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	251 this won't happen: >
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	252
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	253 let myDict.myFunction = function(MyFunction, myDict)
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	254 let otherDict.myFunction = myDict.myFunction
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	255 call otherDict.myFunction()
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da Christian Brabandt <cb@256bit.org> parents: 9097 diff changeset	256
9850 67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640 Christian Brabandt <cb@256bit.org> parents: 9810 diff changeset	257 Here "self" will be "myDict", because it was bound explicitly.
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	258
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	259
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	260 1.3 Lists ~
5814 755931e042e4 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5808 diff changeset	261 list List Lists E686
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	262 A List is an ordered sequence of items. An item can be of any type. Items
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	263 can be accessed by their index number. Items can be added and removed at any
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	264 position in the sequence.
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	265
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	266
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	267 List creation ~
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	268 E696 E697
28379 6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28010 diff changeset	269 A List is created with a comma-separated list of items in square brackets.
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	270 Examples: >
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	271 :let mylist = [1, two, 3, "four"]
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	272 :let emptylist = []
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	273
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	274 An item can be any expression. Using a List for an item creates a
842 a209672376fd updated for version 7.0f vimboss parents: 841 diff changeset	275 List of Lists: >
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	276 :let nestlist = [[11, 12], [21, 22], [31, 32]]
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	277
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	278 An extra comma after the last item is ignored.
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	279
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	280
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	281 List index ~
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	282 list-index E684
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	283 An item in the List can be accessed by putting the index in square brackets
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	284 after the List. Indexes are zero-based, thus the first item has index zero. >
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	285 :let item = mylist[0] " get the first item: 1
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	286 :let item = mylist[2] " get the third item: 3
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	287
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	288 When the resulting item is a list this can be repeated: >
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	289 :let item = nestlist[0][1] " get the first list, second item: 12
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	290 <
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	291 A negative index is counted from the end. Index -1 refers to the last item in
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	292 the List, -2 to the last but one item, etc. >
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	293 :let last = mylist[-1] " get the last item: "four"
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	294
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	295 To avoid an error for an invalid index use the \|get()\| function. When an item
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	296 is not available it returns zero or the default value you specify: >
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	297 :echo get(mylist, idx)
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	298 :echo get(mylist, idx, "NONE")
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	299
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	300
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	301 List concatenation ~
23788 d12ef361d9de patch 8.2.2435: setline() gives an error for some types Bram Moolenaar <Bram@vim.org> parents: 23737 diff changeset	302 list-concatenation
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	303 Two lists can be concatenated with the "+" operator: >
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	304 :let longlist = mylist + [5, 6]
119 e8f07016e34d updated for version 7.0042 vimboss parents: 114 diff changeset	305 :let mylist += [7, 8]
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	306
23788 d12ef361d9de patch 8.2.2435: setline() gives an error for some types Bram Moolenaar <Bram@vim.org> parents: 23737 diff changeset	307 To prepend or append an item, turn the item into a list by putting [] around
d12ef361d9de patch 8.2.2435: setline() gives an error for some types Bram Moolenaar <Bram@vim.org> parents: 23737 diff changeset	308 it. To change a list in-place, refer to \|list-modification\| below.
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	309
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	310
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	311 Sublist ~
9737 35ce559b8553 commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380 Christian Brabandt <cb@256bit.org> parents: 9723 diff changeset	312 sublist
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	313 A part of the List can be obtained by specifying the first and last index,
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	314 separated by a colon in square brackets: >
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	315 :let shortlist = mylist[2:-1] " get List [3, "four"]
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	316
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	317 Omitting the first index is similar to zero. Omitting the last index is
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	318 similar to -1. >
90 9d4f762cc1d9 updated for version 7.0036 vimboss parents: 87 diff changeset	319 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"]
9d4f762cc1d9 updated for version 7.0036 vimboss parents: 87 diff changeset	320 :let shortlist = mylist[2:2] " List with one item: [3]
9d4f762cc1d9 updated for version 7.0036 vimboss parents: 87 diff changeset	321 :let otherlist = mylist[:] " make a copy of the List
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	322
23604 1816ea68c022 patch 8.2.2344: using inclusive index for slice is not always desired Bram Moolenaar <Bram@vim.org> parents: 23602 diff changeset	323 Notice that the last index is inclusive. If you prefer using an exclusive
1816ea68c022 patch 8.2.2344: using inclusive index for slice is not always desired Bram Moolenaar <Bram@vim.org> parents: 23602 diff changeset	324 index use the \|slice()\| method.
1816ea68c022 patch 8.2.2344: using inclusive index for slice is not always desired Bram Moolenaar <Bram@vim.org> parents: 23602 diff changeset	325
842 a209672376fd updated for version 7.0f vimboss parents: 841 diff changeset	326 If the first index is beyond the last item of the List or the second item is
a209672376fd updated for version 7.0f vimboss parents: 841 diff changeset	327 before the first item, the result is an empty list. There is no error
a209672376fd updated for version 7.0f vimboss parents: 841 diff changeset	328 message.
a209672376fd updated for version 7.0f vimboss parents: 841 diff changeset	329
a209672376fd updated for version 7.0f vimboss parents: 841 diff changeset	330 If the second index is equal to or greater than the length of the list the
a209672376fd updated for version 7.0f vimboss parents: 841 diff changeset	331 length minus one is used: >
829 dc8197342755 updated for version 7.0d04 vimboss parents: 825 diff changeset	332 :let mylist = [0, 1, 2, 3]
dc8197342755 updated for version 7.0d04 vimboss parents: 825 diff changeset	333 :echo mylist[2:8] " result: [2, 3]
dc8197342755 updated for version 7.0d04 vimboss parents: 825 diff changeset	334
270 a20218704019 updated for version 7.0072 vimboss parents: 258 diff changeset	335 NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	336 using a single letter variable before the ":". Insert a space when needed:
270 a20218704019 updated for version 7.0072 vimboss parents: 258 diff changeset	337 mylist[s : e].
a20218704019 updated for version 7.0072 vimboss parents: 258 diff changeset	338
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	339
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	340 List identity ~
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	341 list-identity
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	342 When variable "aa" is a list and you assign it to another variable "bb", both
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	343 variables refer to the same list. Thus changing the list "aa" will also
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	344 change "bb": >
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	345 :let aa = [1, 2, 3]
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	346 :let bb = aa
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	347 :call add(aa, 4)
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	348 :echo bb
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	349 < [1, 2, 3, 4]
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	350
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	351 Making a copy of a list is done with the \|copy()\| function. Using [:] also
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	352 works, as explained above. This creates a shallow copy of the list: Changing
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	353 a list item in the list will also change the item in the copied list: >
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	354 :let aa = [[1, 'a'], 2, 3]
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	355 :let bb = copy(aa)
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	356 :call add(aa, 4)
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	357 :let aa[0][1] = 'aaa'
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	358 :echo aa
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	359 < [[1, aaa], 2, 3, 4] >
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	360 :echo bb
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	361 < [[1, aaa], 2, 3]
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	362
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	363 To make a completely independent list use \|deepcopy()\|. This also makes a
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	364 copy of the values in the list, recursively. Up to a hundred levels deep.
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	365
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	366 The operator "is" can be used to check if two variables refer to the same
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	367 List. "isnot" does the opposite. In contrast "==" compares if two lists have
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	368 the same value. >
014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	369 :let alist = [1, 2, 3]
014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	370 :let blist = [1, 2, 3]
014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	371 :echo alist is blist
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	372 < 0 >
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	373 :echo alist == blist
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	374 < 1
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	375
323 03b3684919e3 updated for version 7.0084 vimboss parents: 314 diff changeset	376 Note about comparing lists: Two lists are considered equal if they have the
03b3684919e3 updated for version 7.0084 vimboss parents: 314 diff changeset	377 same length and all items compare equal, as with using "==". There is one
388 f92bb1845823 updated for version 7.0101 vimboss parents: 375 diff changeset	378 exception: When comparing a number with a string they are considered
f92bb1845823 updated for version 7.0101 vimboss parents: 375 diff changeset	379 different. There is no automatic type conversion, as with using "==" on
f92bb1845823 updated for version 7.0101 vimboss parents: 375 diff changeset	380 variables. Example: >
f92bb1845823 updated for version 7.0101 vimboss parents: 375 diff changeset	381 echo 4 == "4"
323 03b3684919e3 updated for version 7.0084 vimboss parents: 314 diff changeset	382 < 1 >
388 f92bb1845823 updated for version 7.0101 vimboss parents: 375 diff changeset	383 echo [4] == ["4"]
323 03b3684919e3 updated for version 7.0084 vimboss parents: 314 diff changeset	384 < 0
03b3684919e3 updated for version 7.0084 vimboss parents: 314 diff changeset	385
388 f92bb1845823 updated for version 7.0101 vimboss parents: 375 diff changeset	386 Thus comparing Lists is more strict than comparing numbers and strings. You
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	387 can compare simple values this way too by putting them in a list: >
388 f92bb1845823 updated for version 7.0101 vimboss parents: 375 diff changeset	388
f92bb1845823 updated for version 7.0101 vimboss parents: 375 diff changeset	389 :let a = 5
f92bb1845823 updated for version 7.0101 vimboss parents: 375 diff changeset	390 :let b = "5"
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	391 :echo a == b
388 f92bb1845823 updated for version 7.0101 vimboss parents: 375 diff changeset	392 < 1 >
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	393 :echo [a] == [b]
388 f92bb1845823 updated for version 7.0101 vimboss parents: 375 diff changeset	394 < 0
323 03b3684919e3 updated for version 7.0084 vimboss parents: 314 diff changeset	395
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	396
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	397 List unpack ~
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	398
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	399 To unpack the items in a list to individual variables, put the variables in
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	400 square brackets, like list items: >
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	401 :let [var1, var2] = mylist
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	402
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	403 When the number of variables does not match the number of items in the list
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	404 this produces an error. To handle any extra items from the list append ";"
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	405 and a variable name: >
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	406 :let [var1, var2; rest] = mylist
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	407
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	408 This works like: >
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	409 :let var1 = mylist[0]
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	410 :let var2 = mylist[1]
95 a2081e6febb8 updated for version 7.0037 vimboss parents: 90 diff changeset	411 :let rest = mylist[2:]
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	412
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	413 Except that there is no error if there are only two items. "rest" will be an
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	414 empty list then.
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	415
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	416
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	417 List modification ~
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	418 list-modification
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	419 To change a specific item of a list use \|:let\| this way: >
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	420 :let list[4] = "four"
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	421 :let listlist[0][3] = item
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	422
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	423 To change part of a list you can specify the first and last item to be
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	424 modified. The value must at least have the number of items in the range: >
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	425 :let list[3:5] = [3, 4, 5]
014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	426
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	427 Adding and removing items from a list is done with functions. Here are a few
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	428 examples: >
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	429 :call insert(list, 'a') " prepend item 'a'
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	430 :call insert(list, 'a', 3) " insert item 'a' before list[3]
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	431 :call add(list, "new") " append String item
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	432 :call add(list, [1, 2]) " append a List as one new item
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	433 :call extend(list, [1, 2]) " extend the list with two more items
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	434 :let i = remove(list, 3) " remove item 3
108 375b1d0f97b0 updated for version 7.0040 vimboss parents: 102 diff changeset	435 :unlet list[3] " idem
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	436 :let l = remove(list, 3, -1) " remove items 3 to last item
108 375b1d0f97b0 updated for version 7.0040 vimboss parents: 102 diff changeset	437 :unlet list[3 : ] " idem
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	438 :call filter(list, 'v:val !~ "x"') " remove items with an 'x'
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	439
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	440 Changing the order of items in a list: >
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	441 :call sort(list) " sort a list alphabetically
014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	442 :call reverse(list) " reverse the order of items
5747 ddc3f32a4b21 updated for version 7.4.218 Bram Moolenaar <bram@vim.org> parents: 5734 diff changeset	443 :call uniq(sort(list)) " sort and remove duplicates
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	444
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	445
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	446 For loop ~
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	447
24234 7ffc795288dd patch 8.2.2658: :for cannot loop over a string Bram Moolenaar <Bram@vim.org> parents: 24194 diff changeset	448 The \|:for\| loop executes commands for each item in a List, String or Blob.
7ffc795288dd patch 8.2.2658: :for cannot loop over a string Bram Moolenaar <Bram@vim.org> parents: 24194 diff changeset	449 A variable is set to each item in sequence. Example with a List: >
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	450 :for item in mylist
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	451 : call Doit(item)
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	452 :endfor
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	453
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	454 This works like: >
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	455 :let index = 0
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	456 :while index < len(mylist)
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	457 : let item = mylist[index]
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	458 : :call Doit(item)
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	459 : let index = index + 1
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	460 :endwhile
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	461
95 a2081e6febb8 updated for version 7.0037 vimboss parents: 90 diff changeset	462 If all you want to do is modify each item in the list then the \|map()\|
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	463 function will be a simpler method than a for loop.
95 a2081e6febb8 updated for version 7.0037 vimboss parents: 90 diff changeset	464
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	465 Just like the \|:let\| command, \|:for\| also accepts a list of variables. This
24234 7ffc795288dd patch 8.2.2658: :for cannot loop over a string Bram Moolenaar <Bram@vim.org> parents: 24194 diff changeset	466 requires the argument to be a List of Lists. >
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	467 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]]
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	468 : call Doit(lnum, col)
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	469 :endfor
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	470
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	471 This works like a \|:let\| command is done for each list item. Again, the types
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	472 must remain the same to avoid an error.
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	473
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	474 It is also possible to put remaining items in a List variable: >
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	475 :for [i, j; rest] in listlist
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	476 : call Doit(i, j)
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	477 : if !empty(rest)
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	478 : echo "remainder: " .. string(rest)
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	479 : endif
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	480 :endfor
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	481
24234 7ffc795288dd patch 8.2.2658: :for cannot loop over a string Bram Moolenaar <Bram@vim.org> parents: 24194 diff changeset	482 For a Blob one byte at a time is used.
7ffc795288dd patch 8.2.2658: :for cannot loop over a string Bram Moolenaar <Bram@vim.org> parents: 24194 diff changeset	483
7ffc795288dd patch 8.2.2658: :for cannot loop over a string Bram Moolenaar <Bram@vim.org> parents: 24194 diff changeset	484 For a String one character, including any composing characters, is used as a
7ffc795288dd patch 8.2.2658: :for cannot loop over a string Bram Moolenaar <Bram@vim.org> parents: 24194 diff changeset	485 String. Example: >
7ffc795288dd patch 8.2.2658: :for cannot loop over a string Bram Moolenaar <Bram@vim.org> parents: 24194 diff changeset	486 for c in text
7ffc795288dd patch 8.2.2658: :for cannot loop over a string Bram Moolenaar <Bram@vim.org> parents: 24194 diff changeset	487 echo 'This character is ' .. c
7ffc795288dd patch 8.2.2658: :for cannot loop over a string Bram Moolenaar <Bram@vim.org> parents: 24194 diff changeset	488 endfor
7ffc795288dd patch 8.2.2658: :for cannot loop over a string Bram Moolenaar <Bram@vim.org> parents: 24194 diff changeset	489
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	490
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	491 List functions ~
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	492 E714
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	493 Functions that are useful with a List: >
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	494 :let r = call(funcname, list) " call a function with an argument list
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	495 :if empty(list) " check if list is empty
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	496 :let l = len(list) " number of items in list
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	497 :let big = max(list) " maximum value in list
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	498 :let small = min(list) " minimum value in list
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	499 :let xs = count(list, 'x') " count nr of times 'x' appears in list
014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	500 :let i = index(list, 'x') " index of first 'x' in list
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	501 :let lines = getline(1, 10) " get ten text lines from buffer
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	502 :call append('$', lines) " append text lines in buffer
95 a2081e6febb8 updated for version 7.0037 vimboss parents: 90 diff changeset	503 :let list = split("a b c") " create list from items in a string
a2081e6febb8 updated for version 7.0037 vimboss parents: 90 diff changeset	504 :let string = join(list, ', ') " create string from list items
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	505 :let s = string(list) " String representation of list
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	506 :call map(list, '">> " .. v:val') " prepend ">> " to each item
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	507
258 f93df7322443 updated for version 7.0070 vimboss parents: 236 diff changeset	508 Don't forget that a combination of features can make things simple. For
f93df7322443 updated for version 7.0070 vimboss parents: 236 diff changeset	509 example, to add up all the numbers in a list: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	510 :exe 'let sum = ' .. join(nrlist, '+')
258 f93df7322443 updated for version 7.0070 vimboss parents: 236 diff changeset	511
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	512
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	513 1.4 Dictionaries ~
15498 e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	514 dict Dict Dictionaries Dictionary
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	515 A Dictionary is an associative array: Each entry has a key and a value. The
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	516 entry can be located with the key. The entries are stored without a specific
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	517 ordering.
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	518
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	519
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	520 Dictionary creation ~
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	521 E720 E721 E722 E723
28379 6dd88e45d47d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28010 diff changeset	522 A Dictionary is created with a comma-separated list of entries in curly
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	523 braces. Each entry has a key and a value, separated by a colon. Each key can
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	524 only appear once. Examples: >
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	525 :let mydict = {1: 'one', 2: 'two', 3: 'three'}
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	526 :let emptydict = {}
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	527 < E713 E716 E717
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	528 A key is always a String. You can use a Number, it will be converted to a
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	529 String automatically. Thus the String '4' and the number 4 will find the same
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	530 entry. Note that the String '04' and the Number 04 are different, since the
28777 b96ceb97e896 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28718 diff changeset	531 Number will be converted to the String '4', leading zeros are dropped. The
b96ceb97e896 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28718 diff changeset	532 empty string can also be used as a key.
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	533
29236 0eef32b4ebbc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29193 diff changeset	534 In \|Vim9\| script a literal key can be used if it consists only of alphanumeric
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	535 characters, underscore and dash, see \|vim9-literal-dict\|.
17758 f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	536 literal-Dict #{}
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	537 To avoid having to put quotes around every key the #{} form can be used in
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	538 legacy script. This does require the key to consist only of ASCII letters,
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	539 digits, '-' and '_'. Example: >
18669 9007e9896303 patch 8.1.2326: cannot parse a date/time string Bram Moolenaar <Bram@vim.org> parents: 18639 diff changeset	540 :let mydict = #{zero: 0, one_key: 1, two-key: 2, 333: 3}
17413 40417757dffd patch 8.1.1705: using ~{} for a literal dict is not nice Bram Moolenaar <Bram@vim.org> parents: 17387 diff changeset	541 Note that 333 here is the string "333". Empty keys are not possible with #{}.
28777 b96ceb97e896 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28718 diff changeset	542 In \|Vim9\| script the #{} form cannot be used because it can be confused with
b96ceb97e896 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28718 diff changeset	543 the start of a comment.
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	544
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	545 A value can be any expression. Using a Dictionary for a value creates a
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	546 nested Dictionary: >
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	547 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}}
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	548
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	549 An extra comma after the last entry is ignored.
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	550
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	551
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	552 Accessing entries ~
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	553
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	554 The normal way to access an entry is by putting the key in square brackets: >
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	555 :let val = mydict["one"]
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	556 :let mydict["four"] = 4
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	557
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	558 You can add new entries to an existing Dictionary this way, unlike Lists.
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	559
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	560 For keys that consist entirely of letters, digits and underscore the following
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	561 form can be used \|expr-entry\|: >
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	562 :let val = mydict.one
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	563 :let mydict.four = 4
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	564
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	565 Since an entry can be any type, also a List and a Dictionary, the indexing and
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	566 key lookup can be repeated: >
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	567 :echo dict.key[idx].key
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	568
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	569
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	570 Dictionary to List conversion ~
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	571
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	572 You may want to loop over the entries in a dictionary. For this you need to
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	573 turn the Dictionary into a List and pass it to \|:for\|.
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	574
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	575 Most often you want to loop over the keys, using the \|keys()\| function: >
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	576 :for key in keys(mydict)
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	577 : echo key .. ': ' .. mydict[key]
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	578 :endfor
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	579
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	580 The List of keys is unsorted. You may want to sort them first: >
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	581 :for key in sort(keys(mydict))
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	582
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	583 To loop over the values use the \|values()\| function: >
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	584 :for v in values(mydict)
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	585 : echo "value: " .. v
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	586 :endfor
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	587
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	588 If you want both the key and the value use the \|items()\| function. It returns
15131 bc1a8d21c811 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15062 diff changeset	589 a List in which each item is a List with two items, the key and the value: >
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	590 :for [key, value] in items(mydict)
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	591 : echo key .. ': ' .. value
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	592 :endfor
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	593
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	594
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	595 Dictionary identity ~
161 6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	596 dict-identity
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	597 Just like Lists you need to use \|copy()\| and \|deepcopy()\| to make a copy of a
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	598 Dictionary. Otherwise, assignment results in referring to the same
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	599 Dictionary: >
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	600 :let onedict = {'a': 1, 'b': 2}
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	601 :let adict = onedict
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	602 :let adict['a'] = 11
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	603 :echo onedict['a']
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	604 11
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	605
327 8f38b35904c0 updated for version 7.0085 vimboss parents: 323 diff changeset	606 Two Dictionaries compare equal if all the key-value pairs compare equal. For
8f38b35904c0 updated for version 7.0085 vimboss parents: 323 diff changeset	607 more info see \|list-identity\|.
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	608
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	609
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	610 Dictionary modification ~
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	611 dict-modification
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	612 To change an already existing entry of a Dictionary, or to add a new entry,
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	613 use \|:let\| this way: >
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	614 :let dict[4] = "four"
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	615 :let dict['one'] = item
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	616
108 375b1d0f97b0 updated for version 7.0040 vimboss parents: 102 diff changeset	617 Removing an entry from a Dictionary is done with \|remove()\| or \|:unlet\|.
375b1d0f97b0 updated for version 7.0040 vimboss parents: 102 diff changeset	618 Three ways to remove the entry with key "aaa" from dict: >
375b1d0f97b0 updated for version 7.0040 vimboss parents: 102 diff changeset	619 :let i = remove(dict, 'aaa')
375b1d0f97b0 updated for version 7.0040 vimboss parents: 102 diff changeset	620 :unlet dict.aaa
375b1d0f97b0 updated for version 7.0040 vimboss parents: 102 diff changeset	621 :unlet dict['aaa']
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	622
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	623 Merging a Dictionary with another is done with \|extend()\|: >
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	624 :call extend(adict, bdict)
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	625 This extends adict with all entries from bdict. Duplicate keys cause entries
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	626 in adict to be overwritten. An optional third argument can change this.
119 e8f07016e34d updated for version 7.0042 vimboss parents: 114 diff changeset	627 Note that the order of entries in a Dictionary is irrelevant, thus don't
e8f07016e34d updated for version 7.0042 vimboss parents: 114 diff changeset	628 expect ":echo adict" to show the items from bdict after the older entries in
e8f07016e34d updated for version 7.0042 vimboss parents: 114 diff changeset	629 adict.
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	630
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	631 Weeding out entries from a Dictionary can be done with \|filter()\|: >
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	632 :call filter(dict, 'v:val =~ "x"')
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	633 This removes all entries from "dict" with a value not matching 'x'.
20552 74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20522 diff changeset	634 This can also be used to remove all entries: >
74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20522 diff changeset	635 call filter(dict, 0)
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	636
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	637
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	638 Dictionary function ~
4159 8b86b69546a9 Update runtime files. Bram Moolenaar <bram@vim.org> parents: 4157 diff changeset	639 Dictionary-function self E725 E862
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	640 When a function is defined with the "dict" attribute it can be used in a
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	641 special way with a dictionary. Example: >
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	642 :function Mylen() dict
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	643 : return len(self.data)
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	644 :endfunction
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	645 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")}
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	646 :echo mydict.len()
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	647
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	648 This is like a method in object oriented programming. The entry in the
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	649 Dictionary is a \|Funcref\|. The local variable "self" refers to the dictionary
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	650 the function was invoked from.
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	651
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	652 It is also possible to add a function without the "dict" attribute as a
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	653 Funcref to a Dictionary, but the "self" variable is not available then.
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	654
819 23f82b5d2814 updated for version 7.0c10 vimboss parents: 818 diff changeset	655 numbered-function anonymous-function
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	656 To avoid the extra name for the function it can be defined and directly
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	657 assigned to a Dictionary in this way: >
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	658 :let mydict = {'data': [0, 1, 2, 3]}
6741 fbc1131f0ba5 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 6697 diff changeset	659 :function mydict.len()
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	660 : return len(self.data)
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	661 :endfunction
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	662 :echo mydict.len()
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	663
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	664 The function will then get a number and the value of dict.len is a \|Funcref\|
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	665 that references this function. The function can only be used through a
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	666 \|Funcref\|. It will automatically be deleted when there is no \|Funcref\|
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	667 remaining that refers to it.
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	668
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	669 It is not necessary to use the "dict" attribute for a numbered function.
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	670
2488 def0e3934129 Preparations for 7.3d release. Bram Moolenaar <bram@vim.org> parents: 2465 diff changeset	671 If you get an error for a numbered function, you can find out what it is with
def0e3934129 Preparations for 7.3d release. Bram Moolenaar <bram@vim.org> parents: 2465 diff changeset	672 a trick. Assuming the function is 42, the command is: >
25836 65de67669df3 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25806 diff changeset	673 :function g:42
2488 def0e3934129 Preparations for 7.3d release. Bram Moolenaar <bram@vim.org> parents: 2465 diff changeset	674
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	675
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	676 Functions for Dictionaries ~
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	677 E715
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	678 Functions that can be used with a Dictionary: >
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	679 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo"
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	680 :if empty(dict) " TRUE if dict is empty
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	681 :let l = len(dict) " number of items in dict
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	682 :let big = max(dict) " maximum value in dict
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	683 :let small = min(dict) " minimum value in dict
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	684 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	685 :let s = string(dict) " String representation of dict
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	686 :call map(dict, '">> " .. v:val') " prepend ">> " to each item
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	687
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	688
15498 e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	689 1.5 Blobs ~
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	690 blob Blob Blobs E978
16158 aef0f93d3eba patch 8.1.1084: cannot delete a match from another window Bram Moolenaar <Bram@vim.org> parents: 16133 diff changeset	691 A Blob is a binary object. It can be used to read an image from a file and
aef0f93d3eba patch 8.1.1084: cannot delete a match from another window Bram Moolenaar <Bram@vim.org> parents: 16133 diff changeset	692 send it over a channel, for example.
aef0f93d3eba patch 8.1.1084: cannot delete a match from another window Bram Moolenaar <Bram@vim.org> parents: 16133 diff changeset	693
aef0f93d3eba patch 8.1.1084: cannot delete a match from another window Bram Moolenaar <Bram@vim.org> parents: 16133 diff changeset	694 A Blob mostly behaves like a \|List\| of numbers, where each number has the
aef0f93d3eba patch 8.1.1084: cannot delete a match from another window Bram Moolenaar <Bram@vim.org> parents: 16133 diff changeset	695 value of an 8-bit byte, from 0 to 255.
15498 e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	696
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	697
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	698 Blob creation ~
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	699
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	700 A Blob can be created with a \|blob-literal\|: >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	701 :let b = 0zFF00ED015DAF
15571 4af72c724093 patch 8.1.0793: incorrect error messages for functions that take a Blob Bram Moolenaar <Bram@vim.org> parents: 15512 diff changeset	702 Dots can be inserted between bytes (pair of hex characters) for readability,
4af72c724093 patch 8.1.0793: incorrect error messages for functions that take a Blob Bram Moolenaar <Bram@vim.org> parents: 15512 diff changeset	703 they don't change the value: >
4af72c724093 patch 8.1.0793: incorrect error messages for functions that take a Blob Bram Moolenaar <Bram@vim.org> parents: 15512 diff changeset	704 :let b = 0zFF00.ED01.5DAF
15498 e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	705
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	706 A blob can be read from a file with \|readfile()\| passing the {type} argument
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	707 set to "B", for example: >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	708 :let b = readfile('image.png', 'B')
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	709
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	710 A blob can be read from a channel with the \|ch_readblob()\| function.
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	711
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	712
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	713 Blob index ~
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	714 blob-index E979
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	715 A byte in the Blob can be accessed by putting the index in square brackets
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	716 after the Blob. Indexes are zero-based, thus the first byte has index zero. >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	717 :let myblob = 0z00112233
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	718 :let byte = myblob[0] " get the first byte: 0x00
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	719 :let byte = myblob[2] " get the third byte: 0x22
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	720
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	721 A negative index is counted from the end. Index -1 refers to the last byte in
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	722 the Blob, -2 to the last but one byte, etc. >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	723 :let last = myblob[-1] " get the last byte: 0x33
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	724
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	725 To avoid an error for an invalid index use the \|get()\| function. When an item
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	726 is not available it returns -1 or the default value you specify: >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	727 :echo get(myblob, idx)
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	728 :echo get(myblob, idx, 999)
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	729
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	730
15615 536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	731 Blob iteration ~
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	732
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	733 The \|:for\| loop executes commands for each byte of a Blob. The loop variable is
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	734 set to each byte in the Blob. Example: >
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	735 :for byte in 0z112233
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	736 : call Doit(byte)
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	737 :endfor
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	738 This calls Doit() with 0x11, 0x22 and 0x33.
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	739
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	740
15498 e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	741 Blob concatenation ~
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	742
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	743 Two blobs can be concatenated with the "+" operator: >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	744 :let longblob = myblob + 0z4455
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	745 :let myblob += 0z6677
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	746
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	747 To change a blob in-place see \|blob-modification\| below.
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	748
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	749
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	750 Part of a blob ~
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	751
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	752 A part of the Blob can be obtained by specifying the first and last index,
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	753 separated by a colon in square brackets: >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	754 :let myblob = 0z00112233
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	755 :let shortblob = myblob[1:2] " get 0z1122
15498 e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	756 :let shortblob = myblob[2:-1] " get 0z2233
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	757
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	758 Omitting the first index is similar to zero. Omitting the last index is
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	759 similar to -1. >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	760 :let endblob = myblob[2:] " from item 2 to the end: 0z2233
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	761 :let shortblob = myblob[2:2] " Blob with one byte: 0z22
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	762 :let otherblob = myblob[:] " make a copy of the Blob
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	763
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	764 If the first index is beyond the last byte of the Blob or the second index is
15725 a3e2e7948ee4 patch 8.1.0870: Vim doesn't use the new ConPTY support in Windows 10 Bram Moolenaar <Bram@vim.org> parents: 15711 diff changeset	765 before the first index, the result is an empty Blob. There is no error
15498 e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	766 message.
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	767
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	768 If the second index is equal to or greater than the length of the list the
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	769 length minus one is used: >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	770 :echo myblob[2:8] " result: 0z2233
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	771
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	772
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	773 Blob modification ~
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	774 blob-modification E1182 E1184
15498 e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	775 To change a specific byte of a blob use \|:let\| this way: >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	776 :let blob[4] = 0x44
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	777
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	778 When the index is just one beyond the end of the Blob, it is appended. Any
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	779 higher index is an error.
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	780
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	781 To change a sequence of bytes the [:] notation can be used: >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	782 let blob[1:3] = 0z445566
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	783 The length of the replaced bytes must be exactly the same as the value
15498 e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	784 provided. E972
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	785
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	786 To change part of a blob you can specify the first and last byte to be
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	787 modified. The value must have the same number of bytes in the range: >
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	788 :let blob[3:5] = 0z334455
15498 e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	789
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	790 You can also use the functions \|add()\|, \|remove()\| and \|insert()\|.
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	791
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	792
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	793 Blob identity ~
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	794
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	795 Blobs can be compared for equality: >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	796 if blob == 0z001122
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	797 And for equal identity: >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	798 if blob is otherblob
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	799 < blob-identity E977
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	800 When variable "aa" is a Blob and you assign it to another variable "bb", both
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	801 variables refer to the same Blob. Then the "is" operator returns true.
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	802
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	803 When making a copy using [:] or \|copy()\| the values are the same, but the
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	804 identity is different: >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	805 :let blob = 0z112233
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	806 :let blob2 = blob
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	807 :echo blob == blob2
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	808 < 1 >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	809 :echo blob is blob2
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	810 < 1 >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	811 :let blob3 = blob[:]
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	812 :echo blob == blob3
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	813 < 1 >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	814 :echo blob is blob3
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	815 < 0
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	816
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	817 Making a copy of a Blob is done with the \|copy()\| function. Using [:] also
15498 e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	818 works, as explained above.
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	819
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	820
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	821 1.6 More about variables ~
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	822 more-variables
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	823 If you need to know the type of a variable or expression, use the \|type()\|
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	824 function.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	825
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	826 When the '!' flag is included in the 'viminfo' option, global variables that
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	827 start with an uppercase letter, and don't contain a lowercase letter, are
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	828 stored in the viminfo file \|viminfo-file\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	829
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	830 When the 'sessionoptions' option contains "global", global variables that
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	831 start with an uppercase letter and contain at least one lowercase letter are
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	832 stored in the session file \|session-file\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	833
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	834 variable name can be stored where ~
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	835 my_var_6 not
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	836 My_Var_6 session file
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	837 MY_VAR_6 viminfo file
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	838
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	839
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	840 In legacy script it is possible to form a variable name with curly braces, see
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	841 \|curly-braces-names\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	842
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	843 ==============================================================================
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	844 2. Expression syntax expression-syntax
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	845 E1143
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	846 Expression syntax summary, from least to most significant:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	847
10218 584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e Christian Brabandt <cb@256bit.org> parents: 10198 diff changeset	848 \|expr1\| expr2
10048 43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5 Christian Brabandt <cb@256bit.org> parents: 10038 diff changeset	849 expr2 ? expr1 : expr1 if-then-else
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5 Christian Brabandt <cb@256bit.org> parents: 10038 diff changeset	850
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5 Christian Brabandt <cb@256bit.org> parents: 10038 diff changeset	851 \|expr2\| expr3
16219 bd49e1656c72 patch 8.1.1114: confusing overloaded operator "." for string concatenation Bram Moolenaar <Bram@vim.org> parents: 16213 diff changeset	852 expr3 \|\| expr3 ... logical OR
10048 43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5 Christian Brabandt <cb@256bit.org> parents: 10038 diff changeset	853
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5 Christian Brabandt <cb@256bit.org> parents: 10038 diff changeset	854 \|expr3\| expr4
16219 bd49e1656c72 patch 8.1.1114: confusing overloaded operator "." for string concatenation Bram Moolenaar <Bram@vim.org> parents: 16213 diff changeset	855 expr4 && expr4 ... logical AND
10048 43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5 Christian Brabandt <cb@256bit.org> parents: 10038 diff changeset	856
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5 Christian Brabandt <cb@256bit.org> parents: 10038 diff changeset	857 \|expr4\| expr5
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5 Christian Brabandt <cb@256bit.org> parents: 10038 diff changeset	858 expr5 == expr5 equal
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	859 expr5 != expr5 not equal
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	860 expr5 > expr5 greater than
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	861 expr5 >= expr5 greater than or equal
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	862 expr5 < expr5 smaller than
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	863 expr5 <= expr5 smaller than or equal
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	864 expr5 =~ expr5 regexp matches
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	865 expr5 !~ expr5 regexp doesn't match
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	866
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	867 expr5 ==? expr5 equal, ignoring case
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	868 expr5 ==# expr5 equal, match case
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	869 etc. As above, append ? for ignoring case, # for
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	870 matching case
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	871
15615 536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	872 expr5 is expr5 same \|List\|, \|Dictionary\| or \|Blob\| instance
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	873 expr5 isnot expr5 different \|List\|, \|Dictionary\| or \|Blob\|
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	874 instance
79 e918d3e340a4 updated for version 7.0032 vimboss parents: 75 diff changeset	875
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	876 \|expr5\| expr6 << expr6 bitwise left shift
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	877 expr6 >> expr6 bitwise right shift
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	878
10048 43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5 Christian Brabandt <cb@256bit.org> parents: 10038 diff changeset	879 \|expr6\| expr7
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	880 expr7 + expr7 ... number addition, list or blob concatenation
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	881 expr7 - expr7 ... number subtraction
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	882 expr7 . expr7 ... string concatenation
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	883 expr7 .. expr7 ... string concatenation
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	884
10048 43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5 Christian Brabandt <cb@256bit.org> parents: 10038 diff changeset	885 \|expr7\| expr8
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	886 expr8 * expr8 ... number multiplication
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	887 expr8 / expr8 ... number division
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	888 expr8 % expr8 ... number modulo
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	889
10048 43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5 Christian Brabandt <cb@256bit.org> parents: 10038 diff changeset	890 \|expr8\| expr9
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	891 <type>expr9 type check and conversion (\|Vim9\| only)
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	892
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	893 \|expr9\| expr10
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	894 ! expr9 logical NOT
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	895 - expr9 unary minus
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	896 + expr9 unary plus
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	897
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	898 \|expr10\| expr11
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	899 expr10[expr1] byte of a String or item of a \|List\|
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	900 expr10[expr1 : expr1] substring of a String or sublist of a \|List\|
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	901 expr10.name entry in a \|Dictionary\|
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	902 expr10(expr1, ...) function call with \|Funcref\| variable
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	903 expr10->name(expr1, ...) \|method\| call
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	904
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	905 \|expr11\| number number constant
26 404aac550f35 updated for version 7.0017 vimboss parents: 24 diff changeset	906 "string" string constant, backslash is special
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	907 'string' string constant, ' is doubled
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	908 [expr1, ...] \|List\|
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	909 {expr1: expr1, ...} \|Dictionary\|
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	910 #{key: expr1, ...} legacy \|Dictionary\|
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	911 &option option value
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	912 (expr1) nested expression
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	913 variable internal variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	914 va{ria}ble internal variable with curly braces
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	915 $VAR environment variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	916 @r contents of register 'r'
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	917 function(expr1, ...) function call
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	918 func{ti}on(expr1, ...) function call with curly braces
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	919 {args -> expr1} legacy lambda expression
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	920 (args) => expr1 Vim9 lambda expression
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	921
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	922
16219 bd49e1656c72 patch 8.1.1114: confusing overloaded operator "." for string concatenation Bram Moolenaar <Bram@vim.org> parents: 16213 diff changeset	923 "..." indicates that the operations in this level can be concatenated.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	924 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	925 &nu \|\| &list && &shell == "csh"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	926
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	927 All expressions within one level are parsed from left to right.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	928
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	929 Expression nesting is limited to 1000 levels deep (300 when build with MSVC)
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	930 to avoid running out of stack and crashing. E1169
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	931
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	932
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	933 expr1 expr1 ternary falsy-operator ?? E109
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	934 -----
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	935
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	936 The ternary operator: expr2 ? expr1 : expr1
22492 0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	937 The falsy operator: expr2 ?? expr1
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	938
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	939 Ternary operator ~
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	940
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	941 In legacy script the expression before the '?' is evaluated to a number. If
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	942 it evaluates to \|TRUE\|, the result is the value of the expression between the
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	943 '?' and ':', otherwise the result is the value of the expression after the
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	944 ':'.
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	945
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	946 In \|Vim9\| script the first expression must evaluate to a boolean, see
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	947 \|vim9-boolean\|.
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	948
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	949 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	950 :echo lnum == 1 ? "top" : lnum
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	951
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	952 Since the first expression is an "expr2", it cannot contain another ?:. The
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	953 other two expressions can, thus allow for recursive use of ?:.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	954 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	955 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	956
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	957 To keep this readable, using \|line-continuation\| is suggested: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	958 :echo lnum == 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	959 :\ ? "top"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	960 :\ : lnum == 1000
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	961 :\ ? "last"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	962 :\ : lnum
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	963
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	964 You should always put a space before the ':', otherwise it can be mistaken for
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	965 use in a variable such as "a:1".
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	966
22492 0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	967 Falsy operator ~
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	968
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	969 This is also known as the "null coalescing operator", but that's too
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	970 complicated, thus we just call it the falsy operator.
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	971
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	972 The expression before the '??' is evaluated. If it evaluates to
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	973 \|truthy\|, this is used as the result. Otherwise the expression after the '??'
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	974 is evaluated and used as the result. This is most useful to have a default
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	975 value for an expression that may result in zero or empty: >
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	976 echo theList ?? 'list is empty'
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	977 echo GetName() ?? 'unknown'
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	978
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	979 These are similar, but not equal: >
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	980 expr2 ?? expr1
0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	981 expr2 ? expr2 : expr1
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	982 In the second line "expr2" is evaluated twice. And in \|Vim9\| script the type
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	983 of expr2 before "?" must be a boolean.
22492 0e03ef68e738 patch 8.2.1794: no falsy Coalescing operator Bram Moolenaar <Bram@vim.org> parents: 22446 diff changeset	984
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	985
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	986 expr2 and expr3 expr2 expr3
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	987 ---------------
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	988
10038 7cf4e210cf3c commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672 Christian Brabandt <cb@256bit.org> parents: 10027 diff changeset	989 expr3 \|\| expr3 .. logical OR expr-barbar
7cf4e210cf3c commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672 Christian Brabandt <cb@256bit.org> parents: 10027 diff changeset	990 expr4 && expr4 .. logical AND expr-&&
7cf4e210cf3c commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672 Christian Brabandt <cb@256bit.org> parents: 10027 diff changeset	991
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	992 The "\|\|" and "&&" operators take one argument on each side.
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	993
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	994 In legacy script the arguments are (converted to) Numbers.
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	995
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	996 In \|Vim9\| script the values must be boolean, see \|vim9-boolean\|. Use "!!" to
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	997 convert any type to a boolean.
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	998
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	999 The result is:
9422 f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	1000 input output ~
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	1001 n1 n2 n1 \|\| n2 n1 && n2 ~
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	1002 \|FALSE\| \|FALSE\| \|FALSE\| \|FALSE\|
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	1003 \|FALSE\| \|TRUE\| \|TRUE\| \|FALSE\|
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	1004 \|TRUE\| \|FALSE\| \|TRUE\| \|FALSE\|
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	1005 \|TRUE\| \|TRUE\| \|TRUE\| \|TRUE\|
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1006
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1007 The operators can be concatenated, for example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1008
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1009 &nu \|\| &list && &shell == "csh"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1010
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1011 Note that "&&" takes precedence over "\|\|", so this has the meaning of: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1012
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1013 &nu \|\| (&list && &shell == "csh")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1014
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1015 Once the result is known, the expression "short-circuits", that is, further
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1016 arguments are not evaluated. This is like what happens in C. For example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1017
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1018 let a = 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1019 echo a \|\| b
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1020
9422 f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	1021 This is valid even if there is no variable called "b" because "a" is \|TRUE\|,
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	1022 so the result must be \|TRUE\|. Similarly below: >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1023
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1024 echo exists("b") && b == "yes"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1025
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1026 This is valid whether "b" has been defined or not. The second clause will
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1027 only be evaluated if "b" has been defined.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1028
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1029
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	1030 expr4 expr4 E1153
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1031 -----
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1032
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1033 expr5 {cmp} expr5
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1034
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1035 Compare two expr5 expressions. In legacy script the result is a 0 if it
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1036 evaluates to false, or 1 if it evaluates to true. In \|Vim9\| script the result
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1037 is \|true\| or \|false\|.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1038
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1039 expr-== expr-!= expr-> expr->=
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1040 expr-< expr-<= expr-=~ expr-!~
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1041 expr-==# expr-!=# expr-># expr->=#
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1042 expr-<# expr-<=# expr-=~# expr-!~#
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1043 expr-==? expr-!=? expr->? expr->=?
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1044 expr-<? expr-<=? expr-=~? expr-!~?
2908 fd09a9c8468e Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2902 diff changeset	1045 expr-is expr-isnot expr-is# expr-isnot#
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	1046 expr-is? expr-isnot? E1072
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1047 use 'ignorecase' match case ignore case ~
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1048 equal == ==# ==?
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1049 not equal != !=# !=?
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1050 greater than > ># >?
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1051 greater than or equal >= >=# >=?
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1052 smaller than < <# <?
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1053 smaller than or equal <= <=# <=?
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1054 regexp matches =~ =~# =~?
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1055 regexp doesn't match !~ !~# !~?
2908 fd09a9c8468e Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2902 diff changeset	1056 same instance is is# is?
fd09a9c8468e Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2902 diff changeset	1057 different instance isnot isnot# isnot?
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1058
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1059 Examples:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1060 "abc" ==# "Abc" evaluates to 0
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1061 "abc" ==? "Abc" evaluates to 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1062 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1063 NOTE: In \|Vim9\| script 'ignorecase' is not used.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1064
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	1065 E691 E692
12756 3b26420fc639 Long overdue runtime update. Christian Brabandt <cb@256bit.org> parents: 12722 diff changeset	1066 A \|List\| can only be compared with a \|List\| and only "equal", "not equal",
3b26420fc639 Long overdue runtime update. Christian Brabandt <cb@256bit.org> parents: 12722 diff changeset	1067 "is" and "isnot" can be used. This compares the values of the list,
3b26420fc639 Long overdue runtime update. Christian Brabandt <cb@256bit.org> parents: 12722 diff changeset	1068 recursively. Ignoring case means case is ignored when comparing item values.
79 e918d3e340a4 updated for version 7.0032 vimboss parents: 75 diff changeset	1069
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	1070 E735 E736
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	1071 A \|Dictionary\| can only be compared with a \|Dictionary\| and only "equal", "not
12756 3b26420fc639 Long overdue runtime update. Christian Brabandt <cb@256bit.org> parents: 12722 diff changeset	1072 equal", "is" and "isnot" can be used. This compares the key/values of the
3b26420fc639 Long overdue runtime update. Christian Brabandt <cb@256bit.org> parents: 12722 diff changeset	1073 \|Dictionary\| recursively. Ignoring case means case is ignored when comparing
3b26420fc639 Long overdue runtime update. Christian Brabandt <cb@256bit.org> parents: 12722 diff changeset	1074 item values.
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	1075
8951 0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed Christian Brabandt <cb@256bit.org> parents: 8883 diff changeset	1076 E694
9407 619a98a67f67 commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223 Christian Brabandt <cb@256bit.org> parents: 9389 diff changeset	1077 A \|Funcref\| can only be compared with a \|Funcref\| and only "equal", "not
619a98a67f67 commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223 Christian Brabandt <cb@256bit.org> parents: 9389 diff changeset	1078 equal", "is" and "isnot" can be used. Case is never ignored. Whether
619a98a67f67 commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223 Christian Brabandt <cb@256bit.org> parents: 9389 diff changeset	1079 arguments or a Dictionary are bound (with a partial) matters. The
619a98a67f67 commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223 Christian Brabandt <cb@256bit.org> parents: 9389 diff changeset	1080 Dictionaries must also be equal (or the same, in case of "is") and the
619a98a67f67 commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223 Christian Brabandt <cb@256bit.org> parents: 9389 diff changeset	1081 arguments must be equal (or the same).
619a98a67f67 commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223 Christian Brabandt <cb@256bit.org> parents: 9389 diff changeset	1082
619a98a67f67 commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223 Christian Brabandt <cb@256bit.org> parents: 9389 diff changeset	1083 To compare Funcrefs to see if they refer to the same function, ignoring bound
619a98a67f67 commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223 Christian Brabandt <cb@256bit.org> parents: 9389 diff changeset	1084 Dictionary and arguments, use \|get()\| to get the function name: >
619a98a67f67 commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223 Christian Brabandt <cb@256bit.org> parents: 9389 diff changeset	1085 if get(Part1, 'name') == get(Part2, 'name')
619a98a67f67 commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223 Christian Brabandt <cb@256bit.org> parents: 9389 diff changeset	1086 " Part1 and Part2 refer to the same function
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	1087 < E1037
15615 536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	1088 Using "is" or "isnot" with a \|List\|, \|Dictionary\| or \|Blob\| checks whether
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	1089 the expressions are referring to the same \|List\|, \|Dictionary\| or \|Blob\|
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	1090 instance. A copy of a \|List\| is different from the original \|List\|. When
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	1091 using "is" without a \|List\|, \|Dictionary\| or \|Blob\|, it is equivalent to
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	1092 using "equal", using "isnot" equivalent to using "not equal". Except that
536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	1093 a different type means the values are different: >
8534 485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5 Christian Brabandt <cb@256bit.org> parents: 8512 diff changeset	1094 echo 4 == '4'
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5 Christian Brabandt <cb@256bit.org> parents: 8512 diff changeset	1095 1
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5 Christian Brabandt <cb@256bit.org> parents: 8512 diff changeset	1096 echo 4 is '4'
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5 Christian Brabandt <cb@256bit.org> parents: 8512 diff changeset	1097 0
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5 Christian Brabandt <cb@256bit.org> parents: 8512 diff changeset	1098 echo 0 is []
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5 Christian Brabandt <cb@256bit.org> parents: 8512 diff changeset	1099 0
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5 Christian Brabandt <cb@256bit.org> parents: 8512 diff changeset	1100 "is#"/"isnot#" and "is?"/"isnot?" can be used to match and ignore case.
79 e918d3e340a4 updated for version 7.0032 vimboss parents: 75 diff changeset	1101
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1102 In legacy script, when comparing a String with a Number, the String is
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1103 converted to a Number, and the comparison is done on Numbers. This means
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1104 that: >
8534 485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5 Christian Brabandt <cb@256bit.org> parents: 8512 diff changeset	1105 echo 0 == 'x'
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5 Christian Brabandt <cb@256bit.org> parents: 8512 diff changeset	1106 1
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5 Christian Brabandt <cb@256bit.org> parents: 8512 diff changeset	1107 because 'x' converted to a Number is zero. However: >
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5 Christian Brabandt <cb@256bit.org> parents: 8512 diff changeset	1108 echo [0] == ['x']
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5 Christian Brabandt <cb@256bit.org> parents: 8512 diff changeset	1109 0
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5 Christian Brabandt <cb@256bit.org> parents: 8512 diff changeset	1110 Inside a List or Dictionary this conversion is not used.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1111
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1112 In \|Vim9\| script the types must match.
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1113
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1114 When comparing two Strings, this is done with strcmp() or stricmp(). This
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1115 results in the mathematical difference (comparing byte values), not
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1116 necessarily the alphabetical difference in the local language.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1117
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1118 When using the operators with a trailing '#', or the short version and
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	1119 'ignorecase' is off, the comparing is done with strcmp(): case matters.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1120
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1121 When using the operators with a trailing '?', or the short version and
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	1122 'ignorecase' is set, the comparing is done with stricmp(): case is ignored.
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	1123
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	1124 'smartcase' is not used.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1125
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1126 The "=~" and "!~" operators match the lefthand argument with the righthand
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1127 argument, which is used as a pattern. See \|pattern\| for what a pattern is.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1128 This matching is always done like 'magic' was set and 'cpoptions' is empty, no
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1129 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1130 portable. To avoid backslashes in the regexp pattern to be doubled, use a
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1131 single-quote string, see \|literal-string\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1132 Since a string is considered to be a single line, a multi-line pattern
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1133 (containing \n, backslash-n) will not match. However, a literal NL character
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1134 can be matched like an ordinary character. Examples:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1135 "foo\nbar" =~ "\n" evaluates to 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1136 "foo\nbar" =~ "\\n" evaluates to 0
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1137
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1138
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1139 expr5 expr5 bitwise-shift
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1140 -----
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1141 expr6 << expr6 bitwise left shift expr-<<
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1142 expr6 >> expr6 bitwise right shift expr->>
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1143 E1282 E1283
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1144 The "<<" and ">>" operators can be used to perform bitwise left or right shift
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1145 of the left operand by the number of bits specified by the right operand. The
28964 8973f2f00872 patch 8.2.5004: right shift on negative number does not work as documented Bram Moolenaar <Bram@vim.org> parents: 28962 diff changeset	1146 operands are used as positive numbers. When shifting right with ">>" the
29193 1e9e9d89f0ee Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29066 diff changeset	1147 topmost bit (sometimes called the sign bit) is cleared. If the right operand
28964 8973f2f00872 patch 8.2.5004: right shift on negative number does not work as documented Bram Moolenaar <Bram@vim.org> parents: 28962 diff changeset	1148 (shift amount) is more than the maximum number of bits in a number
8973f2f00872 patch 8.2.5004: right shift on negative number does not work as documented Bram Moolenaar <Bram@vim.org> parents: 28962 diff changeset	1149 (\|v:numbersize\|) the result is zero.
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1150
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1151
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1152 expr6 and expr7 expr6 expr7 E1036 E1051
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1153 ---------------
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1154 expr7 + expr7 Number addition, \|List\| or \|Blob\| concatenation expr-+
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1155 expr7 - expr7 Number subtraction expr--
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1156 expr7 . expr7 String concatenation expr-.
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1157 expr7 .. expr7 String concatenation expr-..
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1158
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1159 For \|Lists\| only "+" is possible and then both expr7 must be a list. The
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	1160 result is a new list with the two lists Concatenated.
79 e918d3e340a4 updated for version 7.0032 vimboss parents: 75 diff changeset	1161
16219 bd49e1656c72 patch 8.1.1114: confusing overloaded operator "." for string concatenation Bram Moolenaar <Bram@vim.org> parents: 16213 diff changeset	1162 For String concatenation ".." is preferred, since "." is ambiguous, it is also
bd49e1656c72 patch 8.1.1114: confusing overloaded operator "." for string concatenation Bram Moolenaar <Bram@vim.org> parents: 16213 diff changeset	1163 used for \|Dict\| member access and floating point numbers.
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1164 In \|Vim9\| script and when \|vimscript-version\| is 2 or higher, using "." is not
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1165 allowed.
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1166
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1167 In \|Vim9\| script the arguments of ".." are converted to String for simple
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1168 types: Number, Float, Special and Bool. For other types \|string()\| should be
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1169 used.
16219 bd49e1656c72 patch 8.1.1114: confusing overloaded operator "." for string concatenation Bram Moolenaar <Bram@vim.org> parents: 16213 diff changeset	1170
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1171 expr8 * expr8 Number multiplication expr-star
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1172 expr8 / expr8 Number division expr-/
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1173 expr8 % expr8 Number modulo expr-%
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1174
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1175 In legacy script, for all operators except "." and "..", Strings are converted
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1176 to Numbers.
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1177
3214 cd145cc2f2c9 updated for version 7.3.377 Bram Moolenaar <bram@vim.org> parents: 3153 diff changeset	1178 For bitwise operators see \|and()\|, \|or()\| and \|xor()\|.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1179
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1180 Note the difference between "+" and ".." in legacy script:
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1181 "123" + "456" = 579
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1182 "123" .. "456" = "123456"
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1183
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1184 Since '..' has the same precedence as '+' and '-', you need to read: >
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1185 1 .. 90 + 90.0
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1186 As: >
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1187 (1 .. 90) + 90.0
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1188 That works in legacy script, since the String "190" is automatically converted
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1189 to the Number 190, which can be added to the Float 90.0. However: >
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1190 1 .. 90 * 90.0
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1191 Should be read as: >
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1192 1 .. (90 * 90.0)
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1193 Since '..' has lower precedence than '*'. This does NOT work, since this
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1194 attempts to concatenate a Float and a String.
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1195
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1196 When dividing a Number by zero the result depends on the value:
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1197 0 / 0 = -0x80000000 (like NaN for Float)
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1198 >0 / 0 = 0x7fffffff (like positive infinity)
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1199 <0 / 0 = -0x7fffffff (like negative infinity)
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1200 (before Vim 7.2 it was always 0x7fffffff)
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	1201 In \|Vim9\| script dividing a number by zero is an error. E1154
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1202
9389 32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12 Christian Brabandt <cb@256bit.org> parents: 9344 diff changeset	1203 When 64-bit Number support is enabled:
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12 Christian Brabandt <cb@256bit.org> parents: 9344 diff changeset	1204 0 / 0 = -0x8000000000000000 (like NaN for Float)
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12 Christian Brabandt <cb@256bit.org> parents: 9344 diff changeset	1205 >0 / 0 = 0x7fffffffffffffff (like positive infinity)
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12 Christian Brabandt <cb@256bit.org> parents: 9344 diff changeset	1206 <0 / 0 = -0x7fffffffffffffff (like negative infinity)
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12 Christian Brabandt <cb@256bit.org> parents: 9344 diff changeset	1207
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1208 When the righthand side of '%' is zero, the result is 0.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1209
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	1210 None of these work for \|Funcref\|s.
79 e918d3e340a4 updated for version 7.0032 vimboss parents: 75 diff changeset	1211
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	1212 ".", ".." and "%" do not work for Float. E804 E1035
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1213
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1214
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1215 expr8 expr8
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1216 -----
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1217 <type>expr9
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1218
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1219 This is only available in \|Vim9\| script, see \|type-casting\|.
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1220
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1221
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1222 expr9 expr9
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1223 -----
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1224 ! expr9 logical NOT expr-!
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1225 - expr9 unary minus expr-unary--
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1226 + expr9 unary plus expr-unary-+
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1227
9422 f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057 Christian Brabandt <cb@256bit.org> parents: 9416 diff changeset	1228 For '!' \|TRUE\| becomes \|FALSE\|, \|FALSE\| becomes \|TRUE\| (one).
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1229 For '-' the sign of the number is changed.
23563 87671ccc6c6b patch 8.2.2324: not easy to get mark en cursor posotion by character count Bram Moolenaar <Bram@vim.org> parents: 23475 diff changeset	1230 For '+' the number is unchanged. Note: "++" has no effect.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1231
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1232 In legacy script a String will be converted to a Number first. Note that if
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1233 the string does not start with a digit you likely don't get what you expect.
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1234
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1235 In \|Vim9\| script an error is given when "-" or "+" is used and the type is not
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1236 a number.
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1237
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1238 In \|Vim9\| script "!" can be used for any type and the result is always a
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1239 boolean. Use "!!" to convert any type to a boolean, according to whether the
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1240 value is \|falsy\|.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1241
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	1242 These three can be repeated and mixed. Examples:
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1243 !-1 == 0
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1244 !!8 == 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1245 --9 == 9
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1246
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1247
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1248 expr10 expr10
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1249 ------
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1250 This expression is either \|expr11\| or a sequence of the alternatives below,
14637 0ecb909e3249 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14601 diff changeset	1251 in any order. E.g., these are all possible:
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1252 expr10[expr1].name
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1253 expr10.name[expr1]
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1254 expr10(expr1, ...)[expr1].name
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1255 expr10->(expr1, ...)[expr1]
17612 e259d11e2900 patch 8.1.1803: all builtin functions are global Bram Moolenaar <Bram@vim.org> parents: 17571 diff changeset	1256 Evaluation is always from left to right.
14637 0ecb909e3249 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14601 diff changeset	1257
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1258 expr10[expr1] item of String or \|List\| expr-[] E111
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	1259 E909 subscript E1062
21823 b1f3d8a44ab6 patch 8.2.1461: Vim9: string indexes are counted in bytes Bram Moolenaar <Bram@vim.org> parents: 21703 diff changeset	1260 In legacy Vim script:
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1261 If expr10 is a Number or String this results in a String that contains the
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1262 expr1'th single byte from expr10. expr10 is used as a String (a number is
21823 b1f3d8a44ab6 patch 8.2.1461: Vim9: string indexes are counted in bytes Bram Moolenaar <Bram@vim.org> parents: 21703 diff changeset	1263 automatically converted to a String), expr1 as a Number. This doesn't
21991 bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21989 diff changeset	1264 recognize multibyte encodings, see `byteidx()` for an alternative, or use
21823 b1f3d8a44ab6 patch 8.2.1461: Vim9: string indexes are counted in bytes Bram Moolenaar <Bram@vim.org> parents: 21703 diff changeset	1265 `split()` to turn the string into a list of characters. Example, to get the
b1f3d8a44ab6 patch 8.2.1461: Vim9: string indexes are counted in bytes Bram Moolenaar <Bram@vim.org> parents: 21703 diff changeset	1266 byte under the cursor: >
823 9ab23f1e137f updated for version 7.0c12 vimboss parents: 819 diff changeset	1267 :let c = getline(".")[col(".") - 1]
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1268
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	1269 In \|Vim9\| script: E1147 E1148
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1270 If expr10 is a String this results in a String that contains the expr1'th
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1271 single character (including any composing characters) from expr10. To use byte
24132 512f48dc7100 patch 8.2.2607: strcharpart() cannot include composing characters Bram Moolenaar <Bram@vim.org> parents: 24130 diff changeset	1272 indexes use \|strpart()\|.
21823 b1f3d8a44ab6 patch 8.2.1461: Vim9: string indexes are counted in bytes Bram Moolenaar <Bram@vim.org> parents: 21703 diff changeset	1273
b1f3d8a44ab6 patch 8.2.1461: Vim9: string indexes are counted in bytes Bram Moolenaar <Bram@vim.org> parents: 21703 diff changeset	1274 Index zero gives the first byte or character. Careful: text column numbers
b1f3d8a44ab6 patch 8.2.1461: Vim9: string indexes are counted in bytes Bram Moolenaar <Bram@vim.org> parents: 21703 diff changeset	1275 start with one!
b1f3d8a44ab6 patch 8.2.1461: Vim9: string indexes are counted in bytes Bram Moolenaar <Bram@vim.org> parents: 21703 diff changeset	1276
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1277 If the length of the String is less than the index, the result is an empty
7659 07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb Christian Brabandt <cb@256bit.org> parents: 7653 diff changeset	1278 String. A negative index always results in an empty string (reason: backward
21823 b1f3d8a44ab6 patch 8.2.1461: Vim9: string indexes are counted in bytes Bram Moolenaar <Bram@vim.org> parents: 21703 diff changeset	1279 compatibility). Use [-1:] to get the last byte or character.
23563 87671ccc6c6b patch 8.2.2324: not easy to get mark en cursor posotion by character count Bram Moolenaar <Bram@vim.org> parents: 23475 diff changeset	1280 In Vim9 script a negative index is used like with a list: count from the end.
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1281
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1282 If expr10 is a \|List\| then it results the item at index expr1. See \|list-index\|
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1283 for possible index values. If the index is out of range this results in an
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	1284 error. Example: >
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1285 :let item = mylist[-1] " get last item
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1286
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	1287 Generally, if a \|List\| index is equal to or higher than the length of the
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	1288 \|List\|, or more negative than the length of the \|List\|, this results in an
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	1289 error.
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1290
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	1291
29290 dc4de65a7fb7 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29236 diff changeset	1292 expr10[expr1a : expr1b] substring or \|sublist\| expr-[:] substring
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1293
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1294 If expr10 is a String this results in the substring with the bytes or
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1295 characters from expr1a to and including expr1b. expr10 is used as a String,
21991 bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21989 diff changeset	1296 expr1a and expr1b are used as a Number.
21823 b1f3d8a44ab6 patch 8.2.1461: Vim9: string indexes are counted in bytes Bram Moolenaar <Bram@vim.org> parents: 21703 diff changeset	1297
b1f3d8a44ab6 patch 8.2.1461: Vim9: string indexes are counted in bytes Bram Moolenaar <Bram@vim.org> parents: 21703 diff changeset	1298 In legacy Vim script the indexes are byte indexes. This doesn't recognize
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1299 multibyte encodings, see \|byteidx()\| for computing the indexes. If expr10 is
21823 b1f3d8a44ab6 patch 8.2.1461: Vim9: string indexes are counted in bytes Bram Moolenaar <Bram@vim.org> parents: 21703 diff changeset	1300 a Number it is first converted to a String.
b1f3d8a44ab6 patch 8.2.1461: Vim9: string indexes are counted in bytes Bram Moolenaar <Bram@vim.org> parents: 21703 diff changeset	1301
24132 512f48dc7100 patch 8.2.2607: strcharpart() cannot include composing characters Bram Moolenaar <Bram@vim.org> parents: 24130 diff changeset	1302 In Vim9 script the indexes are character indexes and include composing
512f48dc7100 patch 8.2.2607: strcharpart() cannot include composing characters Bram Moolenaar <Bram@vim.org> parents: 24130 diff changeset	1303 characters. To use byte indexes use \|strpart()\|. To use character indexes
512f48dc7100 patch 8.2.2607: strcharpart() cannot include composing characters Bram Moolenaar <Bram@vim.org> parents: 24130 diff changeset	1304 without including composing characters use \|strcharpart()\|.
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1305
23604 1816ea68c022 patch 8.2.2344: using inclusive index for slice is not always desired Bram Moolenaar <Bram@vim.org> parents: 23602 diff changeset	1306 The item at index expr1b is included, it is inclusive. For an exclusive index
1816ea68c022 patch 8.2.2344: using inclusive index for slice is not always desired Bram Moolenaar <Bram@vim.org> parents: 23602 diff changeset	1307 use the \|slice()\| function.
1816ea68c022 patch 8.2.2344: using inclusive index for slice is not always desired Bram Moolenaar <Bram@vim.org> parents: 23602 diff changeset	1308
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1309 If expr1a is omitted zero is used. If expr1b is omitted the length of the
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1310 string minus one is used.
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1311
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1312 A negative number can be used to measure from the end of the string. -1 is
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1313 the last character, -2 the last but one, etc.
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1314
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1315 If an index goes out of range for the string characters are omitted. If
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1316 expr1b is smaller than expr1a the result is an empty string.
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1317
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1318 Examples: >
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1319 :let c = name[-1:] " last byte of a string
21991 bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21989 diff changeset	1320 :let c = name[0:-1] " the whole string
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1321 :let c = name[-2:-2] " last but one byte of a string
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1322 :let s = line(".")[4:] " from the fifth byte to the end
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1323 :let s = s[:-3] " remove last two bytes
2033 de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1998 diff changeset	1324 <
9737 35ce559b8553 commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380 Christian Brabandt <cb@256bit.org> parents: 9723 diff changeset	1325 slice
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1326 If expr10 is a \|List\| this results in a new \|List\| with the items indicated by
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	1327 the indexes expr1a and expr1b. This works like with a String, as explained
9737 35ce559b8553 commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380 Christian Brabandt <cb@256bit.org> parents: 9723 diff changeset	1328 just above. Also see \|sublist\| below. Examples: >
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1329 :let l = mylist[:3] " first four items
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1330 :let l = mylist[4:4] " List with one item
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1331 :let l = mylist[:] " shallow copy of a List
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	1332
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1333 If expr10 is a \|Blob\| this results in a new \|Blob\| with the bytes in the
15454 1d2b5c016f17 patch 8.1.0735: cannot handle binary data Bram Moolenaar <Bram@vim.org> parents: 15446 diff changeset	1334 indexes expr1a and expr1b, inclusive. Examples: >
1d2b5c016f17 patch 8.1.0735: cannot handle binary data Bram Moolenaar <Bram@vim.org> parents: 15446 diff changeset	1335 :let b = 0zDEADBEEF
1d2b5c016f17 patch 8.1.0735: cannot handle binary data Bram Moolenaar <Bram@vim.org> parents: 15446 diff changeset	1336 :let bs = b[1:2] " 0zADBE
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	1337 :let bs = b[:] " copy of 0zDEADBEEF
15454 1d2b5c016f17 patch 8.1.0735: cannot handle binary data Bram Moolenaar <Bram@vim.org> parents: 15446 diff changeset	1338
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1339 Using expr10[expr1] or expr10[expr1a : expr1b] on a \|Funcref\| results in an
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	1340 error.
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	1341
7615 228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c Christian Brabandt <cb@256bit.org> parents: 7597 diff changeset	1342 Watch out for confusion between a namespace and a variable followed by a colon
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c Christian Brabandt <cb@256bit.org> parents: 7597 diff changeset	1343 for a sublist: >
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c Christian Brabandt <cb@256bit.org> parents: 7597 diff changeset	1344 mylist[n:] " uses variable n
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c Christian Brabandt <cb@256bit.org> parents: 7597 diff changeset	1345 mylist[s:] " uses namespace s:, error!
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c Christian Brabandt <cb@256bit.org> parents: 7597 diff changeset	1346
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	1347
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1348 expr10.name entry in a \|Dictionary\| expr-entry
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	1349 E1203 E1229
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1350 If expr10 is a \|Dictionary\| and it is followed by a dot, then the following
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	1351 name will be used as a key in the \|Dictionary\|. This is just like:
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1352 expr10[name].
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	1353
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	1354 The name must consist of alphanumeric characters, just like a variable name,
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	1355 but it may start with a number. Curly braces cannot be used.
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	1356
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	1357 There must not be white space before or after the dot.
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	1358
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	1359 Examples: >
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	1360 :let dict = {"one": 1, 2: "two"}
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16704 diff changeset	1361 :echo dict.one " shows "1"
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16704 diff changeset	1362 :echo dict.2 " shows "two"
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16704 diff changeset	1363 :echo dict .2 " error because of space before the dot
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	1364
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	1365 Note that the dot is also used for String concatenation. To avoid confusion
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	1366 always put spaces around the dot for String concatenation.
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	1367
04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	1368
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1369 expr10(expr1, ...) \|Funcref\| function call E1085
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1370
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1371 When expr10 is a \|Funcref\| type variable, invoke the function it refers to.
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1372
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1373
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1374 expr10->name([args]) method call method ->
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1375 expr10->{lambda}([args])
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	1376 E260 E276 E1265
17620 072efa9ca875 patch 8.1.1807: more functions can be used as a method Bram Moolenaar <Bram@vim.org> parents: 17612 diff changeset	1377 For methods that are also available as global functions this is the same as: >
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1378 name(expr10 [, args])
abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1379 There can also be methods specifically for the type of "expr10".
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	1380
17661 da7890e3359b patch 8.1.1828: not strict enough checking syntax of method invocation Bram Moolenaar <Bram@vim.org> parents: 17624 diff changeset	1381 This allows for chaining, passing the value that one method returns to the
da7890e3359b patch 8.1.1828: not strict enough checking syntax of method invocation Bram Moolenaar <Bram@vim.org> parents: 17624 diff changeset	1382 next method: >
17620 072efa9ca875 patch 8.1.1807: more functions can be used as a method Bram Moolenaar <Bram@vim.org> parents: 17612 diff changeset	1383 mylist->filter(filterexpr)->map(mapexpr)->sort()->join()
072efa9ca875 patch 8.1.1807: more functions can be used as a method Bram Moolenaar <Bram@vim.org> parents: 17612 diff changeset	1384 <
17674 06c3e15ad84d patch 8.1.1834: cannot use a lambda as a method Bram Moolenaar <Bram@vim.org> parents: 17667 diff changeset	1385 Example of using a lambda: >
17916 2e53305f2239 patch 8.1.1954: more functions can be used as a method Bram Moolenaar <Bram@vim.org> parents: 17914 diff changeset	1386 GetPercentage()->{x -> x * 100}()->printf('%d%%')
17758 f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	1387 <
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1388 When using -> the \|expr9\| operators will be applied first, thus: >
17765 545119cd5554 patch 8.1.1879: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17758 diff changeset	1389 -1.234->string()
545119cd5554 patch 8.1.1879: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17758 diff changeset	1390 Is equivalent to: >
545119cd5554 patch 8.1.1879: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17758 diff changeset	1391 (-1.234)->string()
545119cd5554 patch 8.1.1879: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17758 diff changeset	1392 And NOT: >
545119cd5554 patch 8.1.1879: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17758 diff changeset	1393 -(1.234->string())
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	1394
3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	1395 What comes after "->" can be a name, a simple expression (not containing any
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27635 diff changeset	1396 parenthesis), or any expression in parentheses: >
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	1397 base->name(args)
3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	1398 base->some.name(args)
3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	1399 base->alist[idx](args)
3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	1400 base->(getFuncRef())(args)
3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	1401 Note that in the last call the base is passed to the function resulting from
29533 34c1f4cd0c18 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29501 diff changeset	1402 "(getFuncRef())", inserted before "args". E1275
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	1403
17661 da7890e3359b patch 8.1.1828: not strict enough checking syntax of method invocation Bram Moolenaar <Bram@vim.org> parents: 17624 diff changeset	1404 E274
da7890e3359b patch 8.1.1828: not strict enough checking syntax of method invocation Bram Moolenaar <Bram@vim.org> parents: 17624 diff changeset	1405 "->name(" must not contain white space. There can be white space before the
da7890e3359b patch 8.1.1828: not strict enough checking syntax of method invocation Bram Moolenaar <Bram@vim.org> parents: 17624 diff changeset	1406 "->" and after the "(", thus you can split the lines like this: >
da7890e3359b patch 8.1.1828: not strict enough checking syntax of method invocation Bram Moolenaar <Bram@vim.org> parents: 17624 diff changeset	1407 mylist
da7890e3359b patch 8.1.1828: not strict enough checking syntax of method invocation Bram Moolenaar <Bram@vim.org> parents: 17624 diff changeset	1408 \ ->filter(filterexpr)
da7890e3359b patch 8.1.1828: not strict enough checking syntax of method invocation Bram Moolenaar <Bram@vim.org> parents: 17624 diff changeset	1409 \ ->map(mapexpr)
da7890e3359b patch 8.1.1828: not strict enough checking syntax of method invocation Bram Moolenaar <Bram@vim.org> parents: 17624 diff changeset	1410 \ ->sort()
da7890e3359b patch 8.1.1828: not strict enough checking syntax of method invocation Bram Moolenaar <Bram@vim.org> parents: 17624 diff changeset	1411 \ ->join()
17758 f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	1412
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	1413 When using the lambda form there must be no white space between the } and the
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	1414 (.
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	1415
17620 072efa9ca875 patch 8.1.1807: more functions can be used as a method Bram Moolenaar <Bram@vim.org> parents: 17612 diff changeset	1416
28962 abdea69d21b6 patch 8.2.5003: cannot do bitwise shifts Bram Moolenaar <Bram@vim.org> parents: 28862 diff changeset	1417 expr11
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1418 number
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1419 ------
12785 65d7fd8381a3 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 12756 diff changeset	1420 number number constant expr-number
23563 87671ccc6c6b patch 8.2.2324: not easy to get mark en cursor posotion by character count Bram Moolenaar <Bram@vim.org> parents: 23475 diff changeset	1421
87671ccc6c6b patch 8.2.2324: not easy to get mark en cursor posotion by character count Bram Moolenaar <Bram@vim.org> parents: 23475 diff changeset	1422 0x hex-number 0o octal-number binary-number
9908 2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234 Christian Brabandt <cb@256bit.org> parents: 9904 diff changeset	1423 Decimal, Hexadecimal (starting with 0x or 0X), Binary (starting with 0b or 0B)
20665 6ff992bf4c82 patch 8.2.0886: cannot use octal numbers in scriptversion 4 Bram Moolenaar <Bram@vim.org> parents: 20649 diff changeset	1424 and Octal (starting with 0, 0o or 0O).
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1425
28964 8973f2f00872 patch 8.2.5004: right shift on negative number does not work as documented Bram Moolenaar <Bram@vim.org> parents: 28962 diff changeset	1426 Assuming 64 bit numbers are used (see \|v:numbersize\|) an unsigned number is
8973f2f00872 patch 8.2.5004: right shift on negative number does not work as documented Bram Moolenaar <Bram@vim.org> parents: 28962 diff changeset	1427 truncated to 0x7fffffffffffffff or 9223372036854775807. You can use -1 to get
8973f2f00872 patch 8.2.5004: right shift on negative number does not work as documented Bram Moolenaar <Bram@vim.org> parents: 28962 diff changeset	1428 0xffffffffffffffff.
8973f2f00872 patch 8.2.5004: right shift on negative number does not work as documented Bram Moolenaar <Bram@vim.org> parents: 28962 diff changeset	1429
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1430 floating-point-format
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1431 Floating point numbers can be written in two forms:
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1432
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1433 [-+]{N}.{M}
6530 435956324539 Update runtime files. Bram Moolenaar <bram@vim.org> parents: 6447 diff changeset	1434 [-+]{N}.{M}[eE][-+]{exp}
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1435
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1436 {N} and {M} are numbers. Both {N} and {M} must be present and can only
25619 29ec2c198c8d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25573 diff changeset	1437 contain digits, except that in \|Vim9\| script in {N} single quotes between
29ec2c198c8d Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25573 diff changeset	1438 digits are ignored.
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1439 [-+] means there is an optional plus or minus sign.
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1440 {exp} is the exponent, power of 10.
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	1441 Only a decimal point is accepted, not a comma. No matter what the current
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1442 locale is.
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1443 {only when compiled with the \|+float\| feature}
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1444
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1445 Examples:
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1446 123.456
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1447 +0.0001
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1448 55.0
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1449 -0.123
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1450 1.234e03
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1451 1.0E-6
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1452 -3.1416e+88
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1453
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1454 These are INVALID:
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1455 3. empty {M}
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1456 1e40 missing .{M}
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1457
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1458 Rationale:
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1459 Before floating point was introduced, the text "123.456" was interpreted as
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1460 the two numbers "123" and "456", both converted to a string and concatenated,
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1461 resulting in the string "123456". Since this was considered pointless, and we
1698 f4f8014d516e updated for version 7.2c-000 vimboss parents: 1668 diff changeset	1462 could not find it intentionally being used in Vim scripts, this backwards
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1463 incompatibility was accepted in favor of being able to use the normal notation
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1464 for floating point numbers.
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1465
15131 bc1a8d21c811 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15062 diff changeset	1466 float-pi float-e
bc1a8d21c811 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15062 diff changeset	1467 A few useful values to copy&paste: >
bc1a8d21c811 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15062 diff changeset	1468 :let pi = 3.14159265359
bc1a8d21c811 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15062 diff changeset	1469 :let e = 2.71828182846
bc1a8d21c811 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15062 diff changeset	1470 Or, if you don't want to write them in as floating-point literals, you can
bc1a8d21c811 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15062 diff changeset	1471 also use functions, like the following: >
bc1a8d21c811 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15062 diff changeset	1472 :let pi = acos(-1.0)
bc1a8d21c811 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15062 diff changeset	1473 :let e = exp(1.0)
15138 9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: 15131 diff changeset	1474 <
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1475 floating-point-precision
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1476 The precision and range of floating points numbers depends on what "double"
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1477 means in the library Vim was compiled with. There is no way to change this at
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1478 runtime.
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1479
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1480 The default for displaying a \|Float\| is to use 6 decimal places, like using
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1481 printf("%g", f). You can select something else when using the \|printf()\|
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1482 function. Example: >
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1483 :echo printf('%.15e', atan(1))
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1484 < 7.853981633974483e-01
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1485
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1486
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1487
6884 29c328f69aaa Update help files. Bram Moolenaar <bram@vim.org> parents: 6870 diff changeset	1488 string string String expr-string E114
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1489 ------
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1490 "string" string constant expr-quote
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1491
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1492 Note that double quotes are used.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1493
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1494 A string constant accepts these special characters:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1495 \... three-digit octal number (e.g., "\316")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1496 \.. two-digit octal number (must be followed by non-digit)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1497 \. one-digit octal number (must be followed by non-digit)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1498 \x.. byte specified with two hex numbers (e.g., "\x1f")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1499 \x. byte specified with one hex number (must be followed by non-hex char)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1500 \X.. same as \x..
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1501 \X. same as \x.
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1502 \u.... character specified with up to 4 hex numbers, stored according to the
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1503 current value of 'encoding' (e.g., "\u02a4")
6840 37828f7503c7 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 6823 diff changeset	1504 \U.... same as \u but allows up to 8 hex numbers.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1505 \b backspace <BS>
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1506 \e escape <Esc>
25880 9c221ad9634a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25864 diff changeset	1507 \f formfeed 0x0C
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1508 \n newline <NL>
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1509 \r return <CR>
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1510 \t tab <Tab>
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1511 \\ backslash
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1512 \" double quote
2152 b9e314fe473f Updated runtime files. Bram Moolenaar <bram@zimbu.org> parents: 2120 diff changeset	1513 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	1514 in mappings, the 0x80 byte is escaped.
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	1515 To use the double quote character it must be escaped: "<M-\">".
25880 9c221ad9634a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25864 diff changeset	1516 Don't use <Char-xxxx> to get a UTF-8 character, use \uxxxx as
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	1517 mentioned above.
20627 8bce783af0cb patch 8.2.0867: using {xxx} for encoding a modifier is not nice Bram Moolenaar <Bram@vim.org> parents: 20615 diff changeset	1518 \<*xxx> Like \<xxx> but prepends a modifier instead of including it in the
8bce783af0cb patch 8.2.0867: using {xxx} for encoding a modifier is not nice Bram Moolenaar <Bram@vim.org> parents: 20615 diff changeset	1519 character. E.g. "\<C-w>" is one character 0x17 while "\<*C-w>" is four
20603 c2570baa2e4c patch 8.2.0855: GUI tests fail because the test doesn't use a modifier Bram Moolenaar <Bram@vim.org> parents: 20593 diff changeset	1520 bytes: 3 for the CTRL modifier and then character "W".
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1521
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	1522 Note that "\xff" is stored as the byte 255, which may be invalid in some
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	1523 encodings. Use "\u00ff" to store character 255 according to the current value
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	1524 of 'encoding'.
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	1525
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1526 Note that "\000" and "\x00" force the end of the string.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1527
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1528
15498 e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs Bram Moolenaar <Bram@vim.org> parents: 15456 diff changeset	1529 blob-literal blob-literal E973
15454 1d2b5c016f17 patch 8.1.0735: cannot handle binary data Bram Moolenaar <Bram@vim.org> parents: 15446 diff changeset	1530 ------------
1d2b5c016f17 patch 8.1.0735: cannot handle binary data Bram Moolenaar <Bram@vim.org> parents: 15446 diff changeset	1531
1d2b5c016f17 patch 8.1.0735: cannot handle binary data Bram Moolenaar <Bram@vim.org> parents: 15446 diff changeset	1532 Hexadecimal starting with 0z or 0Z, with an arbitrary number of bytes.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data Bram Moolenaar <Bram@vim.org> parents: 15446 diff changeset	1533 The sequence must be an even number of hex characters. Example: >
1d2b5c016f17 patch 8.1.0735: cannot handle binary data Bram Moolenaar <Bram@vim.org> parents: 15446 diff changeset	1534 :let b = 0zFF00ED015DAF
1d2b5c016f17 patch 8.1.0735: cannot handle binary data Bram Moolenaar <Bram@vim.org> parents: 15446 diff changeset	1535
1d2b5c016f17 patch 8.1.0735: cannot handle binary data Bram Moolenaar <Bram@vim.org> parents: 15446 diff changeset	1536
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1537 literal-string literal-string E115
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1538 ---------------
26 404aac550f35 updated for version 7.0017 vimboss parents: 24 diff changeset	1539 'string' string constant expr-'
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1540
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1541 Note that single quotes are used.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1542
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	1543 This string is taken as it is. No backslashes are removed or have a special
99 04f2e519ab18 updated for version 7.0038 vimboss parents: 95 diff changeset	1544 meaning. The only exception is that two quotes stand for one quote.
26 404aac550f35 updated for version 7.0017 vimboss parents: 24 diff changeset	1545
404aac550f35 updated for version 7.0017 vimboss parents: 24 diff changeset	1546 Single quoted strings are useful for patterns, so that backslashes do not need
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	1547 to be doubled. These two commands are equivalent: >
26 404aac550f35 updated for version 7.0017 vimboss parents: 24 diff changeset	1548 if a =~ "\\s*"
404aac550f35 updated for version 7.0017 vimboss parents: 24 diff changeset	1549 if a =~ '\s*'
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1550
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1551
29578 e64e9ba15acc Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29533 diff changeset	1552 interpolated-string $quote interp-string
28718 723c7d940cba patch 8.2.4883: string interpolation only works in heredoc Bram Moolenaar <Bram@vim.org> parents: 28560 diff changeset	1553 --------------------
723c7d940cba patch 8.2.4883: string interpolation only works in heredoc Bram Moolenaar <Bram@vim.org> parents: 28560 diff changeset	1554 $"string" interpolated string constant expr-$quote
723c7d940cba patch 8.2.4883: string interpolation only works in heredoc Bram Moolenaar <Bram@vim.org> parents: 28560 diff changeset	1555 $'string' interpolated literal string constant expr-$'
723c7d940cba patch 8.2.4883: string interpolation only works in heredoc Bram Moolenaar <Bram@vim.org> parents: 28560 diff changeset	1556
723c7d940cba patch 8.2.4883: string interpolation only works in heredoc Bram Moolenaar <Bram@vim.org> parents: 28560 diff changeset	1557 Interpolated strings are an extension of the \|string\| and \|literal-string\|,
723c7d940cba patch 8.2.4883: string interpolation only works in heredoc Bram Moolenaar <Bram@vim.org> parents: 28560 diff changeset	1558 allowing the inclusion of Vim script expressions (see \|expr1\|). Any
723c7d940cba patch 8.2.4883: string interpolation only works in heredoc Bram Moolenaar <Bram@vim.org> parents: 28560 diff changeset	1559 expression returning a value can be enclosed between curly braces. The value
723c7d940cba patch 8.2.4883: string interpolation only works in heredoc Bram Moolenaar <Bram@vim.org> parents: 28560 diff changeset	1560 is converted to a string. All the text and results of the expressions
723c7d940cba patch 8.2.4883: string interpolation only works in heredoc Bram Moolenaar <Bram@vim.org> parents: 28560 diff changeset	1561 are concatenated to make a new string.
29533 34c1f4cd0c18 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29501 diff changeset	1562 E1278 E1279
28718 723c7d940cba patch 8.2.4883: string interpolation only works in heredoc Bram Moolenaar <Bram@vim.org> parents: 28560 diff changeset	1563 To include an opening brace '{' or closing brace '}' in the string content
28843 cd68a630f0d0 Update runtime files and translations Bram Moolenaar <Bram@vim.org> parents: 28777 diff changeset	1564 double it. For double quoted strings using a backslash also works. A single
cd68a630f0d0 Update runtime files and translations Bram Moolenaar <Bram@vim.org> parents: 28777 diff changeset	1565 closing brace '}' will result in an error.
28718 723c7d940cba patch 8.2.4883: string interpolation only works in heredoc Bram Moolenaar <Bram@vim.org> parents: 28560 diff changeset	1566
723c7d940cba patch 8.2.4883: string interpolation only works in heredoc Bram Moolenaar <Bram@vim.org> parents: 28560 diff changeset	1567 Examples: >
723c7d940cba patch 8.2.4883: string interpolation only works in heredoc Bram Moolenaar <Bram@vim.org> parents: 28560 diff changeset	1568 let your_name = input("What's your name? ")
28843 cd68a630f0d0 Update runtime files and translations Bram Moolenaar <Bram@vim.org> parents: 28777 diff changeset	1569 < What's your name? Peter ~
cd68a630f0d0 Update runtime files and translations Bram Moolenaar <Bram@vim.org> parents: 28777 diff changeset	1570 >
cd68a630f0d0 Update runtime files and translations Bram Moolenaar <Bram@vim.org> parents: 28777 diff changeset	1571 echo
28718 723c7d940cba patch 8.2.4883: string interpolation only works in heredoc Bram Moolenaar <Bram@vim.org> parents: 28560 diff changeset	1572 echo $"Hello, {your_name}!"
28843 cd68a630f0d0 Update runtime files and translations Bram Moolenaar <Bram@vim.org> parents: 28777 diff changeset	1573 < Hello, Peter! ~
cd68a630f0d0 Update runtime files and translations Bram Moolenaar <Bram@vim.org> parents: 28777 diff changeset	1574 >
cd68a630f0d0 Update runtime files and translations Bram Moolenaar <Bram@vim.org> parents: 28777 diff changeset	1575 echo $"The square root of {{9}} is {sqrt(9)}"
cd68a630f0d0 Update runtime files and translations Bram Moolenaar <Bram@vim.org> parents: 28777 diff changeset	1576 < The square root of {9} is 3.0 ~
cd68a630f0d0 Update runtime files and translations Bram Moolenaar <Bram@vim.org> parents: 28777 diff changeset	1577
28718 723c7d940cba patch 8.2.4883: string interpolation only works in heredoc Bram Moolenaar <Bram@vim.org> parents: 28560 diff changeset	1578
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1579 option expr-option E112 E113
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1580 ------
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1581 &option option value, local value if possible
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1582 &g:option global option value
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1583 &l:option local option value
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1584
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1585 Examples: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	1586 echo "tabstop is " .. &tabstop
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1587 if &insertmode
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1588
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1589 Any option name can be used here. See \|options\|. When using the local value
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1590 and there is no buffer-local or window-local value, the global value is used
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1591 anyway.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1592
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1593
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	1594 register expr-register @r
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1595 --------
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1596 @r contents of register 'r'
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1597
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1598 The result is the contents of the named register, as a single string.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1599 Newlines are inserted where required. To get the contents of the unnamed
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	1600 register use @" or @@. See \|registers\| for an explanation of the available
336 2d8c2622e1fa updated for version 7.0087 vimboss parents: 327 diff changeset	1601 registers.
2d8c2622e1fa updated for version 7.0087 vimboss parents: 327 diff changeset	1602
2d8c2622e1fa updated for version 7.0087 vimboss parents: 327 diff changeset	1603 When using the '=' register you get the expression itself, not what it
2d8c2622e1fa updated for version 7.0087 vimboss parents: 327 diff changeset	1604 evaluates to. Use \|eval()\| to evaluate it.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1605
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1606
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	1607 nesting expr-nesting E110
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1608 -------
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1609 (expr1) nested expression
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1610
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1611
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1612 environment variable expr-env
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1613 --------------------
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1614 $VAR environment variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1615
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1616 The String value of any environment variable. When it is not defined, the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1617 result is an empty string.
16604 1e0a5f09fdf1 patch 8.1.1305: there is no easy way to manipulate environment variables Bram Moolenaar <Bram@vim.org> parents: 16600 diff changeset	1618
1e0a5f09fdf1 patch 8.1.1305: there is no easy way to manipulate environment variables Bram Moolenaar <Bram@vim.org> parents: 16600 diff changeset	1619 The functions `getenv()` and `setenv()` can also be used and work for
1e0a5f09fdf1 patch 8.1.1305: there is no easy way to manipulate environment variables Bram Moolenaar <Bram@vim.org> parents: 16600 diff changeset	1620 environment variables with non-alphanumeric names.
1e0a5f09fdf1 patch 8.1.1305: there is no easy way to manipulate environment variables Bram Moolenaar <Bram@vim.org> parents: 16600 diff changeset	1621 The function `environ()` can be used to get a Dict with all environment
1e0a5f09fdf1 patch 8.1.1305: there is no easy way to manipulate environment variables Bram Moolenaar <Bram@vim.org> parents: 16600 diff changeset	1622 variables.
1e0a5f09fdf1 patch 8.1.1305: there is no easy way to manipulate environment variables Bram Moolenaar <Bram@vim.org> parents: 16600 diff changeset	1623
1e0a5f09fdf1 patch 8.1.1305: there is no easy way to manipulate environment variables Bram Moolenaar <Bram@vim.org> parents: 16600 diff changeset	1624
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1625 expr-env-expand
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1626 Note that there is a difference between using $VAR directly and using
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1627 expand("$VAR"). Using it directly will only expand environment variables that
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1628 are known inside the current Vim session. Using expand() will first try using
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1629 the environment variables known inside the current Vim session. If that
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1630 fails, a shell will be used to expand the variable. This can be slow, but it
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1631 does expand all variables that the shell knows about. Example: >
6180 6921742f396a Update runtime files. Bram Moolenaar <bram@vim.org> parents: 6153 diff changeset	1632 :echo $shell
6921742f396a Update runtime files. Bram Moolenaar <bram@vim.org> parents: 6153 diff changeset	1633 :echo expand("$shell")
6921742f396a Update runtime files. Bram Moolenaar <bram@vim.org> parents: 6153 diff changeset	1634 The first one probably doesn't echo anything, the second echoes the $shell
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1635 variable (if your shell supports it).
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1636
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1637
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	1638 internal variable expr-variable E1015 E1089
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1639 -----------------
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1640 variable internal variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1641 See below \|internal-variables\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1642
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1643
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	1644 function call expr-function E116 E118 E119 E120
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1645 -------------
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1646 function(expr1, ...) function call
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1647 See below \|functions\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1648
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1649
9527 e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1650 lambda expression expr-lambda lambda
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1651 -----------------
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26881 diff changeset	1652 {args -> expr1} legacy lambda expression E451
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1653 (args) => expr1 \|Vim9\| lambda expression
9527 e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1654
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1655 A lambda expression creates a new unnamed function which returns the result of
9555 9560a5b782ee commit https://github.com/vim/vim/commit/42ebd066422d73cdb7bda6a1dc828a3dd022dec8 Christian Brabandt <cb@256bit.org> parents: 9536 diff changeset	1656 evaluating \|expr1\|. Lambda expressions differ from \|user-functions\| in
9527 e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1657 the following ways:
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1658
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1659 1. The body of the lambda expression is an \|expr1\| and not a sequence of \|Ex\|
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1660 commands.
9686 8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f Christian Brabandt <cb@256bit.org> parents: 9644 diff changeset	1661 2. The prefix "a:" should not be used for arguments. E.g.: >
9527 e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1662 :let F = {arg1, arg2 -> arg1 - arg2}
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1663 :echo F(5, 2)
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1664 < 3
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1665
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1666 The arguments are optional. Example: >
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1667 :let F = {-> 'error function'}
24387 5c98ea5f5d6e Update runtime files Bram Moolenaar <Bram@vim.org> parents: 24307 diff changeset	1668 :echo F('ignored')
9527 e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1669 < error function
24387 5c98ea5f5d6e Update runtime files Bram Moolenaar <Bram@vim.org> parents: 24307 diff changeset	1670
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1671 The \|Vim9\| lambda does not only use a different syntax, it also adds type
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1672 checking and can be split over multiple lines, see \|vim9-lambda\|.
24387 5c98ea5f5d6e Update runtime files Bram Moolenaar <Bram@vim.org> parents: 24307 diff changeset	1673
9686 8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f Christian Brabandt <cb@256bit.org> parents: 9644 diff changeset	1674 closure
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f Christian Brabandt <cb@256bit.org> parents: 9644 diff changeset	1675 Lambda expressions can access outer scope variables and arguments. This is
10218 584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e Christian Brabandt <cb@256bit.org> parents: 10198 diff changeset	1676 often called a closure. Example where "i" and "a:arg" are used in a lambda
13329 424321d6eea7 patch 8.0.1539: no test for the popup menu positioning Christian Brabandt <cb@256bit.org> parents: 13298 diff changeset	1677 while they already exist in the function scope. They remain valid even after
424321d6eea7 patch 8.0.1539: no test for the popup menu positioning Christian Brabandt <cb@256bit.org> parents: 13298 diff changeset	1678 the function returns: >
9686 8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f Christian Brabandt <cb@256bit.org> parents: 9644 diff changeset	1679 :function Foo(arg)
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f Christian Brabandt <cb@256bit.org> parents: 9644 diff changeset	1680 : let i = 3
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f Christian Brabandt <cb@256bit.org> parents: 9644 diff changeset	1681 : return {x -> x + i - a:arg}
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f Christian Brabandt <cb@256bit.org> parents: 9644 diff changeset	1682 :endfunction
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f Christian Brabandt <cb@256bit.org> parents: 9644 diff changeset	1683 :let Bar = Foo(4)
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f Christian Brabandt <cb@256bit.org> parents: 9644 diff changeset	1684 :echo Bar(6)
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f Christian Brabandt <cb@256bit.org> parents: 9644 diff changeset	1685 < 5
9723 80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c Christian Brabandt <cb@256bit.org> parents: 9688 diff changeset	1686
20552 74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20522 diff changeset	1687 Note that the variables must exist in the outer scope before the lambda is
13329 424321d6eea7 patch 8.0.1539: no test for the popup menu positioning Christian Brabandt <cb@256bit.org> parents: 13298 diff changeset	1688 defined for this to work. See also \|:func-closure\|.
424321d6eea7 patch 8.0.1539: no test for the popup menu positioning Christian Brabandt <cb@256bit.org> parents: 13298 diff changeset	1689
424321d6eea7 patch 8.0.1539: no test for the popup menu positioning Christian Brabandt <cb@256bit.org> parents: 13298 diff changeset	1690 Lambda and closure support can be checked with: >
9723 80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c Christian Brabandt <cb@256bit.org> parents: 9688 diff changeset	1691 if has('lambda')
9527 e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1692
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1693 Examples for using a lambda expression with \|sort()\|, \|map()\| and \|filter()\|: >
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1694 :echo map([1, 2, 3], {idx, val -> val + 1})
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1695 < [2, 3, 4] >
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1696 :echo sort([3,7,2,1,4], {a, b -> a - b})
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1697 < [1, 2, 3, 4, 7]
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1698
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1699 The lambda expression is also useful for Channel, Job and timer: >
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1700 :let timer = timer_start(500,
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1701 \ {-> execute("echo 'Handler called'", "")},
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1702 \ {'repeat': 3})
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1703 < Handler called
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1704 Handler called
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1705 Handler called
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	1706
25161 84c7dc0fdcd2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25110 diff changeset	1707 Note that it is possible to cause memory to be used and not freed if the
84c7dc0fdcd2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25110 diff changeset	1708 closure is referenced by the context it depends on: >
84c7dc0fdcd2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25110 diff changeset	1709 function Function()
84c7dc0fdcd2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25110 diff changeset	1710 let x = 0
84c7dc0fdcd2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25110 diff changeset	1711 let F = {-> x}
84c7dc0fdcd2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25110 diff changeset	1712 endfunction
84c7dc0fdcd2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25110 diff changeset	1713 The closure uses "x" from the function scope, and "F" in that same scope
84c7dc0fdcd2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25110 diff changeset	1714 refers to the closure. This cycle results in the memory not being freed.
84c7dc0fdcd2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25110 diff changeset	1715 Recommendation: don't do this.
84c7dc0fdcd2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25110 diff changeset	1716
84c7dc0fdcd2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25110 diff changeset	1717 Notice how execute() is used to execute an Ex command. That's ugly though.
24387 5c98ea5f5d6e Update runtime files Bram Moolenaar <Bram@vim.org> parents: 24307 diff changeset	1718 In Vim9 script you can use a command block, see \|inline-function\|.
9686 8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f Christian Brabandt <cb@256bit.org> parents: 9644 diff changeset	1719
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f Christian Brabandt <cb@256bit.org> parents: 9644 diff changeset	1720 Lambda expressions have internal names like '<lambda>42'. If you get an error
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f Christian Brabandt <cb@256bit.org> parents: 9644 diff changeset	1721 for a lambda expression, you can find what it is with the following command: >
23563 87671ccc6c6b patch 8.2.2324: not easy to get mark en cursor posotion by character count Bram Moolenaar <Bram@vim.org> parents: 23475 diff changeset	1722 :function <lambda>42
9686 8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f Christian Brabandt <cb@256bit.org> parents: 9644 diff changeset	1723 See also: \|numbered-function\|
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f Christian Brabandt <cb@256bit.org> parents: 9644 diff changeset	1724
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1725 ==============================================================================
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	1726 3. Internal variable internal-variables E461 E1001
2596 fae782ef63dd Runtime file updates. Bram Moolenaar <bram@vim.org> parents: 2581 diff changeset	1727
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1728 An internal variable name can be made up of letters, digits and '_'. But it
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26881 diff changeset	1729 cannot start with a digit. In legacy script it is also possible to use curly
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1730 braces, see \|curly-braces-names\|.
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1731
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26881 diff changeset	1732 In legacy script an internal variable is created with the ":let" command
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1733 \|:let\|. An internal variable is explicitly destroyed with the ":unlet"
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1734 command \|:unlet\|.
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	1735 Using a name that is not an internal variable or refers to a variable that has
014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	1736 been destroyed results in an error.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1737
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1738 In \|Vim9\| script `:let` is not used and variables work differently, see \|:var\|.
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1739
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20836 diff changeset	1740 variable-scope
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1741 There are several name spaces for variables. Which one is to be used is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1742 specified by what is prepended:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1743
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1744 (nothing) In a function: local to the function;
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1745 in a legacy script: global;
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1746 in a \|Vim9\| script: local to the script
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1747 \|buffer-variable\| b: Local to the current buffer.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1748 \|window-variable\| w: Local to the current window.
819 23f82b5d2814 updated for version 7.0c10 vimboss parents: 818 diff changeset	1749 \|tabpage-variable\| t: Local to the current tab page.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1750 \|global-variable\| g: Global.
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1751 \|local-variable\| l: Local to a function (only in a legacy function)
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1752 \|script-variable\| s: Local to a \|:source\|'ed Vim script.
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1753 \|function-argument\| a: Function argument (only in a legacy function).
5815 d735e62f5925 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5814 diff changeset	1754 \|vim-variable\| v: Global, predefined by Vim.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1755
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	1756 The scope name by itself can be used as a \|Dictionary\|. For example, to
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	1757 delete all script-local variables: >
133 bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	1758 :for k in keys(s:)
bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	1759 : unlet s:[k]
bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	1760 :endfor
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20836 diff changeset	1761
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1762 Note: in Vim9 script variables can also be local to a block of commands, see
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	1763 \|vim9-scopes\|.
4358 cf1d93a3914a Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 4354 diff changeset	1764 buffer-variable b:var b:
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1765 A variable name that is preceded with "b:" is local to the current buffer.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1766 Thus you can have several "b:foo" variables, one for each buffer.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1767 This kind of variable is deleted when the buffer is wiped out or deleted with
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1768 \|:bdelete\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1769
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1770 One local buffer variable is predefined:
4264 2d1383658bb4 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 4229 diff changeset	1771 b:changedtick changetick
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1772 b:changedtick The total number of changes to the current buffer. It is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1773 incremented for each change. An undo command is also a change
16996 d5e1e09a829f patch 8.1.1498: ":write" increments b:changedtick even though nothing changed Bram Moolenaar <Bram@vim.org> parents: 16971 diff changeset	1774 in this case. Resetting 'modified' when writing the buffer is
d5e1e09a829f patch 8.1.1498: ":write" increments b:changedtick even though nothing changed Bram Moolenaar <Bram@vim.org> parents: 16971 diff changeset	1775 also counted.
d5e1e09a829f patch 8.1.1498: ":write" increments b:changedtick even though nothing changed Bram Moolenaar <Bram@vim.org> parents: 16971 diff changeset	1776 This can be used to perform an action only when the buffer has
d5e1e09a829f patch 8.1.1498: ":write" increments b:changedtick even though nothing changed Bram Moolenaar <Bram@vim.org> parents: 16971 diff changeset	1777 changed. Example: >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1778 :if my_changedtick != b:changedtick
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1779 : let my_changedtick = b:changedtick
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	1780 : call My_Update()
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1781 :endif
10895 c391bfbdb452 Updated runtime files. Christian Brabandt <cb@256bit.org> parents: 10787 diff changeset	1782 < You cannot change or delete the b:changedtick variable.
c391bfbdb452 Updated runtime files. Christian Brabandt <cb@256bit.org> parents: 10787 diff changeset	1783
4358 cf1d93a3914a Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 4354 diff changeset	1784 window-variable w:var w:
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1785 A variable name that is preceded with "w:" is local to the current window. It
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1786 is deleted when the window is closed.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1787
4437 eb6ab7e78925 Update runtime files. Bram Moolenaar <bram@vim.org> parents: 4358 diff changeset	1788 tabpage-variable t:var t:
819 23f82b5d2814 updated for version 7.0c10 vimboss parents: 818 diff changeset	1789 A variable name that is preceded with "t:" is local to the current tab page,
23f82b5d2814 updated for version 7.0c10 vimboss parents: 818 diff changeset	1790 It is deleted when the tab page is closed. {not available when compiled
2570 71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier) Bram Moolenaar <bram@vim.org> parents: 2569 diff changeset	1791 without the \|+windows\| feature}
819 23f82b5d2814 updated for version 7.0c10 vimboss parents: 818 diff changeset	1792
4358 cf1d93a3914a Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 4354 diff changeset	1793 global-variable g:var g:
26847 eafb9fd4ec32 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26777 diff changeset	1794 Inside functions and in \|Vim9\| script global variables are accessed with "g:".
eafb9fd4ec32 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26777 diff changeset	1795 Omitting this will access a variable local to a function or script. "g:"
eafb9fd4ec32 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26777 diff changeset	1796 can also be used in any other place if you like.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1797
4358 cf1d93a3914a Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 4354 diff changeset	1798 local-variable l:var l:
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1799 Inside functions local variables are accessed without prepending anything.
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	1800 But you can also prepend "l:" if you like. However, without prepending "l:"
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	1801 you may run into reserved variable names. For example "count". By itself it
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	1802 refers to "v:count". Using "l:count" you can have a local variable with the
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	1803 same name.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1804
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1805 script-variable s:var
26847 eafb9fd4ec32 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26777 diff changeset	1806 In a legacy Vim script variables starting with "s:" can be used. They cannot
eafb9fd4ec32 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26777 diff changeset	1807 be accessed from outside of the scripts, thus are local to the script.
eafb9fd4ec32 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26777 diff changeset	1808 In \|Vim9\| script the "s:" prefix can be omitted, variables are script-local by
eafb9fd4ec32 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26777 diff changeset	1809 default.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1810
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1811 They can be used in:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1812 - commands executed while the script is sourced
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1813 - functions defined in the script
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1814 - autocommands defined in the script
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1815 - functions and autocommands defined in functions and autocommands which were
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1816 defined in the script (recursively)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1817 - user defined commands defined in the script
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1818 Thus not in:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1819 - other scripts sourced from this one
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1820 - mappings
2033 de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1998 diff changeset	1821 - menus
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1822 - etc.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1823
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	1824 Script variables can be used to avoid conflicts with global variable names.
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	1825 Take this example: >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1826
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1827 let s:counter = 0
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1828 function MyCounter()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1829 let s:counter = s:counter + 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1830 echo s:counter
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1831 endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1832 command Tick call MyCounter()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1833
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1834 You can now invoke "Tick" from any script, and the "s:counter" variable in
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1835 that script will not be changed, only the "s:counter" in the script where
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1836 "Tick" was defined is used.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1837
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1838 Another example that does the same: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1839
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1840 let s:counter = 0
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1841 command Tick let s:counter = s:counter + 1 \| echo s:counter
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1842
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1843 When calling a function and invoking a user-defined command, the context for
9 4102fb4ea781 updated for version 7.0002 vimboss parents: 7 diff changeset	1844 script variables is set to the script where the function or command was
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1845 defined.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1846
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1847 The script variables are also available when a function is defined inside a
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1848 function that is defined in a script. Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1849
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1850 let s:counter = 0
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1851 function StartCounting(incr)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1852 if a:incr
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1853 function MyCounter()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1854 let s:counter = s:counter + 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1855 endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1856 else
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1857 function MyCounter()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1858 let s:counter = s:counter - 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1859 endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1860 endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1861 endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1862
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1863 This defines the MyCounter() function either for counting up or counting down
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1864 when calling StartCounting(). It doesn't matter from where StartCounting() is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1865 called, the s:counter variable will be accessible in MyCounter().
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1866
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1867 When the same script is sourced again it will use the same script variables.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1868 They will remain valid as long as Vim is running. This can be used to
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1869 maintain a counter: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1870
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1871 if !exists("s:counter")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1872 let s:counter = 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1873 echo "script executed for the first time"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1874 else
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1875 let s:counter = s:counter + 1
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	1876 echo "script executed " .. s:counter .. " times now"
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1877 endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1878
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1879 Note that this means that filetype plugins don't get a different set of script
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1880 variables for each buffer. Use local buffer variables instead \|b:var\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1881
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1882
15131 bc1a8d21c811 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15062 diff changeset	1883 PREDEFINED VIM VARIABLES vim-variable v:var v:
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	1884 E963 E1063
15131 bc1a8d21c811 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15062 diff changeset	1885 Some variables can be set by the user, but the type cannot be changed.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1886
18477 e93cab5d0f0f patch 8.1.2233: cannot get the Vim command line arguments Bram Moolenaar <Bram@vim.org> parents: 18463 diff changeset	1887 v:argv argv-variable
e93cab5d0f0f patch 8.1.2233: cannot get the Vim command line arguments Bram Moolenaar <Bram@vim.org> parents: 18463 diff changeset	1888 v:argv The command line arguments Vim was invoked with. This is a
e93cab5d0f0f patch 8.1.2233: cannot get the Vim command line arguments Bram Moolenaar <Bram@vim.org> parents: 18463 diff changeset	1889 list of strings. The first item is the Vim command.
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	1890 See \|v:progpath\| for the command with full path.
18477 e93cab5d0f0f patch 8.1.2233: cannot get the Vim command line arguments Bram Moolenaar <Bram@vim.org> parents: 18463 diff changeset	1891
189 504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1892 v:beval_col beval_col-variable
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1893 v:beval_col The number of the column, over which the mouse pointer is.
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1894 This is the byte index in the \|v:beval_lnum\| line.
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1895 Only valid while evaluating the 'balloonexpr' option.
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1896
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1897 v:beval_bufnr beval_bufnr-variable
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1898 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1899 valid while evaluating the 'balloonexpr' option.
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1900
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1901 v:beval_lnum beval_lnum-variable
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1902 v:beval_lnum The number of the line, over which the mouse pointer is. Only
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1903 valid while evaluating the 'balloonexpr' option.
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1904
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1905 v:beval_text beval_text-variable
374 575dacb554d8 updated for version 7.0096 vimboss parents: 370 diff changeset	1906 v:beval_text The text under or after the mouse pointer. Usually a word as
575dacb554d8 updated for version 7.0096 vimboss parents: 370 diff changeset	1907 it is useful for debugging a C program. 'iskeyword' applies,
575dacb554d8 updated for version 7.0096 vimboss parents: 370 diff changeset	1908 but a dot and "->" before the position is included. When on a
575dacb554d8 updated for version 7.0096 vimboss parents: 370 diff changeset	1909 ']' the text before it is used, including the matching '[' and
189 504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1910 word before it. When on a Visual area within one line the
12427 fc3e2d5614dd patch 8.0.1093: various small quickfix issues Christian Brabandt <cb@256bit.org> parents: 12389 diff changeset	1911 highlighted text is used. Also see \|<cexpr>\|.
189 504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1912 Only valid while evaluating the 'balloonexpr' option.
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1913
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1914 v:beval_winnr beval_winnr-variable
504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1915 v:beval_winnr The number of the window, over which the mouse pointer is. Only
2709 b01a37ab556b Runtime file updates. Bram Moolenaar <bram@vim.org> parents: 2698 diff changeset	1916 valid while evaluating the 'balloonexpr' option. The first
b01a37ab556b Runtime file updates. Bram Moolenaar <bram@vim.org> parents: 2698 diff changeset	1917 window has number zero (unlike most other places where a
b01a37ab556b Runtime file updates. Bram Moolenaar <bram@vim.org> parents: 2698 diff changeset	1918 window gets a number).
189 504c627f7474 updated for version 7.0057 vimboss parents: 179 diff changeset	1919
9221 17fa362f10be commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf Christian Brabandt <cb@256bit.org> parents: 9219 diff changeset	1920 v:beval_winid beval_winid-variable
9908 2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234 Christian Brabandt <cb@256bit.org> parents: 9904 diff changeset	1921 v:beval_winid The \|window-ID\| of the window, over which the mouse pointer
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234 Christian Brabandt <cb@256bit.org> parents: 9904 diff changeset	1922 is. Otherwise like v:beval_winnr.
9221 17fa362f10be commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf Christian Brabandt <cb@256bit.org> parents: 9219 diff changeset	1923
844 d3bbb5dd3913 updated for version 7.0f02 vimboss parents: 843 diff changeset	1924 v:char char-variable
2033 de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1998 diff changeset	1925 v:char Argument for evaluating 'formatexpr' and used for the typed
2249 6d3d35ff2c2b Use full path in undofile(). Updated docs. Bram Moolenaar <bram@vim.org> parents: 2236 diff changeset	1926 character when using <expr> in an abbreviation \|:map-<expr>\|.
4502 605c9ce57ec3 Updated runtime files, language files and translations. Bram Moolenaar <bram@vim.org> parents: 4437 diff changeset	1927 It is also used by the \|InsertCharPre\| and \|InsertEnter\| events.
844 d3bbb5dd3913 updated for version 7.0f02 vimboss parents: 843 diff changeset	1928
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1929 v:charconvert_from charconvert_from-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1930 v:charconvert_from
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1931 The name of the character encoding of a file to be converted.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1932 Only valid while evaluating the 'charconvert' option.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1933
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1934 v:charconvert_to charconvert_to-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1935 v:charconvert_to
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1936 The name of the character encoding of a file after conversion.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1937 Only valid while evaluating the 'charconvert' option.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1938
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1939 v:cmdarg cmdarg-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1940 v:cmdarg This variable is used for two purposes:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1941 1. The extra arguments given to a file read/write command.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1942 Currently these are "++enc=" and "++ff=". This variable is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1943 set before an autocommand event for a file read/write
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1944 command is triggered. There is a leading space to make it
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1945 possible to append this variable directly after the
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	1946 read/write command. Note: The "+cmd" argument isn't
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1947 included here, because it will be executed anyway.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1948 2. When printing a PostScript file with ":hardcopy" this is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1949 the argument for the ":hardcopy" command. This can be used
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1950 in 'printexpr'.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1951
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1952 v:cmdbang cmdbang-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1953 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1954 was used the value is 1, otherwise it is 0. Note that this
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1955 can only be used in autocommands. For user commands \|<bang>\|
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1956 can be used.
20873 69055d27e85e patch 8.2.0988: getting directory contents is always case sorted Bram Moolenaar <Bram@vim.org> parents: 20856 diff changeset	1957 v:collate collate-variable
69055d27e85e patch 8.2.0988: getting directory contents is always case sorted Bram Moolenaar <Bram@vim.org> parents: 20856 diff changeset	1958 v:collate The current locale setting for collation order of the runtime
69055d27e85e patch 8.2.0988: getting directory contents is always case sorted Bram Moolenaar <Bram@vim.org> parents: 20856 diff changeset	1959 environment. This allows Vim scripts to be aware of the
69055d27e85e patch 8.2.0988: getting directory contents is always case sorted Bram Moolenaar <Bram@vim.org> parents: 20856 diff changeset	1960 current locale encoding. Technical: it's the value of
69055d27e85e patch 8.2.0988: getting directory contents is always case sorted Bram Moolenaar <Bram@vim.org> parents: 20856 diff changeset	1961 LC_COLLATE. When not using a locale the value is "C".
69055d27e85e patch 8.2.0988: getting directory contents is always case sorted Bram Moolenaar <Bram@vim.org> parents: 20856 diff changeset	1962 This variable can not be set directly, use the \|:language\|
69055d27e85e patch 8.2.0988: getting directory contents is always case sorted Bram Moolenaar <Bram@vim.org> parents: 20856 diff changeset	1963 command.
69055d27e85e patch 8.2.0988: getting directory contents is always case sorted Bram Moolenaar <Bram@vim.org> parents: 20856 diff changeset	1964 See \|multi-lang\|.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	1965
26057 92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1966 v:colornames
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1967 v:colornames A dictionary that maps color names to hex color strings. These
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1968 color names can be used with the \|highlight-guifg\|,
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1969 \|highlight-guibg\|, and \|highlight-guisp\| parameters. Updating
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1970 an entry in v:colornames has no immediate effect on the syntax
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1971 highlighting. The highlight commands (probably in a
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1972 colorscheme script) need to be re-evaluated in order to use
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1973 the updated color values. For example: >
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1974
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1975 :let v:colornames['fuscia'] = '#cf3ab4'
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1976 :let v:colornames['mauve'] = '#915f6d'
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1977 :highlight Normal guifg=fuscia guibg=mauve
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1978 <
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1979 This cannot be used to override the \|cterm-colors\| but it can
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1980 be used to override other colors. For example, the X11 colors
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1981 defined in the `colors/lists/default.vim` (previously defined
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1982 in \|rgb.txt\|). When defining new color names in a plugin, the
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1983 recommended practice is to set a color entry only when it does
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1984 not already exist. For example: >
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1985
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1986 :call extend(v:colornames, {
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1987 \ 'fuscia': '#cf3ab4',
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1988 \ 'mauve': '#915f6d,
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1989 \ }, 'keep')
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1990 <
26100 babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	1991 Using \|extend()\| with the 'keep' option updates each color only
26057 92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1992 if it did not exist in \|v:colornames\|. Doing so allows the
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1993 user to choose the precise color value for a common name
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1994 by setting it in their \|.vimrc\|.
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1995
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1996 It is possible to remove entries from this dictionary but
26115 bb87ce13e7d6 patch 8.2.3590: test for v:colornames sometimes fails Bram Moolenaar <Bram@vim.org> parents: 26100 diff changeset	1997 doing so is NOT recommended, because it is disruptive to
26057 92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	1998 other scripts. It is also unlikely to achieve the desired
26100 babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	1999 result because the \|:colorscheme\| and \|:highlight\| commands will
26057 92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	2000 both automatically load all `colors/lists/default.vim` color
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	2001 scripts.
92c424550367 patch 8.2.3562: cannot add color names Bram Moolenaar <Bram@vim.org> parents: 26050 diff changeset	2002
6909 676906c33768 patch 7.4.774 Bram Moolenaar <bram@vim.org> parents: 6884 diff changeset	2003 v:completed_item completed_item-variable
676906c33768 patch 7.4.774 Bram Moolenaar <bram@vim.org> parents: 6884 diff changeset	2004 v:completed_item
676906c33768 patch 7.4.774 Bram Moolenaar <bram@vim.org> parents: 6884 diff changeset	2005 \|Dictionary\| containing the \|complete-items\| for the most
676906c33768 patch 7.4.774 Bram Moolenaar <bram@vim.org> parents: 6884 diff changeset	2006 recently completed word after \|CompleteDone\|. The
676906c33768 patch 7.4.774 Bram Moolenaar <bram@vim.org> parents: 6884 diff changeset	2007 \|Dictionary\| is empty if the completion failed.
29501 69d24e60f4f8 patch 9.0.0092: plugins cannot change v:completed_item Bram Moolenaar <Bram@vim.org> parents: 29314 diff changeset	2008 Note: Plugins can modify the value to emulate the builtin
69d24e60f4f8 patch 9.0.0092: plugins cannot change v:completed_item Bram Moolenaar <Bram@vim.org> parents: 29314 diff changeset	2009 \|CompleteDone\| event behavior.
6909 676906c33768 patch 7.4.774 Bram Moolenaar <bram@vim.org> parents: 6884 diff changeset	2010
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2011 v:count count-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2012 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	2013 to get the count before a mapping. Read-only. Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	2014 :map _x :<C-U>echo "the count is " .. v:count<CR>
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2015 < Note: The <C-U> is required to remove the line range that you
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2016 get when typing ':' after a count.
2033 de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1998 diff changeset	2017 When there are two counts, as in "3d2w", they are multiplied,
de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1998 diff changeset	2018 just like what happens in the command, "d6w" for the example.
667 9090f866cd57 updated for version 7.0197 vimboss parents: 665 diff changeset	2019 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	2020 "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	2021 \|scriptversion\| is 3 or higher.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2022
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2023 v:count1 count1-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2024 v:count1 Just like "v:count", but defaults to one when no count is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2025 used.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2026
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2027 v:ctype ctype-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2028 v:ctype The current locale setting for characters of the runtime
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2029 environment. This allows Vim scripts to be aware of the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2030 current locale encoding. Technical: it's the value of
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2031 LC_CTYPE. When not using a locale the value is "C".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2032 This variable can not be set directly, use the \|:language\|
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2033 command.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2034 See \|multi-lang\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2035
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2036 v:dying dying-variable
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	2037 v:dying Normally zero. When a deadly signal is caught it's set to
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2038 one. When multiple signals are caught the number increases.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2039 Can be used in an autocommand to check if Vim didn't
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2040 terminate normally. {only works on Unix}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2041 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2042 :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	2043 < 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	2044 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	2045
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	2046 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	2047 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	2048 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	2049 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	2050 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	2051 :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	2052 <
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	2053 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	2054 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	2055 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	2056 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	2057 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	2058 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	2059
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2060 v:errmsg errmsg-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2061 v:errmsg Last given error message. It's allowed to set this variable.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2062 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2063 :let v:errmsg = ""
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2064 :silent! next
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2065 :if v:errmsg != ""
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2066 : ... 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	2067 < "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	2068 \|scriptversion\| is 3 or higher.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2069
13796 87012d2b17b5 patch 8.0.1770: assert functions don't return anything Christian Brabandt <cb@256bit.org> parents: 13740 diff changeset	2070 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	2071 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	2072 This is a list of strings.
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801 Christian Brabandt <cb@256bit.org> parents: 7147 diff changeset	2073 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	2074 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	2075 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	2076 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	2077 :let v:errors = []
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801 Christian Brabandt <cb@256bit.org> parents: 7147 diff changeset	2078 < 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	2079 list by the assert function.
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801 Christian Brabandt <cb@256bit.org> parents: 7147 diff changeset	2080
13037 6e81a68d63a1 patch 8.0.1394: cannot intercept a yank command Christian Brabandt <cb@256bit.org> parents: 13026 diff changeset	2081 v:event event-variable
6e81a68d63a1 patch 8.0.1394: cannot intercept a yank command Christian Brabandt <cb@256bit.org> parents: 13026 diff changeset	2082 v:event Dictionary containing information about the current
19303 51bc26d4a393 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19181 diff changeset	2083 \|autocommand\|. See the specific event for what it puts in
51bc26d4a393 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19181 diff changeset	2084 this dictionary.
20115 bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20037 diff changeset	2085 The dictionary is emptied when the \|autocommand\| finishes,
bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20037 diff changeset	2086 please refer to \|dict-identity\| for how to get an independent
bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20037 diff changeset	2087 copy of it. Use \|deepcopy()\| if you want to keep the
bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20037 diff changeset	2088 information after the event triggers. Example: >
bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20037 diff changeset	2089 au TextYankPost * let g:foo = deepcopy(v:event)
bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20037 diff changeset	2090 <
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2091 v:exception exception-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2092 v:exception The value of the exception most recently caught and not
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2093 finished. See also \|v:throwpoint\| and \|throw-variables\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2094 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2095 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2096 : throw "oops"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2097 :catch /.*/
17571 2704c4e3e20a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17545 diff changeset	2098 : echo "caught " .. v:exception
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2099 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2100 < Output: "caught oops".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2101
7712 bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34 Christian Brabandt <cb@256bit.org> parents: 7707 diff changeset	2102 v:false false-variable
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34 Christian Brabandt <cb@256bit.org> parents: 7707 diff changeset	2103 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	2104 \|json_encode()\|.
9286 64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8 Christian Brabandt <cb@256bit.org> parents: 9223 diff changeset	2105 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	2106 echo v:false
9286 64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8 Christian Brabandt <cb@256bit.org> parents: 9223 diff changeset	2107 < v:false ~
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8 Christian Brabandt <cb@256bit.org> parents: 9223 diff changeset	2108 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	2109 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	2110 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	2111
179 7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2112 v:fcs_reason fcs_reason-variable
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2113 v:fcs_reason The reason why the \|FileChangedShell\| event was triggered.
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2114 Can be used in an autocommand to decide what to do and/or what
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2115 to set v:fcs_choice to. Possible values:
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2116 deleted file no longer exists
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2117 conflict file contents, mode or timestamp was
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2118 changed and buffer is modified
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2119 changed file contents has changed
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2120 mode mode of file changed
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2121 time only file timestamp changed
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2122
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2123 v:fcs_choice fcs_choice-variable
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2124 v:fcs_choice What should happen after a \|FileChangedShell\| event was
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2125 triggered. Can be used in an autocommand to tell Vim what to
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2126 do with the affected buffer:
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2127 reload Reload the buffer (does not work if
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2128 the file was deleted).
27635 6ca2d8f4cd32 patch 8.2.4343: when reloading not all properties are detected Bram Moolenaar <Bram@vim.org> parents: 27537 diff changeset	2129 edit Reload the buffer and detect the
6ca2d8f4cd32 patch 8.2.4343: when reloading not all properties are detected Bram Moolenaar <Bram@vim.org> parents: 27537 diff changeset	2130 values for options such as
6ca2d8f4cd32 patch 8.2.4343: when reloading not all properties are detected Bram Moolenaar <Bram@vim.org> parents: 27537 diff changeset	2131 'fileformat', 'fileencoding', 'binary'
6ca2d8f4cd32 patch 8.2.4343: when reloading not all properties are detected Bram Moolenaar <Bram@vim.org> parents: 27537 diff changeset	2132 (does not work if the file was
6ca2d8f4cd32 patch 8.2.4343: when reloading not all properties are detected Bram Moolenaar <Bram@vim.org> parents: 27537 diff changeset	2133 deleted).
179 7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2134 ask Ask the user what to do, as if there
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2135 was no autocommand. Except that when
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2136 only the timestamp changed nothing
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2137 will happen.
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2138 <empty> Nothing, the autocommand should do
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2139 everything that needs to be done.
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2140 The default is empty. If another (invalid) value is used then
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2141 Vim behaves like it is empty, there is no warning message.
7fd70926e2e1 updated for version 7.0055 vimboss parents: 170 diff changeset	2142
24569 e3ec2ec8841a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 24387 diff changeset	2143 v:fname fname-variable
25161 84c7dc0fdcd2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25110 diff changeset	2144 v:fname When evaluating 'includeexpr': the file name that was
84c7dc0fdcd2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25110 diff changeset	2145 detected. Empty otherwise.
24569 e3ec2ec8841a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 24387 diff changeset	2146
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2147 v:fname_in fname_in-variable
579 1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2148 v:fname_in The name of the input file. Valid while evaluating:
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2149 option used for ~
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2150 'charconvert' file to be converted
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2151 'diffexpr' original file
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2152 'patchexpr' original file
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2153 'printexpr' file to be printed
593 d220eb88e4e4 updated for version 7.0168 vimboss parents: 590 diff changeset	2154 And set to the swap file name for \|SwapExists\|.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2155
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2156 v:fname_out fname_out-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2157 v:fname_out The name of the output file. Only valid while
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2158 evaluating:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2159 option used for ~
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2160 'charconvert' resulting converted file (*)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2161 'diffexpr' output of diff
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2162 'patchexpr' resulting patched file
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2163 (*) 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	2164 file") it will be equal to v:fname_in. When doing conversion
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2165 for a read command (e.g., ":e file") it will be a temporary
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2166 file and different from v:fname_in.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2167
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2168 v:fname_new fname_new-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2169 v:fname_new The name of the new version of the file. Only valid while
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2170 evaluating 'diffexpr'.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2171
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2172 v:fname_diff fname_diff-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2173 v:fname_diff The name of the diff (patch) file. Only valid while
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2174 evaluating 'patchexpr'.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2175
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2176 v:folddashes folddashes-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2177 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2178 fold.
29 ac33b7c03fac updated for version 7.0018 vimboss parents: 26 diff changeset	2179 Read-only in the \|sandbox\|. \|fold-foldtext\|
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2180
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2181 v:foldlevel foldlevel-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2182 v:foldlevel Used for 'foldtext': foldlevel of closed fold.
29 ac33b7c03fac updated for version 7.0018 vimboss parents: 26 diff changeset	2183 Read-only in the \|sandbox\|. \|fold-foldtext\|
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2184
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2185 v:foldend foldend-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2186 v:foldend Used for 'foldtext': last line of closed fold.
29 ac33b7c03fac updated for version 7.0018 vimboss parents: 26 diff changeset	2187 Read-only in the \|sandbox\|. \|fold-foldtext\|
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2188
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2189 v:foldstart foldstart-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2190 v:foldstart Used for 'foldtext': first line of closed fold.
29 ac33b7c03fac updated for version 7.0018 vimboss parents: 26 diff changeset	2191 Read-only in the \|sandbox\|. \|fold-foldtext\|
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2192
5460 c5166fa10464 updated for version 7.4.080 Bram Moolenaar <bram@vim.org> parents: 5425 diff changeset	2193 v:hlsearch hlsearch-variable
12785 65d7fd8381a3 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 12756 diff changeset	2194 v:hlsearch Variable that indicates whether search highlighting is on.
6413 01c668384bcc updated for version 7.4.537 Bram Moolenaar <bram@vim.org> parents: 6385 diff changeset	2195 Setting it makes sense only if 'hlsearch' is enabled which
01c668384bcc updated for version 7.4.537 Bram Moolenaar <bram@vim.org> parents: 6385 diff changeset	2196 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	2197 like the \|:nohlsearch\| command, setting it to one acts like >
5460 c5166fa10464 updated for version 7.4.080 Bram Moolenaar <bram@vim.org> parents: 5425 diff changeset	2198 let &hlsearch = &hlsearch
6918 2def7b25de60 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 6909 diff changeset	2199 < Note that the value is restored when returning from a
2def7b25de60 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 6909 diff changeset	2200 function. \|function-search-undo\|.
2def7b25de60 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 6909 diff changeset	2201
11 4424b47a0797 updated for version 7.0003 vimboss parents: 10 diff changeset	2202 v:insertmode insertmode-variable
4424b47a0797 updated for version 7.0003 vimboss parents: 10 diff changeset	2203 v:insertmode Used for the \|InsertEnter\| and \|InsertChange\| autocommand
4424b47a0797 updated for version 7.0003 vimboss parents: 10 diff changeset	2204 events. Values:
4424b47a0797 updated for version 7.0003 vimboss parents: 10 diff changeset	2205 i Insert mode
4424b47a0797 updated for version 7.0003 vimboss parents: 10 diff changeset	2206 r Replace mode
4424b47a0797 updated for version 7.0003 vimboss parents: 10 diff changeset	2207 v Virtual Replace mode
4424b47a0797 updated for version 7.0003 vimboss parents: 10 diff changeset	2208
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	2209 v:key key-variable
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	2210 v:key Key of the current item of a \|Dictionary\|. Only valid while
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	2211 evaluating the expression used with \|map()\| and \|filter()\|.
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	2212 Read-only.
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	2213
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2214 v:lang lang-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2215 v:lang The current locale setting for messages of the runtime
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2216 environment. This allows Vim scripts to be aware of the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2217 current language. Technical: it's the value of LC_MESSAGES.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2218 The value is system dependent.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2219 This variable can not be set directly, use the \|:language\|
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2220 command.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2221 It can be different from \|v:ctype\| when messages are desired
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2222 in a different language than what is used for character
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2223 encoding. See \|multi-lang\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2224
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2225 v:lc_time lc_time-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2226 v:lc_time The current locale setting for time messages of the runtime
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2227 environment. This allows Vim scripts to be aware of the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2228 current language. Technical: it's the value of LC_TIME.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2229 This variable can not be set directly, use the \|:language\|
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2230 command. See \|multi-lang\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2231
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2232 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	2233 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	2234 '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	2235 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	2236 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	2237 \|sandbox\|.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2238
26881 fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	2239 v:maxcol maxcol-variable
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26881 diff changeset	2240 v:maxcol Maximum line length. Depending on where it is used it can be
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27635 diff changeset	2241 screen columns, characters or bytes. The value currently is
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27635 diff changeset	2242 2147483647 on all systems.
26881 fb67cd7d30a7 patch 8.2.3969: value of MAXCOL not available in Vim script Bram Moolenaar <Bram@vim.org> parents: 26847 diff changeset	2243
1029 82b2594be408 updated for version 7.0-155 vimboss parents: 985 diff changeset	2244 v:mouse_win mouse_win-variable
82b2594be408 updated for version 7.0-155 vimboss parents: 985 diff changeset	2245 v:mouse_win Window number for a mouse click obtained with \|getchar()\|.
82b2594be408 updated for version 7.0-155 vimboss parents: 985 diff changeset	2246 First window has number 1, like with \|winnr()\|. The value is
82b2594be408 updated for version 7.0-155 vimboss parents: 985 diff changeset	2247 zero when there was no mouse button click.
82b2594be408 updated for version 7.0-155 vimboss parents: 985 diff changeset	2248
9221 17fa362f10be commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf Christian Brabandt <cb@256bit.org> parents: 9219 diff changeset	2249 v:mouse_winid mouse_winid-variable
17fa362f10be commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf Christian Brabandt <cb@256bit.org> parents: 9219 diff changeset	2250 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	2251 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	2252
1029 82b2594be408 updated for version 7.0-155 vimboss parents: 985 diff changeset	2253 v:mouse_lnum mouse_lnum-variable
82b2594be408 updated for version 7.0-155 vimboss parents: 985 diff changeset	2254 v:mouse_lnum Line number for a mouse click obtained with \|getchar()\|.
82b2594be408 updated for version 7.0-155 vimboss parents: 985 diff changeset	2255 This is the text line number, not the screen line number. The
82b2594be408 updated for version 7.0-155 vimboss parents: 985 diff changeset	2256 value is zero when there was no mouse button click.
82b2594be408 updated for version 7.0-155 vimboss parents: 985 diff changeset	2257
82b2594be408 updated for version 7.0-155 vimboss parents: 985 diff changeset	2258 v:mouse_col mouse_col-variable
82b2594be408 updated for version 7.0-155 vimboss parents: 985 diff changeset	2259 v:mouse_col Column number for a mouse click obtained with \|getchar()\|.
82b2594be408 updated for version 7.0-155 vimboss parents: 985 diff changeset	2260 This is the screen column number, like with \|virtcol()\|. The
82b2594be408 updated for version 7.0-155 vimboss parents: 985 diff changeset	2261 value is zero when there was no mouse button click.
82b2594be408 updated for version 7.0-155 vimboss parents: 985 diff changeset	2262
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	2263 v:none none-variable None
7712 bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34 Christian Brabandt <cb@256bit.org> parents: 7707 diff changeset	2264 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	2265 \|json_encode()\|.
21499 3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21409 diff changeset	2266 This can also be used as a function argument to use the
3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21409 diff changeset	2267 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	2268 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	2269 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	2270 echo v:none
9286 64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8 Christian Brabandt <cb@256bit.org> parents: 9223 diff changeset	2271 < v:none ~
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8 Christian Brabandt <cb@256bit.org> parents: 9223 diff changeset	2272 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	2273 value. Read-only.
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	2274 Note that using `== v:none` and `!= v:none` will often give
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	2275 an error. Instead, use `is v:none` and `isnot v:none` .
7712 bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34 Christian Brabandt <cb@256bit.org> parents: 7707 diff changeset	2276
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34 Christian Brabandt <cb@256bit.org> parents: 7707 diff changeset	2277 v:null null-variable
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34 Christian Brabandt <cb@256bit.org> parents: 7707 diff changeset	2278 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	2279 \|json_encode()\|.
7742 5f6f35a3cb12 commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2 Christian Brabandt <cb@256bit.org> parents: 7712 diff changeset	2280 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	2281 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	2282 echo v:null
9286 64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8 Christian Brabandt <cb@256bit.org> parents: 9223 diff changeset	2283 < v:null ~
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8 Christian Brabandt <cb@256bit.org> parents: 9223 diff changeset	2284 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	2285 value. Read-only.
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	2286 In \|Vim9\| script `null` can be used without "v:".
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	2287 In some places `v:null` and `null` can be used for a List,
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	2288 Dict, Job, etc. that is not set. That is slightly different
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	2289 than an empty List, Dict, etc.
7712 bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34 Christian Brabandt <cb@256bit.org> parents: 7707 diff changeset	2290
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	2291 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	2292 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	2293
23737 34b4eb3a8458 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 23693 diff changeset	2294 v:numbermin numbermin-variable
24911 fd37be6dc258 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 24838 diff changeset	2295 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	2296
19477 2bb0e80fcd32 patch 8.2.0296: mixing up "long long" and __int64 may cause problems Bram Moolenaar <Bram@vim.org> parents: 19400 diff changeset	2297 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	2298 v:numbersize Number of bits in a Number. This is normally 64, but on some
19523 a7a24d06d7ce Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19483 diff changeset	2299 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	2300
1733 5a7384b9ca66 updated for version 7.2-031 vimboss parents: 1702 diff changeset	2301 v:oldfiles oldfiles-variable
5a7384b9ca66 updated for version 7.2-031 vimboss parents: 1702 diff changeset	2302 v:oldfiles List of file names that is loaded from the \|viminfo\| file on
5a7384b9ca66 updated for version 7.2-031 vimboss parents: 1702 diff changeset	2303 startup. These are the files that Vim remembers marks for.
5a7384b9ca66 updated for version 7.2-031 vimboss parents: 1702 diff changeset	2304 The length of the List is limited by the ' argument of the
5a7384b9ca66 updated for version 7.2-031 vimboss parents: 1702 diff changeset	2305 'viminfo' option (default is 100).
5618 350272cbf1fd Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5596 diff changeset	2306 When the \|viminfo\| file is not used the List is empty.
1733 5a7384b9ca66 updated for version 7.2-031 vimboss parents: 1702 diff changeset	2307 Also see \|:oldfiles\| and \|c_#<\|.
5a7384b9ca66 updated for version 7.2-031 vimboss parents: 1702 diff changeset	2308 The List can be modified, but this has no effect on what is
5a7384b9ca66 updated for version 7.2-031 vimboss parents: 1702 diff changeset	2309 stored in the \|viminfo\| file later. If you use values other
5a7384b9ca66 updated for version 7.2-031 vimboss parents: 1702 diff changeset	2310 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	2311 {only when compiled with the \|+viminfo\| feature}
1733 5a7384b9ca66 updated for version 7.2-031 vimboss parents: 1702 diff changeset	2312
6935 4db70c94226b patch 7.4.786 Bram Moolenaar <bram@vim.org> parents: 6918 diff changeset	2313 v:option_new
4db70c94226b patch 7.4.786 Bram Moolenaar <bram@vim.org> parents: 6918 diff changeset	2314 v:option_new New value of the option. Valid while executing an \|OptionSet\|
4db70c94226b patch 7.4.786 Bram Moolenaar <bram@vim.org> parents: 6918 diff changeset	2315 autocommand.
4db70c94226b patch 7.4.786 Bram Moolenaar <bram@vim.org> parents: 6918 diff changeset	2316 v:option_old
4db70c94226b patch 7.4.786 Bram Moolenaar <bram@vim.org> parents: 6918 diff changeset	2317 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	2318 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	2319 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	2320 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	2321 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	2322 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	2323 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	2324 \|OptionSet\| autocommand.
620e9011b685 patch 8.1.1542: an OptionSet autocommand does not get enough info Bram Moolenaar <Bram@vim.org> parents: 17079 diff changeset	2325 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	2326 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	2327 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	2328 \|OptionSet\| autocommand.
6935 4db70c94226b patch 7.4.786 Bram Moolenaar <bram@vim.org> parents: 6918 diff changeset	2329 v:option_type
4db70c94226b patch 7.4.786 Bram Moolenaar <bram@vim.org> parents: 6918 diff changeset	2330 v:option_type Scope of the set command. Valid while executing an
4db70c94226b patch 7.4.786 Bram Moolenaar <bram@vim.org> parents: 6918 diff changeset	2331 \|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	2332 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	2333 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	2334 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	2335 \|OptionSet\| autocommand.
620e9011b685 patch 8.1.1542: an OptionSet autocommand does not get enough info Bram Moolenaar <Bram@vim.org> parents: 17079 diff changeset	2336 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	2337 "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	2338 "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	2339 "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	2340 "modeline" \|modeline\|
1490 0f3f3090491f updated for version 7.1-205 vimboss parents: 1405 diff changeset	2341 v:operator operator-variable
0f3f3090491f updated for version 7.1-205 vimboss parents: 1405 diff changeset	2342 v:operator The last operator given in Normal mode. This is a single
0f3f3090491f updated for version 7.1-205 vimboss parents: 1405 diff changeset	2343 character except for commands starting with <g> or <z>,
0f3f3090491f updated for version 7.1-205 vimboss parents: 1405 diff changeset	2344 in which case it is two characters. Best used alongside
0f3f3090491f updated for version 7.1-205 vimboss parents: 1405 diff changeset	2345 \|v:prevcount\| and \|v:register\|. Useful if you want to cancel
0f3f3090491f updated for version 7.1-205 vimboss parents: 1405 diff changeset	2346 Operator-pending mode and then use the operator, e.g.: >
0f3f3090491f updated for version 7.1-205 vimboss parents: 1405 diff changeset	2347 :omap O <Esc>:call MyMotion(v:operator)<CR>
0f3f3090491f updated for version 7.1-205 vimboss parents: 1405 diff changeset	2348 < The value remains set until another operator is entered, thus
0f3f3090491f updated for version 7.1-205 vimboss parents: 1405 diff changeset	2349 don't expect it to be empty.
0f3f3090491f updated for version 7.1-205 vimboss parents: 1405 diff changeset	2350 v:operator is not set for \|:delete\|, \|:yank\| or other Ex
0f3f3090491f updated for version 7.1-205 vimboss parents: 1405 diff changeset	2351 commands.
0f3f3090491f updated for version 7.1-205 vimboss parents: 1405 diff changeset	2352 Read-only.
0f3f3090491f updated for version 7.1-205 vimboss parents: 1405 diff changeset	2353
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2354 v:prevcount prevcount-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2355 v:prevcount The count given for the last but one Normal mode command.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2356 This is the v:count value of the previous command. Useful if
1490 0f3f3090491f updated for version 7.1-205 vimboss parents: 1405 diff changeset	2357 you want to cancel Visual or Operator-pending mode and then
0f3f3090491f updated for version 7.1-205 vimboss parents: 1405 diff changeset	2358 use the count, e.g.: >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2359 :vmap % <Esc>:call MyFilter(v:prevcount)<CR>
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2360 < Read-only.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2361
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	2362 v:profiling profiling-variable
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	2363 v:profiling Normally zero. Set to one after using ":profile start".
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	2364 See \|profiling\|.
8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	2365
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2366 v:progname progname-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2367 v:progname Contains the name (with path removed) with which Vim was
3492 3482d151136b Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3465 diff changeset	2368 invoked. Allows you to do special initialisations for \|view\|,
3482d151136b Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3465 diff changeset	2369 \|evim\| etc., or any other name you might symlink to Vim.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2370 Read-only.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2371
5780 d2286df8719d updated for version 7.4.234 Bram Moolenaar <bram@vim.org> parents: 5763 diff changeset	2372 v:progpath progpath-variable
17758 f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	2373 v:progpath Contains the command with which Vim was invoked, in a form
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	2374 that when passed to the shell will run the same Vim executable
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	2375 as the current one (if $PATH remains unchanged).
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	2376 Useful if you want to message a Vim server using a
5780 d2286df8719d updated for version 7.4.234 Bram Moolenaar <bram@vim.org> parents: 5763 diff changeset	2377 \|--remote-expr\|.
5782 5ab2946f7ce5 updated for version 7.4.235 Bram Moolenaar <bram@vim.org> parents: 5780 diff changeset	2378 To get the full path use: >
5ab2946f7ce5 updated for version 7.4.235 Bram Moolenaar <bram@vim.org> parents: 5780 diff changeset	2379 echo exepath(v:progpath)
17758 f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	2380 < If the command has a relative path it will be expanded to the
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	2381 full path, so that it still works after `:cd`. Thus starting
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	2382 "./vim" results in "/home/user/path/to/vim/src/vim".
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	2383 On Linux and other systems it will always be the full path.
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	2384 On Mac it may just be "vim" and using exepath() as mentioned
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	2385 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	2386 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	2387 ".exe" is not added to v:progpath.
5780 d2286df8719d updated for version 7.4.234 Bram Moolenaar <bram@vim.org> parents: 5763 diff changeset	2388 Read-only.
d2286df8719d updated for version 7.4.234 Bram Moolenaar <bram@vim.org> parents: 5763 diff changeset	2389
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2390 v:register register-variable
2698 b6471224d2af Updated runtime files and translations. Bram Moolenaar <bram@vim.org> parents: 2681 diff changeset	2391 v:register The name of the register in effect for the current normal mode
3492 3482d151136b Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3465 diff changeset	2392 command (regardless of whether that command actually used a
3482d151136b Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3465 diff changeset	2393 register). Or for the currently executing normal mode mapping
3482d151136b Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3465 diff changeset	2394 (use this in custom commands that take a register).
3482d151136b Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3465 diff changeset	2395 If none is supplied it is the default register '"', unless
3482d151136b Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3465 diff changeset	2396 'clipboard' contains "unnamed" or "unnamedplus", then it is
3482d151136b Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3465 diff changeset	2397 '*' or '+'.
2698 b6471224d2af Updated runtime files and translations. Bram Moolenaar <bram@vim.org> parents: 2681 diff changeset	2398 Also see \|getreg()\| and \|setreg()\|
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2399
540 2df7f3a5eb96 updated for version 7.0153 vimboss parents: 537 diff changeset	2400 v:scrollstart scrollstart-variable
2df7f3a5eb96 updated for version 7.0153 vimboss parents: 537 diff changeset	2401 v:scrollstart String describing the script or function that caused the
2df7f3a5eb96 updated for version 7.0153 vimboss parents: 537 diff changeset	2402 screen to scroll up. It's only set when it is empty, thus the
2df7f3a5eb96 updated for version 7.0153 vimboss parents: 537 diff changeset	2403 first reason is remembered. It is set to "Unknown" for a
2df7f3a5eb96 updated for version 7.0153 vimboss parents: 537 diff changeset	2404 typed command.
2df7f3a5eb96 updated for version 7.0153 vimboss parents: 537 diff changeset	2405 This can be used to find out why your script causes the
2df7f3a5eb96 updated for version 7.0153 vimboss parents: 537 diff changeset	2406 hit-enter prompt.
2df7f3a5eb96 updated for version 7.0153 vimboss parents: 537 diff changeset	2407
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2408 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	2409 v:servername The resulting registered \|client-server-name\| if any.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2410 Read-only.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2411
12785 65d7fd8381a3 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 12756 diff changeset	2412
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	2413 v:searchforward v:searchforward searchforward-variable
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	2414 Search direction: 1 after a forward search, 0 after a
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	2415 backward search. It is reset to forward when directly setting
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	2416 the last search pattern, see \|quote/\|.
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	2417 Note that the value is restored when returning from a
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	2418 function. \|function-search-undo\|.
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	2419 Read-write.
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	2420
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2421 v:shell_error shell_error-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2422 v:shell_error Result of the last shell command. When non-zero, the last
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2423 shell command had an error. When zero, there was no problem.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2424 This only works when the shell returns the error code to Vim.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2425 The value -1 is often used when the command could not be
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2426 executed. Read-only.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2427 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2428 :!mv foo bar
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2429 :if v:shell_error
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2430 : echo 'could not rename "foo" to "bar"!'
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2431 :endif
16366 6ee80f3b5ea9 patch 8.1.1188: not all Vim variables require the v: prefix Bram Moolenaar <Bram@vim.org> parents: 16271 diff changeset	2432 < "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	2433 \|scriptversion\| is 3 or higher.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2434
26100 babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	2435 v:sizeofint sizeofint-variable
babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	2436 v:sizeofint Number of bytes in an int. Depends on how Vim was compiled.
babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	2437 This is only useful for deciding whether a test will give the
babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	2438 expected result.
babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	2439
babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	2440 v:sizeoflong sizeoflong-variable
babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	2441 v:sizeoflong Number of bytes in a long. Depends on how Vim was compiled.
babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	2442 This is only useful for deciding whether a test will give the
babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	2443 expected result.
babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	2444
babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	2445 v:sizeofpointer sizeofpointer-variable
babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	2446 v:sizeofpointer Number of bytes in a pointer. Depends on how Vim was compiled.
babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	2447 This is only useful for deciding whether a test will give the
babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	2448 expected result.
babd9f1dbe12 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26089 diff changeset	2449
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2450 v:statusmsg statusmsg-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2451 v:statusmsg Last given status message. It's allowed to set this variable.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2452
579 1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2453 v:swapname swapname-variable
1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2454 v:swapname Only valid when executing \|SwapExists\| autocommands: Name of
1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2455 the swap file found. Read-only.
1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2456
1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2457 v:swapchoice swapchoice-variable
1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2458 v:swapchoice \|SwapExists\| autocommands can set this to the selected choice
1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2459 for handling an existing swap file:
1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2460 'o' Open read-only
1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2461 'e' Edit anyway
1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2462 'r' Recover
1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2463 'd' Delete swapfile
1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2464 'q' Quit
1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2465 'a' Abort
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	2466 The value should be a single-character string. An empty value
579 1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2467 results in the user being asked, as would happen when there is
1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2468 no SwapExists autocommand. The default is empty.
1ef373b13126 updated for version 7.0164 vimboss parents: 574 diff changeset	2469
590 de152391f6f9 updated for version 7.0167 vimboss parents: 579 diff changeset	2470 v:swapcommand swapcommand-variable
625 81fe2ccc1207 updated for version 7.0179 vimboss parents: 620 diff changeset	2471 v:swapcommand Normal mode command to be executed after a file has been
590 de152391f6f9 updated for version 7.0167 vimboss parents: 579 diff changeset	2472 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	2473 another Vim open the file and jump to the right place. For
590 de152391f6f9 updated for version 7.0167 vimboss parents: 579 diff changeset	2474 example, when jumping to a tag the value is ":tag tagname\r".
716 8ae24f338cab updated for version 7.0217 vimboss parents: 714 diff changeset	2475 For ":edit +cmd file" the value is ":cmd\r".
590 de152391f6f9 updated for version 7.0167 vimboss parents: 579 diff changeset	2476
9850 67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640 Christian Brabandt <cb@256bit.org> parents: 9810 diff changeset	2477 v:t_TYPE v:t_bool t_bool-variable
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	2478 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	2479 v:t_channel t_channel-variable
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	2480 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	2481 v:t_dict t_dict-variable
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	2482 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	2483 v:t_float t_float-variable
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	2484 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	2485 v:t_func t_func-variable
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	2486 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	2487 v:t_job t_job-variable
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	2488 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	2489 v:t_list t_list-variable
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	2490 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	2491 v:t_none t_none-variable
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	2492 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	2493 v:t_number t_number-variable
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	2494 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	2495 v:t_string t_string-variable
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	2496 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	2497 v:t_blob t_blob-variable
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15498 diff changeset	2498 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	2499
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2500 v:termresponse termresponse-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2501 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	2502 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	2503 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	2504 'c', with only digits and ';' in between.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2505 When this option is set, the TermResponse autocommand event is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2506 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	2507 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	2508 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	2509 The response from a new xterm is: "<Esc>[> Pp ; Pv ; Pc c". Pp
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2510 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2511 patch level (since this was introduced in patch 95, it's
26708 f0d7cb510ce3 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26640 diff changeset	2512 always 95 or higher). Pc is always zero.
f0d7cb510ce3 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26640 diff changeset	2513 If Pv is 141 or higher then Vim will try to request terminal
f0d7cb510ce3 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26640 diff changeset	2514 codes. This only works with xterm \|xterm-codes\|.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2515 {only when compiled with \|+termresponse\| feature}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2516
12273 c952a6af25e0 patch 8.0.1016: gnome terminal echoes t_RC Christian Brabandt <cb@256bit.org> parents: 12254 diff changeset	2517 v:termblinkresp
c952a6af25e0 patch 8.0.1016: gnome terminal echoes t_RC Christian Brabandt <cb@256bit.org> parents: 12254 diff changeset	2518 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	2519 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	2520 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	2521
c952a6af25e0 patch 8.0.1016: gnome terminal echoes t_RC Christian Brabandt <cb@256bit.org> parents: 12254 diff changeset	2522 v:termstyleresp
c952a6af25e0 patch 8.0.1016: gnome terminal echoes t_RC Christian Brabandt <cb@256bit.org> parents: 12254 diff changeset	2523 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	2524 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	2525 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	2526
12632 b1a7e3968a31 patch 8.0.1194: actual fg and bg colors of terminal are unknown Christian Brabandt <cb@256bit.org> parents: 12499 diff changeset	2527 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	2528 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	2529 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	2530 background color is, see 'background'.
c952a6af25e0 patch 8.0.1016: gnome terminal echoes t_RC Christian Brabandt <cb@256bit.org> parents: 12254 diff changeset	2531
12632 b1a7e3968a31 patch 8.0.1194: actual fg and bg colors of terminal are unknown Christian Brabandt <cb@256bit.org> parents: 12499 diff changeset	2532 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	2533 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	2534 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	2535 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	2536
12273 c952a6af25e0 patch 8.0.1016: gnome terminal echoes t_RC Christian Brabandt <cb@256bit.org> parents: 12254 diff changeset	2537 v:termu7resp
c952a6af25e0 patch 8.0.1016: gnome terminal echoes t_RC Christian Brabandt <cb@256bit.org> parents: 12254 diff changeset	2538 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	2539 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	2540 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	2541
8881 ed0b39dd7fd6 commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e Christian Brabandt <cb@256bit.org> parents: 8876 diff changeset	2542 v:testing testing-variable
9121 7350959e53c3 commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01 Christian Brabandt <cb@256bit.org> parents: 9117 diff changeset	2543 v:testing Must be set before using `test_garbagecollect_now()`.
11160 d0a20101ecb2 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 11105 diff changeset	2544 Also, when set certain error messages won't be shown for 2
12785 65d7fd8381a3 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 12756 diff changeset	2545 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	2546
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2547 v:this_session this_session-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2548 v:this_session Full filename of the last loaded or saved session file. See
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2549 \|:mksession\|. It is allowed to set this variable. When no
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2550 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	2551 "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	2552 \|scriptversion\| is 3 or higher
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2553
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2554 v:throwpoint throwpoint-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2555 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	2556 finished was thrown. Not set when commands are typed. See
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2557 also \|v:exception\| and \|throw-variables\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2558 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2559 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2560 : throw "oops"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2561 :catch /.*/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2562 : echo "Exception from" v:throwpoint
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2563 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2564 < Output: "Exception from test.vim, line 2"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2565
7712 bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34 Christian Brabandt <cb@256bit.org> parents: 7707 diff changeset	2566 v:true true-variable
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34 Christian Brabandt <cb@256bit.org> parents: 7707 diff changeset	2567 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	2568 \|json_encode()\|.
9286 64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8 Christian Brabandt <cb@256bit.org> parents: 9223 diff changeset	2569 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	2570 echo v:true
9286 64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8 Christian Brabandt <cb@256bit.org> parents: 9223 diff changeset	2571 < v:true ~
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8 Christian Brabandt <cb@256bit.org> parents: 9223 diff changeset	2572 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	2573 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	2574 In \|Vim9\| script "true" can be used which has a boolean type.
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	2575 v:val val-variable
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	2576 v:val Value of the current item of a \|List\| or \|Dictionary\|. Only
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	2577 valid while evaluating the expression used with \|map()\| and
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	2578 \|filter()\|. Read-only.
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	2579
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2580 v:version version-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2581 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	2582 minor version number. Version 5.0 is 500. Version 5.1
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2583 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	2584 compatibility, unless \|scriptversion\| is 3 or higher.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2585 Use \|has()\| to check if a certain patch was included, e.g.: >
5786 71b165a378ad updated for version 7.4.237 Bram Moolenaar <bram@vim.org> parents: 5782 diff changeset	2586 if has("patch-7.4.123")
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2587 < Note that patch numbers are specific to the version, thus both
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2588 version 5.0 and 5.1 may have a patch 123, but these are
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2589 completely different.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2590
17053 d5fa04016df0 patch 8.1.1526: no numerical value for the patchlevel Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	2591 v:versionlong versionlong-variable
17131 be5a5cfc991a patch 8.1.1565: MS-Windows: no sound support Bram Moolenaar <Bram@vim.org> parents: 17109 diff changeset	2592 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	2593 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	2594 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	2595 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	2596 < 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	2597 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	2598 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	2599 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	2600 included.
d5fa04016df0 patch 8.1.1526: no numerical value for the patchlevel Bram Moolenaar <Bram@vim.org> parents: 17036 diff changeset	2601
8738 e770986c855a commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225 Christian Brabandt <cb@256bit.org> parents: 8669 diff changeset	2602 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	2603 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	2604 before \|VimEnter\| autocommands are triggered.
e770986c855a commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225 Christian Brabandt <cb@256bit.org> parents: 8669 diff changeset	2605
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2606 v:warningmsg warningmsg-variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2607 v:warningmsg Last given warning message. It's allowed to set this variable.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2608
2609 758822790b43 updated for version 7.3.031 Bram Moolenaar <bram@vim.org> parents: 2608 diff changeset	2609 v:windowid windowid-variable
758822790b43 updated for version 7.3.031 Bram Moolenaar <bram@vim.org> parents: 2608 diff changeset	2610 v:windowid When any X11 based GUI is running or when running in a
758822790b43 updated for version 7.3.031 Bram Moolenaar <bram@vim.org> parents: 2608 diff changeset	2611 terminal and Vim connects to the X server (\|-X\|) this will be
2616 73d947c20291 updated for version 7.3.038 Bram Moolenaar <bram@vim.org> parents: 2610 diff changeset	2612 set to the window ID.
73d947c20291 updated for version 7.3.038 Bram Moolenaar <bram@vim.org> parents: 2610 diff changeset	2613 When an MS-Windows GUI is running this will be set to the
73d947c20291 updated for version 7.3.038 Bram Moolenaar <bram@vim.org> parents: 2610 diff changeset	2614 window handle.
73d947c20291 updated for version 7.3.038 Bram Moolenaar <bram@vim.org> parents: 2610 diff changeset	2615 Otherwise the value is zero.
9908 2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234 Christian Brabandt <cb@256bit.org> parents: 9904 diff changeset	2616 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	2617 see \|window-ID\|.
2609 758822790b43 updated for version 7.3.031 Bram Moolenaar <bram@vim.org> parents: 2608 diff changeset	2618
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2619 ==============================================================================
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2620 4. Builtin Functions functions
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2621
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2622 See \|function-list\| for a list grouped by what the function is used for.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2623
26777 629e7046ef63 patch 8.2.3917: the eval.txt help file is way too big Bram Moolenaar <Bram@vim.org> parents: 26769 diff changeset	2624 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	2625 help file: \|builtin-functions\|.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2626
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2627 ==============================================================================
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2628 5. Defining functions user-functions
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2629
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2630 New functions can be defined. These can be called just like builtin
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2631 functions. The function executes a sequence of Ex commands. Normal mode
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2632 commands can be executed with the \|:normal\| command.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2633
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: 19163 diff changeset	2634 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	2635 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	2636
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2637 The function name must start with an uppercase letter, to avoid confusion with
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2638 builtin functions. To prevent from using the same name in different scripts
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2639 avoid obvious, short names. A good habit is to start the function name with
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2640 the name of the script, e.g., "HTMLcolor()".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2641
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	2642 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	2643 \|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	2644 The \|autoload\| facility is useful to define a function only when it's called.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2645
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2646 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	2647 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	2648 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	2649 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	2650 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	2651 used instead of "s:" when the mapping is expanded outside of the script.
5862 306caa30d83b Runtime file updates. Bram Moolenaar <bram@vim.org> parents: 5815 diff changeset	2652 There are only script-local functions, no buffer-local or window-local
306caa30d83b Runtime file updates. Bram Moolenaar <bram@vim.org> parents: 5815 diff changeset	2653 functions.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2654
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	2655 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	2656 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	2657
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26881 diff changeset	2658 :fu :function E128 E129 E123 E454
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2659 :fu[nction] List all functions and their arguments.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2660
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2661 :fu[nction] {name} List function {name}.
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	2662 {name} can also be a \|Dictionary\| entry that is a
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	2663 \|Funcref\|: >
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	2664 :function dict.init
504 35cde31bdcbd updated for version 7.0141 vimboss parents: 502 diff changeset	2665
35cde31bdcbd updated for version 7.0141 vimboss parents: 502 diff changeset	2666 :fu[nction] /{pattern} List functions with a name matching {pattern}.
35cde31bdcbd updated for version 7.0141 vimboss parents: 502 diff changeset	2667 Example that lists all functions ending with "File": >
35cde31bdcbd updated for version 7.0141 vimboss parents: 502 diff changeset	2668 :function /File$
482 6f8b578776ab updated for version 7.0131 vimboss parents: 477 diff changeset	2669 <
6f8b578776ab updated for version 7.0131 vimboss parents: 477 diff changeset	2670 :function-verbose
6f8b578776ab updated for version 7.0131 vimboss parents: 477 diff changeset	2671 When 'verbose' is non-zero, listing a function will also display where it was
6f8b578776ab updated for version 7.0131 vimboss parents: 477 diff changeset	2672 last defined. Example: >
6f8b578776ab updated for version 7.0131 vimboss parents: 477 diff changeset	2673
6f8b578776ab updated for version 7.0131 vimboss parents: 477 diff changeset	2674 :verbose function SetFileTypeSH
6f8b578776ab updated for version 7.0131 vimboss parents: 477 diff changeset	2675 function SetFileTypeSH(name)
6f8b578776ab updated for version 7.0131 vimboss parents: 477 diff changeset	2676 Last set from /usr/share/vim/vim-7.0/filetype.vim
6f8b578776ab updated for version 7.0131 vimboss parents: 477 diff changeset	2677 <
484 f012c4ed8c38 updated for version 7.0132 vimboss parents: 482 diff changeset	2678 See \|:verbose-cmd\| for more information.
482 6f8b578776ab updated for version 7.0131 vimboss parents: 477 diff changeset	2679
5862 306caa30d83b Runtime file updates. Bram Moolenaar <bram@vim.org> parents: 5815 diff changeset	2680 E124 E125 E853 E884
9688 2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2681 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] [closure]
12756 3b26420fc639 Long overdue runtime update. Christian Brabandt <cb@256bit.org> parents: 12722 diff changeset	2682 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	2683 the function follows in the next lines, until the
3b26420fc639 Long overdue runtime update. Christian Brabandt <cb@256bit.org> parents: 12722 diff changeset	2684 matching \|:endfunction\|.
29533 34c1f4cd0c18 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29501 diff changeset	2685 E1267
12756 3b26420fc639 Long overdue runtime update. Christian Brabandt <cb@256bit.org> parents: 12722 diff changeset	2686 The name must be made of alphanumeric characters and
3b26420fc639 Long overdue runtime update. Christian Brabandt <cb@256bit.org> parents: 12722 diff changeset	2687 '_', and must start with a capital or "s:" (see
3b26420fc639 Long overdue runtime update. Christian Brabandt <cb@256bit.org> parents: 12722 diff changeset	2688 above). Note that using "b:" or "g:" is not allowed.
3b26420fc639 Long overdue runtime update. Christian Brabandt <cb@256bit.org> parents: 12722 diff changeset	2689 (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	2690 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	2691 Before that patch no error was given).
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	2692
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	2693 {name} can also be a \|Dictionary\| entry that is a
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	2694 \|Funcref\|: >
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	2695 :function dict.init(arg)
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	2696 < "dict" must be an existing dictionary. The entry
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	2697 "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	2698 is required to overwrite an existing function. The
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	2699 result is a \|Funcref\| to a numbered function. The
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	2700 function can only be used with a \|Funcref\| and will be
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	2701 deleted if there are no more references to it.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2702 E127 E122
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2703 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	2704 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	2705 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	2706 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	2707 silently replaced.
67e3103d6e18 patch 8.1.0515: reloading a script gives errors for existing functions Bram Moolenaar <Bram@vim.org> parents: 14999 diff changeset	2708 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	2709 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	2710 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	2711 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	2712 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	2713 which is hard to debug.
20552 74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20522 diff changeset	2714 NOTE: In Vim9 script script-local functions cannot be
74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20522 diff changeset	2715 deleted or redefined.
133 bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	2716
bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	2717 For the {arguments} see \|function-argument\|.
bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	2718
5618 350272cbf1fd Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5596 diff changeset	2719 :func-range a:firstline a:lastline
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2720 When the [range] argument is added, the function is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2721 expected to take care of a range itself. The range is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2722 passed as "a:firstline" and "a:lastline". If [range]
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2723 is excluded, ":{range}call" will call the function for
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2724 each line in the range, with the cursor on the start
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2725 of each line. See \|function-range-example\|.
3967 fdb8a9c7bd91 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3920 diff changeset	2726 The cursor is still moved to the first line of the
fdb8a9c7bd91 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 3920 diff changeset	2727 range, as is the case with all Ex commands.
5618 350272cbf1fd Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5596 diff changeset	2728 :func-abort
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2729 When the [abort] argument is added, the function will
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2730 abort as soon as an error is detected.
5618 350272cbf1fd Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5596 diff changeset	2731 :func-dict
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	2732 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	2733 be invoked through an entry in a \|Dictionary\|. The
102 0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	2734 local variable "self" will then be set to the
0aa0e89bfd5f updated for version 7.0039 vimboss parents: 99 diff changeset	2735 dictionary. See \|Dictionary-function\|.
9688 2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2736 :func-closure E932
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2737 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	2738 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	2739 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	2740 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	2741 remains referenced even after Foo() returns: >
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2742 :function! Foo()
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2743 : let x = 0
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2744 : function! Bar() closure
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2745 : let x += 1
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2746 : return x
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2747 : endfunction
9737 35ce559b8553 commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380 Christian Brabandt <cb@256bit.org> parents: 9723 diff changeset	2748 : return funcref('Bar')
9688 2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2749 :endfunction
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2750
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2751 :let F = Foo()
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2752 :echo F()
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2753 < 1 >
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2754 :echo F()
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2755 < 2 >
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2756 :echo F()
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740 Christian Brabandt <cb@256bit.org> parents: 9686 diff changeset	2757 < 3
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2758
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	2759 function-search-undo
653 5acda076fb0c updated for version 7.0192 vimboss parents: 650 diff changeset	2760 The last used search pattern and the redo command "."
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	2761 will not be changed by the function. This also
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	2762 implies that the effect of \|:nohlsearch\| is undone
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	2763 when the function returns.
653 5acda076fb0c updated for version 7.0192 vimboss parents: 650 diff changeset	2764
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	2765 :endf :endfunction E126 E193 W22 E1151
11543 57c452316da1 patch 8.0.0654: no warning for text after :endfunction Christian Brabandt <cb@256bit.org> parents: 11518 diff changeset	2766 :endf[unction] [argument]
57c452316da1 patch 8.0.0654: no warning for text after :endfunction Christian Brabandt <cb@256bit.org> parents: 11518 diff changeset	2767 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	2768 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	2769
57c452316da1 patch 8.0.0654: no warning for text after :endfunction Christian Brabandt <cb@256bit.org> parents: 11518 diff changeset	2770 [argument] can be:
57c452316da1 patch 8.0.0654: no warning for text after :endfunction Christian Brabandt <cb@256bit.org> parents: 11518 diff changeset	2771 \| 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	2772 \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	2773 " 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	2774 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	2775 '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	2776 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	2777 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	2778 ignored.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2779
11561 7ad79766365a patch 8.0.0663: unexpected error message only when 'verbose' is set Christian Brabandt <cb@256bit.org> parents: 11553 diff changeset	2780 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	2781 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	2782 :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	2783 <
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	2784 :delf :delfunction E131 E933 E1084
11543 57c452316da1 patch 8.0.0654: no warning for text after :endfunction Christian Brabandt <cb@256bit.org> parents: 11518 diff changeset	2785 :delf[unction][!] {name}
57c452316da1 patch 8.0.0654: no warning for text after :endfunction Christian Brabandt <cb@256bit.org> parents: 11518 diff changeset	2786 Delete function {name}.
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	2787 {name} can also be a \|Dictionary\| entry that is a
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	2788 \|Funcref\|: >
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	2789 :delfunc dict.init
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	2790 < This will remove the "init" entry from "dict". The
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	2791 function is deleted if there are no more references to
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	2792 it.
11543 57c452316da1 patch 8.0.0654: no warning for text after :endfunction Christian Brabandt <cb@256bit.org> parents: 11518 diff changeset	2793 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	2794 exist.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2795 :retu :return E133
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2796 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2797 evaluated and returned as the result of the function.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2798 If "[expr]" is not given, the number 0 is returned.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2799 When a function ends without an explicit ":return",
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2800 the number 0 is returned.
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	2801 In a :def function E1095 is given if unreachable
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	2802 code follows after the `:return`.
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	2803 In legacy script there is no check for unreachable
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	2804 lines, thus there is no warning if commands follow
5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	2805 `:return`.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2806
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2807 If the ":return" is used after a \|:try\| but before the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2808 matching \|:finally\| (if present), the commands
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2809 following the ":finally" up to the matching \|:endtry\|
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2810 are executed first. This process applies to all
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2811 nested ":try"s inside the function. The function
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2812 returns at the outermost ":endtry".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2813
133 bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	2814 function-argument a:var
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	2815 An argument can be defined by giving its name. In the function this can then
133 bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	2816 be used as "a:name" ("a:" for argument).
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	2817 a:0 a:1 a:000 E740 ...
133 bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	2818 Up to 20 arguments can be given, separated by commas. After the named
bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	2819 arguments an argument "..." can be specified, which means that more arguments
bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	2820 may optionally be following. In the function the extra arguments can be used
bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	2821 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	2822 can be 0). "a:000" is set to a \|List\| that contains these arguments. Note
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	2823 that "a:1" is the same as "a:000[0]".
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	2824 E742 E1090
148 72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	2825 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	2826 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	2827 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	2828 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	2829 change a \|List\| or \|Dictionary\| use \|:lockvar\|.
133 bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	2830
bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	2831 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	2832 still supply the () then.
3b26420fc639 Long overdue runtime update. Christian Brabandt <cb@256bit.org> parents: 12722 diff changeset	2833
13482 9eebe457eb3c Update runtime files. Convert a couple of help files to utf-8. Christian Brabandt <cb@256bit.org> parents: 13438 diff changeset	2834 It is allowed to define another function inside a function body.
133 bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	2835
16615 1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2836 optional-function-argument
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2837 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	2838 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	2839 specified at a call, the default expression is used to initialize it.
19968 1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19952 diff changeset	2840 This only works for functions declared with `:function` or `:def`, not for
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19952 diff changeset	2841 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	2842
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2843 Example: >
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2844 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	2845 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	2846 endfunction
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2847 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	2848 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	2849
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2850 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	2851 call, not definition. Thus it is possible to use an expression which is
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16704 diff changeset	2852 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	2853 evaluated when arguments are not specified during a call.
21499 3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21409 diff changeset	2854 none-function_argument
16615 1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2855 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	2856 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	2857 expression.
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2858
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2859 Example: >
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2860 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	2861 endfunction
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2862 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	2863 <
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2864 E989
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2865 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	2866 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	2867
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2868 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	2869 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	2870 arguments.
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2871
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2872 Example that works: >
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2873 :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	2874 :endfunction
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2875 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	2876 :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	2877 :endfunction
1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2878 <
19968 1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19952 diff changeset	2879 When not using "...", the number of arguments in a function call must be at
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19952 diff changeset	2880 least equal to the number of mandatory named arguments. When using "...", the
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19952 diff changeset	2881 number of arguments may be larger than the total of mandatory and optional
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19952 diff changeset	2882 arguments.
16615 1a911bd57f11 patch 8.1.1310: named function arguments are never optional Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	2883
133 bcb347a8f934 updated for version 7.0044 vimboss parents: 123 diff changeset	2884 local-variables
9527 e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544 Christian Brabandt <cb@256bit.org> parents: 9464 diff changeset	2885 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	2886 function returns. Global variables need to be accessed with "g:".
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2887
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2888 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2889 :function Table(title, ...)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2890 : echohl Title
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2891 : echo a:title
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2892 : echohl None
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	2893 : echo a:0 .. " items:"
140 8ecb0db93e9a updated for version 7.0045 vimboss parents: 133 diff changeset	2894 : for s in a:000
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	2895 : echon ' ' .. s
140 8ecb0db93e9a updated for version 7.0045 vimboss parents: 133 diff changeset	2896 : endfor
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2897 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2898
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2899 This function can then be called with: >
140 8ecb0db93e9a updated for version 7.0045 vimboss parents: 133 diff changeset	2900 call Table("Table", "line1", "line2")
8ecb0db93e9a updated for version 7.0045 vimboss parents: 133 diff changeset	2901 call Table("Empty Table")
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2902
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	2903 To return more than one value, return a \|List\|: >
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	2904 :function Compute(n1, n2)
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2905 : if a:n2 == 0
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	2906 : return ["fail", 0]
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2907 : endif
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	2908 : return ["ok", a:n1 / a:n2]
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2909 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2910
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2911 This function can then be called with: >
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	2912 :let [success, div] = Compute(102, 6)
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2913 :if success == "ok"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2914 : echo div
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2915 :endif
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	2916 <
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	2917 :cal :call E107
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2918 :[range]cal[l] {name}([arguments])
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2919 Call a function. The name of the function and its arguments
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16704 diff changeset	2920 are as specified with `:function`. Up to 20 arguments can be
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	2921 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	2922 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	2923 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	2924 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	2925 SomeFunc(arg)
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	2926 < Without a range and for functions that accept a range, the
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2927 function is called once. When a range is given the cursor is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2928 positioned at the start of the first line before executing the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2929 function.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2930 When a range is given and the function doesn't handle it
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2931 itself, the function is executed for each line in the range,
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2932 with the cursor in the first column of that line. The cursor
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2933 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	2934 call). The arguments are re-evaluated for each line. Thus
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2935 this works:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2936 function-range-example >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2937 :function Mynumber(arg)
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	2938 : echo line(".") .. " " .. a:arg
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2939 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2940 :1,5call Mynumber(getline("."))
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2941 <
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2942 The "a:firstline" and "a:lastline" are defined anyway, they
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2943 can be used to do something different at the start or end of
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2944 the range.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2945
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2946 Example of a function that handles the range itself: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2947
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2948 :function Cont() range
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	2949 : execute (a:firstline + 1) .. "," .. a:lastline .. 's/^/\t\\ '
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2950 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2951 :4,8call Cont()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2952 <
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2953 This function inserts the continuation character "\" in front
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2954 of all the lines in the range, except the first one.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2955
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	2956 When the function returns a composite value it can be further
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	2957 dereferenced, but the range will not be used then. Example: >
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	2958 :4,8call GetDict().method()
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	2959 < Here GetDict() gets the range but method() does not.
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	2960
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	2961 E117
3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	2962 When a function cannot be found the error "E117: Unknown function" will be
3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	2963 given. If the function was using an autoload path or an autoload import and
3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	2964 the script is a \|Vim9\| script, this may also be caused by the function not
3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	2965 being exported.
3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	2966
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2967 E132
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2968 The recursiveness of user functions is restricted with the \|'maxfuncdepth'\|
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2969 option.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2970
17620 072efa9ca875 patch 8.1.1807: more functions can be used as a method Bram Moolenaar <Bram@vim.org> parents: 17612 diff changeset	2971 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	2972 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	2973 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	2974
17667 95c23e180022 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17661 diff changeset	2975 A function can also be called as part of evaluating an expression or when it
95c23e180022 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17661 diff changeset	2976 is used as a method: >
95c23e180022 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17661 diff changeset	2977 let x = GetList()
95c23e180022 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17661 diff changeset	2978 let y = GetList()->Filter()
95c23e180022 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17661 diff changeset	2979
161 6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	2980
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	2981 AUTOMATICALLY LOADING FUNCTIONS ~
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2982 autoload-functions
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2983 When using many or large functions, it's possible to automatically define them
161 6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	2984 only when they are used. There are two methods: with an autocommand and with
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	2985 the "autoload" directory in 'runtimepath'.
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	2986
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	2987
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	2988 Using an autocommand ~
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	2989
28862 82244cfc4694 Update runtime files, new color schemes Bram Moolenaar <Bram@vim.org> parents: 28843 diff changeset	2990 This is introduced in the user manual, section \|51.4\|.
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	2991
161 6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	2992 The autocommand is useful if you have a plugin that is a long Vim script file.
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16704 diff changeset	2993 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	2994 That makes Vim startup faster. The autocommand should then load the same file
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16704 diff changeset	2995 again, setting a variable to skip the `:finish` command.
161 6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	2996
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	2997 Use the FuncUndefined autocommand event with a pattern that matches the
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	2998 function(s) to be defined. Example: >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2999
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3000 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3001
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3002 The file "~/vim/bufnetfuncs.vim" should then define functions that start with
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3003 "BufNet". Also see \|FuncUndefined\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3004
161 6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3005
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3006 Using an autoload script ~
168 4d9eabb1396e updated for version 7.0051 vimboss parents: 164 diff changeset	3007 autoload E746
29066 f8e9d5023bf6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28964 diff changeset	3008 This is introduced in the user manual, section \|52.2\|.
170 8c60f65311fa updated for version 7.0052 vimboss parents: 168 diff changeset	3009
161 6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3010 Using a script in the "autoload" directory is simpler, but requires using
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3011 exactly the right file name. A function that can be autoloaded has a name
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3012 like this: >
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3013
270 a20218704019 updated for version 7.0072 vimboss parents: 258 diff changeset	3014 :call filename#funcname()
161 6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3015
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20836 diff changeset	3016 These functions are always global, in Vim9 script "g:" needs to be used: >
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20836 diff changeset	3017 :call g:filename#funcname()
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20836 diff changeset	3018
161 6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3019 When such a function is called, and it is not defined yet, Vim will search the
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3020 "autoload" directories in 'runtimepath' for a script file called
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3021 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3022 then define the function like this: >
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3023
270 a20218704019 updated for version 7.0072 vimboss parents: 258 diff changeset	3024 function filename#funcname()
161 6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3025 echo "Done!"
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3026 endfunction
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3027
530 339999b511a0 updated for version 7.0148 vimboss parents: 523 diff changeset	3028 The file name and the name used before the # in the function must match
161 6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3029 exactly, and the defined function must have the name exactly as it will be
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20836 diff changeset	3030 called. In Vim9 script the "g:" prefix must be used: >
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20836 diff changeset	3031 function g:filename#funcname()
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20836 diff changeset	3032
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20836 diff changeset	3033 or for a compiled function: >
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20836 diff changeset	3034 def g:filename#funcname()
161 6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3035
270 a20218704019 updated for version 7.0072 vimboss parents: 258 diff changeset	3036 It is possible to use subdirectories. Every # in the function name works like
a20218704019 updated for version 7.0072 vimboss parents: 258 diff changeset	3037 a path separator. Thus when calling a function: >
a20218704019 updated for version 7.0072 vimboss parents: 258 diff changeset	3038
a20218704019 updated for version 7.0072 vimboss parents: 258 diff changeset	3039 :call foo#bar#func()
161 6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3040
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3041 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'.
6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3042
168 4d9eabb1396e updated for version 7.0051 vimboss parents: 164 diff changeset	3043 This also works when reading a variable that has not been set yet: >
4d9eabb1396e updated for version 7.0051 vimboss parents: 164 diff changeset	3044
270 a20218704019 updated for version 7.0072 vimboss parents: 258 diff changeset	3045 :let l = foo#bar#lvar
168 4d9eabb1396e updated for version 7.0051 vimboss parents: 164 diff changeset	3046
557 862863033fdd updated for version 7.0158 vimboss parents: 555 diff changeset	3047 However, when the autoload script was already loaded it won't be loaded again
862863033fdd updated for version 7.0158 vimboss parents: 555 diff changeset	3048 for an unknown variable.
862863033fdd updated for version 7.0158 vimboss parents: 555 diff changeset	3049
168 4d9eabb1396e updated for version 7.0051 vimboss parents: 164 diff changeset	3050 When assigning a value to such a variable nothing special happens. This can
4d9eabb1396e updated for version 7.0051 vimboss parents: 164 diff changeset	3051 be used to pass settings to the autoload script before it's loaded: >
4d9eabb1396e updated for version 7.0051 vimboss parents: 164 diff changeset	3052
270 a20218704019 updated for version 7.0072 vimboss parents: 258 diff changeset	3053 :let foo#bar#toggle = 1
a20218704019 updated for version 7.0072 vimboss parents: 258 diff changeset	3054 :call foo#bar#func()
168 4d9eabb1396e updated for version 7.0051 vimboss parents: 164 diff changeset	3055
164 8b0ee9d57d7f updated for version 7.0050 vimboss parents: 161 diff changeset	3056 Note that when you make a mistake and call a function that is supposed to be
8b0ee9d57d7f updated for version 7.0050 vimboss parents: 161 diff changeset	3057 defined in an autoload script, but the script doesn't actually define the
22723 5b7ea82bc18f Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22689 diff changeset	3058 function, you will get an error message for the missing function. If you fix
5b7ea82bc18f Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22689 diff changeset	3059 the autoload script it won't be automatically loaded again. Either restart
5b7ea82bc18f Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22689 diff changeset	3060 Vim or manually source the script.
168 4d9eabb1396e updated for version 7.0051 vimboss parents: 164 diff changeset	3061
4d9eabb1396e updated for version 7.0051 vimboss parents: 164 diff changeset	3062 Also note that if you have two script files, and one calls a function in the
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3063 other and vice versa, before the used function is defined, it won't work.
168 4d9eabb1396e updated for version 7.0051 vimboss parents: 164 diff changeset	3064 Avoid using the autoload functionality at the toplevel.
161 6df0106fc595 updated for version 7.0049 vimboss parents: 158 diff changeset	3065
27804 8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27635 diff changeset	3066 In \|Vim9\| script you will get error E1263 if you define a function with
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27635 diff changeset	3067 a "#" character in the name. You should use a name without "#" and use
8fc68ce4a097 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27635 diff changeset	3068 `:export`.
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	3069
794 f19994020dad updated for version 7.0231 vimboss parents: 790 diff changeset	3070 Hint: If you distribute a bunch of scripts you can pack them together with the
f19994020dad updated for version 7.0231 vimboss parents: 790 diff changeset	3071 \|vimball\| utility. Also read the user manual \|distribute-script\|.
f19994020dad updated for version 7.0231 vimboss parents: 790 diff changeset	3072
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3073 ==============================================================================
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3074 6. Curly braces names curly-braces-names
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3075
3410 94601b379f38 Updated runtime files. Add Dutch translations. Bram Moolenaar <bram@vim.org> parents: 3398 diff changeset	3076 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	3077 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	3078 wrapped in braces {} like this: >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3079 my_{adjective}_variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3080
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	3081 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	3082
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3083 When Vim encounters this, it evaluates the expression inside the braces, puts
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3084 that in place of the expression, and re-interprets the whole as a variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3085 name. So in the above example, if the variable "adjective" was set to
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3086 "noisy", then the reference would be to "my_noisy_variable", whereas if
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3087 "adjective" was set to "quiet", then it would be to "my_quiet_variable".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3088
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3089 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	3090 value. For example, the statement >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3091 echo my_{&background}_message
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3092
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3093 would output the contents of "my_dark_message" or "my_light_message" depending
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3094 on the current value of 'background'.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3095
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3096 You can use multiple brace pairs: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3097 echo my_{adverb}_{adjective}_message
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3098 ..or even nest them: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3099 echo my_{ad{end_of_word}}_message
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3100 where "end_of_word" is either "verb" or "jective".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3101
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3102 However, the expression inside the braces must evaluate to a valid single
236 4707450c2b33 updated for version 7.0066 vimboss parents: 233 diff changeset	3103 variable name, e.g. this is invalid: >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3104 :let foo='a + b'
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3105 :echo c{foo}d
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3106 .. since the result of expansion is "ca + bd", which is not a variable name.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3107
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3108 curly-braces-function-names
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3109 You can call and define functions by an evaluated name in a similar way.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3110 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3111 :let func_end='whizz'
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3112 :call my_func_{func_end}(parameter)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3113
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3114 This would call the function "my_func_whizz(parameter)".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3115
3410 94601b379f38 Updated runtime files. Add Dutch translations. Bram Moolenaar <bram@vim.org> parents: 3398 diff changeset	3116 This does NOT work: >
94601b379f38 Updated runtime files. Add Dutch translations. Bram Moolenaar <bram@vim.org> parents: 3398 diff changeset	3117 :let i = 3
94601b379f38 Updated runtime files. Add Dutch translations. Bram Moolenaar <bram@vim.org> parents: 3398 diff changeset	3118 :let @{i} = '' " error
94601b379f38 Updated runtime files. Add Dutch translations. Bram Moolenaar <bram@vim.org> parents: 3398 diff changeset	3119 :echo @{i} " error
94601b379f38 Updated runtime files. Add Dutch translations. Bram Moolenaar <bram@vim.org> parents: 3398 diff changeset	3120
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3121 ==============================================================================
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3122 7. Commands expression-commands
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3123
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	3124 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	3125 declarations and assignments do not use a command. \|vim9-declaration\|
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20836 diff changeset	3126
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3127 :let {var-name} = {expr1} :let E18
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3128 Set internal variable {var-name} to the result of the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3129 expression {expr1}. The variable will get the type
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3130 from the {expr}. If {var-name} didn't exist yet, it
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3131 is created.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3132
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	3133 :let {var-name}[{idx}] = {expr1} E689 E1141
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	3134 Set a list item to the result of the expression
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	3135 {expr1}. {var-name} must refer to a list and {idx}
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	3136 must be a valid index in that list. For nested list
fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	3137 the index can be repeated.
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3138 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	3139 This cannot be used to set a byte in a String. You
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3140 can do that like this: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	3141 :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	3142 < 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	3143 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	3144 appended.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data Bram Moolenaar <Bram@vim.org> parents: 15446 diff changeset	3145
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	3146 E711 E719 E1165 E1166 E1183
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3147 :let {var-name}[{idx1}:{idx2}] = {expr1} E708 E709 E710
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3148 Set a sequence of items in a \|List\| to the result of
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3149 the expression {expr1}, which must be a list with the
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	3150 correct number of items.
014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	3151 {idx1} can be omitted, zero is used instead.
014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	3152 {idx2} can be omitted, meaning the end of the list.
014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	3153 When the selected range of items is partly past the
014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	3154 end of the list, items will be added.
014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	3155
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	3156 :let+= :let-= :letstar= :let/= :let%=
3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	3157 :let.= :let..= E734 E985 E1019
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3158 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}".
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3159 :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	3160 :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	3161 :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	3162 :let {var} %= {expr1} Like ":let {var} = {var} % {expr1}".
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3163 :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	3164 :let {var} ..= {expr1} Like ":let {var} = {var} .. {expr1}".
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3165 These fail if {var} was not set yet and when the type
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3166 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	3167 `.=` 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	3168 later, see \|vimscript-version\|.
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3169
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3170
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3171 :let ${env-name} = {expr1} :let-environment :let-$
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3172 Set environment variable {env-name} to the result of
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3173 the expression {expr1}. The type is always String.
17758 f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	3174
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	3175 On some systems making an environment variable empty
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	3176 causes it to be deleted. Many systems do not make a
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	3177 difference between an environment variable that is not
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	3178 set and an environment variable that is empty.
f2c2f9126a82 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 17756 diff changeset	3179
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3180 :let ${env-name} .= {expr1}
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3181 Append {expr1} to the environment variable {env-name}.
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3182 If the environment variable didn't exist yet this
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3183 works like "=".
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3184
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3185 :let @{reg-name} = {expr1} :let-register :let-@
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3186 Write the result of the expression {expr1} in register
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3187 {reg-name}. {reg-name} must be a single letter, and
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3188 must be the name of a writable register (see
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3189 \|registers\|). "@@" can be used for the unnamed
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3190 register, "@/" for the search pattern.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3191 If the result of {expr1} ends in a <CR> or <NL>, the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3192 register will be linewise, otherwise it will be set to
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3193 characterwise.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3194 This can be used to clear the last search pattern: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3195 :let @/ = ""
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3196 < This is different from searching for an empty string,
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3197 that would match everywhere.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3198
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3199 :let @{reg-name} .= {expr1}
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	3200 Append {expr1} to register {reg-name}. If the
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3201 register was empty it's like setting it to {expr1}.
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3202
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	3203 :let &{option-name} = {expr1} :let-option :let-&
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3204 Set option {option-name} to the result of the
68 a97c6902ecd9 updated for version 7.0030 vimboss parents: 55 diff changeset	3205 expression {expr1}. A String or Number value is
a97c6902ecd9 updated for version 7.0030 vimboss parents: 55 diff changeset	3206 always converted to the type of the option.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3207 For an option local to a window or buffer the effect
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3208 is just like using the \|:set\| command: both the local
555 a5efb97bc104 updated for version 7.0157 vimboss parents: 548 diff changeset	3209 value and the global value are changed.
68 a97c6902ecd9 updated for version 7.0030 vimboss parents: 55 diff changeset	3210 Example: >
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	3211 :let &path = &path .. ',/usr/local/include'
10895 c391bfbdb452 Updated runtime files. Christian Brabandt <cb@256bit.org> parents: 10787 diff changeset	3212 < This also works for terminal codes in the form t_xx.
c391bfbdb452 Updated runtime files. Christian Brabandt <cb@256bit.org> parents: 10787 diff changeset	3213 But only for alphanumerical names. Example: >
c391bfbdb452 Updated runtime files. Christian Brabandt <cb@256bit.org> parents: 10787 diff changeset	3214 :let &t_k1 = "\<Esc>[234;"
c391bfbdb452 Updated runtime files. Christian Brabandt <cb@256bit.org> parents: 10787 diff changeset	3215 < 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	3216 a terminal key code, there is no error.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3217
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3218 :let &{option-name} .= {expr1}
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3219 For a string option: Append {expr1} to the value.
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3220 Does not insert a comma like \|:set+=\|.
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3221
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3222 :let &{option-name} += {expr1}
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3223 :let &{option-name} -= {expr1}
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3224 For a number or boolean option: Add or subtract
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3225 {expr1}.
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3226
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3227 :let &l:{option-name} = {expr1}
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3228 :let &l:{option-name} .= {expr1}
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3229 :let &l:{option-name} += {expr1}
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3230 :let &l:{option-name} -= {expr1}
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3231 Like above, but only set the local value of an option
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3232 (if there is one). Works like \|:setlocal\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3233
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3234 :let &g:{option-name} = {expr1}
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3235 :let &g:{option-name} .= {expr1}
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3236 :let &g:{option-name} += {expr1}
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3237 :let &g:{option-name} -= {expr1}
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3238 Like above, but only set the global value of an option
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3239 (if there is one). Works like \|:setglobal\|.
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	3240 E1093
85 fc244e0a6e7e updated for version 7.0034 vimboss parents: 82 diff changeset	3241 :let [{name1}, {name2}, ...] = {expr1} :let-unpack E687 E688
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3242 {expr1} must evaluate to a \|List\|. The first item in
68 a97c6902ecd9 updated for version 7.0030 vimboss parents: 55 diff changeset	3243 the list is assigned to {name1}, the second item to
a97c6902ecd9 updated for version 7.0030 vimboss parents: 55 diff changeset	3244 {name2}, etc.
a97c6902ecd9 updated for version 7.0030 vimboss parents: 55 diff changeset	3245 The number of names must match the number of items in
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3246 the \|List\|.
68 a97c6902ecd9 updated for version 7.0030 vimboss parents: 55 diff changeset	3247 Each name can be one of the items of the ":let"
a97c6902ecd9 updated for version 7.0030 vimboss parents: 55 diff changeset	3248 command as mentioned above.
a97c6902ecd9 updated for version 7.0030 vimboss parents: 55 diff changeset	3249 Example: >
a97c6902ecd9 updated for version 7.0030 vimboss parents: 55 diff changeset	3250 :let [s, item] = GetItem(s)
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3251 < Detail: {expr1} is evaluated first, then the
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3252 assignments are done in sequence. This matters if
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3253 {name2} depends on {name1}. Example: >
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3254 :let x = [0, 1]
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3255 :let i = 0
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3256 :let [i, x[i]] = [1, 2]
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3257 :echo x
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3258 < The result is [0, 2].
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3259
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3260 :let [{name1}, {name2}, ...] .= {expr1}
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3261 :let [{name1}, {name2}, ...] += {expr1}
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3262 :let [{name1}, {name2}, ...] -= {expr1}
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3263 Like above, but append/add/subtract the value for each
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3264 \|List\| item.
68 a97c6902ecd9 updated for version 7.0030 vimboss parents: 55 diff changeset	3265
19968 1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19952 diff changeset	3266 :let [{name}, ..., ; {lastname}] = {expr1} E452
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3267 Like \|:let-unpack\| above, but the \|List\| may have more
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3268 items than there are names. A list of the remaining
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3269 items is assigned to {lastname}. If there are no
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3270 remaining items {lastname} is set to an empty list.
68 a97c6902ecd9 updated for version 7.0030 vimboss parents: 55 diff changeset	3271 Example: >
a97c6902ecd9 updated for version 7.0030 vimboss parents: 55 diff changeset	3272 :let [a, b; rest] = ["aval", "bval", 3, 4]
a97c6902ecd9 updated for version 7.0030 vimboss parents: 55 diff changeset	3273 <
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3274 :let [{name}, ..., ; {lastname}] .= {expr1}
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3275 :let [{name}, ..., ; {lastname}] += {expr1}
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3276 :let [{name}, ..., ; {lastname}] -= {expr1}
f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3277 Like above, but append/add/subtract the value for each
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3278 \|List\| item.
2596 fae782ef63dd Runtime file updates. Bram Moolenaar <bram@vim.org> parents: 2581 diff changeset	3279
17450 509542f1fffb patch 8.1.1723: heredoc assignment has no room for new features Bram Moolenaar <Bram@vim.org> parents: 17433 diff changeset	3280 :let=<< :let-heredoc
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	3281 E990 E991 E172 E221 E1145
28491 769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3282 :let {var-name} =<< [trim] [eval] {endmarker}
16704 a927fdf9a4b0 patch 8.1.1354: getting a list of text lines is clumsy Bram Moolenaar <Bram@vim.org> parents: 16664 diff changeset	3283 text...
a927fdf9a4b0 patch 8.1.1354: getting a list of text lines is clumsy Bram Moolenaar <Bram@vim.org> parents: 16664 diff changeset	3284 text...
18343 375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3285 {endmarker}
21093 99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20965 diff changeset	3286 Set internal variable {var-name} to a \|List\|
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20965 diff changeset	3287 containing the lines of text bounded by the string
28491 769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3288 {endmarker}.
769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3289
769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3290 If "eval" is not specified, then each line of text is
28777 b96ceb97e896 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28718 diff changeset	3291 used as a \|literal-string\|, except that single quotes
29290 dc4de65a7fb7 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 29236 diff changeset	3292 does not need to be doubled.
28777 b96ceb97e896 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28718 diff changeset	3293 If "eval" is specified, then any Vim expression in the
b96ceb97e896 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28718 diff changeset	3294 form {expr} is evaluated and the result replaces the
b96ceb97e896 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28718 diff changeset	3295 expression, like with \|interp-string\|.
28491 769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3296 Example where $HOME is expanded: >
769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3297 let lines =<< trim eval END
769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3298 some text
28777 b96ceb97e896 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28718 diff changeset	3299 See the file {$HOME}/.vimrc
28491 769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3300 more text
769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3301 END
769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3302 < There can be multiple Vim expressions in a single line
769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3303 but an expression cannot span multiple lines. If any
769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3304 expression evaluation fails, then the assignment fails.
769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3305
18343 375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3306 {endmarker} must not contain white space.
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3307 {endmarker} cannot start with a lower case character.
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3308 The last line should end only with the {endmarker}
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3309 string without any other character. Watch out for
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3310 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	3311
17172 6990c1160ea5 patch 8.1.1585: :let-heredoc does not trim enough Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	3312 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	3313 of text are preserved. If "trim" is specified before
18343 375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3314 {endmarker}, then indentation is stripped so you can
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3315 do: >
17172 6990c1160ea5 patch 8.1.1585: :let-heredoc does not trim enough Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	3316 let text =<< trim END
6990c1160ea5 patch 8.1.1585: :let-heredoc does not trim enough Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	3317 if ok
6990c1160ea5 patch 8.1.1585: :let-heredoc does not trim enough Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	3318 echo 'done'
6990c1160ea5 patch 8.1.1585: :let-heredoc does not trim enough Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	3319 endif
6990c1160ea5 patch 8.1.1585: :let-heredoc does not trim enough Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	3320 END
6990c1160ea5 patch 8.1.1585: :let-heredoc does not trim enough Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	3321 < 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	3322 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	3323 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	3324 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	3325 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	3326 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	3327 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	3328 indentation before `let` is stripped from the line
18343 375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3329 containing {endmarker}. Note that the difference
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3330 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	3331
a927fdf9a4b0 patch 8.1.1354: getting a list of text lines is clumsy Bram Moolenaar <Bram@vim.org> parents: 16664 diff changeset	3332 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	3333 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	3334 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	3335
18343 375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3336 To avoid line continuation to be applied, consider
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3337 adding 'C' to 'cpoptions': >
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3338 set cpo+=C
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3339 let var =<< END
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3340 \ leading backslash
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3341 END
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3342 set cpo-=C
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3343 <
16704 a927fdf9a4b0 patch 8.1.1354: getting a list of text lines is clumsy Bram Moolenaar <Bram@vim.org> parents: 16664 diff changeset	3344 Examples: >
a927fdf9a4b0 patch 8.1.1354: getting a list of text lines is clumsy Bram Moolenaar <Bram@vim.org> parents: 16664 diff changeset	3345 let var1 =<< END
18343 375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3346 Sample text 1
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3347 Sample text 2
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3348 Sample text 3
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3349 END
16704 a927fdf9a4b0 patch 8.1.1354: getting a list of text lines is clumsy Bram Moolenaar <Bram@vim.org> parents: 16664 diff changeset	3350
a927fdf9a4b0 patch 8.1.1354: getting a list of text lines is clumsy Bram Moolenaar <Bram@vim.org> parents: 16664 diff changeset	3351 let data =<< trim DATA
18343 375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3352 1 2 3 4
375a7ecdb351 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18186 diff changeset	3353 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	3354 DATA
28491 769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3355
769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3356 let code =<< trim eval CODE
28777 b96ceb97e896 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28718 diff changeset	3357 let v = {10 + 20}
b96ceb97e896 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28718 diff changeset	3358 let h = "{$HOME}"
b96ceb97e896 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28718 diff changeset	3359 let s = "{Str1()} abc {Str2()}"
b96ceb97e896 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28718 diff changeset	3360 let n = {MyFunc(3, 4)}
28491 769599ee9f06 patch 8.2.4770: cannot easily mix expression and heredoc Bram Moolenaar <Bram@vim.org> parents: 28405 diff changeset	3361 CODE
16704 a927fdf9a4b0 patch 8.1.1354: getting a list of text lines is clumsy Bram Moolenaar <Bram@vim.org> parents: 16664 diff changeset	3362 <
2596 fae782ef63dd Runtime file updates. Bram Moolenaar <bram@vim.org> parents: 2581 diff changeset	3363 E121
9877 7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b Christian Brabandt <cb@256bit.org> parents: 9861 diff changeset	3364 :let {var-name} .. List the value of variable {var-name}. Multiple
123 f67f8a8d81ba updated for version 7.0043 vimboss parents: 119 diff changeset	3365 variable names may be given. Special names recognized
f67f8a8d81ba updated for version 7.0043 vimboss parents: 119 diff changeset	3366 here: E738
777 f664cc974a7a updated for version 7.0227 vimboss parents: 724 diff changeset	3367 g: global variables
f664cc974a7a updated for version 7.0227 vimboss parents: 724 diff changeset	3368 b: local buffer variables
f664cc974a7a updated for version 7.0227 vimboss parents: 724 diff changeset	3369 w: local window variables
819 23f82b5d2814 updated for version 7.0c10 vimboss parents: 818 diff changeset	3370 t: local tab page variables
777 f664cc974a7a updated for version 7.0227 vimboss parents: 724 diff changeset	3371 s: script-local variables
f664cc974a7a updated for version 7.0227 vimboss parents: 724 diff changeset	3372 l: local function variables
123 f67f8a8d81ba updated for version 7.0043 vimboss parents: 119 diff changeset	3373 v: Vim variables.
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20836 diff changeset	3374 This does not work in Vim9 script. \|vim9-declaration\|
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3375
55 225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	3376 :let List the values of all variables. The type of the
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	3377 variable is indicated before the value:
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	3378 <nothing> String
225cc00b2eda updated for version 7.0029 vimboss parents: 37 diff changeset	3379 # Number
856 8cd729851562 updated for version 7.0g vimboss parents: 853 diff changeset	3380 * Funcref
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20836 diff changeset	3381 This does not work in Vim9 script. \|vim9-declaration\|
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3382
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	3383 :unl[et][!] {name} ... :unlet :unl E108 E795 E1081
148 72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3384 Remove the internal variable {name}. Several variable
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3385 names can be given, they are all removed. The name
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3386 may also be a \|List\| or \|Dictionary\| item.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3387 With [!] no error message is given for non-existing
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3388 variables.
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3389 One or more items from a \|List\| can be removed: >
108 375b1d0f97b0 updated for version 7.0040 vimboss parents: 102 diff changeset	3390 :unlet list[3] " remove fourth item
375b1d0f97b0 updated for version 7.0040 vimboss parents: 102 diff changeset	3391 :unlet list[3:] " remove fourth item to last
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3392 < One item from a \|Dictionary\| can be removed at a time: >
108 375b1d0f97b0 updated for version 7.0040 vimboss parents: 102 diff changeset	3393 :unlet dict['two']
375b1d0f97b0 updated for version 7.0040 vimboss parents: 102 diff changeset	3394 :unlet dict.two
1668 0b796e045c42 updated for version 7.2b-000 vimboss parents: 1661 diff changeset	3395 < This is especially useful to clean up used global
0b796e045c42 updated for version 7.2b-000 vimboss parents: 1661 diff changeset	3396 variables and script-local variables (these are not
0b796e045c42 updated for version 7.2b-000 vimboss parents: 1661 diff changeset	3397 deleted when the script ends). Function-local
0b796e045c42 updated for version 7.2b-000 vimboss parents: 1661 diff changeset	3398 variables are automatically deleted when the function
0b796e045c42 updated for version 7.2b-000 vimboss parents: 1661 diff changeset	3399 ends.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3400
13923 e4d5726e1678 patch 8.0.1832: cannot use :unlet for an environment variable Christian Brabandt <cb@256bit.org> parents: 13821 diff changeset	3401 :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	3402 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	3403 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	3404 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	3405 variable, also without !.
e4d5726e1678 patch 8.0.1832: cannot use :unlet for an environment variable Christian Brabandt <cb@256bit.org> parents: 13821 diff changeset	3406 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	3407 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	3408
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	3409 :cons :const E1018
17079 00ffed9bbb65 patch 8.1.1539: not easy to define a variable and lock it Bram Moolenaar <Bram@vim.org> parents: 17053 diff changeset	3410 :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	3411 :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	3412 :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	3413 :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	3414 text...
00ffed9bbb65 patch 8.1.1539: not easy to define a variable and lock it Bram Moolenaar <Bram@vim.org> parents: 17053 diff changeset	3415 text...
00ffed9bbb65 patch 8.1.1539: not easy to define a variable and lock it Bram Moolenaar <Bram@vim.org> parents: 17053 diff changeset	3416 {marker}
00ffed9bbb65 patch 8.1.1539: not easy to define a variable and lock it Bram Moolenaar <Bram@vim.org> parents: 17053 diff changeset	3417 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	3418 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	3419 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	3420 :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	3421 < 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	3422 :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	3423 :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	3424 < 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	3425 \|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	3426 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	3427 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	3428 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	3429 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	3430 let ll[1] = 5 " Error!
25880 9c221ad9634a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25864 diff changeset	3431 < 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	3432 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	3433 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	3434 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	3435 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	3436 < E995
17131 be5a5cfc991a patch 8.1.1565: MS-Windows: no sound support Bram Moolenaar <Bram@vim.org> parents: 17109 diff changeset	3437 \|: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	3438 :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	3439 :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	3440 < E996
cc5d4b4bae83 patch 8.1.1554: docs and tests for :const can be improved Bram Moolenaar <Bram@vim.org> parents: 17085 diff changeset	3441 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	3442 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	3443 be locked.
cc5d4b4bae83 patch 8.1.1554: docs and tests for :const can be improved Bram Moolenaar <Bram@vim.org> parents: 17085 diff changeset	3444
17433 ca8e754bdd53 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17413 diff changeset	3445 :cons[t]
ca8e754bdd53 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17413 diff changeset	3446 :cons[t] {var-name}
ca8e754bdd53 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17413 diff changeset	3447 If no argument is given or only {var-name} is given,
ca8e754bdd53 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17413 diff changeset	3448 the behavior is the same as \|:let\|.
ca8e754bdd53 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17413 diff changeset	3449
148 72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3450 :lockv[ar][!] [depth] {name} ... :lockvar :lockv
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3451 Lock the internal variable {name}. Locking means that
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3452 it can no longer be changed (until it is unlocked).
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3453 A locked variable can be deleted: >
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3454 :lockvar v
24278 4ab4ef0c48b1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 24234 diff changeset	3455 :let v = 'asdf' " fails!
4ab4ef0c48b1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 24234 diff changeset	3456 :unlet v " works
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	3457 < E741 E940 E1118 E1119 E1120 E1121 E1122
148 72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3458 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	3459 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	3460 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	3461 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	3462 variable {name}".
148 72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3463
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3464 [depth] is relevant when locking a \|List\| or
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3465 \|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	3466 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	3467 value.
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3468 1 Lock the \|List\| or \|Dictionary\| itself,
148 72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3469 cannot add or remove items, but can
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3470 still change their values.
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3471 2 Also lock the values, cannot change
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3472 the items. If an item is a \|List\| or
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3473 \|Dictionary\|, cannot add or remove
148 72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3474 items, but can still change the
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3475 values.
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3476 3 Like 2 but for the \|List\| /
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3477 \|Dictionary\| in the \|List\| /
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3478 \|Dictionary\|, one level deeper.
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3479 The default [depth] is 2, thus when {name} is a \|List\|
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3480 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	3481
07e48ee8c3bb patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9 Bram Moolenaar <Bram@vim.org> parents: 22232 diff changeset	3482 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	3483 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	3484 lockvar 0 mylist
25880 9c221ad9634a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25864 diff changeset	3485 let mylist[0] = 77 " OK
9c221ad9634a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25864 diff changeset	3486 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	3487 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	3488 < E743
148 72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3489 For unlimited depth use [!] and omit [depth].
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3490 However, there is a maximum depth of 100 to catch
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3491 loops.
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3492
685 d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3493 Note that when two variables refer to the same \|List\|
d7e33248b9c8 updated for version 7.0206 vimboss parents: 681 diff changeset	3494 and you lock one of them, the \|List\| will also be
819 23f82b5d2814 updated for version 7.0c10 vimboss parents: 818 diff changeset	3495 locked when used through the other variable.
23f82b5d2814 updated for version 7.0c10 vimboss parents: 818 diff changeset	3496 Example: >
148 72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3497 :let l = [0, 1, 2, 3]
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3498 :let cl = l
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3499 :lockvar l
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3500 :let cl[1] = 99 " won't work!
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3501 < You may want to make a copy of a list to avoid this.
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3502 See \|deepcopy()\|.
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3503
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3504
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	3505 :unlo[ckvar][!] [depth] {name} ... :unlockvar :unlo E1246
148 72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3506 Unlock the internal variable {name}. Does the
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3507 opposite of \|:lockvar\|.
72aefd4c1e0d updated for version 7.0046 vimboss parents: 140 diff changeset	3508
16944 d23afa4d8b63 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16930 diff changeset	3509 :if {expr1} :if :end :endif :en E171 E579 E580
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3510 :en[dif] Execute the commands until the next matching `:else`
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3511 or `:endif` if {expr1} evaluates to non-zero.
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	3512 Although the short forms work, it is recommended to
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3513 always use `:endif` to avoid confusion and to make
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3514 auto-indenting work properly.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3515
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3516 From Vim version 4.5 until 5.0, every Ex command in
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3517 between the `:if` and `:endif` is ignored. These two
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3518 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	3519 backward compatible way. Nesting was allowed. Note
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3520 that any `:else` or `:elseif` was ignored, the `else`
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3521 part was not executed either.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3522
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3523 You can use this to remain compatible with older
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3524 versions: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3525 :if version >= 500
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3526 : version-5-specific-commands
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3527 :endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3528 < The commands still need to be parsed to find the
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3529 `endif`. Sometimes an older Vim has a problem with a
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3530 new command. For example, `:silent` is recognized as
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3531 a `:substitute` command. In that case `:execute` can
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3532 avoid problems: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3533 :if version >= 600
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3534 : execute "silent 1,$delete"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3535 :endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3536 <
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3537 In \|Vim9\| script `:endif` cannot be shortened, to
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3538 improve script readability.
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3539 NOTE: The `:append` and `:insert` commands don't work
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3540 properly in between `:if` and `:endif`.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3541
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3542 :else :el E581 E583
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3543 :el[se] Execute the commands until the next matching `:else`
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3544 or `:endif` if they previously were not being
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3545 executed.
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3546 In \|Vim9\| script `:else` cannot be shortened, to
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3547 improve script readability.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3548
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3549 :elseif :elsei E582 E584
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3550 :elsei[f] {expr1} Short for `:else` `:if`, with the addition that there
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3551 is no extra `:endif`.
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3552 In \|Vim9\| script `:elseif` cannot be shortened, to
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3553 improve script readability.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3554
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3555 :wh[ile] {expr1} :while :endwhile :wh :endw
114 f6e567606d47 updated for version 7.0041 vimboss parents: 108 diff changeset	3556 E170 E585 E588 E733
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3557 :endw[hile] Repeat the commands between `:while` and `:endwhile`,
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3558 as long as {expr1} evaluates to non-zero.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3559 When an error is detected from a command inside the
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3560 loop, execution continues after the `endwhile`.
75 388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3561 Example: >
388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3562 :let lnum = 1
388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3563 :while lnum <= line("$")
388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3564 :call FixLine(lnum)
388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3565 :let lnum = lnum + 1
388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3566 :endwhile
388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3567 <
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3568 In \|Vim9\| script `:while` and `:endwhile` cannot be
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3569 shortened, to improve script readability.
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3570 NOTE: The `:append` and `:insert` commands don't work
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3571 properly inside a `:while` and `:for` loop.
75 388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3572
15615 536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	3573 :for {var} in {object} :for E690 E732
75 388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3574 :endfo[r] :endfo :endfor
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3575 Repeat the commands between `:for` and `:endfor` for
28843 cd68a630f0d0 Update runtime files and translations Bram Moolenaar <Bram@vim.org> parents: 28777 diff changeset	3576 each item in {object}. {object} can be a \|List\|,
cd68a630f0d0 Update runtime files and translations Bram Moolenaar <Bram@vim.org> parents: 28777 diff changeset	3577 a \|Blob\| or a \|String\|. E1177
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	3578
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	3579 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	3580 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	3581 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	3582 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	3583
30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	3584 When an error is detected for a command inside the
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3585 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	3586 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	3587 are used. Make a copy if this is unwanted: >
79 e918d3e340a4 updated for version 7.0032 vimboss parents: 75 diff changeset	3588 :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	3589 <
26769 30972227ac8d patch 8.2.3913: help for expressions does not mention Vim9 syntax Bram Moolenaar <Bram@vim.org> parents: 26708 diff changeset	3590 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	3591 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	3592 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	3593 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	3594 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	3595 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	3596 inefficient way to make a \|List\| empty): >
2033 de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1998 diff changeset	3597 for item in mylist
de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1998 diff changeset	3598 call remove(mylist, 0)
de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1998 diff changeset	3599 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	3600 < Note that reordering the \|List\| (e.g., with sort() or
87 014ba200db86 updated for version 7.0035 vimboss parents: 85 diff changeset	3601 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	3602 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	3603 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	3604 skipped.
75 388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3605
15615 536fca2cee19 patch 8.1.0815: dialog for file changed outside of Vim not tested Bram Moolenaar <Bram@vim.org> parents: 15579 diff changeset	3606 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	3607 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	3608 \|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	3609
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3610 In \|Vim9\| script `:endfor` cannot be shortened, to
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3611 improve script readability.
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3612
75 388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3613 :for [{var1}, {var2}, ...] in {listlist}
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	3614 :endfo[r] E1140
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3615 Like `:for` above, but each item in {listlist} must be
75 388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3616 a list, of which each item is assigned to {var1},
388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3617 {var2}, etc. Example: >
388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3618 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]]
388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3619 :echo getline(lnum)[col]
388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3620 :endfor
388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3621 <
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3622 :continue :con E586
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3623 :con[tinue] When used inside a `:while` or `:for` loop, jumps back
75 388f285bda1b updated for version 7.0031 vimboss parents: 68 diff changeset	3624 to the start of the loop.
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3625 If it is used after a `:try` inside the loop but
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3626 before the matching `:finally` (if present), the
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3627 commands following the `:finally` up to the matching
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3628 `:endtry` are executed first. This process applies to
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3629 all nested `:try`s inside the loop. The outermost
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3630 `:endtry` then jumps back to the start of the loop.
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3631
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3632 In \|Vim9\| script `:cont` is the shortest form, to
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3633 improve script readability.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3634 :break :brea E587
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3635 :brea[k] When used inside a `:while` or `:for` loop, skips to
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3636 the command after the matching `:endwhile` or
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3637 `:endfor`.
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3638 If it is used after a `:try` inside the loop but
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3639 before the matching `:finally` (if present), the
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3640 commands following the `:finally` up to the matching
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3641 `:endtry` are executed first. This process applies to
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3642 all nested `:try`s inside the loop. The outermost
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3643 `:endtry` then jumps to the command after the loop.
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3644
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3645 In \|Vim9\| script `:break` cannot be shortened, to
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3646 improve script readability.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3647
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	3648 :try :try :endt :endtry
3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	3649 E600 E601 E602 E1032
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3650 :endt[ry] Change the error handling for the commands between
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3651 `:try` and `:endtry` including everything being
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3652 executed across `:source` commands, function calls,
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3653 or autocommand invocations.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3654
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3655 When an error or interrupt is detected and there is
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3656 a `:finally` command following, execution continues
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3657 after the `:finally`. Otherwise, or when the
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3658 `:endtry` is reached thereafter, the next
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3659 (dynamically) surrounding `:try` is checked for
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3660 a corresponding `:finally` etc. Then the script
19523 a7a24d06d7ce Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19483 diff changeset	3661 processing is terminated. Whether a function
a7a24d06d7ce Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19483 diff changeset	3662 definition has an "abort" argument does not matter.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3663 Example: >
19523 a7a24d06d7ce Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19483 diff changeset	3664 try \| call Unknown() \| finally \| echomsg "cleanup" \| endtry
a7a24d06d7ce Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19483 diff changeset	3665 echomsg "not reached"
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3666 <
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3667 Moreover, an error or interrupt (dynamically) inside
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3668 `:try` and `:endtry` is converted to an exception. It
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3669 can be caught as if it were thrown by a `:throw`
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3670 command (see `:catch`). In this case, the script
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3671 processing is not terminated.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3672
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3673 The value "Vim:Interrupt" is used for an interrupt
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3674 exception. An error in a Vim command is converted
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3675 to a value of the form "Vim({command}):{errmsg}",
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3676 other errors are converted to a value of the form
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3677 "Vim:{errmsg}". {command} is the full command name,
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3678 and {errmsg} is the message that is displayed if the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3679 error exception is not caught, always beginning with
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3680 the error number.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3681 Examples: >
19523 a7a24d06d7ce Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19483 diff changeset	3682 try \| sleep 100 \| catch /^Vim:Interrupt$/ \| endtry
a7a24d06d7ce Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19483 diff changeset	3683 try \| edit \| catch /^Vim(edit):E\d\+/ \| echo "error" \| endtry
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3684 <
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3685 In \|Vim9\| script `:endtry` cannot be shortened, to
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3686 improve script readability.
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3687
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	3688 :cat :catch
3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	3689 E603 E604 E605 E654 E1033
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3690 :cat[ch] /{pattern}/ The following commands until the next `:catch`,
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3691 `:finally`, or `:endtry` that belongs to the same
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3692 `:try` as the `:catch` are executed when an exception
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3693 matching {pattern} is being thrown and has not yet
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3694 been caught by a previous `:catch`. Otherwise, these
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3695 commands are skipped.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3696 When {pattern} is omitted all errors are caught.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3697 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	3698 :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	3699 :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	3700 :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	3701 :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	3702 :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	3703 :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	3704 :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	3705 :catch " same as /.*/
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3706 <
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3707 Another character can be used instead of / around the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3708 {pattern}, so long as it does not have a special
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3709 meaning (e.g., '\|' or '"') and doesn't occur inside
27321 3649b5a6b1b6 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27036 diff changeset	3710 {pattern}. E1067
5814 755931e042e4 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5808 diff changeset	3711 Information about the exception is available in
755931e042e4 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5808 diff changeset	3712 \|v:exception\|. Also see \|throw-variables\|.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3713 NOTE: It is not reliable to ":catch" the TEXT of
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3714 an error message because it may vary in different
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3715 locales.
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3716 In \|Vim9\| script `:catch` cannot be shortened, to
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3717 improve script readability.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3718
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3719 :fina :finally E606 E607
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3720 :fina[lly] The following commands until the matching `:endtry`
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3721 are executed whenever the part between the matching
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3722 `:try` and the `:finally` is left: either by falling
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3723 through to the `:finally` or by a `:continue`,
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3724 `:break`, `:finish`, or `:return`, or by an error or
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3725 interrupt or exception (see `:throw`).
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3726
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3727 In \|Vim9\| script `:finally` cannot be shortened, to
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3728 improve script readability and avoid confusion with
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3729 `:final`.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3730
27459 5825405e4e2c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27321 diff changeset	3731 :th :throw E608 E1129
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3732 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception.
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3733 If the ":throw" is used after a `:try` but before the
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3734 first corresponding `:catch`, commands are skipped
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3735 until the first `:catch` matching {expr1} is reached.
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3736 If there is no such `:catch` or if the ":throw" is
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3737 used after a `:catch` but before the `:finally`, the
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3738 commands following the `:finally` (if present) up to
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3739 the matching `:endtry` are executed. If the `:throw`
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3740 is after the `:finally`, commands up to the `:endtry`
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3741 are skipped. At the ":endtry", this process applies
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3742 again for the next dynamically surrounding `:try`
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3743 (which may be found in a calling function or sourcing
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3744 script), until a matching `:catch` has been found.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3745 If the exception is not caught, the command processing
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3746 is terminated.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3747 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3748 :try \| throw "oops" \| catch /^oo/ \| echo "caught" \| endtry
2725 6f63330ec225 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2709 diff changeset	3749 < Note that "catch" may need to be on a separate line
6f63330ec225 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2709 diff changeset	3750 for when an error causes the parsing to skip the whole
6f63330ec225 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2709 diff changeset	3751 line and not see the "\|" that separates the commands.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3752
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3753 In \|Vim9\| script `:throw` cannot be shortened, to
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3754 improve script readability.
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3755
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3756 :ec :echo
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3757 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3758 first {expr1} starts on a new line.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3759 Also see \|:comment\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3760 Use "\n" to start a new line. Use "\r" to move the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3761 cursor to the first column.
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3762 Uses the highlighting set by the `:echohl` command.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3763 Cannot be followed by a comment.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3764 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3765 :echo "the value of 'shell' is" &shell
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	3766 < :echo-redraw
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	3767 A later redraw may make the message disappear again.
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	3768 And since Vim mostly postpones redrawing until it's
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	3769 finished with a sequence of commands this happens
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	3770 quite often. To avoid that a command from before the
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3771 `:echo` causes a redraw afterwards (redraws are often
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	3772 postponed until you type something), force a redraw
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3773 with the `:redraw` command. Example: >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3774 :new \| redraw \| echo "there is a new window"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3775 <
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3776 :echon
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3777 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3778 \|:comment\|.
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3779 Uses the highlighting set by the `:echohl` command.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3780 Cannot be followed by a comment.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3781 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3782 :echon "the value of 'shell' is " &shell
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3783 <
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3784 Note the difference between using `:echo`, which is a
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3785 Vim command, and `:!echo`, which is an external shell
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3786 command: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3787 :!echo % --> filename
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3788 < The arguments of ":!" are expanded, see \|:_%\|. >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3789 :!echo "%" --> filename or "filename"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3790 < Like the previous example. Whether you see the double
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3791 quotes or not depends on your 'shell'. >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3792 :echo % --> nothing
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3793 < The '%' is an illegal character in an expression. >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3794 :echo "%" --> %
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3795 < This just echoes the '%' character. >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3796 :echo expand("%") --> filename
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3797 < This calls the expand() function to expand the '%'.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3798
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3799 :echoh :echohl
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3800 :echoh[l] {name} Use the highlight group {name} for the following
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3801 `:echo`, `:echon` and `:echomsg` commands. Also used
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3802 for the `input()` prompt. Example: >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3803 :echohl WarningMsg \| echo "Don't panic!" \| echohl None
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3804 < Don't forget to set the group back to "None",
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3805 otherwise all following echo's will be highlighted.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3806
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3807 :echom :echomsg
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3808 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3809 message in the \|message-history\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3810 Spaces are placed between the arguments as with the
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3811 `:echo` command. But unprintable characters are
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3812 displayed, not interpreted.
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3813 The parsing works slightly different from `:echo`,
c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3814 more like `:execute`. All the expressions are first
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	3815 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	3816 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	3817 String, string() is used to turn it into a string.
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3818 Uses the highlighting set by the `:echohl` command.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3819 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3820 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see."
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	3821 < See \|:echo-redraw\| to avoid the message disappearing
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	3822 when the screen is redrawn.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3823 :echoe :echoerr
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3824 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3825 message in the \|message-history\|. When used in a
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3826 script or function the line number will be added.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3827 Spaces are placed between the arguments as with the
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3828 `:echomsg` command. When used inside a try conditional,
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3829 the message is raised as an error exception instead
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3830 (see \|try-echoerr\|).
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3831 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3832 :echoerr "This script just failed!"
28010 c968191a8557 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 27903 diff changeset	3833 < If you just want a highlighted message use `:echohl`.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3834 And to get a beep: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3835 :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	3836
9f64c420f280 patch 8.2.2638: cannot write a message to the terminal from the GUI Bram Moolenaar <Bram@vim.org> parents: 24132 diff changeset	3837 :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	3838 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	3839 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	3840 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	3841
18639 cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	3842 :eval
cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	3843 :eval {expr} Evaluate {expr} and discard the result. Example: >
cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	3844 :eval Getlist()->Filter()->append('$')
cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	3845
cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	3846 < The expression is supposed to have a side effect,
cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	3847 since the resulting value is not used. In the example
cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	3848 the `append()` call appends the List with text to the
cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	3849 buffer. This is similar to `:call` but works with any
cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	3850 expression.
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	3851 In \|Vim9\| script an expression without an effect will
063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	3852 result in error E1207 . This should help noticing
063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	3853 mistakes.
18639 cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	3854
cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	3855 The command can be shortened to `:ev` or `:eva`, but
cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	3856 these are hard to recognize and therefore not to be
cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	3857 used.
cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	3858
19523 a7a24d06d7ce Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19483 diff changeset	3859 The command cannot be followed by "\|" and another
a7a24d06d7ce Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19483 diff changeset	3860 command, since "\|" is seen as part of the expression.
a7a24d06d7ce Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19483 diff changeset	3861
18639 cb3163d590a1 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18623 diff changeset	3862
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3863 :exe :execute
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3864 :exe[cute] {expr1} .. Executes the string that results from the evaluation
2152 b9e314fe473f Updated runtime files. Bram Moolenaar <bram@zimbu.org> parents: 2120 diff changeset	3865 of {expr1} as an Ex command.
b9e314fe473f Updated runtime files. Bram Moolenaar <bram@zimbu.org> parents: 2120 diff changeset	3866 Multiple arguments are concatenated, with a space in
23466 15fa3923cc49 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 23380 diff changeset	3867 between. To avoid the extra space use the ".."
2152 b9e314fe473f Updated runtime files. Bram Moolenaar <bram@zimbu.org> parents: 2120 diff changeset	3868 operator to concatenate strings into one argument.
b9e314fe473f Updated runtime files. Bram Moolenaar <bram@zimbu.org> parents: 2120 diff changeset	3869 {expr1} is used as the processed command, command line
b9e314fe473f Updated runtime files. Bram Moolenaar <bram@zimbu.org> parents: 2120 diff changeset	3870 editing keys are not recognized.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3871 Cannot be followed by a comment.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3872 Examples: >
2152 b9e314fe473f Updated runtime files. Bram Moolenaar <bram@zimbu.org> parents: 2120 diff changeset	3873 :execute "buffer" nextbuf
24103 788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 23931 diff changeset	3874 :execute "normal" count .. "w"
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3875 <
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3876 ":execute" can be used to append a command to commands
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3877 that don't accept a '\|'. Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3878 :execute '!ls' \| echo "theend"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3879
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3880 < ":execute" is also a nice way to avoid having to type
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3881 control characters in a Vim script for a ":normal"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3882 command: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3883 :execute "normal ixxx\<Esc>"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3884 < This has an <Esc> character, see \|expr-string\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3885
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3886 Be careful to correctly escape special characters in
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3887 file names. The \|fnameescape()\| function can be used
1661 5bbc2d6658ad updated for version 7.2a-013 vimboss parents: 1621 diff changeset	3888 for Vim commands, \|shellescape()\| for \|:!\| commands.
5bbc2d6658ad updated for version 7.2a-013 vimboss parents: 1621 diff changeset	3889 Examples: >
24103 788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 23931 diff changeset	3890 :execute "e " .. fnameescape(filename)
788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 23931 diff changeset	3891 :execute "!ls " .. shellescape(filename, 1)
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3892 <
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3893 Note: The executed string may be any command-line, but
5763 c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5747 diff changeset	3894 starting or ending "if", "while" and "for" does not
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5747 diff changeset	3895 always work, because when commands are skipped the
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5747 diff changeset	3896 ":execute" is not evaluated and Vim loses track of
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5747 diff changeset	3897 where blocks start and end. Also "break" and
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5747 diff changeset	3898 "continue" should not be inside ":execute".
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5747 diff changeset	3899 This example does not work, because the ":execute" is
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5747 diff changeset	3900 not evaluated and Vim does not see the "while", and
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5747 diff changeset	3901 gives an error for finding an ":endwhile": >
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5747 diff changeset	3902 :if 0
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5747 diff changeset	3903 : execute 'while i > 5'
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5747 diff changeset	3904 : echo "test"
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5747 diff changeset	3905 : endwhile
c52a655d927d Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5747 diff changeset	3906 :endif
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3907 <
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3908 It is allowed to have a "while" or "if" command
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3909 completely in the executed string: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3910 :execute 'while i < 5 \| echo i \| let i = i + 1 \| endwhile'
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3911 <
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3912
2033 de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1998 diff changeset	3913 :exe-comment
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3914 ":execute", ":echo" and ":echon" cannot be followed by
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3915 a comment directly, because they see the '"' as the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3916 start of a string. But, you can use '\|' followed by a
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3917 comment. Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3918 :echo "foo" \| "this is a comment
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3919
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3920 ==============================================================================
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3921 8. Exception handling exception-handling
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3922
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3923 The Vim script language comprises an exception handling feature. This section
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3924 explains how it can be used in a Vim script.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3925
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3926 Exceptions may be raised by Vim on an error or on interrupt, see
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3927 \|catch-errors\| and \|catch-interrupt\|. You can also explicitly throw an
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3928 exception by using the ":throw" command, see \|throw-catch\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3929
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3930
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3931 TRY CONDITIONALS try-conditionals
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3932
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3933 Exceptions can be caught or can cause cleanup code to be executed. You can
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3934 use a try conditional to specify catch clauses (that catch exceptions) and/or
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3935 a finally clause (to be executed for cleanup).
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3936 A try conditional begins with a \|:try\| command and ends at the matching
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3937 \|:endtry\| command. In between, you can use a \|:catch\| command to start
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3938 a catch clause, or a \|:finally\| command to start a finally clause. There may
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3939 be none or multiple catch clauses, but there is at most one finally clause,
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3940 which must not be followed by any catch clauses. The lines before the catch
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3941 clauses and the finally clause is called a try block. >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3942
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3943 :try
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3944 : ...
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3945 : ... TRY BLOCK
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3946 : ...
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3947 :catch /{pattern}/
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3948 : ...
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3949 : ... CATCH CLAUSE
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3950 : ...
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3951 :catch /{pattern}/
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3952 : ...
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3953 : ... CATCH CLAUSE
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3954 : ...
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3955 :finally
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3956 : ...
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3957 : ... FINALLY CLAUSE
82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	3958 : ...
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3959 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3960
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3961 The try conditional allows to watch code for exceptions and to take the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3962 appropriate actions. Exceptions from the try block may be caught. Exceptions
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3963 from the try block and also the catch clauses may cause cleanup actions.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3964 When no exception is thrown during execution of the try block, the control
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3965 is transferred to the finally clause, if present. After its execution, the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3966 script continues with the line following the ":endtry".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3967 When an exception occurs during execution of the try block, the remaining
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3968 lines in the try block are skipped. The exception is matched against the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3969 patterns specified as arguments to the ":catch" commands. The catch clause
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3970 after the first matching ":catch" is taken, other catch clauses are not
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3971 executed. The catch clause ends when the next ":catch", ":finally", or
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3972 ":endtry" command is reached - whatever is first. Then, the finally clause
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3973 (if present) is executed. When the ":endtry" is reached, the script execution
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3974 continues in the following line as usual.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3975 When an exception that does not match any of the patterns specified by the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3976 ":catch" commands is thrown in the try block, the exception is not caught by
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3977 that try conditional and none of the catch clauses is executed. Only the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3978 finally clause, if present, is taken. The exception pends during execution of
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3979 the finally clause. It is resumed at the ":endtry", so that commands after
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3980 the ":endtry" are not executed and the exception might be caught elsewhere,
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3981 see \|try-nesting\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3982 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	3983 remaining lines in that catch clause are not executed. The new exception is
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3984 not matched against the patterns in any of the ":catch" commands of the same
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3985 try conditional and none of its catch clauses is taken. If there is, however,
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3986 a finally clause, it is executed, and the exception pends during its
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3987 execution. The commands following the ":endtry" are not executed. The new
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3988 exception might, however, be caught elsewhere, see \|try-nesting\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3989 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	3990 thrown, the remaining lines in the finally clause are skipped. If the finally
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3991 clause has been taken because of an exception from the try block or one of the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3992 catch clauses, the original (pending) exception is discarded. The commands
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3993 following the ":endtry" are not executed, and the exception from the finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3994 clause is propagated and can be caught elsewhere, see \|try-nesting\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3995
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3996 The finally clause is also executed, when a ":break" or ":continue" for
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3997 a ":while" loop enclosing the complete try conditional is executed from the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3998 try block or a catch clause. Or when a ":return" or ":finish" is executed
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3999 from the try block or a catch clause of a try conditional in a function or
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4000 sourced script, respectively. The ":break", ":continue", ":return", or
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4001 ":finish" pends during execution of the finally clause and is resumed when the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4002 ":endtry" is reached. It is, however, discarded when an exception is thrown
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4003 from the finally clause.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4004 When a ":break" or ":continue" for a ":while" loop enclosing the complete
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4005 try conditional or when a ":return" or ":finish" is encountered in the finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4006 clause, the rest of the finally clause is skipped, and the ":break",
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4007 ":continue", ":return" or ":finish" is executed as usual. If the finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4008 clause has been taken because of an exception or an earlier ":break",
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4009 ":continue", ":return", or ":finish" from the try block or a catch clause,
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4010 this pending exception or command is discarded.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4011
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4012 For examples see \|throw-catch\| and \|try-finally\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4013
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4014
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4015 NESTING OF TRY CONDITIONALS try-nesting
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4016
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4017 Try conditionals can be nested arbitrarily. That is, a complete try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4018 conditional can be put into the try block, a catch clause, or the finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4019 clause of another try conditional. If the inner try conditional does not
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4020 catch an exception thrown in its try block or throws a new exception from one
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4021 of its catch clauses or its finally clause, the outer try conditional is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4022 checked according to the rules above. If the inner try conditional is in the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4023 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	4024 otherwise only the finally clause is executed. It does not matter for
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4025 nesting, whether the inner try conditional is directly contained in the outer
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4026 one, or whether the outer one sources a script or calls a function containing
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4027 the inner try conditional.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4028
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4029 When none of the active try conditionals catches an exception, just their
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4030 finally clauses are executed. Thereafter, the script processing terminates.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4031 An error message is displayed in case of an uncaught exception explicitly
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4032 thrown by a ":throw" command. For uncaught error and interrupt exceptions
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4033 implicitly raised by Vim, the error message(s) or interrupt message are shown
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4034 as usual.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4035
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4036 For examples see \|throw-catch\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4037
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4038
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4039 EXAMINING EXCEPTION HANDLING CODE except-examine
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4040
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4041 Exception handling code can get tricky. If you are in doubt what happens, set
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4042 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4043 script file. Then you see when an exception is thrown, discarded, caught, or
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4044 finished. When using a verbosity level of at least 14, things pending in
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4045 a finally clause are also shown. This information is also given in debug mode
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4046 (see \|debug-scripts\|).
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4047
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4048
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4049 THROWING AND CATCHING EXCEPTIONS throw-catch
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4050
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4051 You can throw any number or string as an exception. Use the \|:throw\| command
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4052 and pass the value to be thrown as argument: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4053 :throw 4711
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4054 :throw "string"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4055 < throw-expression
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4056 You can also specify an expression argument. The expression is then evaluated
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4057 first, and the result is thrown: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4058 :throw 4705 + strlen("string")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4059 :throw strpart("strings", 0, 6)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4060
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4061 An exception might be thrown during evaluation of the argument of the ":throw"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4062 command. Unless it is caught there, the expression evaluation is abandoned.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4063 The ":throw" command then does not throw a new exception.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4064 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4065
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4066 :function! Foo(arg)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4067 : try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4068 : throw a:arg
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4069 : catch /foo/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4070 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4071 : return 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4072 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4073 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4074 :function! Bar()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4075 : echo "in Bar"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4076 : return 4710
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4077 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4078 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4079 :throw Foo("arrgh") + Bar()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4080
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4081 This throws "arrgh", and "in Bar" is not displayed since Bar() is not
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4082 executed. >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4083 :throw Foo("foo") + Bar()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4084 however displays "in Bar" and throws 4711.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4085
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4086 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	4087 abandoned by an (uncaught) exception during the expression evaluation. The
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4088 exception is then propagated to the caller of the command.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4089 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4090
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4091 :if Foo("arrgh")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4092 : echo "then"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4093 :else
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4094 : echo "else"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4095 :endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4096
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4097 Here neither of "then" or "else" is displayed.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4098
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4099 catch-order
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4100 Exceptions can be caught by a try conditional with one or more \|:catch\|
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4101 commands, see \|try-conditionals\|. The values to be caught by each ":catch"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4102 command can be specified as a pattern argument. The subsequent catch clause
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4103 gets executed when a matching exception is caught.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4104 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4105
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4106 :function! Foo(value)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4107 : try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4108 : throw a:value
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4109 : catch /^\d\+$/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4110 : echo "Number thrown"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4111 : catch /.*/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4112 : echo "String thrown"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4113 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4114 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4115 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4116 :call Foo(0x1267)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4117 :call Foo('string')
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4118
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4119 The first call to Foo() displays "Number thrown", the second "String thrown".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4120 An exception is matched against the ":catch" commands in the order they are
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4121 specified. Only the first match counts. So you should place the more
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4122 specific ":catch" first. The following order does not make sense: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4123
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4124 : catch /.*/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4125 : echo "String thrown"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4126 : catch /^\d\+$/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4127 : echo "Number thrown"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4128
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4129 The first ":catch" here matches always, so that the second catch clause is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4130 never taken.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4131
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4132 throw-variables
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4133 If you catch an exception by a general pattern, you may access the exact value
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4134 in the variable \|v:exception\|: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4135
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4136 : catch /^\d\+$/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4137 : echo "Number thrown. Value is" v:exception
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4138
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4139 You may also be interested where an exception was thrown. This is stored in
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4140 \|v:throwpoint\|. Note that "v:exception" and "v:throwpoint" are valid for the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4141 exception most recently caught as long it is not finished.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4142 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4143
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4144 :function! Caught()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4145 : if v:exception != ""
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	4146 : echo 'Caught "' . v:exception .. '" in ' .. v:throwpoint
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4147 : else
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4148 : echo 'Nothing caught'
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4149 : endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4150 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4151 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4152 :function! Foo()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4153 : try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4154 : try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4155 : try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4156 : throw 4711
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4157 : finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4158 : call Caught()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4159 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4160 : catch /.*/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4161 : call Caught()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4162 : throw "oops"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4163 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4164 : catch /.*/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4165 : call Caught()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4166 : finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4167 : call Caught()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4168 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4169 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4170 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4171 :call Foo()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4172
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4173 This displays >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4174
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4175 Nothing caught
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4176 Caught "4711" in function Foo, line 4
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4177 Caught "oops" in function Foo, line 10
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4178 Nothing caught
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4179
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4180 A practical example: The following command ":LineNumber" displays the line
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4181 number in the script or function where it has been used: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4182
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4183 :function! LineNumber()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4184 : return substitute(v:throwpoint, '.\D$\d\+$.', '\1', "")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4185 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4186 :command! LineNumber try \| throw "" \| catch \| echo LineNumber() \| endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4187 <
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4188 try-nested
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4189 An exception that is not caught by a try conditional can be caught by
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4190 a surrounding try conditional: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4191
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4192 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4193 : try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4194 : throw "foo"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4195 : catch /foobar/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4196 : echo "foobar"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4197 : finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4198 : echo "inner finally"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4199 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4200 :catch /foo/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4201 : echo "foo"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4202 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4203
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4204 The inner try conditional does not catch the exception, just its finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4205 clause is executed. The exception is then caught by the outer try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4206 conditional. The example displays "inner finally" and then "foo".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4207
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4208 throw-from-catch
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4209 You can catch an exception and throw a new one to be caught elsewhere from the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4210 catch clause: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4211
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4212 :function! Foo()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4213 : throw "foo"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4214 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4215 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4216 :function! Bar()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4217 : try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4218 : call Foo()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4219 : catch /foo/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4220 : echo "Caught foo, throw bar"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4221 : throw "bar"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4222 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4223 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4224 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4225 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4226 : call Bar()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4227 :catch /.*/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4228 : echo "Caught" v:exception
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4229 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4230
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4231 This displays "Caught foo, throw bar" and then "Caught bar".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4232
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4233 rethrow
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4234 There is no real rethrow in the Vim script language, but you may throw
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4235 "v:exception" instead: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4236
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4237 :function! Bar()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4238 : try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4239 : call Foo()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4240 : catch /.*/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4241 : echo "Rethrow" v:exception
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4242 : throw v:exception
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4243 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4244 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4245 < try-echoerr
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4246 Note that this method cannot be used to "rethrow" Vim error or interrupt
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4247 exceptions, because it is not possible to fake Vim internal exceptions.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4248 Trying so causes an error exception. You should throw your own exception
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4249 denoting the situation. If you want to cause a Vim error exception containing
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4250 the original error exception value, you can use the \|:echoerr\| command: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4251
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4252 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4253 : try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4254 : asdf
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4255 : catch /.*/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4256 : echoerr v:exception
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4257 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4258 :catch /.*/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4259 : echo v:exception
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4260 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4261
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4262 This code displays
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4263
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	4264 Vim(echoerr):Vim:E492: Not an editor command: asdf ~
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4265
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4266
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4267 CLEANUP CODE try-finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4268
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4269 Scripts often change global settings and restore them at their end. If the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4270 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	4271 an inconsistent state. The same may happen to you in the development phase of
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4272 a script when an error occurs or you explicitly throw an exception without
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4273 catching it. You can solve these problems by using a try conditional with
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4274 a finally clause for restoring the settings. Its execution is guaranteed on
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4275 normal control flow, on error, on an explicit ":throw", and on interrupt.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4276 (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	4277 to exceptions. When not caught, they terminate the script after the finally
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4278 clause has been executed.)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4279 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4280
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4281 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4282 : let s:saved_ts = &ts
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4283 : set ts=17
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4284 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4285 : " Do the hard work here.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4286 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4287 :finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4288 : let &ts = s:saved_ts
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4289 : unlet s:saved_ts
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4290 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4291
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4292 This method should be used locally whenever a function or part of a script
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4293 changes global settings which need to be restored on failure or normal exit of
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4294 that function or script part.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4295
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4296 break-finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4297 Cleanup code works also when the try block or a catch clause is left by
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4298 a ":continue", ":break", ":return", or ":finish".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4299 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4300
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4301 :let first = 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4302 :while 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4303 : try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4304 : if first
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4305 : echo "first"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4306 : let first = 0
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4307 : continue
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4308 : else
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4309 : throw "second"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4310 : endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4311 : catch /.*/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4312 : echo v:exception
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4313 : break
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4314 : finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4315 : echo "cleanup"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4316 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4317 : echo "still in while"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4318 :endwhile
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4319 :echo "end"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4320
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4321 This displays "first", "cleanup", "second", "cleanup", and "end". >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4322
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4323 :function! Foo()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4324 : try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4325 : return 4711
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4326 : finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4327 : echo "cleanup\n"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4328 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4329 : echo "Foo still active"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4330 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4331 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4332 :echo Foo() "returned by Foo"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4333
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4334 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	4335 extra ":return" in the finally clause. (Above all, this would override the
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4336 return value.)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4337
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4338 except-from-finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4339 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4340 a finally clause is possible, but not recommended since it abandons the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4341 cleanup actions for the try conditional. But, of course, interrupt and error
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4342 exceptions might get raised from a finally clause.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4343 Example where an error in the finally clause stops an interrupt from
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4344 working correctly: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4345
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4346 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4347 : try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4348 : echo "Press CTRL-C for interrupt"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4349 : while 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4350 : endwhile
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4351 : finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4352 : unlet novar
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4353 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4354 :catch /novar/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4355 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4356 :echo "Script still running"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4357 :sleep 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4358
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4359 If you need to put commands that could fail into a finally clause, you should
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4360 think about catching or ignoring the errors in these commands, see
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4361 \|catch-errors\| and \|ignore-errors\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4362
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4363
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4364 CATCHING ERRORS catch-errors
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4365
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4366 If you want to catch specific errors, you just have to put the code to be
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4367 watched in a try block and add a catch clause for the error message. The
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4368 presence of the try conditional causes all errors to be converted to an
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4369 exception. No message is displayed and \|v:errmsg\| is not set then. To find
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4370 the right pattern for the ":catch" command, you have to know how the format of
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4371 the error exception is.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4372 Error exceptions have the following format: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4373
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4374 Vim({cmdname}):{errmsg}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4375 or >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4376 Vim:{errmsg}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4377
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4378 {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	4379 the command name is not known. {errmsg} is the error message usually produced
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4380 when the error occurs outside try conditionals. It always begins with
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4381 a capital "E", followed by a two or three-digit error number, a colon, and
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4382 a space.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4383
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4384 Examples:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4385
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4386 The command >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4387 :unlet novar
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4388 normally produces the error message >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4389 E108: No such variable: "novar"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4390 which is converted inside try conditionals to an exception >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4391 Vim(unlet):E108: No such variable: "novar"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4392
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4393 The command >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4394 :dwim
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4395 normally produces the error message >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4396 E492: Not an editor command: dwim
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4397 which is converted inside try conditionals to an exception >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4398 Vim:E492: Not an editor command: dwim
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4399
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4400 You can catch all ":unlet" errors by a >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4401 :catch /^Vim(unlet):/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4402 or all errors for misspelled command names by a >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4403 :catch /^Vim:E492:/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4404
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4405 Some error messages may be produced by different commands: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4406 :function nofunc
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4407 and >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4408 :delfunction nofunc
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4409 both produce the error message >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4410 E128: Function name must start with a capital: nofunc
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4411 which is converted inside try conditionals to an exception >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4412 Vim(function):E128: Function name must start with a capital: nofunc
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4413 or >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4414 Vim(delfunction):E128: Function name must start with a capital: nofunc
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4415 respectively. You can catch the error by its number independently on the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4416 command that caused it if you use the following pattern: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4417 :catch /^Vim(\a\+):E128:/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4418
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4419 Some commands like >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4420 :let x = novar
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4421 produce multiple error messages, here: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4422 E121: Undefined variable: novar
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4423 E15: Invalid expression: novar
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4424 Only the first is used for the exception value, since it is the most specific
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4425 one (see \|except-several-errors\|). So you can catch it by >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4426 :catch /^Vim(\a\+):E121:/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4427
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4428 You can catch all errors related to the name "nofunc" by >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4429 :catch /\<nofunc\>/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4430
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4431 You can catch all Vim errors in the ":write" and ":read" commands by >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4432 :catch /^Vim($write\\|read$):E\d\+:/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4433
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4434 You can catch all Vim errors by the pattern >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4435 :catch /^Vim$(\a\+)$\=:E\d\+:/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4436 <
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4437 catch-text
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4438 NOTE: You should never catch the error message text itself: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4439 :catch /No such variable/
6647 3af822eb4da5 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 6583 diff changeset	4440 only works in the English locale, but not when the user has selected
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4441 a different language by the \|:language\| command. It is however helpful to
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4442 cite the message text in a comment: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4443 :catch /^Vim(\a\+):E108:/ " No such variable
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4444
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4445
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4446 IGNORING ERRORS ignore-errors
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4447
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4448 You can ignore errors in a specific Vim command by catching them locally: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4449
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4450 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4451 : write
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4452 :catch
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4453 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4454
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4455 But you are strongly recommended NOT to use this simple form, since it could
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4456 catch more than you want. With the ":write" command, some autocommands could
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4457 be executed and cause errors not related to writing, for instance: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4458
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4459 :au BufWritePre * unlet novar
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4460
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4461 There could even be such errors you are not responsible for as a script
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4462 writer: a user of your script might have defined such autocommands. You would
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4463 then hide the error from the user.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4464 It is much better to use >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4465
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4466 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4467 : write
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4468 :catch /^Vim(write):/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4469 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4470
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4471 which only catches real write errors. So catch only what you'd like to ignore
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4472 intentionally.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4473
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4474 For a single command that does not cause execution of autocommands, you could
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4475 even suppress the conversion of errors to exceptions by the ":silent!"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4476 command: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4477 :silent! nunmap k
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4478 This works also when a try conditional is active.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4479
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4480
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4481 CATCHING INTERRUPTS catch-interrupt
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4482
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4483 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	4484 the exception "Vim:Interrupt". You can catch it like every exception. The
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4485 script is not terminated, then.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4486 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4487
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4488 :function! TASK1()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4489 : sleep 10
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4490 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4491
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4492 :function! TASK2()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4493 : sleep 20
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4494 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4495
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4496 :while 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4497 : let command = input("Type a command: ")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4498 : try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4499 : if command == ""
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4500 : continue
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4501 : elseif command == "END"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4502 : break
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4503 : elseif command == "TASK1"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4504 : call TASK1()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4505 : elseif command == "TASK2"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4506 : call TASK2()
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4507 : else
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4508 : echo "\nIllegal command:" command
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4509 : continue
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4510 : endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4511 : catch /^Vim:Interrupt$/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4512 : echo "\nCommand interrupted"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4513 : " Caught the interrupt. Continue with next prompt.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4514 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4515 :endwhile
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4516
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4517 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	4518 a new command. If you press CTRL-C at the prompt, the script is terminated.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4519
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4520 For testing what happens when CTRL-C would be pressed on a specific line in
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4521 your script, use the debug mode and execute the \|>quit\| or \|>interrupt\|
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4522 command on that line. See \|debug-scripts\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4523
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4524
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4525 CATCHING ALL catch-all
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4526
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4527 The commands >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4528
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4529 :catch /.*/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4530 :catch //
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4531 :catch
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4532
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4533 catch everything, error exceptions, interrupt exceptions and exceptions
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4534 explicitly thrown by the \|:throw\| command. This is useful at the top level of
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4535 a script in order to catch unexpected things.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4536 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4537
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4538 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4539 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4540 : " do the hard work here
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4541 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4542 :catch /MyException/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4543 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4544 : " handle known problem
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4545 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4546 :catch /^Vim:Interrupt$/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4547 : echo "Script interrupted"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4548 :catch /.*/
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	4549 : echo "Internal error (" .. v:exception .. ")"
d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	4550 : echo " - occurred at " .. v:throwpoint
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4551 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4552 :" end of script
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4553
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4554 Note: Catching all might catch more things than you want. Thus, you are
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4555 strongly encouraged to catch only for problems that you can really handle by
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4556 specifying a pattern argument to the ":catch".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4557 Example: Catching all could make it nearly impossible to interrupt a script
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4558 by pressing CTRL-C: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4559
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4560 :while 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4561 : try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4562 : sleep 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4563 : catch
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4564 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4565 :endwhile
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4566
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4567
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4568 EXCEPTIONS AND AUTOCOMMANDS except-autocmd
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4569
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4570 Exceptions may be used during execution of autocommands. Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4571
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4572 :autocmd User x try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4573 :autocmd User x throw "Oops!"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4574 :autocmd User x catch
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4575 :autocmd User x echo v:exception
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4576 :autocmd User x endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4577 :autocmd User x throw "Arrgh!"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4578 :autocmd User x echo "Should not be displayed"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4579 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4580 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4581 : doautocmd User x
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4582 :catch
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4583 : echo v:exception
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4584 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4585
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4586 This displays "Oops!" and "Arrgh!".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4587
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4588 except-autocmd-Pre
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4589 For some commands, autocommands get executed before the main action of the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4590 command takes place. If an exception is thrown and not caught in the sequence
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4591 of autocommands, the sequence and the command that caused its execution are
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4592 abandoned and the exception is propagated to the caller of the command.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4593 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4594
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4595 :autocmd BufWritePre * throw "FAIL"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4596 :autocmd BufWritePre * echo "Should not be displayed"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4597 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4598 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4599 : write
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4600 :catch
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4601 : echo "Caught:" v:exception "from" v:throwpoint
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4602 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4603
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4604 Here, the ":write" command does not write the file currently being edited (as
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4605 you can see by checking 'modified'), since the exception from the BufWritePre
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4606 autocommand abandons the ":write". The exception is then caught and the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4607 script displays: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4608
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4609 Caught: FAIL from BufWrite Auto commands for "*"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4610 <
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4611 except-autocmd-Post
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4612 For some commands, autocommands get executed after the main action of the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4613 command has taken place. If this main action fails and the command is inside
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4614 an active try conditional, the autocommands are skipped and an error exception
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4615 is thrown that can be caught by the caller of the command.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4616 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4617
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4618 :autocmd BufWritePost * echo "File successfully written!"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4619 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4620 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4621 : write /i/m/p/o/s/s/i/b/l/e
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4622 :catch
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4623 : echo v:exception
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4624 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4625
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4626 This just displays: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4627
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4628 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4629
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4630 If you really need to execute the autocommands even when the main action
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4631 fails, trigger the event from the catch clause.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4632 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4633
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4634 :autocmd BufWritePre * set noreadonly
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4635 :autocmd BufWritePost * set readonly
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4636 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4637 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4638 : write /i/m/p/o/s/s/i/b/l/e
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4639 :catch
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4640 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4641 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4642 <
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4643 You can also use ":silent!": >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4644
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4645 :let x = "ok"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4646 :let v:errmsg = ""
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4647 :autocmd BufWritePost * if v:errmsg != ""
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4648 :autocmd BufWritePost * let x = "after fail"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4649 :autocmd BufWritePost * endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4650 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4651 : silent! write /i/m/p/o/s/s/i/b/l/e
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4652 :catch
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4653 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4654 :echo x
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4655
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4656 This displays "after fail".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4657
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4658 If the main action of the command does not fail, exceptions from the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4659 autocommands will be catchable by the caller of the command: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4660
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4661 :autocmd BufWritePost * throw ":-("
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4662 :autocmd BufWritePost * echo "Should not be displayed"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4663 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4664 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4665 : write
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4666 :catch
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4667 : echo v:exception
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4668 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4669 <
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4670 except-autocmd-Cmd
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4671 For some commands, the normal action can be replaced by a sequence of
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4672 autocommands. Exceptions from that sequence will be catchable by the caller
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4673 of the command.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4674 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	4675 had actually been written when the exception occurred. You need to tell it in
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4676 some way. >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4677
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4678 :if !exists("cnt")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4679 : let cnt = 0
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4680 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4681 : autocmd BufWriteCmd * if &modified
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4682 : autocmd BufWriteCmd * let cnt = cnt + 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4683 : autocmd BufWriteCmd * if cnt % 3 == 2
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4684 : autocmd BufWriteCmd * throw "BufWriteCmdError"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4685 : autocmd BufWriteCmd * endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4686 : autocmd BufWriteCmd * write \| set nomodified
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4687 : autocmd BufWriteCmd * if cnt % 3 == 0
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4688 : autocmd BufWriteCmd * throw "BufWriteCmdError"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4689 : autocmd BufWriteCmd * endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4690 : autocmd BufWriteCmd * echo "File successfully written!"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4691 : autocmd BufWriteCmd * endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4692 :endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4693 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4694 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4695 : write
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4696 :catch /^BufWriteCmdError$/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4697 : if &modified
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4698 : echo "Error on writing (file contents not changed)"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4699 : else
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4700 : echo "Error after writing"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4701 : endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4702 :catch /^Vim(write):/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4703 : echo "Error on writing"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4704 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4705
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4706 When this script is sourced several times after making changes, it displays
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4707 first >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4708 File successfully written!
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4709 then >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4710 Error on writing (file contents not changed)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4711 then >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4712 Error after writing
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4713 etc.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4714
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4715 except-autocmd-ill
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4716 You cannot spread a try conditional over autocommands for different events.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4717 The following code is ill-formed: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4718
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4719 :autocmd BufWritePre * try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4720 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4721 :autocmd BufWritePost * catch
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4722 :autocmd BufWritePost * echo v:exception
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4723 :autocmd BufWritePost * endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4724 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4725 :write
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4726
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4727
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4728 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS except-hier-param
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4729
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4730 Some programming languages allow to use hierarchies of exception classes or to
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4731 pass additional information with the object of an exception class. You can do
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4732 similar things in Vim.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4733 In order to throw an exception from a hierarchy, just throw the complete
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4734 class name with the components separated by a colon, for instance throw the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4735 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4736 When you want to pass additional information with your exception class, add
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4737 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4738 for an error when writing "myfile".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4739 With the appropriate patterns in the ":catch" command, you can catch for
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4740 base classes or derived classes of your hierarchy. Additional information in
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4741 parentheses can be cut out from \|v:exception\| with the ":substitute" command.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4742 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4743
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4744 :function! CheckRange(a, func)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4745 : if a:a < 0
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	4746 : throw "EXCEPT:MATHERR:RANGE(" .. a:func .. ")"
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4747 : endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4748 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4749 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4750 :function! Add(a, b)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4751 : call CheckRange(a:a, "Add")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4752 : call CheckRange(a:b, "Add")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4753 : let c = a:a + a:b
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4754 : if c < 0
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4755 : throw "EXCEPT:MATHERR:OVERFLOW"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4756 : endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4757 : return c
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4758 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4759 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4760 :function! Div(a, b)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4761 : call CheckRange(a:a, "Div")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4762 : call CheckRange(a:b, "Div")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4763 : if (a:b == 0)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4764 : throw "EXCEPT:MATHERR:ZERODIV"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4765 : endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4766 : return a:a / a:b
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4767 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4768 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4769 :function! Write(file)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4770 : try
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	4771 : execute "write" fnameescape(a:file)
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4772 : catch /^Vim(write):/
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	4773 : throw "EXCEPT:IO(" .. getcwd() .. ", " .. a:file .. "):WRITEERR"
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4774 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4775 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4776 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4777 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4778 :
28517 f73a9bdff3a3 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 28491 diff changeset	4779 : " something with arithmetic and I/O
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4780 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4781 :catch /^EXCEPT:MATHERR:RANGE/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4782 : let function = substitute(v:exception, '.($\a\+$).', '\1', "")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4783 : echo "Range error in" function
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4784 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4785 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4786 : echo "Math error"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4787 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4788 :catch /^EXCEPT:IO/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4789 : let dir = substitute(v:exception, '.($.\+$,\s.\+).*', '\1', "")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4790 : let file = substitute(v:exception, '.(.\+,\s$.\+$).*', '\1', "")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4791 : if file !~ '^/'
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	4792 : let file = dir .. "/" .. file
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4793 : endif
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	4794 : echo 'I/O error for "' .. file .. '"'
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4795 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4796 :catch /^EXCEPT/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4797 : echo "Unspecified error"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4798 :
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4799 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4800
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4801 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4802 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4803 exceptions with the "Vim" prefix; they are reserved for Vim.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4804 Vim error exceptions are parameterized with the name of the command that
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4805 failed, if known. See \|catch-errors\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4806
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4807
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4808 PECULIARITIES
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4809 except-compat
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4810 The exception handling concept requires that the command sequence causing the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4811 exception is aborted immediately and control is transferred to finally clauses
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4812 and/or a catch clause.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4813
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4814 In the Vim script language there are cases where scripts and functions
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4815 continue after an error: in functions without the "abort" flag or in a command
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4816 after ":silent!", control flow goes to the following line, and outside
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4817 functions, control flow goes to the line following the outermost ":endwhile"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4818 or ":endif". On the other hand, errors should be catchable as exceptions
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4819 (thus, requiring the immediate abortion).
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4820
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4821 This problem has been solved by converting errors to exceptions and using
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4822 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	4823 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	4824 be caught only from an active try conditional. If you want an immediate
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4825 termination without catching the error, just use a try conditional without
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4826 catch clause. (You can cause cleanup code being executed before termination
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4827 by specifying a finally clause.)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4828
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4829 When no try conditional is active, the usual abortion and continuation
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4830 behavior is used instead of immediate abortion. This ensures compatibility of
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4831 scripts written for Vim 6.1 and earlier.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4832
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4833 However, when sourcing an existing script that does not use exception handling
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4834 commands (or when calling one of its functions) from inside an active try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4835 conditional of a new script, you might change the control flow of the existing
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4836 script on error. You get the immediate abortion on error and can catch the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4837 error in the new script. If however the sourced script suppresses error
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4838 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	4839 \|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	4840 not converted to an exception. (See \|:silent\|.) So the only remaining cause
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4841 where this happens is for scripts that don't care about errors and produce
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4842 error messages. You probably won't want to use such code from your new
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4843 scripts.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4844
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4845 except-syntax-err
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4846 Syntax errors in the exception handling commands are never caught by any of
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4847 the ":catch" commands of the try conditional they belong to. Its finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4848 clauses, however, is executed.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4849 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4850
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4851 :try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4852 : try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4853 : throw 4711
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4854 : catch /\(/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4855 : echo "in catch with syntax error"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4856 : catch
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4857 : echo "inner catch-all"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4858 : finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4859 : echo "inner finally"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4860 : endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4861 :catch
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	4862 : echo 'outer catch-all caught "' .. v:exception .. '"'
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4863 : finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4864 : echo "outer finally"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4865 :endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4866
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4867 This displays: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4868 inner finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4869 outer catch-all caught "Vim(catch):E54: Unmatched \("
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4870 outer finally
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4871 The original exception is discarded and an error exception is raised, instead.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4872
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4873 except-single-line
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4874 The ":try", ":catch", ":finally", and ":endtry" commands can be put on
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4875 a single line, but then syntax errors may make it difficult to recognize the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4876 "catch" line, thus you better avoid this.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4877 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4878 :try \| unlet! foo # \| catch \| endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4879 raises an error exception for the trailing characters after the ":unlet!"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4880 argument, but does not see the ":catch" and ":endtry" commands, so that the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4881 error exception is discarded and the "E488: Trailing characters" message gets
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4882 displayed.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4883
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4884 except-several-errors
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4885 When several errors appear in a single command, the first error message is
25402 bdda48f01a68 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 25398 diff changeset	4886 usually the most specific one and therefore converted to the error exception.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4887 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4888 echo novar
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4889 causes >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4890 E121: Undefined variable: novar
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4891 E15: Invalid expression: novar
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4892 The value of the error exception inside try conditionals is: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4893 Vim(echo):E121: Undefined variable: novar
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4894 < except-syntax-error
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4895 But when a syntax error is detected after a normal error in the same command,
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4896 the syntax error is used for the exception being thrown.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4897 Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4898 unlet novar #
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4899 causes >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4900 E108: No such variable: "novar"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4901 E488: Trailing characters
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4902 The value of the error exception inside try conditionals is: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4903 Vim(unlet):E488: Trailing characters
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4904 This is done because the syntax error might change the execution path in a way
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4905 not intended by the user. Example: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4906 try
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4907 try \| unlet novar # \| catch \| echo v:exception \| endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4908 catch /.*/
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4909 echo "outer catch:" v:exception
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4910 endtry
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4911 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4912 a "E600: Missing :endtry" error message is given, see \|except-single-line\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4913
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4914 ==============================================================================
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4915 9. Examples eval-examples
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4916
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4917 Printing in Binary ~
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4918 >
2033 de5a43c5eedc Update documentation files. Bram Moolenaar <bram@zimbu.org> parents: 1998 diff changeset	4919 :" The function Nr2Bin() returns the binary string representation of a number.
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4920 :func Nr2Bin(nr)
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4921 : let n = a:nr
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4922 : let r = ""
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4923 : while n
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	4924 : let r = '01'[n % 2] .. r
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4925 : let n = n / 2
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4926 : endwhile
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4927 : return r
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4928 :endfunc
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4929
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4930 :" The function String2Bin() converts each character in a string to a
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4931 :" binary string, separated with dashes.
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4932 :func String2Bin(str)
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4933 : let out = ''
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4934 : for ix in range(strlen(a:str))
27903 d19b7aee1925 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27804 diff changeset	4935 : let out = out .. '-' .. Nr2Bin(char2nr(a:str[ix]))
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4936 : endfor
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4937 : return out[1:]
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4938 :endfunc
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4939
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4940 Example of its use: >
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4941 :echo Nr2Bin(32)
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4942 result: "100000" >
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4943 :echo String2Bin("32")
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4944 result: "110011-110010"
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4945
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4946
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4947 Sorting lines ~
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4948
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4949 This example sorts lines with a specific compare function. >
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4950
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4951 :func SortBuffer()
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4952 : let lines = getline(1, '$')
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4953 : call sort(lines, function("Strcmp"))
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4954 : call setline(1, lines)
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4955 :endfunction
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4956
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4957 As a one-liner: >
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4958 :call setline(1, sort(getline(1, '$'), function("Strcmp")))
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4959
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4960
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4961 scanf() replacement ~
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4962 sscanf
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4963 There is no sscanf() function in Vim. If you need to extract parts from a
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4964 line, you can use matchstr() and substitute() to do it. This example shows
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4965 how to get the file name, line number and column number out of a line like
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4966 "foobar.txt, 123, 45". >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4967 :" Set up the match bit
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4968 :let mx='$\f\+$,\s$\d\+$,\s$\d\+$'
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4969 :"get the part matching the whole expression
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4970 :let l = matchstr(line, mx)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4971 :"get each item out of the match
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4972 :let file = substitute(l, mx, '\1', '')
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4973 :let lnum = substitute(l, mx, '\2', '')
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4974 :let col = substitute(l, mx, '\3', '')
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4975
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4976 The input is in the variable "line", the results in the variables "file",
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4977 "lnum" and "col". (idea from Michael Geddes)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4978
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4979
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4980 getting the scriptnames in a Dictionary ~
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4981 scriptnames-dictionary
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4982 The \|:scriptnames\| command can be used to get a list of all script files that
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4983 have been sourced. There is no equivalent function or variable for this
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4984 (because it's rarely needed). In case you need to manipulate the list this
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4985 code can be used: >
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4986 " Get the output of ":scriptnames" in the scriptnames_output variable.
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4987 let scriptnames_output = ''
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4988 redir => scriptnames_output
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4989 silent scriptnames
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4990 redir END
12785 65d7fd8381a3 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 12756 diff changeset	4991
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	4992 " Split the output into lines and parse each line. Add an entry to the
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4993 " "scripts" dictionary.
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4994 let scripts = {}
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4995 for line in split(scriptnames_output, "\n")
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4996 " Only do non-blank lines.
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4997 if line =~ '\S'
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	4998 " Get the first number in the line.
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	4999 let nr = matchstr(line, '\d\+')
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	5000 " Get the file name, remove the script number " 123: ".
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	5001 let name = substitute(line, '.\+:\s*', '', '')
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	5002 " Add an item to the Dictionary
1621 82b5078be2dd updated for version 7.2a vimboss parents: 1609 diff changeset	5003 let scripts[nr] = name
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	5004 endif
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	5005 endfor
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	5006 unlet scriptnames_output
9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	5007
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5008 ==============================================================================
16223 abb67309c1ca patch 8.1.1116: cannot enforce a Vim script style Bram Moolenaar <Bram@vim.org> parents: 16219 diff changeset	5009 10. Vim script versions vimscript-version vimscript-versions
16380 5ad204d8a2f2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 16366 diff changeset	5010 scriptversion
16223 abb67309c1ca patch 8.1.1116: cannot enforce a Vim script style Bram Moolenaar <Bram@vim.org> parents: 16219 diff changeset	5011 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	5012 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	5013 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	5014
abb67309c1ca patch 8.1.1116: cannot enforce a Vim script style Bram Moolenaar <Bram@vim.org> parents: 16219 diff changeset	5015 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	5016 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	5017 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	5018 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	5019 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	5020
27537 063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	5021 When using a legacy function, defined with `:function`, in \|Vim9\| script then
063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	5022 scriptversion 4 is used.
063952f68595 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 27459 diff changeset	5023
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 17020 diff changeset	5024 scriptversion-1 >
16223 abb67309c1ca patch 8.1.1116: cannot enforce a Vim script style Bram Moolenaar <Bram@vim.org> parents: 16219 diff changeset	5025 :scriptversion 1
abb67309c1ca patch 8.1.1116: cannot enforce a Vim script style Bram Moolenaar <Bram@vim.org> parents: 16219 diff changeset	5026 < 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	5027 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	5028 Test for support with: >
abb67309c1ca patch 8.1.1116: cannot enforce a Vim script style Bram Moolenaar <Bram@vim.org> parents: 16219 diff changeset	5029 has('vimscript-1')
abb67309c1ca patch 8.1.1116: cannot enforce a Vim script style Bram Moolenaar <Bram@vim.org> parents: 16219 diff changeset	5030
17026 905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 17020 diff changeset	5031 < scriptversion-2 >
16223 abb67309c1ca patch 8.1.1116: cannot enforce a Vim script style Bram Moolenaar <Bram@vim.org> parents: 16219 diff changeset	5032 :scriptversion 2
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16704 diff changeset	5033 < 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	5034 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	5035 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	5036
905e1b154058 patch 8.1.1513: all popup functionality is in functions, except :popupclear Bram Moolenaar <Bram@vim.org> parents: 17020 diff changeset	5037 scriptversion-3 >
16380 5ad204d8a2f2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 16366 diff changeset	5038 :scriptversion 3
5ad204d8a2f2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 16366 diff changeset	5039 < All \|vim-variable\|s must be prefixed by "v:". E.g. "version" doesn't
5ad204d8a2f2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 16366 diff changeset	5040 work as \|v:version\| anymore, it can be used as a normal variable.
5ad204d8a2f2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 16366 diff changeset	5041 Same for some obvious names as "count" and others.
5ad204d8a2f2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 16366 diff changeset	5042
16223 abb67309c1ca patch 8.1.1116: cannot enforce a Vim script style Bram Moolenaar <Bram@vim.org> parents: 16219 diff changeset	5043 Test for support with: >
16380 5ad204d8a2f2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 16366 diff changeset	5044 has('vimscript-3')
18080 a6d218f99ff7 patch 8.1.2035: recognizing octal numbers is confusing Bram Moolenaar <Bram@vim.org> parents: 18053 diff changeset	5045 <
a6d218f99ff7 patch 8.1.2035: recognizing octal numbers is confusing Bram Moolenaar <Bram@vim.org> parents: 18053 diff changeset	5046 scriptversion-4 >
a6d218f99ff7 patch 8.1.2035: recognizing octal numbers is confusing Bram Moolenaar <Bram@vim.org> parents: 18053 diff changeset	5047 :scriptversion 4
20665 6ff992bf4c82 patch 8.2.0886: cannot use octal numbers in scriptversion 4 Bram Moolenaar <Bram@vim.org> parents: 20649 diff changeset	5048 < 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	5049 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	5050 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	5051 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	5052 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	5053 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	5054 < 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	5055 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	5056 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	5057 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	5058 < 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	5059 easier to read: >
a6d218f99ff7 patch 8.1.2035: recognizing octal numbers is confusing Bram Moolenaar <Bram@vim.org> parents: 18053 diff changeset	5060 echo 1'000'000
a6d218f99ff7 patch 8.1.2035: recognizing octal numbers is confusing Bram Moolenaar <Bram@vim.org> parents: 18053 diff changeset	5061 < 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	5062
a6d218f99ff7 patch 8.1.2035: recognizing octal numbers is confusing Bram Moolenaar <Bram@vim.org> parents: 18053 diff changeset	5063 Test for support with: >
a6d218f99ff7 patch 8.1.2035: recognizing octal numbers is confusing Bram Moolenaar <Bram@vim.org> parents: 18053 diff changeset	5064 has('vimscript-4')
16223 abb67309c1ca patch 8.1.1116: cannot enforce a Vim script style Bram Moolenaar <Bram@vim.org> parents: 16219 diff changeset	5065
abb67309c1ca patch 8.1.1116: cannot enforce a Vim script style Bram Moolenaar <Bram@vim.org> parents: 16219 diff changeset	5066 ==============================================================================
abb67309c1ca patch 8.1.1116: cannot enforce a Vim script style Bram Moolenaar <Bram@vim.org> parents: 16219 diff changeset	5067 11. No +eval feature no-eval-feature
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5068
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5069 When the \|+eval\| feature was disabled at compile time, none of the expression
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5070 evaluation commands are available. To prevent this from causing Vim scripts
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5071 to generate all kinds of errors, the ":if" and ":endif" commands are still
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5072 recognized, though the argument of the ":if" and everything between the ":if"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5073 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5074 only if the commands are at the start of the line. The ":else" command is not
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5075 recognized.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5076
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5077 Example of how to avoid executing commands when the \|+eval\| feature is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5078 missing: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5079
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5080 :if 1
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5081 : echo "Expression evaluation is compiled in"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5082 :else
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5083 : echo "You will _never_ see this message"
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5084 :endif
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5085
16971 e18b1c654d09 Update runtime files - Add typescript syntax and indent. Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	5086 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	5087 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	5088 if 1
e18b1c654d09 Update runtime files - Add typescript syntax and indent. Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	5089 echo "commands executed with +eval"
e18b1c654d09 Update runtime files - Add typescript syntax and indent. Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	5090 finish
e18b1c654d09 Update runtime files - Add typescript syntax and indent. Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	5091 endif
e18b1c654d09 Update runtime files - Add typescript syntax and indent. Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	5092 args " command executed without +eval
e18b1c654d09 Update runtime files - Add typescript syntax and indent. Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	5093
e18b1c654d09 Update runtime files - Add typescript syntax and indent. Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	5094 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	5095 example shows: >
11414 c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented Christian Brabandt <cb@256bit.org> parents: 11407 diff changeset	5096
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented Christian Brabandt <cb@256bit.org> parents: 11407 diff changeset	5097 silent! while 0
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented Christian Brabandt <cb@256bit.org> parents: 11407 diff changeset	5098 set history=111
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented Christian Brabandt <cb@256bit.org> parents: 11407 diff changeset	5099 silent! endwhile
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented Christian Brabandt <cb@256bit.org> parents: 11407 diff changeset	5100
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented Christian Brabandt <cb@256bit.org> parents: 11407 diff changeset	5101 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	5102 "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	5103 silently ignored, and the command is executed.
11347 4aae8146c21f Update runtime files. Christian Brabandt <cb@256bit.org> parents: 11313 diff changeset	5104
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5105 ==============================================================================
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26881 diff changeset	5106 12. The sandbox eval-sandbox sandbox
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5107
2350 06feaf4fe36a Rename some "python3" symbols to "py3", as the command name. Bram Moolenaar <bram@vim.org> parents: 2345 diff changeset	5108 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	5109 '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	5110 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	5111 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	5112 the command from a tags file is executed and for CTRL-R = in the command line.
29 ac33b7c03fac updated for version 7.0018 vimboss parents: 26 diff changeset	5113 The sandbox is also used for the \|:sandbox\| command.
27036 3e661b0cf500 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 26881 diff changeset	5114 E48
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5115 These items are not allowed in the sandbox:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5116 - changing the buffer text
14347 723487cd7876 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14343 diff changeset	5117 - defining or changing mapping, autocommands, user commands
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5118 - setting certain options (see \|option-summary\|)
1156 9cec4e0b792a updated for version 7.1a vimboss parents: 1104 diff changeset	5119 - setting certain v: variables (see \|v:var\|) E794
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5120 - executing a shell command
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5121 - reading or writing a file
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5122 - jumping to another buffer or editing a file
625 81fe2ccc1207 updated for version 7.0179 vimboss parents: 620 diff changeset	5123 - executing Python, Perl, etc. commands
29 ac33b7c03fac updated for version 7.0018 vimboss parents: 26 diff changeset	5124 This is not guaranteed 100% secure, but it should block most attacks.
ac33b7c03fac updated for version 7.0018 vimboss parents: 26 diff changeset	5125
ac33b7c03fac updated for version 7.0018 vimboss parents: 26 diff changeset	5126 :san :sandbox
401 4a1ead01d30b updated for version 7.0105 vimboss parents: 395 diff changeset	5127 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an
29 ac33b7c03fac updated for version 7.0018 vimboss parents: 26 diff changeset	5128 option that may have been set from a modeline, e.g.
ac33b7c03fac updated for version 7.0018 vimboss parents: 26 diff changeset	5129 'foldexpr'.
ac33b7c03fac updated for version 7.0018 vimboss parents: 26 diff changeset	5130
634 1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5131 sandbox-option
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5132 A few options contain an expression. When this expression is evaluated it may
790 c8680debe1cc updated for version 7.0230 vimboss parents: 786 diff changeset	5133 have to be done in the sandbox to avoid a security risk. But the sandbox is
634 1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5134 restrictive, thus this only happens when the option was set from an insecure
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5135 location. Insecure in this context are:
843 9f279ebda751 updated for version 7.0f01 vimboss parents: 842 diff changeset	5136 - sourcing a .vimrc or .exrc in the current directory
634 1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5137 - while executing in the sandbox
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5138 - value coming from a modeline
14347 723487cd7876 Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14343 diff changeset	5139 - executing a function that was defined in the sandbox
634 1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5140
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5141 Note that when in the sandbox and saving an option value and restoring it, the
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5142 option will still be marked as it was set in the sandbox.
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5143
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5144 ==============================================================================
16223 abb67309c1ca patch 8.1.1116: cannot enforce a Vim script style Bram Moolenaar <Bram@vim.org> parents: 16219 diff changeset	5145 13. Textlock textlock
634 1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5146
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5147 In a few situations it is not allowed to change the text in the buffer, jump
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5148 to another window and some other things that might confuse or break what Vim
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5149 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	5150 actually doing something else. For example, evaluating the 'balloonexpr' may
634 1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5151 happen any moment the mouse cursor is resting at some position.
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5152
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5153 This is not allowed when the textlock is active:
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5154 - changing the buffer text
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5155 - jumping to another buffer or window
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5156 - editing another file
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5157 - closing a window or quitting Vim
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5158 - etc.
1c586ee8dd45 updated for version 7.0183 vimboss parents: 626 diff changeset	5159
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5160
14421 2f7e67dd088c Update runtime files. Christian Brabandt <cb@256bit.org> parents: 14407 diff changeset	5161 vim:tw=78:ts=8:noet:ft=help:norl:

Mercurial > vim

annotate runtime/doc/eval.txt @ 29704:5b3a88601317 v9.0.0192