Mercurial > vim

annotate runtime/doc/eval.txt @ 15512:f0f06837a699

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update runtime files. commit https://github.com/vim/vim/commit/d09091d4955c5f41de69928f2db85611ed54ed23 Author: Bram Moolenaar <Bram@vim.org> Date: Thu Jan 17 16:07:22 2019 +0100 Update runtime files.
author Bram Moolenaar <Bram@vim.org>
date Thu, 17 Jan 2019 16:15:08 +0100
parents e1de20a47fa9
children 4af72c724093
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
1 *eval.txt* For Vim version 8.1. Last change: 2019 Jan 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*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8
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
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
15 1. Variables |variables|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
16 1.1 Variable types
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
17 1.2 Function references |Funcref|
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
18 1.3 Lists |Lists|
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
19 1.4 Dictionaries |Dictionaries|
15498
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
20 1.5 Blobs |Blobs|
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
21 1.6 More about variables |more-variables|
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
22 2. Expression syntax |expression-syntax|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
23 3. Internal variable |internal-variables|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
24 4. Builtin Functions |functions|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
25 5. Defining functions |user-functions|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
26 6. Curly braces names |curly-braces-names|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
27 7. Commands |expression-commands|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
28 8. Exception handling |exception-handling|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
29 9. Examples |eval-examples|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
30 10. No +eval feature |no-eval-feature|
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
31 11. The sandbox |eval-sandbox|
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
32 12. Textlock |textlock|
9887
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
33 13. Testing |testing|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 {Vi does not have any of these commands}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 1. Variables *variables*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
40 1.1 Variable types ~
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
41 *E712*
8061
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 8031
diff changeset
42 There are nine types of variables:
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
43
3082
3502a7f991fc Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2965
diff changeset
44 Number A 32 or 64 bit signed number. |expr-number| *Number*
9686
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
45 64-bit Numbers are available only when compiled with the
9389
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
46 |+num64| feature.
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
47 Examples: -123 0x10 0177 0b1011
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
48
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
49 Float A floating point number. |floating-point-format| *Float*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
50 {only when compiled with the |+float| feature}
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
51 Examples: 123.456 1.15e-6 -1.1e3
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
52
9041
34c45ee4210d commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents: 8951
diff changeset
53 *E928*
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
54 String A NUL terminated string of 8-bit unsigned characters (bytes).
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
55 |expr-string| Examples: "ab\txx\"--" 'x-z''a,c'
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
56
15498
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
57 List An ordered sequence of items, see |List| for details.
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
58 Example: [1, 2, ['a', 'b']]
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
59
370
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
60 Dictionary An associative, unordered array: Each entry has a key and a
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
61 value. |Dictionary|
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
62 Example: {'blue': "#0000ff", 'red': "#ff0000"}
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
63
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
64 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
65 Example: function("strlen")
9104
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
66 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
67 like a Partial.
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
68 Example: function("Callback", [arg], myDict)
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
69
8178
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
70 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
71
8881
ed0b39dd7fd6 commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents: 8876
diff changeset
72 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
73
ed0b39dd7fd6 commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents: 8876
diff changeset
74 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
75
15498
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
76 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
77 for details
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
78 Example: 0zFF00ED015DAF
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
79 0z is an empty Blob.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
80
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
81 The Number and String types are converted automatically, depending on how they
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
82 are used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84 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
85 the Number. Examples:
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
86 Number 123 --> String "123" ~
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
87 Number 0 --> String "0" ~
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
88 Number -1 --> String "-1" ~
2152
b9e314fe473f Updated runtime files.
Bram Moolenaar <bram@zimbu.org>
parents: 2120
diff changeset
89 *octal*
7477
05cf4cc72a9f commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
90 Conversion from a String to a Number is done by converting the first digits to
05cf4cc72a9f commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
91 a number. Hexadecimal "0xf9", Octal "017", and Binary "0b10" numbers are
05cf4cc72a9f commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
92 recognized. If the String doesn't start with digits, the result is zero.
05cf4cc72a9f commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
93 Examples:
2581
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
94 String "456" --> Number 456 ~
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
95 String "6bar" --> Number 6 ~
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
96 String "foo" --> Number 0 ~
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
97 String "0xf1" --> Number 241 ~
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
98 String "0100" --> Number 64 ~
7477
05cf4cc72a9f commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
99 String "0b101" --> Number 5 ~
2581
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
100 String "-8" --> Number -8 ~
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
101 String "+8" --> Number 0 ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
102
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
103 To force conversion from String to Number, add zero to it: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104 :echo "0100" + 0
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
105 < 64 ~
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
106
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
107 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
108 base, use |str2nr()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
109
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
110 *TRUE* *FALSE* *Boolean*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
111 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE.
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
112 You can also use |v:false| and |v:true|. When TRUE is returned from a
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
113 function it is the Number one, FALSE is the number zero.
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
114
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
115 Note that in the command: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
116 :if "foo"
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
117 :" NOT executed
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
118 "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
119 non-zero number it means TRUE: >
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
120 :if "8foo"
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
121 :" executed
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
122 To test for a non-empty string, use empty(): >
3893
c3036f1dca68 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3875
diff changeset
123 :if !empty("foo")
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
124 <
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
125 *non-zero-arg*
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
126 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
127 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
128 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
129 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
130 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
131
8061
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 8031
diff changeset
132 *E745* *E728* *E703* *E729* *E730* *E731* *E908* *E910* *E913*
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
133 *E974* *E975* *E976*
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
134 |List|, |Dictionary|, |Funcref|, |Job|, |Channel| and |Blob| types are not
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
135 automatically converted.
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
136
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
137 *E805* *E806* *E808*
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
138 When mixing Number and Float the Number is converted to Float. Otherwise
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
139 there is no automatic conversion of Float. You can use str2float() for String
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
140 to Float, printf() for Float to String and float2nr() for Float to Number.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
141
8061
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 8031
diff changeset
142 *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
143 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
144
8512
5104f96b6ecf commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents: 8502
diff changeset
145 *no-type-checking*
5104f96b6ecf commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents: 8502
diff changeset
146 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
147
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
148
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
149 1.2 Function references ~
153
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
150 *Funcref* *E695* *E718*
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
151 A Funcref variable is obtained with the |function()| function, the |funcref()|
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
152 function or created with the lambda expression |expr-lambda|. It can be used
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
153 in an expression in the place of a function name, before the parenthesis
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
154 around the arguments, to invoke the function it refers to. Example: >
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
155
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
156 :let Fn = function("MyFunc")
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
157 :echo Fn()
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
158 < *E704* *E705* *E707*
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
159 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
160 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
161 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
162
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
163 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
164 Dictionary entry. Example: >
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
165 :function dict.init() dict
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
166 : let self.val = 0
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
167 :endfunction
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
168
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
169 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
170 function name is not used here. Also see |numbered-function|.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
171
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
172 A Funcref can also be used with the |:call| command: >
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
173 :call Fn()
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
174 :call dict.init()
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
175
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
176 The name of the referenced function can be obtained with |string()|. >
119
e8f07016e34d updated for version 7.0042
vimboss
parents: 114
diff changeset
177 :let func = string(Fn)
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
178
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
179 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
180 arguments: >
119
e8f07016e34d updated for version 7.0042
vimboss
parents: 114
diff changeset
181 :let r = call(Fn, mylist)
9104
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
182 <
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
183 *Partial*
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
184 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
185 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
186 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
187 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
188
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
189 let Cb = function('Callback', ['foo'], myDict)
14999
2b30a2b4bde2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14964
diff changeset
190 call Cb('bar')
9104
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
191
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
192 This will invoke the function as if using: >
14999
2b30a2b4bde2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14964
diff changeset
193 call myDict.Callback('foo', 'bar')
9104
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
194
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
195 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
196 |ch_open()|.
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
197
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
198 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
199 a member of the Dictionary: >
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
200
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
201 let myDict.myFunction = MyFunction
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
202 call myDict.myFunction()
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
203
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
204 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
205 "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
206 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
207
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
208 let otherDict.myFunction = myDict.myFunction
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
209 call otherDict.myFunction()
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
210
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
211 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
212 this won't happen: >
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
213
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
214 let myDict.myFunction = function(MyFunction, myDict)
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
215 let otherDict.myFunction = myDict.myFunction
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
216 call otherDict.myFunction()
2242a5766417 commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents: 9097
diff changeset
217
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
218 Here "self" will be "myDict", because it was bound explicitly.
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
219
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
220
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
221 1.3 Lists ~
5814
755931e042e4 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5808
diff changeset
222 *list* *List* *Lists* *E686*
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
223 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
224 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
225 position in the sequence.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
226
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
227
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
228 List creation ~
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
229 *E696* *E697*
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
230 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
231 Examples: >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
232 :let mylist = [1, two, 3, "four"]
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
233 :let emptylist = []
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
234
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
235 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
236 List of Lists: >
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
237 :let nestlist = [[11, 12], [21, 22], [31, 32]]
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
238
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
239 An extra comma after the last item is ignored.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
240
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
241
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
242 List index ~
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
243 *list-index* *E684*
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
244 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
245 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
246 :let item = mylist[0] " get the first item: 1
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
247 :let item = mylist[2] " get the third item: 3
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
248
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
249 When the resulting item is a list this can be repeated: >
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
250 :let item = nestlist[0][1] " get the first list, second item: 12
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
251 <
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
252 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
253 the List, -2 to the last but one item, etc. >
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
254 :let last = mylist[-1] " get the last item: "four"
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
255
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
256 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
257 is not available it returns zero or the default value you specify: >
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
258 :echo get(mylist, idx)
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
259 :echo get(mylist, idx, "NONE")
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
260
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
261
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
262 List concatenation ~
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
263
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
264 Two lists can be concatenated with the "+" operator: >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
265 :let longlist = mylist + [5, 6]
119
e8f07016e34d updated for version 7.0042
vimboss
parents: 114
diff changeset
266 :let mylist += [7, 8]
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
267
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
268 To prepend or append an item turn the item into a list by putting [] around
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
269 it. To change a list in-place see |list-modification| below.
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
270
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
271
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
272 Sublist ~
9737
35ce559b8553 commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents: 9723
diff changeset
273 *sublist*
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
274 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
275 separated by a colon in square brackets: >
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
276 :let shortlist = mylist[2:-1] " get List [3, "four"]
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 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
279 similar to -1. >
90
9d4f762cc1d9 updated for version 7.0036
vimboss
parents: 87
diff changeset
280 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"]
9d4f762cc1d9 updated for version 7.0036
vimboss
parents: 87
diff changeset
281 :let shortlist = mylist[2:2] " List with one item: [3]
9d4f762cc1d9 updated for version 7.0036
vimboss
parents: 87
diff changeset
282 :let otherlist = mylist[:] " make a copy of the List
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
283
842
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
284 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
285 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
286 message.
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
287
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
288 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
289 length minus one is used: >
829
dc8197342755 updated for version 7.0d04
vimboss
parents: 825
diff changeset
290 :let mylist = [0, 1, 2, 3]
dc8197342755 updated for version 7.0d04
vimboss
parents: 825
diff changeset
291 :echo mylist[2:8] " result: [2, 3]
dc8197342755 updated for version 7.0d04
vimboss
parents: 825
diff changeset
292
270
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
293 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
294 using a single letter variable before the ":". Insert a space when needed:
270
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
295 mylist[s : e].
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
296
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
297
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
298 List identity ~
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
299 *list-identity*
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
300 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
301 variables refer to the same list. Thus changing the list "aa" will also
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
302 change "bb": >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
303 :let aa = [1, 2, 3]
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
304 :let bb = aa
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
305 :call add(aa, 4)
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
306 :echo bb
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
307 < [1, 2, 3, 4]
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
308
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
309 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
310 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
311 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
312 :let aa = [[1, 'a'], 2, 3]
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
313 :let bb = copy(aa)
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
314 :call add(aa, 4)
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
315 :let aa[0][1] = 'aaa'
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
316 :echo aa
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
317 < [[1, aaa], 2, 3, 4] >
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
318 :echo bb
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
319 < [[1, aaa], 2, 3]
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
320
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
321 To make a completely independent list use |deepcopy()|. This also makes a
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
322 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
323
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
324 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
325 List. "isnot" does the opposite. In contrast "==" compares if two lists have
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
326 the same value. >
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
327 :let alist = [1, 2, 3]
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
328 :let blist = [1, 2, 3]
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
329 :echo alist is blist
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
330 < 0 >
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
331 :echo alist == blist
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
332 < 1
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
333
323
03b3684919e3 updated for version 7.0084
vimboss
parents: 314
diff changeset
334 Note about comparing lists: Two lists are considered equal if they have the
03b3684919e3 updated for version 7.0084
vimboss
parents: 314
diff changeset
335 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
336 exception: When comparing a number with a string they are considered
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
337 different. There is no automatic type conversion, as with using "==" on
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
338 variables. Example: >
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
339 echo 4 == "4"
323
03b3684919e3 updated for version 7.0084
vimboss
parents: 314
diff changeset
340 < 1 >
388
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
341 echo [4] == ["4"]
323
03b3684919e3 updated for version 7.0084
vimboss
parents: 314
diff changeset
342 < 0
03b3684919e3 updated for version 7.0084
vimboss
parents: 314
diff changeset
343
388
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
344 Thus comparing Lists is more strict than comparing numbers and strings. You
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
345 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
346
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
347 :let a = 5
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
348 :let b = "5"
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
349 :echo a == b
388
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
350 < 1 >
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
351 :echo [a] == [b]
388
f92bb1845823 updated for version 7.0101
vimboss
parents: 375
diff changeset
352 < 0
323
03b3684919e3 updated for version 7.0084
vimboss
parents: 314
diff changeset
353
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
354
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
355 List unpack ~
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
356
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
357 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
358 square brackets, like list items: >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
359 :let [var1, var2] = mylist
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
360
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
361 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
362 this produces an error. To handle any extra items from the list append ";"
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
363 and a variable name: >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
364 :let [var1, var2; rest] = mylist
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
365
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
366 This works like: >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
367 :let var1 = mylist[0]
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
368 :let var2 = mylist[1]
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
369 :let rest = mylist[2:]
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
370
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
371 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
372 empty list then.
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
373
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
374
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
375 List modification ~
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
376 *list-modification*
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
377 To change a specific item of a list use |:let| this way: >
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
378 :let list[4] = "four"
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
379 :let listlist[0][3] = item
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
380
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
381 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
382 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
383 :let list[3:5] = [3, 4, 5]
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
384
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
385 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
386 examples: >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
387 :call insert(list, 'a') " prepend item 'a'
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
388 :call insert(list, 'a', 3) " insert item 'a' before list[3]
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
389 :call add(list, "new") " append String item
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
390 :call add(list, [1, 2]) " append a List as one new item
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
391 :call extend(list, [1, 2]) " extend the list with two more items
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
392 :let i = remove(list, 3) " remove item 3
108
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
393 :unlet list[3] " idem
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
394 :let l = remove(list, 3, -1) " remove items 3 to last item
108
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
395 :unlet list[3 : ] " idem
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
396 :call filter(list, 'v:val !~ "x"') " remove items with an 'x'
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
397
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
398 Changing the order of items in a list: >
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
399 :call sort(list) " sort a list alphabetically
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
400 :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
401 :call uniq(sort(list)) " sort and remove duplicates
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
402
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
403
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
404 For loop ~
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
405
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
406 The |:for| loop executes commands for each item in a list. A variable is set
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
407 to each item in the list in sequence. Example: >
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
408 :for item in mylist
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
409 : call Doit(item)
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
410 :endfor
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
411
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
412 This works like: >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
413 :let index = 0
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
414 :while index < len(mylist)
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
415 : let item = mylist[index]
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
416 : :call Doit(item)
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
417 : let index = index + 1
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
418 :endwhile
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
419
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
420 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
421 function will be a simpler method than a for loop.
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
422
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
423 Just like the |:let| command, |:for| also accepts a list of variables. This
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
424 requires the argument to be a list of lists. >
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
425 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]]
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
426 : call Doit(lnum, col)
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
427 :endfor
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
428
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
429 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
430 must remain the same to avoid an error.
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
431
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
432 It is also possible to put remaining items in a List variable: >
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
433 :for [i, j; rest] in listlist
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
434 : call Doit(i, j)
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
435 : if !empty(rest)
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
436 : echo "remainder: " . string(rest)
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
437 : endif
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
438 :endfor
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
439
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
440
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
441 List functions ~
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
442 *E714*
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
443 Functions that are useful with a List: >
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
444 :let r = call(funcname, list) " call a function with an argument list
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
445 :if empty(list) " check if list is empty
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
446 :let l = len(list) " number of items in list
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
447 :let big = max(list) " maximum value in list
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
448 :let small = min(list) " minimum value in list
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
449 :let xs = count(list, 'x') " count nr of times 'x' appears in list
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
450 :let i = index(list, 'x') " index of first 'x' in list
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
451 :let lines = getline(1, 10) " get ten text lines from buffer
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
452 :call append('$', lines) " append text lines in buffer
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
453 :let list = split("a b c") " create list from items in a string
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
454 :let string = join(list, ', ') " create string from list items
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
455 :let s = string(list) " String representation of list
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
456 :call map(list, '">> " . v:val') " prepend ">> " to each item
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
457
258
f93df7322443 updated for version 7.0070
vimboss
parents: 236
diff changeset
458 Don't forget that a combination of features can make things simple. For
f93df7322443 updated for version 7.0070
vimboss
parents: 236
diff changeset
459 example, to add up all the numbers in a list: >
f93df7322443 updated for version 7.0070
vimboss
parents: 236
diff changeset
460 :exe 'let sum = ' . join(nrlist, '+')
f93df7322443 updated for version 7.0070
vimboss
parents: 236
diff changeset
461
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
462
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
463 1.4 Dictionaries ~
15498
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
464 *dict* *Dict* *Dictionaries* *Dictionary*
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
465 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
466 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
467 ordering.
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
468
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
469
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
470 Dictionary creation ~
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
471 *E720* *E721* *E722* *E723*
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
472 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
473 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
474 only appear once. Examples: >
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
475 :let mydict = {1: 'one', 2: 'two', 3: 'three'}
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
476 :let emptydict = {}
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
477 < *E713* *E716* *E717*
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
478 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
479 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
480 entry. Note that the String '04' and the Number 04 are different, since the
8876
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
481 Number will be converted to the String '4'. The empty string can be used as a
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
482 key.
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
483
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
484 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
485 nested Dictionary: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
486 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}}
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
487
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
488 An extra comma after the last entry is ignored.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
489
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
490
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
491 Accessing entries ~
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
492
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
493 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
494 :let val = mydict["one"]
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
495 :let mydict["four"] = 4
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
496
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
497 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
498
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
499 For keys that consist entirely of letters, digits and underscore the following
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
500 form can be used |expr-entry|: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
501 :let val = mydict.one
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
502 :let mydict.four = 4
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
503
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
504 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
505 key lookup can be repeated: >
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
506 :echo dict.key[idx].key
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
507
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
508
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
509 Dictionary to List conversion ~
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
510
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
511 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
512 turn the Dictionary into a List and pass it to |:for|.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
513
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
514 Most often you want to loop over the keys, using the |keys()| function: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
515 :for key in keys(mydict)
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
516 : echo key . ': ' . mydict[key]
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
517 :endfor
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
518
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
519 The List of keys is unsorted. You may want to sort them first: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
520 :for key in sort(keys(mydict))
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
521
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
522 To loop over the values use the |values()| function: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
523 :for v in values(mydict)
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
524 : echo "value: " . v
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
525 :endfor
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
526
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
527 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
528 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
529 :for [key, value] in items(mydict)
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
530 : echo key . ': ' . value
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
531 :endfor
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
532
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
533
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
534 Dictionary identity ~
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
535 *dict-identity*
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
536 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
537 Dictionary. Otherwise, assignment results in referring to the same
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
538 Dictionary: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
539 :let onedict = {'a': 1, 'b': 2}
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
540 :let adict = onedict
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
541 :let adict['a'] = 11
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
542 :echo onedict['a']
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
543 11
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
544
327
8f38b35904c0 updated for version 7.0085
vimboss
parents: 323
diff changeset
545 Two Dictionaries compare equal if all the key-value pairs compare equal. For
8f38b35904c0 updated for version 7.0085
vimboss
parents: 323
diff changeset
546 more info see |list-identity|.
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
547
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
548
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
549 Dictionary modification ~
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
550 *dict-modification*
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
551 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
552 use |:let| this way: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
553 :let dict[4] = "four"
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
554 :let dict['one'] = item
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
555
108
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
556 Removing an entry from a Dictionary is done with |remove()| or |:unlet|.
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
557 Three ways to remove the entry with key "aaa" from dict: >
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
558 :let i = remove(dict, 'aaa')
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
559 :unlet dict.aaa
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
560 :unlet dict['aaa']
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
561
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
562 Merging a Dictionary with another is done with |extend()|: >
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
563 :call extend(adict, bdict)
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
564 This extends adict with all entries from bdict. Duplicate keys cause entries
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
565 in adict to be overwritten. An optional third argument can change this.
119
e8f07016e34d updated for version 7.0042
vimboss
parents: 114
diff changeset
566 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
567 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
568 adict.
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
569
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
570 Weeding out entries from a Dictionary can be done with |filter()|: >
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
571 :call filter(dict, 'v:val =~ "x"')
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
572 This removes all entries from "dict" with a value not matching 'x'.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
573
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
574
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
575 Dictionary function ~
4159
8b86b69546a9 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4157
diff changeset
576 *Dictionary-function* *self* *E725* *E862*
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
577 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
578 special way with a dictionary. Example: >
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
579 :function Mylen() dict
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
580 : return len(self.data)
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
581 :endfunction
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
582 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
583 :echo mydict.len()
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
584
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
585 This is like a method in object oriented programming. The entry in the
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
586 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
587 the function was invoked from.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
588
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
589 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
590 Funcref to a Dictionary, but the "self" variable is not available then.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
591
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
592 *numbered-function* *anonymous-function*
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
593 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
594 assigned to a Dictionary in this way: >
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
595 :let mydict = {'data': [0, 1, 2, 3]}
6741
fbc1131f0ba5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6697
diff changeset
596 :function mydict.len()
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
597 : return len(self.data)
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
598 :endfunction
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
599 :echo mydict.len()
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
600
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
601 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
602 that references this function. The function can only be used through a
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
603 |Funcref|. It will automatically be deleted when there is no |Funcref|
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
604 remaining that refers to it.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
605
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
606 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
607
2488
def0e3934129 Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents: 2465
diff changeset
608 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
609 a trick. Assuming the function is 42, the command is: >
def0e3934129 Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents: 2465
diff changeset
610 :function {42}
def0e3934129 Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents: 2465
diff changeset
611
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
612
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
613 Functions for Dictionaries ~
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
614 *E715*
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
615 Functions that can be used with a Dictionary: >
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
616 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo"
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
617 :if empty(dict) " TRUE if dict is empty
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
618 :let l = len(dict) " number of items in dict
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
619 :let big = max(dict) " maximum value in dict
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
620 :let small = min(dict) " minimum value in dict
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
621 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
622 :let s = string(dict) " String representation of dict
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
623 :call map(dict, '">> " . v:val') " prepend ">> " to each item
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
624
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
625
15498
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
626 1.5 Blobs ~
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
627 *blob* *Blob* *Blobs* *E978*
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
628 A Blob mostly behaves like a |List| of numbers, where the numbers have an
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
629 8-bit value, from 0 to 255.
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
630
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
631
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
632 Blob creation ~
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
633
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
634 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
635 :let b = 0zFF00ED015DAF
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
636
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
637 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
638 set to "B", for example: >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
639 :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
640
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
641 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
642
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
643
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
644 Blob index ~
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
645 *blob-index* *E979*
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
646 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
647 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
648 :let myblob = 0z00112233
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
649 :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
650 :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
651
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
652 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
653 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
654 :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
655
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
656 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
657 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
658 :echo get(myblob, idx)
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
659 :echo get(myblob, idx, 999)
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
660
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
661
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
662 Blob concatenation ~
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
663
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
664 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
665 :let longblob = myblob + 0z4455
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
666 :let myblob += 0z6677
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
667
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
668 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
669
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
670
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
671 Part of a blob ~
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
672
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
673 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
674 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
675 :let myblob = 0z00112233
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
676 :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
677 :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
678
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
679 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
680 similar to -1. >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
681 :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
682 :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
683 :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
684
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
685 If the first index is beyond the last byte of the Blob or the second index is
15498
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
686 before the first byte, the result is an empty list. There is no error
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
687 message.
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
688
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
689 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
690 length minus one is used: >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
691 :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
692
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
693
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
694 Blob modification ~
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
695 *blob-modification*
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
696 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
697 :let blob[4] = 0x44
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
698
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
699 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
700 higher index is an error.
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
701
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
702 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
703 let blob[1:3] = 0z445566
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
704 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
705 provided. *E972*
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
706
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
707 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
708 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
709 :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
710
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
711 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
712
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
713
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
714 Blob identity ~
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
715
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
716 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
717 if blob == 0z001122
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
718 And for equal identity: >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
719 if blob is otherblob
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
720 < *blob-identity* *E977*
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
721 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
722 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
723
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
724 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
725 identity is different: >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
726 :let blob = 0z112233
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
727 :let blob2 = blob
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
728 :echo blob == blob2
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
729 < 1 >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
730 :echo blob is blob2
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
731 < 1 >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
732 :let blob3 = blob[:]
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
733 :echo blob == blob3
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
734 < 1 >
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
735 :echo blob is blob3
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
736 < 0
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
737
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
738 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
739 works, as explained above.
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
740
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
741
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
742 1.6 More about variables ~
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
743 *more-variables*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
744 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
745 function.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
746
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
747 When the '!' flag is included in the 'viminfo' option, global variables that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
748 start with an uppercase letter, and don't contain a lowercase letter, are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
749 stored in the viminfo file |viminfo-file|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
750
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
751 When the 'sessionoptions' option contains "global", global variables that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
752 start with an uppercase letter and contain at least one lowercase letter are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
753 stored in the session file |session-file|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
754
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
755 variable name can be stored where ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
756 my_var_6 not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
757 My_Var_6 session file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
758 MY_VAR_6 viminfo file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
759
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
760
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
761 It's possible to form a variable name with curly braces, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
762 |curly-braces-names|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
763
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
764 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
765 2. Expression syntax *expression-syntax*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
766
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
767 Expression syntax summary, from least to most significant:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
768
10218
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
769 |expr1| expr2
10048
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
770 expr2 ? expr1 : expr1 if-then-else
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
771
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
772 |expr2| expr3
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
773 expr3 || expr3 .. logical OR
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
774
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
775 |expr3| expr4
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
776 expr4 && expr4 .. logical AND
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
777
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
778 |expr4| expr5
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
779 expr5 == expr5 equal
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
780 expr5 != expr5 not equal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
781 expr5 > expr5 greater than
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
782 expr5 >= expr5 greater than or equal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
783 expr5 < expr5 smaller than
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
784 expr5 <= expr5 smaller than or equal
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
785 expr5 =~ expr5 regexp matches
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
786 expr5 !~ expr5 regexp doesn't match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
787
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
788 expr5 ==? expr5 equal, ignoring case
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
789 expr5 ==# expr5 equal, match case
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
790 etc. As above, append ? for ignoring case, # for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
791 matching case
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
792
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
793 expr5 is expr5 same |List| instance
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
794 expr5 isnot expr5 different |List| instance
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
795
10048
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
796 |expr5| expr6
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
797 expr6 + expr6 .. number addition, list or blob concatenation
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
798 expr6 - expr6 .. number subtraction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
799 expr6 . expr6 .. string concatenation
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
800
10048
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
801 |expr6| expr7
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
802 expr7 * expr7 .. number multiplication
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
803 expr7 / expr7 .. number division
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
804 expr7 % expr7 .. number modulo
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
805
10048
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
806 |expr7| expr8
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
807 ! expr7 logical NOT
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
808 - expr7 unary minus
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
809 + expr7 unary plus
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
810
10048
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
811 |expr8| expr9
43efa4f5a8ea commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents: 10038
diff changeset
812 expr8[expr1] byte of a String or item of a |List|
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
813 expr8[expr1 : expr1] substring of a String or sublist of a |List|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
814 expr8.name entry in a |Dictionary|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
815 expr8(expr1, ...) function call with |Funcref| variable
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
816
10218
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
817 |expr9| number number constant
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
818 "string" string constant, backslash is special
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
819 'string' string constant, ' is doubled
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
820 [expr1, ...] |List|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
821 {expr1: expr1, ...} |Dictionary|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
822 &option option value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
823 (expr1) nested expression
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
824 variable internal variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
825 va{ria}ble internal variable with curly braces
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
826 $VAR environment variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
827 @r contents of register 'r'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
828 function(expr1, ...) function call
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
829 func{ti}on(expr1, ...) function call with curly braces
9527
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
830 {args -> expr1} lambda expression
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
831
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
832
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
833 ".." indicates that the operations in this level can be concatenated.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
834 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
835 &nu || &list && &shell == "csh"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
836
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
837 All expressions within one level are parsed from left to right.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
838
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
839
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
840 expr1 *expr1* *E109*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
841 -----
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
842
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
843 expr2 ? expr1 : expr1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
844
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
845 The expression before the '?' is evaluated to a number. If it evaluates to
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
846 |TRUE|, the result is the value of the expression between the '?' and ':',
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
847 otherwise the result is the value of the expression after the ':'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
848 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
849 :echo lnum == 1 ? "top" : lnum
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
850
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
851 Since the first expression is an "expr2", it cannot contain another ?:. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
852 other two expressions can, thus allow for recursive use of ?:.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
853 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
854 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
855
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
856 To keep this readable, using |line-continuation| is suggested: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
857 :echo lnum == 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
858 :\ ? "top"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
859 :\ : lnum == 1000
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
860 :\ ? "last"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
861 :\ : lnum
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
862
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
863 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
864 use in a variable such as "a:1".
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
865
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
866
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
867 expr2 and expr3 *expr2* *expr3*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
868 ---------------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
869
10038
7cf4e210cf3c commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents: 10027
diff changeset
870 expr3 || expr3 .. logical OR *expr-barbar*
7cf4e210cf3c commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents: 10027
diff changeset
871 expr4 && expr4 .. logical AND *expr-&&*
7cf4e210cf3c commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents: 10027
diff changeset
872
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
873 The "||" and "&&" operators take one argument on each side. The arguments
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
874 are (converted to) Numbers. The result is:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
875
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
876 input output ~
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
877 n1 n2 n1 || n2 n1 && n2 ~
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
878 |FALSE| |FALSE| |FALSE| |FALSE|
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
879 |FALSE| |TRUE| |TRUE| |FALSE|
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
880 |TRUE| |FALSE| |TRUE| |FALSE|
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
881 |TRUE| |TRUE| |TRUE| |TRUE|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
882
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
883 The operators can be concatenated, for example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
884
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
885 &nu || &list && &shell == "csh"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
886
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
887 Note that "&&" takes precedence over "||", so this has the meaning of: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
888
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
889 &nu || (&list && &shell == "csh")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
890
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
891 Once the result is known, the expression "short-circuits", that is, further
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
892 arguments are not evaluated. This is like what happens in C. For example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
893
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
894 let a = 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
895 echo a || b
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
896
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
897 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
898 so the result must be |TRUE|. Similarly below: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
899
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
900 echo exists("b") && b == "yes"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
901
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
902 This is valid whether "b" has been defined or not. The second clause will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
903 only be evaluated if "b" has been defined.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
904
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
905
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
906 expr4 *expr4*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
907 -----
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
908
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
909 expr5 {cmp} expr5
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
910
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
911 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
912 if it evaluates to true.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
913
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
914 *expr-==* *expr-!=* *expr->* *expr->=*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
915 *expr-<* *expr-<=* *expr-=~* *expr-!~*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
916 *expr-==#* *expr-!=#* *expr->#* *expr->=#*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
917 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
918 *expr-==?* *expr-!=?* *expr->?* *expr->=?*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
919 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?*
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
920 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#*
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
921 *expr-is?* *expr-isnot?*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
922 use 'ignorecase' match case ignore case ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
923 equal == ==# ==?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
924 not equal != !=# !=?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
925 greater than > ># >?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
926 greater than or equal >= >=# >=?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
927 smaller than < <# <?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
928 smaller than or equal <= <=# <=?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
929 regexp matches =~ =~# =~?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
930 regexp doesn't match !~ !~# !~?
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
931 same instance is is# is?
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
932 different instance isnot isnot# isnot?
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
933
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
934 Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
935 "abc" ==# "Abc" evaluates to 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
936 "abc" ==? "Abc" evaluates to 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
937 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
938
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
939 *E691* *E692*
12756
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
940 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
941 "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
942 recursively. Ignoring case means case is ignored when comparing item values.
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
943
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
944 *E735* *E736*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
945 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
946 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
947 |Dictionary| recursively. Ignoring case means case is ignored when comparing
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
948 item values.
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
949
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
950 *E694*
9407
619a98a67f67 commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents: 9389
diff changeset
951 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
952 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
953 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
954 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
955 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
956
619a98a67f67 commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents: 9389
diff changeset
957 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
958 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
959 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
960 " Part1 and Part2 refer to the same function
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
961
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
962 When using "is" or "isnot" with a |List| or a |Dictionary| this checks if the
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
963 expressions are referring to the same |List| or |Dictionary| instance. A copy
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
964 of a |List| is different from the original |List|. When using "is" without
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
965 a |List| or a |Dictionary| it is equivalent to using "equal", using "isnot"
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
966 equivalent to using "not equal". Except that a different type means the
8534
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
967 values are different: >
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
968 echo 4 == '4'
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
969 1
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
970 echo 4 is '4'
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
971 0
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
972 echo 0 is []
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
973 0
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
974 "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
975
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
976 When comparing a String with a Number, the String is converted to a Number,
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
977 and the comparison is done on Numbers. This means that: >
8534
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
978 echo 0 == 'x'
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
979 1
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
980 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
981 echo [0] == ['x']
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
982 0
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
983 Inside a List or Dictionary this conversion is not used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
984
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
985 When comparing two Strings, this is done with strcmp() or stricmp(). This
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
986 results in the mathematical difference (comparing byte values), not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
987 necessarily the alphabetical difference in the local language.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
988
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
989 When using the operators with a trailing '#', or the short version and
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
990 'ignorecase' is off, the comparing is done with strcmp(): case matters.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
991
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
992 When using the operators with a trailing '?', or the short version and
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
993 'ignorecase' is set, the comparing is done with stricmp(): case is ignored.
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
994
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
995 'smartcase' is not used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
996
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
997 The "=~" and "!~" operators match the lefthand argument with the righthand
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
998 argument, which is used as a pattern. See |pattern| for what a pattern is.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
999 This matching is always done like 'magic' was set and 'cpoptions' is empty, no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1000 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1001 portable. To avoid backslashes in the regexp pattern to be doubled, use a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1002 single-quote string, see |literal-string|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1003 Since a string is considered to be a single line, a multi-line pattern
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1004 (containing \n, backslash-n) will not match. However, a literal NL character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1005 can be matched like an ordinary character. Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1006 "foo\nbar" =~ "\n" evaluates to 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1007 "foo\nbar" =~ "\\n" evaluates to 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1008
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1009
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1010 expr5 and expr6 *expr5* *expr6*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1011 ---------------
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1012 expr6 + expr6 .. Number addition or |List| concatenation *expr-+*
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
1013 expr6 - expr6 .. Number subtraction *expr--*
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
1014 expr6 . expr6 .. String concatenation *expr-.*
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
1015
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
1016 For |Lists| only "+" is possible and then both expr6 must be a list. The
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1017 result is a new list with the two lists Concatenated.
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
1018
3214
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
1019 expr7 * expr7 .. Number multiplication *expr-star*
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
1020 expr7 / expr7 .. Number division *expr-/*
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
1021 expr7 % expr7 .. Number modulo *expr-%*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1022
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1023 For all, except ".", Strings are converted to Numbers.
3214
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
1024 For bitwise operators see |and()|, |or()| and |xor()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1025
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1026 Note the difference between "+" and ".":
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1027 "123" + "456" = 579
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1028 "123" . "456" = "123456"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1029
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1030 Since '.' has the same precedence as '+' and '-', you need to read: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1031 1 . 90 + 90.0
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1032 As: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1033 (1 . 90) + 90.0
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1034 That works, since the String "190" is automatically converted to the Number
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1035 190, which can be added to the Float 90.0. However: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1036 1 . 90 * 90.0
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1037 Should be read as: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1038 1 . (90 * 90.0)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1039 Since '.' has lower precedence than '*'. This does NOT work, since this
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1040 attempts to concatenate a Float and a String.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1041
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1042 When dividing a Number by zero the result depends on the value:
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1043 0 / 0 = -0x80000000 (like NaN for Float)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1044 >0 / 0 = 0x7fffffff (like positive infinity)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1045 <0 / 0 = -0x7fffffff (like negative infinity)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1046 (before Vim 7.2 it was always 0x7fffffff)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1047
9389
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
1048 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
1049 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
1050 >0 / 0 = 0x7fffffffffffffff (like positive infinity)
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
1051 <0 / 0 = -0x7fffffffffffffff (like negative infinity)
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
1052
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1053 When the righthand side of '%' is zero, the result is 0.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1054
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1055 None of these work for |Funcref|s.
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
1056
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1057 . and % do not work for Float. *E804*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1058
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1059
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1060 expr7 *expr7*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1061 -----
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1062 ! expr7 logical NOT *expr-!*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1063 - expr7 unary minus *expr-unary--*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1064 + expr7 unary plus *expr-unary-+*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1065
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
1066 For '!' |TRUE| becomes |FALSE|, |FALSE| becomes |TRUE| (one).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1067 For '-' the sign of the number is changed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1068 For '+' the number is unchanged.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1069
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1070 A String will be converted to a Number first.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1071
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
1072 These three can be repeated and mixed. Examples:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1073 !-1 == 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1074 !!8 == 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1075 --9 == 9
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1076
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1077
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1078 expr8 *expr8*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1079 -----
14637
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14601
diff changeset
1080 This expression is either |expr9| or a sequence of the alternatives below,
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14601
diff changeset
1081 in any order. E.g., these are all possible:
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14601
diff changeset
1082 expr9[expr1].name
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14601
diff changeset
1083 expr9.name[expr1]
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14601
diff changeset
1084 expr9(expr1, ...)[expr1].name
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14601
diff changeset
1085
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14601
diff changeset
1086
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1087 expr8[expr1] item of String or |List| *expr-[]* *E111*
8876
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
1088 *E909* *subscript*
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1089 If expr8 is a Number or String this results in a String that contains the
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1090 expr1'th single byte from expr8. expr8 is used as a String, expr1 as a
10218
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
1091 Number. This doesn't recognize multi-byte encodings, see `byteidx()` for
8876
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
1092 an alternative, or use `split()` to turn the string into a list of characters.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1093
7384
aea5ebf352c4 commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents: 7358
diff changeset
1094 Index zero gives the first byte. This is like it works in C. Careful:
aea5ebf352c4 commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents: 7358
diff changeset
1095 text column numbers start with one! Example, to get the byte under the
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1096 cursor: >
823
9ab23f1e137f updated for version 7.0c12
vimboss
parents: 819
diff changeset
1097 :let c = getline(".")[col(".") - 1]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1098
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1099 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
1100 String. A negative index always results in an empty string (reason: backward
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1101 compatibility). Use [-1:] to get the last byte.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1102
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1103 If expr8 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
1104 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
1105 error. Example: >
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1106 :let item = mylist[-1] " get last item
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1107
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1108 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
1109 |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
1110 error.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1111
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1112
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1113 expr8[expr1a : expr1b] substring or sublist *expr-[:]*
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1114
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1115 If expr8 is a Number or String this results in the substring with the bytes
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1116 from expr1a to and including expr1b. expr8 is used as a String, expr1a and
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
1117 expr1b are used as a Number. This doesn't recognize multi-byte encodings, see
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
1118 |byteidx()| for computing the indexes.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1119
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1120 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
1121 string minus one is used.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1122
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1123 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
1124 the last character, -2 the last but one, etc.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1125
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1126 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
1127 expr1b is smaller than expr1a the result is an empty string.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1128
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1129 Examples: >
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1130 :let c = name[-1:] " last byte of a string
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1131 :let c = name[-2:-2] " last but one byte of a string
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1132 :let s = line(".")[4:] " from the fifth byte to the end
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1133 :let s = s[:-3] " remove last two bytes
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
1134 <
9737
35ce559b8553 commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents: 9723
diff changeset
1135 *slice*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1136 If expr8 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
1137 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
1138 just above. Also see |sublist| below. Examples: >
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1139 :let l = mylist[:3] " first four items
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1140 :let l = mylist[4:4] " List with one item
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1141 :let l = mylist[:] " shallow copy of a List
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
1142
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
1143 If expr8 is a |Blob| this results in a new |Blob| with the bytes in the
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
1144 indexes expr1a and expr1b, inclusive. Examples: >
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
1145 :let b = 0zDEADBEEF
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
1146 :let bs = b[1:2] " 0zADBE
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
1147 :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
1148
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1149 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1150 error.
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1151
7615
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents: 7597
diff changeset
1152 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
1153 for a sublist: >
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents: 7597
diff changeset
1154 mylist[n:] " uses variable n
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents: 7597
diff changeset
1155 mylist[s:] " uses namespace s:, error!
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents: 7597
diff changeset
1156
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1157
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1158 expr8.name entry in a |Dictionary| *expr-entry*
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1159
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1160 If expr8 is a |Dictionary| and it is followed by a dot, then the following
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1161 name will be used as a key in the |Dictionary|. This is just like:
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1162 expr8[name].
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1163
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1164 The name must consist of alphanumeric characters, just like a variable name,
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1165 but it may start with a number. Curly braces cannot be used.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1166
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1167 There must not be white space before or after the dot.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1168
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1169 Examples: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1170 :let dict = {"one": 1, 2: "two"}
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1171 :echo dict.one
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1172 :echo dict .2
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1173
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1174 Note that the dot is also used for String concatenation. To avoid confusion
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1175 always put spaces around the dot for String concatenation.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1176
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
1177
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1178 expr8(expr1, ...) |Funcref| function call
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1179
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1180 When expr8 is a |Funcref| type variable, invoke the function it refers to.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1181
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1182
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1183
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1184 *expr9*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1185 number
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1186 ------
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
1187 number number constant *expr-number*
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
1188 *hex-number* *octal-number* *binary-number*
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
1189
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
1190 Decimal, Hexadecimal (starting with 0x or 0X), Binary (starting with 0b or 0B)
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
1191 and Octal (starting with 0).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1192
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1193 *floating-point-format*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1194 Floating point numbers can be written in two forms:
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1195
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1196 [-+]{N}.{M}
6530
435956324539 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6447
diff changeset
1197 [-+]{N}.{M}[eE][-+]{exp}
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1198
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1199 {N} and {M} are numbers. Both {N} and {M} must be present and can only
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1200 contain digits.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1201 [-+] means there is an optional plus or minus sign.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1202 {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
1203 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
1204 locale is.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1205 {only when compiled with the |+float| feature}
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1206
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1207 Examples:
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1208 123.456
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1209 +0.0001
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1210 55.0
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1211 -0.123
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1212 1.234e03
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1213 1.0E-6
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1214 -3.1416e+88
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1215
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1216 These are INVALID:
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1217 3. empty {M}
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1218 1e40 missing .{M}
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1219
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1220 Rationale:
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1221 Before floating point was introduced, the text "123.456" was interpreted as
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1222 the two numbers "123" and "456", both converted to a string and concatenated,
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1223 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
1224 could not find it intentionally being used in Vim scripts, this backwards
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1225 incompatibility was accepted in favor of being able to use the normal notation
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1226 for floating point numbers.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1227
15131
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15062
diff changeset
1228 *float-pi* *float-e*
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15062
diff changeset
1229 A few useful values to copy&paste: >
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15062
diff changeset
1230 :let pi = 3.14159265359
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15062
diff changeset
1231 :let e = 2.71828182846
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15062
diff changeset
1232 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
1233 also use functions, like the following: >
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15062
diff changeset
1234 :let pi = acos(-1.0)
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15062
diff changeset
1235 :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
1236 <
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1237 *floating-point-precision*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1238 The precision and range of floating points numbers depends on what "double"
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1239 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
1240 runtime.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1241
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1242 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
1243 printf("%g", f). You can select something else when using the |printf()|
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1244 function. Example: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1245 :echo printf('%.15e', atan(1))
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1246 < 7.853981633974483e-01
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1247
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1248
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1249
6884
29c328f69aaa Update help files.
Bram Moolenaar <bram@vim.org>
parents: 6870
diff changeset
1250 string *string* *String* *expr-string* *E114*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1251 ------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1252 "string" string constant *expr-quote*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1253
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1254 Note that double quotes are used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1255
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1256 A string constant accepts these special characters:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1257 \... three-digit octal number (e.g., "\316")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1258 \.. two-digit octal number (must be followed by non-digit)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1259 \. one-digit octal number (must be followed by non-digit)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1260 \x.. byte specified with two hex numbers (e.g., "\x1f")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1261 \x. byte specified with one hex number (must be followed by non-hex char)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1262 \X.. same as \x..
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1263 \X. same as \x.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1264 \u.... character specified with up to 4 hex numbers, stored according to the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1265 current value of 'encoding' (e.g., "\u02a4")
6840
37828f7503c7 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6823
diff changeset
1266 \U.... same as \u but allows up to 8 hex numbers.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1267 \b backspace <BS>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1268 \e escape <Esc>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1269 \f formfeed <FF>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1270 \n newline <NL>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1271 \r return <CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1272 \t tab <Tab>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1273 \\ backslash
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1274 \" double quote
2152
b9e314fe473f Updated runtime files.
Bram Moolenaar <bram@zimbu.org>
parents: 2120
diff changeset
1275 \<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
1276 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
1277 To use the double quote character it must be escaped: "<M-\">".
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
1278 Don't use <Char-xxxx> to get a utf-8 character, use \uxxxx as
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
1279 mentioned above.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1280
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
1281 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
1282 encodings. Use "\u00ff" to store character 255 according to the current value
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
1283 of 'encoding'.
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
1284
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1285 Note that "\000" and "\x00" force the end of the string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1286
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1287
15498
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
1288 blob-literal *blob-literal* *E973*
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
1289 ------------
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
1290
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
1291 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
1292 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
1293 :let b = 0zFF00ED015DAF
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
1294
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
1295
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1296 literal-string *literal-string* *E115*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1297 ---------------
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1298 'string' string constant *expr-'*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1299
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1300 Note that single quotes are used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1301
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
1302 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
1303 meaning. The only exception is that two quotes stand for one quote.
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1304
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1305 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
1306 to be doubled. These two commands are equivalent: >
26
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1307 if a =~ "\\s*"
404aac550f35 updated for version 7.0017
vimboss
parents: 24
diff changeset
1308 if a =~ '\s*'
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1309
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1310
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1311 option *expr-option* *E112* *E113*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1312 ------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1313 &option option value, local value if possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1314 &g:option global option value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1315 &l:option local option value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1316
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1317 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1318 echo "tabstop is " . &tabstop
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1319 if &insertmode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1320
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1321 Any option name can be used here. See |options|. When using the local value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1322 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
1323 anyway.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1324
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1325
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
1326 register *expr-register* *@r*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1327 --------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1328 @r contents of register 'r'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1329
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1330 The result is the contents of the named register, as a single string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1331 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
1332 register use @" or @@. See |registers| for an explanation of the available
336
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
1333 registers.
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
1334
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
1335 When using the '=' register you get the expression itself, not what it
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
1336 evaluates to. Use |eval()| to evaluate it.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1337
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1338
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1339 nesting *expr-nesting* *E110*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1340 -------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1341 (expr1) nested expression
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1342
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1343
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1344 environment variable *expr-env*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1345 --------------------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1346 $VAR environment variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1347
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1348 The String value of any environment variable. When it is not defined, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1349 result is an empty string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1350 *expr-env-expand*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1351 Note that there is a difference between using $VAR directly and using
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1352 expand("$VAR"). Using it directly will only expand environment variables that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1353 are known inside the current Vim session. Using expand() will first try using
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1354 the environment variables known inside the current Vim session. If that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1355 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
1356 does expand all variables that the shell knows about. Example: >
6180
6921742f396a Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6153
diff changeset
1357 :echo $shell
6921742f396a Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6153
diff changeset
1358 :echo expand("$shell")
6921742f396a Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6153
diff changeset
1359 The first one probably doesn't echo anything, the second echoes the $shell
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1360 variable (if your shell supports it).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1361
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1362
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1363 internal variable *expr-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1364 -----------------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1365 variable internal variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1366 See below |internal-variables|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1367
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1368
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
1369 function call *expr-function* *E116* *E118* *E119* *E120*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1370 -------------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1371 function(expr1, ...) function call
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1372 See below |functions|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1373
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1374
9527
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1375 lambda expression *expr-lambda* *lambda*
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1376 -----------------
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1377 {args -> expr1} lambda expression
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1378
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1379 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
1380 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
1381 the following ways:
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1382
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1383 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
1384 commands.
9686
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
1385 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
1386 :let F = {arg1, arg2 -> arg1 - arg2}
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1387 :echo F(5, 2)
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1388 < 3
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1389
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1390 The arguments are optional. Example: >
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1391 :let F = {-> 'error function'}
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1392 :echo F()
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1393 < error function
9686
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
1394 *closure*
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
1395 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
1396 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
1397 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
1398 the function returns: >
9686
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
1399 :function Foo(arg)
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
1400 : let i = 3
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
1401 : return {x -> x + i - a:arg}
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
1402 :endfunction
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
1403 :let Bar = Foo(4)
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
1404 :echo Bar(6)
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
1405 < 5
9723
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
1406
13329
424321d6eea7 patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents: 13298
diff changeset
1407 Note that the variables must exist in the outer scope before the lamba is
424321d6eea7 patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents: 13298
diff changeset
1408 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
1409
424321d6eea7 patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents: 13298
diff changeset
1410 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
1411 if has('lambda')
9527
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1412
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1413 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
1414 :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
1415 < [2, 3, 4] >
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1416 :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
1417 < [1, 2, 3, 4, 7]
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1418
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1419 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
1420 :let timer = timer_start(500,
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1421 \ {-> execute("echo 'Handler called'", "")},
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1422 \ {'repeat': 3})
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1423 < Handler called
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1424 Handler called
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1425 Handler called
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1426
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1427 Note how execute() is used to execute an Ex command. That's ugly though.
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
1428
9686
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
1429
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
1430 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
1431 for a lambda expression, you can find what it is with the following command: >
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
1432 :function {'<lambda>42'}
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
1433 See also: |numbered-function|
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
1434
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1435 ==============================================================================
2596
fae782ef63dd Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2581
diff changeset
1436 3. Internal variable *internal-variables* *E461*
fae782ef63dd Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2581
diff changeset
1437
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1438 An internal variable name can be made up of letters, digits and '_'. But it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1439 cannot start with a digit. It's also possible to use curly braces, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1440 |curly-braces-names|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1441
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1442 An internal variable is created with the ":let" command |:let|.
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
1443 An internal variable is explicitly destroyed with the ":unlet" command
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
1444 |:unlet|.
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
1445 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
1446 been destroyed results in an error.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1447
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1448 There are several name spaces for variables. Which one is to be used is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1449 specified by what is prepended:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1450
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1451 (nothing) In a function: local to a function; otherwise: global
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1452 |buffer-variable| b: Local to the current buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1453 |window-variable| w: Local to the current window.
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
1454 |tabpage-variable| t: Local to the current tab page.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1455 |global-variable| g: Global.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1456 |local-variable| l: Local to a function.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1457 |script-variable| s: Local to a |:source|'ed Vim script.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1458 |function-argument| a: Function argument (only inside a function).
5815
d735e62f5925 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5814
diff changeset
1459 |vim-variable| v: Global, predefined by Vim.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1460
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1461 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
1462 delete all script-local variables: >
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
1463 :for k in keys(s:)
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
1464 : unlet s:[k]
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
1465 :endfor
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
1466 <
4358
cf1d93a3914a Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4354
diff changeset
1467 *buffer-variable* *b:var* *b:*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1468 A variable name that is preceded with "b:" is local to the current buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1469 Thus you can have several "b:foo" variables, one for each buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1470 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
1471 |:bdelete|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1472
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1473 One local buffer variable is predefined:
4264
2d1383658bb4 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4229
diff changeset
1474 *b:changedtick* *changetick*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1475 b:changedtick The total number of changes to the current buffer. It is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1476 incremented for each change. An undo command is also a change
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1477 in this case. This can be used to perform an action only when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1478 the buffer has changed. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1479 :if my_changedtick != b:changedtick
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1480 : let my_changedtick = b:changedtick
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1481 : call My_Update()
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1482 :endif
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10787
diff changeset
1483 < You cannot change or delete the b:changedtick variable.
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10787
diff changeset
1484
4358
cf1d93a3914a Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4354
diff changeset
1485 *window-variable* *w:var* *w:*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1486 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
1487 is deleted when the window is closed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1488
4437
eb6ab7e78925 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4358
diff changeset
1489 *tabpage-variable* *t:var* *t:*
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
1490 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
1491 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
1492 without the |+windows| feature}
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
1493
4358
cf1d93a3914a Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4354
diff changeset
1494 *global-variable* *g:var* *g:*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1495 Inside functions global variables are accessed with "g:". Omitting this will
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
1496 access a variable local to a function. But "g:" can also be used in any other
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1497 place if you like.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1498
4358
cf1d93a3914a Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4354
diff changeset
1499 *local-variable* *l:var* *l:*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1500 Inside functions local variables are accessed without prepending anything.
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
1501 But you can also prepend "l:" if you like. However, without prepending "l:"
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
1502 you may run into reserved variable names. For example "count". By itself it
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
1503 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
1504 same name.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1505
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1506 *script-variable* *s:var*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1507 In a Vim script variables starting with "s:" can be used. They cannot be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1508 accessed from outside of the scripts, thus are local to the script.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1509
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1510 They can be used in:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1511 - commands executed while the script is sourced
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1512 - functions defined in the script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1513 - autocommands defined in the script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1514 - functions and autocommands defined in functions and autocommands which were
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1515 defined in the script (recursively)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1516 - user defined commands defined in the script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1517 Thus not in:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1518 - other scripts sourced from this one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1519 - mappings
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
1520 - menus
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1521 - etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1522
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
1523 Script variables can be used to avoid conflicts with global variable names.
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
1524 Take this example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1525
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1526 let s:counter = 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1527 function MyCounter()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1528 let s:counter = s:counter + 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1529 echo s:counter
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1530 endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1531 command Tick call MyCounter()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1532
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1533 You can now invoke "Tick" from any script, and the "s:counter" variable in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1534 that script will not be changed, only the "s:counter" in the script where
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1535 "Tick" was defined is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1536
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1537 Another example that does the same: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1538
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1539 let s:counter = 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1540 command Tick let s:counter = s:counter + 1 | echo s:counter
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1541
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1542 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
1543 script variables is set to the script where the function or command was
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1544 defined.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1545
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1546 The script variables are also available when a function is defined inside a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1547 function that is defined in a script. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1548
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1549 let s:counter = 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1550 function StartCounting(incr)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1551 if a:incr
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1552 function MyCounter()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1553 let s:counter = s:counter + 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1554 endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1555 else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1556 function MyCounter()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1557 let s:counter = s:counter - 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1558 endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1559 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1560 endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1561
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1562 This defines the MyCounter() function either for counting up or counting down
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1563 when calling StartCounting(). It doesn't matter from where StartCounting() is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1564 called, the s:counter variable will be accessible in MyCounter().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1565
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1566 When the same script is sourced again it will use the same script variables.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1567 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
1568 maintain a counter: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1569
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1570 if !exists("s:counter")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1571 let s:counter = 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1572 echo "script executed for the first time"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1573 else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1574 let s:counter = s:counter + 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1575 echo "script executed " . s:counter . " times now"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1576 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1577
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1578 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
1579 variables for each buffer. Use local buffer variables instead |b:var|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1580
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1581
15131
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15062
diff changeset
1582 PREDEFINED VIM VARIABLES *vim-variable* *v:var* *v:*
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15062
diff changeset
1583 *E963*
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15062
diff changeset
1584 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
1585
189
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1586 *v:beval_col* *beval_col-variable*
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1587 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
1588 This is the byte index in the |v:beval_lnum| line.
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1589 Only valid while evaluating the 'balloonexpr' option.
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1590
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1591 *v:beval_bufnr* *beval_bufnr-variable*
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1592 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
1593 valid while evaluating the 'balloonexpr' option.
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1594
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1595 *v:beval_lnum* *beval_lnum-variable*
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1596 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
1597 valid while evaluating the 'balloonexpr' option.
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1598
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1599 *v:beval_text* *beval_text-variable*
374
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
1600 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
1601 it is useful for debugging a C program. 'iskeyword' applies,
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
1602 but a dot and "->" before the position is included. When on a
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
1603 ']' the text before it is used, including the matching '[' and
189
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1604 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
1605 highlighted text is used. Also see |<cexpr>|.
189
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1606 Only valid while evaluating the 'balloonexpr' option.
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1607
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1608 *v:beval_winnr* *beval_winnr-variable*
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1609 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
1610 valid while evaluating the 'balloonexpr' option. The first
b01a37ab556b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2698
diff changeset
1611 window has number zero (unlike most other places where a
b01a37ab556b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2698
diff changeset
1612 window gets a number).
189
504c627f7474 updated for version 7.0057
vimboss
parents: 179
diff changeset
1613
9221
17fa362f10be commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents: 9219
diff changeset
1614 *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
1615 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
1616 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
1617
844
d3bbb5dd3913 updated for version 7.0f02
vimboss
parents: 843
diff changeset
1618 *v:char* *char-variable*
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
1619 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
1620 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
1621 It is also used by the |InsertCharPre| and |InsertEnter| events.
844
d3bbb5dd3913 updated for version 7.0f02
vimboss
parents: 843
diff changeset
1622
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1623 *v:charconvert_from* *charconvert_from-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1624 v:charconvert_from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1625 The name of the character encoding of a file to be converted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1626 Only valid while evaluating the 'charconvert' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1627
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1628 *v:charconvert_to* *charconvert_to-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1629 v:charconvert_to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1630 The name of the character encoding of a file after conversion.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1631 Only valid while evaluating the 'charconvert' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1632
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1633 *v:cmdarg* *cmdarg-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1634 v:cmdarg This variable is used for two purposes:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1635 1. The extra arguments given to a file read/write command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1636 Currently these are "++enc=" and "++ff=". This variable is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1637 set before an autocommand event for a file read/write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1638 command is triggered. There is a leading space to make it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1639 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
1640 read/write command. Note: The "+cmd" argument isn't
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1641 included here, because it will be executed anyway.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1642 2. When printing a PostScript file with ":hardcopy" this is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1643 the argument for the ":hardcopy" command. This can be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1644 in 'printexpr'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1645
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1646 *v:cmdbang* *cmdbang-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1647 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1648 was used the value is 1, otherwise it is 0. Note that this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1649 can only be used in autocommands. For user commands |<bang>|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1650 can be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1651
6909
676906c33768 patch 7.4.774
Bram Moolenaar <bram@vim.org>
parents: 6884
diff changeset
1652 *v:completed_item* *completed_item-variable*
676906c33768 patch 7.4.774
Bram Moolenaar <bram@vim.org>
parents: 6884
diff changeset
1653 v:completed_item
676906c33768 patch 7.4.774
Bram Moolenaar <bram@vim.org>
parents: 6884
diff changeset
1654 |Dictionary| containing the |complete-items| for the most
676906c33768 patch 7.4.774
Bram Moolenaar <bram@vim.org>
parents: 6884
diff changeset
1655 recently completed word after |CompleteDone|. The
676906c33768 patch 7.4.774
Bram Moolenaar <bram@vim.org>
parents: 6884
diff changeset
1656 |Dictionary| is empty if the completion failed.
676906c33768 patch 7.4.774
Bram Moolenaar <bram@vim.org>
parents: 6884
diff changeset
1657
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1658 *v:count* *count-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1659 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
1660 to get the count before a mapping. Read-only. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1661 :map _x :<C-U>echo "the count is " . v:count<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1662 < Note: The <C-U> is required to remove the line range that you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1663 get when typing ':' after a count.
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
1664 When there are two counts, as in "3d2w", they are multiplied,
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
1665 just like what happens in the command, "d6w" for the example.
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
1666 Also used for evaluating the 'formatexpr' option.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1667 "count" also works, for backwards compatibility.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1668
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1669 *v:count1* *count1-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1670 v:count1 Just like "v:count", but defaults to one when no count is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1671 used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1672
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1673 *v:ctype* *ctype-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1674 v:ctype The current locale setting for characters of the runtime
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1675 environment. This allows Vim scripts to be aware of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1676 current locale encoding. Technical: it's the value of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1677 LC_CTYPE. When not using a locale the value is "C".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1678 This variable can not be set directly, use the |:language|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1679 command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1680 See |multi-lang|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1681
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1682 *v:dying* *dying-variable*
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
1683 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
1684 one. When multiple signals are caught the number increases.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1685 Can be used in an autocommand to check if Vim didn't
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1686 terminate normally. {only works on Unix}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1687 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1688 :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
1689 < 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
1690 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
1691
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1692 *v:errmsg* *errmsg-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1693 v:errmsg Last given error message. It's allowed to set this variable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1694 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1695 :let v:errmsg = ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1696 :silent! next
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1697 :if v:errmsg != ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1698 : ... handle error
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1699 < "errmsg" also works, for backwards compatibility.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1700
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
1701 *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
1702 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
1703 This is a list of strings.
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
1704 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
1705 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
1706 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
1707 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
1708 :let v:errors = []
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
1709 < 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
1710 list by the assert function.
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
1711
13037
6e81a68d63a1 patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents: 13026
diff changeset
1712 *v:event* *event-variable*
6e81a68d63a1 patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents: 13026
diff changeset
1713 v:event Dictionary containing information about the current
6e81a68d63a1 patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents: 13026
diff changeset
1714 |autocommand|. The dictionary is emptied when the |autocommand|
6e81a68d63a1 patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents: 13026
diff changeset
1715 finishes, please refer to |dict-identity| for how to get an
6e81a68d63a1 patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents: 13026
diff changeset
1716 independent copy of it.
6e81a68d63a1 patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents: 13026
diff changeset
1717
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1718 *v:exception* *exception-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1719 v:exception The value of the exception most recently caught and not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1720 finished. See also |v:throwpoint| and |throw-variables|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1721 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1722 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1723 : throw "oops"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1724 :catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1725 : echo "caught" v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1726 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1727 < Output: "caught oops".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1728
7712
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
1729 *v:false* *false-variable*
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
1730 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
1731 |json_encode()|.
9286
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9223
diff changeset
1732 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
1733 echo v:false
9286
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9223
diff changeset
1734 < v:false ~
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9223
diff changeset
1735 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
1736 value. Read-only.
7712
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
1737
179
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1738 *v:fcs_reason* *fcs_reason-variable*
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1739 v:fcs_reason The reason why the |FileChangedShell| event was triggered.
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1740 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
1741 to set v:fcs_choice to. Possible values:
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1742 deleted file no longer exists
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1743 conflict file contents, mode or timestamp was
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1744 changed and buffer is modified
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1745 changed file contents has changed
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1746 mode mode of file changed
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1747 time only file timestamp changed
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1748
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1749 *v:fcs_choice* *fcs_choice-variable*
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1750 v:fcs_choice What should happen after a |FileChangedShell| event was
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1751 triggered. Can be used in an autocommand to tell Vim what to
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1752 do with the affected buffer:
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1753 reload Reload the buffer (does not work if
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1754 the file was deleted).
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1755 ask Ask the user what to do, as if there
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1756 was no autocommand. Except that when
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1757 only the timestamp changed nothing
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1758 will happen.
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1759 <empty> Nothing, the autocommand should do
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1760 everything that needs to be done.
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1761 The default is empty. If another (invalid) value is used then
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1762 Vim behaves like it is empty, there is no warning message.
7fd70926e2e1 updated for version 7.0055
vimboss
parents: 170
diff changeset
1763
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1764 *v:fname_in* *fname_in-variable*
579
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
1765 v:fname_in The name of the input file. Valid while evaluating:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1766 option used for ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1767 'charconvert' file to be converted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1768 'diffexpr' original file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1769 'patchexpr' original file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1770 'printexpr' file to be printed
593
d220eb88e4e4 updated for version 7.0168
vimboss
parents: 590
diff changeset
1771 And set to the swap file name for |SwapExists|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1772
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1773 *v:fname_out* *fname_out-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1774 v:fname_out The name of the output file. Only valid while
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1775 evaluating:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1776 option used for ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1777 'charconvert' resulting converted file (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1778 'diffexpr' output of diff
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1779 'patchexpr' resulting patched file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1780 (*) 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
1781 file") it will be equal to v:fname_in. When doing conversion
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1782 for a read command (e.g., ":e file") it will be a temporary
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1783 file and different from v:fname_in.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1784
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1785 *v:fname_new* *fname_new-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1786 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
1787 evaluating 'diffexpr'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1788
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1789 *v:fname_diff* *fname_diff-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1790 v:fname_diff The name of the diff (patch) file. Only valid while
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1791 evaluating 'patchexpr'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1792
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1793 *v:folddashes* *folddashes-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1794 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1795 fold.
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1796 Read-only in the |sandbox|. |fold-foldtext|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1797
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1798 *v:foldlevel* *foldlevel-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1799 v:foldlevel Used for 'foldtext': foldlevel of closed fold.
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1800 Read-only in the |sandbox|. |fold-foldtext|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1801
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1802 *v:foldend* *foldend-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1803 v:foldend Used for 'foldtext': last line of closed fold.
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1804 Read-only in the |sandbox|. |fold-foldtext|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1805
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1806 *v:foldstart* *foldstart-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1807 v:foldstart Used for 'foldtext': first line of closed fold.
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
1808 Read-only in the |sandbox|. |fold-foldtext|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1809
5460
c5166fa10464 updated for version 7.4.080
Bram Moolenaar <bram@vim.org>
parents: 5425
diff changeset
1810 *v:hlsearch* *hlsearch-variable*
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
1811 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
1812 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
1813 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
1814 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
1815 let &hlsearch = &hlsearch
6918
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
1816 < Note that the value is restored when returning from a
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
1817 function. |function-search-undo|.
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
1818
11
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
1819 *v:insertmode* *insertmode-variable*
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
1820 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
1821 events. Values:
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
1822 i Insert mode
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
1823 r Replace mode
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
1824 v Virtual Replace mode
4424b47a0797 updated for version 7.0003
vimboss
parents: 10
diff changeset
1825
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1826 *v:key* *key-variable*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
1827 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
1828 evaluating the expression used with |map()| and |filter()|.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1829 Read-only.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
1830
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1831 *v:lang* *lang-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1832 v:lang The current locale setting for messages of the runtime
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1833 environment. This allows Vim scripts to be aware of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1834 current language. Technical: it's the value of LC_MESSAGES.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1835 The value is system dependent.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1836 This variable can not be set directly, use the |:language|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1837 command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1838 It can be different from |v:ctype| when messages are desired
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1839 in a different language than what is used for character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1840 encoding. See |multi-lang|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1841
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1842 *v:lc_time* *lc_time-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1843 v:lc_time The current locale setting for time messages of the runtime
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1844 environment. This allows Vim scripts to be aware of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1845 current language. Technical: it's the value of LC_TIME.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1846 This variable can not be set directly, use the |:language|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1847 command. See |multi-lang|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1848
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1849 *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
1850 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
1851 '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
1852 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
1853 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
1854 |sandbox|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1855
1029
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
1856 *v:mouse_win* *mouse_win-variable*
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
1857 v:mouse_win Window number for a mouse click obtained with |getchar()|.
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
1858 First window has number 1, like with |winnr()|. The value is
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
1859 zero when there was no mouse button click.
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
1860
9221
17fa362f10be commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents: 9219
diff changeset
1861 *v:mouse_winid* *mouse_winid-variable*
17fa362f10be commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents: 9219
diff changeset
1862 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
1863 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
1864
1029
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
1865 *v:mouse_lnum* *mouse_lnum-variable*
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
1866 v:mouse_lnum Line number for a mouse click obtained with |getchar()|.
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
1867 This is the text line number, not the screen line number. The
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
1868 value is zero when there was no mouse button click.
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
1869
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
1870 *v:mouse_col* *mouse_col-variable*
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
1871 v:mouse_col Column number for a mouse click obtained with |getchar()|.
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
1872 This is the screen column number, like with |virtcol()|. The
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
1873 value is zero when there was no mouse button click.
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
1874
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
1875 *v:none* *none-variable* *None*
7712
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
1876 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
1877 |json_encode()|.
7742
5f6f35a3cb12 commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents: 7712
diff changeset
1878 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
1879 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
1880 echo v:none
9286
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9223
diff changeset
1881 < v:none ~
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9223
diff changeset
1882 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
1883 value. Read-only.
7712
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
1884
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
1885 *v:null* *null-variable*
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
1886 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
1887 |json_encode()|.
7742
5f6f35a3cb12 commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents: 7712
diff changeset
1888 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
1889 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
1890 echo v:null
9286
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9223
diff changeset
1891 < v:null ~
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9223
diff changeset
1892 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
1893 value. Read-only.
7712
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
1894
1733
5a7384b9ca66 updated for version 7.2-031
vimboss
parents: 1702
diff changeset
1895 *v:oldfiles* *oldfiles-variable*
5a7384b9ca66 updated for version 7.2-031
vimboss
parents: 1702
diff changeset
1896 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
1897 startup. These are the files that Vim remembers marks for.
5a7384b9ca66 updated for version 7.2-031
vimboss
parents: 1702
diff changeset
1898 The length of the List is limited by the ' argument of the
5a7384b9ca66 updated for version 7.2-031
vimboss
parents: 1702
diff changeset
1899 'viminfo' option (default is 100).
5618
350272cbf1fd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5596
diff changeset
1900 When the |viminfo| file is not used the List is empty.
1733
5a7384b9ca66 updated for version 7.2-031
vimboss
parents: 1702
diff changeset
1901 Also see |:oldfiles| and |c_#<|.
5a7384b9ca66 updated for version 7.2-031
vimboss
parents: 1702
diff changeset
1902 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
1903 stored in the |viminfo| file later. If you use values other
5a7384b9ca66 updated for version 7.2-031
vimboss
parents: 1702
diff changeset
1904 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
1905 {only when compiled with the |+viminfo| feature}
1733
5a7384b9ca66 updated for version 7.2-031
vimboss
parents: 1702
diff changeset
1906
6935
4db70c94226b patch 7.4.786
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
1907 *v:option_new*
4db70c94226b patch 7.4.786
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
1908 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
1909 autocommand.
4db70c94226b patch 7.4.786
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
1910 *v:option_old*
4db70c94226b patch 7.4.786
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
1911 v:option_old Old value of the option. Valid while executing an |OptionSet|
4db70c94226b patch 7.4.786
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
1912 autocommand.
4db70c94226b patch 7.4.786
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
1913 *v:option_type*
4db70c94226b patch 7.4.786
Bram Moolenaar <bram@vim.org>
parents: 6918
diff changeset
1914 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
1915 |OptionSet| autocommand. Can be either "global" or "local"
1490
0f3f3090491f updated for version 7.1-205
vimboss
parents: 1405
diff changeset
1916 *v:operator* *operator-variable*
0f3f3090491f updated for version 7.1-205
vimboss
parents: 1405
diff changeset
1917 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
1918 character except for commands starting with <g> or <z>,
0f3f3090491f updated for version 7.1-205
vimboss
parents: 1405
diff changeset
1919 in which case it is two characters. Best used alongside
0f3f3090491f updated for version 7.1-205
vimboss
parents: 1405
diff changeset
1920 |v:prevcount| and |v:register|. Useful if you want to cancel
0f3f3090491f updated for version 7.1-205
vimboss
parents: 1405
diff changeset
1921 Operator-pending mode and then use the operator, e.g.: >
0f3f3090491f updated for version 7.1-205
vimboss
parents: 1405
diff changeset
1922 :omap O <Esc>:call MyMotion(v:operator)<CR>
0f3f3090491f updated for version 7.1-205
vimboss
parents: 1405
diff changeset
1923 < The value remains set until another operator is entered, thus
0f3f3090491f updated for version 7.1-205
vimboss
parents: 1405
diff changeset
1924 don't expect it to be empty.
0f3f3090491f updated for version 7.1-205
vimboss
parents: 1405
diff changeset
1925 v:operator is not set for |:delete|, |:yank| or other Ex
0f3f3090491f updated for version 7.1-205
vimboss
parents: 1405
diff changeset
1926 commands.
0f3f3090491f updated for version 7.1-205
vimboss
parents: 1405
diff changeset
1927 Read-only.
0f3f3090491f updated for version 7.1-205
vimboss
parents: 1405
diff changeset
1928
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1929 *v:prevcount* *prevcount-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1930 v:prevcount The count given for the last but one Normal mode command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1931 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
1932 you want to cancel Visual or Operator-pending mode and then
0f3f3090491f updated for version 7.1-205
vimboss
parents: 1405
diff changeset
1933 use the count, e.g.: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1934 :vmap % <Esc>:call MyFilter(v:prevcount)<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1935 < Read-only.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1936
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
1937 *v:profiling* *profiling-variable*
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
1938 v:profiling Normally zero. Set to one after using ":profile start".
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
1939 See |profiling|.
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
1940
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1941 *v:progname* *progname-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1942 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
1943 invoked. Allows you to do special initialisations for |view|,
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
1944 |evim| etc., or any other name you might symlink to Vim.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1945 Read-only.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1946
5780
d2286df8719d updated for version 7.4.234
Bram Moolenaar <bram@vim.org>
parents: 5763
diff changeset
1947 *v:progpath* *progpath-variable*
d2286df8719d updated for version 7.4.234
Bram Moolenaar <bram@vim.org>
parents: 5763
diff changeset
1948 v:progpath Contains the command with which Vim was invoked, including the
d2286df8719d updated for version 7.4.234
Bram Moolenaar <bram@vim.org>
parents: 5763
diff changeset
1949 path. Useful if you want to message a Vim server using a
d2286df8719d updated for version 7.4.234
Bram Moolenaar <bram@vim.org>
parents: 5763
diff changeset
1950 |--remote-expr|.
5782
5ab2946f7ce5 updated for version 7.4.235
Bram Moolenaar <bram@vim.org>
parents: 5780
diff changeset
1951 To get the full path use: >
5ab2946f7ce5 updated for version 7.4.235
Bram Moolenaar <bram@vim.org>
parents: 5780
diff changeset
1952 echo exepath(v:progpath)
11032
516391d8865f patch 8.0.0405: v:progpath may become invalid after :cd
Christian Brabandt <cb@256bit.org>
parents: 11014
diff changeset
1953 < If the path is relative it will be expanded to the full path,
516391d8865f patch 8.0.0405: v:progpath may become invalid after :cd
Christian Brabandt <cb@256bit.org>
parents: 11014
diff changeset
1954 so that it still works after `:cd`. Thus starting "./vim"
516391d8865f patch 8.0.0405: v:progpath may become invalid after :cd
Christian Brabandt <cb@256bit.org>
parents: 11014
diff changeset
1955 results in "/home/user/path/to/vim/src/vim".
516391d8865f patch 8.0.0405: v:progpath may become invalid after :cd
Christian Brabandt <cb@256bit.org>
parents: 11014
diff changeset
1956 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
1957 ".exe" is not added to v:progpath.
5780
d2286df8719d updated for version 7.4.234
Bram Moolenaar <bram@vim.org>
parents: 5763
diff changeset
1958 Read-only.
d2286df8719d updated for version 7.4.234
Bram Moolenaar <bram@vim.org>
parents: 5763
diff changeset
1959
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1960 *v:register* *register-variable*
2698
b6471224d2af Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2681
diff changeset
1961 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
1962 command (regardless of whether that command actually used a
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
1963 register). Or for the currently executing normal mode mapping
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
1964 (use this in custom commands that take a register).
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
1965 If none is supplied it is the default register '"', unless
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
1966 'clipboard' contains "unnamed" or "unnamedplus", then it is
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
1967 '*' or '+'.
2698
b6471224d2af Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2681
diff changeset
1968 Also see |getreg()| and |setreg()|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1969
540
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 537
diff changeset
1970 *v:scrollstart* *scrollstart-variable*
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 537
diff changeset
1971 v:scrollstart String describing the script or function that caused the
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 537
diff changeset
1972 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
1973 first reason is remembered. It is set to "Unknown" for a
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 537
diff changeset
1974 typed command.
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 537
diff changeset
1975 This can be used to find out why your script causes the
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 537
diff changeset
1976 hit-enter prompt.
2df7f3a5eb96 updated for version 7.0153
vimboss
parents: 537
diff changeset
1977
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1978 *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
1979 v:servername The resulting registered |client-server-name| if any.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1980 Read-only.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1981
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
1982
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1983 v:searchforward *v:searchforward* *searchforward-variable*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1984 Search direction: 1 after a forward search, 0 after a
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1985 backward search. It is reset to forward when directly setting
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1986 the last search pattern, see |quote/|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1987 Note that the value is restored when returning from a
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1988 function. |function-search-undo|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1989 Read-write.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
1990
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1991 *v:shell_error* *shell_error-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1992 v:shell_error Result of the last shell command. When non-zero, the last
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1993 shell command had an error. When zero, there was no problem.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1994 This only works when the shell returns the error code to Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1995 The value -1 is often used when the command could not be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1996 executed. Read-only.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1997 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1998 :!mv foo bar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1999 :if v:shell_error
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2000 : echo 'could not rename "foo" to "bar"!'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2001 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2002 < "shell_error" also works, for backwards compatibility.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2003
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2004 *v:statusmsg* *statusmsg-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2005 v:statusmsg Last given status message. It's allowed to set this variable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2006
579
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2007 *v:swapname* *swapname-variable*
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2008 v:swapname Only valid when executing |SwapExists| autocommands: Name of
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2009 the swap file found. Read-only.
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2010
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2011 *v:swapchoice* *swapchoice-variable*
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2012 v:swapchoice |SwapExists| autocommands can set this to the selected choice
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2013 for handling an existing swap file:
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2014 'o' Open read-only
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2015 'e' Edit anyway
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2016 'r' Recover
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2017 'd' Delete swapfile
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2018 'q' Quit
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2019 'a' Abort
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
2020 The value should be a single-character string. An empty value
579
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2021 results in the user being asked, as would happen when there is
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2022 no SwapExists autocommand. The default is empty.
1ef373b13126 updated for version 7.0164
vimboss
parents: 574
diff changeset
2023
590
de152391f6f9 updated for version 7.0167
vimboss
parents: 579
diff changeset
2024 *v:swapcommand* *swapcommand-variable*
625
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 620
diff changeset
2025 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
2026 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
2027 another Vim open the file and jump to the right place. For
590
de152391f6f9 updated for version 7.0167
vimboss
parents: 579
diff changeset
2028 example, when jumping to a tag the value is ":tag tagname\r".
716
8ae24f338cab updated for version 7.0217
vimboss
parents: 714
diff changeset
2029 For ":edit +cmd file" the value is ":cmd\r".
590
de152391f6f9 updated for version 7.0167
vimboss
parents: 579
diff changeset
2030
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
2031 *v:t_TYPE* *v:t_bool* *t_bool-variable*
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
2032 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
2033 *v:t_channel* *t_channel-variable*
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
2034 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
2035 *v:t_dict* *t_dict-variable*
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
2036 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
2037 *v:t_float* *t_float-variable*
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
2038 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
2039 *v:t_func* *t_func-variable*
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
2040 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
2041 *v:t_job* *t_job-variable*
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
2042 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
2043 *v:t_list* *t_list-variable*
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
2044 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
2045 *v:t_none* *t_none-variable*
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
2046 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
2047 *v:t_number* *t_number-variable*
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
2048 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
2049 *v:t_string* *t_string-variable*
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
2050 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
2051 *v:t_blob* *t_blob-variable*
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
2052 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
2053
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2054 *v:termresponse* *termresponse-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2055 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
2056 termcap entry. It is set when Vim receives an escape sequence
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2057 that starts with ESC [ or CSI and ends in a 'c', with only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2058 digits, ';' and '.' in between.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2059 When this option is set, the TermResponse autocommand event is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2060 fired, so that you can react to the response from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2061 terminal.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2062 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2063 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2064 patch level (since this was introduced in patch 95, it's
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2065 always 95 or bigger). Pc is always zero.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2066 {only when compiled with |+termresponse| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2067
12273
c952a6af25e0 patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents: 12254
diff changeset
2068 *v:termblinkresp*
c952a6af25e0 patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents: 12254
diff changeset
2069 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
2070 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
2071 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
2072
c952a6af25e0 patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents: 12254
diff changeset
2073 *v:termstyleresp*
c952a6af25e0 patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents: 12254
diff changeset
2074 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
2075 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
2076 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
2077
12632
b1a7e3968a31 patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents: 12499
diff changeset
2078 *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
2079 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
2080 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
2081 background color is, see 'background'.
c952a6af25e0 patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents: 12254
diff changeset
2082
12632
b1a7e3968a31 patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents: 12499
diff changeset
2083 *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
2084 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
2085 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
2086 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
2087
12273
c952a6af25e0 patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents: 12254
diff changeset
2088 *v:termu7resp*
c952a6af25e0 patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents: 12254
diff changeset
2089 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
2090 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
2091 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
2092
8881
ed0b39dd7fd6 commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents: 8876
diff changeset
2093 *v:testing* *testing-variable*
9121
7350959e53c3 commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents: 9117
diff changeset
2094 v:testing Must be set before using `test_garbagecollect_now()`.
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11105
diff changeset
2095 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
2096 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
2097
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2098 *v:this_session* *this_session-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2099 v:this_session Full filename of the last loaded or saved session file. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2100 |:mksession|. It is allowed to set this variable. When no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2101 session file has been saved, this variable is empty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2102 "this_session" also works, for backwards compatibility.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2103
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2104 *v:throwpoint* *throwpoint-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2105 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
2106 finished was thrown. Not set when commands are typed. See
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2107 also |v:exception| and |throw-variables|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2108 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2109 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2110 : throw "oops"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2111 :catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2112 : echo "Exception from" v:throwpoint
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2113 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2114 < Output: "Exception from test.vim, line 2"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2115
7712
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
2116 *v:true* *true-variable*
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
2117 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
2118 |json_encode()|.
9286
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9223
diff changeset
2119 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
2120 echo v:true
9286
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9223
diff changeset
2121 < v:true ~
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9223
diff changeset
2122 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
2123 value. Read-only.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2124 *v:val* *val-variable*
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
2125 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
2126 valid while evaluating the expression used with |map()| and
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2127 |filter()|. Read-only.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2128
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2129 *v:version* *version-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2130 v:version Version number of Vim: Major version number times 100 plus
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2131 minor version number. Version 5.0 is 500. Version 5.1 (5.01)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2132 is 501. Read-only. "version" also works, for backwards
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2133 compatibility.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2134 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
2135 if has("patch-7.4.123")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2136 < Note that patch numbers are specific to the version, thus both
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2137 version 5.0 and 5.1 may have a patch 123, but these are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2138 completely different.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2139
8738
e770986c855a commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents: 8669
diff changeset
2140 *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
2141 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
2142 before |VimEnter| autocommands are triggered.
e770986c855a commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents: 8669
diff changeset
2143
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2144 *v:warningmsg* *warningmsg-variable*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2145 v:warningmsg Last given warning message. It's allowed to set this variable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2146
2609
758822790b43 updated for version 7.3.031
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
2147 *v:windowid* *windowid-variable*
758822790b43 updated for version 7.3.031
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
2148 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
2149 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
2150 set to the window ID.
73d947c20291 updated for version 7.3.038
Bram Moolenaar <bram@vim.org>
parents: 2610
diff changeset
2151 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
2152 window handle.
73d947c20291 updated for version 7.3.038
Bram Moolenaar <bram@vim.org>
parents: 2610
diff changeset
2153 Otherwise the value is zero.
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
2154 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
2155 see |window-ID|.
2609
758822790b43 updated for version 7.3.031
Bram Moolenaar <bram@vim.org>
parents: 2608
diff changeset
2156
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2157 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2158 4. Builtin Functions *functions*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2159
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2160 See |function-list| for a list grouped by what the function is used for.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2161
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
2162 (Use CTRL-] on the function name to jump to the full explanation.)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2163
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2164 USAGE RESULT DESCRIPTION ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2165
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2166 abs({expr}) Float or Number absolute value of {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2167 acos({expr}) Float arc cosine of {expr}
15498
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
2168 add({object}, {item}) List/Blob append {item} to {object}
9536
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2169 and({expr}, {expr}) Number bitwise AND
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
2170 append({lnum}, {text}) Number append {text} below line {lnum}
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
2171 appendbufline({expr}, {lnum}, {text})
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
2172 Number append {text} below line {lnum}
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
2173 in buffer {expr}
15033
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15016
diff changeset
2174 argc([{winid}]) Number number of files in the argument list
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2175 argidx() Number current index in the argument list
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2176 arglistid([{winnr} [, {tabnr}]]) Number argument list id
14964
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2177 argv({nr} [, {winid}]) String {nr} entry of the argument list
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2178 argv([-1, {winid}]) List the argument list
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2179 assert_beeps({cmd}) Number assert {cmd} causes a beep
11181
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
2180 assert_equal({exp}, {act} [, {msg}])
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2181 Number assert {exp} is equal to {act}
13298
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
2182 assert_equalfile({fname-one}, {fname-two})
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2183 Number assert file contents is equal
11181
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
2184 assert_exception({error} [, {msg}])
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2185 Number assert {error} is in v:exception
14945
4ee65b4150fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14864
diff changeset
2186 assert_fails({cmd} [, {error} [, {msg}]])
4ee65b4150fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14864
diff changeset
2187 Number assert {cmd} fails
11181
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
2188 assert_false({actual} [, {msg}])
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2189 Number assert {actual} is false
9636
ccbb8e393d80 commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents: 9626
diff changeset
2190 assert_inrange({lower}, {upper}, {actual} [, {msg}])
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2191 Number assert {actual} is inside the range
11181
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
2192 assert_match({pat}, {text} [, {msg}])
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2193 Number assert {pat} matches {text}
11181
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
2194 assert_notequal({exp}, {act} [, {msg}])
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2195 Number assert {exp} is not equal {act}
11181
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
2196 assert_notmatch({pat}, {text} [, {msg}])
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2197 Number assert {pat} not matches {text}
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2198 assert_report({msg}) Number report a test failure
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2199 assert_true({actual} [, {msg}]) Number assert {actual} is true
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2200 asin({expr}) Float arc sine of {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2201 atan({expr}) Float arc tangent of {expr}
10038
7cf4e210cf3c commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents: 10027
diff changeset
2202 atan2({expr1}, {expr2}) Float arc tangent of {expr1} / {expr2}
13016
e47e70300f30 patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents: 12977
diff changeset
2203 balloon_show({expr}) none show {expr} inside the balloon
12883
058e93aee621 patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents: 12857
diff changeset
2204 balloon_split({msg}) List split {msg} as used for a balloon
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2205 browse({save}, {title}, {initdir}, {default})
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2206 String put up a file requester
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2207 browsedir({title}, {initdir}) String put up a directory requester
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2208 bufexists({expr}) Number |TRUE| if buffer {expr} exists
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2209 buflisted({expr}) Number |TRUE| if buffer {expr} is listed
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2210 bufloaded({expr}) Number |TRUE| if buffer {expr} is loaded
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2211 bufname({expr}) String Name of the buffer {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2212 bufnr({expr} [, {create}]) Number Number of the buffer {expr}
9219
7363f5cc4cb8 commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents: 9121
diff changeset
2213 bufwinid({expr}) Number window ID of buffer {expr}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2214 bufwinnr({expr}) Number window number of buffer {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2215 byte2line({byte}) Number line number at byte count {byte}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2216 byteidx({expr}, {nr}) Number byte index of {nr}'th char in {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2217 byteidxcomp({expr}, {nr}) Number byte index of {nr}'th char in {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2218 call({func}, {arglist} [, {dict}])
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
2219 any call {func} with arguments {arglist}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2220 ceil({expr}) Float round {expr} up
10422
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
2221 ch_canread({handle}) Number check if there is something to read
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2222 ch_close({handle}) none close {handle}
10054
d4b7232fc63a commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents: 10051
diff changeset
2223 ch_close_in({handle}) none close in part of {handle}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2224 ch_evalexpr({handle}, {expr} [, {options}])
8440
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
2225 any evaluate {expr} on JSON {handle}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2226 ch_evalraw({handle}, {string} [, {options}])
8440
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
2227 any evaluate {string} on raw {handle}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2228 ch_getbufnr({handle}, {what}) Number get buffer number for {handle}/{what}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2229 ch_getjob({channel}) Job get the Job of {channel}
9536
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2230 ch_info({handle}) String info about channel {handle}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2231 ch_log({msg} [, {handle}]) none write {msg} in the channel log file
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2232 ch_logfile({fname} [, {mode}]) none start logging channel activity
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2233 ch_open({address} [, {options}])
9536
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2234 Channel open a channel to {address}
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2235 ch_read({handle} [, {options}]) String read from {handle}
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
2236 ch_readblob({handle} [, {options}])
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
2237 Blob read Blob from {handle}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2238 ch_readraw({handle} [, {options}])
9536
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2239 String read raw from {handle}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2240 ch_sendexpr({handle}, {expr} [, {options}])
8440
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
2241 any send {expr} over JSON {handle}
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
2242 ch_sendraw({handle}, {expr} [, {options}])
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
2243 any send {expr} over raw {handle}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2244 ch_setoptions({handle}, {options})
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2245 none set options for {handle}
10233
d709622a18c9 commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents: 10228
diff changeset
2246 ch_status({handle} [, {options}])
d709622a18c9 commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents: 10228
diff changeset
2247 String status of channel {handle}
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2248 changenr() Number current change number
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2249 char2nr({expr} [, {utf8}]) Number ASCII/UTF8 value of first char in {expr}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2250 cindent({lnum}) Number C indent for line {lnum}
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
2251 clearmatches() none clear all matches
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2252 col({expr}) Number column nr of cursor or mark
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2253 complete({startcol}, {matches}) none set Insert mode completion
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2254 complete_add({expr}) Number add completion match
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2255 complete_check() Number check for key typed during completion
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2256 confirm({msg} [, {choices} [, {default} [, {type}]]])
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2257 Number number of choice picked by user
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2258 copy({expr}) any make a shallow copy of {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2259 cos({expr}) Float cosine of {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2260 cosh({expr}) Float hyperbolic cosine of {expr}
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
2261 count({comp}, {expr} [, {ic} [, {start}]])
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
2262 Number count how many {expr} are in {comp}
9887
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
2263 cscope_connection([{num}, {dbpath} [, {prepend}]])
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2264 Number checks existence of cscope connection
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2265 cursor({lnum}, {col} [, {off}])
6385
f654ad95fd4e Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6369
diff changeset
2266 Number move cursor to {lnum}, {col}, {off}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2267 cursor({list}) Number move cursor to position in {list}
14147
de75c249723d patch 8.1.0091: MS-Windows: Cannot interrupt gdb when program is running
Christian Brabandt <cb@256bit.org>
parents: 14123
diff changeset
2268 debugbreak({pid}) Number interrupt process being debugged
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2269 deepcopy({expr} [, {noref}]) any make a full copy of {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2270 delete({fname} [, {flags}]) Number delete the file or directory {fname}
14519
5c5908e81e93 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14422
diff changeset
2271 deletebufline({expr}, {first} [, {last}])
14043
cbad3b3f46b2 patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents: 14039
diff changeset
2272 Number delete lines from buffer {expr}
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2273 did_filetype() Number |TRUE| if FileType autocmd event used
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2274 diff_filler({lnum}) Number diff filler lines about {lnum}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2275 diff_hlID({lnum}, {col}) Number diff highlighting at {lnum}/{col}
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2276 empty({expr}) Number |TRUE| if {expr} is empty
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2277 escape({string}, {chars}) String escape {chars} in {string} with '\'
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2278 eval({string}) any evaluate {string} into its value
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2279 eventhandler() Number |TRUE| if inside an event handler
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2280 executable({expr}) Number 1 if executable {expr} exists
9454
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
2281 execute({command}) String execute {command} and get the output
9536
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2282 exepath({expr}) String full path of the command {expr}
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2283 exists({expr}) Number |TRUE| if {expr} exists
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2284 extend({expr1}, {expr2} [, {expr3}])
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
2285 List/Dict insert items of {expr2} into {expr1}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2286 exp({expr}) Float exponential of {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2287 expand({expr} [, {nosuf} [, {list}]])
3398
d1096a4e96bd updated for version 7.3.465
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
2288 any expand special keywords in {expr}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2289 feedkeys({string} [, {mode}]) Number add key sequence to typeahead buffer
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2290 filereadable({file}) Number |TRUE| if {file} is a readable file
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2291 filewritable({file}) Number |TRUE| if {file} is a writable file
10218
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
2292 filter({expr1}, {expr2}) List/Dict remove items from {expr1} where
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
2293 {expr2} is 0
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2294 finddir({name} [, {path} [, {count}]])
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
2295 String find directory {name} in {path}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2296 findfile({name} [, {path} [, {count}]])
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
2297 String find file {name} in {path}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2298 float2nr({expr}) Number convert Float {expr} to a Number
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2299 floor({expr}) Float round {expr} down
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2300 fmod({expr1}, {expr2}) Float remainder of {expr1} / {expr2}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2301 fnameescape({fname}) String escape special characters in {fname}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2302 fnamemodify({fname}, {mods}) String modify file name
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2303 foldclosed({lnum}) Number first line of fold at {lnum} if closed
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2304 foldclosedend({lnum}) Number last line of fold at {lnum} if closed
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2305 foldlevel({lnum}) Number fold level at {lnum}
8148
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
2306 foldtext() String line displayed for closed fold
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2307 foldtextresult({lnum}) String text for closed fold at {lnum}
8148
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
2308 foreground() Number bring the Vim window to the foreground
9723
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
2309 funcref({name} [, {arglist}] [, {dict}])
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
2310 Funcref reference to function {name}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2311 function({name} [, {arglist}] [, {dict}])
9723
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
2312 Funcref named reference to function {name}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2313 garbagecollect([{atexit}]) none free memory, breaking cyclic references
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2314 get({list}, {idx} [, {def}]) any get item {idx} from {list} or {def}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2315 get({dict}, {key} [, {def}]) any get item {key} from {dict} or {def}
9117
0cc48b3cd884 commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents: 9110
diff changeset
2316 get({func}, {what}) any get property of funcref/partial {func}
10218
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
2317 getbufinfo([{expr}]) List information about buffers
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2318 getbufline({expr}, {lnum} [, {end}])
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
2319 List lines {lnum} to {end} of buffer {expr}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2320 getbufvar({expr}, {varname} [, {def}])
4157
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
2321 any variable {varname} in buffer {expr}
13280
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
2322 getchangelist({expr}) List list of change list items
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2323 getchar([expr]) Number get one character from the user
8148
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
2324 getcharmod() Number modifiers for the last typed character
7013
349e6c01f35d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6991
diff changeset
2325 getcharsearch() Dict last character search
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2326 getcmdline() String return the current command-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2327 getcmdpos() Number return cursor position in command-line
6153
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
2328 getcmdtype() String return current command-line type
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
2329 getcmdwintype() String return current command-line window type
9861
74f67cb4f7e1 commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents: 9858
diff changeset
2330 getcompletion({pat}, {type} [, {filtered}])
74f67cb4f7e1 commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents: 9858
diff changeset
2331 List list of cmdline completion matches
5944
332a5c2b2956 updated for version 7.4.313
Bram Moolenaar <bram@vim.org>
parents: 5942
diff changeset
2332 getcurpos() List position of the cursor
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2333 getcwd([{winnr} [, {tabnr}]]) String get the current working directory
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2334 getfontname([{name}]) String name of font being used
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2335 getfperm({fname}) String file permissions of file {fname}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2336 getfsize({fname}) Number size in bytes of file {fname}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2337 getftime({fname}) Number last modification time of file
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2338 getftype({fname}) String description of type of file {fname}
13246
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
2339 getjumplist([{winnr} [, {tabnr}]])
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
2340 List list of jump list items
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2341 getline({lnum}) String line {lnum} of current buffer
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2342 getline({lnum}, {end}) List lines {lnum} to {end} of current buffer
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2343 getloclist({nr} [, {what}]) List list of location list items
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
2344 getmatches() List list of current matches
1548
8d74df00f7da updated for version 7.1-262
vimboss
parents: 1533
diff changeset
2345 getpid() Number process ID of Vim
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2346 getpos({expr}) List position of cursor, mark, etc.
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
2347 getqflist([{what}]) List list of quickfix items
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2348 getreg([{regname} [, 1 [, {list}]]])
5796
f084024c0ddb updated for version 7.4.242
Bram Moolenaar <bram@vim.org>
parents: 5794
diff changeset
2349 String or List contents of register
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2350 getregtype([{regname}]) String type of register
10218
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
2351 gettabinfo([{expr}]) List list of tab pages
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2352 gettabvar({nr}, {varname} [, {def}])
4157
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
2353 any variable {varname} in tab {nr} or {def}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2354 gettabwinvar({tabnr}, {winnr}, {name} [, {def}])
831
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
2355 any {name} in {winnr} in tab page {tabnr}
15016
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
2356 gettagstack([{nr}]) Dict get the tag stack of window {nr}
14343
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
2357 getwininfo([{winid}]) List list of info about each window
13482
9eebe457eb3c Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents: 13438
diff changeset
2358 getwinpos([{timeout}]) List X and Y coord in pixels of the Vim window
13379
0f9dd1b43244 patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
2359 getwinposx() Number X coord in pixels of the Vim window
0f9dd1b43244 patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
2360 getwinposy() Number Y coord in pixels of the Vim window
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2361 getwinvar({nr}, {varname} [, {def}])
4157
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
2362 any variable {varname} in window {nr}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2363 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]])
3398
d1096a4e96bd updated for version 7.3.465
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
2364 any expand file wildcards in {expr}
9536
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2365 glob2regpat({expr}) String convert a glob pat into a search pat
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2366 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
1754
28d0c20ad8a0 updated for version 7.2-051
vimboss
parents: 1733
diff changeset
2367 String do glob({expr}) for all dirs in {path}
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2368 has({feature}) Number |TRUE| if feature {feature} supported
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2369 has_key({dict}, {key}) Number |TRUE| if {dict} has entry {key}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2370 haslocaldir([{winnr} [, {tabnr}]])
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2371 Number |TRUE| if the window executed |:lcd|
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2372 hasmapto({what} [, {mode} [, {abbr}]])
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2373 Number |TRUE| if mapping to {what} exists
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2374 histadd({history}, {item}) String add an item to a history
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2375 histdel({history} [, {item}]) String remove an item from a history
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2376 histget({history} [, {index}]) String get the item {index} from a history
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2377 histnr({history}) Number highest index of a history
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2378 hlexists({name}) Number |TRUE| if highlight group {name} exists
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2379 hlID({name}) Number syntax ID of highlight group {name}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2380 hostname() String name of the machine Vim is running on
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2381 iconv({expr}, {from}, {to}) String convert encoding of {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2382 indent({lnum}) Number indent of line {lnum}
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
2383 index({object}, {expr} [, {start} [, {ic}]])
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
2384 Number index in {object} where {expr} appears
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2385 input({prompt} [, {text} [, {completion}]])
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
2386 String get input from the user
11763
21f3930dfe6e Documentation updates.
Christian Brabandt <cb@256bit.org>
parents: 11659
diff changeset
2387 inputdialog({prompt} [, {text} [, {completion}]])
9536
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2388 String like input() but in a GUI dialog
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2389 inputlist({textlist}) Number let the user pick from a choice list
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2390 inputrestore() Number restore typeahead
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2391 inputsave() Number save and clear typeahead
9536
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2392 inputsecret({prompt} [, {text}]) String like input() but hiding the text
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
2393 insert({object}, {item} [, {idx}]) List insert {item} in {object} [before {idx}]
9536
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2394 invert({expr}) Number bitwise invert
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2395 isdirectory({directory}) Number |TRUE| if {directory} is a directory
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2396 islocked({expr}) Number |TRUE| if {expr} is locked
9536
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2397 isnan({expr}) Number |TRUE| if {expr} is NaN
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2398 items({dict}) List key-value pairs in {dict}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2399 job_getchannel({job}) Channel get the channel handle for {job}
13740
f309afff6f25 patch 8.0.1742: cannot get a list of all the jobs
Christian Brabandt <cb@256bit.org>
parents: 13735
diff changeset
2400 job_info([{job}]) Dict get information about {job}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2401 job_setoptions({job}, {options}) none set options for {job}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2402 job_start({command} [, {options}])
9536
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2403 Job start a job
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2404 job_status({job}) String get the status of {job}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2405 job_stop({job} [, {how}]) Number stop {job}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2406 join({list} [, {sep}]) String join {list} items into one String
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2407 js_decode({string}) any decode JS style JSON
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2408 js_encode({expr}) String encode JS style JSON
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2409 json_decode({string}) any decode JSON
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2410 json_encode({expr}) String encode JSON
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2411 keys({dict}) List keys in {dict}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2412 len({expr}) Number the length of {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2413 libcall({lib}, {func}, {arg}) String call {func} in library {lib} with {arg}
9536
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2414 libcallnr({lib}, {func}, {arg}) Number idem, but return a Number
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2415 line({expr}) Number line nr of cursor, last line or mark
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2416 line2byte({lnum}) Number byte count of line {lnum}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2417 lispindent({lnum}) Number Lisp indent for line {lnum}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2418 localtime() Number current time
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2419 log({expr}) Float natural logarithm (base e) of {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2420 log10({expr}) Float logarithm of Float {expr} to base 10
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2421 luaeval({expr} [, {expr}]) any evaluate |Lua| expression
10218
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
2422 map({expr1}, {expr2}) List/Dict change each item in {expr1} to {expr}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2423 maparg({name} [, {mode} [, {abbr} [, {dict}]]])
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3214
diff changeset
2424 String or Dict
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3214
diff changeset
2425 rhs of mapping {name} in mode {mode}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2426 mapcheck({name} [, {mode} [, {abbr}]])
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
2427 String check for mappings matching {name}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2428 match({expr}, {pat} [, {start} [, {count}]])
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2429 Number position where {pat} matches in {expr}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2430 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
2431 Number highlight {pattern} with {group}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2432 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
5979
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
2433 Number highlight positions with {group}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2434 matcharg({nr}) List arguments of |:match|
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2435 matchdelete({id}) Number delete match identified by {id}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2436 matchend({expr}, {pat} [, {start} [, {count}]])
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2437 Number position where {pat} ends in {expr}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2438 matchlist({expr}, {pat} [, {start} [, {count}]])
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
2439 List match and submatches of {pat} in {expr}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2440 matchstr({expr}, {pat} [, {start} [, {count}]])
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
2441 String {count}'th match of {pat} in {expr}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2442 matchstrpos({expr}, {pat} [, {start} [, {count}]])
8793
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
2443 List {count}'th match of {pat} in {expr}
10734
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
2444 max({expr}) Number maximum value of items in {expr}
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
2445 min({expr}) Number minimum value of items in {expr}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2446 mkdir({name} [, {path} [, {prot}]])
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2447 Number create directory {name}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2448 mode([expr]) String current editing mode
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2449 mzeval({expr}) any evaluate |MzScheme| expression
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2450 nextnonblank({lnum}) Number line nr of non-blank line >= {lnum}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2451 nr2char({expr} [, {utf8}]) String single char with ASCII/UTF8 value {expr}
9536
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2452 or({expr}, {expr}) Number bitwise OR
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2453 pathshorten({expr}) String shorten directory names in a path
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2454 perleval({expr}) any evaluate |Perl| expression
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2455 pow({x}, {y}) Float {x} to the power of {y}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2456 prevnonblank({lnum}) Number line nr of non-blank line <= {lnum}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2457 printf({fmt}, {expr1}...) String format text
14103
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
2458 prompt_setcallback({buf}, {expr}) none set prompt callback function
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
2459 prompt_setinterrupt({buf}, {text}) none set prompt interrupt function
14019
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
2460 prompt_setprompt({buf}, {text}) none set prompt text
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
2461 prop_add({lnum}, {col}, {props}) none add a text property
15251
17525ca95e1e patch 8.1.0634: text properties cannot cross line boundaries
Bram Moolenaar <Bram@vim.org>
parents: 15219
diff changeset
2462 prop_clear({lnum} [, {lnum-end} [, {props}]])
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
2463 none remove all text properties
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
2464 prop_find({props} [, {direction}])
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
2465 Dict search for a text property
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
2466 prop_list({lnum} [, {props}) List text properties in {lnum}
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
2467 prop_remove({props} [, {lnum} [, {lnum-end}]])
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
2468 Number remove a text property
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
2469 prop_type_add({name}, {props}) none define a new property type
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
2470 prop_type_change({name}, {props})
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
2471 none change an existing property type
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
2472 prop_type_delete({name} [, {props}])
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
2473 none delete a property type
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
2474 prop_type_get([{name} [, {props}])
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
2475 Dict get property type values
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
2476 prop_type_list([{props}]) List get list of property types
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2477 pumvisible() Number whether popup menu is visible
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2478 pyeval({expr}) any evaluate |Python| expression
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2479 py3eval({expr}) any evaluate |python3| expression
10722
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
2480 pyxeval({expr}) any evaluate |python_x| expression
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2481 range({expr} [, {max} [, {stride}]])
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
2482 List items from {expr} to {max}
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
2483 readfile({fname} [, {type} [, {max}]])
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
2484 List get list of lines from file {fname}
14019
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
2485 reg_executing() String get the executing register name
14004
e124262d435e patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents: 13967
diff changeset
2486 reg_recording() String get the recording register name
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2487 reltime([{start} [, {end}]]) List get time value
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2488 reltimefloat({time}) Float turn the time value into a Float
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2489 reltimestr({time}) String turn time value into a String
11229
146a1e213b60 Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents: 11225
diff changeset
2490 remote_expr({server}, {string} [, {idvar} [, {timeout}]])
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2491 String send expression
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2492 remote_foreground({server}) Number bring Vim server to the foreground
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2493 remote_peek({serverid} [, {retvar}])
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2494 Number check for reply string
11229
146a1e213b60 Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents: 11225
diff changeset
2495 remote_read({serverid} [, {timeout}])
146a1e213b60 Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents: 11225
diff changeset
2496 String read reply string
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2497 remote_send({server}, {string} [, {idvar}])
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2498 String send key sequence
11177
76fb679a310e patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
2499 remote_startserver({name}) none become server {name}
9344
33c1b85d408c commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents: 9286
diff changeset
2500 remove({list}, {idx} [, {end}]) any remove items {idx}-{end} from {list}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2501 remove({dict}, {key}) any remove entry {key} from {dict}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2502 rename({from}, {to}) Number rename (move) file from {from} to {to}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2503 repeat({expr}, {count}) String repeat {expr} {count} times
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2504 resolve({filename}) String get filename a shortcut points to
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2505 reverse({list}) List reverse {list} in-place
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2506 round({expr}) Float round off {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2507 screenattr({row}, {col}) Number attribute at screen position
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2508 screenchar({row}, {col}) Number character at screen position
3986
56bb88c68f98 updated for version 7.3.748
Bram Moolenaar <bram@vim.org>
parents: 3967
diff changeset
2509 screencol() Number current cursor column
56bb88c68f98 updated for version 7.3.748
Bram Moolenaar <bram@vim.org>
parents: 3967
diff changeset
2510 screenrow() Number current cursor row
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2511 search({pattern} [, {flags} [, {stopline} [, {timeout}]]])
1496
29c09fa57168 updated for version 7.1-211
vimboss
parents: 1490
diff changeset
2512 Number search for {pattern}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2513 searchdecl({name} [, {global} [, {thisblock}]])
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2514 Number search for variable declaration
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2515 searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2516 Number search for other end of start/end pair
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2517 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
2518 List search for other end of start/end pair
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2519 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]])
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
2520 List search for {pattern}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2521 server2client({clientid}, {string})
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2522 Number send reply string
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2523 serverlist() String get a list of available servers
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
2524 setbufline({expr}, {lnum}, {text})
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
2525 Number set line {lnum} to {text} in buffer
12319
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
2526 {expr}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2527 setbufvar({expr}, {varname}, {val})
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2528 none set {varname} in buffer {expr} to {val}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2529 setcharsearch({dict}) Dict set character search from {dict}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2530 setcmdpos({pos}) Number set cursor position in command-line
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2531 setfperm({fname}, {mode}) Number set {fname} file permissions to {mode}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2532 setline({lnum}, {line}) Number set line {lnum} to {line}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2533 setloclist({nr}, {list} [, {action} [, {what}]])
647
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
2534 Number modify location list using {list}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2535 setmatches({list}) Number restore a list of matches
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2536 setpos({expr}, {list}) Number set the {expr} position to {list}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2537 setqflist({list} [, {action} [, {what}]])
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
2538 Number modify quickfix list using {list}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2539 setreg({n}, {v} [, {opt}]) Number set register to value and type
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2540 settabvar({nr}, {varname}, {val}) none set {varname} in tab page {nr} to {val}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2541 settabwinvar({tabnr}, {winnr}, {varname}, {val})
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2542 none set {varname} in window {winnr} in tab
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2543 page {tabnr} to {val}
15016
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
2544 settagstack({nr}, {dict} [, {action}])
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
2545 Number modify tag stack using {dict}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2546 setwinvar({nr}, {varname}, {val}) none set {varname} in window {nr} to {val}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2547 sha256({string}) String SHA256 checksum of {string}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2548 shellescape({string} [, {special}])
1661
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
2549 String escape {string} for use as shell
985
656853d9c014 updated for version 7.0-111
vimboss
parents: 874
diff changeset
2550 command argument
15062
3a94f7918980 patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents: 15033
diff changeset
2551 shiftwidth([{col}]) Number effective value of 'shiftwidth'
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
2552 sign_define({name} [, {dict}]) Number define or update a sign
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
2553 sign_getdefined([{name}]) List get a list of defined signs
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
2554 sign_getplaced([{expr} [, {dict}]])
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
2555 List get a list of placed signs
15418
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
2556 sign_jump({id}, {group}, {expr})
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
2557 Number jump to a sign
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
2558 sign_place({id}, {group}, {name}, {expr} [, {dict}])
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
2559 Number place a sign
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
2560 sign_undefine([{name}]) Number undefine a sign
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
2561 sign_unplace({group} [, {dict}])
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
2562 Number unplace a sign
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2563 simplify({filename}) String simplify filename as much as possible
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2564 sin({expr}) Float sine of {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2565 sinh({expr}) Float hyperbolic sine of {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2566 sort({list} [, {func} [, {dict}]])
2902
69e0783ed0ef updated for version 7.3.224
Bram Moolenaar <bram@vim.org>
parents: 2845
diff changeset
2567 List sort {list}, using {func} to compare
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2568 soundfold({word}) String sound-fold {word}
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
2569 spellbadword() String badly spelled word at cursor
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2570 spellsuggest({word} [, {max} [, {capital}]])
537
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
2571 List spelling suggestions
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2572 split({expr} [, {pat} [, {keepempty}]])
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2573 List make |List| from {pat} separated {expr}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2574 sqrt({expr}) Float square root of {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2575 str2float({expr}) Float convert String to Float
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2576 str2nr({expr} [, {base}]) Number convert String to Number
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2577 strchars({expr} [, {skipcc}]) Number character length of the String {expr}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2578 strcharpart({str}, {start} [, {len}])
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
2579 String {len} characters of {str} at {start}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2580 strdisplaywidth({expr} [, {col}]) Number display length of the String {expr}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2581 strftime({format} [, {time}]) String time in specified format
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
2582 strgetchar({str}, {index}) Number get char {index} from {str}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2583 stridx({haystack}, {needle} [, {start}])
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
2584 Number index of {needle} in {haystack}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2585 string({expr}) String String representation of {expr} value
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2586 strlen({expr}) Number length of the String {expr}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2587 strpart({str}, {start} [, {len}])
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
2588 String {len} characters of {str} at {start}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2589 strridx({haystack}, {needle} [, {start}])
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
2590 Number last index of {needle} in {haystack}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2591 strtrans({expr}) String translate string to make it printable
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2592 strwidth({expr}) Number display cell length of the String {expr}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2593 submatch({nr} [, {list}]) String or List
5794
a63d0cd691dc updated for version 7.4.241
Bram Moolenaar <bram@vim.org>
parents: 5786
diff changeset
2594 specific match in ":s" or substitute()
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2595 substitute({expr}, {pat}, {sub}, {flags})
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2596 String all {pat} in {expr} replaced with {sub}
14599
72d6f6f7ead7 patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents: 14587
diff changeset
2597 swapinfo({fname}) Dict information about swap file {fname}
14778
20653d6f3d95 patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents: 14756
diff changeset
2598 swapname({expr}) String swap file of buffer {expr}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2599 synID({lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2600 synIDattr({synID}, {what} [, {mode}])
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2601 String attribute {what} of syntax ID {synID}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2602 synIDtrans({synID}) Number translated syntax ID of {synID}
9536
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2603 synconcealed({lnum}, {col}) List info about concealing
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2604 synstack({lnum}, {col}) List stack of syntax IDs at {lnum} and {col}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2605 system({expr} [, {input}]) String output of shell command/filter {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2606 systemlist({expr} [, {input}]) List output of shell command/filter {expr}
9344
33c1b85d408c commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents: 9286
diff changeset
2607 tabpagebuflist([{arg}]) List list of buffer numbers in tab page
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2608 tabpagenr([{arg}]) Number number of current or last tab page
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2609 tabpagewinnr({tabarg} [, {arg}]) Number number of current window in tab page
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2610 taglist({expr} [, {filename}]) List list of tags matching {expr}
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2611 tagfiles() List tags files used
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2612 tan({expr}) Float tangent of {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2613 tanh({expr}) Float hyperbolic tangent of {expr}
8577
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
2614 tempname() String name for a temporary file
13298
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
2615 term_dumpdiff({filename}, {filename} [, {options}])
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
2616 Number display difference between two dumps
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
2617 term_dumpload({filename} [, {options}])
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
2618 Number displaying a screen dump
13329
424321d6eea7 patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents: 13298
diff changeset
2619 term_dumpwrite({buf}, {filename} [, {options}])
13298
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
2620 none dump terminal window contents
12035
a3ed3d236839 patch 8.0.0898: can't use the alternate screen in a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12031
diff changeset
2621 term_getaltscreen({buf}) Number get the alternate screen flag
13626
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
2622 term_getansicolors({buf}) List get ANSI palette in GUI color mode
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
2623 term_getattr({attr}, {what}) Number get the value of attribute {what}
11876
3704ca24c9a2 patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11874
diff changeset
2624 term_getcursor({buf}) List get the cursor position of a terminal
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
2625 term_getjob({buf}) Job get the job associated with a terminal
11904
40322e8f07e7 patch 8.0.0832: terminal function arguments are not consistent
Christian Brabandt <cb@256bit.org>
parents: 11882
diff changeset
2626 term_getline({buf}, {row}) String get a line of text from a terminal
12025
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
2627 term_getscrolled({buf}) Number get the scroll count of a terminal
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
2628 term_getsize({buf}) List get the size of a terminal
11882
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
2629 term_getstatus({buf}) String get the status of a terminal
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
2630 term_gettitle({buf}) String get the title of a terminal
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
2631 term_gettty({buf}, [{input}]) String get the tty name of a terminal
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
2632 term_list() List get the list of terminal buffers
11904
40322e8f07e7 patch 8.0.0832: terminal function arguments are not consistent
Christian Brabandt <cb@256bit.org>
parents: 11882
diff changeset
2633 term_scrape({buf}, {row}) List get row of a terminal screen
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
2634 term_sendkeys({buf}, {keys}) none send keystrokes to a terminal
13626
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
2635 term_setansicolors({buf}, {colors})
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
2636 none set ANSI palette in GUI color mode
13735
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13678
diff changeset
2637 term_setkill({buf}, {how}) none set signal to stop job in terminal
13437
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
2638 term_setrestore({buf}, {command}) none set command to restore terminal
13735
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13678
diff changeset
2639 term_setsize({buf}, {rows}, {cols})
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13678
diff changeset
2640 none set the size of a terminal
14945
4ee65b4150fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14864
diff changeset
2641 term_start({cmd}, {options}) Number open a terminal window and run a job
12007
64b822c4f7ae patch 8.0.0884: can't specify the wait time for term_wait()
Christian Brabandt <cb@256bit.org>
parents: 12003
diff changeset
2642 term_wait({buf} [, {time}]) Number wait for screen to be updated
9121
7350959e53c3 commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents: 9117
diff changeset
2643 test_alloc_fail({id}, {countdown}, {repeat})
7350959e53c3 commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents: 9117
diff changeset
2644 none make memory allocation fail
9644
9f7bcc2c3b97 commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents: 9636
diff changeset
2645 test_autochdir() none enable 'autochdir' during startup
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
2646 test_feedinput({string}) none add key sequence to input buffer
9108
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
2647 test_garbagecollect_now() none free memory right now for testing
11006
b3601a8eb679 patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents: 10908
diff changeset
2648 test_ignore_error({expr}) none ignore a specific error
15456
f01eb1aed348 patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents: 15454
diff changeset
2649 test_null_blob() Blob null value for testing
9108
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
2650 test_null_channel() Channel null value for testing
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
2651 test_null_dict() Dict null value for testing
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
2652 test_null_job() Job null value for testing
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
2653 test_null_list() List null value for testing
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
2654 test_null_partial() Funcref null value for testing
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
2655 test_null_string() String null value for testing
14945
4ee65b4150fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14864
diff changeset
2656 test_option_not_set({name}) none reset flag indicating option was set
4ee65b4150fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14864
diff changeset
2657 test_override({expr}, {val}) none test with Vim internal overrides
14756
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
2658 test_scrollbar({which}, {value}, {dragging})
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
2659 none scroll in the GUI for testing
9286
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9223
diff changeset
2660 test_settime({expr}) none set current time for testing
9790
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
2661 timer_info([{id}]) List information about timers
9810
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
2662 timer_pause({id}, {pause}) none pause or unpause a timer
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2663 timer_start({time}, {callback} [, {options}])
8577
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
2664 Number create a timer
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2665 timer_stop({timer}) none stop a timer
9810
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
2666 timer_stopall() none stop all timers
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2667 tolower({expr}) String the String {expr} switched to lowercase
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2668 toupper({expr}) String the String {expr} switched to uppercase
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2669 tr({src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr}
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
2670 to chars in {tostr}
14519
5c5908e81e93 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14422
diff changeset
2671 trim({text} [, {mask}]) String trim characters in {mask} from {text}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2672 trunc({expr}) Float truncate Float {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2673 type({name}) Number type of variable {name}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2674 undofile({name}) String undo file name for {name}
2280
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
2675 undotree() List undo file tree
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2676 uniq({list} [, {func} [, {dict}]])
5747
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
2677 List remove adjacent duplicates from a list
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2678 values({dict}) List values in {dict}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2679 virtcol({expr}) Number screen column of cursor or mark
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2680 visualmode([expr]) String last visual mode used
4151
13170a796134 updated for version 7.3.828
Bram Moolenaar <bram@vim.org>
parents: 4126
diff changeset
2681 wildmenumode() Number whether 'wildmenu' mode is active
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2682 win_findbuf({bufnr}) List find windows containing {bufnr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2683 win_getid([{win} [, {tab}]]) Number get window ID for {win} in {tab}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2684 win_gotoid({expr}) Number go to window with ID {expr}
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2685 win_id2tabwin({expr}) List get tab and window nr from window ID
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2686 win_id2win({expr}) Number get window nr from window ID
12977
2d817fd289ba patch 8.0.1364: there is no easy way to get the window position
Christian Brabandt <cb@256bit.org>
parents: 12968
diff changeset
2687 win_screenpos({nr}) List get screen position of window {nr}
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2688 winbufnr({nr}) Number buffer number of window {nr}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2689 wincol() Number window column of the cursor
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2690 winheight({nr}) Number height of window {nr}
14587
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
2691 winlayout([{tabnr}]) List layout of windows in tab {tabnr}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2692 winline() Number window line of the cursor
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2693 winnr([{expr}]) Number number of current window
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2694 winrestcmd() String returns command to restore window sizes
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2695 winrestview({dict}) none restore view of current window
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
2696 winsaveview() Dict save view of current window
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
2697 winwidth({nr}) Number width of window {nr}
7480
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
2698 wordcount() Dict get byte/char/word statistics
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
2699 writefile({object}, {fname} [, {flags}])
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
2700 Number write |Blob| or |List| of lines to file
9536
b2aada04d84e commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents: 9527
diff changeset
2701 xor({expr}, {expr}) Number bitwise XOR
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2702
8876
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
2703
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2704 abs({expr}) *abs()*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2705 Return the absolute value of {expr}. When {expr} evaluates to
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2706 a |Float| abs() returns a |Float|. When {expr} can be
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2707 converted to a |Number| abs() returns a |Number|. Otherwise
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2708 abs() gives an error message and returns -1.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2709 Examples: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2710 echo abs(1.456)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2711 < 1.456 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2712 echo abs(-5.456)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2713 < 5.456 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2714 echo abs(-4)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2715 < 4
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2716 {only available when compiled with the |+float| feature}
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2717
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2718
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2719 acos({expr}) *acos()*
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2720 Return the arc cosine of {expr} measured in radians, as a
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
2721 |Float| in the range of [0, pi].
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
2722 {expr} must evaluate to a |Float| or a |Number| in the range
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2723 [-1, 1].
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2724 Examples: >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2725 :echo acos(0)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2726 < 1.570796 >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2727 :echo acos(-0.5)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2728 < 2.094395
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
2729 {only available when compiled with the |+float| feature}
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2730
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2731
15498
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
2732 add({object}, {expr}) *add()*
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
2733 Append the item {expr} to |List| or |Blob| {object}. Returns
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
2734 the resulting |List| or |Blob|. Examples: >
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2735 :let alist = add([1, 2, 3], item)
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2736 :call add(mylist, "woodstock")
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2737 < Note that when {expr} is a |List| it is appended as a single
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
2738 item. Use |extend()| to concatenate |Lists|.
15498
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
2739 When {object} is a |Blob| then {expr} must be a number.
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
2740 Use |insert()| to add an item at another position.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2741
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2742
3214
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
2743 and({expr}, {expr}) *and()*
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
2744 Bitwise AND on the two arguments. The arguments are converted
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
2745 to a number. A List, Dict or Float argument causes an error.
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
2746 Example: >
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
2747 :let flag = and(bits, 0x80)
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
2748
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
2749
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
2750 append({lnum}, {text}) *append()*
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
2751 When {text} is a |List|: Append each item of the |List| as a
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
2752 text line below line {lnum} in the current buffer.
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
2753 Otherwise append {text} as one text line below line {lnum} in
153
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
2754 the current buffer.
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
2755 {lnum} can be zero to insert a line before the first one.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2756 Returns 1 for failure ({lnum} out of range or out of memory),
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
2757 0 for success. Example: >
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2758 :let failed = append(line('$'), "# THE END")
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
2759 :let failed = append(0, ["Chapter 1", "the beginning"])
14039
acb2dc112b06 patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
2760
acb2dc112b06 patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
2761 appendbufline({expr}, {lnum}, {text}) *appendbufline()*
acb2dc112b06 patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
2762 Like |append()| but append the text in buffer {expr}.
acb2dc112b06 patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
2763
acb2dc112b06 patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
2764 For the use of {expr}, see |bufname()|.
acb2dc112b06 patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
2765
acb2dc112b06 patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
2766 {lnum} is used like with |append()|. Note that using |line()|
acb2dc112b06 patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
2767 would use the current buffer, not the one appending to.
acb2dc112b06 patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
2768 Use "$" to append at the end of the buffer.
acb2dc112b06 patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
2769
acb2dc112b06 patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
2770 On success 0 is returned, on failure 1 is returned.
acb2dc112b06 patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
2771
acb2dc112b06 patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
2772 If {expr} is not a valid buffer or {lnum} is not valid, an
acb2dc112b06 patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
2773 error message is given. Example: >
acb2dc112b06 patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents: 14019
diff changeset
2774 :let failed = appendbufline(13, 0, "# THE START")
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
2775 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2776 *argc()*
14964
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2777 argc([{winid}])
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2778 The result is the number of files in the argument list. See
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2779 |arglist|.
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2780 If {winid} is not supplied, the argument list of the current
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2781 window is used.
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2782 If {winid} is -1, the global argument list is used.
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2783 Otherwise {winid} specifies the window of which the argument
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2784 list is used: either the window number or the window ID.
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2785 Returns -1 if the {winid} argument is invalid.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2786
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2787 *argidx()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2788 argidx() The result is the current index in the argument list. 0 is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2789 the first file. argc() - 1 is the last one. See |arglist|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2790
5942
66eead134d68 updated for version 7.4.312
Bram Moolenaar <bram@vim.org>
parents: 5940
diff changeset
2791 *arglistid()*
8148
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
2792 arglistid([{winnr} [, {tabnr}]])
5942
66eead134d68 updated for version 7.4.312
Bram Moolenaar <bram@vim.org>
parents: 5940
diff changeset
2793 Return the argument list ID. This is a number which
66eead134d68 updated for version 7.4.312
Bram Moolenaar <bram@vim.org>
parents: 5940
diff changeset
2794 identifies the argument list being used. Zero is used for the
6153
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
2795 global argument list. See |arglist|.
14964
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2796 Returns -1 if the arguments are invalid.
5942
66eead134d68 updated for version 7.4.312
Bram Moolenaar <bram@vim.org>
parents: 5940
diff changeset
2797
66eead134d68 updated for version 7.4.312
Bram Moolenaar <bram@vim.org>
parents: 5940
diff changeset
2798 Without arguments use the current window.
66eead134d68 updated for version 7.4.312
Bram Moolenaar <bram@vim.org>
parents: 5940
diff changeset
2799 With {winnr} only use this window in the current tab page.
66eead134d68 updated for version 7.4.312
Bram Moolenaar <bram@vim.org>
parents: 5940
diff changeset
2800 With {winnr} and {tabnr} use the window in the specified tab
66eead134d68 updated for version 7.4.312
Bram Moolenaar <bram@vim.org>
parents: 5940
diff changeset
2801 page.
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
2802 {winnr} can be the window number or the |window-ID|.
5942
66eead134d68 updated for version 7.4.312
Bram Moolenaar <bram@vim.org>
parents: 5940
diff changeset
2803
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2804 *argv()*
14964
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2805 argv([{nr} [, {winid}])
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2806 The result is the {nr}th file in the argument list. See
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2807 |arglist|. "argv(0)" is the first one. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2808 :let i = 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2809 :while i < argc()
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2810 : let f = escape(fnameescape(argv(i)), '.')
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2811 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2812 : let i = i + 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2813 :endwhile
14964
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2814 < Without the {nr} argument, or when {nr} is -1, a |List| with
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2815 the whole |arglist| is returned.
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2816
2c0bfa167468 patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents: 14945
diff changeset
2817 The {winid} argument specifies the window ID, see |argc()|.
818
1f929f3ca806 updated for version 7.0c03
vimboss
parents: 810
diff changeset
2818
13272
abaebba89fd4 patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents: 13246
diff changeset
2819 assert_beeps({cmd}) *assert_beeps()*
abaebba89fd4 patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents: 13246
diff changeset
2820 Run {cmd} and add an error message to |v:errors| if it does
abaebba89fd4 patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents: 13246
diff changeset
2821 NOT produce a beep or visual bell.
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2822 Also see |assert_fails()| and |assert-return|.
13272
abaebba89fd4 patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents: 13246
diff changeset
2823
7279
b5e9810b389d commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents: 7277
diff changeset
2824 *assert_equal()*
7584
9b7de205336d commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents: 7557
diff changeset
2825 assert_equal({expected}, {actual} [, {msg}])
7277
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
2826 When {expected} and {actual} are not equal an error message is
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2827 added to |v:errors| and 1 is returned. Otherwise zero is
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2828 returned |assert-return|.
7277
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
2829 There is no automatic conversion, the String "4" is different
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
2830 from the Number 4. And the number 4 is different from the
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
2831 Float 4.0. The value of 'ignorecase' is not used here, case
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
2832 always matters.
7279
b5e9810b389d commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents: 7277
diff changeset
2833 When {msg} is omitted an error in the form "Expected
b5e9810b389d commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents: 7277
diff changeset
2834 {expected} but got {actual}" is produced.
7277
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
2835 Example: >
7279
b5e9810b389d commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents: 7277
diff changeset
2836 assert_equal('foo', 'bar')
7277
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
2837 < Will result in a string to be added to |v:errors|:
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
2838 test.vim line 12: Expected 'foo' but got 'bar' ~
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
2839
13298
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
2840 *assert_equalfile()*
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
2841 assert_equalfile({fname-one}, {fname-two})
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
2842 When the files {fname-one} and {fname-two} do not contain
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
2843 exactly the same text an error message is added to |v:errors|.
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2844 Also see |assert-return|.
13298
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
2845 When {fname-one} or {fname-two} does not exist the error will
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
2846 mention that.
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
2847 Mainly useful with |terminal-diff|.
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
2848
7584
9b7de205336d commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents: 7557
diff changeset
2849 assert_exception({error} [, {msg}]) *assert_exception()*
9b7de205336d commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents: 7557
diff changeset
2850 When v:exception does not contain the string {error} an error
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2851 message is added to |v:errors|. Also see |assert-return|.
7584
9b7de205336d commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents: 7557
diff changeset
2852 This can be used to assert that a command throws an exception.
9b7de205336d commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents: 7557
diff changeset
2853 Using the error number, followed by a colon, avoids problems
9b7de205336d commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents: 7557
diff changeset
2854 with translations: >
9b7de205336d commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents: 7557
diff changeset
2855 try
9b7de205336d commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents: 7557
diff changeset
2856 commandthatfails
9b7de205336d commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents: 7557
diff changeset
2857 call assert_false(1, 'command should have failed')
9b7de205336d commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents: 7557
diff changeset
2858 catch
9b7de205336d commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents: 7557
diff changeset
2859 call assert_exception('E492:')
9b7de205336d commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents: 7557
diff changeset
2860 endtry
9b7de205336d commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents: 7557
diff changeset
2861
14945
4ee65b4150fd Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14864
diff changeset
2862 assert_fails({cmd} [, {error} [, {msg}]]) *assert_fails()*
7593
87e607fb6853 commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents: 7584
diff changeset
2863 Run {cmd} and add an error message to |v:errors| if it does
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2864 NOT produce an error. Also see |assert-return|.
10348
c78513465e6e commit https://github.com/vim/vim/commit/25de4c232d580583feadae11ab34e3cc6333c350
Christian Brabandt <cb@256bit.org>
parents: 10301
diff changeset
2865 When {error} is given it must match in |v:errmsg|.
13272
abaebba89fd4 patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents: 13246
diff changeset
2866 Note that beeping is not considered an error, and some failing
abaebba89fd4 patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents: 13246
diff changeset
2867 commands only beep. Use |assert_beeps()| for those.
7593
87e607fb6853 commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents: 7584
diff changeset
2868
7584
9b7de205336d commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents: 7557
diff changeset
2869 assert_false({actual} [, {msg}]) *assert_false()*
7277
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
2870 When {actual} is not false an error message is added to
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15138
diff changeset
2871 |v:errors|, like with |assert_equal()|.
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2872 Also see |assert-return|.
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
2873 A value is false when it is zero. When {actual} is not a
7277
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
2874 number the assert fails.
9636
ccbb8e393d80 commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents: 9626
diff changeset
2875 When {msg} is omitted an error in the form
ccbb8e393d80 commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents: 9626
diff changeset
2876 "Expected False but got {actual}" is produced.
ccbb8e393d80 commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents: 9626
diff changeset
2877
ccbb8e393d80 commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents: 9626
diff changeset
2878 assert_inrange({lower}, {upper}, {actual} [, {msg}]) *assert_inrange()*
ccbb8e393d80 commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents: 9626
diff changeset
2879 This asserts number values. When {actual} is lower than
ccbb8e393d80 commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents: 9626
diff changeset
2880 {lower} or higher than {upper} an error message is added to
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2881 |v:errors|. Also see |assert-return|.
9636
ccbb8e393d80 commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents: 9626
diff changeset
2882 When {msg} is omitted an error in the form
ccbb8e393d80 commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents: 9626
diff changeset
2883 "Expected range {lower} - {upper}, but got {actual}" is
ccbb8e393d80 commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents: 9626
diff changeset
2884 produced.
7279
b5e9810b389d commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents: 7277
diff changeset
2885
8749
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2886 *assert_match()*
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2887 assert_match({pattern}, {actual} [, {msg}])
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2888 When {pattern} does not match {actual} an error message is
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2889 added to |v:errors|. Also see |assert-return|.
8749
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2890
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2891 {pattern} is used as with |=~|: The matching is always done
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2892 like 'magic' was set and 'cpoptions' is empty, no matter what
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2893 the actual value of 'magic' or 'cpoptions' is.
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2894
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2895 {actual} is used as a string, automatic conversion applies.
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2896 Use "^" and "$" to match with the start and end of the text.
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2897 Use both to match the whole text.
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2898
9636
ccbb8e393d80 commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents: 9626
diff changeset
2899 When {msg} is omitted an error in the form
ccbb8e393d80 commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents: 9626
diff changeset
2900 "Pattern {pattern} does not match {actual}" is produced.
8749
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2901 Example: >
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2902 assert_match('^f.*o$', 'foobar')
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2903 < Will result in a string to be added to |v:errors|:
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2904 test.vim line 12: Pattern '^f.*o$' does not match 'foobar' ~
65a5a18d3acf commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents: 8748
diff changeset
2905
8831
6f41d68aa68e commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents: 8795
diff changeset
2906 *assert_notequal()*
6f41d68aa68e commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents: 8795
diff changeset
2907 assert_notequal({expected}, {actual} [, {msg}])
6f41d68aa68e commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents: 8795
diff changeset
2908 The opposite of `assert_equal()`: add an error message to
6f41d68aa68e commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents: 8795
diff changeset
2909 |v:errors| when {expected} and {actual} are equal.
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2910 Also see |assert-return|.
8831
6f41d68aa68e commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents: 8795
diff changeset
2911
6f41d68aa68e commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents: 8795
diff changeset
2912 *assert_notmatch()*
6f41d68aa68e commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents: 8795
diff changeset
2913 assert_notmatch({pattern}, {actual} [, {msg}])
6f41d68aa68e commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents: 8795
diff changeset
2914 The opposite of `assert_match()`: add an error message to
6f41d68aa68e commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents: 8795
diff changeset
2915 |v:errors| when {pattern} matches {actual}.
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2916 Also see |assert-return|.
8831
6f41d68aa68e commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents: 8795
diff changeset
2917
11181
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
2918 assert_report({msg}) *assert_report()*
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
2919 Report a test failure directly, using {msg}.
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2920 Always returns one.
11181
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
2921
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
2922 assert_true({actual} [, {msg}]) *assert_true()*
7277
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
2923 When {actual} is not true an error message is added to
7584
9b7de205336d commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents: 7557
diff changeset
2924 |v:errors|, like with |assert_equal()|.
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
2925 Also see |assert-return|.
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
2926 A value is TRUE when it is a non-zero number. When {actual}
7277
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
2927 is not a number the assert fails.
7279
b5e9810b389d commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents: 7277
diff changeset
2928 When {msg} is omitted an error in the form "Expected True but
b5e9810b389d commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents: 7277
diff changeset
2929 got {actual}" is produced.
7277
6600871bb38c commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents: 7147
diff changeset
2930
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2931 asin({expr}) *asin()*
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
2932 Return the arc sine of {expr} measured in radians, as a |Float|
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2933 in the range of [-pi/2, pi/2].
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
2934 {expr} must evaluate to a |Float| or a |Number| in the range
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2935 [-1, 1].
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2936 Examples: >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2937 :echo asin(0.8)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2938 < 0.927295 >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2939 :echo asin(-0.5)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2940 < -0.523599
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
2941 {only available when compiled with the |+float| feature}
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2942
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2943
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2944 atan({expr}) *atan()*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2945 Return the principal value of the arc tangent of {expr}, in
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2946 the range [-pi/2, +pi/2] radians, as a |Float|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2947 {expr} must evaluate to a |Float| or a |Number|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2948 Examples: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2949 :echo atan(100)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2950 < 1.560797 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2951 :echo atan(-4.01)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2952 < -1.326405
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2953 {only available when compiled with the |+float| feature}
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
2954
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2955
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2956 atan2({expr1}, {expr2}) *atan2()*
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2957 Return the arc tangent of {expr1} / {expr2}, measured in
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
2958 radians, as a |Float| in the range [-pi, pi].
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
2959 {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2960 Examples: >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2961 :echo atan2(-1, 1)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2962 < -0.785398 >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2963 :echo atan2(1, -1)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2964 < 2.356194
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
2965 {only available when compiled with the |+float| feature}
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2966
12883
058e93aee621 patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents: 12857
diff changeset
2967 balloon_show({expr}) *balloon_show()*
058e93aee621 patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents: 12857
diff changeset
2968 Show {expr} inside the balloon. For the GUI {expr} is used as
058e93aee621 patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents: 12857
diff changeset
2969 a string. For a terminal {expr} can be a list, which contains
058e93aee621 patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents: 12857
diff changeset
2970 the lines of the balloon. If {expr} is not a list it will be
058e93aee621 patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents: 12857
diff changeset
2971 split with |balloon_split()|.
058e93aee621 patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents: 12857
diff changeset
2972
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
2973 Example: >
11014
fb2bcfa6a8de patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents: 11006
diff changeset
2974 func GetBalloonContent()
fb2bcfa6a8de patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents: 11006
diff changeset
2975 " initiate getting the content
fb2bcfa6a8de patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents: 11006
diff changeset
2976 return ''
fb2bcfa6a8de patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents: 11006
diff changeset
2977 endfunc
fb2bcfa6a8de patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents: 11006
diff changeset
2978 set balloonexpr=GetBalloonContent()
fb2bcfa6a8de patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents: 11006
diff changeset
2979
fb2bcfa6a8de patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents: 11006
diff changeset
2980 func BalloonCallback(result)
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
2981 call balloon_show(a:result)
11014
fb2bcfa6a8de patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents: 11006
diff changeset
2982 endfunc
fb2bcfa6a8de patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents: 11006
diff changeset
2983 <
fb2bcfa6a8de patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents: 11006
diff changeset
2984 The intended use is that fetching the content of the balloon
fb2bcfa6a8de patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents: 11006
diff changeset
2985 is initiated from 'balloonexpr'. It will invoke an
fb2bcfa6a8de patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents: 11006
diff changeset
2986 asynchronous method, in which a callback invokes
fb2bcfa6a8de patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents: 11006
diff changeset
2987 balloon_show(). The 'balloonexpr' itself can return an
fb2bcfa6a8de patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents: 11006
diff changeset
2988 empty string or a placeholder.
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
2989
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
2990 When showing a balloon is not possible nothing happens, no
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
2991 error message.
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
2992 {only available when compiled with the |+balloon_eval| or
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
2993 |+balloon_eval_term| feature}
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
2994
12883
058e93aee621 patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents: 12857
diff changeset
2995 balloon_split({msg}) *balloon_split()*
058e93aee621 patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents: 12857
diff changeset
2996 Split {msg} into lines to be displayed in a balloon. The
058e93aee621 patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents: 12857
diff changeset
2997 splits are made for the current window size and optimize to
058e93aee621 patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents: 12857
diff changeset
2998 show debugger output.
058e93aee621 patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents: 12857
diff changeset
2999 Returns a |List| with the split lines.
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
3000 {only available when compiled with the |+balloon_eval_term|
12885
10cb5c3df3f5 patch 8.0.1319: can't build GUI on MS-Windows
Christian Brabandt <cb@256bit.org>
parents: 12883
diff changeset
3001 feature}
12883
058e93aee621 patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents: 12857
diff changeset
3002
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3003 *browse()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3004 browse({save}, {title}, {initdir}, {default})
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3005 Put up a file requester. This only works when "has("browse")"
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
3006 returns |TRUE| (only in some GUI versions).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3007 The input fields are:
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
3008 {save} when |TRUE|, select file to write
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3009 {title} title for the requester
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3010 {initdir} directory to start browsing in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3011 {default} default file name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3012 When the "Cancel" button is hit, something went wrong, or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3013 browsing is not possible, an empty string is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3014
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
3015 *browsedir()*
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
3016 browsedir({title}, {initdir})
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
3017 Put up a directory requester. This only works when
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
3018 "has("browse")" returns |TRUE| (only in some GUI versions).
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
3019 On systems where a directory browser is not supported a file
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
3020 browser is used. In that case: select a file in the directory
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
3021 to be used.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
3022 The input fields are:
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
3023 {title} title for the requester
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
3024 {initdir} directory to start browsing in
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
3025 When the "Cancel" button is hit, something went wrong, or
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
3026 browsing is not possible, an empty string is returned.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
3027
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3028 bufexists({expr}) *bufexists()*
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
3029 The result is a Number, which is |TRUE| if a buffer called
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3030 {expr} exists.
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
3031 If the {expr} argument is a number, buffer numbers are used.
12909
1578c0ba0dd1 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12885
diff changeset
3032 Number zero is the alternate buffer for the current window.
1578c0ba0dd1 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12885
diff changeset
3033
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3034 If the {expr} argument is a string it must match a buffer name
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
3035 exactly. The name can be:
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
3036 - Relative to the current directory.
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
3037 - A full path.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3038 - The name of a buffer with 'buftype' set to "nofile".
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
3039 - A URL name.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3040 Unlisted buffers will be found.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3041 Note that help files are listed by their short name in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3042 output of |:buffers|, but bufexists() requires using their
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3043 long name to be able to find them.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3044 bufexists() may report a buffer exists, but to use the name
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3045 with a |:buffer| command you may need to use |expand()|. Esp
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3046 for MS-Windows 8.3 names in the form "c:\DOCUME~1"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3047 Use "bufexists(0)" to test for the existence of an alternate
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3048 file name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3049 *buffer_exists()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3050 Obsolete name: buffer_exists().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3051
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3052 buflisted({expr}) *buflisted()*
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
3053 The result is a Number, which is |TRUE| if a buffer called
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3054 {expr} exists and is listed (has the 'buflisted' option set).
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
3055 The {expr} argument is used like with |bufexists()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3056
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3057 bufloaded({expr}) *bufloaded()*
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
3058 The result is a Number, which is |TRUE| if a buffer called
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3059 {expr} exists and is loaded (shown in a window or hidden).
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
3060 The {expr} argument is used like with |bufexists()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3061
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3062 bufname({expr}) *bufname()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3063 The result is the name of a buffer, as it is displayed by the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3064 ":ls" command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3065 If {expr} is a Number, that buffer number's name is given.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3066 Number zero is the alternate buffer for the current window.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3067 If {expr} is a String, it is used as a |file-pattern| to match
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
3068 with the buffer names. This is always done like 'magic' is
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3069 set and 'cpoptions' is empty. When there is more than one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3070 match an empty string is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3071 "" or "%" can be used for the current buffer, "#" for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3072 alternate buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3073 A full match is preferred, otherwise a match at the start, end
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
3074 or middle of the buffer name is accepted. If you only want a
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
3075 full match then put "^" at the start and "$" at the end of the
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
3076 pattern.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3077 Listed buffers are found first. If there is a single match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3078 with a listed buffer, that one is returned. Next unlisted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3079 buffers are searched for.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3080 If the {expr} is a String, but you want to use it as a buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3081 number, force it to be a Number by adding zero to it: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3082 :echo bufname("3" + 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3083 < If the buffer doesn't exist, or doesn't have a name, an empty
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3084 string is returned. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3085 bufname("#") alternate buffer name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3086 bufname(3) name of buffer 3
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3087 bufname("%") name of current buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3088 bufname("file2") name of buffer where "file2" matches.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3089 < *buffer_name()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3090 Obsolete name: buffer_name().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3091
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3092 *bufnr()*
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3093 bufnr({expr} [, {create}])
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3094 The result is the number of a buffer, as it is displayed by
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3095 the ":ls" command. For the use of {expr}, see |bufname()|
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3096 above.
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3097 If the buffer doesn't exist, -1 is returned. Or, if the
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3098 {create} argument is present and not zero, a new, unlisted,
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
3099 buffer is created and its number is returned.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3100 bufnr("$") is the last buffer: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3101 :let last_buffer = bufnr("$")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3102 < The result is a Number, which is the highest buffer number
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3103 of existing buffers. Note that not all buffers with a smaller
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3104 number necessarily exist, because ":bwipeout" may have removed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3105 them. Use bufexists() to test for the existence of a buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3106 *buffer_number()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3107 Obsolete name: buffer_number().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3108 *last_buffer_nr()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3109 Obsolete name for bufnr("$"): last_buffer_nr().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3110
9219
7363f5cc4cb8 commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents: 9121
diff changeset
3111 bufwinid({expr}) *bufwinid()*
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
3112 The result is a Number, which is the |window-ID| of the first
9219
7363f5cc4cb8 commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents: 9121
diff changeset
3113 window associated with buffer {expr}. For the use of {expr},
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
3114 see |bufname()| above. If buffer {expr} doesn't exist or
9219
7363f5cc4cb8 commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents: 9121
diff changeset
3115 there is no such window, -1 is returned. Example: >
7363f5cc4cb8 commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents: 9121
diff changeset
3116
7363f5cc4cb8 commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents: 9121
diff changeset
3117 echo "A window containing buffer 1 is " . (bufwinid(1))
7363f5cc4cb8 commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents: 9121
diff changeset
3118 <
7363f5cc4cb8 commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents: 9121
diff changeset
3119 Only deals with the current tab page.
7363f5cc4cb8 commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents: 9121
diff changeset
3120
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3121 bufwinnr({expr}) *bufwinnr()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3122 The result is a Number, which is the number of the first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3123 window associated with buffer {expr}. For the use of {expr},
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
3124 see |bufname()| above. If buffer {expr} doesn't exist or
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3125 there is no such window, -1 is returned. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3126
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3127 echo "A window containing buffer 1 is " . (bufwinnr(1))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3128
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3129 < The number can be used with |CTRL-W_w| and ":wincmd w"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3130 |:wincmd|.
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
3131 Only deals with the current tab page.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3132
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3133 byte2line({byte}) *byte2line()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3134 Return the line number that contains the character at byte
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3135 count {byte} in the current buffer. This includes the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3136 end-of-line character, depending on the 'fileformat' option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3137 for the current buffer. The first character has byte count
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3138 one.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3139 Also see |line2byte()|, |go| and |:goto|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3140 {not available when compiled without the |+byte_offset|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3141 feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3142
18
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3143 byteidx({expr}, {nr}) *byteidx()*
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3144 Return byte index of the {nr}'th character in the string
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3145 {expr}. Use zero for the first character, it returns zero.
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3146 This function is only useful when there are multibyte
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3147 characters, otherwise the returned value is equal to {nr}.
5413
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3148 Composing characters are not counted separately, their byte
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3149 length is added to the preceding base character. See
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3150 |byteidxcomp()| below for counting composing characters
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3151 separately.
18
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3152 Example : >
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3153 echo matchstr(str, ".", byteidx(str, 3))
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3154 < will display the fourth character. Another way to do the
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3155 same: >
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3156 let s = strpart(str, byteidx(str, 3))
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3157 echo strpart(s, 0, byteidx(s, 1))
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
3158 < Also see |strgetchar()| and |strcharpart()|.
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
3159
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
3160 If there are less than {nr} characters -1 is returned.
18
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3161 If there are exactly {nr} characters the length of the string
5413
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3162 in bytes is returned.
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3163
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3164 byteidxcomp({expr}, {nr}) *byteidxcomp()*
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3165 Like byteidx(), except that a composing character is counted
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3166 as a separate character. Example: >
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3167 let s = 'e' . nr2char(0x301)
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3168 echo byteidx(s, 1)
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3169 echo byteidxcomp(s, 1)
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3170 echo byteidxcomp(s, 2)
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3171 < The first and third echo result in 3 ('e' plus composing
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3172 character is 3 bytes), the second echo results in 1 ('e' is
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3173 one byte).
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3174 Only works different from byteidx() when 'encoding' is set to
3109053ce4e3 updated for version 7.4.057
Bram Moolenaar <bram@vim.org>
parents: 5340
diff changeset
3175 a Unicode encoding.
18
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
3176
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
3177 call({func}, {arglist} [, {dict}]) *call()* *E699*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3178 Call function {func} with the items in |List| {arglist} as
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3179 arguments.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3180 {func} can either be a |Funcref| or the name of a function.
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3181 a:firstline and a:lastline are set to the cursor line.
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3182 Returns the return value of the called function.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
3183 {dict} is for functions with the "dict" attribute. It will be
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
3184 used to set the local variable "self". |Dictionary-function|
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3185
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3186 ceil({expr}) *ceil()*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3187 Return the smallest integral value greater than or equal to
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3188 {expr} as a |Float| (round up).
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3189 {expr} must evaluate to a |Float| or a |Number|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3190 Examples: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3191 echo ceil(1.456)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3192 < 2.0 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3193 echo ceil(-5.456)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3194 < -5.0 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3195 echo ceil(4.0)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3196 < 4.0
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3197 {only available when compiled with the |+float| feature}
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3198
10422
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3199 ch_canread({handle}) *ch_canread()*
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3200 Return non-zero when there is something to read from {handle}.
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3201 {handle} can be a Channel or a Job that has a Channel.
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3202
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3203 This is useful to read from a channel at a convenient time,
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3204 e.g. from a timer.
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3205
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3206 Note that messages are dropped when the channel does not have
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3207 a callback. Add a close callback to avoid that.
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3208
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3209 {only available when compiled with the |+channel| feature}
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3210
8440
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3211 ch_close({handle}) *ch_close()*
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3212 Close {handle}. See |channel-close|.
10422
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3213 {handle} can be a Channel or a Job that has a Channel.
10054
d4b7232fc63a commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents: 10051
diff changeset
3214 A close callback is not invoked.
d4b7232fc63a commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents: 10051
diff changeset
3215
d4b7232fc63a commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents: 10051
diff changeset
3216 {only available when compiled with the |+channel| feature}
d4b7232fc63a commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents: 10051
diff changeset
3217
d4b7232fc63a commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents: 10051
diff changeset
3218 ch_close_in({handle}) *ch_close_in()*
d4b7232fc63a commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents: 10051
diff changeset
3219 Close the "in" part of {handle}. See |channel-close-in|.
10422
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3220 {handle} can be a Channel or a Job that has a Channel.
10054
d4b7232fc63a commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents: 10051
diff changeset
3221 A close callback is not invoked.
8392
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents: 8303
diff changeset
3222
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
3223 {only available when compiled with the |+channel| feature}
7895
bff95e0d8885 commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
3224
8440
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3225 ch_evalexpr({handle}, {expr} [, {options}]) *ch_evalexpr()*
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3226 Send {expr} over {handle}. The {expr} is encoded
8285
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3227 according to the type of channel. The function cannot be used
8303
88207f4b861a commit https://github.com/vim/vim/commit/dae8d21dd291df6a6679a00be64e18bca0156576
Christian Brabandt <cb@256bit.org>
parents: 8291
diff changeset
3228 with a raw channel. See |channel-use|.
10422
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3229 {handle} can be a Channel or a Job that has a Channel.
8285
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3230 *E917*
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3231 {options} must be a Dictionary. It must not have a "callback"
8748
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
3232 entry. It can have a "timeout" entry to specify the timeout
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
3233 for this specific request.
8285
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3234
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3235 ch_evalexpr() waits for a response and returns the decoded
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3236 expression. When there is an error or timeout it returns an
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3237 empty string.
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3238
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3239 {only available when compiled with the |+channel| feature}
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3240
8440
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3241 ch_evalraw({handle}, {string} [, {options}]) *ch_evalraw()*
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3242 Send {string} over {handle}.
10422
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3243 {handle} can be a Channel or a Job that has a Channel.
8440
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3244
8285
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3245 Works like |ch_evalexpr()|, but does not encode the request or
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3246 decode the response. The caller is responsible for the
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3247 correct contents. Also does not add a newline for a channel
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3248 in NL mode, the caller must do that. The NL in the response
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3249 is removed.
12756
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
3250 Note that Vim does not know when the text received on a raw
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
3251 channel is complete, it may only return the first part and you
15456
f01eb1aed348 patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents: 15454
diff changeset
3252 need to use |ch_readraw()| to fetch the rest.
8285
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3253 See |channel-use|.
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3254
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3255 {only available when compiled with the |+channel| feature}
e05e28dcb590 commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents: 8275
diff changeset
3256
8440
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3257 ch_getbufnr({handle}, {what}) *ch_getbufnr()*
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3258 Get the buffer number that {handle} is using for {what}.
10422
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3259 {handle} can be a Channel or a Job that has a Channel.
8291
ac0c43e7af20 commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents: 8285
diff changeset
3260 {what} can be "err" for stderr, "out" for stdout or empty for
ac0c43e7af20 commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents: 8285
diff changeset
3261 socket output.
ac0c43e7af20 commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents: 8285
diff changeset
3262 Returns -1 when there is no buffer.
ac0c43e7af20 commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents: 8285
diff changeset
3263 {only available when compiled with the |+channel| feature}
ac0c43e7af20 commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents: 8285
diff changeset
3264
8178
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
3265 ch_getjob({channel}) *ch_getjob()*
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
3266 Get the Job associated with {channel}.
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
3267 If there is no job calling |job_status()| on the returned Job
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
3268 will result in "fail".
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
3269
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
3270 {only available when compiled with the |+channel| and
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
3271 |+job| features}
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
3272
8669
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3273 ch_info({handle}) *ch_info()*
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3274 Returns a Dictionary with information about {handle}. The
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3275 items are:
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3276 "id" number of the channel
10233
d709622a18c9 commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents: 10228
diff changeset
3277 "status" "open", "buffered" or "closed", like
d709622a18c9 commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents: 10228
diff changeset
3278 ch_status()
8669
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3279 When opened with ch_open():
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3280 "hostname" the hostname of the address
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3281 "port" the port of the address
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3282 "sock_status" "open" or "closed"
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3283 "sock_mode" "NL", "RAW", "JSON" or "JS"
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3284 "sock_io" "socket"
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3285 "sock_timeout" timeout in msec
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3286 When opened with job_start():
10233
d709622a18c9 commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents: 10228
diff changeset
3287 "out_status" "open", "buffered" or "closed"
8669
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3288 "out_mode" "NL", "RAW", "JSON" or "JS"
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3289 "out_io" "null", "pipe", "file" or "buffer"
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3290 "out_timeout" timeout in msec
10233
d709622a18c9 commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents: 10228
diff changeset
3291 "err_status" "open", "buffered" or "closed"
8669
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3292 "err_mode" "NL", "RAW", "JSON" or "JS"
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3293 "err_io" "out", "null", "pipe", "file" or "buffer"
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3294 "err_timeout" timeout in msec
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3295 "in_status" "open" or "closed"
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3296 "in_mode" "NL", "RAW", "JSON" or "JS"
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3297 "in_io" "null", "pipe", "file" or "buffer"
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3298 "in_timeout" timeout in msec
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
3299
8440
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3300 ch_log({msg} [, {handle}]) *ch_log()*
8148
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
3301 Write {msg} in the channel log file, if it was opened with
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
3302 |ch_logfile()|.
8440
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3303 When {handle} is passed the channel number is used for the
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3304 message.
10449
222b1432814e commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents: 10422
diff changeset
3305 {handle} can be a Channel or a Job that has a Channel. The
10244
876fbdd84e52 commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents: 10237
diff changeset
3306 Channel must be open for the channel number to be used.
8148
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
3307
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
3308 ch_logfile({fname} [, {mode}]) *ch_logfile()*
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
3309 Start logging channel activity to {fname}.
8061
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 8031
diff changeset
3310 When {fname} is an empty string: stop logging.
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 8031
diff changeset
3311
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
3312 When {mode} is omitted or "a" append to the file.
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
3313 When {mode} is "w" start with an empty file.
8061
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 8031
diff changeset
3314
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
3315 Use |ch_log()| to write log messages. The file is flushed
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
3316 after every message, on Unix you can use "tail -f" to see what
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
3317 is going on in real time.
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
3318
12025
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
3319 This function is not available in the |sandbox|.
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
3320 NOTE: the channel communication is stored in the file, be
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
3321 aware that this may contain confidential and privacy sensitive
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
3322 information, e.g. a password you type in a terminal window.
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
3323
8392
1bf1b88968a2 commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents: 8303
diff changeset
3324
8148
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
3325 ch_open({address} [, {options}]) *ch_open()*
7788
192ae655ac91 commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents: 7782
diff changeset
3326 Open a channel to {address}. See |channel|.
8748
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
3327 Returns a Channel. Use |ch_status()| to check for failure.
7788
192ae655ac91 commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents: 7782
diff changeset
3328
192ae655ac91 commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents: 7782
diff changeset
3329 {address} has the form "hostname:port", e.g.,
192ae655ac91 commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents: 7782
diff changeset
3330 "localhost:8765".
192ae655ac91 commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents: 7782
diff changeset
3331
8748
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
3332 If {options} is given it must be a |Dictionary|.
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
3333 See |channel-open-options|.
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
3334
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
3335 {only available when compiled with the |+channel| feature}
7788
192ae655ac91 commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents: 7782
diff changeset
3336
8440
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3337 ch_read({handle} [, {options}]) *ch_read()*
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3338 Read from {handle} and return the received message.
10422
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3339 {handle} can be a Channel or a Job that has a Channel.
13016
e47e70300f30 patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents: 12977
diff changeset
3340 For a NL channel this waits for a NL to arrive, except when
e47e70300f30 patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents: 12977
diff changeset
3341 there is nothing more to read (channel was closed).
8748
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
3342 See |channel-more|.
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
3343 {only available when compiled with the |+channel| feature}
8178
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
3344
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
3345 ch_readblob({handle} [, {options}]) *ch_readblob()*
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
3346 Like ch_read() but reads binary data and returns a |Blob|.
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
3347 See |channel-more|.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
3348 {only available when compiled with the |+channel| feature}
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
3349
8440
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3350 ch_readraw({handle} [, {options}]) *ch_readraw()*
8178
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
3351 Like ch_read() but for a JS and JSON channel does not decode
13016
e47e70300f30 patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents: 12977
diff changeset
3352 the message. For a NL channel it does not block waiting for
e47e70300f30 patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents: 12977
diff changeset
3353 the NL to arrive, but otherwise works like ch_read().
e47e70300f30 patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents: 12977
diff changeset
3354 See |channel-more|.
8748
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
3355 {only available when compiled with the |+channel| feature}
8178
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
3356
8440
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3357 ch_sendexpr({handle}, {expr} [, {options}]) *ch_sendexpr()*
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3358 Send {expr} over {handle}. The {expr} is encoded
7992
78106b0f2c56 commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents: 7967
diff changeset
3359 according to the type of channel. The function cannot be used
8748
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
3360 with a raw channel.
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
3361 See |channel-use|. *E912*
10422
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3362 {handle} can be a Channel or a Job that has a Channel.
7895
bff95e0d8885 commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
3363
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
3364 {only available when compiled with the |+channel| feature}
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
3365
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
3366 ch_sendraw({handle}, {expr} [, {options}]) *ch_sendraw()*
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
3367 Send |String| or |Blob| {expr} over {handle}.
7992
78106b0f2c56 commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents: 7967
diff changeset
3368 Works like |ch_sendexpr()|, but does not encode the request or
78106b0f2c56 commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents: 7967
diff changeset
3369 decode the response. The caller is responsible for the
8094
18a3f0f05244 commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents: 8078
diff changeset
3370 correct contents. Also does not add a newline for a channel
18a3f0f05244 commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents: 8078
diff changeset
3371 in NL mode, the caller must do that. The NL in the response
18a3f0f05244 commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents: 8078
diff changeset
3372 is removed.
18a3f0f05244 commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents: 8078
diff changeset
3373 See |channel-use|.
7895
bff95e0d8885 commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents: 7876
diff changeset
3374
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
3375 {only available when compiled with the |+channel| feature}
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
3376
8440
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3377 ch_setoptions({handle}, {options}) *ch_setoptions()*
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3378 Set options on {handle}:
8148
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
3379 "callback" the channel callback
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
3380 "timeout" default read timeout in msec
8178
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
3381 "mode" mode for the whole channel
8148
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
3382 See |ch_open()| for more explanation.
10422
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3383 {handle} can be a Channel or a Job that has a Channel.
8148
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
3384
8178
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
3385 Note that changing the mode may cause queued messages to be
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
3386 lost.
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
3387
8148
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
3388 These options cannot be changed:
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
3389 "waittime" only applies to |ch_open()|
8148
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
3390
10233
d709622a18c9 commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents: 10228
diff changeset
3391 ch_status({handle} [, {options}]) *ch_status()*
8440
4c6ad81d41fe commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents: 8392
diff changeset
3392 Return the status of {handle}:
8061
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 8031
diff changeset
3393 "fail" failed to open the channel
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 8031
diff changeset
3394 "open" channel can be used
9041
34c45ee4210d commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents: 8951
diff changeset
3395 "buffered" channel can be read, not written to
8061
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 8031
diff changeset
3396 "closed" channel can not be used
10422
e664ee056a84 commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents: 10404
diff changeset
3397 {handle} can be a Channel or a Job that has a Channel.
9041
34c45ee4210d commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents: 8951
diff changeset
3398 "buffered" is used when the channel was closed but there is
34c45ee4210d commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents: 8951
diff changeset
3399 still data that can be obtained with |ch_read()|.
8061
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 8031
diff changeset
3400
10233
d709622a18c9 commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents: 10228
diff changeset
3401 If {options} is given it can contain a "part" entry to specify
d709622a18c9 commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents: 10228
diff changeset
3402 the part of the channel to return the status for: "out" or
d709622a18c9 commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents: 10228
diff changeset
3403 "err". For example, to get the error status: >
d709622a18c9 commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents: 10228
diff changeset
3404 ch_status(job, {"part": "err"})
d709622a18c9 commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents: 10228
diff changeset
3405 <
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3406 changenr() *changenr()*
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3407 Return the number of the most recent change. This is the same
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3408 number as what is displayed with |:undolist| and can be used
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3409 with the |:undo| command.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3410 When a change was made it is the number of that change. After
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3411 redo it is the number of the redone change. After undo it is
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3412 one less than the number of the undone change.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3413
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
3414 char2nr({expr} [, {utf8}]) *char2nr()*
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3415 Return number value of the first char in {expr}. Examples: >
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3416 char2nr(" ") returns 32
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3417 char2nr("ABC") returns 65
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3418 < When {utf8} is omitted or zero, the current 'encoding' is used.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3419 Example for "utf-8": >
13482
9eebe457eb3c Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents: 13438
diff changeset
3420 char2nr("á") returns 225
9eebe457eb3c Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents: 13438
diff changeset
3421 char2nr("á"[0]) returns 195
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3422 < With {utf8} set to 1, always treat as utf-8 characters.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3423 A combining character is a separate character.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3424 |nr2char()| does the opposite.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3425
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3426 cindent({lnum}) *cindent()*
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3427 Get the amount of indent for line {lnum} according the C
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3428 indenting rules, as with 'cindent'.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3429 The indent is counted in spaces, the value of 'tabstop' is
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3430 relevant. {lnum} is used just like in |getline()|.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3431 When {lnum} is invalid or Vim was not compiled the |+cindent|
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3432 feature, -1 is returned.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3433 See |C-indenting|.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3434
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3435 clearmatches() *clearmatches()*
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3436 Clears all matches previously defined by |matchadd()| and the
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3437 |:match| commands.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3438
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3439 *col()*
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3440 col({expr}) The result is a Number, which is the byte index of the column
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3441 position given with {expr}. The accepted positions are:
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3442 . the cursor position
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3443 $ the end of the cursor line (the result is the
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3444 number of bytes in the cursor line plus one)
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3445 'x position of mark x (if the mark is not set, 0 is
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3446 returned)
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3447 v In Visual mode: the start of the Visual area (the
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3448 cursor is the end). When not in Visual mode
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3449 returns the cursor position. Differs from |'<| in
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3450 that it's updated right away.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3451 Additionally {expr} can be [lnum, col]: a |List| with the line
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3452 and column number. Most useful when the column is "$", to get
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3453 the last column of a specific line. When "lnum" or "col" is
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3454 out of range then col() returns zero.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3455 To get the line number use |line()|. To get both use
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3456 |getpos()|.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3457 For the screen column position use |virtcol()|.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3458 Note that only marks in the current file can be used.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3459 Examples: >
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3460 col(".") column of cursor
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3461 col("$") length of cursor line plus one
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3462 col("'t") column of mark t
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3463 col("'" . markname) column of mark markname
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3464 < The first column is 1. 0 is returned for an error.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3465 For an uppercase mark the column may actually be in another
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3466 buffer.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3467 For the cursor position, when 'virtualedit' is active, the
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3468 column is one higher if the cursor is after the end of the
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3469 line. This can be used to obtain the column in Insert mode: >
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3470 :imap <F2> <C-O>:let save_ve = &ve<CR>
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3471 \<C-O>:set ve=all<CR>
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3472 \<C-O>:echo col(".") . "\n" <Bar>
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3473 \let &ve = save_ve<CR>
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3474 <
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3475
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3476 complete({startcol}, {matches}) *complete()* *E785*
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3477 Set the matches for Insert mode completion.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3478 Can only be used in Insert mode. You need to use a mapping
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3479 with CTRL-R = (see |i_CTRL-R|). It does not work after CTRL-O
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3480 or with an expression mapping.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3481 {startcol} is the byte offset in the line where the completed
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3482 text start. The text up to the cursor is the original text
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3483 that will be replaced by the matches. Use col('.') for an
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3484 empty string. "col('.') - 1" will replace one character by a
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3485 match.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3486 {matches} must be a |List|. Each |List| item is one match.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3487 See |complete-items| for the kind of items that are possible.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3488 Note that the after calling this function you need to avoid
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3489 inserting anything that would cause completion to stop.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3490 The match can be selected with CTRL-N and CTRL-P as usual with
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3491 Insert mode completion. The popup menu will appear if
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3492 specified, see |ins-completion-menu|.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3493 Example: >
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3494 inoremap <F5> <C-R>=ListMonths()<CR>
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3495
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3496 func! ListMonths()
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3497 call complete(col('.'), ['January', 'February', 'March',
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3498 \ 'April', 'May', 'June', 'July', 'August', 'September',
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3499 \ 'October', 'November', 'December'])
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3500 return ''
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3501 endfunc
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3502 < This isn't very useful, but it shows how it works. Note that
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3503 an empty string is returned to avoid a zero being inserted.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3504
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3505 complete_add({expr}) *complete_add()*
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3506 Add {expr} to the list of matches. Only to be used by the
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3507 function specified with the 'completefunc' option.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3508 Returns 0 for failure (empty string or out of memory),
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3509 1 when the match was added, 2 when the match was already in
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3510 the list.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3511 See |complete-functions| for an explanation of {expr}. It is
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3512 the same as one item in the list that 'omnifunc' would return.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3513
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3514 complete_check() *complete_check()*
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3515 Check for a key typed while looking for completion matches.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3516 This is to be used when looking for matches takes some time.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3517 Returns |TRUE| when searching for matches is to be aborted,
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3518 zero otherwise.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3519 Only to be used by the function specified with the
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3520 'completefunc' option.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3521
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3522 *confirm()*
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3523 confirm({msg} [, {choices} [, {default} [, {type}]]])
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3524 Confirm() offers the user a dialog, from which a choice can be
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3525 made. It returns the number of the choice. For the first
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3526 choice this is 1.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3527 Note: confirm() is only supported when compiled with dialog
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3528 support, see |+dialog_con| and |+dialog_gui|.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3529
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3530 {msg} is displayed in a |dialog| with {choices} as the
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3531 alternatives. When {choices} is missing or empty, "&OK" is
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3532 used (and translated).
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3533 {msg} is a String, use '\n' to include a newline. Only on
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3534 some systems the string is wrapped when it doesn't fit.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3535
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3536 {choices} is a String, with the individual choices separated
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3537 by '\n', e.g. >
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3538 confirm("Save changes?", "&Yes\n&No\n&Cancel")
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3539 < The letter after the '&' is the shortcut key for that choice.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3540 Thus you can type 'c' to select "Cancel". The shortcut does
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3541 not need to be the first letter: >
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3542 confirm("file has been modified", "&Save\nSave &All")
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3543 < For the console, the first letter of each choice is used as
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3544 the default shortcut key.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3545
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3546 The optional {default} argument is the number of the choice
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3547 that is made if the user hits <CR>. Use 1 to make the first
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3548 choice the default one. Use 0 to not set a default. If
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3549 {default} is omitted, 1 is used.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3550
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3551 The optional {type} argument gives the type of dialog. This
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3552 is only used for the icon of the GTK, Mac, Motif and Win32
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3553 GUI. It can be one of these values: "Error", "Question",
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3554 "Info", "Warning" or "Generic". Only the first character is
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3555 relevant. When {type} is omitted, "Generic" is used.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3556
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3557 If the user aborts the dialog by pressing <Esc>, CTRL-C,
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3558 or another valid interrupt key, confirm() returns 0.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3559
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3560 An example: >
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3561 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2)
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3562 :if choice == 0
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3563 : echo "make up your mind!"
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3564 :elseif choice == 3
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3565 : echo "tasteful"
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3566 :else
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3567 : echo "I prefer bananas myself."
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3568 :endif
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3569 < In a GUI dialog, buttons are used. The layout of the buttons
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3570 depends on the 'v' flag in 'guioptions'. If it is included,
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3571 the buttons are always put vertically. Otherwise, confirm()
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3572 tries to put the buttons in one horizontal line. If they
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3573 don't fit, a vertical layout is used anyway. For some systems
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3574 the horizontal layout is always used.
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3575
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3576 *copy()*
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
3577 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3578 different from using {expr} directly.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3579 When {expr} is a |List| a shallow copy is created. This means
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3580 that the original |List| can be changed without changing the
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3581 copy, and vice versa. But the items are identical, thus
8019
d685893d852e commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents: 7992
diff changeset
3582 changing an item changes the contents of both |Lists|.
d685893d852e commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents: 7992
diff changeset
3583 A |Dictionary| is copied in a similar way as a |List|.
d685893d852e commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents: 7992
diff changeset
3584 Also see |deepcopy()|.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3585
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3586 cos({expr}) *cos()*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3587 Return the cosine of {expr}, measured in radians, as a |Float|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3588 {expr} must evaluate to a |Float| or a |Number|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3589 Examples: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3590 :echo cos(100)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3591 < 0.862319 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3592 :echo cos(-4.01)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3593 < -0.646043
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3594 {only available when compiled with the |+float| feature}
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3595
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3596
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3597 cosh({expr}) *cosh()*
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
3598 Return the hyperbolic cosine of {expr} as a |Float| in the range
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3599 [1, inf].
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
3600 {expr} must evaluate to a |Float| or a |Number|.
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3601 Examples: >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3602 :echo cosh(0.5)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3603 < 1.127626 >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3604 :echo cosh(-0.5)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3605 < -1.127626
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
3606 {only available when compiled with the |+float| feature}
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3607
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
3608
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
3609 count({comp}, {expr} [, {ic} [, {start}]]) *count()*
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3610 Return the number of times an item with value {expr} appears
11828
5a07a3ff56c1 patch 8.0.0794: checking translations fails with multiple NL
Christian Brabandt <cb@256bit.org>
parents: 11763
diff changeset
3611 in |String|, |List| or |Dictionary| {comp}.
5a07a3ff56c1 patch 8.0.0794: checking translations fails with multiple NL
Christian Brabandt <cb@256bit.org>
parents: 11763
diff changeset
3612
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
3613 If {start} is given then start with the item with this index.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3614 {start} can only be used with a |List|.
11828
5a07a3ff56c1 patch 8.0.0794: checking translations fails with multiple NL
Christian Brabandt <cb@256bit.org>
parents: 11763
diff changeset
3615
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
3616 When {ic} is given and it's |TRUE| then case is ignored.
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3617
11828
5a07a3ff56c1 patch 8.0.0794: checking translations fails with multiple NL
Christian Brabandt <cb@256bit.org>
parents: 11763
diff changeset
3618 When {comp} is a string then the number of not overlapping
13070
17720967656c patch 8.0.1410: hang when using count() with an empty string
Christian Brabandt <cb@256bit.org>
parents: 13062
diff changeset
3619 occurrences of {expr} is returned. Zero is returned when
17720967656c patch 8.0.1410: hang when using count() with an empty string
Christian Brabandt <cb@256bit.org>
parents: 13062
diff changeset
3620 {expr} is an empty string.
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
3621
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3622 *cscope_connection()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3623 cscope_connection([{num} , {dbpath} [, {prepend}]])
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3624 Checks for the existence of a |cscope| connection. If no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3625 parameters are specified, then the function returns:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3626 0, if cscope was not available (not compiled in), or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3627 if there are no cscope connections;
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3628 1, if there is at least one cscope connection.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3629
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3630 If parameters are specified, then the value of {num}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3631 determines how existence of a cscope connection is checked:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3632
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3633 {num} Description of existence check
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3634 ----- ------------------------------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3635 0 Same as no parameters (e.g., "cscope_connection()").
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3636 1 Ignore {prepend}, and use partial string matches for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3637 {dbpath}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3638 2 Ignore {prepend}, and use exact string matches for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3639 {dbpath}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3640 3 Use {prepend}, use partial string matches for both
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3641 {dbpath} and {prepend}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3642 4 Use {prepend}, use exact string matches for both
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3643 {dbpath} and {prepend}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3644
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3645 Note: All string comparisons are case sensitive!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3646
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3647 Examples. Suppose we had the following (from ":cs show"): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3648
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3649 # pid database name prepend path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3650 0 27664 cscope.out /usr/local
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3651 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3652 Invocation Return Val ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3653 ---------- ---------- >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3654 cscope_connection() 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3655 cscope_connection(1, "out") 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3656 cscope_connection(2, "out") 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3657 cscope_connection(3, "out") 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3658 cscope_connection(3, "out", "local") 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3659 cscope_connection(4, "out") 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3660 cscope_connection(4, "out", "local") 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3661 cscope_connection(4, "cscope.out", "/usr/local") 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3662 <
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3663 cursor({lnum}, {col} [, {off}]) *cursor()*
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3664 cursor({list})
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
3665 Positions the cursor at the column (byte count) {col} in the
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
3666 line {lnum}. The first column is one.
5938
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
3667
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3668 When there is one argument {list} this is used as a |List|
5938
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
3669 with two, three or four item:
8876
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
3670 [{lnum}, {col}]
5938
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
3671 [{lnum}, {col}, {off}]
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
3672 [{lnum}, {col}, {off}, {curswant}]
6009
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6007
diff changeset
3673 This is like the return value of |getpos()| or |getcurpos()|,
5944
332a5c2b2956 updated for version 7.4.313
Bram Moolenaar <bram@vim.org>
parents: 5942
diff changeset
3674 but without the first item.
5938
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
3675
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3676 Does not change the jumplist.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3677 If {lnum} is greater than the number of lines in the buffer,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3678 the cursor will be positioned at the last line in the buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3679 If {lnum} is zero, the cursor will stay in the current line.
493
06364aa0d597 updated for version 7.0135
vimboss
parents: 484
diff changeset
3680 If {col} is greater than the number of bytes in the line,
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3681 the cursor will be positioned at the last character in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3682 line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3683 If {col} is zero, the cursor will stay in the current column.
5944
332a5c2b2956 updated for version 7.4.313
Bram Moolenaar <bram@vim.org>
parents: 5942
diff changeset
3684 If {curswant} is given it is used to set the preferred column
6180
6921742f396a Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6153
diff changeset
3685 for vertical movement. Otherwise {col} is used.
6385
f654ad95fd4e Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6369
diff changeset
3686
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3687 When 'virtualedit' is used {off} specifies the offset in
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
3688 screen columns from the start of the character. E.g., a
1266
54588e2e8041 updated for version 7.1
vimboss
parents: 1215
diff changeset
3689 position within a <Tab> or after the last character.
1851
e7f6ca5594cf updated for version 7.2-149
vimboss
parents: 1768
diff changeset
3690 Returns 0 when the position could be set, -1 otherwise.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3691
14147
de75c249723d patch 8.1.0091: MS-Windows: Cannot interrupt gdb when program is running
Christian Brabandt <cb@256bit.org>
parents: 14123
diff changeset
3692 debugbreak({pid}) *debugbreak()*
de75c249723d patch 8.1.0091: MS-Windows: Cannot interrupt gdb when program is running
Christian Brabandt <cb@256bit.org>
parents: 14123
diff changeset
3693 Specifically used to interrupt a program being debugged. It
de75c249723d patch 8.1.0091: MS-Windows: Cannot interrupt gdb when program is running
Christian Brabandt <cb@256bit.org>
parents: 14123
diff changeset
3694 will cause process {pid} to get a SIGTRAP. Behavior for other
de75c249723d patch 8.1.0091: MS-Windows: Cannot interrupt gdb when program is running
Christian Brabandt <cb@256bit.org>
parents: 14123
diff changeset
3695 processes is undefined. See |terminal-debugger|.
de75c249723d patch 8.1.0091: MS-Windows: Cannot interrupt gdb when program is running
Christian Brabandt <cb@256bit.org>
parents: 14123
diff changeset
3696 {only available on MS-Windows}
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3697
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
3698 deepcopy({expr} [, {noref}]) *deepcopy()* *E698*
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
3699 Make a copy of {expr}. For Numbers and Strings this isn't
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3700 different from using {expr} directly.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3701 When {expr} is a |List| a full copy is created. This means
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3702 that the original |List| can be changed without changing the
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
3703 copy, and vice versa. When an item is a |List| or
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
3704 |Dictionary|, a copy for it is made, recursively. Thus
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
3705 changing an item in the copy does not change the contents of
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
3706 the original |List|.
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
3707 A |Dictionary| is copied in a similar way as a |List|.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3708 When {noref} is omitted or zero a contained |List| or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3709 |Dictionary| is only copied once. All references point to
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3710 this single copy. With {noref} set to 1 every occurrence of a
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3711 |List| or |Dictionary| results in a new copy. This also means
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3712 that a cyclic reference causes deepcopy() to fail.
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
3713 *E724*
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
3714 Nesting is possible up to 100 levels. When there is an item
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
3715 that refers back to a higher level making a deep copy with
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
3716 {noref} set to 1 will fail.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3717 Also see |copy()|.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
3718
7615
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents: 7597
diff changeset
3719 delete({fname} [, {flags}]) *delete()*
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents: 7597
diff changeset
3720 Without {flags} or with {flags} empty: Deletes the file by the
7629
befbed72da87 commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents: 7615
diff changeset
3721 name {fname}. This also works when {fname} is a symbolic link.
7615
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents: 7597
diff changeset
3722
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents: 7597
diff changeset
3723 When {flags} is "d": Deletes the directory by the name
7629
befbed72da87 commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents: 7615
diff changeset
3724 {fname}. This fails when directory {fname} is not empty.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
3725
7615
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents: 7597
diff changeset
3726 When {flags} is "rf": Deletes the directory by the name
7629
befbed72da87 commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents: 7615
diff changeset
3727 {fname} and everything in it, recursively. BE CAREFUL!
10027
018fead968c1 commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents: 10004
diff changeset
3728 Note: on MS-Windows it is not possible to delete a directory
018fead968c1 commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents: 10004
diff changeset
3729 that is being used.
10004
8061455d9179 commit https://github.com/vim/vim/commit/818078ddfbb8cc2546f697c5675a251d095722ec
Christian Brabandt <cb@256bit.org>
parents: 10000
diff changeset
3730
7629
befbed72da87 commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents: 7615
diff changeset
3731 A symbolic link itself is deleted, not what it points to.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
3732
7615
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents: 7597
diff changeset
3733 The result is a Number, which is 0 if the delete operation was
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents: 7597
diff changeset
3734 successful and -1 when the deletion failed or partly failed.
228ff048db20 commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents: 7597
diff changeset
3735
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3736 Use |remove()| to delete an item from a |List|.
14043
cbad3b3f46b2 patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents: 14039
diff changeset
3737 To delete a line from the buffer use |:delete| or
cbad3b3f46b2 patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents: 14039
diff changeset
3738 |deletebufline()|.
cbad3b3f46b2 patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents: 14039
diff changeset
3739
14519
5c5908e81e93 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14422
diff changeset
3740 deletebufline({expr}, {first} [, {last}]) *deletebufline()*
14043
cbad3b3f46b2 patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents: 14039
diff changeset
3741 Delete lines {first} to {last} (inclusive) from buffer {expr}.
cbad3b3f46b2 patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents: 14039
diff changeset
3742 If {last} is omitted then delete line {first} only.
cbad3b3f46b2 patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents: 14039
diff changeset
3743 On success 0 is returned, on failure 1 is returned.
cbad3b3f46b2 patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents: 14039
diff changeset
3744
cbad3b3f46b2 patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents: 14039
diff changeset
3745 For the use of {expr}, see |bufname()| above.
cbad3b3f46b2 patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents: 14039
diff changeset
3746
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
3747 {first} and {last} are used like with |getline()|. Note that
14043
cbad3b3f46b2 patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents: 14039
diff changeset
3748 when using |line()| this refers to the current buffer. Use "$"
cbad3b3f46b2 patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents: 14039
diff changeset
3749 to refer to the last line in buffer {expr}.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3750
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3751 *did_filetype()*
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
3752 did_filetype() Returns |TRUE| when autocommands are being executed and the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3753 FileType event has been triggered at least once. Can be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3754 to avoid triggering the FileType event again in the scripts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3755 that detect the file type. |FileType|
11473
bd6ff5246c71 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11442
diff changeset
3756 Returns |FALSE| when `:setf FALLBACK` was used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3757 When editing another file, the counter is reset, thus this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3758 really checks if the FileType event has been triggered for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3759 current buffer. This allows an autocommand that starts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3760 editing another buffer to set 'filetype' and load a syntax
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3761 file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3762
32
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3763 diff_filler({lnum}) *diff_filler()*
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3764 Returns the number of filler lines above line {lnum}.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3765 These are the lines that were inserted at this point in
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3766 another diff'ed window. These filler lines are shown in the
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3767 display but don't exist in the buffer.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3768 {lnum} is used like with |getline()|. Thus "." is the current
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3769 line, "'m" mark m, etc.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3770 Returns 0 if the current window is not in diff mode.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3771
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3772 diff_hlID({lnum}, {col}) *diff_hlID()*
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3773 Returns the highlight ID for diff mode at line {lnum} column
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3774 {col} (byte index). When the current line does not have a
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3775 diff change zero is returned.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3776 {lnum} is used like with |getline()|. Thus "." is the current
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3777 line, "'m" mark m, etc.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3778 {col} is 1 for the leftmost column, {lnum} is 1 for the first
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3779 line.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3780 The highlight ID can be used with |synIDattr()| to obtain
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3781 syntax information about the highlighting.
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
3782
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
3783 empty({expr}) *empty()*
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
3784 Return the Number 1 if {expr} is empty, zero otherwise.
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
3785 - A |List| or |Dictionary| is empty when it does not have any
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
3786 items.
15498
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
3787 - A |String| is empty when its length is zero.
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
3788 - A |Number| and |Float| are empty when their value is zero.
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
3789 - |v:false|, |v:none| and |v:null| are empty, |v:true| is not.
15498
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
3790 - A |Job| is empty when it failed to start.
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
3791 - A |Channel| is empty when it is closed.
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
3792 - A |Blob| is empty when its length is zero.
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
3793
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
3794 For a long |List| this is much faster than comparing the
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3795 length with zero.
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
3796
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3797 escape({string}, {chars}) *escape()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3798 Escape the characters in {chars} that occur in {string} with a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3799 backslash. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3800 :echo escape('c:\program files\vim', ' \')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3801 < results in: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3802 c:\\program\ files\\vim
12427
fc3e2d5614dd patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents: 12389
diff changeset
3803 < Also see |shellescape()| and |fnameescape()|.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3804
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3805 *eval()*
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3806 eval({string}) Evaluate {string} and return the result. Especially useful to
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3807 turn the result of |string()| back into the original value.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3808 This works for Numbers, Floats, Strings and composites of
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3809 them. Also works for |Funcref|s that refer to existing
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
3810 functions.
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
3811
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3812 eventhandler() *eventhandler()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3813 Returns 1 when inside an event handler. That is that Vim got
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3814 interrupted while waiting for the user to type a character,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3815 e.g., when dropping a file on Vim. This means interactive
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3816 commands cannot be used. Otherwise zero is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3817
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3818 executable({expr}) *executable()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3819 This function checks if an executable with the name {expr}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3820 exists. {expr} must be the name of the program without any
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
3821 arguments.
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
3822 executable() uses the value of $PATH and/or the normal
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
3823 searchpath for programs. *PATHEXT*
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
3824 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
3825 optionally be included. Then the extensions in $PATHEXT are
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
3826 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
3827 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
3828 used. A dot by itself can be used in $PATHEXT to try using
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
3829 the name without an extension. When 'shell' looks like a
10
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
3830 Unix shell, then the name is also tried without adding an
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
3831 extension.
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
3832 On MS-DOS and MS-Windows it only checks if the file exists and
4e2284e71352 updated for version 7.0002
vimboss
parents: 9
diff changeset
3833 is not a directory, not if it's really executable.
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3834 On MS-Windows an executable in the same directory as Vim is
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3835 always found. Since this directory is added to $PATH it
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
3836 should also work to execute it |win32-PATH|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3837 The result is a Number:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3838 1 exists
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3839 0 does not exist
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3840 -1 not implemented on this system
14249
4543777545a3 Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents: 14193
diff changeset
3841 |exepath()| can be used to get the full path of an executable.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3842
9454
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3843 execute({command} [, {silent}]) *execute()*
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3844 Execute an Ex command or commands and return the output as a
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3845 string.
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3846 {command} can be a string or a List. In case of a List the
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3847 lines are executed one by one.
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3848 This is equivalent to: >
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3849 redir => var
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3850 {command}
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3851 redir END
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3852 <
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3853 The optional {silent} argument can have these values:
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3854 "" no `:silent` used
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3855 "silent" `:silent` used
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3856 "silent!" `:silent!` used
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
3857 The default is "silent". Note that with "silent!", unlike
9527
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
3858 `:redir`, error messages are dropped. When using an external
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
3859 command the screen may be messed up, use `system()` instead.
9454
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3860 *E930*
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3861 It is not possible to use `:redir` anywhere in {command}.
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3862
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3863 To get a list of lines use |split()| on the result: >
9464
be72f4201a1d commit https://github.com/vim/vim/commit/063b9d15abea041a5bfff3ffc4e219e26fd1d4fa
Christian Brabandt <cb@256bit.org>
parents: 9460
diff changeset
3864 split(execute('args'), "\n")
9454
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3865
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3866 < When used recursively the output of the recursive call is not
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3867 included in the output of the higher level call.
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
3868
5782
5ab2946f7ce5 updated for version 7.4.235
Bram Moolenaar <bram@vim.org>
parents: 5780
diff changeset
3869 exepath({expr}) *exepath()*
5ab2946f7ce5 updated for version 7.4.235
Bram Moolenaar <bram@vim.org>
parents: 5780
diff changeset
3870 If {expr} is an executable and is either an absolute path, a
5ab2946f7ce5 updated for version 7.4.235
Bram Moolenaar <bram@vim.org>
parents: 5780
diff changeset
3871 relative path or found in $PATH, return the full path.
5ab2946f7ce5 updated for version 7.4.235
Bram Moolenaar <bram@vim.org>
parents: 5780
diff changeset
3872 Note that the current directory is used when {expr} starts
5ab2946f7ce5 updated for version 7.4.235
Bram Moolenaar <bram@vim.org>
parents: 5780
diff changeset
3873 with "./", which may be a problem for Vim: >
5ab2946f7ce5 updated for version 7.4.235
Bram Moolenaar <bram@vim.org>
parents: 5780
diff changeset
3874 echo exepath(v:progpath)
5814
755931e042e4 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5808
diff changeset
3875 < If {expr} cannot be found in $PATH or is not executable then
5782
5ab2946f7ce5 updated for version 7.4.235
Bram Moolenaar <bram@vim.org>
parents: 5780
diff changeset
3876 an empty string is returned.
5ab2946f7ce5 updated for version 7.4.235
Bram Moolenaar <bram@vim.org>
parents: 5780
diff changeset
3877
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3878 *exists()*
9790
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
3879 exists({expr}) The result is a Number, which is |TRUE| if {expr} is defined,
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
3880 zero otherwise.
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
3881
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
3882 For checking for a supported feature use |has()|.
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
3883 For checking if a file exists use |filereadable()|.
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
3884
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
3885 The {expr} argument is a string, which contains one of these:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3886 &option-name Vim option (only checks if it exists,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3887 not if it really works)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3888 +option-name Vim option that works.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3889 $ENVNAME environment variable (could also be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3890 done by comparing with an empty
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3891 string)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3892 *funcname built-in function (see |functions|)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3893 or user defined function (see
5862
306caa30d83b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 5815
diff changeset
3894 |user-functions|). Also works for a
306caa30d83b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 5815
diff changeset
3895 variable that is a Funcref.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3896 varname internal variable (see
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
3897 |internal-variables|). Also works
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3898 for |curly-braces-names|, |Dictionary|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
3899 entries, |List| items, etc. Beware
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
3900 that evaluating an index may cause an
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
3901 error message for an invalid
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
3902 expression. E.g.: >
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
3903 :let l = [1, 2, 3]
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
3904 :echo exists("l[5]")
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
3905 < 0 >
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
3906 :echo exists("l[xx]")
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
3907 < E121: Undefined variable: xx
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
3908 0
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3909 :cmdname Ex command: built-in command, user
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3910 command or command modifier |:command|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3911 Returns:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3912 1 for match with start of a command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3913 2 full match with a command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3914 3 matches several user commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3915 To check for a supported command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3916 always check the return value to be 2.
864
bc620d6bdf06 updated for version 7.0g03
vimboss
parents: 859
diff changeset
3917 :2match The |:2match| command.
bc620d6bdf06 updated for version 7.0g03
vimboss
parents: 859
diff changeset
3918 :3match The |:3match| command.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3919 #event autocommand defined for this event
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3920 #event#pattern autocommand defined for this event and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3921 pattern (the pattern is taken
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3922 literally and compared to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3923 autocommand patterns character by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3924 character)
613
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
3925 #group autocommand group exists
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
3926 #group#event autocommand defined for this group and
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
3927 event.
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
3928 #group#event#pattern
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
3929 autocommand defined for this group,
613
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
3930 event and pattern.
615
7fe13e0f5dce updated for version 7.0175
vimboss
parents: 613
diff changeset
3931 ##event autocommand for this event is
7fe13e0f5dce updated for version 7.0175
vimboss
parents: 613
diff changeset
3932 supported.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3933
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3934 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3935 exists("&shortname")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3936 exists("$HOSTNAME")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3937 exists("*strftime")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3938 exists("*s:MyFunc")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3939 exists("bufcount")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3940 exists(":Make")
613
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
3941 exists("#CursorHold")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3942 exists("#BufReadPre#*.gz")
613
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
3943 exists("#filetypeindent")
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
3944 exists("#filetypeindent#FileType")
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
3945 exists("#filetypeindent#FileType#*")
615
7fe13e0f5dce updated for version 7.0175
vimboss
parents: 613
diff changeset
3946 exists("##ColorScheme")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3947 < There must be no space between the symbol (&/$/*/#) and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3948 name.
867
a5677b7ce858 updated for version 7.0g04
vimboss
parents: 864
diff changeset
3949 There must be no extra characters after the name, although in
a5677b7ce858 updated for version 7.0g04
vimboss
parents: 864
diff changeset
3950 a few cases this is ignored. That may become more strict in
a5677b7ce858 updated for version 7.0g04
vimboss
parents: 864
diff changeset
3951 the future, thus don't count on it!
a5677b7ce858 updated for version 7.0g04
vimboss
parents: 864
diff changeset
3952 Working example: >
a5677b7ce858 updated for version 7.0g04
vimboss
parents: 864
diff changeset
3953 exists(":make")
a5677b7ce858 updated for version 7.0g04
vimboss
parents: 864
diff changeset
3954 < NOT working example: >
a5677b7ce858 updated for version 7.0g04
vimboss
parents: 864
diff changeset
3955 exists(":make install")
859
99305c4c42d4 updated for version 7.0g02
vimboss
parents: 857
diff changeset
3956
99305c4c42d4 updated for version 7.0g02
vimboss
parents: 857
diff changeset
3957 < Note that the argument must be a string, not the name of the
99305c4c42d4 updated for version 7.0g02
vimboss
parents: 857
diff changeset
3958 variable itself. For example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3959 exists(bufcount)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3960 < This doesn't check for existence of the "bufcount" variable,
853
d10fbefd3bc1 updated for version 7.0f05
vimboss
parents: 844
diff changeset
3961 but gets the value of "bufcount", and checks if that exists.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3962
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3963 exp({expr}) *exp()*
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
3964 Return the exponential of {expr} as a |Float| in the range
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3965 [0, inf].
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
3966 {expr} must evaluate to a |Float| or a |Number|.
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3967 Examples: >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3968 :echo exp(2)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3969 < 7.389056 >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3970 :echo exp(-1)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3971 < 0.367879
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
3972 {only available when compiled with the |+float| feature}
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3973
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
3974
3410
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
3975 expand({expr} [, {nosuf} [, {list}]]) *expand()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3976 Expand wildcards and the following special keywords in {expr}.
3410
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
3977 'wildignorecase' applies.
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
3978
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
3979 If {list} is given and it is |TRUE|, a List will be returned.
3410
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
3980 Otherwise the result is a String and when there are several
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
3981 matches, they are separated by <NL> characters. [Note: in
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
3982 version 5.0 a space was used, which caused problems when a
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
3983 file name contains a space]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3984
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
3985 If the expansion fails, the result is an empty string. A name
4869
a5352e73dc00 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4835
diff changeset
3986 for a non-existing file is not included, unless {expr} does
a5352e73dc00 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4835
diff changeset
3987 not start with '%', '#' or '<', see below.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3988
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3989 When {expr} starts with '%', '#' or '<', the expansion is done
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3990 like for the |cmdline-special| variables with their associated
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3991 modifiers. Here is a short overview:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3992
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3993 % current file name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3994 # alternate file name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3995 #n alternate file name n
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3996 <cfile> file name under the cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3997 <afile> autocmd file name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3998 <abuf> autocmd buffer number (as a String!)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3999 <amatch> autocmd matched name
5734
657ade71d395 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5692
diff changeset
4000 <sfile> sourced script file or function name
14700
0a3b9ecf7cb8 patch 8.1.0362: cannot get the script line number when executing a function
Christian Brabandt <cb@256bit.org>
parents: 14695
diff changeset
4001 <slnum> sourced script line number or function
0a3b9ecf7cb8 patch 8.1.0362: cannot get the script line number when executing a function
Christian Brabandt <cb@256bit.org>
parents: 14695
diff changeset
4002 line number
0a3b9ecf7cb8 patch 8.1.0362: cannot get the script line number when executing a function
Christian Brabandt <cb@256bit.org>
parents: 14695
diff changeset
4003 <sflnum> script file line number, also when in
0a3b9ecf7cb8 patch 8.1.0362: cannot get the script line number when executing a function
Christian Brabandt <cb@256bit.org>
parents: 14695
diff changeset
4004 a function
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4005 <cword> word under the cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4006 <cWORD> WORD under the cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4007 <client> the {clientid} of the last received
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4008 message |server2client()|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4009 Modifiers:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4010 :p expand to full path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4011 :h head (last path component removed)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4012 :t tail (last path component only)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4013 :r root (one extension removed)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4014 :e extension only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4015
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4016 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4017 :let &tags = expand("%:p:h") . "/tags"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4018 < Note that when expanding a string that starts with '%', '#' or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4019 '<', any following text is ignored. This does NOT work: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4020 :let doesntwork = expand("%:h.bak")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4021 < Use this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4022 :let doeswork = expand("%:h") . ".bak"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4023 < Also note that expanding "<cfile>" and others only returns the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4024 referenced file name without further expansion. If "<cfile>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4025 is "~/.cshrc", you need to do another expand() to have the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4026 "~/" expanded into the path of the home directory: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4027 :echo expand(expand("<cfile>"))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4028 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4029 There cannot be white space between the variables and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4030 following modifier. The |fnamemodify()| function can be used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4031 to modify normal file names.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4032
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4033 When using '%' or '#', and the current or alternate file name
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4034 is not defined, an empty string is used. Using "%:p" in a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4035 buffer with no name, results in the current directory, with a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4036 '/' added.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4037
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4038 When {expr} does not start with '%', '#' or '<', it is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4039 expanded like a file name is expanded on the command line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4040 'suffixes' and 'wildignore' are used, unless the optional
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
4041 {nosuf} argument is given and it is |TRUE|.
3398
d1096a4e96bd updated for version 7.3.465
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
4042 Names for non-existing files are included. The "**" item can
d1096a4e96bd updated for version 7.3.465
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
4043 be used to search in a directory tree. For example, to find
d1096a4e96bd updated for version 7.3.465
Bram Moolenaar <bram@vim.org>
parents: 3312
diff changeset
4044 all "README" files in the current directory and below: >
444
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
4045 :echo expand("**/README")
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
4046 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4047 Expand() can also be used to expand variables and environment
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4048 variables that are only known in a shell. But this can be
6180
6921742f396a Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6153
diff changeset
4049 slow, because a shell may be used to do the expansion. See
6921742f396a Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6153
diff changeset
4050 |expr-env-expand|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4051 The expanded variable is still handled like a list of file
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
4052 names. When an environment variable cannot be expanded, it is
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4053 left unchanged. Thus ":echo expand('$FOOBAR')" results in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4054 "$FOOBAR".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4055
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4056 See |glob()| for finding existing files. See |system()| for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4057 getting the raw output of an external command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4058
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4059 extend({expr1}, {expr2} [, {expr3}]) *extend()*
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4060 {expr1} and {expr2} must be both |Lists| or both
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4061 |Dictionaries|.
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4062
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4063 If they are |Lists|: Append {expr2} to {expr1}.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4064 If {expr3} is given insert the items of {expr2} before item
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4065 {expr3} in {expr1}. When {expr3} is zero insert before the
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4066 first item. When {expr3} is equal to len({expr1}) then
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4067 {expr2} is appended.
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
4068 Examples: >
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
4069 :echo sort(extend(mylist, [7, 5]))
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
4070 :call extend(mylist, [2, 3], 1)
1699
9d74e2f433c0 updated for version 7.2c-001
vimboss
parents: 1698
diff changeset
4071 < When {expr1} is the same List as {expr2} then the number of
9d74e2f433c0 updated for version 7.2c-001
vimboss
parents: 1698
diff changeset
4072 items copied is equal to the original length of the List.
9d74e2f433c0 updated for version 7.2c-001
vimboss
parents: 1698
diff changeset
4073 E.g., when {expr3} is 1 you get N new copies of the first item
9d74e2f433c0 updated for version 7.2c-001
vimboss
parents: 1698
diff changeset
4074 (where N is the original length of the List).
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
4075 Use |add()| to concatenate one item to a list. To concatenate
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4076 two lists into a new list use the + operator: >
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
4077 :let newlist = [1, 2, 3] + [4, 5]
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4078 <
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
4079 If they are |Dictionaries|:
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4080 Add all entries from {expr2} to {expr1}.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4081 If a key exists in both {expr1} and {expr2} then {expr3} is
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4082 used to decide what to do:
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4083 {expr3} = "keep": keep the value of {expr1}
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4084 {expr3} = "force": use the value of {expr2}
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
4085 {expr3} = "error": give an error message *E737*
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4086 When {expr3} is omitted then "force" is assumed.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4087
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4088 {expr1} is changed when {expr2} is not empty. If necessary
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4089 make a copy of {expr1} first.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4090 {expr2} remains unchanged.
6823
0303182665d5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6741
diff changeset
4091 When {expr1} is locked and {expr2} is not empty the operation
0303182665d5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6741
diff changeset
4092 fails.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4093 Returns {expr1}.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4094
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
4095
842
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
4096 feedkeys({string} [, {mode}]) *feedkeys()*
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
4097 Characters in {string} are queued for processing as if they
6549
2561531decf1 updated for version 7.4.601
Bram Moolenaar <bram@vim.org>
parents: 6530
diff changeset
4098 come from a mapping or were typed by the user.
15378
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
4099
6549
2561531decf1 updated for version 7.4.601
Bram Moolenaar <bram@vim.org>
parents: 6530
diff changeset
4100 By default the string is added to the end of the typeahead
2561531decf1 updated for version 7.4.601
Bram Moolenaar <bram@vim.org>
parents: 6530
diff changeset
4101 buffer, thus if a mapping is still being executed the
2561531decf1 updated for version 7.4.601
Bram Moolenaar <bram@vim.org>
parents: 6530
diff changeset
4102 characters come after them. Use the 'i' flag to insert before
2561531decf1 updated for version 7.4.601
Bram Moolenaar <bram@vim.org>
parents: 6530
diff changeset
4103 other characters, they will be executed next, before any
2561531decf1 updated for version 7.4.601
Bram Moolenaar <bram@vim.org>
parents: 6530
diff changeset
4104 characters from a mapping.
15378
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
4105
842
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
4106 The function does not wait for processing of keys contained in
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
4107 {string}.
15378
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
4108
842
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
4109 To include special keys into {string}, use double-quotes
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
4110 and "\..." notation |expr-quote|. For example,
1215
1d08aac0aea9 updated for version 7.1b
vimboss
parents: 1156
diff changeset
4111 feedkeys("\<CR>") simulates pressing of the <Enter> key. But
842
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
4112 feedkeys('\<CR>') pushes 5 characters.
15378
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
4113
842
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
4114 {mode} is a String, which can contain these character flags:
15378
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
4115 'm' Remap keys. This is default. If {mode} is absent,
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
4116 keys are remapped.
843
9f279ebda751 updated for version 7.0f01
vimboss
parents: 842
diff changeset
4117 'n' Do not remap keys.
9f279ebda751 updated for version 7.0f01
vimboss
parents: 842
diff changeset
4118 't' Handle keys as if typed; otherwise they are handled as
9f279ebda751 updated for version 7.0f01
vimboss
parents: 842
diff changeset
4119 if coming from a mapping. This matters for undo,
9f279ebda751 updated for version 7.0f01
vimboss
parents: 842
diff changeset
4120 opening folds, etc.
6549
2561531decf1 updated for version 7.4.601
Bram Moolenaar <bram@vim.org>
parents: 6530
diff changeset
4121 'i' Insert the string instead of appending (see above).
7703
39251e981d1f commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents: 7659
diff changeset
4122 'x' Execute commands until typeahead is empty. This is
39251e981d1f commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents: 7659
diff changeset
4123 similar to using ":normal!". You can call feedkeys()
39251e981d1f commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents: 7659
diff changeset
4124 several times without 'x' and then one time with 'x'
39251e981d1f commit https://github.com/vim/vim/commit/25281634cda03ce302aaf9f906a9520b5f81f91e
Christian Brabandt <cb@256bit.org>
parents: 7659
diff changeset
4125 (possibly with an empty {string}) to execute all the
8876
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
4126 typeahead. Note that when Vim ends in Insert mode it
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
4127 will behave as if <Esc> is typed, to avoid getting
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
4128 stuck, waiting for a character to be typed before the
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
4129 script continues.
15378
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
4130 Note that if you manage to call feedkeys() while
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
4131 executing commands, thus calling it recursively, then
15378
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
4132 all typehead will be consumed by the last call.
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
4133 '!' When used with 'x' will not end Insert mode. Can be
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
4134 used in a test when a timer is set to exit Insert mode
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
4135 a little later. Useful for testing CursorHoldI.
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
4136
842
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
4137 Return value is always 0.
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
4138
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4139 filereadable({file}) *filereadable()*
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
4140 The result is a Number, which is |TRUE| when a file with the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4141 name {file} exists, and can be read. If {file} doesn't exist,
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
4142 or is a directory, the result is |FALSE|. {file} is any
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4143 expression, which is used as a String.
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
4144 If you don't care about the file being readable you can use
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
4145 |glob()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4146 *file_readable()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4147 Obsolete name: file_readable().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4148
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
4149
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
4150 filewritable({file}) *filewritable()*
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
4151 The result is a Number, which is 1 when a file with the
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
4152 name {file} exists, and can be written. If {file} doesn't
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4153 exist, or is not writable, the result is 0. If {file} is a
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
4154 directory, and we can write to it, the result is 2.
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
4155
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
4156
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4157 filter({expr1}, {expr2}) *filter()*
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4158 {expr1} must be a |List| or a |Dictionary|.
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4159 For each item in {expr1} evaluate {expr2} and when the result
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4160 is zero remove the item from the |List| or |Dictionary|.
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4161 {expr2} must be a |string| or |Funcref|.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
4162
10218
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
4163 If {expr2} is a |string|, inside {expr2} |v:val| has the value
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4164 of the current item. For a |Dictionary| |v:key| has the key
10218
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
4165 of the current item and for a |List| |v:key| has the index of
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
4166 the current item.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4167 Examples: >
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4168 call filter(mylist, 'v:val !~ "OLD"')
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4169 < Removes the items where "OLD" appears. >
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4170 call filter(mydict, 'v:key >= 8')
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4171 < Removes the items with a key below 8. >
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4172 call filter(var, 0)
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4173 < Removes all the items, thus clears the |List| or |Dictionary|.
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
4174
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4175 Note that {expr2} is the result of expression and is then
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4176 used as an expression again. Often it is good to use a
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4177 |literal-string| to avoid having to double backslashes.
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4178
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4179 If {expr2} is a |Funcref| it must take two arguments:
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4180 1. the key or the index of the current item.
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4181 2. the value of the current item.
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
4182 The function must return |TRUE| if the item should be kept.
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4183 Example that keeps the odd items of a list: >
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4184 func Odd(idx, val)
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4185 return a:idx % 2 == 1
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4186 endfunc
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4187 call filter(mylist, function('Odd'))
10218
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
4188 < It is shorter when using a |lambda|: >
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
4189 call filter(myList, {idx, val -> idx * val <= 42})
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
4190 < If you do not use "val" you can leave it out: >
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
4191 call filter(myList, {idx -> idx % 2 == 1})
10244
876fbdd84e52 commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents: 10237
diff changeset
4192 <
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4193 The operation is done in-place. If you want a |List| or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4194 |Dictionary| to remain unmodified make a copy first: >
650
662e40bd2be1 updated for version 7.0191
vimboss
parents: 648
diff changeset
4195 :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4196
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4197 < Returns {expr1}, the |List| or |Dictionary| that was filtered.
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4198 When an error is encountered while evaluating {expr2} no
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4199 further items in {expr1} are processed. When {expr2} is a
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4200 Funcref errors inside a function are ignored, unless it was
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
4201 defined with the "abort" flag.
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
4202
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
4203
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
4204 finddir({name} [, {path} [, {count}]]) *finddir()*
1095
4c8b90b7a94a updated for version 7.0-221
vimboss
parents: 1065
diff changeset
4205 Find directory {name} in {path}. Supports both downwards and
4c8b90b7a94a updated for version 7.0-221
vimboss
parents: 1065
diff changeset
4206 upwards recursive directory searches. See |file-searching|
4c8b90b7a94a updated for version 7.0-221
vimboss
parents: 1065
diff changeset
4207 for the syntax of {path}.
4c8b90b7a94a updated for version 7.0-221
vimboss
parents: 1065
diff changeset
4208 Returns the path of the first found match. When the found
4c8b90b7a94a updated for version 7.0-221
vimboss
parents: 1065
diff changeset
4209 directory is below the current directory a relative path is
4c8b90b7a94a updated for version 7.0-221
vimboss
parents: 1065
diff changeset
4210 returned. Otherwise a full path is returned.
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
4211 If {path} is omitted or empty then 'path' is used.
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
4212 If the optional {count} is given, find {count}'s occurrence of
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
4213 {name} in {path} instead of the first one.
809
4f1b94b51e99 updated for version 7.0b02
vimboss
parents: 805
diff changeset
4214 When {count} is negative return all the matches in a |List|.
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
4215 This is quite similar to the ex-command |:find|.
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
4216 {only available when compiled with the |+file_in_path|
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
4217 feature}
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
4218
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
4219 findfile({name} [, {path} [, {count}]]) *findfile()*
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
4220 Just like |finddir()|, but find a file instead of a directory.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
4221 Uses 'suffixesadd'.
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
4222 Example: >
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
4223 :echo findfile("tags.vim", ".;")
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
4224 < Searches from the directory of the current file upwards until
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
4225 it finds the file "tags.vim".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4226
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4227 float2nr({expr}) *float2nr()*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4228 Convert {expr} to a Number by omitting the part after the
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4229 decimal point.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4230 {expr} must evaluate to a |Float| or a Number.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4231 When the value of {expr} is out of range for a |Number| the
9389
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
4232 result is truncated to 0x7fffffff or -0x7fffffff (or when
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
4233 64-bit Number support is enabled, 0x7fffffffffffffff or
12427
fc3e2d5614dd patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents: 12389
diff changeset
4234 -0x7fffffffffffffff). NaN results in -0x80000000 (or when
9389
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
4235 64-bit Number support is enabled, -0x8000000000000000).
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4236 Examples: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4237 echo float2nr(3.95)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4238 < 3 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4239 echo float2nr(-23.45)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4240 < -23 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4241 echo float2nr(1.0e100)
9389
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
4242 < 2147483647 (or 9223372036854775807) >
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4243 echo float2nr(-1.0e150)
9389
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
4244 < -2147483647 (or -9223372036854775807) >
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4245 echo float2nr(1.0e-100)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4246 < 0
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4247 {only available when compiled with the |+float| feature}
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4248
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4249
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4250 floor({expr}) *floor()*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4251 Return the largest integral value less than or equal to
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4252 {expr} as a |Float| (round down).
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4253 {expr} must evaluate to a |Float| or a |Number|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4254 Examples: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4255 echo floor(1.856)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4256 < 1.0 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4257 echo floor(-5.456)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4258 < -6.0 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4259 echo floor(4.0)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4260 < 4.0
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4261 {only available when compiled with the |+float| feature}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
4262
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
4263
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
4264 fmod({expr1}, {expr2}) *fmod()*
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
4265 Return the remainder of {expr1} / {expr2}, even if the
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
4266 division is not representable. Returns {expr1} - i * {expr2}
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
4267 for some integer i such that if {expr2} is non-zero, the
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
4268 result has the same sign as {expr1} and magnitude less than
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
4269 the magnitude of {expr2}. If {expr2} is zero, the value
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
4270 returned is zero. The value returned is a |Float|.
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
4271 {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
4272 Examples: >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
4273 :echo fmod(12.33, 1.22)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
4274 < 0.13 >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
4275 :echo fmod(-12.33, 1.22)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
4276 < -0.13
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
4277 {only available when compiled with |+float| feature}
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
4278
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
4279
1586
fe7db192c7cc updated for version 7.1-299
vimboss
parents: 1548
diff changeset
4280 fnameescape({string}) *fnameescape()*
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
4281 Escape {string} for use as file name command argument. All
1586
fe7db192c7cc updated for version 7.1-299
vimboss
parents: 1548
diff changeset
4282 characters that have a special meaning, such as '%' and '|'
fe7db192c7cc updated for version 7.1-299
vimboss
parents: 1548
diff changeset
4283 are escaped with a backslash.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4284 For most systems the characters escaped are
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4285 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4286 appears in a filename, it depends on the value of 'isfname'.
1700
9e1cefec84dd updated for version 7.2c-002
vimboss
parents: 1699
diff changeset
4287 A leading '+' and '>' is also escaped (special after |:edit|
9e1cefec84dd updated for version 7.2c-002
vimboss
parents: 1699
diff changeset
4288 and |:write|). And a "-" by itself (special after |:cd|).
1586
fe7db192c7cc updated for version 7.1-299
vimboss
parents: 1548
diff changeset
4289 Example: >
1700
9e1cefec84dd updated for version 7.2c-002
vimboss
parents: 1699
diff changeset
4290 :let fname = '+some str%nge|name'
1586
fe7db192c7cc updated for version 7.1-299
vimboss
parents: 1548
diff changeset
4291 :exe "edit " . fnameescape(fname)
fe7db192c7cc updated for version 7.1-299
vimboss
parents: 1548
diff changeset
4292 < results in executing: >
1700
9e1cefec84dd updated for version 7.2c-002
vimboss
parents: 1699
diff changeset
4293 edit \+some\ str\%nge\|name
1586
fe7db192c7cc updated for version 7.1-299
vimboss
parents: 1548
diff changeset
4294
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4295 fnamemodify({fname}, {mods}) *fnamemodify()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4296 Modify file name {fname} according to {mods}. {mods} is a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4297 string of characters like it is used for file names on the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4298 command line. See |filename-modifiers|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4299 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4300 :echo fnamemodify("main.c", ":p:h")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4301 < results in: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4302 /home/mool/vim/vim/src
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4303 < Note: Environment variables don't work in {fname}, use
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4304 |expand()| first then.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4305
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4306 foldclosed({lnum}) *foldclosed()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4307 The result is a Number. If the line {lnum} is in a closed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4308 fold, the result is the number of the first line in that fold.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4309 If the line {lnum} is not in a closed fold, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4310
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4311 foldclosedend({lnum}) *foldclosedend()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4312 The result is a Number. If the line {lnum} is in a closed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4313 fold, the result is the number of the last line in that fold.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4314 If the line {lnum} is not in a closed fold, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4315
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4316 foldlevel({lnum}) *foldlevel()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4317 The result is a Number, which is the foldlevel of line {lnum}
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
4318 in the current buffer. For nested folds the deepest level is
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4319 returned. If there is no fold at line {lnum}, zero is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4320 returned. It doesn't matter if the folds are open or closed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4321 When used while updating folds (from 'foldexpr') -1 is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4322 returned for lines where folds are still to be updated and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4323 foldlevel is unknown. As a special case the level of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4324 previous line is usually available.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4325
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4326 *foldtext()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4327 foldtext() Returns a String, to be displayed for a closed fold. This is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4328 the default function used for the 'foldtext' option and should
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4329 only be called from evaluating 'foldtext'. It uses the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4330 |v:foldstart|, |v:foldend| and |v:folddashes| variables.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4331 The returned string looks like this: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4332 +-- 45 lines: abcdef
11181
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
4333 < The number of leading dashes depends on the foldlevel. The
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
4334 "45" is the number of lines in the fold. "abcdef" is the text
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
4335 in the first non-blank line of the fold. Leading white space,
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
4336 "//" or "/*" and the text from the 'foldmarker' and
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
4337 'commentstring' options is removed.
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
4338 When used to draw the actual foldtext, the rest of the line
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
4339 will be filled with the fold char from the 'fillchars'
13544aa85dc0 patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents: 11177
diff changeset
4340 setting.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4341 {not available when compiled without the |+folding| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4342
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
4343 foldtextresult({lnum}) *foldtextresult()*
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
4344 Returns the text that is displayed for the closed fold at line
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
4345 {lnum}. Evaluates 'foldtext' in the appropriate context.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
4346 When there is no closed fold at {lnum} an empty string is
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
4347 returned.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
4348 {lnum} is used like with |getline()|. Thus "." is the current
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
4349 line, "'m" mark m, etc.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
4350 Useful when exporting folded text, e.g., to HTML.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
4351 {not available when compiled without the |+folding| feature}
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
4352
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4353 *foreground()*
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
4354 foreground() Move the Vim window to the foreground. Useful when sent from
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4355 a client to a Vim server. |remote_send()|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4356 On Win32 systems this might not work, the OS does not always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4357 allow a window to bring itself to the foreground. Use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4358 |remote_foreground()| instead.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4359 {only in the Win32, Athena, Motif and GTK GUI versions and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4360 Win32 console version}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4361
9723
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
4362 *funcref()*
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
4363 funcref({name} [, {arglist}] [, {dict}])
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
4364 Just like |function()|, but the returned Funcref will lookup
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
4365 the function by reference, not by name. This matters when the
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
4366 function {name} is redefined later.
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
4367
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
4368 Unlike |function()|, {name} must be an existing user function.
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
4369 Also for autoloaded functions. {name} cannot be a builtin
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
4370 function.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4371
8538
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4372 *function()* *E700* *E922* *E923*
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4373 function({name} [, {arglist}] [, {dict}])
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4374 Return a |Funcref| variable that refers to function {name}.
8577
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
4375 {name} can be the name of a user defined function or an
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
4376 internal function.
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
4377
9723
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
4378 {name} can also be a Funcref or a partial. When it is a
8577
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
4379 partial the dict stored in it will be used and the {dict}
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
4380 argument is not allowed. E.g.: >
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
4381 let FuncWithArg = function(dict.Func, [arg])
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
4382 let Broken = function(dict.Func, [arg], dict)
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
4383 <
9723
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
4384 When using the Funcref the function will be found by {name},
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
4385 also when it was redefined later. Use |funcref()| to keep the
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
4386 same function.
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
4387
8538
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4388 When {arglist} or {dict} is present this creates a partial.
9097
071f9da012fb commit https://github.com/vim/vim/commit/06d2d38ab7564e1f784b1058a4ef4580cd6d1810
Christian Brabandt <cb@256bit.org>
parents: 9076
diff changeset
4389 That means the argument list and/or the dictionary is stored in
8538
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4390 the Funcref and will be used when the Funcref is called.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
4391
8538
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4392 The arguments are passed to the function in front of other
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4393 arguments. Example: >
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4394 func Callback(arg1, arg2, name)
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4395 ...
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4396 let Func = function('Callback', ['one', 'two'])
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4397 ...
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4398 call Func('name')
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4399 < Invokes the function as with: >
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4400 call Callback('one', 'two', 'name')
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4401
8669
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
4402 < The function() call can be nested to add more arguments to the
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
4403 Funcref. The extra arguments are appended to the list of
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
4404 arguments. Example: >
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
4405 func Callback(arg1, arg2, name)
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
4406 ...
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
4407 let Func = function('Callback', ['one'])
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
4408 let Func2 = function(Func, ['two'])
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
4409 ...
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
4410 call Func2('name')
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
4411 < Invokes the function as with: >
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
4412 call Callback('one', 'two', 'name')
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
4413
8538
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4414 < The Dictionary is only useful when calling a "dict" function.
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4415 In that case the {dict} is passed in as "self". Example: >
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4416 function Callback() dict
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4417 echo "called for " . self.name
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4418 endfunction
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4419 ...
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4420 let context = {"name": "example"}
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4421 let Func = function('Callback', context)
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4422 ...
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4423 call Func() " will echo: called for example
8577
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
4424 < The use of function() is not needed when there are no extra
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
4425 arguments, these two are equivalent: >
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
4426 let Func = function('Callback', context)
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
4427 let Func = context.Callback
8538
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4428
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4429 < The argument list and the Dictionary can be combined: >
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4430 function Callback(arg1, count) dict
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4431 ...
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4432 let context = {"name": "example"}
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4433 let Func = function('Callback', ['one'], context)
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4434 ...
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4435 call Func(500)
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4436 < Invokes the function as with: >
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4437 call context.Callback('one', 500)
c337c813c64d commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents: 8536
diff changeset
4438
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4439
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3214
diff changeset
4440 garbagecollect([{atexit}]) *garbagecollect()*
8881
ed0b39dd7fd6 commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents: 8876
diff changeset
4441 Cleanup unused |Lists|, |Dictionaries|, |Channels| and |Jobs|
ed0b39dd7fd6 commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents: 8876
diff changeset
4442 that have circular references.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
4443
8881
ed0b39dd7fd6 commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents: 8876
diff changeset
4444 There is hardly ever a need to invoke this function, as it is
ed0b39dd7fd6 commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents: 8876
diff changeset
4445 automatically done when Vim runs out of memory or is waiting
ed0b39dd7fd6 commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents: 8876
diff changeset
4446 for the user to press a key after 'updatetime'. Items without
ed0b39dd7fd6 commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents: 8876
diff changeset
4447 circular references are always freed when they become unused.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4448 This is useful if you have deleted a very big |List| and/or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4449 |Dictionary| with circular references in a script that runs
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4450 for a long time.
8881
ed0b39dd7fd6 commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents: 8876
diff changeset
4451
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3214
diff changeset
4452 When the optional {atexit} argument is one, garbage
1405
b63792dadc23 updated for version 7.1-120
vimboss
parents: 1326
diff changeset
4453 collection will also be done when exiting Vim, if it wasn't
b63792dadc23 updated for version 7.1-120
vimboss
parents: 1326
diff changeset
4454 done before. This is useful when checking for memory leaks.
370
3a21825ad207 updated for version 7.0095
vimboss
parents: 359
diff changeset
4455
9108
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
4456 The garbage collection is not done immediately but only when
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
4457 it's safe to perform. This is when waiting for the user to
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
4458 type a character. To force garbage collection immediately use
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
4459 |test_garbagecollect_now()|.
8881
ed0b39dd7fd6 commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents: 8876
diff changeset
4460
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
4461 get({list}, {idx} [, {default}]) *get()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4462 Get item {idx} from |List| {list}. When this item is not
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4463 available return {default}. Return zero when {default} is
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4464 omitted.
15498
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
4465 get({blob}, {idx} [, {default}])
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
4466 Get byte {idx} from |Blob| {blob}. When this byte is not
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
4467 available return {default}. Return -1 when {default} is
e1de20a47fa9 patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents: 15456
diff changeset
4468 omitted.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4469 get({dict}, {key} [, {default}])
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4470 Get item with key {key} from |Dictionary| {dict}. When this
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4471 item is not available return {default}. Return zero when
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4472 {default} is omitted.
9117
0cc48b3cd884 commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents: 9110
diff changeset
4473 get({func}, {what})
0cc48b3cd884 commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents: 9110
diff changeset
4474 Get an item with from Funcref {func}. Possible values for
9110
6d3888e2232c commit https://github.com/vim/vim/commit/2bbf8eff6fab16d86e7bcfc0da1962d31bec7891
Christian Brabandt <cb@256bit.org>
parents: 9108
diff changeset
4475 {what} are:
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
4476 "name" The function name
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
4477 "func" The function
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
4478 "dict" The dictionary
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
4479 "args" The list with arguments
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
4480
9858
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4481 *getbufinfo()*
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4482 getbufinfo([{expr}])
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4483 getbufinfo([{dict}])
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
4484 Get information about buffers as a List of Dictionaries.
9858
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4485
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4486 Without an argument information about all the buffers is
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4487 returned.
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4488
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4489 When the argument is a Dictionary only the buffers matching
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4490 the specified criteria are returned. The following keys can
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4491 be specified in {dict}:
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4492 buflisted include only listed buffers.
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4493 bufloaded include only loaded buffers.
13020
58cce40c965b patch 8.0.1386: cannot select modified buffers with getbufinfo()
Christian Brabandt <cb@256bit.org>
parents: 13016
diff changeset
4494 bufmodified include only modified buffers.
9858
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4495
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4496 Otherwise, {expr} specifies a particular buffer to return
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4497 information for. For the use of {expr}, see |bufname()|
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4498 above. If the buffer is found the returned List has one item.
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4499 Otherwise the result is an empty list.
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4500
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4501 Each returned List item is a dictionary with the following
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4502 entries:
9904
24900147aa44 commit https://github.com/vim/vim/commit/339288377072f66ec88e21903e75a82d23ffbf4f
Christian Brabandt <cb@256bit.org>
parents: 9894
diff changeset
4503 bufnr buffer number.
9858
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4504 changed TRUE if the buffer is modified.
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4505 changedtick number of changes made to the buffer.
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4506 hidden TRUE if the buffer is hidden.
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4507 listed TRUE if the buffer is listed.
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4508 lnum current line number in buffer.
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4509 loaded TRUE if the buffer is loaded.
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4510 name full path to the file in the buffer.
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4511 signs list of signs placed in the buffer.
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4512 Each list item is a dictionary with
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4513 the following fields:
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4514 id sign identifier
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4515 lnum line number
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4516 name sign name
10000
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
4517 variables a reference to the dictionary with
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
4518 buffer-local variables.
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
4519 windows list of |window-ID|s that display this
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
4520 buffer
9858
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4521
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4522 Examples: >
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4523 for buf in getbufinfo()
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4524 echo buf.name
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4525 endfor
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4526 for buf in getbufinfo({'buflisted':1})
10000
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
4527 if buf.changed
9858
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4528 ....
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4529 endif
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4530 endfor
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
4531 <
10000
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
4532 To get buffer-local options use: >
14519
5c5908e81e93 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14422
diff changeset
4533 getbufvar({bufnr}, '&option_name')
10000
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
4534
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
4535 <
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
4536 *getbufline()*
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
4537 getbufline({expr}, {lnum} [, {end}])
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4538 Return a |List| with the lines starting from {lnum} to {end}
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4539 (inclusive) in the buffer {expr}. If {end} is omitted, a
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4540 |List| with only the line {lnum} is returned.
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
4541
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
4542 For the use of {expr}, see |bufname()| above.
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
4543
448
dd9db57ee7ce updated for version 7.0118
vimboss
parents: 444
diff changeset
4544 For {lnum} and {end} "$" can be used for the last line of the
dd9db57ee7ce updated for version 7.0118
vimboss
parents: 444
diff changeset
4545 buffer. Otherwise a number must be used.
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
4546
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
4547 When {lnum} is smaller than 1 or bigger than the number of
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4548 lines in the buffer, an empty |List| is returned.
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
4549
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
4550 When {end} is greater than the number of lines in the buffer,
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
4551 it is treated as {end} is set to the number of lines in the
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4552 buffer. When {end} is before {lnum} an empty |List| is
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
4553 returned.
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
4554
448
dd9db57ee7ce updated for version 7.0118
vimboss
parents: 444
diff changeset
4555 This function works only for loaded buffers. For unloaded and
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4556 non-existing buffers, an empty |List| is returned.
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
4557
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
4558 Example: >
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
4559 :let lines = getbufline(bufnr("myfile"), 1, "$")
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4560
4157
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
4561 getbufvar({expr}, {varname} [, {def}]) *getbufvar()*
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4562 The result is the value of option or local buffer variable
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4563 {varname} in buffer {expr}. Note that the name without "b:"
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4564 must be used.
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
4565 When {varname} is empty returns a dictionary with all the
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
4566 buffer-local variables.
10000
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
4567 When {varname} is equal to "&" returns a dictionary with all
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
4568 the buffer-local options.
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
4569 Otherwise, when {varname} starts with "&" returns the value of
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
4570 a buffer-local option.
216
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
4571 This also works for a global or buffer-local option, but it
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
4572 doesn't work for a global variable, window-local variable or
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
4573 window-local option.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4574 For the use of {expr}, see |bufname()| above.
4157
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
4575 When the buffer or variable doesn't exist {def} or an empty
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
4576 string is returned, there is no error message.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4577 Examples: >
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4578 :let bufmodified = getbufvar(1, "&mod")
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4579 :echo "todo myvar = " . getbufvar("todo", "myvar")
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4580 <
13280
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4581 getchangelist({expr}) *getchangelist()*
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4582 Returns the |changelist| for the buffer {expr}. For the use
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4583 of {expr}, see |bufname()| above. If buffer {expr} doesn't
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4584 exist, an empty list is returned.
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4585
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4586 The returned list contains two entries: a list with the change
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4587 locations and the current position in the list. Each
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4588 entry in the change list is a dictionary with the following
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4589 entries:
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4590 col column number
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4591 coladd column offset for 'virtualedit'
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4592 lnum line number
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4593 If buffer {expr} is the current buffer, then the current
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4594 position refers to the position in the list. For other
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4595 buffers, it is set to the length of the list.
fbda23eb0996 patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents: 13272
diff changeset
4596
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4597 getchar([expr]) *getchar()*
867
a5677b7ce858 updated for version 7.0g04
vimboss
parents: 864
diff changeset
4598 Get a single character from the user or input stream.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4599 If [expr] is omitted, wait until a character is available.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4600 If [expr] is 0, only get a character when one is available.
867
a5677b7ce858 updated for version 7.0g04
vimboss
parents: 864
diff changeset
4601 Return zero otherwise.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4602 If [expr] is 1, only check if a character is available, it is
867
a5677b7ce858 updated for version 7.0g04
vimboss
parents: 864
diff changeset
4603 not consumed. Return zero if no character available.
a5677b7ce858 updated for version 7.0g04
vimboss
parents: 864
diff changeset
4604
5555
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5466
diff changeset
4605 Without [expr] and when [expr] is 0 a whole character or
11639
71d7b5ed08a0 patch 8.0.0702: an error in a timer can make Vim unusable
Christian Brabandt <cb@256bit.org>
parents: 11609
diff changeset
4606 special key is returned. If it is a single character, the
867
a5677b7ce858 updated for version 7.0g04
vimboss
parents: 864
diff changeset
4607 result is a number. Use nr2char() to convert it to a String.
a5677b7ce858 updated for version 7.0g04
vimboss
parents: 864
diff changeset
4608 Otherwise a String is returned with the encoded character.
11639
71d7b5ed08a0 patch 8.0.0702: an error in a timer can make Vim unusable
Christian Brabandt <cb@256bit.org>
parents: 11609
diff changeset
4609 For a special key it's a String with a sequence of bytes
71d7b5ed08a0 patch 8.0.0702: an error in a timer can make Vim unusable
Christian Brabandt <cb@256bit.org>
parents: 11609
diff changeset
4610 starting with 0x80 (decimal: 128). This is the same value as
71d7b5ed08a0 patch 8.0.0702: an error in a timer can make Vim unusable
Christian Brabandt <cb@256bit.org>
parents: 11609
diff changeset
4611 the String "\<Key>", e.g., "\<Left>". The returned value is
71d7b5ed08a0 patch 8.0.0702: an error in a timer can make Vim unusable
Christian Brabandt <cb@256bit.org>
parents: 11609
diff changeset
4612 also a String when a modifier (shift, control, alt) was used
71d7b5ed08a0 patch 8.0.0702: an error in a timer can make Vim unusable
Christian Brabandt <cb@256bit.org>
parents: 11609
diff changeset
4613 that is not included in the character.
867
a5677b7ce858 updated for version 7.0g04
vimboss
parents: 864
diff changeset
4614
5968
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4615 When [expr] is 0 and Esc is typed, there will be a short delay
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4616 while Vim waits to see if this is the start of an escape
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4617 sequence.
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4618
5555
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5466
diff changeset
4619 When [expr] is 1 only the first byte is returned. For a
872
e6c3e7c34232 updated for version 7.0g05
vimboss
parents: 867
diff changeset
4620 one-byte character it is the character itself as a number.
e6c3e7c34232 updated for version 7.0g05
vimboss
parents: 867
diff changeset
4621 Use nr2char() to convert it to a String.
867
a5677b7ce858 updated for version 7.0g04
vimboss
parents: 864
diff changeset
4622
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3214
diff changeset
4623 Use getcharmod() to obtain any additional modifiers.
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3214
diff changeset
4624
1029
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
4625 When the user clicks a mouse button, the mouse event will be
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
4626 returned. The position can then be found in |v:mouse_col|,
9221
17fa362f10be commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents: 9219
diff changeset
4627 |v:mouse_lnum|, |v:mouse_winid| and |v:mouse_win|. This
17fa362f10be commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents: 9219
diff changeset
4628 example positions the mouse as it would normally happen: >
1029
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
4629 let c = getchar()
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
4630 if c == "\<LeftMouse>" && v:mouse_win > 0
1029
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
4631 exe v:mouse_win . "wincmd w"
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
4632 exe v:mouse_lnum
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
4633 exe "normal " . v:mouse_col . "|"
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
4634 endif
82b2594be408 updated for version 7.0-155
vimboss
parents: 985
diff changeset
4635 <
10734
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
4636 When using bracketed paste only the first character is
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
4637 returned, the rest of the pasted text is dropped.
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
4638 |xterm-bracketed-paste|.
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
4639
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4640 There is no prompt, you will somehow have to make clear to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4641 user that a character has to be typed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4642 There is no mapping for the character.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4643 Key codes are replaced, thus when the user presses the <Del>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4644 key you get the code for the <Del> key, not the raw character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4645 sequence. Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4646 getchar() == "\<Del>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4647 getchar() == "\<S-Left>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4648 < This example redefines "f" to ignore case: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4649 :nmap f :call FindChar()<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4650 :function FindChar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4651 : let c = nr2char(getchar())
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4652 : while col('.') < col('$') - 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4653 : normal l
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4654 : if getline('.')[col('.') - 1] ==? c
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4655 : break
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4656 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4657 : endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4658 :endfunction
6421
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6413
diff changeset
4659 <
6647
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6583
diff changeset
4660 You may also receive synthetic characters, such as
6421
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6413
diff changeset
4661 |<CursorHold>|. Often you will want to ignore this and get
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6413
diff changeset
4662 another character: >
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6413
diff changeset
4663 :function GetKey()
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6413
diff changeset
4664 : let c = getchar()
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6413
diff changeset
4665 : while c == "\<CursorHold>"
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6413
diff changeset
4666 : let c = getchar()
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6413
diff changeset
4667 : endwhile
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6413
diff changeset
4668 : return c
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6413
diff changeset
4669 :endfunction
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4670
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4671 getcharmod() *getcharmod()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4672 The result is a Number which is the state of the modifiers for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4673 the last obtained character with getchar() or in another way.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4674 These values are added together:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4675 2 shift
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4676 4 control
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4677 8 alt (meta)
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3214
diff changeset
4678 16 meta (when it's different from ALT)
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3214
diff changeset
4679 32 mouse double click
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3214
diff changeset
4680 64 mouse triple click
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3214
diff changeset
4681 96 mouse quadruple click (== 32 + 64)
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3214
diff changeset
4682 128 command (Macintosh only)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4683 Only the modifiers that have not been included in the
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
4684 character itself are obtained. Thus Shift-a results in "A"
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
4685 without a modifier.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4686
6991
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4687 getcharsearch() *getcharsearch()*
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4688 Return the current character search information as a {dict}
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4689 with the following entries:
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4690
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4691 char character previously used for a character
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4692 search (|t|, |f|, |T|, or |F|); empty string
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4693 if no character search has been performed
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4694 forward direction of character search; 1 for forward,
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4695 0 for backward
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4696 until type of character search; 1 for a |t| or |T|
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4697 character search, 0 for an |f| or |F|
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4698 character search
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4699
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4700 This can be useful to always have |;| and |,| search
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4701 forward/backward regardless of the direction of the previous
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4702 character search: >
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4703 :nnoremap <expr> ; getcharsearch().forward ? ';' : ','
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4704 :nnoremap <expr> , getcharsearch().forward ? ',' : ';'
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4705 < Also see |setcharsearch()|.
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
4706
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4707 getcmdline() *getcmdline()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4708 Return the current command-line. Only works when the command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4709 line is being edited, thus requires use of |c_CTRL-\_e| or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4710 |c_CTRL-R_=|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4711 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4712 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
4713 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|.
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
4714 Returns an empty string when entering a password or using
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
4715 |inputsecret()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4716
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
4717 getcmdpos() *getcmdpos()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4718 Return the position of the cursor in the command line as a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4719 byte count. The first column is 1.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4720 Only works when editing the command line, thus requires use of
3456
4dde9b516e72 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3445
diff changeset
4721 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
4dde9b516e72 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3445
diff changeset
4722 Returns 0 otherwise.
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
4723 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|.
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
4724
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
4725 getcmdtype() *getcmdtype()*
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
4726 Return the current command-line type. Possible return values
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
4727 are:
532
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4728 : normal Ex command
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4729 > debug mode command |debug-mode|
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4730 / forward search command
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4731 ? backward search command
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4732 @ |input()| command
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
4733 - |:insert| or |:append| command
6213
37c24033b260 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6197
diff changeset
4734 = |i_CTRL-R_=|
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
4735 Only works when editing the command line, thus requires use of
3456
4dde9b516e72 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3445
diff changeset
4736 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
4dde9b516e72 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3445
diff changeset
4737 Returns an empty string otherwise.
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
4738 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4739
6153
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
4740 getcmdwintype() *getcmdwintype()*
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
4741 Return the current |command-line-window| type. Possible return
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
4742 values are the same as |getcmdtype()|. Returns an empty string
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
4743 when not in the command-line window.
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6110
diff changeset
4744
9861
74f67cb4f7e1 commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents: 9858
diff changeset
4745 getcompletion({pat}, {type} [, {filtered}]) *getcompletion()*
9460
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4746 Return a list of command-line completion matches. {type}
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4747 specifies what for. The following completion types are
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4748 supported:
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4749
13551
1fd0f8392946 patch 8.0.1649: no completion for argument list commands
Christian Brabandt <cb@256bit.org>
parents: 13513
diff changeset
4750 arglist file names in argument list
9460
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4751 augroup autocmd groups
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4752 buffer buffer names
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4753 behave :behave suboptions
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4754 color color schemes
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4755 command Ex command (and arguments)
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4756 compiler compilers
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4757 cscope |:cscope| suboptions
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4758 dir directory names
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4759 environment environment variable names
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4760 event autocommand events
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4761 expression Vim expression
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4762 file file and directory names
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4763 file_in_path file and directory names in |'path'|
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4764 filetype filetype names |'filetype'|
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4765 function function name
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4766 help help subjects
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4767 highlight highlight groups
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4768 history :history suboptions
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4769 locale locale names (as output of locale -a)
11995
7df3dd3c0ac1 patch 8.0.0878: no completion for :mapclear
Christian Brabandt <cb@256bit.org>
parents: 11967
diff changeset
4770 mapclear buffer argument
9460
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4771 mapping mapping name
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4772 menu menus
10275
6d8b2da002e9 commit https://github.com/vim/vim/commit/9e507ca8a3e1535e62de4bd86374b0fcd18ef5b8
Christian Brabandt <cb@256bit.org>
parents: 10245
diff changeset
4773 messages |:messages| suboptions
9460
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4774 option options
10275
6d8b2da002e9 commit https://github.com/vim/vim/commit/9e507ca8a3e1535e62de4bd86374b0fcd18ef5b8
Christian Brabandt <cb@256bit.org>
parents: 10245
diff changeset
4775 packadd optional package |pack-add| names
9460
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4776 shellcmd Shell command
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4777 sign |:sign| suboptions
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4778 syntax syntax file names |'syntax'|
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4779 syntime |:syntime| suboptions
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4780 tag tags
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4781 tag_listfiles tags, file names
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4782 user user names
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4783 var user variables
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4784
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4785 If {pat} is an empty string, then all the matches are returned.
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4786 Otherwise only items matching {pat} are returned. See
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4787 |wildcards| for the use of special characters in {pat}.
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4788
9861
74f67cb4f7e1 commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents: 9858
diff changeset
4789 If the optional {filtered} flag is set to 1, then 'wildignore'
74f67cb4f7e1 commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents: 9858
diff changeset
4790 is applied to filter the results. Otherwise all the matches
74f67cb4f7e1 commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents: 9858
diff changeset
4791 are returned. The 'wildignorecase' option always applies.
74f67cb4f7e1 commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents: 9858
diff changeset
4792
9460
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4793 If there are no matches, an empty list is returned. An
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4794 invalid value for {type} produces an error.
cdffa812f9d1 commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents: 9454
diff changeset
4795
5944
332a5c2b2956 updated for version 7.4.313
Bram Moolenaar <bram@vim.org>
parents: 5942
diff changeset
4796 *getcurpos()*
332a5c2b2956 updated for version 7.4.313
Bram Moolenaar <bram@vim.org>
parents: 5942
diff changeset
4797 getcurpos() Get the position of the cursor. This is like getpos('.'), but
332a5c2b2956 updated for version 7.4.313
Bram Moolenaar <bram@vim.org>
parents: 5942
diff changeset
4798 includes an extra item in the list:
7597
3012eaddb6b2 commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents: 7593
diff changeset
4799 [bufnum, lnum, col, off, curswant] ~
5944
332a5c2b2956 updated for version 7.4.313
Bram Moolenaar <bram@vim.org>
parents: 5942
diff changeset
4800 The "curswant" number is the preferred column when moving the
11347
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
4801 cursor vertically. Also see |getpos()|.
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
4802
5944
332a5c2b2956 updated for version 7.4.313
Bram Moolenaar <bram@vim.org>
parents: 5942
diff changeset
4803 This can be used to save and restore the cursor position: >
332a5c2b2956 updated for version 7.4.313
Bram Moolenaar <bram@vim.org>
parents: 5942
diff changeset
4804 let save_cursor = getcurpos()
332a5c2b2956 updated for version 7.4.313
Bram Moolenaar <bram@vim.org>
parents: 5942
diff changeset
4805 MoveTheCursorAround
332a5c2b2956 updated for version 7.4.313
Bram Moolenaar <bram@vim.org>
parents: 5942
diff changeset
4806 call setpos('.', save_cursor)
11347
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
4807 < Note that this only works within the window. See
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
4808 |winrestview()| for restoring more state.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4809 *getcwd()*
7653
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
4810 getcwd([{winnr} [, {tabnr}]])
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
4811 The result is a String, which is the name of the current
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4812 working directory.
7653
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
4813
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
4814 With {winnr} return the local current directory of this window
13229
93efa1de7abb patch 8.0.1489: there is no easy way to get the global directory
Christian Brabandt <cb@256bit.org>
parents: 13125
diff changeset
4815 in the current tab page. {winnr} can be the window number or
93efa1de7abb patch 8.0.1489: there is no easy way to get the global directory
Christian Brabandt <cb@256bit.org>
parents: 13125
diff changeset
4816 the |window-ID|.
93efa1de7abb patch 8.0.1489: there is no easy way to get the global directory
Christian Brabandt <cb@256bit.org>
parents: 13125
diff changeset
4817 If {winnr} is -1 return the name of the global working
93efa1de7abb patch 8.0.1489: there is no easy way to get the global directory
Christian Brabandt <cb@256bit.org>
parents: 13125
diff changeset
4818 directory. See also |haslocaldir()|.
93efa1de7abb patch 8.0.1489: there is no easy way to get the global directory
Christian Brabandt <cb@256bit.org>
parents: 13125
diff changeset
4819
7653
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
4820 With {winnr} and {tabnr} return the local current directory of
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
4821 the window in the specified tab page.
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
4822 Return an empty string if the arguments are invalid.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4823
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4824 getfsize({fname}) *getfsize()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4825 The result is a Number, which is the size in bytes of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4826 given file {fname}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4827 If {fname} is a directory, 0 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4828 If the file {fname} can't be found, -1 is returned.
1293
3ae106044109 updated for version 7.1-008
vimboss
parents: 1266
diff changeset
4829 If the size of {fname} is too big to fit in a Number then -2
3ae106044109 updated for version 7.1-008
vimboss
parents: 1266
diff changeset
4830 is returned.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4831
37
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
4832 getfontname([{name}]) *getfontname()*
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
4833 Without an argument returns the name of the normal font being
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
4834 used. Like what is used for the Normal highlight group
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
4835 |hl-Normal|.
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
4836 With an argument a check is done whether {name} is a valid
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
4837 font name. If not then an empty string is returned.
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
4838 Otherwise the actual font name is returned, or {name} if the
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
4839 GUI does not support obtaining the real name.
824
8dd456c1e283 updated for version 7.0c13
vimboss
parents: 823
diff changeset
4840 Only works when the GUI is running, thus not in your vimrc or
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
4841 gvimrc file. Use the |GUIEnter| autocommand to use this
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
4842 function just after the GUI has started.
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10787
diff changeset
4843 Note that the GTK GUI accepts any font name, thus checking for
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10787
diff changeset
4844 a valid name does not work.
37
fdf55076c53f updated for version 7.0022
vimboss
parents: 33
diff changeset
4845
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4846 getfperm({fname}) *getfperm()*
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4847 The result is a String, which is the read, write, and execute
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4848 permissions of the given file {fname}.
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4849 If {fname} does not exist or its directory cannot be read, an
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4850 empty string is returned.
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4851 The result is of the form "rwxrwxrwx", where each group of
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4852 "rwx" flags represent, in turn, the permissions of the owner
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4853 of the file, the group the file belongs to, and other users.
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4854 If a user does not have a given permission the flag for this
3750
536aa8b0c934 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3682
diff changeset
4855 is replaced with the string "-". Examples: >
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4856 :echo getfperm("/etc/passwd")
3750
536aa8b0c934 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3682
diff changeset
4857 :echo getfperm(expand("~/.vimrc"))
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4858 < This will hopefully (from a security point of view) display
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4859 the string "rw-r--r--" or even "rw-------".
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
4860
10244
876fbdd84e52 commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents: 10237
diff changeset
4861 For setting permissions use |setfperm()|.
8451
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
4862
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4863 getftime({fname}) *getftime()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4864 The result is a Number, which is the last modification time of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4865 the given file {fname}. The value is measured as seconds
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4866 since 1st Jan 1970, and may be passed to strftime(). See also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4867 |localtime()| and |strftime()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4868 If the file {fname} can't be found -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4869
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4870 getftype({fname}) *getftype()*
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4871 The result is a String, which is a description of the kind of
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4872 file of the given file {fname}.
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4873 If {fname} does not exist an empty string is returned.
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4874 Here is a table over different kinds of files and their
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4875 results:
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4876 Normal file "file"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4877 Directory "dir"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4878 Symbolic link "link"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4879 Block device "bdev"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4880 Character device "cdev"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4881 Socket "socket"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4882 FIFO "fifo"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4883 All other "other"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4884 Example: >
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4885 getftype("/home")
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4886 < Note that a type such as "link" will only be returned on
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4887 systems that support it. On some systems only "dir" and
7707
41768bcebc9b commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents: 7703
diff changeset
4888 "file" are returned. On MS-Windows a symbolic link to a
41768bcebc9b commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents: 7703
diff changeset
4889 directory returns "dir" instead of "link".
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
4890
13298
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
4891 getjumplist([{winnr} [, {tabnr}]]) *getjumplist()*
13246
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4892 Returns the |jumplist| for the specified window.
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4893
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4894 Without arguments use the current window.
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4895 With {winnr} only use this window in the current tab page.
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4896 {winnr} can also be a |window-ID|.
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4897 With {winnr} and {tabnr} use the window in the specified tab
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4898 page.
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4899
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4900 The returned list contains two entries: a list with the jump
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4901 locations and the last used jump position number in the list.
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4902 Each entry in the jump location list is a dictionary with
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4903 the following entries:
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4904 bufnr buffer number
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4905 col column number
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4906 coladd column offset for 'virtualedit'
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4907 filename filename if available
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4908 lnum line number
dd3b2ecf91f6 patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
4909
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4910 *getline()*
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4911 getline({lnum} [, {end}])
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4912 Without {end} the result is a String, which is line {lnum}
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4913 from the current buffer. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4914 getline(1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4915 < When {lnum} is a String that doesn't start with a
14019
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
4916 digit, |line()| is called to translate the String into a Number.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4917 To get the line under the cursor: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4918 getline(".")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4919 < When {lnum} is smaller than 1 or bigger than the number of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4920 lines in the buffer, an empty string is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4921
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4922 When {end} is given the result is a |List| where each item is
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4923 a line from the current buffer in the range {lnum} to {end},
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4924 including line {end}.
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4925 {end} is used in the same way as {lnum}.
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4926 Non-existing lines are silently omitted.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
4927 When {end} is before {lnum} an empty |List| is returned.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4928 Example: >
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4929 :let start = line('.')
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4930 :let end = search("^$") - 1
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4931 :let lines = getline(start, end)
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4932
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
4933 < To get lines from another buffer see |getbufline()|
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
4934
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
4935 getloclist({nr} [, {what}]) *getloclist()*
647
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
4936 Returns a list with all the entries in the location list for
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
4937 window {nr}. {nr} can be the window number or the |window-ID|.
9223
6c4d610fce0a commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents: 9221
diff changeset
4938 When {nr} is zero the current window is used.
6c4d610fce0a commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents: 9221
diff changeset
4939
647
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
4940 For a location list window, the displayed location list is
648
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
4941 returned. For an invalid window number {nr}, an empty list is
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
4942 returned. Otherwise, same as |getqflist()|.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
4943
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
4944 If the optional {what} dictionary argument is supplied, then
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
4945 returns the items listed in {what} as a dictionary. Refer to
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
4946 |getqflist()| for the supported items in {what}.
14664
8770189c3e22 patch 8.1.0345: cannot get the window id associated with the location list
Christian Brabandt <cb@256bit.org>
parents: 14637
diff changeset
4947 If {what} contains 'filewinid', then returns the id of the
8770189c3e22 patch 8.1.0345: cannot get the window id associated with the location list
Christian Brabandt <cb@256bit.org>
parents: 14637
diff changeset
4948 window used to display files from the location list. This
8770189c3e22 patch 8.1.0345: cannot get the window id associated with the location list
Christian Brabandt <cb@256bit.org>
parents: 14637
diff changeset
4949 field is applicable only when called from a location list
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
4950 window. See |location-list-file-window| for more details.
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
4951
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4952 getmatches() *getmatches()*
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4953 Returns a |List| with all matches previously defined by
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4954 |matchadd()| and the |:match| commands. |getmatches()| is
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4955 useful in combination with |setmatches()|, as |setmatches()|
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4956 can restore a list of matches saved by |getmatches()|.
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4957 Example: >
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4958 :echo getmatches()
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4959 < [{'group': 'MyGroup1', 'pattern': 'TODO',
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4960 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4961 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4962 :let m = getmatches()
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4963 :call clearmatches()
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4964 :echo getmatches()
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4965 < [] >
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4966 :call setmatches(m)
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4967 :echo getmatches()
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4968 < [{'group': 'MyGroup1', 'pattern': 'TODO',
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4969 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4970 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4971 :unlet m
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
4972 <
5968
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4973 *getpid()*
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4974 getpid() Return a Number which is the process ID of the Vim process.
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4975 On Unix and MS-Windows this is a unique number, until Vim
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
4976 exits. On MS-DOS it's always zero.
5968
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4977
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4978 *getpos()*
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4979 getpos({expr}) Get the position for {expr}. For possible values of {expr}
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4980 see |line()|. For getting the cursor position see
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4981 |getcurpos()|.
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4982 The result is a |List| with four numbers:
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4983 [bufnum, lnum, col, off]
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4984 "bufnum" is zero, unless a mark like '0 or 'A is used, then it
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4985 is the buffer number of the mark.
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4986 "lnum" and "col" are the position in the buffer. The first
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4987 column is 1.
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4988 The "off" number is zero, unless 'virtualedit' is used. Then
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4989 it is the offset in screen columns from the start of the
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4990 character. E.g., a position within a <Tab> or after the last
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4991 character.
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4992 Note that for '< and '> Visual mode matters: when it is "V"
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4993 (visual line mode) the column of '< is zero and the column of
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4994 '> is a large number.
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4995 This can be used to save and restore the position of a mark: >
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4996 let save_a_mark = getpos("'a")
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4997 ...
6421
5d89d9b40499 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6413
diff changeset
4998 call setpos("'a", save_a_mark)
5968
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
4999 < Also see |getcurpos()| and |setpos()|.
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
5000
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
5001
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
5002 getqflist([{what}]) *getqflist()*
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5003 Returns a list with all the current quickfix errors. Each
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5004 list item is a dictionary with these entries:
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5005 bufnr number of buffer that has the file name, use
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5006 bufname() to get the name
13821
98274127d675 patch 8.0.1782: no simple way to label quickfix entries
Christian Brabandt <cb@256bit.org>
parents: 13818
diff changeset
5007 module module name
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5008 lnum line number in the buffer (first line is 1)
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5009 col column number (first column is 1)
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
5010 vcol |TRUE|: "col" is visual column
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
5011 |FALSE|: "col" is byte index
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5012 nr error number
1065
caa550fe4457 updated for version 7.0-191
vimboss
parents: 1029
diff changeset
5013 pattern search pattern used to locate the error
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5014 text description of the error
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5015 type type of the error, 'E', '1', etc.
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
5016 valid |TRUE|: recognized error message
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5017
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
5018 When there is no error list or it's empty, an empty list is
1065
caa550fe4457 updated for version 7.0-191
vimboss
parents: 1029
diff changeset
5019 returned. Quickfix list entries with non-existing buffer
caa550fe4457 updated for version 7.0-191
vimboss
parents: 1029
diff changeset
5020 number are returned with "bufnr" set to zero.
515
04dcb5a1f2f9 updated for version 7.0144
vimboss
parents: 504
diff changeset
5021
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5022 Useful application: Find pattern matches in multiple files and
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5023 do something with them: >
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5024 :vimgrep /theword/jg *.c
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5025 :for d in getqflist()
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5026 : echo bufname(d.bufnr) ':' d.lnum '=' d.text
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
5027 :endfor
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
5028 <
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
5029 If the optional {what} dictionary argument is supplied, then
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
5030 returns only the items listed in {what} as a dictionary. The
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
5031 following string items are supported in {what}:
13062
6479dadcf214 patch 8.0.1406: difficult to track changes to a quickfix list
Christian Brabandt <cb@256bit.org>
parents: 13051
diff changeset
5032 changedtick get the total number of changes made
13818
28ac7914b2b6 Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents: 13796
diff changeset
5033 to the list |quickfix-changedtick|
28ac7914b2b6 Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents: 13796
diff changeset
5034 context get the |quickfix-context|
12321
2779d593a706 patch 8.0.1040: cannot use another error format in getqflist()
Christian Brabandt <cb@256bit.org>
parents: 12319
diff changeset
5035 efm errorformat to use when parsing "lines". If
12968
45987b1b77dc Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12909
diff changeset
5036 not present, then the 'errorformat' option
12321
2779d593a706 patch 8.0.1040: cannot use another error format in getqflist()
Christian Brabandt <cb@256bit.org>
parents: 12319
diff changeset
5037 value is used.
12287
20641a7e1fc9 patch 8.0.1023: it is not easy to identify a quickfix list
Christian Brabandt <cb@256bit.org>
parents: 12273
diff changeset
5038 id get information for the quickfix list with
20641a7e1fc9 patch 8.0.1023: it is not easy to identify a quickfix list
Christian Brabandt <cb@256bit.org>
parents: 12273
diff changeset
5039 |quickfix-ID|; zero means the id for the
12968
45987b1b77dc Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12909
diff changeset
5040 current list or the list specified by "nr"
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
5041 idx index of the current entry in the quickfix
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
5042 list specified by 'id' or 'nr'.
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
5043 See |quickfix-index|
11549
f5add45f9848 patch 8.0.0657: cannot get and set quickfix list items
Christian Brabandt <cb@256bit.org>
parents: 11543
diff changeset
5044 items quickfix list entries
13818
28ac7914b2b6 Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents: 13796
diff changeset
5045 lines parse a list of lines using 'efm' and return
28ac7914b2b6 Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents: 13796
diff changeset
5046 the resulting entries. Only a |List| type is
28ac7914b2b6 Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents: 13796
diff changeset
5047 accepted. The current quickfix list is not
28ac7914b2b6 Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents: 13796
diff changeset
5048 modified. See |quickfix-parse|.
10237
197795e3530d commit https://github.com/vim/vim/commit/890680ca6364386fabb271c85e0755bcaa6a33c1
Christian Brabandt <cb@256bit.org>
parents: 10233
diff changeset
5049 nr get information for this quickfix list; zero
12321
2779d593a706 patch 8.0.1040: cannot use another error format in getqflist()
Christian Brabandt <cb@256bit.org>
parents: 12319
diff changeset
5050 means the current quickfix list and "$" means
11502
46bbef0ee9a6 patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents: 11473
diff changeset
5051 the last quickfix list
12465
805f7fd40e0d patch 8.0.1112: can't get size or current index from quickfix list
Christian Brabandt <cb@256bit.org>
parents: 12427
diff changeset
5052 size number of entries in the quickfix list
13818
28ac7914b2b6 Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents: 13796
diff changeset
5053 title get the list title |quickfix-title|
13016
e47e70300f30 patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents: 12977
diff changeset
5054 winid get the quickfix |window-ID|
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
5055 all all of the above quickfix properties
13016
e47e70300f30 patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents: 12977
diff changeset
5056 Non-string items in {what} are ignored. To get the value of a
13026
7c0e0e923537 patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents: 13020
diff changeset
5057 particular item, set it to zero.
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
5058 If "nr" is not present then the current quickfix list is used.
12287
20641a7e1fc9 patch 8.0.1023: it is not easy to identify a quickfix list
Christian Brabandt <cb@256bit.org>
parents: 12273
diff changeset
5059 If both "nr" and a non-zero "id" are specified, then the list
20641a7e1fc9 patch 8.0.1023: it is not easy to identify a quickfix list
Christian Brabandt <cb@256bit.org>
parents: 12273
diff changeset
5060 specified by "id" is used.
12427
fc3e2d5614dd patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents: 12389
diff changeset
5061 To get the number of lists in the quickfix stack, set "nr" to
fc3e2d5614dd patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents: 12389
diff changeset
5062 "$" in {what}. The "nr" value in the returned dictionary
11502
46bbef0ee9a6 patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents: 11473
diff changeset
5063 contains the quickfix stack size.
12427
fc3e2d5614dd patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents: 12389
diff changeset
5064 When "lines" is specified, all the other items except "efm"
fc3e2d5614dd patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents: 12389
diff changeset
5065 are ignored. The returned dictionary contains the entry
fc3e2d5614dd patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents: 12389
diff changeset
5066 "items" with the list of entries.
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
5067
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
5068 The returned dictionary contains the following entries:
13062
6479dadcf214 patch 8.0.1406: difficult to track changes to a quickfix list
Christian Brabandt <cb@256bit.org>
parents: 13051
diff changeset
5069 changedtick total number of changes made to the
6479dadcf214 patch 8.0.1406: difficult to track changes to a quickfix list
Christian Brabandt <cb@256bit.org>
parents: 13051
diff changeset
5070 list |quickfix-changedtick|
13818
28ac7914b2b6 Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents: 13796
diff changeset
5071 context quickfix list context. See |quickfix-context|
13026
7c0e0e923537 patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents: 13020
diff changeset
5072 If not present, set to "".
7c0e0e923537 patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents: 13020
diff changeset
5073 id quickfix list ID |quickfix-ID|. If not
7c0e0e923537 patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents: 13020
diff changeset
5074 present, set to 0.
7c0e0e923537 patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents: 13020
diff changeset
5075 idx index of the current entry in the list. If not
7c0e0e923537 patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents: 13020
diff changeset
5076 present, set to 0.
7c0e0e923537 patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents: 13020
diff changeset
5077 items quickfix list entries. If not present, set to
7c0e0e923537 patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents: 13020
diff changeset
5078 an empty list.
7c0e0e923537 patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents: 13020
diff changeset
5079 nr quickfix list number. If not present, set to 0
7c0e0e923537 patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents: 13020
diff changeset
5080 size number of entries in the quickfix list. If not
7c0e0e923537 patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents: 13020
diff changeset
5081 present, set to 0.
7c0e0e923537 patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents: 13020
diff changeset
5082 title quickfix list title text. If not present, set
7c0e0e923537 patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents: 13020
diff changeset
5083 to "".
13016
e47e70300f30 patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents: 12977
diff changeset
5084 winid quickfix |window-ID|. If not present, set to 0
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
5085
13818
28ac7914b2b6 Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents: 13796
diff changeset
5086 Examples (See also |getqflist-examples|): >
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
5087 :echo getqflist({'all': 1})
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
5088 :echo getqflist({'nr': 2, 'title': 1})
12303
ec7a4fd21dd5 patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents: 12287
diff changeset
5089 :echo getqflist({'lines' : ["F1:10:L10"]})
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
5090 <
5796
f084024c0ddb updated for version 7.4.242
Bram Moolenaar <bram@vim.org>
parents: 5794
diff changeset
5091 getreg([{regname} [, 1 [, {list}]]]) *getreg()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5092 The result is a String, which is the contents of register
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
5093 {regname}. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5094 :let cliptext = getreg('*')
9887
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
5095 < When {regname} was not set the result is an empty string.
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
5096
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
5097 getreg('=') returns the last evaluated value of the expression
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
5098 register. (For use in maps.)
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
5099 getreg('=', 1) returns the expression itself, so that it can
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
5100 be restored with |setreg()|. For other registers the extra
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
5101 argument is ignored, thus you can always give it.
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
5102
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
5103 If {list} is present and |TRUE|, the result type is changed
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
5104 to |List|. Each list item is one text line. Use it if you care
5796
f084024c0ddb updated for version 7.4.242
Bram Moolenaar <bram@vim.org>
parents: 5794
diff changeset
5105 about zero bytes possibly present inside register: without
f084024c0ddb updated for version 7.4.242
Bram Moolenaar <bram@vim.org>
parents: 5794
diff changeset
5106 third argument both NLs and zero bytes are represented as NLs
f084024c0ddb updated for version 7.4.242
Bram Moolenaar <bram@vim.org>
parents: 5794
diff changeset
5107 (see |NL-used-for-Nul|).
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
5108 When the register was not set an empty list is returned.
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
5109
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5110 If {regname} is not specified, |v:register| is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5111
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
5112
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5113 getregtype([{regname}]) *getregtype()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5114 The result is a String, which is type of register {regname}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5115 The value will be one of:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5116 "v" for |characterwise| text
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5117 "V" for |linewise| text
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5118 "<CTRL-V>{width}" for |blockwise-visual| text
5596
1098b7b6e147 updated for version 7.4.145
Bram Moolenaar <bram@vim.org>
parents: 5555
diff changeset
5119 "" for an empty or unknown register
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5120 <CTRL-V> is one character with value 0x16.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5121 If {regname} is not specified, |v:register| is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5122
9858
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
5123 gettabinfo([{arg}]) *gettabinfo()*
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
5124 If {arg} is not specified, then information about all the tab
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
5125 pages is returned as a List. Each List item is a Dictionary.
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
5126 Otherwise, {arg} specifies the tab page number and information
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
5127 about that one is returned. If the tab page does not exist an
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
5128 empty List is returned.
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
5129
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
5130 Each List item is a Dictionary with the following entries:
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
5131 tabnr tab page number.
10000
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
5132 variables a reference to the dictionary with
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
5133 tabpage-local variables
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
5134 windows List of |window-ID|s in the tag page.
9858
3e96d9ed2ca1 commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents: 9850
diff changeset
5135
4157
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
5136 gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()*
2207
b17bbfa96fa0 Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents: 2206
diff changeset
5137 Get the value of a tab-local variable {varname} in tab page
b17bbfa96fa0 Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents: 2206
diff changeset
5138 {tabnr}. |t:var|
b17bbfa96fa0 Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents: 2206
diff changeset
5139 Tabs are numbered starting with one.
6197
4176c48c7dd5 updated for version 7.4.434
Bram Moolenaar <bram@vim.org>
parents: 6183
diff changeset
5140 When {varname} is empty a dictionary with all tab-local
4176c48c7dd5 updated for version 7.4.434
Bram Moolenaar <bram@vim.org>
parents: 6183
diff changeset
5141 variables is returned.
2207
b17bbfa96fa0 Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents: 2206
diff changeset
5142 Note that the name without "t:" must be used.
4157
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
5143 When the tab or variable doesn't exist {def} or an empty
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
5144 string is returned, there is no error message.
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
5145
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
5146 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()*
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
5147 Get the value of window-local variable {varname} in window
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
5148 {winnr} in tab page {tabnr}.
4157
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
5149 When {varname} is empty a dictionary with all window-local
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
5150 variables is returned.
10000
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
5151 When {varname} is equal to "&" get the values of all
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
5152 window-local options in a Dictionary.
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
5153 Otherwise, when {varname} starts with "&" get the value of a
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
5154 window-local option.
4157
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
5155 Note that {varname} must be the name without "w:".
831
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
5156 Tabs are numbered starting with one. For the current tabpage
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
5157 use |getwinvar()|.
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
5158 {winnr} can be the window number or the |window-ID|.
831
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
5159 When {winnr} is zero the current window is used.
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
5160 This also works for a global option, buffer-local option and
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
5161 window-local option, but it doesn't work for a global variable
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
5162 or buffer-local variable.
4157
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
5163 When the tab, window or variable doesn't exist {def} or an
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
5164 empty string is returned, there is no error message.
831
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
5165 Examples: >
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
5166 :let list_is_on = gettabwinvar(1, 2, '&list')
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
5167 :echo "myvar = " . gettabwinvar(3, 1, 'myvar')
1266
54588e2e8041 updated for version 7.1
vimboss
parents: 1215
diff changeset
5168 <
14347
723487cd7876 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14343
diff changeset
5169 To obtain all window-local variables use: >
723487cd7876 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14343
diff changeset
5170 gettabwinvar({tabnr}, {winnr}, '&')
723487cd7876 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14343
diff changeset
5171
15016
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5172 gettagstack([{nr}]) *gettagstack()*
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5173 The result is a Dict, which is the tag stack of window {nr}.
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5174 {nr} can be the window number or the |window-ID|.
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5175 When {nr} is not specified, the current window is used.
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5176 When window {nr} doesn't exist, an empty Dict is returned.
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5177
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5178 The returned dictionary contains the following entries:
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5179 curidx Current index in the stack. When at
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5180 top of the stack, set to (length + 1).
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5181 Index of bottom of the stack is 1.
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5182 items List of items in the stack. Each item
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5183 is a dictionary containing the
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5184 entries described below.
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5185 length Number of entries in the stack.
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5186
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5187 Each item in the stack is a dictionary with the following
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5188 entries:
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5189 bufnr buffer number of the current jump
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5190 from cursor position before the tag jump.
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5191 See |getpos()| for the format of the
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5192 returned list.
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5193 matchnr current matching tag number. Used when
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5194 multiple matching tags are found for a
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5195 name.
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5196 tagname name of the tag
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5197
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5198 See |tagstack| for more information about the tag stack.
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
5199
14343
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5200 getwininfo([{winid}]) *getwininfo()*
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5201 Returns information about windows as a List with Dictionaries.
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5202
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5203 If {winid} is given Information about the window with that ID
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5204 is returned. If the window does not exist the result is an
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5205 empty list.
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5206
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5207 Without {winid} information about all the windows in all the
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5208 tab pages is returned.
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5209
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5210 Each List item is a Dictionary with the following entries:
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5211 bufnr number of buffer in the window
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5212 height window height (excluding winbar)
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5213 loclist 1 if showing a location list
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5214 {only with the +quickfix feature}
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5215 quickfix 1 if quickfix or location list window
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5216 {only with the +quickfix feature}
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5217 terminal 1 if a terminal window
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5218 {only with the +terminal feature}
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5219 tabnr tab page number
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5220 variables a reference to the dictionary with
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5221 window-local variables
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5222 width window width
14347
723487cd7876 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14343
diff changeset
5223 winbar 1 if the window has a toolbar, 0
723487cd7876 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14343
diff changeset
5224 otherwise
14343
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5225 wincol leftmost screen column of the window,
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5226 col from |win_screenpos()|
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5227 winid |window-ID|
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5228 winnr window number
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5229 winrow topmost screen column of the window,
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5230 row from |win_screenpos()|
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
5231
13379
0f9dd1b43244 patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
5232 getwinpos([{timeout}]) *getwinpos()*
0f9dd1b43244 patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
5233 The result is a list with two numbers, the result of
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15138
diff changeset
5234 getwinposx() and getwinposy() combined:
13379
0f9dd1b43244 patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
5235 [x-pos, y-pos]
0f9dd1b43244 patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
5236 {timeout} can be used to specify how long to wait in msec for
0f9dd1b43244 patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
5237 a response from the terminal. When omitted 100 msec is used.
13437
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
5238 Use a longer time for a remote terminal.
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
5239 When using a value less than 10 and no response is received
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
5240 within that time, a previously reported position is returned,
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
5241 if available. This can be used to poll for the position and
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
5242 do some work in the meantime: >
13437
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
5243 while 1
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
5244 let res = getwinpos(1)
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
5245 if res[0] >= 0
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
5246 break
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
5247 endif
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
5248 " Do some work here
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
5249 endwhile
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
5250 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5251 *getwinposx()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5252 getwinposx() The result is a Number, which is the X coordinate in pixels of
11347
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5253 the left hand side of the GUI Vim window. Also works for an
13379
0f9dd1b43244 patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
5254 xterm (uses a timeout of 100 msec).
11347
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5255 The result will be -1 if the information is not available.
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5256 The value can be used with `:winpos`.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5257
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5258 *getwinposy()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5259 getwinposy() The result is a Number, which is the Y coordinate in pixels of
13379
0f9dd1b43244 patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
5260 the top of the GUI Vim window. Also works for an xterm (uses
0f9dd1b43244 patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents: 13341
diff changeset
5261 a timeout of 100 msec).
11347
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5262 The result will be -1 if the information is not available.
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5263 The value can be used with `:winpos`.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5264
4157
cb185366f5c8 updated for version 7.3.831
Bram Moolenaar <bram@vim.org>
parents: 4151
diff changeset
5265 getwinvar({winnr}, {varname} [, {def}]) *getwinvar()*
831
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
5266 Like |gettabwinvar()| for the current tabpage.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5267 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5268 :let list_is_on = getwinvar(2, '&list')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5269 :echo "myvar = " . getwinvar(1, 'myvar')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5270 <
6663
056809de0b29 updated for version 7.4.656
Bram Moolenaar <bram@vim.org>
parents: 6647
diff changeset
5271 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()*
1754
28d0c20ad8a0 updated for version 7.2-051
vimboss
parents: 1733
diff changeset
5272 Expand the file wildcards in {expr}. See |wildcards| for the
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
5273 use of special characters.
3410
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
5274
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
5275 Unless the optional {nosuf} argument is given and is |TRUE|,
1754
28d0c20ad8a0 updated for version 7.2-051
vimboss
parents: 1733
diff changeset
5276 the 'suffixes' and 'wildignore' options apply: Names matching
28d0c20ad8a0 updated for version 7.2-051
vimboss
parents: 1733
diff changeset
5277 one of the patterns in 'wildignore' will be skipped and
28d0c20ad8a0 updated for version 7.2-051
vimboss
parents: 1733
diff changeset
5278 'suffixes' affect the ordering of matches.
2662
916c90b37ea9 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
5279 'wildignorecase' always applies.
3410
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
5280
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
5281 When {list} is present and it is |TRUE| the result is a List
3410
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
5282 with all matching files. The advantage of using a List is,
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
5283 you also get filenames containing newlines correctly.
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
5284 Otherwise the result is a String and when there are several
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
5285 matches, they are separated by <NL> characters.
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
5286
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
5287 If the expansion fails, the result is an empty String or List.
6663
056809de0b29 updated for version 7.4.656
Bram Moolenaar <bram@vim.org>
parents: 6647
diff changeset
5288
3445
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3410
diff changeset
5289 A name for a non-existing file is not included. A symbolic
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3410
diff changeset
5290 link is only included if it points to an existing file.
6663
056809de0b29 updated for version 7.4.656
Bram Moolenaar <bram@vim.org>
parents: 6647
diff changeset
5291 However, when the {alllinks} argument is present and it is
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
5292 |TRUE| then all symbolic links are included.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5293
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5294 For most systems backticks can be used to get files names from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5295 any external command. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5296 :let tagfiles = glob("`find . -name tags -print`")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5297 :let &tags = substitute(tagfiles, "\n", ",", "g")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5298 < The result of the program inside the backticks should be one
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
5299 item per line. Spaces inside an item are allowed.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5300
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5301 See |expand()| for expanding special Vim variables. See
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5302 |system()| for getting the raw output of an external command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5303
6697
12155a47f6c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6663
diff changeset
5304 glob2regpat({expr}) *glob2regpat()*
12155a47f6c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6663
diff changeset
5305 Convert a file pattern, as used by glob(), into a search
12155a47f6c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6663
diff changeset
5306 pattern. The result can be used to match with a string that
12155a47f6c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6663
diff changeset
5307 is a file name. E.g. >
12155a47f6c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6663
diff changeset
5308 if filename =~ glob2regpat('Make*.mak')
12155a47f6c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6663
diff changeset
5309 < This is equivalent to: >
12155a47f6c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6663
diff changeset
5310 if filename =~ '^Make.*\.mak$'
7788
192ae655ac91 commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents: 7782
diff changeset
5311 < When {expr} is an empty string the result is "^$", match an
192ae655ac91 commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents: 7782
diff changeset
5312 empty string.
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
5313 Note that the result depends on the system. On MS-Windows
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
5314 a backslash usually means a path separator.
7788
192ae655ac91 commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents: 7782
diff changeset
5315
6663
056809de0b29 updated for version 7.4.656
Bram Moolenaar <bram@vim.org>
parents: 6647
diff changeset
5316 *globpath()*
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5317 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5318 Perform glob() on all directories in {path} and concatenate
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5319 the results. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5320 :echo globpath(&rtp, "syntax/c.vim")
5873
8e9db1f27a00 updated for version 7.4.279
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
5321 <
8e9db1f27a00 updated for version 7.4.279
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
5322 {path} is a comma-separated list of directory names. Each
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5323 directory name is prepended to {expr} and expanded like with
1754
28d0c20ad8a0 updated for version 7.2-051
vimboss
parents: 1733
diff changeset
5324 |glob()|. A path separator is inserted when needed.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5325 To add a comma inside a directory name escape it with a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5326 backslash. Note that on MS-Windows a directory may have a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5327 trailing backslash, remove it if you put a comma after it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5328 If the expansion fails for one of the directories, there is no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5329 error message.
5873
8e9db1f27a00 updated for version 7.4.279
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
5330
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
5331 Unless the optional {nosuf} argument is given and is |TRUE|,
1754
28d0c20ad8a0 updated for version 7.2-051
vimboss
parents: 1733
diff changeset
5332 the 'suffixes' and 'wildignore' options apply: Names matching
28d0c20ad8a0 updated for version 7.2-051
vimboss
parents: 1733
diff changeset
5333 one of the patterns in 'wildignore' will be skipped and
28d0c20ad8a0 updated for version 7.2-051
vimboss
parents: 1733
diff changeset
5334 'suffixes' affect the ordering of matches.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5335
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
5336 When {list} is present and it is |TRUE| the result is a List
5873
8e9db1f27a00 updated for version 7.4.279
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
5337 with all matching files. The advantage of using a List is, you
8e9db1f27a00 updated for version 7.4.279
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
5338 also get filenames containing newlines correctly. Otherwise
8e9db1f27a00 updated for version 7.4.279
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
5339 the result is a String and when there are several matches,
8e9db1f27a00 updated for version 7.4.279
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
5340 they are separated by <NL> characters. Example: >
8e9db1f27a00 updated for version 7.4.279
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
5341 :echo globpath(&rtp, "syntax/c.vim", 0, 1)
8e9db1f27a00 updated for version 7.4.279
Bram Moolenaar <bram@vim.org>
parents: 5862
diff changeset
5342 <
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5343 {alllinks} is used as with |glob()|.
6663
056809de0b29 updated for version 7.4.656
Bram Moolenaar <bram@vim.org>
parents: 6647
diff changeset
5344
444
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
5345 The "**" item can be used to search in a directory tree.
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
5346 For example, to find all "README.txt" files in the directories
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
5347 in 'runtimepath' and below: >
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
5348 :echo globpath(&rtp, "**/README.txt")
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
5349 < Upwards search and limiting the depth of "**" is not
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
5350 supported, thus using 'path' will not always work properly.
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
5351
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5352 *has()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5353 has({feature}) The result is a Number, which is 1 if the feature {feature} is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5354 supported, zero otherwise. The {feature} argument is a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5355 string. See |feature-list| below.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5356 Also see |exists()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5357
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
5358
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
5359 has_key({dict}, {key}) *has_key()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5360 The result is a Number, which is 1 if |Dictionary| {dict} has
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5361 an entry with key {key}. Zero otherwise.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
5362
7653
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
5363 haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()*
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
5364 The result is a Number, which is 1 when the window has set a
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
5365 local path via |:lcd|, and 0 otherwise.
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
5366
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
5367 Without arguments use the current window.
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
5368 With {winnr} use this window in the current tab page.
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
5369 With {winnr} and {tabnr} use the window in the specified tab
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
5370 page.
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
5371 {winnr} can be the window number or the |window-ID|.
7653
d4370fef0175 commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents: 7651
diff changeset
5372 Return 0 if the arguments are invalid.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
5373
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
5374 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5375 The result is a Number, which is 1 if there is a mapping that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5376 contains {what} in somewhere in the rhs (what it is mapped to)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5377 and this mapping exists in one of the modes indicated by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5378 {mode}.
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
5379 When {abbr} is there and it is |TRUE| use abbreviations
786
8f6a426bc1e0 updated for version 7.0229
vimboss
parents: 782
diff changeset
5380 instead of mappings. Don't forget to specify Insert and/or
8f6a426bc1e0 updated for version 7.0229
vimboss
parents: 782
diff changeset
5381 Command-line mode.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5382 Both the global mappings and the mappings local to the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5383 buffer are checked for a match.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5384 If no matching mapping is found 0 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5385 The following characters are recognized in {mode}:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5386 n Normal mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5387 v Visual mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5388 o Operator-pending mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5389 i Insert mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5390 l Language-Argument ("r", "f", "t", etc.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5391 c Command-line mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5392 When {mode} is omitted, "nvo" is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5393
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5394 This function is useful to check if a mapping already exists
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
5395 to a function in a Vim script. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5396 :if !hasmapto('\ABCdoit')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5397 : map <Leader>d \ABCdoit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5398 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5399 < This installs the mapping to "\ABCdoit" only if there isn't
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5400 already a mapping to "\ABCdoit".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5401
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5402 histadd({history}, {item}) *histadd()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5403 Add the String {item} to the history {history} which can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5404 one of: *hist-names*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5405 "cmd" or ":" command line history
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5406 "search" or "/" search pattern history
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
5407 "expr" or "=" typed expression history
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5408 "input" or "@" input line history
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
5409 "debug" or ">" debug command history
10228
8a1481e59d64 commit https://github.com/vim/vim/commit/3e496b0ea31996b665824f45664dee1fdd73c4d0
Christian Brabandt <cb@256bit.org>
parents: 10218
diff changeset
5410 empty the current or last used history
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
5411 The {history} string does not need to be the whole name, one
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
5412 character is sufficient.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5413 If {item} does already exist in the history, it will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5414 shifted to become the newest entry.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5415 The result is a Number: 1 if the operation was successful,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5416 otherwise 0 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5417
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5418 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5419 :call histadd("input", strftime("%Y %b %d"))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5420 :let date=input("Enter date: ")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5421 < This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5422
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5423 histdel({history} [, {item}]) *histdel()*
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
5424 Clear {history}, i.e. delete all its entries. See |hist-names|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5425 for the possible values of {history}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5426
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
5427 If the parameter {item} evaluates to a String, it is used as a
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
5428 regular expression. All entries matching that expression will
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
5429 be removed from the history (if there are any).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5430 Upper/lowercase must match, unless "\c" is used |/\c|.
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
5431 If {item} evaluates to a Number, it will be interpreted as
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
5432 an index, see |:history-indexing|. The respective entry will
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
5433 be removed if it exists.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5434
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5435 The result is a Number: 1 for a successful operation,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5436 otherwise 0 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5437
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5438 Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5439 Clear expression register history: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5440 :call histdel("expr")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5441 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5442 Remove all entries starting with "*" from the search history: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5443 :call histdel("/", '^\*')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5444 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5445 The following three are equivalent: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5446 :call histdel("search", histnr("search"))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5447 :call histdel("search", -1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5448 :call histdel("search", '^'.histget("search", -1).'$')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5449 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5450 To delete the last search pattern and use the last-but-one for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5451 the "n" command and 'hlsearch': >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5452 :call histdel("search", -1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5453 :let @/ = histget("search", -1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5454
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5455 histget({history} [, {index}]) *histget()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5456 The result is a String, the entry with Number {index} from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5457 {history}. See |hist-names| for the possible values of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5458 {history}, and |:history-indexing| for {index}. If there is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5459 no such entry, an empty String is returned. When {index} is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5460 omitted, the most recent item from the history is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5461
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5462 Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5463 Redo the second last search from history. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5464 :execute '/' . histget("search", -2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5465
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5466 < Define an Ex command ":H {num}" that supports re-execution of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5467 the {num}th entry from the output of |:history|. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5468 :command -nargs=1 H execute histget("cmd", 0+<args>)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5469 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5470 histnr({history}) *histnr()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5471 The result is the Number of the current entry in {history}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5472 See |hist-names| for the possible values of {history}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5473 If an error occurred, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5474
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5475 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5476 :let inp_index = histnr("expr")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5477 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5478 hlexists({name}) *hlexists()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5479 The result is a Number, which is non-zero if a highlight group
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5480 called {name} exists. This is when the group has been
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5481 defined in some way. Not necessarily when highlighting has
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5482 been defined for it, it may also have been used for a syntax
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5483 item.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5484 *highlight_exists()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5485 Obsolete name: highlight_exists().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5486
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5487 *hlID()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5488 hlID({name}) The result is a Number, which is the ID of the highlight group
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5489 with name {name}. When the highlight group doesn't exist,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5490 zero is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5491 This can be used to retrieve information about the highlight
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
5492 group. For example, to get the background color of the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5493 "Comment" group: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5494 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5495 < *highlightID()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5496 Obsolete name: highlightID().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5497
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5498 hostname() *hostname()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5499 The result is a String, which is the name of the machine on
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
5500 which Vim is currently running. Machine names greater than
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5501 256 characters long are truncated.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5502
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5503 iconv({expr}, {from}, {to}) *iconv()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5504 The result is a String, which is the text {expr} converted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5505 from encoding {from} to encoding {to}.
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
5506 When the conversion completely fails an empty string is
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
5507 returned. When some characters could not be converted they
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
5508 are replaced with "?".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5509 The encoding names are whatever the iconv() library function
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5510 can accept, see ":!man 3 iconv".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5511 Most conversions require Vim to be compiled with the |+iconv|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5512 feature. Otherwise only UTF-8 to latin1 conversion and back
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5513 can be done.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5514 This can be used to display messages with special characters,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5515 no matter what 'encoding' is set to. Write the message in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5516 UTF-8 and use: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5517 echo iconv(utf8_str, "utf-8", &enc)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5518 < Note that Vim uses UTF-8 for all Unicode encodings, conversion
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5519 from/to UCS-2 is automatically changed to use UTF-8. You
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5520 cannot use UCS-2 in a string anyway, because of the NUL bytes.
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
5521 {only available when compiled with the |+multi_byte| feature}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5522
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5523 *indent()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5524 indent({lnum}) The result is a Number, which is indent of line {lnum} in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5525 current buffer. The indent is counted in spaces, the value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5526 of 'tabstop' is relevant. {lnum} is used just like in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5527 |getline()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5528 When {lnum} is invalid -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5529
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5530
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5531 index({object}, {expr} [, {start} [, {ic}]]) *index()*
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5532 If {object} is a |List| return the lowest index where the item
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5533 has a value equal to {expr}. There is no automatic
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5534 conversion, so the String "4" is different from the Number 4.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5535 And the number 4 is different from the Float 4.0. The value
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5536 of 'ignorecase' is not used here, case always matters.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5537
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5538 If {object} is |Blob| return the lowest index where the byte
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5539 value is equal to {expr}.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5540
153
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
5541 If {start} is given then start looking at the item with index
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
5542 {start} (may be negative for an item relative to the end).
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
5543 When {ic} is given and it is |TRUE|, ignore case. Otherwise
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5544 case must match.
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5545 -1 is returned when {expr} is not found in {object}.
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5546 Example: >
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5547 :let idx = index(words, "the")
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
5548 :if index(numbers, 123) >= 0
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5549
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
5550
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5551 input({prompt} [, {text} [, {completion}]]) *input()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5552 The result is a String, which is whatever the user typed on
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
5553 the command-line. The {prompt} argument is either a prompt
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
5554 string, or a blank string (for no prompt). A '\n' can be used
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
5555 in the prompt to start a new line.
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5556 The highlighting set with |:echohl| is used for the prompt.
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5557 The input is entered just like a command-line, with the same
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
5558 editing commands and mappings. There is a separate history
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5559 for lines typed for input().
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5560 Example: >
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5561 :if input("Coffee or beer? ") == "beer"
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5562 : echo "Cheers!"
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5563 :endif
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5564 <
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
5565 If the optional {text} argument is present and not empty, this
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
5566 is used for the default reply, as if the user typed this.
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
5567 Example: >
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5568 :let color = input("Color? ", "white")
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5569
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5570 < The optional {completion} argument specifies the type of
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5571 completion supported for the input. Without it completion is
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
5572 not performed. The supported completion types are the same as
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5573 that can be supplied to a user-defined command using the
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
5574 "-complete=" argument. Refer to |:command-completion| for
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5575 more information. Example: >
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5576 let fname = input("File: ", "", "file")
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5577 <
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5578 NOTE: This function must not be used in a startup file, for
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5579 the versions that only run in GUI mode (e.g., the Win32 GUI).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5580 Note: When input() is called from within a mapping it will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5581 consume remaining characters from that mapping, because a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5582 mapping is handled like the characters were typed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5583 Use |inputsave()| before input() and |inputrestore()|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5584 after input() to avoid that. Another solution is to avoid
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5585 that further characters follow in the mapping, e.g., by using
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5586 |:execute| or |:normal|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5587
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5588 Example with a mapping: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5589 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5590 :function GetFoo()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5591 : call inputsave()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5592 : let g:Foo = input("enter search pattern: ")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5593 : call inputrestore()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5594 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5595
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5596 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()*
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
5597 Like |input()|, but when the GUI is running and text dialogs
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
5598 are supported, a dialog window pops up to input the text.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5599 Example: >
3875
8235ccf121bb updated for version 7.3.694
Bram Moolenaar <bram@vim.org>
parents: 3830
diff changeset
5600 :let n = inputdialog("value for shiftwidth", shiftwidth())
8235ccf121bb updated for version 7.3.694
Bram Moolenaar <bram@vim.org>
parents: 3830
diff changeset
5601 :if n != ""
8235ccf121bb updated for version 7.3.694
Bram Moolenaar <bram@vim.org>
parents: 3830
diff changeset
5602 : let &sw = n
8235ccf121bb updated for version 7.3.694
Bram Moolenaar <bram@vim.org>
parents: 3830
diff changeset
5603 :endif
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5604 < When the dialog is cancelled {cancelreturn} is returned. When
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5605 omitted an empty string is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5606 Hitting <Enter> works like pressing the OK button. Hitting
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5607 <Esc> works like pressing the Cancel button.
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5608 NOTE: Command-line completion is not supported.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5609
519
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
5610 inputlist({textlist}) *inputlist()*
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
5611 {textlist} must be a |List| of strings. This |List| is
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
5612 displayed, one string per line. The user will be prompted to
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
5613 enter a number, which is returned.
519
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
5614 The user can also select an item by clicking on it with the
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
5615 mouse. For the first string 0 is returned. When clicking
519
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
5616 above the first item a negative number is returned. When
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
5617 clicking on the prompt one more than the length of {textlist}
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
5618 is returned.
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
5619 Make sure {textlist} has less than 'lines' entries, otherwise
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
5620 it won't work. It's a good idea to put the entry number at
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
5621 the start of the string. And put a prompt in the first item.
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
5622 Example: >
519
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
5623 let color = inputlist(['Select color:', '1. red',
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
5624 \ '2. green', '3. blue'])
d50452846776 updated for version 7.0145
vimboss
parents: 515
diff changeset
5625
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5626 inputrestore() *inputrestore()*
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
5627 Restore typeahead that was saved with a previous |inputsave()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5628 Should be called the same number of times inputsave() is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5629 called. Calling it more often is harmless though.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5630 Returns 1 when there is nothing to restore, 0 otherwise.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5631
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5632 inputsave() *inputsave()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5633 Preserve typeahead (also from mappings) and clear it, so that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5634 a following prompt gets input from the user. Should be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5635 followed by a matching inputrestore() after the prompt. Can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5636 be used several times, in which case there must be just as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5637 many inputrestore() calls.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5638 Returns 1 when out of memory, 0 otherwise.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5639
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5640 inputsecret({prompt} [, {text}]) *inputsecret()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5641 This function acts much like the |input()| function with but
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5642 two exceptions:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5643 a) the user's response will be displayed as a sequence of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5644 asterisks ("*") thereby keeping the entry secret, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5645 b) the user's response will not be recorded on the input
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5646 |history| stack.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5647 The result is a String, which is whatever the user actually
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5648 typed on the command-line in response to the issued prompt.
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
5649 NOTE: Command-line completion is not supported.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5650
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5651 insert({object}, {item} [, {idx}]) *insert()*
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5652 When {object} is a |List| or a |Blob| insert {item} at the start
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5653 of it.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5654
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5655 If {idx} is specified insert {item} before the item with index
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
5656 {idx}. If {idx} is zero it goes before the first item, just
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5657 like omitting {idx}. A negative {idx} is also possible, see
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5658 |list-index|. -1 inserts just before the last item.
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5659
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
5660 Returns the resulting |List| or |Blob|. Examples: >
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5661 :let mylist = insert([2, 3, 5], 1)
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5662 :call insert(mylist, 4, -1)
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5663 :call insert(mylist, 6, len(mylist))
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
5664 < The last example can be done simpler with |add()|.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5665 Note that when {item} is a |List| it is inserted as a single
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
5666 item. Use |extend()| to concatenate |Lists|.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5667
3214
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
5668 invert({expr}) *invert()*
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
5669 Bitwise invert. The argument is converted to a number. A
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
5670 List, Dict or Float argument causes an error. Example: >
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
5671 :let bits = invert(bits)
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
5672
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5673 isdirectory({directory}) *isdirectory()*
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
5674 The result is a Number, which is |TRUE| when a directory
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5675 with the name {directory} exists. If {directory} doesn't
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
5676 exist, or isn't a directory, the result is |FALSE|. {directory}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5677 is any expression, which is used as a String.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5678
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
5679 islocked({expr}) *islocked()* *E786*
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
5680 The result is a Number, which is |TRUE| when {expr} is the
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5681 name of a locked variable.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5682 {expr} must be the name of a variable, |List| item or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5683 |Dictionary| entry, not the variable itself! Example: >
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5684 :let alist = [0, ['a', 'b'], 2, 3]
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5685 :lockvar 1 alist
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5686 :echo islocked('alist') " 1
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5687 :echo islocked('alist[1]') " 0
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5688
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5689 < When {expr} is a variable that does not exist you get an error
843
9f279ebda751 updated for version 7.0f01
vimboss
parents: 842
diff changeset
5690 message. Use |exists()| to check for existence.
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
5691
8246
f16bfe02cef1 commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents: 8218
diff changeset
5692 isnan({expr}) *isnan()*
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
5693 Return |TRUE| if {expr} is a float with value NaN. >
8246
f16bfe02cef1 commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents: 8218
diff changeset
5694 echo isnan(0.0 / 0.0)
f16bfe02cef1 commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents: 8218
diff changeset
5695 < 1 ~
f16bfe02cef1 commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents: 8218
diff changeset
5696
f16bfe02cef1 commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents: 8218
diff changeset
5697 {only available when compiled with the |+float| feature}
f16bfe02cef1 commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents: 8218
diff changeset
5698
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
5699 items({dict}) *items()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5700 Return a |List| with all the key-value pairs of {dict}. Each
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5701 |List| item is a list with two items: the key of a {dict}
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5702 entry and the value of this entry. The |List| is in arbitrary
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5703 order.
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
5704
8061
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 8031
diff changeset
5705 job_getchannel({job}) *job_getchannel()*
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 8031
diff changeset
5706 Get the channel handle that {job} is using.
8497
da01d5da2cfa commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents: 8451
diff changeset
5707 To check if the job has no channel: >
da01d5da2cfa commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents: 8451
diff changeset
5708 if string(job_getchannel()) == 'channel fail'
da01d5da2cfa commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents: 8451
diff changeset
5709 <
8061
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 8031
diff changeset
5710 {only available when compiled with the |+job| feature}
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 8031
diff changeset
5711
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
5712 job_info([{job}]) *job_info()*
8512
5104f96b6ecf commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents: 8502
diff changeset
5713 Returns a Dictionary with information about {job}:
5104f96b6ecf commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents: 8502
diff changeset
5714 "status" what |job_status()| returns
5104f96b6ecf commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents: 8502
diff changeset
5715 "channel" what |job_getchannel()| returns
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
5716 "cmd" List of command arguments used to start the job
11933
d033653d3df8 patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents: 11904
diff changeset
5717 "process" process ID
12389
d0cf7f71b95b patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents: 12337
diff changeset
5718 "tty_in" terminal input name, empty when none
d0cf7f71b95b patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents: 12337
diff changeset
5719 "tty_out" terminal output name, empty when none
8512
5104f96b6ecf commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents: 8502
diff changeset
5720 "exitval" only valid when "status" is "dead"
8577
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
5721 "exit_cb" function to be called on exit
8512
5104f96b6ecf commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents: 8502
diff changeset
5722 "stoponexit" |job-stoponexit|
5104f96b6ecf commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents: 8502
diff changeset
5723
13796
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
5724 Without any arguments, returns a List with all Job objects.
87012d2b17b5 patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents: 13740
diff changeset
5725
8178
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
5726 job_setoptions({job}, {options}) *job_setoptions()*
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
5727 Change options for {job}. Supported are:
8512
5104f96b6ecf commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents: 8502
diff changeset
5728 "stoponexit" |job-stoponexit|
8577
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
5729 "exit_cb" |job-exit_cb|
8178
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
5730
8061
abd64cf67bcf commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents: 8031
diff changeset
5731 job_start({command} [, {options}]) *job_start()*
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5732 Start a job and return a Job object. Unlike |system()| and
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5733 |:!cmd| this does not wait for the job to finish.
12254
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12252
diff changeset
5734 To start a job in a terminal window see |term_start()|.
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5735
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5736 {command} can be a String. This works best on MS-Windows. On
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5737 Unix it is split up in white-separated parts to be passed to
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5738 execvp(). Arguments in double quotes can contain white space.
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5739
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5740 {command} can be a List, where the first item is the executable
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5741 and further items are the arguments. All items are converted
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5742 to String. This works best on Unix.
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5743
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5744 On MS-Windows, job_start() makes a GUI application hidden. If
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5745 want to show it, Use |:!start| instead.
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5746
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5747 The command is executed directly, not through a shell, the
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5748 'shell' option is not used. To use the shell: >
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5749 let job = job_start(["/bin/sh", "-c", "echo hello"])
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5750 < Or: >
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5751 let job = job_start('/bin/sh -c "echo hello"')
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5752 < Note that this will start two processes, the shell and the
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5753 command it executes. If you don't want this use the "exec"
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5754 shell command.
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5755
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5756 On Unix $PATH is used to search for the executable only when
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5757 the command does not contain a slash.
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5758
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5759 The job will use the same terminal as Vim. If it reads from
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5760 stdin the job and Vim will be fighting over input, that
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5761 doesn't work. Redirect stdin and stdout to avoid problems: >
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5762 let job = job_start(['sh', '-c', "myserver </dev/null >/dev/null"])
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5763 <
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5764 The returned Job object can be used to get the status with
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5765 |job_status()| and stop the job with |job_stop()|.
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5766
14123
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14103
diff changeset
5767 Note that the job object will be deleted if there are no
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14103
diff changeset
5768 references to it. This closes the stdin and stderr, which may
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14103
diff changeset
5769 cause the job to fail with an error. To avoid this keep a
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14103
diff changeset
5770 reference to the job. Thus instead of: >
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14103
diff changeset
5771 call job_start('my-command')
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14103
diff changeset
5772 < use: >
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14103
diff changeset
5773 let myjob = job_start('my-command')
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14103
diff changeset
5774 < and unlet "myjob" once the job is not needed or is past the
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14103
diff changeset
5775 point where it would fail (e.g. when it prints a message on
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14103
diff changeset
5776 startup). Keep in mind that variables local to a function
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14103
diff changeset
5777 will cease to exist if the function returns. Use a
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14103
diff changeset
5778 script-local variable if needed: >
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14103
diff changeset
5779 let s:myjob = job_start('my-command')
583bf95b6c84 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14103
diff changeset
5780 <
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5781 {options} must be a Dictionary. It can contain many optional
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5782 items, see |job-options|.
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5783
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5784 {only available when compiled with the |+job| feature}
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5785
8178
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
5786 job_status({job}) *job_status()* *E916*
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5787 Returns a String with the status of {job}:
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5788 "run" job is running
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5789 "fail" job failed to start
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5790 "dead" job died or was stopped after running
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
5791
9221
17fa362f10be commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents: 9219
diff changeset
5792 On Unix a non-existing command results in "dead" instead of
17fa362f10be commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents: 9219
diff changeset
5793 "fail", because a fork happens before the failure can be
17fa362f10be commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents: 9219
diff changeset
5794 detected.
17fa362f10be commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents: 9219
diff changeset
5795
8876
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
5796 If an exit callback was set with the "exit_cb" option and the
8178
e77efd7a7dad commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents: 8148
diff changeset
5797 job is now detected to be "dead" the callback will be invoked.
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5798
8502
ee5cb2e9ed5a commit https://github.com/vim/vim/commit/8950a563b306ce76f259573d91c2ddccdf52e32e
Christian Brabandt <cb@256bit.org>
parents: 8497
diff changeset
5799 For more information see |job_info()|.
ee5cb2e9ed5a commit https://github.com/vim/vim/commit/8950a563b306ce76f259573d91c2ddccdf52e32e
Christian Brabandt <cb@256bit.org>
parents: 8497
diff changeset
5800
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5801 {only available when compiled with the |+job| feature}
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5802
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5803 job_stop({job} [, {how}]) *job_stop()*
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5804 Stop the {job}. This can also be used to signal the job.
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5805
8251
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5806 When {how} is omitted or is "term" the job will be terminated.
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5807 For Unix SIGTERM is sent. On MS-Windows the job will be
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5808 terminated forcedly (there is no "gentle" way).
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5809 This goes to the process group, thus children may also be
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5810 affected.
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5811
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5812 Effect for Unix:
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5813 "term" SIGTERM (default)
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5814 "hup" SIGHUP
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5815 "quit" SIGQUIT
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5816 "int" SIGINT
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5817 "kill" SIGKILL (strongest way to stop)
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5818 number signal with that number
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5819
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5820 Effect for MS-Windows:
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5821 "term" terminate process forcedly (default)
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5822 "hup" CTRL_BREAK
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5823 "quit" CTRL_BREAK
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5824 "int" CTRL_C
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5825 "kill" terminate process forcedly
989ac3aed1ef commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents: 8246
diff changeset
5826 Others CTRL_BREAK
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5827
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5828 On Unix the signal is sent to the process group. This means
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5829 that when the job is "sh -c command" it affects both the shell
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5830 and the command.
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5831
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5832 The result is a Number: 1 if the operation could be executed,
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5833 0 if "how" is not supported on the system.
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5834 Note that even when the operation was executed, whether the
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5835 job was actually stopped needs to be checked with
11414
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents: 11407
diff changeset
5836 |job_status()|.
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents: 11407
diff changeset
5837
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents: 11407
diff changeset
5838 If the status of the job is "dead", the signal will not be
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents: 11407
diff changeset
5839 sent. This is to avoid to stop the wrong job (esp. on Unix,
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents: 11407
diff changeset
5840 where process numbers are recycled).
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents: 11407
diff changeset
5841
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents: 11407
diff changeset
5842 When using "kill" Vim will assume the job will die and close
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents: 11407
diff changeset
5843 the channel.
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5844
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
5845 {only available when compiled with the |+job| feature}
7957
b74549818500 commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents: 7935
diff changeset
5846
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
5847 join({list} [, {sep}]) *join()*
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
5848 Join the items in {list} together into one String.
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
5849 When {sep} is specified it is put in between the items. If
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
5850 {sep} is omitted a single space is used.
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
5851 Note that {sep} is not added at the end. You might want to
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
5852 add it there too: >
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
5853 let lines = join(mylist, "\n") . "\n"
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
5854 < String items are used as-is. |Lists| and |Dictionaries| are
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
5855 converted into a string like with |string()|.
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
5856 The opposite function is |split()|.
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
5857
8019
d685893d852e commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents: 7992
diff changeset
5858 js_decode({string}) *js_decode()*
d685893d852e commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents: 7992
diff changeset
5859 This is similar to |json_decode()| with these differences:
7967
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5860 - Object key names do not have to be in quotes.
10563
bac9cec298ed patch 8.0.0171: JS style JSON does not support single quotes
Christian Brabandt <cb@256bit.org>
parents: 10548
diff changeset
5861 - Strings can be in single quotes.
7967
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5862 - Empty items in an array (between two commas) are allowed and
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5863 result in v:none items.
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5864
8019
d685893d852e commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents: 7992
diff changeset
5865 js_encode({expr}) *js_encode()*
d685893d852e commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents: 7992
diff changeset
5866 This is similar to |json_encode()| with these differences:
7967
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5867 - Object key names are not in quotes.
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5868 - v:none items in an array result in an empty item between
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5869 commas.
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5870 For example, the Vim object:
8019
d685893d852e commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents: 7992
diff changeset
5871 [1,v:none,{"one":1},v:none] ~
7967
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5872 Will be encoded as:
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5873 [1,,{one:1},,] ~
8019
d685893d852e commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents: 7992
diff changeset
5874 While json_encode() would produce:
7967
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5875 [1,null,{"one":1},null] ~
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5876 This encoding is valid for JavaScript. It is more efficient
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5877 than JSON, especially when using an array with optional items.
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5878
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5879
8019
d685893d852e commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents: 7992
diff changeset
5880 json_decode({string}) *json_decode()*
7742
5f6f35a3cb12 commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents: 7712
diff changeset
5881 This parses a JSON formatted string and returns the equivalent
8019
d685893d852e commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents: 7992
diff changeset
5882 in Vim values. See |json_encode()| for the relation between
7742
5f6f35a3cb12 commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents: 7712
diff changeset
5883 JSON and Vim values.
5f6f35a3cb12 commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents: 7712
diff changeset
5884 The decoding is permissive:
11347
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5885 - A trailing comma in an array and object is ignored, e.g.
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5886 "[1, 2, ]" is the same as "[1, 2]".
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
5887 - Integer keys are accepted in objects, e.g. {1:2} is the
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
5888 same as {'1':2}.
7742
5f6f35a3cb12 commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents: 7712
diff changeset
5889 - More floating point numbers are recognized, e.g. "1." for
11347
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5890 "1.0", or "001.2" for "1.2". Special floating point values
15446
8ac454818352 patch 8.1.0731: JS encoding does not handle negative infinity
Bram Moolenaar <Bram@vim.org>
parents: 15424
diff changeset
5891 "Infinity", "-Infinity" and "NaN" (capitalization ignored)
8ac454818352 patch 8.1.0731: JS encoding does not handle negative infinity
Bram Moolenaar <Bram@vim.org>
parents: 15424
diff changeset
5892 are accepted.
11347
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5893 - Leading zeroes in integer numbers are ignored, e.g. "012"
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5894 for "12" or "-012" for "-12".
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5895 - Capitalization is ignored in literal names null, true or
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5896 false, e.g. "NULL" for "null", "True" for "true".
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5897 - Control characters U+0000 through U+001F which are not
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5898 escaped in strings are accepted, e.g. " " (tab
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5899 character in string) for "\t".
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5900 - Backslash in an invalid 2-character sequence escape is
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5901 ignored, e.g. "\a" is decoded as "a".
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5902 - A correct surrogate pair in JSON strings should normally be
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5903 a 12 character sequence such as "\uD834\uDD1E", but
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5904 json_decode() silently accepts truncated surrogate pairs
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5905 such as "\uD834" or "\uD834\u"
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5906 *E938*
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5907 A duplicate key in an object, valid in rfc7159, is not
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5908 accepted by json_decode() as the result must be a valid Vim
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5909 type, e.g. this fails: {"a":"b", "a":"c"}
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
5910
7712
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
5911
8019
d685893d852e commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents: 7992
diff changeset
5912 json_encode({expr}) *json_encode()*
7742
5f6f35a3cb12 commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents: 7712
diff changeset
5913 Encode {expr} as JSON and return this as a string.
7712
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
5914 The encoding is specified in:
7782
3a99194bd187 commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents: 7742
diff changeset
5915 https://tools.ietf.org/html/rfc7159.html
7712
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
5916 Vim values are converted as follows:
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
5917 |Number| decimal number
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
5918 |Float| floating point number
8275
ff900e499f79 commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents: 8251
diff changeset
5919 Float nan "NaN"
ff900e499f79 commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents: 8251
diff changeset
5920 Float inf "Infinity"
15446
8ac454818352 patch 8.1.0731: JS encoding does not handle negative infinity
Bram Moolenaar <Bram@vim.org>
parents: 15424
diff changeset
5921 Float -inf "-Infinity"
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
5922 |String| in double quotes (possibly null)
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
5923 |Funcref| not possible, error
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
5924 |List| as an array (possibly null); when
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
5925 used recursively: []
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
5926 |Dict| as an object (possibly null); when
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
5927 used recursively: {}
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
5928 |Blob| as an array of the individual bytes
7712
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
5929 v:false "false"
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
5930 v:true "true"
7967
45ea5ebf3a98 commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents: 7957
diff changeset
5931 v:none "null"
7712
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
5932 v:null "null"
8275
ff900e499f79 commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents: 8251
diff changeset
5933 Note that NaN and Infinity are passed on as values. This is
ff900e499f79 commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents: 8251
diff changeset
5934 missing in the JSON standard, but several implementations do
ff900e499f79 commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents: 8251
diff changeset
5935 allow it. If not then you will get an error.
7712
bce3b5ddb393 commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents: 7707
diff changeset
5936
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
5937 keys({dict}) *keys()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5938 Return a |List| with all the keys of {dict}. The |List| is in
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
5939 arbitrary order.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
5940
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
5941 *len()* *E701*
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5942 len({expr}) The result is a Number, which is the length of the argument.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5943 When {expr} is a String or a Number the length in bytes is
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5944 used, as with |strlen()|.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5945 When {expr} is a |List| the number of items in the |List| is
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5946 returned.
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
5947 When {expr} is a |Blob| the number of bytes is returned.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5948 When {expr} is a |Dictionary| the number of entries in the
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
5949 |Dictionary| is returned.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5950 Otherwise an error is given.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
5951
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5952 *libcall()* *E364* *E368*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5953 libcall({libname}, {funcname}, {argument})
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5954 Call function {funcname} in the run-time library {libname}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5955 with single argument {argument}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5956 This is useful to call functions in a library that you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5957 especially made to be used with Vim. Since only one argument
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5958 is possible, calling standard library functions is rather
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5959 limited.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5960 The result is the String returned by the function. If the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5961 function returns NULL, this will appear as an empty string ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5962 to Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5963 If the function returns a number, use libcallnr()!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5964 If {argument} is a number, it is passed to the function as an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5965 int; if {argument} is a string, it is passed as a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5966 null-terminated string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5967 This function will fail in |restricted-mode|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5968
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5969 libcall() allows you to write your own 'plug-in' extensions to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5970 Vim without having to recompile the program. It is NOT a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5971 means to call system functions! If you try to do so Vim will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5972 very probably crash.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5973
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5974 For Win32, the functions you write must be placed in a DLL
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5975 and use the normal C calling convention (NOT Pascal which is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5976 used in Windows System DLLs). The function must take exactly
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5977 one parameter, either a character pointer or a long integer,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5978 and must return a character pointer or NULL. The character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5979 pointer returned must point to memory that will remain valid
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5980 after the function has returned (e.g. in static data in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5981 DLL). If it points to allocated memory, that memory will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5982 leak away. Using a static buffer in the function should work,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5983 it's then freed when the DLL is unloaded.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5984
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5985 WARNING: If the function returns a non-valid pointer, Vim may
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
5986 crash! This also happens if the function returns a number,
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5987 because Vim thinks it's a pointer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5988 For Win32 systems, {libname} should be the filename of the DLL
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5989 without the ".DLL" suffix. A full path is only required if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5990 the DLL is not in the usual places.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5991 For Unix: When compiling your own plugins, remember that the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5992 object code must be compiled as position-independent ('PIC').
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
5993 {only in Win32 and some Unix versions, when the |+libcall|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5994 feature is present}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5995 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5996 :echo libcall("libc.so", "getenv", "HOME")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5997 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5998 *libcallnr()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5999 libcallnr({libname}, {funcname}, {argument})
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
6000 Just like |libcall()|, but used for a function that returns an
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6001 int instead of a string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6002 {only in Win32 on some Unix versions, when the |+libcall|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6003 feature is present}
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6004 Examples: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6005 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6006 :call libcallnr("libc.so", "printf", "Hello World!\n")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6007 :call libcallnr("libc.so", "sleep", 10)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6008 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6009 *line()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6010 line({expr}) The result is a Number, which is the line number of the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6011 position given with {expr}. The accepted positions are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6012 . the cursor position
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6013 $ the last line in the current buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6014 'x position of mark x (if the mark is not set, 0 is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6015 returned)
11313
327a04a762f6 patch 8.0.0542: getpos() can return a negative line number
Christian Brabandt <cb@256bit.org>
parents: 11263
diff changeset
6016 w0 first line visible in current window (one if the
327a04a762f6 patch 8.0.0542: getpos() can return a negative line number
Christian Brabandt <cb@256bit.org>
parents: 11263
diff changeset
6017 display isn't updated, e.g. in silent Ex mode)
327a04a762f6 patch 8.0.0542: getpos() can return a negative line number
Christian Brabandt <cb@256bit.org>
parents: 11263
diff changeset
6018 w$ last line visible in current window (this is one
327a04a762f6 patch 8.0.0542: getpos() can return a negative line number
Christian Brabandt <cb@256bit.org>
parents: 11263
diff changeset
6019 less than "w0" if no lines are visible)
1609
1324b7b755f3 updated for version 7.1-322
vimboss
parents: 1586
diff changeset
6020 v In Visual mode: the start of the Visual area (the
1324b7b755f3 updated for version 7.1-322
vimboss
parents: 1586
diff changeset
6021 cursor is the end). When not in Visual mode
1324b7b755f3 updated for version 7.1-322
vimboss
parents: 1586
diff changeset
6022 returns the cursor position. Differs from |'<| in
1324b7b755f3 updated for version 7.1-322
vimboss
parents: 1586
diff changeset
6023 that it's updated right away.
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
6024 Note that a mark in another file can be used. The line number
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
6025 then applies to another buffer.
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
6026 To get the column number use |col()|. To get both use
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
6027 |getpos()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6028 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6029 line(".") line number of the cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6030 line("'t") line number of mark t
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6031 line("'" . marker) line number of mark marker
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6032 < *last-position-jump*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6033 This autocommand jumps to the last known position in a file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6034 just after opening it, if the '" mark is set: >
11518
63b0b7b79b25 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11502
diff changeset
6035 :au BufReadPost *
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6036 \ if line("'\"") > 1 && line("'\"") <= line("$") && &ft !~# 'commit'
11561
7ad79766365a patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents: 11553
diff changeset
6037 \ | exe "normal! g`\""
7ad79766365a patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents: 11553
diff changeset
6038 \ | endif
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
6039
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6040 line2byte({lnum}) *line2byte()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6041 Return the byte count from the start of the buffer for line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6042 {lnum}. This includes the end-of-line character, depending on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6043 the 'fileformat' option for the current buffer. The first
3237
91e53bcb7946 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3224
diff changeset
6044 line returns 1. 'encoding' matters, 'fileencoding' is ignored.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6045 This can also be used to get the byte count for the line just
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6046 below the last line: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6047 line2byte(line("$") + 1)
3237
91e53bcb7946 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3224
diff changeset
6048 < This is the buffer size plus one. If 'fileencoding' is empty
91e53bcb7946 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3224
diff changeset
6049 it is the file size plus one.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6050 When {lnum} is invalid, or the |+byte_offset| feature has been
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6051 disabled at compile time, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6052 Also see |byte2line()|, |go| and |:goto|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6053
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6054 lispindent({lnum}) *lispindent()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6055 Get the amount of indent for line {lnum} according the lisp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6056 indenting rules, as with 'lisp'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6057 The indent is counted in spaces, the value of 'tabstop' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6058 relevant. {lnum} is used just like in |getline()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6059 When {lnum} is invalid or Vim was not compiled the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6060 |+lispindent| feature, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6061
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6062 localtime() *localtime()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6063 Return the current time, measured as seconds since 1st Jan
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6064 1970. See also |strftime()| and |getftime()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6065
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
6066
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
6067 log({expr}) *log()*
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
6068 Return the natural logarithm (base e) of {expr} as a |Float|.
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
6069 {expr} must evaluate to a |Float| or a |Number| in the range
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
6070 (0, inf].
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
6071 Examples: >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
6072 :echo log(10)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
6073 < 2.302585 >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
6074 :echo log(exp(5))
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
6075 < 5.0
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
6076 {only available when compiled with the |+float| feature}
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
6077
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
6078
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6079 log10({expr}) *log10()*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6080 Return the logarithm of Float {expr} to base 10 as a |Float|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6081 {expr} must evaluate to a |Float| or a |Number|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6082 Examples: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6083 :echo log10(1000)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6084 < 3.0 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6085 :echo log10(0.01)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6086 < -2.0
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6087 {only available when compiled with the |+float| feature}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6088
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6089 luaeval({expr} [, {expr}]) *luaeval()*
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6090 Evaluate Lua expression {expr} and return its result converted
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6091 to Vim data structures. Second {expr} may hold additional
3492
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
6092 argument accessible as _A inside first {expr}.
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
6093 Strings are returned as they are.
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
6094 Boolean objects are converted to numbers.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6095 Numbers are converted to |Float| values if vim was compiled
3492
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
6096 with |+float| and to numbers otherwise.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6097 Dictionaries and lists obtained by vim.eval() are returned
3492
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
6098 as-is.
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
6099 Other objects are returned as zero without any errors.
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
6100 See |lua-luaeval| for more details.
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
6101 {only available when compiled with the |+lua| feature}
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
6102
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6103 map({expr1}, {expr2}) *map()*
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6104 {expr1} must be a |List| or a |Dictionary|.
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6105 Replace each item in {expr1} with the result of evaluating
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6106 {expr2}. {expr2} must be a |string| or |Funcref|.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6107
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6108 If {expr2} is a |string|, inside {expr2} |v:val| has the value
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6109 of the current item. For a |Dictionary| |v:key| has the key
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6110 of the current item and for a |List| |v:key| has the index of
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6111 the current item.
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
6112 Example: >
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
6113 :call map(mylist, '"> " . v:val . " <"')
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
6114 < This puts "> " before and " <" after each item in "mylist".
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
6115
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6116 Note that {expr2} is the result of an expression and is then
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
6117 used as an expression again. Often it is good to use a
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
6118 |literal-string| to avoid having to double backslashes. You
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
6119 still have to double ' quotes
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
6120
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6121 If {expr2} is a |Funcref| it is called with two arguments:
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6122 1. The key or the index of the current item.
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6123 2. the value of the current item.
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6124 The function must return the new value of the item. Example
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6125 that changes each value by "key-value": >
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6126 func KeyValue(key, val)
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6127 return a:key . '-' . a:val
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6128 endfunc
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6129 call map(myDict, function('KeyValue'))
10218
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
6130 < It is shorter when using a |lambda|: >
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
6131 call map(myDict, {key, val -> key . '-' . val})
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
6132 < If you do not use "val" you can leave it out: >
584c835a2de1 commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
6133 call map(myDict, {key -> 'item: ' . key})
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6134 <
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
6135 The operation is done in-place. If you want a |List| or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
6136 |Dictionary| to remain unmodified make a copy first: >
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
6137 :let tlist = map(copy(mylist), ' v:val . "\t"')
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
6138
9416
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6139 < Returns {expr1}, the |List| or |Dictionary| that was filtered.
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6140 When an error is encountered while evaluating {expr2} no
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6141 further items in {expr1} are processed. When {expr2} is a
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6142 Funcref errors inside a function are ignored, unless it was
cbf052ccb120 commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents: 9407
diff changeset
6143 defined with the "abort" flag.
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
6144
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
6145
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6146 maparg({name} [, {mode} [, {abbr} [, {dict}]]]) *maparg()*
2610
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6147 When {dict} is omitted or zero: Return the rhs of mapping
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6148 {name} in mode {mode}. The returned String has special
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6149 characters translated like in the output of the ":map" command
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6150 listing.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6151
2610
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6152 When there is no mapping for {name}, an empty String is
14006
665fe1f419b0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14004
diff changeset
6153 returned. When the mapping for {name} is empty, then "<Nop>"
665fe1f419b0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14004
diff changeset
6154 is returned.
2610
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6155
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6156 The {name} can have special key names, like in the ":map"
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6157 command.
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6158
644
e4fa26ce8769 updated for version 7.0187
vimboss
parents: 634
diff changeset
6159 {mode} can be one of these strings:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6160 "n" Normal
2610
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6161 "v" Visual (including Select)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6162 "o" Operator-pending
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6163 "i" Insert
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6164 "c" Cmd-line
2610
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6165 "s" Select
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6166 "x" Visual
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6167 "l" langmap |language-mapping|
12499
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12465
diff changeset
6168 "t" Terminal-Job
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6169 "" Normal, Visual and Operator-pending
644
e4fa26ce8769 updated for version 7.0187
vimboss
parents: 634
diff changeset
6170 When {mode} is omitted, the modes for "" are used.
2610
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6171
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
6172 When {abbr} is there and it is |TRUE| use abbreviations
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
6173 instead of mappings.
2610
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6174
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
6175 When {dict} is there and it is |TRUE| return a dictionary
2610
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6176 containing all the information of the mapping with the
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6177 following items:
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6178 "lhs" The {lhs} of the mapping.
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6179 "rhs" The {rhs} of the mapping as typed.
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6180 "silent" 1 for a |:map-silent| mapping, else 0.
2625
0aa21d63aba0 Updated runtile files.
Bram Moolenaar <bram@vim.org>
parents: 2616
diff changeset
6181 "noremap" 1 if the {rhs} of the mapping is not remappable.
2610
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6182 "expr" 1 for an expression mapping (|:map-<expr>|).
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6183 "buffer" 1 for a buffer local mapping (|:map-local|).
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6184 "mode" Modes for which the mapping is defined. In
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6185 addition to the modes mentioned above, these
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6186 characters will be used:
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6187 " " Normal, Visual and Operator-pending
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6188 "!" Insert and Commandline mode
2642
840c3cadb842 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2625
diff changeset
6189 (|mapmode-ic|)
2625
0aa21d63aba0 Updated runtile files.
Bram Moolenaar <bram@vim.org>
parents: 2616
diff changeset
6190 "sid" The script local ID, used for <sid> mappings
0aa21d63aba0 Updated runtile files.
Bram Moolenaar <bram@vim.org>
parents: 2616
diff changeset
6191 (|<SID>|).
14700
0a3b9ecf7cb8 patch 8.1.0362: cannot get the script line number when executing a function
Christian Brabandt <cb@256bit.org>
parents: 14695
diff changeset
6192 "lnum" The line number in "sid", zero if unknown.
5555
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5466
diff changeset
6193 "nowait" Do not wait for other, longer mappings.
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5466
diff changeset
6194 (|:map-<nowait>|).
2610
6c05b5e5c1be updated for version 7.3.032
Bram Moolenaar <bram@vim.org>
parents: 2609
diff changeset
6195
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6196 The mappings local to the current buffer are checked first,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6197 then the global mappings.
626
732c7ae5743e updated for version 7.0180
vimboss
parents: 625
diff changeset
6198 This function can be used to map a key even when it's already
732c7ae5743e updated for version 7.0180
vimboss
parents: 625
diff changeset
6199 mapped, and have it do the original mapping too. Sketch: >
732c7ae5743e updated for version 7.0180
vimboss
parents: 625
diff changeset
6200 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n')
732c7ae5743e updated for version 7.0180
vimboss
parents: 625
diff changeset
6201
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6202
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6203 mapcheck({name} [, {mode} [, {abbr}]]) *mapcheck()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6204 Check if there is a mapping that matches with {name} in mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6205 {mode}. See |maparg()| for {mode} and special names in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6206 {name}.
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
6207 When {abbr} is there and it is |TRUE| use abbreviations
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
6208 instead of mappings.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6209 A match happens with a mapping that starts with {name} and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6210 with a mapping which is equal to the start of {name}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6211
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6212 matches mapping "a" "ab" "abc" ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6213 mapcheck("a") yes yes yes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6214 mapcheck("abc") yes yes yes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6215 mapcheck("ax") yes no no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6216 mapcheck("b") no no no
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6217
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6218 The difference with maparg() is that mapcheck() finds a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6219 mapping that matches with {name}, while maparg() only finds a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6220 mapping for {name} exactly.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6221 When there is no mapping that starts with {name}, an empty
14006
665fe1f419b0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14004
diff changeset
6222 String is returned. If there is one, the RHS of that mapping
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6223 is returned. If there are several mappings that start with
14006
665fe1f419b0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14004
diff changeset
6224 {name}, the RHS of one of them is returned. This will be
665fe1f419b0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14004
diff changeset
6225 "<Nop>" if the RHS is empty.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6226 The mappings local to the current buffer are checked first,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6227 then the global mappings.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6228 This function can be used to check if a mapping can be added
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6229 without being ambiguous. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6230 :if mapcheck("_vv") == ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6231 : map _vv :set guifont=7x13<CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6232 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6233 < This avoids adding the "_vv" mapping when there already is a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6234 mapping for "_v" or for "_vvv".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6235
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6236 match({expr}, {pat} [, {start} [, {count}]]) *match()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
6237 When {expr} is a |List| then this returns the index of the
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
6238 first item where {pat} matches. Each item is used as a
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
6239 String, |Lists| and |Dictionaries| are used as echoed.
14695
b178e2039b2d Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14673
diff changeset
6240
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
6241 Otherwise, {expr} is used as a String. The result is a
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
6242 Number, which gives the index (byte offset) in {expr} where
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
6243 {pat} matches.
14695
b178e2039b2d Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14673
diff changeset
6244
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
6245 A match at the first character or |List| item returns zero.
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
6246 If there is no match -1 is returned.
14695
b178e2039b2d Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14673
diff changeset
6247
2833
c869ff170ddc Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2826
diff changeset
6248 For getting submatches see |matchlist()|.
19
a81bc802c17c updated for version 7.0011
vimboss
parents: 18
diff changeset
6249 Example: >
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
6250 :echo match("testing", "ing") " results in 4
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
6251 :echo match([1, 'x'], '\a') " results in 1
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
6252 < See |string-match| for how {pat} is used.
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
6253 *strpbrk()*
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
6254 Vim doesn't have a strpbrk() function. But you can do: >
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
6255 :let sepidx = match(line, '[.,;: \t]')
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
6256 < *strcasestr()*
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
6257 Vim doesn't have a strcasestr() function. But you can add
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
6258 "\c" to the pattern to ignore case: >
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
6259 :let idx = match(haystack, '\cneedle')
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
6260 <
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
6261 If {start} is given, the search starts from byte index
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
6262 {start} in a String or item {start} in a |List|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6263 The result, however, is still the index counted from the
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
6264 first character/item. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6265 :echo match("testing", "ing", 2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6266 < result is again "4". >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6267 :echo match("testing", "ing", 4)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6268 < result is again "4". >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6269 :echo match("testing", "t", 2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6270 < result is "3".
694
07d199fe02ed updated for version 7.0209
vimboss
parents: 692
diff changeset
6271 For a String, if {start} > 0 then it is like the string starts
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
6272 {start} bytes later, thus "^" will match at {start}. Except
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
6273 when {count} is given, then it's like matches before the
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
6274 {start} byte are ignored (this is a bit complicated to keep it
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
6275 backwards compatible).
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
6276 For a String, if {start} < 0, it will be set to 0. For a list
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
6277 the index is counted from the end.
697
f08390485cd3 updated for version 7.0210
vimboss
parents: 694
diff changeset
6278 If {start} is out of range ({start} > strlen({expr}) for a
f08390485cd3 updated for version 7.0210
vimboss
parents: 694
diff changeset
6279 String or {start} > len({expr}) for a |List|) -1 is returned.
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
6280
694
07d199fe02ed updated for version 7.0209
vimboss
parents: 692
diff changeset
6281 When {count} is given use the {count}'th match. When a match
697
f08390485cd3 updated for version 7.0210
vimboss
parents: 694
diff changeset
6282 is found in a String the search for the next one starts one
694
07d199fe02ed updated for version 7.0209
vimboss
parents: 692
diff changeset
6283 character further. Thus this example results in 1: >
07d199fe02ed updated for version 7.0209
vimboss
parents: 692
diff changeset
6284 echo match("testing", "..", 0, 2)
07d199fe02ed updated for version 7.0209
vimboss
parents: 692
diff changeset
6285 < In a |List| the search continues in the next item.
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
6286 Note that when {count} is added the way {start} works changes,
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
6287 see above.
694
07d199fe02ed updated for version 7.0209
vimboss
parents: 692
diff changeset
6288
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6289 See |pattern| for the patterns that are accepted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6290 The 'ignorecase' option is used to set the ignore-caseness of
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
6291 the pattern. 'smartcase' is NOT used. The matching is always
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6292 done like 'magic' is set and 'cpoptions' is empty.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6293
14407
631344964949 patch 8.1.0218: cannot add matches to another window
Christian Brabandt <cb@256bit.org>
parents: 14347
diff changeset
6294 *matchadd()* *E798* *E799* *E801* *E957*
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6295 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6296 Defines a pattern to be highlighted in the current window (a
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6297 "match"). It will be highlighted with {group}. Returns an
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6298 identification number (ID), which can be used to delete the
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6299 match using |matchdelete()|.
5466
d060c429b21f Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5460
diff changeset
6300 Matching is case sensitive and magic, unless case sensitivity
d060c429b21f Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5460
diff changeset
6301 or magicness are explicitly overridden in {pattern}. The
d060c429b21f Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5460
diff changeset
6302 'magic', 'smartcase' and 'ignorecase' options are not used.
6951
b2673982c625 Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6947
diff changeset
6303 The "Conceal" value is special, it causes the match to be
b2673982c625 Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6947
diff changeset
6304 concealed.
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6305
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6306 The optional {priority} argument assigns a priority to the
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
6307 match. A match with a high priority will have its
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6308 highlighting overrule that of a match with a lower priority.
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6309 A priority is specified as an integer (negative numbers are no
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6310 exception). If the {priority} argument is not specified, the
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6311 default priority is 10. The priority of 'hlsearch' is zero,
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6312 hence all matches with a priority greater than zero will
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6313 overrule it. Syntax highlighting (see 'syntax') is a separate
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6314 mechanism, and regardless of the chosen priority a match will
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6315 always overrule syntax highlighting.
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6316
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6317 The optional {id} argument allows the request for a specific
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6318 match ID. If a specified ID is already taken, an error
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6319 message will appear and the match will not be added. An ID
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6320 is specified as a positive integer (zero excluded). IDs 1, 2
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6321 and 3 are reserved for |:match|, |:2match| and |:3match|,
6947
1efa7c2b9368 patch 7.4.792
Bram Moolenaar <bram@vim.org>
parents: 6935
diff changeset
6322 respectively. If the {id} argument is not specified or -1,
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6323 |matchadd()| automatically chooses a free ID.
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6324
7659
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7653
diff changeset
6325 The optional {dict} argument allows for further custom
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7653
diff changeset
6326 values. Currently this is used to specify a match specific
6947
1efa7c2b9368 patch 7.4.792
Bram Moolenaar <bram@vim.org>
parents: 6935
diff changeset
6327 conceal character that will be shown for |hl-Conceal|
1efa7c2b9368 patch 7.4.792
Bram Moolenaar <bram@vim.org>
parents: 6935
diff changeset
6328 highlighted matches. The dict can have the following members:
1efa7c2b9368 patch 7.4.792
Bram Moolenaar <bram@vim.org>
parents: 6935
diff changeset
6329
1efa7c2b9368 patch 7.4.792
Bram Moolenaar <bram@vim.org>
parents: 6935
diff changeset
6330 conceal Special character to show instead of the
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
6331 match (only for |hl-Conceal| highlighted
6947
1efa7c2b9368 patch 7.4.792
Bram Moolenaar <bram@vim.org>
parents: 6935
diff changeset
6332 matches, see |:syn-cchar|)
14407
631344964949 patch 8.1.0218: cannot add matches to another window
Christian Brabandt <cb@256bit.org>
parents: 14347
diff changeset
6333 window Instead of the current window use the
631344964949 patch 8.1.0218: cannot add matches to another window
Christian Brabandt <cb@256bit.org>
parents: 14347
diff changeset
6334 window with this number or window ID.
6947
1efa7c2b9368 patch 7.4.792
Bram Moolenaar <bram@vim.org>
parents: 6935
diff changeset
6335
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6336 The number of matches is not limited, as it is the case with
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6337 the |:match| commands.
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6338
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6339 Example: >
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6340 :highlight MyGroup ctermbg=green guibg=green
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6341 :let m = matchadd("MyGroup", "TODO")
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6342 < Deletion of the pattern: >
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6343 :call matchdelete(m)
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6344
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6345 < A list of matches defined by |matchadd()| and |:match| are
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
6346 available from |getmatches()|. All matches can be deleted in
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6347 one operation by |clearmatches()|.
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6348
9790
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
6349 *matchaddpos()*
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6350 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
5979
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6351 Same as |matchadd()|, but requires a list of positions {pos}
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6352 instead of a pattern. This command is faster than |matchadd()|
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6353 because it does not require to handle regular expressions and
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6354 sets buffer line boundaries to redraw screen. It is supposed
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6355 to be used when fast match additions and deletions are
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6356 required, for example to highlight matching parentheses.
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6357
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6358 The list {pos} can contain one of these items:
6007
ce284c205558 updated for version 7.4.344
Bram Moolenaar <bram@vim.org>
parents: 5995
diff changeset
6359 - A number. This whole line will be highlighted. The first
5979
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6360 line has number 1.
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6361 - A list with one number, e.g., [23]. The whole line with this
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6362 number will be highlighted.
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6363 - A list with two numbers, e.g., [23, 11]. The first number is
6007
ce284c205558 updated for version 7.4.344
Bram Moolenaar <bram@vim.org>
parents: 5995
diff changeset
6364 the line number, the second one is the column number (first
ce284c205558 updated for version 7.4.344
Bram Moolenaar <bram@vim.org>
parents: 5995
diff changeset
6365 column is 1, the value must correspond to the byte index as
ce284c205558 updated for version 7.4.344
Bram Moolenaar <bram@vim.org>
parents: 5995
diff changeset
6366 |col()| would return). The character at this position will
ce284c205558 updated for version 7.4.344
Bram Moolenaar <bram@vim.org>
parents: 5995
diff changeset
6367 be highlighted.
5979
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6368 - A list with three numbers, e.g., [23, 11, 3]. As above, but
6007
ce284c205558 updated for version 7.4.344
Bram Moolenaar <bram@vim.org>
parents: 5995
diff changeset
6369 the third number gives the length of the highlight in bytes.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6370
5979
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6371 The maximum number of positions is 8.
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6372
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6373 Example: >
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6374 :highlight MyGroup ctermbg=green guibg=green
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6375 :let m = matchaddpos("MyGroup", [[23, 24], 34])
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6376 < Deletion of the pattern: >
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6377 :call matchdelete(m)
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6378
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6379 < Matches added by |matchaddpos()| are returned by
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6380 |getmatches()| with an entry "pos1", "pos2", etc., with the
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6381 value a list like the {pos} item.
f9fa2e506b9f updated for version 7.4.330
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
6382
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6383 matcharg({nr}) *matcharg()*
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
6384 Selects the {nr} match item, as set with a |:match|,
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6385 |:2match| or |:3match| command.
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6386 Return a |List| with two elements:
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6387 The name of the highlight group used
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6388 The pattern used.
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6389 When {nr} is not 1, 2 or 3 returns an empty |List|.
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6390 When there is no match item set returns ['', ''].
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6391 This is useful to save and restore a |:match|.
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6392 Highlighting matches using the |:match| commands are limited
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6393 to three matches. |matchadd()| does not have this limitation.
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6394
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6395 matchdelete({id}) *matchdelete()* *E802* *E803*
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6396 Deletes a match with ID {id} previously defined by |matchadd()|
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6397 or one of the |:match| commands. Returns 0 if successful,
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6398 otherwise -1. See example for |matchadd()|. All matches can
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
6399 be deleted in one operation by |clearmatches()|.
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6400
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6401 matchend({expr}, {pat} [, {start} [, {count}]]) *matchend()*
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
6402 Same as |match()|, but return the index of first character
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
6403 after the match. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6404 :echo matchend("testing", "ing")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6405 < results in "7".
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
6406 *strspn()* *strcspn()*
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
6407 Vim doesn't have a strspn() or strcspn() function, but you can
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
6408 do it with matchend(): >
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
6409 :let span = matchend(line, '[a-zA-Z]')
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
6410 :let span = matchend(line, '[^a-zA-Z]')
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
6411 < Except that -1 is returned when there are no matches.
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
6412
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
6413 The {start}, if given, has the same meaning as for |match()|. >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6414 :echo matchend("testing", "ing", 2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6415 < results in "7". >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6416 :echo matchend("testing", "ing", 5)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6417 < result is "-1".
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
6418 When {expr} is a |List| the result is equal to |match()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6419
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6420 matchlist({expr}, {pat} [, {start} [, {count}]]) *matchlist()*
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
6421 Same as |match()|, but return a |List|. The first item in the
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
6422 list is the matched string, same as what matchstr() would
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
6423 return. Following items are submatches, like "\1", "\2", etc.
842
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
6424 in |:substitute|. When an optional submatch didn't match an
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
6425 empty string is used. Example: >
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
6426 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')
a209672376fd updated for version 7.0f
vimboss
parents: 841
diff changeset
6427 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
6428 When there is no match an empty list is returned.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
6429
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6430 matchstr({expr}, {pat} [, {start} [, {count}]]) *matchstr()*
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6431 Same as |match()|, but return the matched string. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6432 :echo matchstr("testing", "ing")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6433 < results in "ing".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6434 When there is no match "" is returned.
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
6435 The {start}, if given, has the same meaning as for |match()|. >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6436 :echo matchstr("testing", "ing", 2)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6437 < results in "ing". >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6438 :echo matchstr("testing", "ing", 5)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6439 < result is "".
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
6440 When {expr} is a |List| then the matching item is returned.
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
6441 The type isn't changed, it's not necessarily a String.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6442
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6443 matchstrpos({expr}, {pat} [, {start} [, {count}]]) *matchstrpos()*
8793
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6444 Same as |matchstr()|, but return the matched string, the start
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6445 position and the end position of the match. Example: >
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6446 :echo matchstrpos("testing", "ing")
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6447 < results in ["ing", 4, 7].
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6448 When there is no match ["", -1, -1] is returned.
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6449 The {start}, if given, has the same meaning as for |match()|. >
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6450 :echo matchstrpos("testing", "ing", 2)
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6451 < results in ["ing", 4, 7]. >
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6452 :echo matchstrpos("testing", "ing", 5)
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6453 < result is ["", -1, -1].
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6454 When {expr} is a |List| then the matching item, the index
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6455 of first item where {pat} matches, the start position and the
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6456 end position of the match are returned. >
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6457 :echo matchstrpos([1, '__x'], '\a')
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6458 < result is ["x", 1, 2, 3].
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6459 The type isn't changed, it's not necessarily a String.
dda254280bab commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents: 8749
diff changeset
6460
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
6461 *max()*
10734
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
6462 max({expr}) Return the maximum value of all items in {expr}.
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
6463 {expr} can be a list or a dictionary. For a dictionary,
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
6464 it returns the maximum of all values in the dictionary.
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
6465 If {expr} is neither a list nor a dictionary, or one of the
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
6466 items in {expr} cannot be used as a Number this results in
11561
7ad79766365a patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents: 11553
diff changeset
6467 an error. An empty |List| or |Dictionary| results in zero.
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
6468
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
6469 *min()*
10734
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
6470 min({expr}) Return the minimum value of all items in {expr}.
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
6471 {expr} can be a list or a dictionary. For a dictionary,
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
6472 it returns the minimum of all values in the dictionary.
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
6473 If {expr} is neither a list nor a dictionary, or one of the
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
6474 items in {expr} cannot be used as a Number this results in
11561
7ad79766365a patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents: 11553
diff changeset
6475 an error. An empty |List| or |Dictionary| results in zero.
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
6476
843
9f279ebda751 updated for version 7.0f01
vimboss
parents: 842
diff changeset
6477 *mkdir()* *E739*
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6478 mkdir({name} [, {path} [, {prot}]])
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6479 Create directory {name}.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6480 If {path} is "p" then intermediate directories are created as
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6481 necessary. Otherwise it must be "".
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6482 If {prot} is given it is used to set the protection bits of
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6483 the new directory. The default is 0755 (rwxr-xr-x: r/w for
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
6484 the user readable for others). Use 0700 to make it unreadable
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1700
diff changeset
6485 for others. This is only used for the last part of {name}.
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1700
diff changeset
6486 Thus if you create /tmp/foo/bar then /tmp/foo will be created
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1700
diff changeset
6487 with 0755.
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1700
diff changeset
6488 Example: >
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1700
diff changeset
6489 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700)
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1700
diff changeset
6490 < This function is not available in the |sandbox|.
13672
4a1efd1a6018 patch 8.0.1708: mkdir with 'p' flag fails on existing directory
Christian Brabandt <cb@256bit.org>
parents: 13626
diff changeset
6491 There is no error if the directory already exists and the "p"
4a1efd1a6018 patch 8.0.1708: mkdir with 'p' flag fails on existing directory
Christian Brabandt <cb@256bit.org>
parents: 13626
diff changeset
6492 flag is passed (since patch 8.0.1708).
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6493 Not available on all systems. To check use: >
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6494 :if exists("*mkdir")
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
6495 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6496 *mode()*
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6497 mode([expr]) Return a string that indicates the current mode.
1661
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
6498 If [expr] is supplied and it evaluates to a non-zero Number or
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
6499 a non-empty String (|non-zero-arg|), then the full mode is
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
6500 returned, otherwise only the first letter is returned.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6501
14422
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6502 n Normal, Terminal-Normal
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6503 no Operator-pending
15279
54457fc4af0b patch 8.1.0648: custom operators can't act upon a forced motion
Bram Moolenaar <Bram@vim.org>
parents: 15271
diff changeset
6504 nov Operator-pending (forced characterwise |o_v|)
54457fc4af0b patch 8.1.0648: custom operators can't act upon a forced motion
Bram Moolenaar <Bram@vim.org>
parents: 15271
diff changeset
6505 noV Operator-pending (forced linewise |o_V|)
54457fc4af0b patch 8.1.0648: custom operators can't act upon a forced motion
Bram Moolenaar <Bram@vim.org>
parents: 15271
diff changeset
6506 noCTRL-V Operator-pending (forced blockwise |o_CTRL-V|);
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
6507 CTRL-V is one character
14422
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6508 niI Normal using |i_CTRL-O| in |Insert-mode|
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6509 niR Normal using |i_CTRL-O| in |Replace-mode|
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6510 niV Normal using |i_CTRL-O| in |Virtual-Replace-mode|
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6511 v Visual by character
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6512 V Visual by line
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6513 CTRL-V Visual blockwise
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6514 s Select by character
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6515 S Select by line
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6516 CTRL-S Select blockwise
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6517 i Insert
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6518 ic Insert mode completion |compl-generic|
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6519 ix Insert mode |i_CTRL-X| completion
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6520 R Replace |R|
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6521 Rc Replace mode completion |compl-generic|
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6522 Rv Virtual Replace |gR|
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6523 Rx Replace mode |i_CTRL-X| completion
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6524 c Command-line editing
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6525 cv Vim Ex mode |gQ|
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6526 ce Normal Ex mode |Q|
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6527 r Hit-enter prompt
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6528 rm The -- more -- prompt
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6529 r? A |:confirm| query of some sort
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6530 ! Shell or external command is executing
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6531 t Terminal-Job mode: keys go to the job
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6532 This is useful in the 'statusline' option or when used
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6533 with |remote_expr()| In most other places it always returns
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6534 "c" or "n".
14422
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6535 Note that in the future more modes and more specific modes may
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6536 be added. It's better not to compare the whole string but only
06316dbd66bc patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents: 14421
diff changeset
6537 the leading character(s).
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6538 Also see |visualmode()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6539
2050
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6540 mzeval({expr}) *mzeval()*
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6541 Evaluate MzScheme expression {expr} and return its result
3492
3482d151136b Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3465
diff changeset
6542 converted to Vim data structures.
2050
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6543 Numbers and strings are returned as they are.
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6544 Pairs (including lists and improper lists) and vectors are
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6545 returned as Vim |Lists|.
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6546 Hash tables are represented as Vim |Dictionary| type with keys
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6547 converted to strings.
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6548 All other types are converted to string with display function.
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6549 Examples: >
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6550 :mz (define l (list 1 2 3))
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6551 :mz (define h (make-hash)) (hash-set! h "list" l)
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6552 :echo mzeval("l")
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6553 :echo mzeval("h")
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6554 <
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6555 {only available when compiled with the |+mzscheme| feature}
afcf9db31561 updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents: 2033
diff changeset
6556
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6557 nextnonblank({lnum}) *nextnonblank()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6558 Return the line number of the first line at or below {lnum}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6559 that is not blank. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6560 if getline(nextnonblank(1)) =~ "Java"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6561 < When {lnum} is invalid or there is no non-blank line at or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6562 below it, zero is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6563 See also |prevnonblank()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6564
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6565 nr2char({expr} [, {utf8}]) *nr2char()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6566 Return a string with a single character, which has the number
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6567 value {expr}. Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6568 nr2char(64) returns "@"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6569 nr2char(32) returns " "
4051
42edc5dac33c updated for version 7.3.780
Bram Moolenaar <bram@vim.org>
parents: 3996
diff changeset
6570 < When {utf8} is omitted or zero, the current 'encoding' is used.
42edc5dac33c updated for version 7.3.780
Bram Moolenaar <bram@vim.org>
parents: 3996
diff changeset
6571 Example for "utf-8": >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6572 nr2char(300) returns I with bow character
4051
42edc5dac33c updated for version 7.3.780
Bram Moolenaar <bram@vim.org>
parents: 3996
diff changeset
6573 < With {utf8} set to 1, always return utf-8 characters.
42edc5dac33c updated for version 7.3.780
Bram Moolenaar <bram@vim.org>
parents: 3996
diff changeset
6574 Note that a NUL character in the file is specified with
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6575 nr2char(10), because NULs are represented with newline
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6576 characters. nr2char(0) is a real NUL and terminates the
119
e8f07016e34d updated for version 7.0042
vimboss
parents: 114
diff changeset
6577 string, thus results in an empty string.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6578
3214
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
6579 or({expr}, {expr}) *or()*
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
6580 Bitwise OR on the two arguments. The arguments are converted
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
6581 to a number. A List, Dict or Float argument causes an error.
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
6582 Example: >
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
6583 :let bits = or(bits, 0x80)
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
6584
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
6585
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6586 pathshorten({expr}) *pathshorten()*
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6587 Shorten directory names in the path {expr} and return the
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6588 result. The tail, the file name, is kept as-is. The other
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6589 components in the path are reduced to single letters. Leading
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6590 '~' and '.' characters are kept. Example: >
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6591 :echo pathshorten('~/.vim/autoload/myfile.vim')
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6592 < ~/.v/a/myfile.vim ~
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6593 It doesn't matter if the path exists or not.
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
6594
7651
c7575b07de98 commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents: 7629
diff changeset
6595 perleval({expr}) *perleval()*
c7575b07de98 commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents: 7629
diff changeset
6596 Evaluate Perl expression {expr} in scalar context and return
c7575b07de98 commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents: 7629
diff changeset
6597 its result converted to Vim data structures. If value can't be
7659
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7653
diff changeset
6598 converted, it is returned as a string Perl representation.
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7653
diff changeset
6599 Note: If you want an array or hash, {expr} must return a
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7653
diff changeset
6600 reference to it.
7651
c7575b07de98 commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents: 7629
diff changeset
6601 Example: >
c7575b07de98 commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents: 7629
diff changeset
6602 :echo perleval('[1 .. 4]')
c7575b07de98 commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents: 7629
diff changeset
6603 < [1, 2, 3, 4]
c7575b07de98 commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents: 7629
diff changeset
6604 {only available when compiled with the |+perl| feature}
c7575b07de98 commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents: 7629
diff changeset
6605
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6606 pow({x}, {y}) *pow()*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6607 Return the power of {x} to the exponent {y} as a |Float|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6608 {x} and {y} must evaluate to a |Float| or a |Number|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6609 Examples: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6610 :echo pow(3, 3)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6611 < 27.0 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6612 :echo pow(2, 16)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6613 < 65536.0 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6614 :echo pow(32, 0.20)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6615 < 2.0
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6616 {only available when compiled with the |+float| feature}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6617
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
6618 prevnonblank({lnum}) *prevnonblank()*
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
6619 Return the line number of the first line at or above {lnum}
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
6620 that is not blank. Example: >
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
6621 let ind = indent(prevnonblank(v:lnum - 1))
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
6622 < When {lnum} is invalid or there is no non-blank line at or
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
6623 above it, zero is returned.
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
6624 Also see |nextnonblank()|.
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
6625
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
6626
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6627 printf({fmt}, {expr1} ...) *printf()*
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6628 Return a String with {fmt}, where "%" items are replaced by
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6629 the formatted form of their respective arguments. Example: >
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6630 printf("%4d: E%d %.30s", lnum, errno, msg)
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6631 < May result in:
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6632 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6633
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6634 Often used items are:
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
6635 %s string
3914
f15769bce0b8 updated for version 7.3.713
Bram Moolenaar <bram@vim.org>
parents: 3893
diff changeset
6636 %6S string right-aligned in 6 display cells
653
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
6637 %6s string right-aligned in 6 bytes
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6638 %.9s string truncated to 9 bytes
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6639 %c single byte
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6640 %d decimal number
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6641 %5d decimal number padded with spaces to 5 characters
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6642 %x hex number
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6643 %04x hex number padded with zeros to at least 4 characters
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6644 %X hex number using upper case letters
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6645 %o octal number
9894
b01afb4e8f66 commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
6646 %08b binary number padded with zeros to at least 8 chars
10038
7cf4e210cf3c commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents: 10027
diff changeset
6647 %f floating point number as 12.23, inf, -inf or nan
7cf4e210cf3c commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents: 10027
diff changeset
6648 %F floating point number as 12.23, INF, -INF or NAN
7cf4e210cf3c commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents: 10027
diff changeset
6649 %e floating point number as 1.23e3, inf, -inf or nan
7cf4e210cf3c commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents: 10027
diff changeset
6650 %E floating point number as 1.23E3, INF, -INF or NAN
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6651 %g floating point number, as %f or %e depending on value
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10787
diff changeset
6652 %G floating point number, as %F or %E depending on value
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6653 %% the % character itself
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6654
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6655 Conversion specifications start with '%' and end with the
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6656 conversion type. All other characters are copied unchanged to
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6657 the result.
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6658
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6659 The "%" starts a conversion specification. The following
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6660 arguments appear in sequence:
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6661
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6662 % [flags] [field-width] [.precision] type
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6663
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
6664 flags
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6665 Zero or more of the following flags:
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6666
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6667 # The value should be converted to an "alternate
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6668 form". For c, d, and s conversions, this option
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6669 has no effect. For o conversions, the precision
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6670 of the number is increased to force the first
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6671 character of the output string to a zero (except
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6672 if a zero value is printed with an explicit
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6673 precision of zero).
9894
b01afb4e8f66 commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
6674 For b and B conversions, a non-zero result has
b01afb4e8f66 commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
6675 the string "0b" (or "0B" for B conversions)
b01afb4e8f66 commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
6676 prepended to it.
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6677 For x and X conversions, a non-zero result has
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6678 the string "0x" (or "0X" for X conversions)
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6679 prepended to it.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6680
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6681 0 (zero) Zero padding. For all conversions the converted
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6682 value is padded on the left with zeros rather
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6683 than blanks. If a precision is given with a
9894
b01afb4e8f66 commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
6684 numeric conversion (d, b, B, o, x, and X), the 0
b01afb4e8f66 commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
6685 flag is ignored.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6686
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6687 - A negative field width flag; the converted value
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6688 is to be left adjusted on the field boundary.
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6689 The converted value is padded on the right with
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6690 blanks, rather than on the left with blanks or
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6691 zeros. A - overrides a 0 if both are given.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6692
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6693 ' ' (space) A blank should be left before a positive
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6694 number produced by a signed conversion (d).
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6695
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6696 + A sign must always be placed before a number
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
6697 produced by a signed conversion. A + overrides
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6698 a space if both are used.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6699
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6700 field-width
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6701 An optional decimal digit string specifying a minimum
653
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
6702 field width. If the converted value has fewer bytes
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
6703 than the field width, it will be padded with spaces on
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
6704 the left (or right, if the left-adjustment flag has
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
6705 been given) to fill out the field width.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6706
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6707 .precision
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6708 An optional precision, in the form of a period '.'
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6709 followed by an optional digit string. If the digit
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6710 string is omitted, the precision is taken as zero.
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6711 This gives the minimum number of digits to appear for
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6712 d, o, x, and X conversions, or the maximum number of
653
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
6713 bytes to be printed from a string for s conversions.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6714 For floating point it is the number of digits after
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6715 the decimal point.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6716
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6717 type
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6718 A character that specifies the type of conversion to
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6719 be applied, see below.
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6720
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6721 A field width or precision, or both, may be indicated by an
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6722 asterisk '*' instead of a digit string. In this case, a
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
6723 Number argument supplies the field width or precision. A
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6724 negative field width is treated as a left adjustment flag
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6725 followed by a positive field width; a negative precision is
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6726 treated as though it were missing. Example: >
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6727 :echo printf("%d: %.*s", nr, width, line)
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6728 < This limits the length of the text used from "line" to
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6729 "width" bytes.
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6730
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
6731 The conversion specifiers and their meanings are:
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6732
9894
b01afb4e8f66 commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
6733 *printf-d* *printf-b* *printf-B* *printf-o*
b01afb4e8f66 commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
6734 *printf-x* *printf-X*
b01afb4e8f66 commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
6735 dbBoxX The Number argument is converted to signed decimal
b01afb4e8f66 commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
6736 (d), unsigned binary (b and B), unsigned octal (o), or
b01afb4e8f66 commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
6737 unsigned hexadecimal (x and X) notation. The letters
b01afb4e8f66 commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
6738 "abcdef" are used for x conversions; the letters
b01afb4e8f66 commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents: 9887
diff changeset
6739 "ABCDEF" are used for X conversions.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6740 The precision, if any, gives the minimum number of
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6741 digits that must appear; if the converted value
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6742 requires fewer digits, it is padded on the left with
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6743 zeros.
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6744 In no case does a non-existent or small field width
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6745 cause truncation of a numeric field; if the result of
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6746 a conversion is wider than the field width, the field
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6747 is expanded to contain the conversion result.
10000
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
6748 The 'h' modifier indicates the argument is 16 bits.
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
6749 The 'l' modifier indicates the argument is 32 bits.
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
6750 The 'L' modifier indicates the argument is 64 bits.
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
6751 Generally, these modifiers are not useful. They are
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
6752 ignored when type is known from the argument.
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
6753
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
6754 i alias for d
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
6755 D alias for ld
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
6756 U alias for lu
233289599874 commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents: 9975
diff changeset
6757 O alias for lo
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6758
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6759 *printf-c*
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6760 c The Number argument is converted to a byte, and the
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6761 resulting character is written.
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6762
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6763 *printf-s*
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6764 s The text of the String argument is used. If a
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6765 precision is specified, no more bytes than the number
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6766 specified are used.
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
6767 If the argument is not a String type, it is
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
6768 automatically converted to text with the same format
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
6769 as ":echo".
6583
b0a227941705 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6549
diff changeset
6770 *printf-S*
3914
f15769bce0b8 updated for version 7.3.713
Bram Moolenaar <bram@vim.org>
parents: 3893
diff changeset
6771 S The text of the String argument is used. If a
f15769bce0b8 updated for version 7.3.713
Bram Moolenaar <bram@vim.org>
parents: 3893
diff changeset
6772 precision is specified, no more display cells than the
f15769bce0b8 updated for version 7.3.713
Bram Moolenaar <bram@vim.org>
parents: 3893
diff changeset
6773 number specified are used. Without the |+multi_byte|
f15769bce0b8 updated for version 7.3.713
Bram Moolenaar <bram@vim.org>
parents: 3893
diff changeset
6774 feature works just like 's'.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6775
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6776 *printf-f* *E807*
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
6777 f F The Float argument is converted into a string of the
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6778 form 123.456. The precision specifies the number of
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6779 digits after the decimal point. When the precision is
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6780 zero the decimal point is omitted. When the precision
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6781 is not specified 6 is used. A really big number
10038
7cf4e210cf3c commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents: 10027
diff changeset
6782 (out of range or dividing by zero) results in "inf"
11561
7ad79766365a patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents: 11553
diff changeset
6783 or "-inf" with %f (INF or -INF with %F).
7ad79766365a patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents: 11553
diff changeset
6784 "0.0 / 0.0" results in "nan" with %f (NAN with %F).
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6785 Example: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6786 echo printf("%.2f", 12.115)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6787 < 12.12
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6788 Note that roundoff depends on the system libraries.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6789 Use |round()| when in doubt.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6790
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6791 *printf-e* *printf-E*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6792 e E The Float argument is converted into a string of the
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6793 form 1.234e+03 or 1.234E+03 when using 'E'. The
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6794 precision specifies the number of digits after the
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6795 decimal point, like with 'f'.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6796
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6797 *printf-g* *printf-G*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6798 g G The Float argument is converted like with 'f' if the
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6799 value is between 0.001 (inclusive) and 10000000.0
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6800 (exclusive). Otherwise 'e' is used for 'g' and 'E'
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6801 for 'G'. When no precision is specified superfluous
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6802 zeroes and '+' signs are removed, except for the zero
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6803 immediately after the decimal point. Thus 10000000.0
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6804 results in 1.0e7.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6805
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
6806 *printf-%*
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6807 % A '%' is written. No argument is converted. The
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6808 complete conversion specification is "%%".
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6809
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
6810 When a Number argument is expected a String argument is also
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
6811 accepted and automatically converted.
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
6812 When a Float or String argument is expected a Number argument
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
6813 is also accepted and automatically converted.
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
6814 Any other argument type results in an error message.
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6815
459
d9d38102399f updated for version 7.0122
vimboss
parents: 452
diff changeset
6816 *E766* *E767*
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6817 The number of {exprN} arguments must exactly match the number
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6818 of "%" items. If there are not sufficient or too many
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
6819 arguments an error is given. Up to 18 arguments can be used.
449
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6820
3709cf52b9b5 updated for version 7.0119
vimboss
parents: 448
diff changeset
6821
14019
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6822 prompt_setcallback({buf}, {expr}) *prompt_setcallback()*
14103
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6823 Set prompt callback for buffer {buf} to {expr}. When {expr}
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6824 is an empty string the callback is removed. This has only
14019
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6825 effect if {buf} has 'buftype' set to "prompt".
14103
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6826
14019
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6827 The callback is invoked when pressing Enter. The current
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6828 buffer will always be the prompt buffer. A new line for a
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6829 prompt is added before invoking the callback, thus the prompt
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6830 for which the callback was invoked will be in the last but one
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6831 line.
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6832 If the callback wants to add text to the buffer, it must
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6833 insert it above the last line, since that is where the current
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6834 prompt is. This can also be done asynchronously.
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6835 The callback is invoked with one argument, which is the text
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6836 that was entered at the prompt. This can be an empty string
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6837 if the user only typed Enter.
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6838 Example: >
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6839 call prompt_setcallback(bufnr(''), function('s:TextEntered'))
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6840 func s:TextEntered(text)
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6841 if a:text == 'exit' || a:text == 'quit'
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6842 stopinsert
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6843 close
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6844 else
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6845 call append(line('$') - 1, 'Entered: "' . a:text . '"')
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6846 " Reset 'modified' to allow the buffer to be closed.
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6847 set nomodified
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6848 endif
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6849 endfunc
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
6850
14103
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6851 prompt_setinterrupt({buf}, {expr}) *prompt_setinterrupt()*
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6852 Set a callback for buffer {buf} to {expr}. When {expr} is an
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6853 empty string the callback is removed. This has only effect if
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6854 {buf} has 'buftype' set to "prompt".
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6855
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6856 This callback will be invoked when pressing CTRL-C in Insert
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6857 mode. Without setting a callback Vim will exit Insert mode,
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6858 as in any buffer.
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6859
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6860 prompt_setprompt({buf}, {text}) *prompt_setprompt()*
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6861 Set prompt for buffer {buf} to {text}. You most likely want
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6862 {text} to end in a space.
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6863 The result is only visible if {buf} has 'buftype' set to
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6864 "prompt". Example: >
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
6865 call prompt_setprompt(bufnr(''), 'command: ')
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6866 <
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6867 *prop_add()* *E965*
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6868 prop_add({lnum}, {col}, {props})
15335
18c20ceee4b5 patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents: 15334
diff changeset
6869 Attach a text property at position {lnum}, {col}. {col} is
18c20ceee4b5 patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents: 15334
diff changeset
6870 counted in bytes, use one for the first column.
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6871 If {lnum} is invalid an error is given. *E966*
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6872 If {col} is invalid an error is given. *E964*
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6873
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6874 {props} is a dictionary with these fields:
15335
18c20ceee4b5 patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents: 15334
diff changeset
6875 length length of text in bytes, can only be used
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6876 for a property that does not continue in
15335
18c20ceee4b5 patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents: 15334
diff changeset
6877 another line; can be zero
18c20ceee4b5 patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents: 15334
diff changeset
6878 end_lnum line number for the end of text
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
6879 end_col column just after the text; not used when
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
6880 "length" is present; when {col} and "end_col"
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
6881 are equal, and "end_lnum" is omitted or equal
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
6882 to {lnum}, this is a zero-width text property
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6883 bufnr buffer to add the property to; when omitted
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
6884 the current buffer is used
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6885 id user defined ID for the property; when omitted
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6886 zero is used
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6887 type name of the text property type
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6888 All fields except "type" are optional.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6889
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6890 It is an error when both "length" and "end_lnum" or "end_col"
15335
18c20ceee4b5 patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents: 15334
diff changeset
6891 are given. Either use "length" or "end_col" for a property
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6892 within one line, or use "end_lnum" and "end_col" for a
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6893 property that spans more than one line.
15335
18c20ceee4b5 patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents: 15334
diff changeset
6894 When neither "length" nor "end_col" are given the property
18c20ceee4b5 patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents: 15334
diff changeset
6895 will be zero-width. That means it will not be highlighted but
18c20ceee4b5 patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents: 15334
diff changeset
6896 will move with the text, as a kind of mark.
15251
17525ca95e1e patch 8.1.0634: text properties cannot cross line boundaries
Bram Moolenaar <Bram@vim.org>
parents: 15219
diff changeset
6897 The property can end exactly at the last character of the
17525ca95e1e patch 8.1.0634: text properties cannot cross line boundaries
Bram Moolenaar <Bram@vim.org>
parents: 15219
diff changeset
6898 text, or just after it. In the last case, if text is appended
17525ca95e1e patch 8.1.0634: text properties cannot cross line boundaries
Bram Moolenaar <Bram@vim.org>
parents: 15219
diff changeset
6899 to the line, the text property size will increase, also when
17525ca95e1e patch 8.1.0634: text properties cannot cross line boundaries
Bram Moolenaar <Bram@vim.org>
parents: 15219
diff changeset
6900 the property type does not have "end_incl" set.
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6901
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6902 "type" will first be looked up in the buffer the property is
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6903 added to. When not found, the global property types are used.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6904 If not found an error is given.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6905
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6906 See |text-properties| for information about text properties.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6907
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6908
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15138
diff changeset
6909 prop_clear({lnum} [, {lnum-end} [, {props}]]) *prop_clear()*
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6910 Remove all text properties from line {lnum}.
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15138
diff changeset
6911 When {lnum-end} is given, remove all text properties from line
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15138
diff changeset
6912 {lnum} to {lnum-end} (inclusive).
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6913
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6914 When {props} contains a "bufnr" item use this buffer,
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6915 otherwise use the current buffer.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6916
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6917 See |text-properties| for information about text properties.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6918
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6919 *prop_find()*
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6920 prop_find({props} [, {direction}])
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6921 NOT IMPLEMENTED YET
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6922 Search for a text property as specified with {props}:
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6923 id property with this ID
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6924 type property with this type name
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6925 bufnr buffer to search in; when present a
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6926 start position with "lnum" and "col"
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6927 must be given; when omitted the
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6928 current buffer is used
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
6929 lnum start in this line (when omitted start
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6930 at the cursor)
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6931 col start at this column (when omitted
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6932 and "lnum" is given: use column 1,
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6933 otherwise start at the cursor)
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6934 skipstart do not look for a match at the start
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6935 position
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6936
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6937 {direction} can be "f" for forward and "b" for backward. When
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6938 omitted forward search is performed.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6939
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6940 If a match is found then a Dict is returned with the entries
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6941 as with prop_list(), and additionally an "lnum" entry.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6942 If no match is found then an empty Dict is returned.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6943
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6944 See |text-properties| for information about text properties.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6945
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6946
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
6947 prop_list({lnum} [, {props}]) *prop_list()*
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6948 Return a List with all text properties in line {lnum}.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6949
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6950 When {props} contains a "bufnr" item, use this buffer instead
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6951 of the current buffer.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6952
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6953 The properties are ordered by starting column and priority.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6954 Each property is a Dict with these entries:
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6955 col starting column
15334
9d3d7b0f4861 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 15281
diff changeset
6956 length length in bytes, one more if line break is
9d3d7b0f4861 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 15281
diff changeset
6957 included
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6958 id property ID
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6959 type name of the property type, omitted if
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6960 the type was deleted
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6961 start when TRUE property starts in this line
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6962 end when TRUE property ends in this line
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6963
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6964 When "start" is zero the property started in a previous line,
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6965 the current one is a continuation.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6966 When "end" is zero the property continues in the next line.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6967 The line break after this line is included.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6968
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6969 See |text-properties| for information about text properties.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6970
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6971
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6972 *prop_remove()* *E968*
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6973 prop_remove({props} [, {lnum} [, {lnum-end}]])
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6974 Remove a matching text property from line {lnum}. When
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6975 {lnum-end} is given, remove matching text properties from line
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6976 {lnum} to {lnum-end} (inclusive).
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6977 When {lnum} is omitted remove matching text properties from
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6978 all lines.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6979
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6980 {props} is a dictionary with these fields:
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6981 id remove text properties with this ID
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6982 type remove text properties with this type name
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6983 bufnr use this buffer instead of the current one
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6984 all when TRUE remove all matching text properties,
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6985 not just the first one
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6986 A property matches when either "id" or "type" matches.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6987
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6988 Returns the number of properties that were removed.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6989
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6990 See |text-properties| for information about text properties.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6991
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6992
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6993 prop_type_add({name}, {props}) *prop_type_add()* *E969* *E970*
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6994 Add a text property type {name}. If a property type with this
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6995 name already exists an error is given.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
6996 {props} is a dictionary with these optional fields:
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6997 bufnr define the property only for this buffer; this
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6998 avoids name collisions and automatically
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
6999 clears the property types when the buffer is
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
7000 deleted.
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
7001 highlight name of highlight group to use
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
7002 priority when a character has multiple text
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
7003 properties the one with the highest priority
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
7004 will be used; negative values can be used, the
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
7005 default priority is zero
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
7006 start_incl when TRUE inserts at the start position will
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
7007 be included in the text property
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
7008 end_incl when TRUE inserts at the end position will be
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
7009 included in the text property
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7010
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7011 See |text-properties| for information about text properties.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7012
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7013
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7014 prop_type_change({name}, {props}) *prop_type_change()*
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7015 Change properties of an existing text property type. If a
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7016 property with this name does not exist an error is given.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7017 The {props} argument is just like |prop_type_add()|.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7018
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7019 See |text-properties| for information about text properties.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7020
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7021
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7022 prop_type_delete({name} [, {props}]) *prop_type_delete()*
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7023 Remove the text property type {name}. When text properties
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7024 using the type {name} are still in place, they will not have
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7025 an effect and can no longer be removed by name.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7026
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7027 {props} can contain a "bufnr" item. When it is given, delete
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7028 a property type from this buffer instead of from the global
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7029 property types.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7030
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7031 When text property type {name} is not found there is no error.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7032
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7033 See |text-properties| for information about text properties.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7034
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7035
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7036 prop_type_get([{name} [, {props}]) *prop_type_get()*
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7037 Returns the properties of property type {name}. This is a
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7038 dictionary with the same fields as was given to
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7039 prop_type_add().
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7040 When the property type {name} does not exist, an empty
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7041 dictionary is returned.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7042
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7043 {props} can contain a "bufnr" item. When it is given, use
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7044 this buffer instead of the global property types.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7045
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7046 See |text-properties| for information about text properties.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7047
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7048
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7049 prop_type_list([{props}]) *prop_type_list()*
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7050 Returns a list with all property type names.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7051
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7052 {props} can contain a "bufnr" item. When it is given, use
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7053 this buffer instead of the global property types.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7054
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
7055 See |text-properties| for information about text properties.
14103
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
7056
14019
dc67449d648c patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents: 14006
diff changeset
7057
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
7058 pumvisible() *pumvisible()*
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
7059 Returns non-zero when the popup menu is visible, zero
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
7060 otherwise. See |ins-completion-menu|.
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7061 This can be used to avoid some things that would remove the
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7062 popup menu.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7063
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7064 py3eval({expr}) *py3eval()*
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7065 Evaluate Python expression {expr} and return its result
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7066 converted to Vim data structures.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7067 Numbers and strings are returned as they are (strings are
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7068 copied though, Unicode strings are additionally converted to
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7069 'encoding').
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7070 Lists are represented as Vim |List| type.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7071 Dictionaries are represented as Vim |Dictionary| type with
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7072 keys converted to strings.
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7073 {only available when compiled with the |+python3| feature}
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7074
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7075 *E858* *E859*
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7076 pyeval({expr}) *pyeval()*
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7077 Evaluate Python expression {expr} and return its result
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7078 converted to Vim data structures.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7079 Numbers and strings are returned as they are (strings are
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7080 copied though).
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7081 Lists are represented as Vim |List| type.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7082 Dictionaries are represented as Vim |Dictionary| type,
3830
04592728474a Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3750
diff changeset
7083 non-string keys result in error.
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7084 {only available when compiled with the |+python| feature}
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
7085
10722
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
7086 pyxeval({expr}) *pyxeval()*
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
7087 Evaluate Python expression {expr} and return its result
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
7088 converted to Vim data structures.
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
7089 Uses Python 2 or 3, see |python_x| and 'pyxversion'.
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
7090 See also: |pyeval()|, |py3eval()|
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
7091 {only available when compiled with the |+python| or the
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
7092 |+python3| feature}
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
7093
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
7094 *E726* *E727*
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7095 range({expr} [, {max} [, {stride}]]) *range()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
7096 Returns a |List| with Numbers:
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7097 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7098 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7099 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7100 {max}] (increasing {expr} with {stride} each time, not
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7101 producing a value past {max}).
336
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
7102 When the maximum is one before the start the result is an
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
7103 empty list. When the maximum is more than one before the
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
7104 start this is an error.
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7105 Examples: >
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
7106 range(4) " [0, 1, 2, 3]
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7107 range(2, 4) " [2, 3, 4]
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7108 range(2, 9, 3) " [2, 5, 8]
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
7109 range(2, -2, -1) " [2, 1, 0, -1, -2]
336
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
7110 range(0) " []
2d8c2622e1fa updated for version 7.0087
vimboss
parents: 327
diff changeset
7111 range(2, 0) " error!
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7112 <
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
7113 *readfile()*
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7114 readfile({fname} [, {type} [, {max}]])
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
7115 Read file {fname} and return a |List|, each line of the file
10245
d76ccdacb41e commit https://github.com/vim/vim/commit/6100d02aab7c8294b581cb299250eea164b50e9d
Christian Brabandt <cb@256bit.org>
parents: 10244
diff changeset
7116 as an item. Lines are broken at NL characters. Macintosh
d76ccdacb41e commit https://github.com/vim/vim/commit/6100d02aab7c8294b581cb299250eea164b50e9d
Christian Brabandt <cb@256bit.org>
parents: 10244
diff changeset
7117 files separated with CR will result in a single long line
d76ccdacb41e commit https://github.com/vim/vim/commit/6100d02aab7c8294b581cb299250eea164b50e9d
Christian Brabandt <cb@256bit.org>
parents: 10244
diff changeset
7118 (unless a NL appears somewhere).
2513
a88237afdb20 Change readfile() to ignore byte order marks, unless in binary mode.
Bram Moolenaar <bram@vim.org>
parents: 2490
diff changeset
7119 All NUL characters are replaced with a NL character.
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7120 When {type} contains "b" binary mode is used:
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
7121 - When the last line ends in a NL an extra empty list item is
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
7122 added.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
7123 - No CR characters are removed.
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7124 When {type} contains "B" a |Blob| is returned with the binary
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7125 data of the file unmodified.
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
7126 Otherwise:
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
7127 - CR characters that appear before a NL are removed.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
7128 - Whether the last line ends in a NL or not does not matter.
2513
a88237afdb20 Change readfile() to ignore byte order marks, unless in binary mode.
Bram Moolenaar <bram@vim.org>
parents: 2490
diff changeset
7129 - When 'encoding' is Unicode any UTF-8 byte order mark is
a88237afdb20 Change readfile() to ignore byte order marks, unless in binary mode.
Bram Moolenaar <bram@vim.org>
parents: 2490
diff changeset
7130 removed from the text.
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
7131 When {max} is given this specifies the maximum number of lines
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
7132 to be read. Useful if you only want to check the first ten
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
7133 lines of a file: >
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
7134 :for line in readfile(fname, '', 10)
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
7135 : if line =~ 'Date' | echo line | endif
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
7136 :endfor
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
7137 < When {max} is negative -{max} lines from the end of the file
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
7138 are returned, or as many as there are.
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
7139 When {max} is zero the result is an empty list.
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
7140 Note that without {max} the whole file is read into memory.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
7141 Also note that there is no recognition of encoding. Read a
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
7142 file into a buffer if you need to.
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
7143 When the file can't be opened an error message is given and
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
7144 the result is an empty list.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
7145 Also see |writefile()|.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
7146
14004
e124262d435e patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents: 13967
diff changeset
7147 reg_executing() *reg_executing()*
e124262d435e patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents: 13967
diff changeset
7148 Returns the single letter name of the register being executed.
e124262d435e patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents: 13967
diff changeset
7149 Returns an empty string when no register is being executed.
e124262d435e patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents: 13967
diff changeset
7150 See |@|.
e124262d435e patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents: 13967
diff changeset
7151
e124262d435e patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents: 13967
diff changeset
7152 reg_recording() *reg_recording()*
e124262d435e patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents: 13967
diff changeset
7153 Returns the single letter name of the register being recorded.
e124262d435e patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents: 13967
diff changeset
7154 Returns an empty string string when not recording. See |q|.
e124262d435e patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents: 13967
diff changeset
7155
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7156 reltime([{start} [, {end}]]) *reltime()*
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7157 Return an item that represents a time value. The format of
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7158 the item depends on the system. It can be passed to
8876
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
7159 |reltimestr()| to convert it to a string or |reltimefloat()|
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
7160 to convert to a Float.
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7161 Without an argument it returns the current time.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7162 With one argument is returns the time passed since the time
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7163 specified in the argument.
843
9f279ebda751 updated for version 7.0f01
vimboss
parents: 842
diff changeset
7164 With two arguments it returns the time passed between {start}
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7165 and {end}.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7166 The {start} and {end} arguments must be values returned by
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7167 reltime().
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
7168 {only available when compiled with the |+reltime| feature}
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7169
8876
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
7170 reltimefloat({time}) *reltimefloat()*
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
7171 Return a Float that represents the time value of {time}.
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
7172 Example: >
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
7173 let start = reltime()
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
7174 call MyFunction()
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
7175 let seconds = reltimefloat(reltime(start))
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
7176 < See the note of reltimestr() about overhead.
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
7177 Also see |profiling|.
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
7178 {only available when compiled with the |+reltime| feature}
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
7179
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7180 reltimestr({time}) *reltimestr()*
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7181 Return a String that represents the time value of {time}.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7182 This is the number of seconds, a dot and the number of
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7183 microseconds. Example: >
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7184 let start = reltime()
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7185 call MyFunction()
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7186 echo reltimestr(reltime(start))
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7187 < Note that overhead for the commands will be added to the time.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7188 The accuracy depends on the system.
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
7189 Leading spaces are used to make the string align nicely. You
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
7190 can use split() to remove it. >
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
7191 echo split(reltimestr(reltime(start)))[0]
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
7192 < Also see |profiling|.
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
7193 {only available when compiled with the |+reltime| feature}
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
7194
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7195 *remote_expr()* *E449*
11211
71311d899b42 patch 8.0.0492: a failing client-server request can make Vim hang
Christian Brabandt <cb@256bit.org>
parents: 11181
diff changeset
7196 remote_expr({server}, {string} [, {idvar} [, {timeout}]])
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
7197 Send the {string} to {server}. The string is sent as an
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7198 expression and the result is returned after evaluation.
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7199 The result must be a String or a |List|. A |List| is turned
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7200 into a String by joining the items with a line break in
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7201 between (not at the end), like with join(expr, "\n").
11211
71311d899b42 patch 8.0.0492: a failing client-server request can make Vim hang
Christian Brabandt <cb@256bit.org>
parents: 11181
diff changeset
7202 If {idvar} is present and not empty, it is taken as the name
71311d899b42 patch 8.0.0492: a failing client-server request can make Vim hang
Christian Brabandt <cb@256bit.org>
parents: 11181
diff changeset
7203 of a variable and a {serverid} for later use with
13329
424321d6eea7 patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents: 13298
diff changeset
7204 |remote_read()| is stored there.
11211
71311d899b42 patch 8.0.0492: a failing client-server request can make Vim hang
Christian Brabandt <cb@256bit.org>
parents: 11181
diff changeset
7205 If {timeout} is given the read times out after this many
71311d899b42 patch 8.0.0492: a failing client-server request can make Vim hang
Christian Brabandt <cb@256bit.org>
parents: 11181
diff changeset
7206 seconds. Otherwise a timeout of 600 seconds is used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7207 See also |clientserver| |RemoteReply|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7208 This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7209 {only available when compiled with the |+clientserver| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7210 Note: Any errors will cause a local error message to be issued
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7211 and the result will be the empty string.
12756
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
7212
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
7213 Variables will be evaluated in the global namespace,
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7214 independent of a function currently being active. Except
12756
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
7215 when in debug mode, then local function variables and
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
7216 arguments can be evaluated.
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
7217
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7218 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7219 :echo remote_expr("gvim", "2+2")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7220 :echo remote_expr("gvim1", "b:current_syntax")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7221 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7222
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7223 remote_foreground({server}) *remote_foreground()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7224 Move the Vim server with the name {server} to the foreground.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7225 This works like: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7226 remote_expr({server}, "foreground()")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7227 < Except that on Win32 systems the client does the work, to work
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7228 around the problem that the OS doesn't always allow the server
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7229 to bring itself to the foreground.
574
25a70b1cd2da updated for version 7.0163
vimboss
parents: 557
diff changeset
7230 Note: This does not restore the window if it was minimized,
25a70b1cd2da updated for version 7.0163
vimboss
parents: 557
diff changeset
7231 like foreground() does.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7232 This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7233 {only in the Win32, Athena, Motif and GTK GUI versions and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7234 Win32 console version}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7235
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7236
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7237 remote_peek({serverid} [, {retvar}]) *remote_peek()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7238 Returns a positive number if there are available strings
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7239 from {serverid}. Copies any reply string into the variable
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
7240 {retvar} if specified. {retvar} must be a string with the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7241 name of a variable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7242 Returns zero if none are available.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7243 Returns -1 if something is wrong.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7244 See also |clientserver|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7245 This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7246 {only available when compiled with the |+clientserver| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7247 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7248 :let repl = ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7249 :echo "PEEK: ".remote_peek(id, "repl").": ".repl
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7250
11211
71311d899b42 patch 8.0.0492: a failing client-server request can make Vim hang
Christian Brabandt <cb@256bit.org>
parents: 11181
diff changeset
7251 remote_read({serverid}, [{timeout}]) *remote_read()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7252 Return the oldest available reply from {serverid} and consume
11211
71311d899b42 patch 8.0.0492: a failing client-server request can make Vim hang
Christian Brabandt <cb@256bit.org>
parents: 11181
diff changeset
7253 it. Unless a {timeout} in seconds is given, it blocks until a
71311d899b42 patch 8.0.0492: a failing client-server request can make Vim hang
Christian Brabandt <cb@256bit.org>
parents: 11181
diff changeset
7254 reply is available.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7255 See also |clientserver|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7256 This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7257 {only available when compiled with the |+clientserver| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7258 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7259 :echo remote_read(id)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7260 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7261 *remote_send()* *E241*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7262 remote_send({server}, {string} [, {idvar}])
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
7263 Send the {string} to {server}. The string is sent as input
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 20
diff changeset
7264 keys and the function returns immediately. At the Vim server
cc049b00ee70 updated for version 7.0014
vimboss
parents: 20
diff changeset
7265 the keys are not mapped |:map|.
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
7266 If {idvar} is present, it is taken as the name of a variable
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
7267 and a {serverid} for later use with remote_read() is stored
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
7268 there.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7269 See also |clientserver| |RemoteReply|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7270 This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7271 {only available when compiled with the |+clientserver| feature}
11177
76fb679a310e patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
7272
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7273 Note: Any errors will be reported in the server and may mess
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7274 up the display.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7275 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7276 :echo remote_send("gvim", ":DropAndReply ".file, "serverid").
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7277 \ remote_read(serverid)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7278
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7279 :autocmd NONE RemoteReply *
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7280 \ echo remote_read(expand("<amatch>"))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7281 :echo remote_send("gvim", ":sleep 10 | echo ".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7282 \ 'server2client(expand("<client>"), "HELLO")<CR>')
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
7283 <
11177
76fb679a310e patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
7284 *remote_startserver()* *E941* *E942*
76fb679a310e patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
7285 remote_startserver({name})
76fb679a310e patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
7286 Become the server {name}. This fails if already running as a
76fb679a310e patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
7287 server, when |v:servername| is not empty.
76fb679a310e patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
7288 {only available when compiled with the |+clientserver| feature}
76fb679a310e patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
7289
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
7290 remove({list}, {idx} [, {end}]) *remove()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
7291 Without {end}: Remove the item at {idx} from |List| {list} and
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
7292 return the item.
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
7293 With {end}: Remove items from {idx} to {end} (inclusive) and
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
7294 return a List with these items. When {idx} points to the same
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
7295 item as {end} a list with one item is returned. When {end}
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
7296 points to an item before {idx} this is an error.
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
7297 See |list-index| for possible values of {idx} and {end}.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
7298 Example: >
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
7299 :echo "last item: " . remove(mylist, -1)
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
7300 :call remove(mylist, 0, 9)
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7301 remove({blob}, {idx} [, {end}])
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7302 Without {end}: Remove the byte at {idx} from |Blob| {blob} and
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7303 return the byte.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7304 With {end}: Remove bytes from {idx} to {end} (inclusive) and
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7305 return a |Blob| with these bytes. When {idx} points to the same
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7306 byte as {end} a |Blob| with one byte is returned. When {end}
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7307 points to a byte before {idx} this is an error.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7308 Example: >
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7309 :echo "last byte: " . remove(myblob, -1)
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7310 :call remove(mylist, 0, 9)
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7311 remove({dict}, {key})
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7312 Remove the entry from {dict} with key {key}. Example: >
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7313 :echo "removed " . remove(dict, "one")
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7314 < If there is no {key} in {dict} this is an error.
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7315
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7316 Use |delete()| to remove a file.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
7317
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7318 rename({from}, {to}) *rename()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7319 Rename the file by the name {from} to the name {to}. This
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7320 should also work to move files across file systems. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7321 result is a Number, which is 0 if the file was renamed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7322 successfully, and non-zero when the renaming failed.
1851
e7f6ca5594cf updated for version 7.2-149
vimboss
parents: 1768
diff changeset
7323 NOTE: If {to} exists it is overwritten without warning.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7324 This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7325
18
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
7326 repeat({expr}, {count}) *repeat()*
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
7327 Repeat {expr} {count} times and return the concatenated
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
7328 result. Example: >
843
9f279ebda751 updated for version 7.0f01
vimboss
parents: 842
diff changeset
7329 :let separator = repeat('-', 80)
18
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
7330 < When {count} is zero or negative the result is empty.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
7331 When {expr} is a |List| the result is {expr} concatenated
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
7332 {count} times. Example: >
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
7333 :let longlist = repeat(['a', 'b'], 3)
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
7334 < Results in ['a', 'b', 'a', 'b', 'a', 'b'].
18
293621502c4d updated for version 7.0010
vimboss
parents: 15
diff changeset
7335
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
7336
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7337 resolve({filename}) *resolve()* *E655*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7338 On MS-Windows, when {filename} is a shortcut (a .lnk file),
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7339 returns the path the shortcut points to in a simplified form.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7340 On Unix, repeat resolving symbolic links in all path
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7341 components of {filename} and return the simplified result.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7342 To cope with link cycles, resolving of symbolic links is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7343 stopped after 100 iterations.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7344 On other systems, return the simplified {filename}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7345 The simplification step is done as by |simplify()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7346 resolve() keeps a leading path component specifying the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7347 current directory (provided the result is still a relative
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7348 path name) and also keeps a trailing path separator.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7349
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
7350 *reverse()*
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7351 reverse({object})
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7352 Reverse the order of items in {object} in-place.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7353 {object} can be a |List| or a |Blob|.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7354 Returns {object}.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
7355 If you want an object to remain unmodified make a copy first: >
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
7356 :let revlist = reverse(copy(mylist))
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
7357
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7358 round({expr}) *round()*
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
7359 Round off {expr} to the nearest integral value and return it
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7360 as a |Float|. If {expr} lies halfway between two integral
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7361 values, then use the larger one (away from zero).
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7362 {expr} must evaluate to a |Float| or a |Number|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7363 Examples: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7364 echo round(0.456)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7365 < 0.0 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7366 echo round(4.5)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7367 < 5.0 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7368 echo round(-4.5)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7369 < -5.0
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7370 {only available when compiled with the |+float| feature}
3996
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7371
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7372 screenattr({row}, {col}) *screenattr()*
10027
018fead968c1 commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents: 10004
diff changeset
7373 Like |screenchar()|, but return the attribute. This is a rather
4835
4db0bf9f1b44 updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents: 4502
diff changeset
7374 arbitrary number that can only be used to compare to the
4db0bf9f1b44 updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents: 4502
diff changeset
7375 attribute at other positions.
4db0bf9f1b44 updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents: 4502
diff changeset
7376
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7377 screenchar({row}, {col}) *screenchar()*
4835
4db0bf9f1b44 updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents: 4502
diff changeset
7378 The result is a Number, which is the character at position
4db0bf9f1b44 updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents: 4502
diff changeset
7379 [row, col] on the screen. This works for every possible
4db0bf9f1b44 updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents: 4502
diff changeset
7380 screen position, also status lines, window separators and the
4db0bf9f1b44 updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents: 4502
diff changeset
7381 command line. The top left position is row one, column one
4db0bf9f1b44 updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents: 4502
diff changeset
7382 The character excludes composing characters. For double-byte
4db0bf9f1b44 updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents: 4502
diff changeset
7383 encodings it may only be the first byte.
4db0bf9f1b44 updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents: 4502
diff changeset
7384 This is mainly to be used for testing.
4db0bf9f1b44 updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents: 4502
diff changeset
7385 Returns -1 when row or col is out of range.
4db0bf9f1b44 updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents: 4502
diff changeset
7386
3996
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7387 screencol() *screencol()*
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7388 The result is a Number, which is the current screen column of
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7389 the cursor. The leftmost column has number 1.
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7390 This function is mainly used for testing.
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7391
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7392 Note: Always returns the current screen column, thus if used
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7393 in a command (e.g. ":echo screencol()") it will return the
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7394 column inside the command line, which is 1 when the command is
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7395 executed. To get the cursor position in the file use one of
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7396 the following mappings: >
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7397 nnoremap <expr> GG ":echom ".screencol()."\n"
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7398 nnoremap <silent> GG :echom screencol()<CR>
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7399 <
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7400 screenrow() *screenrow()*
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7401 The result is a Number, which is the current screen row of the
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7402 cursor. The top line has number one.
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7403 This function is mainly used for testing.
9723
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
7404 Alternatively you can use |winline()|.
3996
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7405
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7406 Note: Same restrictions as with |screencol()|.
b3f3237a3d72 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3986
diff changeset
7407
1496
29c09fa57168 updated for version 7.1-211
vimboss
parents: 1490
diff changeset
7408 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7409 Search for regexp pattern {pattern}. The search starts at the
119
e8f07016e34d updated for version 7.0042
vimboss
parents: 114
diff changeset
7410 cursor position (you can use |cursor()| to set it).
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7411
3967
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3920
diff changeset
7412 When a match has been found its line number is returned.
3312
b7811ab264bf updated for version 7.3.423
Bram Moolenaar <bram@vim.org>
parents: 3256
diff changeset
7413 If there is no match a 0 is returned and the cursor doesn't
b7811ab264bf updated for version 7.3.423
Bram Moolenaar <bram@vim.org>
parents: 3256
diff changeset
7414 move. No error message is given.
b7811ab264bf updated for version 7.3.423
Bram Moolenaar <bram@vim.org>
parents: 3256
diff changeset
7415
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7416 {flags} is a String, which can contain these character flags:
7358
6fbeef3b65e6 commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents: 7315
diff changeset
7417 'b' search Backward instead of forward
6fbeef3b65e6 commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents: 7315
diff changeset
7418 'c' accept a match at the Cursor position
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7419 'e' move to the End of the match
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
7420 'n' do Not move the cursor
7358
6fbeef3b65e6 commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents: 7315
diff changeset
7421 'p' return number of matching sub-Pattern (see below)
6fbeef3b65e6 commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents: 7315
diff changeset
7422 's' Set the ' mark at the previous location of the cursor
6fbeef3b65e6 commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents: 7315
diff changeset
7423 'w' Wrap around the end of the file
6fbeef3b65e6 commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents: 7315
diff changeset
7424 'W' don't Wrap around the end of the file
6fbeef3b65e6 commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents: 7315
diff changeset
7425 'z' start searching at the cursor column instead of zero
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7426 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7427
444
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
7428 If the 's' flag is supplied, the ' mark is set, only if the
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
7429 cursor is moved. The 's' flag cannot be combined with the 'n'
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
7430 flag.
d0d15b184c56 updated for version 7.0116
vimboss
parents: 438
diff changeset
7431
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
7432 'ignorecase', 'smartcase' and 'magic' are used.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7433
7659
07f11de5efca commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents: 7653
diff changeset
7434 When the 'z' flag is not given, searching always starts in
7358
6fbeef3b65e6 commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents: 7315
diff changeset
7435 column zero and then matches before the cursor are skipped.
6fbeef3b65e6 commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents: 7315
diff changeset
7436 When the 'c' flag is present in 'cpo' the next search starts
6fbeef3b65e6 commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents: 7315
diff changeset
7437 after the match. Without the 'c' flag the next search starts
6fbeef3b65e6 commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents: 7315
diff changeset
7438 one column further.
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
7439
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
7440 When the {stopline} argument is given then the search stops
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
7441 after searching this line. This is useful to restrict the
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
7442 search to a range of lines. Examples: >
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
7443 let match = search('(', 'b', line("w0"))
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
7444 let end = search('END', '', line("w$"))
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
7445 < When {stopline} is used and it is not zero this also implies
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
7446 that the search does not wrap around the end of the file.
1496
29c09fa57168 updated for version 7.1-211
vimboss
parents: 1490
diff changeset
7447 A zero value is equal to not giving the argument.
29c09fa57168 updated for version 7.1-211
vimboss
parents: 1490
diff changeset
7448
29c09fa57168 updated for version 7.1-211
vimboss
parents: 1490
diff changeset
7449 When the {timeout} argument is given the search stops when
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
7450 more than this many milliseconds have passed. Thus when
1496
29c09fa57168 updated for version 7.1-211
vimboss
parents: 1490
diff changeset
7451 {timeout} is 500 the search stops after half a second.
29c09fa57168 updated for version 7.1-211
vimboss
parents: 1490
diff changeset
7452 The value must not be negative. A zero value is like not
29c09fa57168 updated for version 7.1-211
vimboss
parents: 1490
diff changeset
7453 giving the argument.
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
7454 {only available when compiled with the |+reltime| feature}
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
7455
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7456 *search()-sub-match*
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7457 With the 'p' flag the returned value is one more than the
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7458 first sub-match in \(\). One if none of them matched but the
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7459 whole pattern did match.
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7460 To get the column number too use |searchpos()|.
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7461
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
7462 The cursor will be positioned at the match, unless the 'n'
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7463 flag is used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7464
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7465 Example (goes over all files in the argument list): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7466 :let n = 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7467 :while n <= argc() " loop over all files in arglist
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7468 : exe "argument " . n
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7469 : " start at the last char in the file and wrap for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7470 : " first search to find match at start of file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7471 : normal G$
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7472 : let flags = "w"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7473 : while search("foo", flags) > 0
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7474 : s/foo/bar/g
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7475 : let flags = "W"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7476 : endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7477 : update " write the file if modified
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7478 : let n = n + 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7479 :endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7480 <
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7481 Example for using some flags: >
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7482 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7483 < This will search for the keywords "if", "else", and "endif"
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7484 under or after the cursor. Because of the 'p' flag, it
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7485 returns 1, 2, or 3 depending on which keyword is found, or 0
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7486 if the search fails. With the cursor on the first word of the
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7487 line:
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7488 if (foo == 0) | let foo = foo + 1 | endif ~
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7489 the function returns 1. Without the 'c' flag, the function
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7490 finds the "endif" and returns 3. The same thing happens
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7491 without the 'e' flag if the cursor is on the "f" of "if".
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7492 The 'n' flag tells the function not to move the cursor.
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7493
504
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
7494
523
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
7495 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()*
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
7496 Search for the declaration of {name}.
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
7497
523
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
7498 With a non-zero {global} argument it works like |gD|, find
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
7499 first match in the file. Otherwise it works like |gd|, find
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
7500 first match in the function.
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
7501
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
7502 With a non-zero {thisblock} argument matches in a {} block
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
7503 that ends before the cursor position are ignored. Avoids
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
7504 finding variable declarations only valid in another scope.
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 519
diff changeset
7505
504
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
7506 Moves the cursor to the found match.
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
7507 Returns zero for success, non-zero for failure.
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
7508 Example: >
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
7509 if searchdecl('myvar') == 0
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
7510 echo getline('.')
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
7511 endif
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
7512 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7513 *searchpair()*
1496
29c09fa57168 updated for version 7.1-211
vimboss
parents: 1490
diff changeset
7514 searchpair({start}, {middle}, {end} [, {flags} [, {skip}
29c09fa57168 updated for version 7.1-211
vimboss
parents: 1490
diff changeset
7515 [, {stopline} [, {timeout}]]]])
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7516 Search for the match of a nested start-end pair. This can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7517 used to find the "endif" that matches an "if", while other
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7518 if/endif pairs in between are ignored.
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7519 The search starts at the cursor. The default is to search
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7520 forward, include 'b' in {flags} to search backward.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7521 If a match is found, the cursor is positioned at it and the
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7522 line number is returned. If no match is found 0 or -1 is
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7523 returned and the cursor doesn't move. No error message is
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
7524 given.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7525
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7526 {start}, {middle} and {end} are patterns, see |pattern|. They
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7527 must not contain \( \) pairs. Use of \%( \) is allowed. When
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7528 {middle} is not empty, it is found when searching from either
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7529 direction, but only when not in a nested start-end pair. A
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7530 typical use is: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7531 searchpair('\<if\>', '\<else\>', '\<endif\>')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7532 < By leaving {middle} empty the "else" is skipped.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7533
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7534 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7535 |search()|. Additionally:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7536 'r' Repeat until no more matches found; will find the
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7537 outer pair. Implies the 'W' flag.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7538 'm' Return number of matches instead of line number with
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
7539 the match; will be > 1 when 'r' is used.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7540 Note: it's nearly always a good idea to use the 'W' flag, to
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7541 avoid wrapping around the end of the file.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7542
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7543 When a match for {start}, {middle} or {end} is found, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7544 {skip} expression is evaluated with the cursor positioned on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7545 the start of the match. It should return non-zero if this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7546 match is to be skipped. E.g., because it is inside a comment
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7547 or a string.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7548 When {skip} is omitted or empty, every match is accepted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7549 When evaluating {skip} causes an error the search is aborted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7550 and -1 returned.
12722
7749260f261c patch 8.0.1239: cannot use a lambda for the skip argument to searchpair()
Christian Brabandt <cb@256bit.org>
parents: 12716
diff changeset
7551 {skip} can be a string, a lambda, a funcref or a partial.
14193
c460506890ba Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14161
diff changeset
7552 Anything else makes the function fail.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7553
1496
29c09fa57168 updated for version 7.1-211
vimboss
parents: 1490
diff changeset
7554 For {stopline} and {timeout} see |search()|.
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
7555
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7556 The value of 'ignorecase' is used. 'magic' is ignored, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7557 patterns are used like it's on.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7558
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7559 The search starts exactly at the cursor. A match with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7560 {start}, {middle} or {end} at the next character, in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7561 direction of searching, is the first one found. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7562 if 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7563 if 2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7564 endif 2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7565 endif 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7566 < When starting at the "if 2", with the cursor on the "i", and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7567 searching forwards, the "endif 2" is found. When starting on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7568 the character just before the "if 2", the "endif 1" will be
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
7569 found. That's because the "if 2" will be found first, and
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7570 then this is considered to be a nested if/endif from "if 2" to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7571 "endif 2".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7572 When searching backwards and {end} is more than one character,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7573 it may be useful to put "\zs" at the end of the pattern, so
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7574 that when the cursor is inside a match with the end it finds
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7575 the matching start.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7576
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7577 Example, to find the "endif" command in a Vim script: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7578
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7579 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7580 \ 'getline(".") =~ "^\\s*\""')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7581
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7582 < The cursor must be at or after the "if" for which a match is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7583 to be found. Note that single-quote strings are used to avoid
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7584 having to double the backslashes. The skip expression only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7585 catches comments at the start of a line, not after a command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7586 Also, a word "en" or "if" halfway a line is considered a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7587 match.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7588 Another example, to search for the matching "{" of a "}": >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7589
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7590 :echo searchpair('{', '', '}', 'bW')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7591
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7592 < This works when the cursor is at or before the "}" for which a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7593 match is to be found. To reject matches that syntax
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7594 highlighting recognized as strings: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7595
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7596 :echo searchpair('{', '', '}', 'bW',
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7597 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7598 <
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
7599 *searchpairpos()*
1496
29c09fa57168 updated for version 7.1-211
vimboss
parents: 1490
diff changeset
7600 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip}
29c09fa57168 updated for version 7.1-211
vimboss
parents: 1490
diff changeset
7601 [, {stopline} [, {timeout}]]]])
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
7602 Same as |searchpair()|, but returns a |List| with the line and
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
7603 column position of the match. The first element of the |List|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
7604 is the line number and the second element is the byte index of
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
7605 the column position of the match. If no match is found,
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
7606 returns [0, 0]. >
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
7607
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
7608 :let [lnum,col] = searchpairpos('{', '', '}', 'n')
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
7609 <
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
7610 See |match-parens| for a bigger and more useful example.
9090f866cd57 updated for version 7.0197
vimboss
parents: 665
diff changeset
7611
1496
29c09fa57168 updated for version 7.1-211
vimboss
parents: 1490
diff changeset
7612 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()*
692
a28f83d37113 updated for version 7.0208
vimboss
parents: 688
diff changeset
7613 Same as |search()|, but returns a |List| with the line and
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
7614 column position of the match. The first element of the |List|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
7615 is the line number and the second element is the byte index of
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
7616 the column position of the match. If no match is found,
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
7617 returns [0, 0].
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7618 Example: >
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7619 :let [lnum, col] = searchpos('mypattern', 'n')
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7620
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7621 < When the 'p' flag is given then there is an extra item with
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7622 the sub-pattern match number |search()-sub-match|. Example: >
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7623 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7624 < In this example "submatch" is 2 when a lowercase letter is
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7625 found |/\l|, 3 when an uppercase letter is found |/\u|.
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 712
diff changeset
7626
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
7627 server2client({clientid}, {string}) *server2client()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7628 Send a reply string to {clientid}. The most recent {clientid}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7629 that sent a string can be retrieved with expand("<client>").
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7630 {only available when compiled with the |+clientserver| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7631 Note:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7632 This id has to be stored before the next command can be
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
7633 received. I.e. before returning from the received command and
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7634 before calling any commands that waits for input.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7635 See also |clientserver|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7636 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7637 :echo server2client(expand("<client>"), "HELLO")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7638 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7639 serverlist() *serverlist()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7640 Return a list of available server names, one per line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7641 When there are no servers or the information is not available
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7642 an empty string is returned. See also |clientserver|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7643 {only available when compiled with the |+clientserver| feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7644 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7645 :echo serverlist()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7646 <
12319
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7647 setbufline({expr}, {lnum}, {text}) *setbufline()*
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7648 Set line {lnum} to {text} in buffer {expr}. To insert
15378
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
7649 lines use |append()|. Any text properties in {lnum} are
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
7650 cleared.
12319
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7651
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7652 For the use of {expr}, see |bufname()| above.
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7653
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7654 {lnum} is used like with |setline()|.
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7655 This works like |setline()| for the specified buffer.
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7656 On success 0 is returned, on failure 1 is returned.
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7657
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7658 If {expr} is not a valid buffer or {lnum} is not valid, an
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7659 error message is given.
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7660
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7661 setbufvar({expr}, {varname}, {val}) *setbufvar()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7662 Set option or local variable {varname} in buffer {expr} to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7663 {val}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7664 This also works for a global or local window option, but it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7665 doesn't work for a global or local window variable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7666 For a local window option the global value is unchanged.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7667 For the use of {expr}, see |bufname()| above.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7668 Note that the variable name without "b:" must be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7669 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7670 :call setbufvar(1, "&mod", 1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7671 :call setbufvar("todo", "myvar", "foobar")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7672 < This function is not available in the |sandbox|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7673
7100
f717d96a39b3 commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents: 7013
diff changeset
7674 setcharsearch({dict}) *setcharsearch()*
6991
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7675 Set the current character search information to {dict},
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7676 which contains one or more of the following entries:
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7677
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7678 char character which will be used for a subsequent
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7679 |,| or |;| command; an empty string clears the
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7680 character search
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7681 forward direction of character search; 1 for forward,
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7682 0 for backward
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7683 until type of character search; 1 for a |t| or |T|
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7684 character search, 0 for an |f| or |F|
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7685 character search
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7686
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7687 This can be useful to save/restore a user's character search
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7688 from a script: >
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7689 :let prevsearch = getcharsearch()
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7690 :" Perform a command which clobbers user's search
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7691 :call setcharsearch(prevsearch)
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7692 < Also see |getcharsearch()|.
814f1f569e4a patch 7.4.813
Bram Moolenaar <bram@vim.org>
parents: 6951
diff changeset
7693
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7694 setcmdpos({pos}) *setcmdpos()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7695 Set the cursor position in the command line to byte position
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
7696 {pos}. The first position is 1.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7697 Use |getcmdpos()| to obtain the current position.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7698 Only works while editing the command line, thus you must use
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7699 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7700 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7701 set after the command line is set to the expression. For
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7702 |c_CTRL-R_=| it is set after evaluating the expression but
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
7703 before inserting the resulting text.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7704 When the number is too big the cursor is put at the end of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7705 line. A number smaller than one has undefined results.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7706 Returns 0 when successful, 1 when not editing the command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7707 line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7708
8451
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7709 setfperm({fname}, {mode}) *setfperm()* *chmod*
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7710 Set the file permissions for {fname} to {mode}.
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7711 {mode} must be a string with 9 characters. It is of the form
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7712 "rwxrwxrwx", where each group of "rwx" flags represent, in
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7713 turn, the permissions of the owner of the file, the group the
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7714 file belongs to, and other users. A '-' character means the
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7715 permission is off, any other character means on. Multi-byte
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7716 characters are not supported.
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7717
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7718 For example "rw-r-----" means read-write for the user,
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7719 readable by the group, not accessible by others. "xx-x-----"
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7720 would do the same thing.
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7721
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7722 Returns non-zero for success, zero for failure.
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7723
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7724 To read permissions see |getfperm()|.
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7725
c0b5c2b0a5ee commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents: 8440
diff changeset
7726
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7727 setline({lnum}, {text}) *setline()*
3312
b7811ab264bf updated for version 7.3.423
Bram Moolenaar <bram@vim.org>
parents: 3256
diff changeset
7728 Set line {lnum} of the current buffer to {text}. To insert
12319
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7729 lines use |append()|. To set lines in another buffer use
15378
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
7730 |setbufline()|. Any text properties in {lnum} are cleared.
12319
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7731
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
7732 {lnum} is used like with |getline()|.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7733 When {lnum} is just below the last line the {text} will be
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
7734 added as a new line.
12319
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7735
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
7736 If this succeeds, 0 is returned. If this fails (most likely
12319
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7737 because {lnum} is invalid) 1 is returned.
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7738
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7739 Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7740 :call setline(5, strftime("%c"))
12319
c7e95667d14b patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents: 12317
diff changeset
7741
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7742 < When {text} is a |List| then line {lnum} and following lines
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
7743 will be set to the items in the list. Example: >
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
7744 :call setline(5, ['aaa', 'bbb', 'ccc'])
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
7745 < This is equivalent to: >
3465
161d01cbb165 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3456
diff changeset
7746 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']]
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
7747 : call setline(n, l)
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
7748 :endfor
12427
fc3e2d5614dd patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents: 12389
diff changeset
7749
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7750 < Note: The '[ and '] marks are not set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7751
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7752 setloclist({nr}, {list} [, {action} [, {what}]]) *setloclist()*
647
19106f131c87 updated for version 7.0188
vimboss
parents: 644
diff changeset
7753 Create or replace or add to the location list for window {nr}.
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
7754 {nr} can be the window number or the |window-ID|.
9223
6c4d610fce0a commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents: 9221
diff changeset
7755 When {nr} is zero the current window is used.
6c4d610fce0a commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents: 9221
diff changeset
7756
6c4d610fce0a commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents: 9221
diff changeset
7757 For a location list window, the displayed location list is
6c4d610fce0a commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents: 9221
diff changeset
7758 modified. For an invalid window number {nr}, -1 is returned.
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
7759 Otherwise, same as |setqflist()|.
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
7760 Also see |location-list|.
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
7761
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
7762 If the optional {what} dictionary argument is supplied, then
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
7763 only the items listed in {what} are set. Refer to |setqflist()|
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
7764 for the list of supported keys in {what}.
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
7765
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
7766 setmatches({list}) *setmatches()*
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
7767 Restores a list of matches saved by |getmatches()|. Returns 0
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7768 if successful, otherwise -1. All current matches are cleared
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1317
diff changeset
7769 before the list is restored. See example for |getmatches()|.
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
7770
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7771 *setpos()*
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7772 setpos({expr}, {list})
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7773 Set the position for {expr}. Possible values:
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7774 . the cursor
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7775 'x mark x
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7776
5938
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
7777 {list} must be a |List| with four or five numbers:
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7778 [bufnum, lnum, col, off]
5938
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
7779 [bufnum, lnum, col, off, curswant]
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7780
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
7781 "bufnum" is the buffer number. Zero can be used for the
10730
44e9340dc604 patch 8.0.0255: setpos() does not use the buffer argument for all marks
Christian Brabandt <cb@256bit.org>
parents: 10722
diff changeset
7782 current buffer. When setting an uppercase mark "bufnum" is
44e9340dc604 patch 8.0.0255: setpos() does not use the buffer argument for all marks
Christian Brabandt <cb@256bit.org>
parents: 10722
diff changeset
7783 used for the mark position. For other marks it specifies the
44e9340dc604 patch 8.0.0255: setpos() does not use the buffer argument for all marks
Christian Brabandt <cb@256bit.org>
parents: 10722
diff changeset
7784 buffer to set the mark in. You can use the |bufnr()| function
44e9340dc604 patch 8.0.0255: setpos() does not use the buffer argument for all marks
Christian Brabandt <cb@256bit.org>
parents: 10722
diff changeset
7785 to turn a file name into a buffer number.
44e9340dc604 patch 8.0.0255: setpos() does not use the buffer argument for all marks
Christian Brabandt <cb@256bit.org>
parents: 10722
diff changeset
7786 For setting the cursor and the ' mark "bufnum" is ignored,
44e9340dc604 patch 8.0.0255: setpos() does not use the buffer argument for all marks
Christian Brabandt <cb@256bit.org>
parents: 10722
diff changeset
7787 since these are associated with a window, not a buffer.
798
95dac6af3b3a updated for version 7.0232
vimboss
parents: 794
diff changeset
7788 Does not change the jumplist.
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7789
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7790 "lnum" and "col" are the position in the buffer. The first
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
7791 column is 1. Use a zero "lnum" to delete a mark. If "col" is
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
7792 smaller than 1 then 1 is used.
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7793
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7794 The "off" number is only used when 'virtualedit' is set. Then
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7795 it is the offset in screen columns from the start of the
1266
54588e2e8041 updated for version 7.1
vimboss
parents: 1215
diff changeset
7796 character. E.g., a position within a <Tab> or after the last
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7797 character.
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7798
5938
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
7799 The "curswant" number is only used when setting the cursor
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
7800 position. It sets the preferred column for when moving the
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
7801 cursor vertically. When the "curswant" number is missing the
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
7802 preferred column is not set. When it is present and setting a
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
7803 mark position it is not used.
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
7804
5555
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5466
diff changeset
7805 Note that for '< and '> changing the line number may result in
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5466
diff changeset
7806 the marks to be effectively be swapped, so that '< is always
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5466
diff changeset
7807 before '>.
7818ca6de3d0 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5466
diff changeset
7808
1533
8abc0abf8cbd updated for version 7.1-248
vimboss
parents: 1504
diff changeset
7809 Returns 0 when the position could be set, -1 otherwise.
8abc0abf8cbd updated for version 7.1-248
vimboss
parents: 1504
diff changeset
7810 An error message is given if {expr} is invalid.
8abc0abf8cbd updated for version 7.1-248
vimboss
parents: 1504
diff changeset
7811
5944
332a5c2b2956 updated for version 7.4.313
Bram Moolenaar <bram@vim.org>
parents: 5942
diff changeset
7812 Also see |getpos()| and |getcurpos()|.
707
111b7dcc8a17 updated for version 7.0213
vimboss
parents: 703
diff changeset
7813
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
7814 This does not restore the preferred column for moving
5938
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
7815 vertically; if you set the cursor position with this, |j| and
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
7816 |k| motions will jump to previous columns! Use |cursor()| to
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
7817 also set the preferred column. Also see the "curswant" key in
ccac0aa34eea updated for version 7.4.310
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
7818 |winrestview()|.
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
7819
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7820 setqflist({list} [, {action} [, {what}]]) *setqflist()*
12048
ebd313aa5a6c patch 8.0.0904: cannot set a location list from text
Christian Brabandt <cb@256bit.org>
parents: 12045
diff changeset
7821 Create or replace or add to the quickfix list.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7822
12048
ebd313aa5a6c patch 8.0.0904: cannot set a location list from text
Christian Brabandt <cb@256bit.org>
parents: 12045
diff changeset
7823 When {what} is not present, use the items in {list}. Each
ebd313aa5a6c patch 8.0.0904: cannot set a location list from text
Christian Brabandt <cb@256bit.org>
parents: 12045
diff changeset
7824 item must be a dictionary. Non-dictionary items in {list} are
ebd313aa5a6c patch 8.0.0904: cannot set a location list from text
Christian Brabandt <cb@256bit.org>
parents: 12045
diff changeset
7825 ignored. Each dictionary item can contain the following
ebd313aa5a6c patch 8.0.0904: cannot set a location list from text
Christian Brabandt <cb@256bit.org>
parents: 12045
diff changeset
7826 entries:
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
7827
1065
caa550fe4457 updated for version 7.0-191
vimboss
parents: 1029
diff changeset
7828 bufnr buffer number; must be the number of a valid
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7829 buffer
1065
caa550fe4457 updated for version 7.0-191
vimboss
parents: 1029
diff changeset
7830 filename name of a file; only used when "bufnr" is not
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
7831 present or it is invalid.
13821
98274127d675 patch 8.0.1782: no simple way to label quickfix entries
Christian Brabandt <cb@256bit.org>
parents: 13818
diff changeset
7832 module name of a module; if given it will be used in
98274127d675 patch 8.0.1782: no simple way to label quickfix entries
Christian Brabandt <cb@256bit.org>
parents: 13818
diff changeset
7833 quickfix error window instead of the filename.
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
7834 lnum line number in the file
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
7835 pattern search pattern used to locate the error
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
7836 col column number
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
7837 vcol when non-zero: "col" is visual column
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
7838 when zero: "col" is byte index
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
7839 nr error number
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
7840 text description of the error
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
7841 type single-character error type, 'E', 'W', etc.
11390
73cfcf11d983 patch 8.0.0580: cannot set the valid flag with setqflist()
Christian Brabandt <cb@256bit.org>
parents: 11347
diff changeset
7842 valid recognized error message
233
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
7843
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
7844 The "col", "vcol", "nr", "type" and "text" entries are
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
7845 optional. Either "lnum" or "pattern" entry can be used to
fca8a9b65afa updated for version 7.0065
vimboss
parents: 230
diff changeset
7846 locate a matching error line.
1065
caa550fe4457 updated for version 7.0-191
vimboss
parents: 1029
diff changeset
7847 If the "filename" and "bufnr" entries are not present or
caa550fe4457 updated for version 7.0-191
vimboss
parents: 1029
diff changeset
7848 neither the "lnum" or "pattern" entries are present, then the
caa550fe4457 updated for version 7.0-191
vimboss
parents: 1029
diff changeset
7849 item will not be handled as an error line.
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
7850 If both "pattern" and "lnum" are present then "pattern" will
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
7851 be used.
11390
73cfcf11d983 patch 8.0.0580: cannot set the valid flag with setqflist()
Christian Brabandt <cb@256bit.org>
parents: 11347
diff changeset
7852 If the "valid" entry is not supplied, then the valid flag is
73cfcf11d983 patch 8.0.0580: cannot set the valid flag with setqflist()
Christian Brabandt <cb@256bit.org>
parents: 11347
diff changeset
7853 set when "bufnr" is a valid buffer or "filename" exists.
2152
b9e314fe473f Updated runtime files.
Bram Moolenaar <bram@zimbu.org>
parents: 2120
diff changeset
7854 If you supply an empty {list}, the quickfix list will be
b9e314fe473f Updated runtime files.
Bram Moolenaar <bram@zimbu.org>
parents: 2120
diff changeset
7855 cleared.
1065
caa550fe4457 updated for version 7.0-191
vimboss
parents: 1029
diff changeset
7856 Note that the list is not exactly the same as what
caa550fe4457 updated for version 7.0-191
vimboss
parents: 1029
diff changeset
7857 |getqflist()| returns.
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
7858
11263
ae5f9f26f81c patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents: 11262
diff changeset
7859 {action} values: *E927*
ae5f9f26f81c patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents: 11262
diff changeset
7860 'a' The items from {list} are added to the existing
ae5f9f26f81c patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents: 11262
diff changeset
7861 quickfix list. If there is no existing list, then a
ae5f9f26f81c patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents: 11262
diff changeset
7862 new list is created.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7863
11263
ae5f9f26f81c patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents: 11262
diff changeset
7864 'r' The items from the current quickfix list are replaced
ae5f9f26f81c patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents: 11262
diff changeset
7865 with the items from {list}. This can also be used to
ae5f9f26f81c patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents: 11262
diff changeset
7866 clear the list: >
ae5f9f26f81c patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents: 11262
diff changeset
7867 :call setqflist([], 'r')
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7868 <
11263
ae5f9f26f81c patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents: 11262
diff changeset
7869 'f' All the quickfix lists in the quickfix stack are
ae5f9f26f81c patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents: 11262
diff changeset
7870 freed.
ae5f9f26f81c patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents: 11262
diff changeset
7871
9221
17fa362f10be commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents: 9219
diff changeset
7872 If {action} is not present or is set to ' ', then a new list
12084
69ce6b3f0834 patch 8.0.0922: quickfix list always added after current one
Christian Brabandt <cb@256bit.org>
parents: 12076
diff changeset
7873 is created. The new quickfix list is added after the current
69ce6b3f0834 patch 8.0.0922: quickfix list always added after current one
Christian Brabandt <cb@256bit.org>
parents: 12076
diff changeset
7874 quickfix list in the stack and all the following lists are
69ce6b3f0834 patch 8.0.0922: quickfix list always added after current one
Christian Brabandt <cb@256bit.org>
parents: 12076
diff changeset
7875 freed. To add a new quickfix list at the end of the stack,
12321
2779d593a706 patch 8.0.1040: cannot use another error format in getqflist()
Christian Brabandt <cb@256bit.org>
parents: 12319
diff changeset
7876 set "nr" in {what} to "$".
277
fe16c18c24a7 updated for version 7.0074
vimboss
parents: 270
diff changeset
7877
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
7878 If the optional {what} dictionary argument is supplied, then
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
7879 only the items listed in {what} are set. The first {list}
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
7880 argument is ignored. The following items can be specified in
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
7881 {what}:
13818
28ac7914b2b6 Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents: 13796
diff changeset
7882 context quickfix list context. See |quickfix-context|
12321
2779d593a706 patch 8.0.1040: cannot use another error format in getqflist()
Christian Brabandt <cb@256bit.org>
parents: 12319
diff changeset
7883 efm errorformat to use when parsing text from
2779d593a706 patch 8.0.1040: cannot use another error format in getqflist()
Christian Brabandt <cb@256bit.org>
parents: 12319
diff changeset
7884 "lines". If this is not present, then the
2779d593a706 patch 8.0.1040: cannot use another error format in getqflist()
Christian Brabandt <cb@256bit.org>
parents: 12319
diff changeset
7885 'errorformat' option value is used.
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
7886 See |quickfix-parse|
12287
20641a7e1fc9 patch 8.0.1023: it is not easy to identify a quickfix list
Christian Brabandt <cb@256bit.org>
parents: 12273
diff changeset
7887 id quickfix list identifier |quickfix-ID|
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
7888 idx index of the current entry in the quickfix
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
7889 list specified by 'id' or 'nr'. If set to '$',
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
7890 then the last entry in the list is set as the
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
7891 current entry. See |quickfix-index|
11549
f5add45f9848 patch 8.0.0657: cannot get and set quickfix list items
Christian Brabandt <cb@256bit.org>
parents: 11543
diff changeset
7892 items list of quickfix entries. Same as the {list}
f5add45f9848 patch 8.0.0657: cannot get and set quickfix list items
Christian Brabandt <cb@256bit.org>
parents: 11543
diff changeset
7893 argument.
12303
ec7a4fd21dd5 patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents: 12287
diff changeset
7894 lines use 'errorformat' to parse a list of lines and
ec7a4fd21dd5 patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents: 12287
diff changeset
7895 add the resulting entries to the quickfix list
ec7a4fd21dd5 patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents: 12287
diff changeset
7896 {nr} or {id}. Only a |List| value is supported.
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
7897 See |quickfix-parse|
11502
46bbef0ee9a6 patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents: 11473
diff changeset
7898 nr list number in the quickfix stack; zero
12321
2779d593a706 patch 8.0.1040: cannot use another error format in getqflist()
Christian Brabandt <cb@256bit.org>
parents: 12319
diff changeset
7899 means the current quickfix list and "$" means
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
7900 the last quickfix list.
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
7901 title quickfix list title text. See |quickfix-title|
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
7902 Unsupported keys in {what} are ignored.
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
7903 If the "nr" item is not present, then the current quickfix list
11609
6f11697fb92c patch 8.0.0687: minor issues related to quickfix
Christian Brabandt <cb@256bit.org>
parents: 11587
diff changeset
7904 is modified. When creating a new quickfix list, "nr" can be
6f11697fb92c patch 8.0.0687: minor issues related to quickfix
Christian Brabandt <cb@256bit.org>
parents: 11587
diff changeset
7905 set to a value one greater than the quickfix stack size.
12287
20641a7e1fc9 patch 8.0.1023: it is not easy to identify a quickfix list
Christian Brabandt <cb@256bit.org>
parents: 12273
diff changeset
7906 When modifying a quickfix list, to guarantee that the correct
12321
2779d593a706 patch 8.0.1040: cannot use another error format in getqflist()
Christian Brabandt <cb@256bit.org>
parents: 12319
diff changeset
7907 list is modified, "id" should be used instead of "nr" to
12287
20641a7e1fc9 patch 8.0.1023: it is not easy to identify a quickfix list
Christian Brabandt <cb@256bit.org>
parents: 12273
diff changeset
7908 specify the list.
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
7909
13818
28ac7914b2b6 Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents: 13796
diff changeset
7910 Examples (See also |setqflist-examples|): >
12303
ec7a4fd21dd5 patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents: 12287
diff changeset
7911 :call setqflist([], 'r', {'title': 'My search'})
ec7a4fd21dd5 patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents: 12287
diff changeset
7912 :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
13818
28ac7914b2b6 Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents: 13796
diff changeset
7913 :call setqflist([], 'a', {'id':qfid, 'lines':["F1:10:L10"]})
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
7914 <
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
7915 Returns zero for success, -1 for failure.
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
7916
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
7917 This function can be used to create a quickfix list
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
7918 independent of the 'errorformat' setting. Use a command like
11400
0f8713fe20dc Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11390
diff changeset
7919 `:cc 1` to jump to the first position.
230
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
7920
9281a51ca7a2 updated for version 7.0064
vimboss
parents: 216
diff changeset
7921
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7922 *setreg()*
8148
f5da459c5698 commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents: 8094
diff changeset
7923 setreg({regname}, {value} [, {options}])
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7924 Set the register {regname} to {value}.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7925 {value} may be any value returned by |getreg()|, including
5798
9f8fa56f1906 updated for version 7.4.243
Bram Moolenaar <bram@vim.org>
parents: 5796
diff changeset
7926 a |List|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7927 If {options} contains "a" or {regname} is upper case,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7928 then the value is appended.
2423
71899235e72d Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
7929 {options} can also contain a register type specification:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7930 "c" or "v" |characterwise| mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7931 "l" or "V" |linewise| mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7932 "b" or "<CTRL-V>" |blockwise-visual| mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7933 If a number immediately follows "b" or "<CTRL-V>" then this is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7934 used as the width of the selection - if it is not specified
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7935 then the width of the block is set to the number of characters
1266
54588e2e8041 updated for version 7.1
vimboss
parents: 1215
diff changeset
7936 in the longest line (counting a <Tab> as 1 character).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7937
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7938 If {options} contains no register settings, then the default
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7939 is to use character mode unless {value} ends in a <NL> for
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7940 string {value} and linewise mode for list {value}. Blockwise
5798
9f8fa56f1906 updated for version 7.4.243
Bram Moolenaar <bram@vim.org>
parents: 5796
diff changeset
7941 mode is never selected automatically.
9f8fa56f1906 updated for version 7.4.243
Bram Moolenaar <bram@vim.org>
parents: 5796
diff changeset
7942 Returns zero for success, non-zero for failure.
9f8fa56f1906 updated for version 7.4.243
Bram Moolenaar <bram@vim.org>
parents: 5796
diff changeset
7943
9f8fa56f1906 updated for version 7.4.243
Bram Moolenaar <bram@vim.org>
parents: 5796
diff changeset
7944 *E883*
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7945 Note: you may not use |List| containing more than one item to
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7946 set search and expression registers. Lists containing no
5798
9f8fa56f1906 updated for version 7.4.243
Bram Moolenaar <bram@vim.org>
parents: 5796
diff changeset
7947 items act like empty strings.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7948
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7949 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7950 :call setreg(v:register, @*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7951 :call setreg('*', @%, 'ac')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7952 :call setreg('a', "1\n2\n3", 'b5')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7953
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7954 < This example shows using the functions to save and restore a
12427
fc3e2d5614dd patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents: 12389
diff changeset
7955 register: >
5798
9f8fa56f1906 updated for version 7.4.243
Bram Moolenaar <bram@vim.org>
parents: 5796
diff changeset
7956 :let var_a = getreg('a', 1, 1)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7957 :let var_amode = getregtype('a')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7958 ....
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7959 :call setreg('a', var_a, var_amode)
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7960 < Note: you may not reliably restore register value
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
7961 without using the third argument to |getreg()| as without it
12427
fc3e2d5614dd patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents: 12389
diff changeset
7962 newlines are represented as newlines AND Nul bytes are
fc3e2d5614dd patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents: 12389
diff changeset
7963 represented as newlines as well, see |NL-used-for-Nul|.
fc3e2d5614dd patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents: 12389
diff changeset
7964
fc3e2d5614dd patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents: 12389
diff changeset
7965 You can also change the type of a register by appending
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7966 nothing: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7967 :call setreg('a', '', 'al')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7968
2207
b17bbfa96fa0 Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents: 2206
diff changeset
7969 settabvar({tabnr}, {varname}, {val}) *settabvar()*
b17bbfa96fa0 Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents: 2206
diff changeset
7970 Set tab-local variable {varname} to {val} in tab page {tabnr}.
b17bbfa96fa0 Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents: 2206
diff changeset
7971 |t:var|
b17bbfa96fa0 Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents: 2206
diff changeset
7972 Note that the variable name without "t:" must be used.
b17bbfa96fa0 Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents: 2206
diff changeset
7973 Tabs are numbered starting with one.
b17bbfa96fa0 Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents: 2206
diff changeset
7974 This function is not available in the |sandbox|.
b17bbfa96fa0 Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents: 2206
diff changeset
7975
831
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
7976 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()*
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
7977 Set option or local variable {varname} in window {winnr} to
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
7978 {val}.
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
7979 Tabs are numbered starting with one. For the current tabpage
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
7980 use |setwinvar()|.
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
7981 {winnr} can be the window number or the |window-ID|.
831
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
7982 When {winnr} is zero the current window is used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7983 This also works for a global or local buffer option, but it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7984 doesn't work for a global or local buffer variable.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7985 For a local buffer option the global value is unchanged.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7986 Note that the variable name without "w:" must be used.
831
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
7987 Examples: >
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
7988 :call settabwinvar(1, 1, "&list", 0)
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
7989 :call settabwinvar(3, 2, "myvar", "foobar")
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
7990 < This function is not available in the |sandbox|.
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
7991
15016
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
7992 settagstack({nr}, {dict} [, {action}]) *settagstack()*
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
7993 Modify the tag stack of the window {nr} using {dict}.
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
7994 {nr} can be the window number or the |window-ID|.
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
7995
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
7996 For a list of supported items in {dict}, refer to
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
7997 |gettagstack()|
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
7998 *E962*
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
7999 If {action} is not present or is set to 'r', then the tag
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8000 stack is replaced. If {action} is set to 'a', then new entries
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8001 from {dict} are pushed onto the tag stack.
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8002
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8003 Returns zero for success, -1 for failure.
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8004
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8005 Examples:
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8006 Set current index of the tag stack to 4: >
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8007 call settagstack(1005, {'curidx' : 4})
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8008
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8009 < Empty the tag stack of window 3: >
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8010 call settagstack(3, {'items' : []})
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8011
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8012 < Push a new item onto the tag stack: >
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8013 let pos = [bufnr('myfile.txt'), 10, 1, 0]
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8014 let newtag = [{'tagname' : 'mytag', 'from' : pos}]
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8015 call settagstack(2, {'items' : newtag}, 'a')
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8016
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8017 < Save and restore the tag stack: >
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8018 let stack = gettagstack(1003)
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8019 " do something else
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8020 call settagstack(1003, stack)
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8021 unlet stack
c338c91086b9 patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents: 15008
diff changeset
8022 <
831
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
8023 setwinvar({nr}, {varname}, {val}) *setwinvar()*
f24a95dae8ee updated for version 7.0d05
vimboss
parents: 829
diff changeset
8024 Like |settabwinvar()| for the current tab page.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8025 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8026 :call setwinvar(1, "&list", 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8027 :call setwinvar(2, "myvar", "foobar")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8028
4126
2b340e5c5baa updated for version 7.3.816
Bram Moolenaar <bram@vim.org>
parents: 4073
diff changeset
8029 sha256({string}) *sha256()*
6647
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6583
diff changeset
8030 Returns a String with 64 hex characters, which is the SHA256
4126
2b340e5c5baa updated for version 7.3.816
Bram Moolenaar <bram@vim.org>
parents: 4073
diff changeset
8031 checksum of {string}.
2b340e5c5baa updated for version 7.3.816
Bram Moolenaar <bram@vim.org>
parents: 4073
diff changeset
8032 {only available when compiled with the |+cryptv| feature}
2b340e5c5baa updated for version 7.3.816
Bram Moolenaar <bram@vim.org>
parents: 4073
diff changeset
8033
1661
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
8034 shellescape({string} [, {special}]) *shellescape()*
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
8035 Escape {string} for use as a shell command argument.
985
656853d9c014 updated for version 7.0-111
vimboss
parents: 874
diff changeset
8036 On MS-Windows and MS-DOS, when 'shellslash' is not set, it
1661
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
8037 will enclose {string} in double quotes and double all double
985
656853d9c014 updated for version 7.0-111
vimboss
parents: 874
diff changeset
8038 quotes within {string}.
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
8039 Otherwise it will enclose {string} in single quotes and
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
8040 replace all "'" with "'\''".
11502
46bbef0ee9a6 patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents: 11473
diff changeset
8041
1661
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
8042 When the {special} argument is present and it's a non-zero
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
8043 Number or a non-empty String (|non-zero-arg|), then special
1698
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
8044 items such as "!", "%", "#" and "<cword>" will be preceded by
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
8045 a backslash. This backslash will be removed again by the |:!|
1661
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
8046 command.
11502
46bbef0ee9a6 patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents: 11473
diff changeset
8047
1698
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
8048 The "!" character will be escaped (again with a |non-zero-arg|
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
8049 {special}) when 'shell' contains "csh" in the tail. That is
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
8050 because for csh and tcsh "!" is used for history replacement
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
8051 even when inside single quotes.
11502
46bbef0ee9a6 patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents: 11473
diff changeset
8052
46bbef0ee9a6 patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents: 11473
diff changeset
8053 With a |non-zero-arg| {special} the <NL> character is also
46bbef0ee9a6 patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents: 11473
diff changeset
8054 escaped. When 'shell' containing "csh" in the tail it's
1698
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
8055 escaped a second time.
11502
46bbef0ee9a6 patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents: 11473
diff changeset
8056
1661
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
8057 Example of use with a |:!| command: >
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
8058 :exe '!dir ' . shellescape(expand('<cfile>'), 1)
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
8059 < This results in a directory listing for the file under the
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
8060 cursor. Example of use with |system()|: >
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
8061 :call system("chmod +w -- " . shellescape(expand("%")))
5690
40f18a1c1592 updated for version 7.4.191
Bram Moolenaar <bram@vim.org>
parents: 5663
diff changeset
8062 < See also |::S|.
985
656853d9c014 updated for version 7.0-111
vimboss
parents: 874
diff changeset
8063
656853d9c014 updated for version 7.0-111
vimboss
parents: 874
diff changeset
8064
15062
3a94f7918980 patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents: 15033
diff changeset
8065 shiftwidth([{col}]) *shiftwidth()*
3875
8235ccf121bb updated for version 7.3.694
Bram Moolenaar <bram@vim.org>
parents: 3830
diff changeset
8066 Returns the effective value of 'shiftwidth'. This is the
8235ccf121bb updated for version 7.3.694
Bram Moolenaar <bram@vim.org>
parents: 3830
diff changeset
8067 'shiftwidth' value unless it is zero, in which case it is the
7782
3a99194bd187 commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents: 7742
diff changeset
8068 'tabstop' value. This function was introduced with patch
15062
3a94f7918980 patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents: 15033
diff changeset
8069 7.3.694 in 2012, everybody should have it by now (however it
3a94f7918980 patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents: 15033
diff changeset
8070 did not allow for the optional {col} argument until 8.1.542).
3a94f7918980 patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents: 15033
diff changeset
8071
3a94f7918980 patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents: 15033
diff changeset
8072 When there is one argument {col} this is used as column number
3a94f7918980 patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents: 15033
diff changeset
8073 for which to return the 'shiftwidth' value. This matters for the
3a94f7918980 patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents: 15033
diff changeset
8074 'vartabstop' feature. If the 'vartabstop' setting is enabled and
3a94f7918980 patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents: 15033
diff changeset
8075 no {col} argument is given, column 1 will be assumed.
15033
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15016
diff changeset
8076
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8077 sign_define({name} [, {dict}]) *sign_define()*
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8078 Define a new sign named {name} or modify the attributes of an
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8079 existing sign. This is similar to the |:sign-define| command.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8080
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8081 Prefix {name} with a unique text to avoid name collisions.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8082 There is no {group} like with placing signs.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8083
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8084 The {name} can be a String or a Number. The optional {dict}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8085 argument specifies the sign attributes. The following values
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8086 are supported:
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8087 icon full path to the bitmap file for the sign.
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8088 linehl highlight group used for the whole line the
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8089 sign is placed in.
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8090 text text that is displayed when there is no icon
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8091 or the GUI is not being used.
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8092 texthl highlight group used for the text item
15378
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
8093
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
8094 If the sign named {name} already exists, then the attributes
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
8095 of the sign are updated.
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8096
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8097 Returns 0 on success and -1 on failure.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8098
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8099 Examples: >
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8100 call sign_define("mySign", {"text" : "=>", "texthl" :
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8101 \ "Error", "linehl" : "Search"})
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8102 <
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8103 sign_getdefined([{name}]) *sign_getdefined()*
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8104 Get a list of defined signs and their attributes.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8105 This is similar to the |:sign-list| command.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8106
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8107 If the {name} is not supplied, then a list of all the defined
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8108 signs is returned. Otherwise the attribute of the specified
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8109 sign is returned.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8110
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8111 Each list item in the returned value is a dictionary with the
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8112 following entries:
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8113 icon full path to the bitmap file of the sign
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8114 linehl highlight group used for the whole line the
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8115 sign is placed in.
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8116 name name of the sign
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8117 text text that is displayed when there is no icon
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8118 or the GUI is not being used.
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8119 texthl highlight group used for the text item
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8120
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8121 Returns an empty List if there are no signs and when {name} is
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8122 not found.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8123
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8124 Examples: >
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8125 " Get a list of all the defined signs
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8126 echo sign_getdefined()
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8127
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8128 " Get the attribute of the sign named mySign
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8129 echo sign_getdefined("mySign")
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8130 <
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8131 sign_getplaced([{expr} [, {dict}]]) *sign_getplaced()*
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8132 Return a list of signs placed in a buffer or all the buffers.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8133 This is similar to the |:sign-place-list| command.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8134
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8135 If the optional buffer name {expr} is specified, then only the
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8136 list of signs placed in that buffer is returned. For the use
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8137 of {expr}, see |bufname()|. The optional {dict} can contain
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8138 the following entries:
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8139 group select only signs in this group
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8140 id select sign with this identifier
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8141 lnum select signs placed in this line. For the use
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8142 of {lnum}, see |line()|.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8143 If {group} is '*', then signs in all the groups including the
15271
a6319aca721b patch 8.1.0644: finding next sign ID is inefficient
Bram Moolenaar <Bram@vim.org>
parents: 15251
diff changeset
8144 global group are returned. If {group} is not supplied or is an
a6319aca721b patch 8.1.0644: finding next sign ID is inefficient
Bram Moolenaar <Bram@vim.org>
parents: 15251
diff changeset
8145 empty string, then only signs in the global group are
a6319aca721b patch 8.1.0644: finding next sign ID is inefficient
Bram Moolenaar <Bram@vim.org>
parents: 15251
diff changeset
8146 returned. If no arguments are supplied, then signs in the
a6319aca721b patch 8.1.0644: finding next sign ID is inefficient
Bram Moolenaar <Bram@vim.org>
parents: 15251
diff changeset
8147 global group placed in all the buffers are returned.
15378
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
8148 See |sign-group|.
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8149
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8150 Each list item in the returned value is a dictionary with the
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8151 following entries:
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8152 bufnr number of the buffer with the sign
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8153 signs list of signs placed in {bufnr}. Each list
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8154 item is a dictionary with the below listed
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8155 entries
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8156
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8157 The dictionary for each sign contains the following entries:
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8158 group sign group. Set to '' for the global group.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8159 id identifier of the sign
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8160 lnum line number where the sign is placed
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8161 name name of the defined sign
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8162 priority sign priority
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8163
15388
7444fffa482d patch 8.1.0702: ":sign place" only uses the current buffer
Bram Moolenaar <Bram@vim.org>
parents: 15378
diff changeset
8164 The returned signs in a buffer are ordered by their line
7444fffa482d patch 8.1.0702: ":sign place" only uses the current buffer
Bram Moolenaar <Bram@vim.org>
parents: 15378
diff changeset
8165 number.
7444fffa482d patch 8.1.0702: ":sign place" only uses the current buffer
Bram Moolenaar <Bram@vim.org>
parents: 15378
diff changeset
8166
15378
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
8167 Returns an empty list on failure or if there are no placed
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
8168 signs.
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8169
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8170 Examples: >
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8171 " Get a List of signs placed in eval.c in the
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8172 " global group
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8173 echo sign_getplaced("eval.c")
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8174
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8175 " Get a List of signs in group 'g1' placed in eval.c
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8176 echo sign_getplaced("eval.c", {'group' : 'g1'})
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8177
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8178 " Get a List of signs placed at line 10 in eval.c
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8179 echo sign_getplaced("eval.c", {'lnum' : 10})
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8180
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8181 " Get sign with identifier 10 placed in a.py
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8182 echo sign_getplaced("a.py", {'id' : 10})
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8183
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8184 " Get sign with id 20 in group 'g1' placed in a.py
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8185 echo sign_getplaced("a.py", {'group' : 'g1',
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8186 \ 'id' : 20})
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8187
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8188 " Get a List of all the placed signs
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8189 echo sign_getplaced()
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8190 <
15418
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
8191 *sign_jump()*
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
8192 sign_jump({id}, {group}, {expr})
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
8193 Open the buffer {expr} or jump to the window that contains
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
8194 {expr} and position the cursor at sign {id} in group {group}.
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
8195 This is similar to the |:sign-jump| command.
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
8196
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
8197 For the use of {expr}, see |bufname()|.
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
8198
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
8199 Returns the line number of the sign. Returns -1 if the
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
8200 arguments are invalid.
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
8201
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
8202 Example: >
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
8203 " Jump to sign 10 in the current buffer
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
8204 call sign_jump(10, '', '')
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents: 15388
diff changeset
8205 <
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8206 *sign_place()*
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8207 sign_place({id}, {group}, {name}, {expr} [, {dict}])
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8208 Place the sign defined as {name} at line {lnum} in file {expr}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8209 and assign {id} and {group} to sign. This is similar to the
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8210 |:sign-place| command.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8211
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8212 If the sign identifier {id} is zero, then a new identifier is
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8213 allocated. Otherwise the specified number is used. {group} is
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8214 the sign group name. To use the global sign group, use an
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8215 empty string. {group} functions as a namespace for {id}, thus
15378
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
8216 two groups can use the same IDs. Refer to |sign-identifier|
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
8217 and |sign-group| for more information.
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8218
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8219 {name} refers to a defined sign.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8220 {expr} refers to a buffer name or number. For the accepted
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8221 values, see |bufname()|.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8222
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8223 The optional {dict} argument supports the following entries:
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8224 lnum line number in the buffer {expr} where
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8225 the sign is to be placed. For the
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8226 accepted values, see |line()|.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8227 priority priority of the sign. See
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8228 |sign-priority| for more information.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8229
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8230 If the optional {dict} is not specified, then it modifies the
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8231 placed sign {id} in group {group} to use the defined sign
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8232 {name}.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8233
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8234 Returns the sign identifier on success and -1 on failure.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8235
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8236 Examples: >
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8237 " Place a sign named sign1 with id 5 at line 20 in
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8238 " buffer json.c
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8239 call sign_place(5, '', 'sign1', 'json.c',
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8240 \ {'lnum' : 20})
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8241
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8242 " Updates sign 5 in buffer json.c to use sign2
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8243 call sign_place(5, '', 'sign2', 'json.c')
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8244
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8245 " Place a sign named sign3 at line 30 in
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8246 " buffer json.c with a new identifier
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8247 let id = sign_place(0, '', 'sign3', 'json.c',
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8248 \ {'lnum' : 30})
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8249
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8250 " Place a sign named sign4 with id 10 in group 'g3'
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8251 " at line 40 in buffer json.c with priority 90
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8252 call sign_place(10, 'g3', 'sign4', 'json.c',
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8253 \ {'lnum' : 40, 'priority' : 90})
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8254 <
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8255 sign_undefine([{name}]) *sign_undefine()*
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8256 Deletes a previously defined sign {name}. This is similar to
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8257 the |:sign-undefine| command. If {name} is not supplied, then
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8258 deletes all the defined signs.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8259
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8260 Returns 0 on success and -1 on failure.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8261
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8262 Examples: >
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8263 " Delete a sign named mySign
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8264 call sign_undefine("mySign")
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8265
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8266 " Delete all the signs
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8267 call sign_undefine()
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8268 <
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8269 sign_unplace({group} [, {dict}]) *sign_unplace()*
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8270 Remove a previously placed sign in one or more buffers. This
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15279
diff changeset
8271 is similar to the |:sign-unplace| command.
15209
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8272
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8273 {group} is the sign group name. To use the global sign group,
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8274 use an empty string. If {group} is set to '*', then all the
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8275 groups including the global group are used.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8276 The signs in {group} are selected based on the entries in
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8277 {dict}. The following optional entries in {dict} are
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8278 supported:
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8279 buffer buffer name or number. See |bufname()|.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8280 id sign identifier
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8281 If {dict} is not supplied, then all the signs in {group} are
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8282 removed.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8283
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8284 Returns 0 on success and -1 on failure.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8285
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8286 Examples: >
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8287 " Remove sign 10 from buffer a.vim
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8288 call sign_unplace('', {'buffer' : "a.vim", 'id' : 10})
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8289
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8290 " Remove sign 20 in group 'g1' from buffer 3
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8291 call sign_unplace('g1', {'buffer' : 3, 'id' : 20})
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8292
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8293 " Remove all the signs in group 'g2' from buffer 10
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8294 call sign_unplace('g2', {'buffer' : 10})
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8295
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8296 " Remove sign 30 in group 'g3' from all the buffers
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8297 call sign_unplace('g3', {'id' : 30})
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8298
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8299 " Remove all the signs placed in buffer 5
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8300 call sign_unplace('*', {'buffer' : 5})
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8301
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8302 " Remove the signs in group 'g4' from all the buffers
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8303 call sign_unplace('g4')
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8304
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8305 " Remove sign 40 from all the buffers
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8306 call sign_unplace('*', {'id' : 40})
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8307
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8308 " Remove all the placed signs from all the buffers
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8309 call sign_unplace('*')
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8310 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8311 simplify({filename}) *simplify()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8312 Simplify the file name as much as possible without changing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8313 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8314 Unix) are not resolved. If the first path component in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8315 {filename} designates the current directory, this will be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8316 valid for the result as well. A trailing path separator is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8317 not removed either.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8318 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8319 simplify("./dir/.././/file/") == "./file/"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8320 < Note: The combination "dir/.." is only removed if "dir" is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8321 a searchable directory or does not exist. On Unix, it is also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8322 removed when "dir" is a symbolic link within the same
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8323 directory. In order to resolve all the involved symbolic
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8324 links before simplifying the path name, use |resolve()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8325
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
8326
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8327 sin({expr}) *sin()*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8328 Return the sine of {expr}, measured in radians, as a |Float|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8329 {expr} must evaluate to a |Float| or a |Number|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8330 Examples: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8331 :echo sin(100)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8332 < -0.506366 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8333 :echo sin(-4.01)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8334 < 0.763301
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8335 {only available when compiled with the |+float| feature}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8336
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8337
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
8338 sinh({expr}) *sinh()*
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
8339 Return the hyperbolic sine of {expr} as a |Float| in the range
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
8340 [-inf, inf].
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
8341 {expr} must evaluate to a |Float| or a |Number|.
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
8342 Examples: >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
8343 :echo sinh(0.5)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
8344 < 0.521095 >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
8345 :echo sinh(-0.9)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
8346 < -1.026517
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
8347 {only available when compiled with the |+float| feature}
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
8348
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
8349
2902
69e0783ed0ef updated for version 7.3.224
Bram Moolenaar <bram@vim.org>
parents: 2845
diff changeset
8350 sort({list} [, {func} [, {dict}]]) *sort()* *E702*
5747
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
8351 Sort the items in {list} in-place. Returns {list}.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8352
5747
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
8353 If you want a list to remain unmodified make a copy first: >
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
8354 :let sortedlist = sort(copy(mylist))
5968
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5944
diff changeset
8355
6009
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6007
diff changeset
8356 < When {func} is omitted, is empty or zero, then sort() uses the
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6007
diff changeset
8357 string representation of each item to sort on. Numbers sort
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6007
diff changeset
8358 after Strings, |Lists| after Numbers. For sorting text in the
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6007
diff changeset
8359 current buffer use |:sort|.
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6007
diff changeset
8360
6180
6921742f396a Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6153
diff changeset
8361 When {func} is given and it is '1' or 'i' then case is
6009
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6007
diff changeset
8362 ignored.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8363
6009
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6007
diff changeset
8364 When {func} is given and it is 'n' then all items will be
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6007
diff changeset
8365 sorted numerical (Implementation detail: This uses the
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6007
diff changeset
8366 strtod() function to parse numbers, Strings, Lists, Dicts and
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6007
diff changeset
8367 Funcrefs will be considered as being 0).
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6007
diff changeset
8368
7291
6ffc75d807bd commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents: 7279
diff changeset
8369 When {func} is given and it is 'N' then all items will be
6ffc75d807bd commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents: 7279
diff changeset
8370 sorted numerical. This is like 'n' but a string containing
6ffc75d807bd commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents: 7279
diff changeset
8371 digits will be used as the number they represent.
6ffc75d807bd commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents: 7279
diff changeset
8372
7707
41768bcebc9b commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents: 7703
diff changeset
8373 When {func} is given and it is 'f' then all items will be
41768bcebc9b commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents: 7703
diff changeset
8374 sorted numerical. All values must be a Number or a Float.
41768bcebc9b commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents: 7703
diff changeset
8375
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
8376 When {func} is a |Funcref| or a function name, this function
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
8377 is called to compare items. The function is invoked with two
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
8378 items as argument and must return zero if they are equal, 1 or
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
8379 bigger if the first one sorts after the second one, -1 or
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
8380 smaller if the first one sorts before the second one.
5747
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
8381
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
8382 {dict} is for functions with the "dict" attribute. It will be
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
8383 used to set the local variable "self". |Dictionary-function|
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
8384
6032
b8f703a4e55f Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents: 6009
diff changeset
8385 The sort is stable, items which compare equal (as number or as
b8f703a4e55f Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents: 6009
diff changeset
8386 string) will keep their relative position. E.g., when sorting
6051
0efec12f52ac Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6032
diff changeset
8387 on numbers, text strings will sort next to each other, in the
6032
b8f703a4e55f Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents: 6009
diff changeset
8388 same order as they were originally.
b8f703a4e55f Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents: 6009
diff changeset
8389
5747
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
8390 Also see |uniq()|.
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
8391
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
8392 Example: >
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
8393 func MyCompare(i1, i2)
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
8394 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
8395 endfunc
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
8396 let sortedlist = sort(mylist, "MyCompare")
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
8397 < A shorter compare version for this specific simple case, which
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
8398 ignores overflow: >
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
8399 func MyCompare(i1, i2)
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
8400 return a:i1 - a:i2
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
8401 endfunc
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
8402 <
374
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
8403 *soundfold()*
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
8404 soundfold({word})
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
8405 Return the sound-folded equivalent of {word}. Uses the first
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8406 language in 'spelllang' for the current window that supports
375
f14cbd913415 updated for version 7.0097
vimboss
parents: 374
diff changeset
8407 soundfolding. 'spell' must be set. When no sound folding is
f14cbd913415 updated for version 7.0097
vimboss
parents: 374
diff changeset
8408 possible the {word} is returned unmodified.
374
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
8409 This can be used for making spelling suggestions. Note that
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
8410 the method can be quite slow.
575dacb554d8 updated for version 7.0096
vimboss
parents: 370
diff changeset
8411
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
8412 *spellbadword()*
532
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8413 spellbadword([{sentence}])
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8414 Without argument: The result is the badly spelled word under
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8415 or after the cursor. The cursor is moved to the start of the
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8416 bad word. When no bad word is found in the cursor line the
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8417 result is an empty string and the cursor doesn't move.
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8418
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8419 With argument: The result is the first word in {sentence} that
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8420 is badly spelled. If there are no spelling mistakes the
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8421 result is an empty string.
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8422
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8423 The return value is a list with two items:
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8424 - The badly spelled word or an empty string.
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8425 - The type of the spelling error:
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
8426 "bad" spelling mistake
532
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8427 "rare" rare word
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8428 "local" word only valid in another region
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8429 "caps" word should start with Capital
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8430 Example: >
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8431 echo spellbadword("the quik brown fox")
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8432 < ['quik', 'bad'] ~
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8433
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8434 The spelling information for the current window is used. The
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8435 'spell' option must be set and the value of 'spelllang' is
7052f11a3dc9 updated for version 7.0150
vimboss
parents: 531
diff changeset
8436 used.
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
8437
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
8438 *spellsuggest()*
537
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
8439 spellsuggest({word} [, {max} [, {capital}]])
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
8440 Return a |List| with spelling suggestions to replace {word}.
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
8441 When {max} is given up to this number of suggestions are
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
8442 returned. Otherwise up to 25 suggestions are returned.
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
8443
537
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
8444 When the {capital} argument is given and it's non-zero only
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
8445 suggestions with a leading capital will be given. Use this
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
8446 after a match with 'spellcapcheck'.
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
8447
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
8448 {word} can be a badly spelled word followed by other text.
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
8449 This allows for joining two words that were split. The
359
6c62b9b939bd updated for version 7.0093
vimboss
parents: 344
diff changeset
8450 suggestions also include the following text, thus you can
6c62b9b939bd updated for version 7.0093
vimboss
parents: 344
diff changeset
8451 replace a line.
6c62b9b939bd updated for version 7.0093
vimboss
parents: 344
diff changeset
8452
6c62b9b939bd updated for version 7.0093
vimboss
parents: 344
diff changeset
8453 {word} may also be a good word. Similar words will then be
537
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
8454 returned. {word} itself is not included in the suggestions,
e321639cfa3e updated for version 7.0152
vimboss
parents: 532
diff changeset
8455 although it may appear capitalized.
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
8456
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
8457 The spelling information for the current window is used. The
375
f14cbd913415 updated for version 7.0097
vimboss
parents: 374
diff changeset
8458 'spell' option must be set and the values of 'spelllang' and
f14cbd913415 updated for version 7.0097
vimboss
parents: 374
diff changeset
8459 'spellsuggest' are used.
344
7033303ea0c0 updated for version 7.0089
vimboss
parents: 336
diff changeset
8460
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
8461
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
8462 split({expr} [, {pattern} [, {keepempty}]]) *split()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
8463 Make a |List| out of {expr}. When {pattern} is omitted or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
8464 empty each white-separated sequence of characters becomes an
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
8465 item.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
8466 Otherwise the string is split where {pattern} matches,
3920
c53344bacabf Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3914
diff changeset
8467 removing the matched characters. 'ignorecase' is not used
c53344bacabf Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3914
diff changeset
8468 here, add \c to ignore case. |/\c|
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
8469 When the first or last item is empty it is omitted, unless the
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
8470 {keepempty} argument is given and it's non-zero.
293
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 282
diff changeset
8471 Other empty items are kept when {pattern} matches at least one
f811be6fa9b5 updated for version 7.0077
vimboss
parents: 282
diff changeset
8472 character or when {keepempty} is non-zero.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
8473 Example: >
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
8474 :let words = split(getline('.'), '\W\+')
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
8475 < To split a string in individual characters: >
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
8476 :for c in split(mystring, '\zs')
7100
f717d96a39b3 commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents: 7013
diff changeset
8477 < If you want to keep the separator you can also use '\zs' at
f717d96a39b3 commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents: 7013
diff changeset
8478 the end of the pattern: >
258
f93df7322443 updated for version 7.0070
vimboss
parents: 236
diff changeset
8479 :echo split('abc:def:ghi', ':\zs')
f93df7322443 updated for version 7.0070
vimboss
parents: 236
diff changeset
8480 < ['abc:', 'def:', 'ghi'] ~
282
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
8481 Splitting a table where the first element can be empty: >
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
8482 :let items = split(line, ':', 1)
33d9c918b8ab updated for version 7.0075
vimboss
parents: 277
diff changeset
8483 < The opposite function is |join()|.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
8484
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
8485
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8486 sqrt({expr}) *sqrt()*
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8487 Return the non-negative square root of Float {expr} as a
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8488 |Float|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8489 {expr} must evaluate to a |Float| or a |Number|. When {expr}
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8490 is negative the result is NaN (Not a Number).
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8491 Examples: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8492 :echo sqrt(100)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8493 < 10.0 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8494 :echo sqrt(-4.01)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8495 < nan
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
8496 "nan" may be different, it depends on system libraries.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8497 {only available when compiled with the |+float| feature}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8498
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8499
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
8500 str2float({expr}) *str2float()*
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8501 Convert String {expr} to a Float. This mostly works the same
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8502 as when using a floating point number in an expression, see
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8503 |floating-point-format|. But it's a bit more permissive.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8504 E.g., "1e40" is accepted, while in an expression you need to
15131
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15062
diff changeset
8505 write "1.0e40". The hexadecimal form "0x123" is also
bc1a8d21c811 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15062
diff changeset
8506 accepted, but not others, like binary or octal.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8507 Text after the number is silently ignored.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8508 The decimal point is always '.', no matter what the locale is
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8509 set to. A comma ends the number: "12,345.67" is converted to
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8510 12.0. You can strip out thousands separators with
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8511 |substitute()|: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8512 let f = str2float(substitute(text, ',', '', 'g'))
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8513 < {only available when compiled with the |+float| feature}
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8514
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8515
8883
b7de875169e6 commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents: 8881
diff changeset
8516 str2nr({expr} [, {base}]) *str2nr()*
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8517 Convert string {expr} to a number.
7477
05cf4cc72a9f commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
8518 {base} is the conversion base, it can be 2, 8, 10 or 16.
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8519 When {base} is omitted base 10 is used. This also means that
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8520 a leading zero doesn't cause octal conversion to be used, as
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8521 with the default String to Number conversion.
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8522 When {base} is 16 a leading "0x" or "0X" is ignored. With a
7477
05cf4cc72a9f commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
8523 different base the result will be zero. Similarly, when
05cf4cc72a9f commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
8524 {base} is 8 a leading "0" is ignored, and when {base} is 2 a
05cf4cc72a9f commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
8525 leading "0b" or "0B" is ignored.
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8526 Text after the number is silently ignored.
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
8527
782
d20041a02ee5 updated for version 7.0228
vimboss
parents: 777
diff changeset
8528
6884
29c328f69aaa Update help files.
Bram Moolenaar <bram@vim.org>
parents: 6870
diff changeset
8529 strchars({expr} [, {skipcc}]) *strchars()*
2338
da6ec32d8d8f Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents: 2337
diff changeset
8530 The result is a Number, which is the number of characters
6884
29c328f69aaa Update help files.
Bram Moolenaar <bram@vim.org>
parents: 6870
diff changeset
8531 in String {expr}.
29c328f69aaa Update help files.
Bram Moolenaar <bram@vim.org>
parents: 6870
diff changeset
8532 When {skipcc} is omitted or zero, composing characters are
29c328f69aaa Update help files.
Bram Moolenaar <bram@vim.org>
parents: 6870
diff changeset
8533 counted separately.
29c328f69aaa Update help files.
Bram Moolenaar <bram@vim.org>
parents: 6870
diff changeset
8534 When {skipcc} set to 1, Composing characters are ignored.
2339
01e4b4d37842 Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents: 2338
diff changeset
8535 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8536
6918
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8537 {skipcc} is only available after 7.4.755. For backward
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8538 compatibility, you can define a wrapper function: >
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8539 if has("patch-7.4.755")
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8540 function s:strchars(str, skipcc)
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8541 return strchars(a:str, a:skipcc)
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8542 endfunction
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8543 else
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8544 function s:strchars(str, skipcc)
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8545 if a:skipcc
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8546 return strlen(substitute(a:str, ".", "x", "g"))
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8547 else
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8548 return strchars(a:str)
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8549 endif
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8550 endfunction
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8551 endif
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8552 <
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8553 strcharpart({src}, {start} [, {len}]) *strcharpart()*
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8554 Like |strpart()| but using character index and length instead
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8555 of byte index and length.
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8556 When a character index is used where a character does not
10617
9a75c8a1b8b1 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10563
diff changeset
8557 exist it is assumed to be one character. For example: >
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8558 strcharpart('abc', -1, 2)
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8559 < results in 'a'.
6918
2def7b25de60 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6909
diff changeset
8560
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8561 strdisplaywidth({expr} [, {col}]) *strdisplaywidth()*
2339
01e4b4d37842 Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents: 2338
diff changeset
8562 The result is a Number, which is the number of display cells
6884
29c328f69aaa Update help files.
Bram Moolenaar <bram@vim.org>
parents: 6870
diff changeset
8563 String {expr} occupies on the screen when it starts at {col}.
2339
01e4b4d37842 Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents: 2338
diff changeset
8564 When {col} is omitted zero is used. Otherwise it is the
01e4b4d37842 Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents: 2338
diff changeset
8565 screen column where to start. This matters for Tab
01e4b4d37842 Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents: 2338
diff changeset
8566 characters.
2343
0703d2fd5749 Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents: 2339
diff changeset
8567 The option settings of the current window are used. This
0703d2fd5749 Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents: 2339
diff changeset
8568 matters for anything that's displayed differently, such as
0703d2fd5749 Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents: 2339
diff changeset
8569 'tabstop' and 'display'.
2339
01e4b4d37842 Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents: 2338
diff changeset
8570 When {expr} contains characters with East Asian Width Class
01e4b4d37842 Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents: 2338
diff changeset
8571 Ambiguous, this function's return value depends on 'ambiwidth'.
01e4b4d37842 Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents: 2338
diff changeset
8572 Also see |strlen()|, |strwidth()| and |strchars()|.
2338
da6ec32d8d8f Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents: 2337
diff changeset
8573
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8574 strftime({format} [, {time}]) *strftime()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8575 The result is a String, which is a formatted date and time, as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8576 specified by the {format} string. The given {time} is used,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8577 or the current time if no time is given. The accepted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8578 {format} depends on your system, thus this is not portable!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8579 See the manual page of the C function strftime() for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8580 format. The maximum length of the result is 80 characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8581 See also |localtime()| and |getftime()|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8582 The language can be changed with the |:language| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8583 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8584 :echo strftime("%c") Sun Apr 27 11:49:23 1997
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8585 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8586 :echo strftime("%y%m%d %T") 970427 11:53:55
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8587 :echo strftime("%H:%M") 11:55
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8588 :echo strftime("%c", getftime("file.c"))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8589 Show mod time of file.c.
82
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
8590 < Not available on all systems. To check use: >
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
8591 :if exists("*strftime")
366d9947baf2 updated for version 7.0033
vimboss
parents: 79
diff changeset
8592
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8593 strgetchar({str}, {index}) *strgetchar()*
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8594 Get character {index} from {str}. This uses a character
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8595 index, not a byte index. Composing characters are considered
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8596 separate characters here.
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8597 Also see |strcharpart()| and |strchars()|.
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8598
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
8599 stridx({haystack}, {needle} [, {start}]) *stridx()*
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
8600 The result is a Number, which gives the byte index in
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
8601 {haystack} of the first occurrence of the String {needle}.
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
8602 If {start} is specified, the search starts at index {start}.
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
8603 This can be used to find a second match: >
2662
916c90b37ea9 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
8604 :let colon1 = stridx(line, ":")
916c90b37ea9 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
8605 :let colon2 = stridx(line, ":", colon1 + 1)
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
8606 < The search is done case-sensitive.
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
8607 For pattern searches use |match()|.
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
8608 -1 is returned if the {needle} does not occur in {haystack}.
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
8609 See also |strridx()|.
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
8610 Examples: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8611 :echo stridx("An Example", "Example") 3
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8612 :echo stridx("Starting point", "Start") 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8613 :echo stridx("Starting point", "start") -1
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
8614 < *strstr()* *strchr()*
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
8615 stridx() works similar to the C function strstr(). When used
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
8616 with a single character it works similar to strchr().
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
8617
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
8618 *string()*
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
8619 string({expr}) Return {expr} converted to a String. If {expr} is a Number,
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8620 Float, String or a composition of them, then the result can be
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8621 parsed back with |eval()|.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
8622 {expr} type result ~
8748
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
8623 String 'string' (single quotes are doubled)
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
8624 Number 123
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8625 Float 123.123456 or 1.123456e8
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
8626 Funcref function('name')
95
a2081e6febb8 updated for version 7.0037
vimboss
parents: 90
diff changeset
8627 List [item, item]
323
03b3684919e3 updated for version 7.0084
vimboss
parents: 314
diff changeset
8628 Dictionary {key: value, key: value}
8748
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
8629
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
8630 When a List or Dictionary has a recursive reference it is
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
8631 replaced by "[...]" or "{...}". Using eval() on the result
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
8632 will then fail.
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
8633
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
8634 Also see |strtrans()|.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
8635
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8636 *strlen()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8637 strlen({expr}) The result is a Number, which is the length of the String
502
52e76e2b5b65 updated for version 7.0140
vimboss
parents: 493
diff changeset
8638 {expr} in bytes.
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
8639 If the argument is a Number it is first converted to a String.
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
8640 For other types an error is given.
6870
66ab6ec256d1 patch 7.4.755
Bram Moolenaar <bram@vim.org>
parents: 6840
diff changeset
8641 If you want to count the number of multi-byte characters use
66ab6ec256d1 patch 7.4.755
Bram Moolenaar <bram@vim.org>
parents: 6840
diff changeset
8642 |strchars()|.
66ab6ec256d1 patch 7.4.755
Bram Moolenaar <bram@vim.org>
parents: 6840
diff changeset
8643 Also see |len()|, |strdisplaywidth()| and |strwidth()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8644
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8645 strpart({src}, {start} [, {len}]) *strpart()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8646 The result is a String, which is part of {src}, starting from
574
25a70b1cd2da updated for version 7.0163
vimboss
parents: 557
diff changeset
8647 byte {start}, with the byte length {len}.
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8648 To count characters instead of bytes use |strcharpart()|.
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8649
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8650 When bytes are selected which do not exist, this doesn't
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8651 result in an error, the bytes are simply omitted.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8652 If {len} is missing, the copy continues from {start} till the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8653 end of the {src}. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8654 strpart("abcdefg", 3, 2) == "de"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8655 strpart("abcdefg", -2, 4) == "ab"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8656 strpart("abcdefg", 5, 4) == "fg"
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
8657 strpart("abcdefg", 3) == "defg"
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8883
diff changeset
8658
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8659 < Note: To get the first character, {start} must be 0. For
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8660 example, to get three bytes under and after the cursor: >
823
9ab23f1e137f updated for version 7.0c12
vimboss
parents: 819
diff changeset
8661 strpart(getline("."), col(".") - 1, 3)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8662 <
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
8663 strridx({haystack}, {needle} [, {start}]) *strridx()*
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
8664 The result is a Number, which gives the byte index in
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
8665 {haystack} of the last occurrence of the String {needle}.
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
8666 When {start} is specified, matches beyond this index are
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
8667 ignored. This can be used to find a match before a previous
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
8668 match: >
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
8669 :let lastcomma = strridx(line, ",")
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
8670 :let comma2 = strridx(line, ",", lastcomma - 1)
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
8671 < The search is done case-sensitive.
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
8672 For pattern searches use |match()|.
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
8673 -1 is returned if the {needle} does not occur in {haystack}.
22
cc049b00ee70 updated for version 7.0014
vimboss
parents: 20
diff changeset
8674 If the {needle} is empty the length of {haystack} is returned.
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
8675 See also |stridx()|. Examples: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8676 :echo strridx("an angry armadillo", "an") 3
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
8677 < *strrchr()*
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
8678 When used with a single character it works similar to the C
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
8679 function strrchr().
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
8680
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8681 strtrans({expr}) *strtrans()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8682 The result is a String, which is {expr} with all unprintable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8683 characters translated into printable characters |'isprint'|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8684 Like they are shown in a window. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8685 echo strtrans(@a)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8686 < This displays a newline in register a as "^@" instead of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8687 starting a new line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8688
2338
da6ec32d8d8f Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents: 2337
diff changeset
8689 strwidth({expr}) *strwidth()*
da6ec32d8d8f Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents: 2337
diff changeset
8690 The result is a Number, which is the number of display cells
da6ec32d8d8f Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents: 2337
diff changeset
8691 String {expr} occupies. A Tab character is counted as one
2339
01e4b4d37842 Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents: 2338
diff changeset
8692 cell, alternatively use |strdisplaywidth()|.
2338
da6ec32d8d8f Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents: 2337
diff changeset
8693 When {expr} contains characters with East Asian Width Class
da6ec32d8d8f Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents: 2337
diff changeset
8694 Ambiguous, this function's return value depends on 'ambiwidth'.
2339
01e4b4d37842 Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents: 2338
diff changeset
8695 Also see |strlen()|, |strdisplaywidth()| and |strchars()|.
2338
da6ec32d8d8f Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents: 2337
diff changeset
8696
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8697 submatch({nr} [, {list}]) *submatch()* *E935*
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8698 Only for an expression in a |:substitute| command or
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8699 substitute() function.
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8700 Returns the {nr}'th submatch of the matched text. When {nr}
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8701 is 0 the whole matched text is returned.
5794
a63d0cd691dc updated for version 7.4.241
Bram Moolenaar <bram@vim.org>
parents: 5786
diff changeset
8702 Note that a NL in the string can stand for a line break of a
a63d0cd691dc updated for version 7.4.241
Bram Moolenaar <bram@vim.org>
parents: 5786
diff changeset
8703 multi-line match or a NUL character in the text.
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8704 Also see |sub-replace-expression|.
5794
a63d0cd691dc updated for version 7.4.241
Bram Moolenaar <bram@vim.org>
parents: 5786
diff changeset
8705
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8706 If {list} is present and non-zero then submatch() returns
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8707 a list of strings, similar to |getline()| with two arguments.
5794
a63d0cd691dc updated for version 7.4.241
Bram Moolenaar <bram@vim.org>
parents: 5786
diff changeset
8708 NL characters in the text represent NUL characters in the
a63d0cd691dc updated for version 7.4.241
Bram Moolenaar <bram@vim.org>
parents: 5786
diff changeset
8709 text.
a63d0cd691dc updated for version 7.4.241
Bram Moolenaar <bram@vim.org>
parents: 5786
diff changeset
8710 Only returns more than one item for |:substitute|, inside
a63d0cd691dc updated for version 7.4.241
Bram Moolenaar <bram@vim.org>
parents: 5786
diff changeset
8711 |substitute()| this list will always contain one or zero
a63d0cd691dc updated for version 7.4.241
Bram Moolenaar <bram@vim.org>
parents: 5786
diff changeset
8712 items, since there are no real line breaks.
a63d0cd691dc updated for version 7.4.241
Bram Moolenaar <bram@vim.org>
parents: 5786
diff changeset
8713
10245
d76ccdacb41e commit https://github.com/vim/vim/commit/6100d02aab7c8294b581cb299250eea164b50e9d
Christian Brabandt <cb@256bit.org>
parents: 10244
diff changeset
8714 When substitute() is used recursively only the submatches in
d76ccdacb41e commit https://github.com/vim/vim/commit/6100d02aab7c8294b581cb299250eea164b50e9d
Christian Brabandt <cb@256bit.org>
parents: 10244
diff changeset
8715 the current (deepest) call can be obtained.
d76ccdacb41e commit https://github.com/vim/vim/commit/6100d02aab7c8294b581cb299250eea164b50e9d
Christian Brabandt <cb@256bit.org>
parents: 10244
diff changeset
8716
12968
45987b1b77dc Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12909
diff changeset
8717 Examples: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8718 :s/\d\+/\=submatch(0) + 1/
12968
45987b1b77dc Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12909
diff changeset
8719 :echo substitute(text, '\d\+', '\=submatch(0) + 1', '')
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8720 < This finds the first number in the line and adds one to it.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8721 A line break is included as a newline character.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8722
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8723 substitute({expr}, {pat}, {sub}, {flags}) *substitute()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8724 The result is a String, which is a copy of {expr}, in which
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8725 the first match of {pat} is replaced with {sub}.
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8726 When {flags} is "g", all matches of {pat} in {expr} are
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8727 replaced. Otherwise {flags} should be "".
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8728
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8729 This works like the ":substitute" command (without any flags).
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8730 But the matching with {pat} is always done like the 'magic'
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8731 option is set and 'cpoptions' is empty (to make scripts
3967
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3920
diff changeset
8732 portable). 'ignorecase' is still relevant, use |/\c| or |/\C|
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3920
diff changeset
8733 if you want to ignore or match case and ignore 'ignorecase'.
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3920
diff changeset
8734 'smartcase' is not used. See |string-match| for how {pat} is
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3920
diff changeset
8735 used.
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8736
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8737 A "~" in {sub} is not replaced with the previous {sub}.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8738 Note that some codes in {sub} have a special meaning
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
8739 |sub-replace-special|. For example, to replace something with
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8740 "\n" (two characters), use "\\\\n" or '\\n'.
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8741
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8742 When {pat} does not match in {expr}, {expr} is returned
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8743 unmodified.
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8744
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8745 Example: >
9626
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
8746 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8747 < This removes the last component of the 'path' option. >
9626
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
8748 :echo substitute("testing", ".*", "\\U\\0", "")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8749 < results in "TESTING".
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8750
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8751 When {sub} starts with "\=", the remainder is interpreted as
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2902
diff changeset
8752 an expression. See |sub-replace-expression|. Example: >
9626
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
8753 :echo substitute(s, '%\(\x\x\)',
2833
c869ff170ddc Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2826
diff changeset
8754 \ '\=nr2char("0x" . submatch(1))', 'g')
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8755
9626
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
8756 < When {sub} is a Funcref that function is called, with one
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
8757 optional argument. Example: >
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
8758 :echo substitute(s, '%\(\x\x\)', SubNr, 'g')
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
8759 < The optional argument is a list which contains the whole
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
8760 matched string and up to nine submatches, like what
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
8761 |submatch()| returns. Example: >
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
8762 :echo substitute(s, '%\(\x\x\)', {m -> '0x' . m[1]}, 'g')
9626
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
8763
14668
34fd018452ed Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14664
diff changeset
8764 swapinfo({fname}) *swapinfo()*
14599
72d6f6f7ead7 patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents: 14587
diff changeset
8765 The result is a dictionary, which holds information about the
72d6f6f7ead7 patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents: 14587
diff changeset
8766 swapfile {fname}. The available fields are:
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
8767 version Vim version
14599
72d6f6f7ead7 patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents: 14587
diff changeset
8768 user user name
72d6f6f7ead7 patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents: 14587
diff changeset
8769 host host name
72d6f6f7ead7 patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents: 14587
diff changeset
8770 fname original file name
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
8771 pid PID of the Vim process that created the swap
14599
72d6f6f7ead7 patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents: 14587
diff changeset
8772 file
72d6f6f7ead7 patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents: 14587
diff changeset
8773 mtime last modification time in seconds
72d6f6f7ead7 patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents: 14587
diff changeset
8774 inode Optional: INODE number of the file
14601
d0ff19a55579 patch 8.1.0314: build failure without the +eval feature
Christian Brabandt <cb@256bit.org>
parents: 14599
diff changeset
8775 dirty 1 if file was modified, 0 if not
14637
0ecb909e3249 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14601
diff changeset
8776 Note that "user" and "host" are truncated to at most 39 bytes.
14599
72d6f6f7ead7 patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents: 14587
diff changeset
8777 In case of failure an "error" item is added with the reason:
72d6f6f7ead7 patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents: 14587
diff changeset
8778 Cannot open file: file not found or in accessible
72d6f6f7ead7 patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents: 14587
diff changeset
8779 Cannot read file: cannot read first block
14601
d0ff19a55579 patch 8.1.0314: build failure without the +eval feature
Christian Brabandt <cb@256bit.org>
parents: 14599
diff changeset
8780 Not a swap file: does not contain correct block ID
d0ff19a55579 patch 8.1.0314: build failure without the +eval feature
Christian Brabandt <cb@256bit.org>
parents: 14599
diff changeset
8781 Magic number mismatch: Info in first block is invalid
14599
72d6f6f7ead7 patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents: 14587
diff changeset
8782
14778
20653d6f3d95 patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents: 14756
diff changeset
8783 swapname({expr}) *swapname()*
20653d6f3d95 patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents: 14756
diff changeset
8784 The result is the swap file path of the buffer {expr}.
20653d6f3d95 patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents: 14756
diff changeset
8785 For the use of {expr}, see |bufname()| above.
20653d6f3d95 patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents: 14756
diff changeset
8786 If buffer {expr} is the current buffer, the result is equal to
20653d6f3d95 patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents: 14756
diff changeset
8787 |:swapname| (unless no swap file).
20653d6f3d95 patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents: 14756
diff changeset
8788 If buffer {expr} has no swap file, returns an empty string.
20653d6f3d95 patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents: 14756
diff changeset
8789
32
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
8790 synID({lnum}, {col}, {trans}) *synID()*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8791 The result is a Number, which is the syntax ID at the position
32
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
8792 {lnum} and {col} in the current window.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8793 The syntax ID can be used with |synIDattr()| and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8794 |synIDtrans()| to obtain syntax information about text.
419
f713fc55bf7b updated for version 7.0109
vimboss
parents: 401
diff changeset
8795
32
41f9fd58cf13 updated for version 7.0019
vimboss
parents: 29
diff changeset
8796 {col} is 1 for the leftmost column, {lnum} is 1 for the first
419
f713fc55bf7b updated for version 7.0109
vimboss
parents: 401
diff changeset
8797 line. 'synmaxcol' applies, in a longer line zero is returned.
7147
c590de398af9 commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents: 7100
diff changeset
8798 Note that when the position is after the last character,
c590de398af9 commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents: 7100
diff changeset
8799 that's where the cursor can be in Insert mode, synID() returns
c590de398af9 commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents: 7100
diff changeset
8800 zero.
419
f713fc55bf7b updated for version 7.0109
vimboss
parents: 401
diff changeset
8801
9454
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
8802 When {trans} is |TRUE|, transparent items are reduced to the
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
8803 item that they reveal. This is useful when wanting to know
9454
9da0cb39cbee commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents: 9430
diff changeset
8804 the effective color. When {trans} is |FALSE|, the transparent
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8805 item is returned. This is useful when wanting to know which
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8806 syntax item is effective (e.g. inside parens).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8807 Warning: This function can be very slow. Best speed is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8808 obtained by going through the file in forward direction.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8809
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8810 Example (echoes the name of the syntax item under the cursor): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8811 :echo synIDattr(synID(line("."), col("."), 1), "name")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8812 <
2401
e7751177126b Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents: 2350
diff changeset
8813
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8814 synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8815 The result is a String, which is the {what} attribute of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8816 syntax ID {synID}. This can be used to obtain information
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8817 about a syntax item.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8818 {mode} can be "gui", "cterm" or "term", to get the attributes
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
8819 for that mode. When {mode} is omitted, or an invalid value is
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8820 used, the attributes for the currently active highlighting are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8821 used (GUI, cterm or term).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8822 Use synIDtrans() to follow linked highlight groups.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8823 {what} result
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8824 "name" the name of the syntax item
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8825 "fg" foreground color (GUI: color name used to set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8826 the color, cterm: color number as a string,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8827 term: empty string)
1755
0c6c64edcbe0 updated for version 7.2-052
vimboss
parents: 1754
diff changeset
8828 "bg" background color (as with "fg")
2106
15674e198164 updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents: 2072
diff changeset
8829 "font" font name (only available in the GUI)
15674e198164 updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents: 2072
diff changeset
8830 |highlight-font|
1755
0c6c64edcbe0 updated for version 7.2-052
vimboss
parents: 1754
diff changeset
8831 "sp" special color (as with "fg") |highlight-guisp|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8832 "fg#" like "fg", but for the GUI and the GUI is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8833 running the name in "#RRGGBB" form
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8834 "bg#" like "fg#" for "bg"
1755
0c6c64edcbe0 updated for version 7.2-052
vimboss
parents: 1754
diff changeset
8835 "sp#" like "fg#" for "sp"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8836 "bold" "1" if bold
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8837 "italic" "1" if italic
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8838 "reverse" "1" if reverse
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8839 "inverse" "1" if inverse (= reverse)
2106
15674e198164 updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents: 2072
diff changeset
8840 "standout" "1" if standout
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8841 "underline" "1" if underlined
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
8842 "undercurl" "1" if undercurled
12317
2a8890b80923 patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents: 12311
diff changeset
8843 "strike" "1" if strikethrough
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8844
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8845 Example (echoes the color of the syntax item under the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8846 cursor): >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8847 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8848 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8849 synIDtrans({synID}) *synIDtrans()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8850 The result is a Number, which is the translated syntax ID of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8851 {synID}. This is the syntax group ID of what is being used to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8852 highlight the character. Highlight links given with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8853 ":highlight link" are followed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8854
2608
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2596
diff changeset
8855 synconcealed({lnum}, {col}) *synconcealed()*
11553
cbceef33af7a patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents: 11549
diff changeset
8856 The result is a List with currently three items:
cbceef33af7a patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents: 11549
diff changeset
8857 1. The first item in the list is 0 if the character at the
cbceef33af7a patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents: 11549
diff changeset
8858 position {lnum} and {col} is not part of a concealable
cbceef33af7a patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents: 11549
diff changeset
8859 region, 1 if it is.
cbceef33af7a patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents: 11549
diff changeset
8860 2. The second item in the list is a string. If the first item
cbceef33af7a patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents: 11549
diff changeset
8861 is 1, the second item contains the text which will be
cbceef33af7a patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents: 11549
diff changeset
8862 displayed in place of the concealed text, depending on the
cbceef33af7a patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents: 11549
diff changeset
8863 current setting of 'conceallevel' and 'listchars'.
11579
52e3a77c097b patch 8.0.0672: third item of synconcealed() changes too often
Christian Brabandt <cb@256bit.org>
parents: 11561
diff changeset
8864 3. The third and final item in the list is a number
52e3a77c097b patch 8.0.0672: third item of synconcealed() changes too often
Christian Brabandt <cb@256bit.org>
parents: 11561
diff changeset
8865 representing the specific syntax region matched in the
52e3a77c097b patch 8.0.0672: third item of synconcealed() changes too often
Christian Brabandt <cb@256bit.org>
parents: 11561
diff changeset
8866 line. When the character is not concealed the value is
52e3a77c097b patch 8.0.0672: third item of synconcealed() changes too often
Christian Brabandt <cb@256bit.org>
parents: 11561
diff changeset
8867 zero. This allows detection of the beginning of a new
52e3a77c097b patch 8.0.0672: third item of synconcealed() changes too often
Christian Brabandt <cb@256bit.org>
parents: 11561
diff changeset
8868 concealable region if there are two consecutive regions
52e3a77c097b patch 8.0.0672: third item of synconcealed() changes too often
Christian Brabandt <cb@256bit.org>
parents: 11561
diff changeset
8869 with the same replacement character. For an example, if
52e3a77c097b patch 8.0.0672: third item of synconcealed() changes too often
Christian Brabandt <cb@256bit.org>
parents: 11561
diff changeset
8870 the text is "123456" and both "23" and "45" are concealed
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
8871 and replaced by the character "X", then:
11579
52e3a77c097b patch 8.0.0672: third item of synconcealed() changes too often
Christian Brabandt <cb@256bit.org>
parents: 11561
diff changeset
8872 call returns ~
12254
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12252
diff changeset
8873 synconcealed(lnum, 1) [0, '', 0]
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12252
diff changeset
8874 synconcealed(lnum, 2) [1, 'X', 1]
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12252
diff changeset
8875 synconcealed(lnum, 3) [1, 'X', 1]
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12252
diff changeset
8876 synconcealed(lnum, 4) [1, 'X', 2]
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12252
diff changeset
8877 synconcealed(lnum, 5) [1, 'X', 2]
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12252
diff changeset
8878 synconcealed(lnum, 6) [0, '', 0]
2608
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2596
diff changeset
8879
7d8af31066c8 Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2596
diff changeset
8880
1500
ea9f418ed072 updated for version 7.1-215
vimboss
parents: 1496
diff changeset
8881 synstack({lnum}, {col}) *synstack()*
ea9f418ed072 updated for version 7.1-215
vimboss
parents: 1496
diff changeset
8882 Return a |List|, which is the stack of syntax items at the
ea9f418ed072 updated for version 7.1-215
vimboss
parents: 1496
diff changeset
8883 position {lnum} and {col} in the current window. Each item in
ea9f418ed072 updated for version 7.1-215
vimboss
parents: 1496
diff changeset
8884 the List is an ID like what |synID()| returns.
ea9f418ed072 updated for version 7.1-215
vimboss
parents: 1496
diff changeset
8885 The first item in the List is the outer region, following are
ea9f418ed072 updated for version 7.1-215
vimboss
parents: 1496
diff changeset
8886 items contained in that one. The last one is what |synID()|
ea9f418ed072 updated for version 7.1-215
vimboss
parents: 1496
diff changeset
8887 returns, unless not the whole item is highlighted or it is a
ea9f418ed072 updated for version 7.1-215
vimboss
parents: 1496
diff changeset
8888 transparent item.
ea9f418ed072 updated for version 7.1-215
vimboss
parents: 1496
diff changeset
8889 This function is useful for debugging a syntax file.
ea9f418ed072 updated for version 7.1-215
vimboss
parents: 1496
diff changeset
8890 Example that shows the syntax stack under the cursor: >
ea9f418ed072 updated for version 7.1-215
vimboss
parents: 1496
diff changeset
8891 for id in synstack(line("."), col("."))
ea9f418ed072 updated for version 7.1-215
vimboss
parents: 1496
diff changeset
8892 echo synIDattr(id, "name")
ea9f418ed072 updated for version 7.1-215
vimboss
parents: 1496
diff changeset
8893 endfor
2290
22529abcd646 Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents: 2281
diff changeset
8894 < When the position specified with {lnum} and {col} is invalid
22529abcd646 Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents: 2281
diff changeset
8895 nothing is returned. The position just after the last
22529abcd646 Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents: 2281
diff changeset
8896 character in a line and the first column in an empty line are
22529abcd646 Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents: 2281
diff changeset
8897 valid positions.
1500
ea9f418ed072 updated for version 7.1-215
vimboss
parents: 1496
diff changeset
8898
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 22
diff changeset
8899 system({expr} [, {input}]) *system()* *E677*
5808
e5f1f2ea0b4a updated for version 7.4.248
Bram Moolenaar <bram@vim.org>
parents: 5806
diff changeset
8900 Get the output of the shell command {expr} as a string. See
e5f1f2ea0b4a updated for version 7.4.248
Bram Moolenaar <bram@vim.org>
parents: 5806
diff changeset
8901 |systemlist()| to get the output as a List.
5806
76863b4b48a3 updated for version 7.4.247
Bram Moolenaar <bram@vim.org>
parents: 5798
diff changeset
8902
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8903 When {input} is given and is a string this string is written
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8904 to a file and passed as stdin to the command. The string is
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8905 written as-is, you need to take care of using the correct line
5806
76863b4b48a3 updated for version 7.4.247
Bram Moolenaar <bram@vim.org>
parents: 5798
diff changeset
8906 separators yourself.
76863b4b48a3 updated for version 7.4.247
Bram Moolenaar <bram@vim.org>
parents: 5798
diff changeset
8907 If {input} is given and is a |List| it is written to the file
76863b4b48a3 updated for version 7.4.247
Bram Moolenaar <bram@vim.org>
parents: 5798
diff changeset
8908 in a way |writefile()| does with {binary} set to "b" (i.e.
76863b4b48a3 updated for version 7.4.247
Bram Moolenaar <bram@vim.org>
parents: 5798
diff changeset
8909 with a newline between each list item with newlines inside
10522
7232cd9f8a7c commit https://github.com/vim/vim/commit/12c4492dd35e0cd83c8816be2ec849b836109882
Christian Brabandt <cb@256bit.org>
parents: 10449
diff changeset
8910 list items converted to NULs).
7232cd9f8a7c commit https://github.com/vim/vim/commit/12c4492dd35e0cd83c8816be2ec849b836109882
Christian Brabandt <cb@256bit.org>
parents: 10449
diff changeset
8911 When {input} is given and is a number that is a valid id for
7232cd9f8a7c commit https://github.com/vim/vim/commit/12c4492dd35e0cd83c8816be2ec849b836109882
Christian Brabandt <cb@256bit.org>
parents: 10449
diff changeset
8912 an existing buffer then the content of the buffer is written
7232cd9f8a7c commit https://github.com/vim/vim/commit/12c4492dd35e0cd83c8816be2ec849b836109882
Christian Brabandt <cb@256bit.org>
parents: 10449
diff changeset
8913 to the file line by line, each line terminated by a NL and
7232cd9f8a7c commit https://github.com/vim/vim/commit/12c4492dd35e0cd83c8816be2ec849b836109882
Christian Brabandt <cb@256bit.org>
parents: 10449
diff changeset
8914 NULs characters where the text has a NL.
9527
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
8915
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
8916 Pipes are not used, the 'shelltemp' option is not used.
5806
76863b4b48a3 updated for version 7.4.247
Bram Moolenaar <bram@vim.org>
parents: 5798
diff changeset
8917
10038
7cf4e210cf3c commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents: 10027
diff changeset
8918 When prepended by |:silent| the terminal will not be set to
6183
fca35aa9380a updated for version 7.4.427
Bram Moolenaar <bram@vim.org>
parents: 6180
diff changeset
8919 cooked mode. This is meant to be used for commands that do
fca35aa9380a updated for version 7.4.427
Bram Moolenaar <bram@vim.org>
parents: 6180
diff changeset
8920 not need the user to type. It avoids stray characters showing
fca35aa9380a updated for version 7.4.427
Bram Moolenaar <bram@vim.org>
parents: 6180
diff changeset
8921 up on the screen which require |CTRL-L| to remove. >
fca35aa9380a updated for version 7.4.427
Bram Moolenaar <bram@vim.org>
parents: 6180
diff changeset
8922 :silent let f = system('ls *.vim')
fca35aa9380a updated for version 7.4.427
Bram Moolenaar <bram@vim.org>
parents: 6180
diff changeset
8923 <
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8924 Note: Use |shellescape()| or |::S| with |expand()| or
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8925 |fnamemodify()| to escape special characters in a command
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8926 argument. Newlines in {expr} may cause the command to fail.
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8927 The characters in 'shellquote' and 'shellxquote' may also
5690
40f18a1c1592 updated for version 7.4.191
Bram Moolenaar <bram@vim.org>
parents: 5663
diff changeset
8928 cause trouble.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8929 This is not to be used for interactive commands.
1661
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
8930
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8931 The result is a String. Example: >
1661
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
8932 :let files = system("ls " . shellescape(expand('%:h')))
5690
40f18a1c1592 updated for version 7.4.191
Bram Moolenaar <bram@vim.org>
parents: 5663
diff changeset
8933 :let files = system('ls ' . expand('%:h:S'))
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8934
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8935 < To make the result more system-independent, the shell output
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8936 is filtered to replace <CR> with <NL> for Macintosh, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8937 <CR><NL> with <NL> for DOS-like systems.
5277
42bf9264e64e Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5247
diff changeset
8938 To avoid the string being truncated at a NUL, all NUL
42bf9264e64e Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5247
diff changeset
8939 characters are replaced with SOH (0x01).
42bf9264e64e Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5247
diff changeset
8940
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8941 The command executed is constructed using several options:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8942 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8943 ({tmp} is an automatically generated file name).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8944 For Unix and OS/2 braces are put around {expr} to allow for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8945 concatenated commands.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8946
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
8947 The command will be executed in "cooked" mode, so that a
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
8948 CTRL-C will interrupt the command (on Unix at least).
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
8949
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8950 The resulting error code can be found in |v:shell_error|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8951 This function will fail in |restricted-mode|.
625
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 620
diff changeset
8952
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 620
diff changeset
8953 Note that any wrong value in the options mentioned above may
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 620
diff changeset
8954 make the function fail. It has also been reported to fail
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 620
diff changeset
8955 when using a security agent application.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8956 Unlike ":!cmd" there is no automatic check for changed files.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8957 Use |:checktime| to force a check.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8958
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
8959
5808
e5f1f2ea0b4a updated for version 7.4.248
Bram Moolenaar <bram@vim.org>
parents: 5806
diff changeset
8960 systemlist({expr} [, {input}]) *systemlist()*
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8961 Same as |system()|, but returns a |List| with lines (parts of
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8962 output separated by NL) with NULs transformed into NLs. Output
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
8963 is the same as |readfile()| will output with {binary} argument
10548
74effdaa369e Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10522
diff changeset
8964 set to "b". Note that on MS-Windows you may get trailing CR
74effdaa369e Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10522
diff changeset
8965 characters.
5808
e5f1f2ea0b4a updated for version 7.4.248
Bram Moolenaar <bram@vim.org>
parents: 5806
diff changeset
8966
8577
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
8967 Returns an empty string on error.
5808
e5f1f2ea0b4a updated for version 7.4.248
Bram Moolenaar <bram@vim.org>
parents: 5806
diff changeset
8968
e5f1f2ea0b4a updated for version 7.4.248
Bram Moolenaar <bram@vim.org>
parents: 5806
diff changeset
8969
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8970 tabpagebuflist([{arg}]) *tabpagebuflist()*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
8971 The result is a |List|, where each item is the number of the
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8972 buffer associated with each window in the current tab page.
9887
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
8973 {arg} specifies the number of the tab page to be used. When
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8974 omitted the current tab page is used.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8975 When {arg} is invalid the number zero is returned.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8976 To get a list of all buffers in all tabs use this: >
3445
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3410
diff changeset
8977 let buflist = []
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8978 for i in range(tabpagenr('$'))
3445
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3410
diff changeset
8979 call extend(buflist, tabpagebuflist(i + 1))
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8980 endfor
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8981 < Note that a buffer may appear in more than one window.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8982
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8983
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8984 tabpagenr([{arg}]) *tabpagenr()*
674
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
8985 The result is a Number, which is the number of the current
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
8986 tab page. The first tab page has number 1.
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
8987 When the optional argument is "$", the number of the last tab
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
8988 page is returned (the tab page count).
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
8989 The number can be used with the |:tab| command.
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
8990
4b8583e82cb8 updated for version 7.0201
vimboss
parents: 667
diff changeset
8991
5763
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5747
diff changeset
8992 tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()*
2569
f612f6b0b883 Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
8993 Like |winnr()| but for tab page {tabarg}.
677
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8994 {tabarg} specifies the number of tab page to be used.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8995 {arg} is used like with |winnr()|:
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8996 - When omitted the current window number is returned. This is
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8997 the window which will be used when going to this tab page.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8998 - When "$" the number of windows is returned.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
8999 - When "#" the previous window nr is returned.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
9000 Useful examples: >
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
9001 tabpagewinnr(1) " current window of tab page 1
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
9002 tabpagewinnr(4, '$') " number of windows in tab page 4
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
9003 < When {tabarg} is invalid zero is returned.
e649c78407e6 updated for version 7.0202
vimboss
parents: 674
diff changeset
9004
805
497fab3f99d6 updated for version 7.0b01
vimboss
parents: 800
diff changeset
9005 *tagfiles()*
497fab3f99d6 updated for version 7.0b01
vimboss
parents: 800
diff changeset
9006 tagfiles() Returns a |List| with the file names used to search for tags
497fab3f99d6 updated for version 7.0b01
vimboss
parents: 800
diff changeset
9007 for the current buffer. This is the 'tags' option expanded.
497fab3f99d6 updated for version 7.0b01
vimboss
parents: 800
diff changeset
9008
497fab3f99d6 updated for version 7.0b01
vimboss
parents: 800
diff changeset
9009
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
9010 taglist({expr} [, {filename}]) *taglist()*
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
9011 Returns a list of tags matching the regular expression {expr}.
11225
d3415ec1cdaf patch 8.0.0499: taglist() does not prioritize tags for a buffer
Christian Brabandt <cb@256bit.org>
parents: 11211
diff changeset
9012
d3415ec1cdaf patch 8.0.0499: taglist() does not prioritize tags for a buffer
Christian Brabandt <cb@256bit.org>
parents: 11211
diff changeset
9013 If {filename} is passed it is used to prioritize the results
d3415ec1cdaf patch 8.0.0499: taglist() does not prioritize tags for a buffer
Christian Brabandt <cb@256bit.org>
parents: 11211
diff changeset
9014 in the same way that |:tselect| does. See |tag-priority|.
d3415ec1cdaf patch 8.0.0499: taglist() does not prioritize tags for a buffer
Christian Brabandt <cb@256bit.org>
parents: 11211
diff changeset
9015 {filename} should be the full path of the file.
d3415ec1cdaf patch 8.0.0499: taglist() does not prioritize tags for a buffer
Christian Brabandt <cb@256bit.org>
parents: 11211
diff changeset
9016
438
59b7b7e99c95 updated for version 7.0113
vimboss
parents: 435
diff changeset
9017 Each list item is a dictionary with at least the following
59b7b7e99c95 updated for version 7.0113
vimboss
parents: 435
diff changeset
9018 entries:
648
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
9019 name Name of the tag.
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
9020 filename Name of the file where the tag is
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9021 defined. It is either relative to the
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9022 current directory or a full path.
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
9023 cmd Ex command used to locate the tag in
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
9024 the file.
648
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
9025 kind Type of the tag. The value for this
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
9026 entry depends on the language specific
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9027 kind values. Only available when
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9028 using a tags file generated by
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9029 Exuberant ctags or hdrtag.
648
9032e4668296 updated for version 7.0189
vimboss
parents: 647
diff changeset
9030 static A file specific tag. Refer to
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
9031 |static-tag| for more information.
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9032 More entries may be present, depending on the content of the
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9033 tags file: access, implementation, inherits and signature.
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9034 Refer to the ctags documentation for information about these
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9035 fields. For C code the fields "struct", "class" and "enum"
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9036 may appear, they give the name of the entity the tag is
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9037 contained in.
452
01af1008a8d8 updated for version 7.0120
vimboss
parents: 449
diff changeset
9038
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 11032
diff changeset
9039 The ex-command "cmd" can be either an ex search pattern, a
216
da182deebec7 updated for version 7.0061
vimboss
parents: 205
diff changeset
9040 line number or a line number followed by a byte number.
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
9041
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
9042 If there are no matching tags, then an empty list is returned.
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
9043
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
9044 To get an exact tag match, the anchors '^' and '$' should be
4073
e362db8b2d7b Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4051
diff changeset
9045 used in {expr}. This also make the function work faster.
e362db8b2d7b Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4051
diff changeset
9046 Refer to |tag-regexp| for more information about the tag
e362db8b2d7b Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4051
diff changeset
9047 search regular expression pattern.
205
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
9048
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
9049 Refer to |'tags'| for information about how the tags file is
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
9050 located by Vim. Refer to |tags-file-format| for the format of
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
9051 the tags file generated by the different ctags tools.
d292c40ca788 updated for version 7.0060
vimboss
parents: 189
diff changeset
9052
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9053 tan({expr}) *tan()*
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
9054 Return the tangent of {expr}, measured in radians, as a |Float|
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9055 in the range [-inf, inf].
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
9056 {expr} must evaluate to a |Float| or a |Number|.
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9057 Examples: >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9058 :echo tan(10)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9059 < 0.648361 >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9060 :echo tan(-4.01)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9061 < -1.181502
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
9062 {only available when compiled with the |+float| feature}
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9063
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9064
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9065 tanh({expr}) *tanh()*
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
9066 Return the hyperbolic tangent of {expr} as a |Float| in the
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9067 range [-1, 1].
2337
a0f87fc19d1d Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents: 2320
diff changeset
9068 {expr} must evaluate to a |Float| or a |Number|.
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9069 Examples: >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9070 :echo tanh(0.5)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9071 < 0.462117 >
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9072 :echo tanh(-1)
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9073 < -0.761594
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2569
diff changeset
9074 {only available when compiled with the |+float| feature}
2206
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9075
a8afba7027ae Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
9076
9108
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9077 tempname() *tempname()* *temp-file-name*
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9078 The result is a String, which is the name of a file that
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
9079 doesn't exist. It can be used for a temporary file. The name
9108
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9080 is different for at least 26 consecutive calls. Example: >
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9081 :let tmpfile = tempname()
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9082 :exe "redir > " . tmpfile
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9083 < For Unix, the file will be in a private directory |tempfile|.
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9084 For MS-Windows forward slashes are used when the 'shellslash'
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9085 option is set or when 'shellcmdflag' starts with '-'.
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9086
13298
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9087 *term_dumpdiff()*
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9088 term_dumpdiff({filename}, {filename} [, {options}])
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9089 Open a new window displaying the difference between the two
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9090 files. The files must have been created with
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9091 |term_dumpwrite()|.
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9092 Returns the buffer number or zero when the diff fails.
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9093 Also see |terminal-diff|.
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9094 NOTE: this does not work with double-width characters yet.
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9095
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9096 The top part of the buffer contains the contents of the first
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9097 file, the bottom part of the buffer contains the contents of
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9098 the second file. The middle part shows the differences.
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
9099 The parts are separated by a line of equals.
13298
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9100
13501
a4a559e08798 patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents: 13482
diff changeset
9101 If the {options} argument is present, it must be a Dict with
a4a559e08798 patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents: 13482
diff changeset
9102 these possible members:
a4a559e08798 patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents: 13482
diff changeset
9103 "term_name" name to use for the buffer name, instead
a4a559e08798 patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents: 13482
diff changeset
9104 of the first file name.
a4a559e08798 patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents: 13482
diff changeset
9105 "term_rows" vertical size to use for the terminal,
13735
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13678
diff changeset
9106 instead of using 'termwinsize'
13501
a4a559e08798 patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents: 13482
diff changeset
9107 "term_cols" horizontal size to use for the terminal,
13735
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13678
diff changeset
9108 instead of using 'termwinsize'
13501
a4a559e08798 patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents: 13482
diff changeset
9109 "vertical" split the window vertically
a4a559e08798 patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents: 13482
diff changeset
9110 "curwin" use the current window, do not split the
a4a559e08798 patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents: 13482
diff changeset
9111 window; fails if the current buffer
a4a559e08798 patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents: 13482
diff changeset
9112 cannot be |abandon|ed
a4a559e08798 patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents: 13482
diff changeset
9113 "norestore" do not add the terminal window to a
a4a559e08798 patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents: 13482
diff changeset
9114 session file
13298
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9115
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9116 Each character in the middle part indicates a difference. If
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9117 there are multiple differences only the first in this list is
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9118 used:
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9119 X different character
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9120 w different width
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9121 f different foreground color
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9122 b different background color
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9123 a different attribute
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9124 + missing position in first file
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9125 - missing position in second file
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9126
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9127 Using the "s" key the top and bottom parts are swapped. This
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9128 makes it easy to spot a difference.
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9129
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9130 *term_dumpload()*
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9131 term_dumpload({filename} [, {options}])
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9132 Open a new window displaying the contents of {filename}
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9133 The file must have been created with |term_dumpwrite()|.
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9134 Returns the buffer number or zero when it fails.
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9135 Also see |terminal-diff|.
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9136
13501
a4a559e08798 patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents: 13482
diff changeset
9137 For {options} see |term_dumpdiff()|.
13298
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9138
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9139 *term_dumpwrite()*
13329
424321d6eea7 patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents: 13298
diff changeset
9140 term_dumpwrite({buf}, {filename} [, {options}])
13298
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9141 Dump the contents of the terminal screen of {buf} in the file
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9142 {filename}. This uses a format that can be used with
13341
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13329
diff changeset
9143 |term_dumpload()| and |term_dumpdiff()|.
14695
b178e2039b2d Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14673
diff changeset
9144 If the job in the terminal already finished an error is given:
b178e2039b2d Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14673
diff changeset
9145 *E958*
b178e2039b2d Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14673
diff changeset
9146 If {filename} already exists an error is given: *E953*
13298
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9147 Also see |terminal-diff|.
a88c5e12b860 patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents: 13280
diff changeset
9148
13329
424321d6eea7 patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents: 13298
diff changeset
9149 {options} is a dictionary with these optional entries:
424321d6eea7 patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents: 13298
diff changeset
9150 "rows" maximum number of rows to dump
424321d6eea7 patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents: 13298
diff changeset
9151 "columns" maximum number of columns to dump
424321d6eea7 patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents: 13298
diff changeset
9152
12035
a3ed3d236839 patch 8.0.0898: can't use the alternate screen in a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12031
diff changeset
9153 term_getaltscreen({buf}) *term_getaltscreen()*
a3ed3d236839 patch 8.0.0898: can't use the alternate screen in a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12031
diff changeset
9154 Returns 1 if the terminal of {buf} is using the alternate
a3ed3d236839 patch 8.0.0898: can't use the alternate screen in a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12031
diff changeset
9155 screen.
a3ed3d236839 patch 8.0.0898: can't use the alternate screen in a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12031
diff changeset
9156 {buf} is used as with |term_getsize()|.
a3ed3d236839 patch 8.0.0898: can't use the alternate screen in a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12031
diff changeset
9157 {only available when compiled with the |+terminal| feature}
a3ed3d236839 patch 8.0.0898: can't use the alternate screen in a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12031
diff changeset
9158
13626
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9159 term_getansicolors({buf}) *term_getansicolors()*
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9160 Get the ANSI color palette in use by terminal {buf}.
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9161 Returns a List of length 16 where each element is a String
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9162 representing a color in hexadecimal "#rrggbb" format.
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9163 Also see |term_setansicolors()| and |g:terminal_ansi_colors|.
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9164 If neither was used returns the default colors.
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9165
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9166 {buf} is used as with |term_getsize()|. If the buffer does not
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9167 exist or is not a terminal window, an empty list is returned.
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9168 {only available when compiled with the |+terminal| feature and
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9169 with GUI enabled and/or the |+termguicolors| feature}
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9170
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9171 term_getattr({attr}, {what}) *term_getattr()*
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9172 Given {attr}, a value returned by term_scrape() in the "attr"
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9173 item, return whether {what} is on. {what} can be one of:
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9174 bold
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9175 italic
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9176 underline
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9177 strike
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9178 reverse
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9179 {only available when compiled with the |+terminal| feature}
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9180
11876
3704ca24c9a2 patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11874
diff changeset
9181 term_getcursor({buf}) *term_getcursor()*
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9182 Get the cursor position of terminal {buf}. Returns a list with
12499
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12465
diff changeset
9183 two numbers and a dictionary: [row, col, dict].
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12465
diff changeset
9184
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12465
diff changeset
9185 "row" and "col" are one based, the first screen cell is row
12076
ca4931a20f8c patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents: 12072
diff changeset
9186 1, column 1. This is the cursor position of the terminal
ca4931a20f8c patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents: 12072
diff changeset
9187 itself, not of the Vim window.
ca4931a20f8c patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents: 12072
diff changeset
9188
ca4931a20f8c patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents: 12072
diff changeset
9189 "dict" can have these members:
ca4931a20f8c patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents: 12072
diff changeset
9190 "visible" one when the cursor is visible, zero when it
ca4931a20f8c patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents: 12072
diff changeset
9191 is hidden.
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
9192 "blink" one when the cursor is blinking, zero when it
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
9193 is not blinking.
12076
ca4931a20f8c patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents: 12072
diff changeset
9194 "shape" 1 for a block cursor, 2 for underline and 3
ca4931a20f8c patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents: 12072
diff changeset
9195 for a vertical bar.
11876
3704ca24c9a2 patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11874
diff changeset
9196
3704ca24c9a2 patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11874
diff changeset
9197 {buf} must be the buffer number of a terminal window. If the
3704ca24c9a2 patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11874
diff changeset
9198 buffer does not exist or is not a terminal window, an empty
3704ca24c9a2 patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11874
diff changeset
9199 list is returned.
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9200 {only available when compiled with the |+terminal| feature}
11876
3704ca24c9a2 patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11874
diff changeset
9201
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9202 term_getjob({buf}) *term_getjob()*
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9203 Get the Job associated with terminal window {buf}.
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9204 {buf} is used as with |term_getsize()|.
11933
d033653d3df8 patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents: 11904
diff changeset
9205 Returns |v:null| when there is no job.
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9206 {only available when compiled with the |+terminal| feature}
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9207
11904
40322e8f07e7 patch 8.0.0832: terminal function arguments are not consistent
Christian Brabandt <cb@256bit.org>
parents: 11882
diff changeset
9208 term_getline({buf}, {row}) *term_getline()*
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9209 Get a line of text from the terminal window of {buf}.
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9210 {buf} is used as with |term_getsize()|.
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9211
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9212 The first line has {row} one. When {row} is "." the cursor
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9213 line is used. When {row} is invalid an empty string is
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9214 returned.
13438
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9215
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9216 To get attributes of each character use |term_scrape()|.
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9217 {only available when compiled with the |+terminal| feature}
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9218
12025
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
9219 term_getscrolled({buf}) *term_getscrolled()*
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
9220 Return the number of lines that scrolled to above the top of
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
9221 terminal {buf}. This is the offset between the row number
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
9222 used for |term_getline()| and |getline()|, so that: >
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
9223 term_getline(buf, N)
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
9224 < is equal to: >
14864
40ef13331e02 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14778
diff changeset
9225 getline(N + term_getscrolled(buf))
12025
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
9226 < (if that line exists).
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
9227
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
9228 {buf} is used as with |term_getsize()|.
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
9229 {only available when compiled with the |+terminal| feature}
c0ee48f48a2b patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 12007
diff changeset
9230
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9231 term_getsize({buf}) *term_getsize()*
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9232 Get the size of terminal {buf}. Returns a list with two
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9233 numbers: [rows, cols]. This is the size of the terminal, not
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9234 the window containing the terminal.
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9235
11933
d033653d3df8 patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents: 11904
diff changeset
9236 {buf} must be the buffer number of a terminal window. Use an
d033653d3df8 patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents: 11904
diff changeset
9237 empty string for the current buffer. If the buffer does not
d033653d3df8 patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents: 11904
diff changeset
9238 exist or is not a terminal window, an empty list is returned.
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9239 {only available when compiled with the |+terminal| feature}
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9240
11882
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9241 term_getstatus({buf}) *term_getstatus()*
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9242 Get the status of terminal {buf}. This returns a comma
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9243 separated list of these items:
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9244 running job is running
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9245 finished job has finished
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9246 normal in Terminal-Normal mode
11882
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9247 One of "running" or "finished" is always present.
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9248
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9249 {buf} must be the buffer number of a terminal window. If the
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9250 buffer does not exist or is not a terminal window, an empty
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9251 string is returned.
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9252 {only available when compiled with the |+terminal| feature}
11882
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9253
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9254 term_gettitle({buf}) *term_gettitle()*
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9255 Get the title of terminal {buf}. This is the title that the
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9256 job in the terminal has set.
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9257
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9258 {buf} must be the buffer number of a terminal window. If the
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9259 buffer does not exist or is not a terminal window, an empty
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9260 string is returned.
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9261 {only available when compiled with the |+terminal| feature}
11882
69e7379f46db patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 11876
diff changeset
9262
12389
d0cf7f71b95b patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents: 12337
diff changeset
9263 term_gettty({buf} [, {input}]) *term_gettty()*
11933
d033653d3df8 patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents: 11904
diff changeset
9264 Get the name of the controlling terminal associated with
12389
d0cf7f71b95b patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents: 12337
diff changeset
9265 terminal window {buf}. {buf} is used as with |term_getsize()|.
d0cf7f71b95b patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents: 12337
diff changeset
9266
d0cf7f71b95b patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents: 12337
diff changeset
9267 When {input} is omitted or 0, return the name for writing
d0cf7f71b95b patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents: 12337
diff changeset
9268 (stdout). When {input} is 1 return the name for reading
d0cf7f71b95b patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents: 12337
diff changeset
9269 (stdin). On UNIX, both return same name.
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9270 {only available when compiled with the |+terminal| feature}
11933
d033653d3df8 patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents: 11904
diff changeset
9271
11874
d444e087b8fd patch 8.0.0817: cannot get the terminal line at the cursor
Christian Brabandt <cb@256bit.org>
parents: 11846
diff changeset
9272 term_list() *term_list()*
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9273 Return a list with the buffer numbers of all buffers for
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9274 terminal windows.
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9275 {only available when compiled with the |+terminal| feature}
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9276
11904
40322e8f07e7 patch 8.0.0832: terminal function arguments are not consistent
Christian Brabandt <cb@256bit.org>
parents: 11882
diff changeset
9277 term_scrape({buf}, {row}) *term_scrape()*
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9278 Get the contents of {row} of terminal screen of {buf}.
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9279 For {buf} see |term_getsize()|.
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9280
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9281 The first line has {row} one. When {row} is "." the cursor
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9282 line is used. When {row} is invalid an empty string is
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9283 returned.
11874
d444e087b8fd patch 8.0.0817: cannot get the terminal line at the cursor
Christian Brabandt <cb@256bit.org>
parents: 11846
diff changeset
9284
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
9285 Return a List containing a Dict for each screen cell:
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9286 "chars" character(s) at the cell
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9287 "fg" foreground color as #rrggbb
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9288 "bg" background color as #rrggbb
11933
d033653d3df8 patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents: 11904
diff changeset
9289 "attr" attributes of the cell, use |term_getattr()|
12076
ca4931a20f8c patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents: 12072
diff changeset
9290 to get the individual flags
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9291 "width" cell width: 1 or 2
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9292 {only available when compiled with the |+terminal| feature}
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9293
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9294 term_sendkeys({buf}, {keys}) *term_sendkeys()*
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9295 Send keystrokes {keys} to terminal {buf}.
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9296 {buf} is used as with |term_getsize()|.
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9297
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9298 {keys} are translated as key sequences. For example, "\<c-x>"
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9299 means the character CTRL-X.
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9300 {only available when compiled with the |+terminal| feature}
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9301
13626
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9302 term_setansicolors({buf}, {colors}) *term_setansicolors()*
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9303 Set the ANSI color palette used by terminal {buf}.
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9304 {colors} must be a List of 16 valid color names or hexadecimal
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9305 color codes, like those accepted by |highlight-guifg|.
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9306 Also see |term_getansicolors()| and |g:terminal_ansi_colors|.
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9307
13678
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9308 The colors normally are:
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9309 0 black
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9310 1 dark red
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9311 2 dark green
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9312 3 brown
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9313 4 dark blue
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9314 5 dark magenta
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9315 6 dark cyan
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9316 7 light grey
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9317 8 dark grey
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9318 9 red
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9319 10 green
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9320 11 yellow
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9321 12 blue
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9322 13 magenta
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9323 14 cyan
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9324 15 white
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9325
13626
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9326 These colors are used in the GUI and in the terminal when
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9327 'termguicolors' is set. When not using GUI colors (GUI mode
13735
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13678
diff changeset
9328 or 'termguicolors'), the terminal window always uses the 16
13626
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9329 ANSI colors of the underlying terminal.
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9330 {only available when compiled with the |+terminal| feature and
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9331 with GUI enabled and/or the |+termguicolors| feature}
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9332
13438
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9333 term_setkill({buf}, {how}) *term_setkill()*
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9334 When exiting Vim or trying to close the terminal window in
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9335 another way, {how} defines whether the job in the terminal can
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9336 be stopped.
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9337 When {how} is empty (the default), the job will not be
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9338 stopped, trying to exit will result in |E947|.
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9339 Otherwise, {how} specifies what signal to send to the job.
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9340 See |job_stop()| for the values.
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9341
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9342 After sending the signal Vim will wait for up to a second to
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9343 check that the job actually stopped.
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9344
13437
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
9345 term_setrestore({buf}, {command}) *term_setrestore()*
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
9346 Set the command to write in a session file to restore the job
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
9347 in this terminal. The line written in the session file is: >
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
9348 terminal ++curwin ++cols=%d ++rows=%d {command}
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
9349 < Make sure to escape the command properly.
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
9350
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
9351 Use an empty {command} to run 'shell'.
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
9352 Use "NONE" to not restore this window.
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
9353 {only available when compiled with the |+terminal| feature}
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
9354
13735
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13678
diff changeset
9355 term_setsize({buf}, {rows}, {cols}) *term_setsize()* *E955*
13678
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9356 Set the size of terminal {buf}. The size of the window
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9357 containing the terminal will also be adjusted, if possible.
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9358 If {rows} or {cols} is zero or negative, that dimension is not
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9359 changed.
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9360
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9361 {buf} must be the buffer number of a terminal window. Use an
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9362 empty string for the current buffer. If the buffer does not
39fcaaa973db patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents: 13672
diff changeset
9363 exist or is not a terminal window, an error is given.
12499
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12465
diff changeset
9364 {only available when compiled with the |+terminal| feature}
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12465
diff changeset
9365
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9366 term_start({cmd}, {options}) *term_start()*
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9367 Open a terminal window and run {cmd} in it.
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9368
12756
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
9369 {cmd} can be a string or a List, like with |job_start()|. The
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
9370 string "NONE" can be used to open a terminal window without
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
9371 starting a job, the pty of the terminal can be used by a
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
9372 command like gdb.
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
9373
12056
0498547dace0 patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents: 12048
diff changeset
9374 Returns the buffer number of the terminal window. If {cmd}
0498547dace0 patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents: 12048
diff changeset
9375 cannot be executed the window does open and shows an error
0498547dace0 patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents: 12048
diff changeset
9376 message.
0498547dace0 patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents: 12048
diff changeset
9377 If opening the window fails zero is returned.
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9378
11967
12833414cc02 patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11933
diff changeset
9379 {options} are similar to what is used for |job_start()|, see
12833414cc02 patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11933
diff changeset
9380 |job-options|. However, not all options can be used. These
12833414cc02 patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11933
diff changeset
9381 are supported:
12833414cc02 patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11933
diff changeset
9382 all timeout options
14519
5c5908e81e93 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14422
diff changeset
9383 "stoponexit", "cwd", "env"
5c5908e81e93 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14422
diff changeset
9384 "callback", "out_cb", "err_cb", "exit_cb", "close_cb"
11967
12833414cc02 patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11933
diff changeset
9385 "in_io", "in_top", "in_bot", "in_name", "in_buf"
12833414cc02 patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11933
diff changeset
9386 "out_io", "out_name", "out_buf", "out_modifiable", "out_msg"
12833414cc02 patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11933
diff changeset
9387 "err_io", "err_name", "err_buf", "err_modifiable", "err_msg"
12833414cc02 patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11933
diff changeset
9388 However, at least one of stdin, stdout or stderr must be
12833414cc02 patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11933
diff changeset
9389 connected to the terminal. When I/O is connected to the
12833414cc02 patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11933
diff changeset
9390 terminal then the callback function for that part is not used.
12833414cc02 patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents: 11933
diff changeset
9391
12056
0498547dace0 patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents: 12048
diff changeset
9392 There are extra options:
12031
9897241c08b5 patch 8.0.0896: cannot close a terminal window when the job ends
Christian Brabandt <cb@256bit.org>
parents: 12025
diff changeset
9393 "term_name" name to use for the buffer name, instead
9897241c08b5 patch 8.0.0896: cannot close a terminal window when the job ends
Christian Brabandt <cb@256bit.org>
parents: 12025
diff changeset
9394 of the command name.
12056
0498547dace0 patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents: 12048
diff changeset
9395 "term_rows" vertical size to use for the terminal,
13735
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13678
diff changeset
9396 instead of using 'termwinsize'
12056
0498547dace0 patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents: 12048
diff changeset
9397 "term_cols" horizontal size to use for the terminal,
13735
a62eeee5f116 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13678
diff changeset
9398 instead of using 'termwinsize'
14103
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
9399 "vertical" split the window vertically; note that
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
9400 other window position can be defined with
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
9401 command modifiers, such as |:belowright|.
12060
a879814b8a37 patch 8.0.0910: cannot create a terminal in the current window
Christian Brabandt <cb@256bit.org>
parents: 12056
diff changeset
9402 "curwin" use the current window, do not split the
a879814b8a37 patch 8.0.0910: cannot create a terminal in the current window
Christian Brabandt <cb@256bit.org>
parents: 12056
diff changeset
9403 window; fails if the current buffer
a879814b8a37 patch 8.0.0910: cannot create a terminal in the current window
Christian Brabandt <cb@256bit.org>
parents: 12056
diff changeset
9404 cannot be |abandon|ed
12427
fc3e2d5614dd patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents: 12389
diff changeset
9405 "hidden" do not open a window
13437
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
9406 "norestore" do not add the terminal window to a
02b3f719eacb Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13379
diff changeset
9407 session file
13438
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9408 "term_kill" what to do when trying to close the
33eea5ce5415 patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents: 13437
diff changeset
9409 terminal window, see |term_setkill()|
12056
0498547dace0 patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents: 12048
diff changeset
9410 "term_finish" What to do when the job is finished:
12031
9897241c08b5 patch 8.0.0896: cannot close a terminal window when the job ends
Christian Brabandt <cb@256bit.org>
parents: 12025
diff changeset
9411 "close": close any windows
9897241c08b5 patch 8.0.0896: cannot close a terminal window when the job ends
Christian Brabandt <cb@256bit.org>
parents: 12025
diff changeset
9412 "open": open window if needed
9897241c08b5 patch 8.0.0896: cannot close a terminal window when the job ends
Christian Brabandt <cb@256bit.org>
parents: 12025
diff changeset
9413 Note that "open" can be interruptive.
9897241c08b5 patch 8.0.0896: cannot close a terminal window when the job ends
Christian Brabandt <cb@256bit.org>
parents: 12025
diff changeset
9414 See |term++close| and |term++open|.
12072
f4e1e1e6886b patch 8.0.0916: cannot specify properties of window for terminal open
Christian Brabandt <cb@256bit.org>
parents: 12060
diff changeset
9415 "term_opencmd" command to use for opening the window when
f4e1e1e6886b patch 8.0.0916: cannot specify properties of window for terminal open
Christian Brabandt <cb@256bit.org>
parents: 12060
diff changeset
9416 "open" is used for "term_finish"; must
f4e1e1e6886b patch 8.0.0916: cannot specify properties of window for terminal open
Christian Brabandt <cb@256bit.org>
parents: 12060
diff changeset
9417 have "%d" where the buffer number goes,
f4e1e1e6886b patch 8.0.0916: cannot specify properties of window for terminal open
Christian Brabandt <cb@256bit.org>
parents: 12060
diff changeset
9418 e.g. "10split|buffer %d"; when not
f4e1e1e6886b patch 8.0.0916: cannot specify properties of window for terminal open
Christian Brabandt <cb@256bit.org>
parents: 12060
diff changeset
9419 specified "botright sbuf %d" is used
12311
66fa8eabbd6e patch 8.0.1035: sending buffer lines to terminal doesn't work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents: 12303
diff changeset
9420 "eof_chars" Text to send after all buffer lines were
66fa8eabbd6e patch 8.0.1035: sending buffer lines to terminal doesn't work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents: 12303
diff changeset
9421 written to the terminal. When not set
12389
d0cf7f71b95b patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents: 12337
diff changeset
9422 CTRL-D is used on MS-Windows. For Python
d0cf7f71b95b patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents: 12337
diff changeset
9423 use CTRL-Z or "exit()". For a shell use
d0cf7f71b95b patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents: 12337
diff changeset
9424 "exit". A CR is always added.
13626
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9425 "ansi_colors" A list of 16 color names or hex codes
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9426 defining the ANSI palette used in GUI
ab89131d30e0 patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents: 13563
diff changeset
9427 color modes. See |g:terminal_ansi_colors|.
12072
f4e1e1e6886b patch 8.0.0916: cannot specify properties of window for terminal open
Christian Brabandt <cb@256bit.org>
parents: 12060
diff changeset
9428
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9429 {only available when compiled with the |+terminal| feature}
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9430
12007
64b822c4f7ae patch 8.0.0884: can't specify the wait time for term_wait()
Christian Brabandt <cb@256bit.org>
parents: 12003
diff changeset
9431 term_wait({buf} [, {time}]) *term_wait()*
11846
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9432 Wait for pending updates of {buf} to be handled.
1c65cad8b967 patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents: 11828
diff changeset
9433 {buf} is used as with |term_getsize()|.
12007
64b822c4f7ae patch 8.0.0884: can't specify the wait time for term_wait()
Christian Brabandt <cb@256bit.org>
parents: 12003
diff changeset
9434 {time} is how long to wait for updates to arrive in msec. If
64b822c4f7ae patch 8.0.0884: can't specify the wait time for term_wait()
Christian Brabandt <cb@256bit.org>
parents: 12003
diff changeset
9435 not set then 10 msec will be used.
12003
6889f1f25d6b patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents: 11995
diff changeset
9436 {only available when compiled with the |+terminal| feature}
9108
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9437
9121
7350959e53c3 commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents: 9117
diff changeset
9438 test_alloc_fail({id}, {countdown}, {repeat}) *test_alloc_fail()*
7350959e53c3 commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents: 9117
diff changeset
9439 This is for testing: If the memory allocation with {id} is
7350959e53c3 commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents: 9117
diff changeset
9440 called, then decrement {countdown}, and when it reaches zero
7350959e53c3 commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents: 9117
diff changeset
9441 let memory allocation fail {repeat} times. When {repeat} is
7350959e53c3 commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents: 9117
diff changeset
9442 smaller than one it fails one time.
7350959e53c3 commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents: 9117
diff changeset
9443
9644
9f7bcc2c3b97 commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents: 9636
diff changeset
9444 test_autochdir() *test_autochdir()*
9f7bcc2c3b97 commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents: 9636
diff changeset
9445 Set a flag to enable the effect of 'autochdir' before Vim
9f7bcc2c3b97 commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents: 9636
diff changeset
9446 startup has finished.
9f7bcc2c3b97 commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents: 9636
diff changeset
9447
12337
040a892d0eed patch 8.0.1048: no test for what 8.0.1020 fixes
Christian Brabandt <cb@256bit.org>
parents: 12321
diff changeset
9448 test_feedinput({string}) *test_feedinput()*
040a892d0eed patch 8.0.1048: no test for what 8.0.1020 fixes
Christian Brabandt <cb@256bit.org>
parents: 12321
diff changeset
9449 Characters in {string} are queued for processing as if they
040a892d0eed patch 8.0.1048: no test for what 8.0.1020 fixes
Christian Brabandt <cb@256bit.org>
parents: 12321
diff changeset
9450 were typed by the user. This uses a low level input buffer.
040a892d0eed patch 8.0.1048: no test for what 8.0.1020 fixes
Christian Brabandt <cb@256bit.org>
parents: 12321
diff changeset
9451 This function works only when with |+unix| or GUI is running.
040a892d0eed patch 8.0.1048: no test for what 8.0.1020 fixes
Christian Brabandt <cb@256bit.org>
parents: 12321
diff changeset
9452
9108
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9453 test_garbagecollect_now() *test_garbagecollect_now()*
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9454 Like garbagecollect(), but executed right away. This must
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9455 only be called directly to avoid any structure to exist
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9456 internally, and |v:testing| must have been set before calling
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9457 any function.
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9458
11006
b3601a8eb679 patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents: 10908
diff changeset
9459 test_ignore_error({expr}) *test_ignore_error()*
b3601a8eb679 patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents: 10908
diff changeset
9460 Ignore any error containing {expr}. A normal message is given
b3601a8eb679 patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents: 10908
diff changeset
9461 instead.
b3601a8eb679 patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents: 10908
diff changeset
9462 This is only meant to be used in tests, where catching the
b3601a8eb679 patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents: 10908
diff changeset
9463 error with try/catch cannot be used (because it skips over
b3601a8eb679 patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents: 10908
diff changeset
9464 following code).
b3601a8eb679 patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents: 10908
diff changeset
9465 {expr} is used literally, not as a pattern.
15219
dada0b389d4f patch 8.1.0619: :echomsg and :echoerr do not handle List and Dict
Bram Moolenaar <Bram@vim.org>
parents: 15209
diff changeset
9466 When the {expr} is the string "RESET" then the list of ignored
dada0b389d4f patch 8.1.0619: :echomsg and :echoerr do not handle List and Dict
Bram Moolenaar <Bram@vim.org>
parents: 15209
diff changeset
9467 errors is made empty.
11006
b3601a8eb679 patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents: 10908
diff changeset
9468
15456
f01eb1aed348 patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents: 15454
diff changeset
9469 test_null_blob() *test_null_blob()*
f01eb1aed348 patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents: 15454
diff changeset
9470 Return a |Blob| that is null. Only useful for testing.
f01eb1aed348 patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents: 15454
diff changeset
9471
9108
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9472 test_null_channel() *test_null_channel()*
15456
f01eb1aed348 patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents: 15454
diff changeset
9473 Return a |Channel| that is null. Only useful for testing.
9108
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9474 {only available when compiled with the +channel feature}
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9475
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9476 test_null_dict() *test_null_dict()*
15456
f01eb1aed348 patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents: 15454
diff changeset
9477 Return a |Dict| that is null. Only useful for testing.
9108
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9478
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9479 test_null_job() *test_null_job()*
15456
f01eb1aed348 patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents: 15454
diff changeset
9480 Return a |Job| that is null. Only useful for testing.
9108
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9481 {only available when compiled with the +job feature}
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9482
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9483 test_null_list() *test_null_list()*
15456
f01eb1aed348 patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents: 15454
diff changeset
9484 Return a |List| that is null. Only useful for testing.
9108
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9485
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9486 test_null_partial() *test_null_partial()*
15456
f01eb1aed348 patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents: 15454
diff changeset
9487 Return a |Partial| that is null. Only useful for testing.
9108
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9488
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9489 test_null_string() *test_null_string()*
15456
f01eb1aed348 patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents: 15454
diff changeset
9490 Return a |String| that is null. Only useful for testing.
9108
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9491
14748
00da090af0ab patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents: 14700
diff changeset
9492 test_option_not_set({name}) *test_option_not_set()*
00da090af0ab patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents: 14700
diff changeset
9493 Reset the flag that indicates option {name} was set. Thus it
00da090af0ab patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents: 14700
diff changeset
9494 looks like it still has the default value. Use like this: >
00da090af0ab patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents: 14700
diff changeset
9495 set ambiwidth=double
00da090af0ab patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents: 14700
diff changeset
9496 call test_option_not_set('ambiwidth')
00da090af0ab patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents: 14700
diff changeset
9497 < Now the 'ambiwidth' option behaves like it was never changed,
00da090af0ab patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents: 14700
diff changeset
9498 even though the value is "double".
00da090af0ab patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents: 14700
diff changeset
9499 Only to be used for testing!
00da090af0ab patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents: 14700
diff changeset
9500
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11105
diff changeset
9501 test_override({name}, {val}) *test_override()*
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15138
diff changeset
9502 Overrides certain parts of Vim's internal processing to be able
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11105
diff changeset
9503 to run tests. Only to be used for testing Vim!
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11105
diff changeset
9504 The override is enabled when {val} is non-zero and removed
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11105
diff changeset
9505 when {val} is zero.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
9506 Current supported values for name are:
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11105
diff changeset
9507
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11105
diff changeset
9508 name effect when {val} is non-zero ~
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11105
diff changeset
9509 redraw disable the redrawing() function
14673
f1b7d308de2f patch 8.1.0349: crash when wiping buffer in a callback
Christian Brabandt <cb@256bit.org>
parents: 14668
diff changeset
9510 redraw_flag ignore the RedrawingDisabled flag
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11105
diff changeset
9511 char_avail disable the char_avail() function
11587
439835c4b7aa patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents: 11579
diff changeset
9512 starting reset the "starting" variable, see below
14161
7cac4646c552 patch 8.1.0098: segfault when pattern with z() is very slow
Christian Brabandt <cb@256bit.org>
parents: 14147
diff changeset
9513 nfa_fail makes the NFA regexp engine fail to force a
7cac4646c552 patch 8.1.0098: segfault when pattern with z() is very slow
Christian Brabandt <cb@256bit.org>
parents: 14147
diff changeset
9514 fallback to the old engine
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11105
diff changeset
9515 ALL clear all overrides ({val} is not used)
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11105
diff changeset
9516
11587
439835c4b7aa patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents: 11579
diff changeset
9517 "starting" is to be used when a test should behave like
439835c4b7aa patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents: 11579
diff changeset
9518 startup was done. Since the tests are run by sourcing a
439835c4b7aa patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents: 11579
diff changeset
9519 script the "starting" variable is non-zero. This is usually a
439835c4b7aa patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents: 11579
diff changeset
9520 good thing (tests run faster), but sometimes changes behavior
439835c4b7aa patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents: 11579
diff changeset
9521 in a way that the test doesn't work properly.
439835c4b7aa patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents: 11579
diff changeset
9522 When using: >
439835c4b7aa patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents: 11579
diff changeset
9523 call test_override('starting', 1)
12076
ca4931a20f8c patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents: 12072
diff changeset
9524 < The value of "starting" is saved. It is restored by: >
11587
439835c4b7aa patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents: 11579
diff changeset
9525 call test_override('starting', 0)
439835c4b7aa patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents: 11579
diff changeset
9526
14756
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9527 test_scrollbar({which}, {value}, {dragging}) *test_scrollbar()*
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9528 Pretend using scrollbar {which} to move it to position
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9529 {value}. {which} can be:
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9530 left Left scrollbar of the current window
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9531 right Right scrollbar of the current window
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9532 hor Horizontal scrollbar
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9533
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9534 For the vertical scrollbars {value} can be 1 to the
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9535 line-count of the buffer. For the horizontal scrollbar the
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9536 {value} can be between 1 and the maximum line length, assuming
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9537 'wrap' is not set.
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9538
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9539 When {dragging} is non-zero it's like dragging the scrollbar,
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9540 otherwise it's like clicking in the scrollbar.
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9541 Only works when the {which} scrollbar actually exists,
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9542 obviously only when using the GUI.
a179e5cfcab7 patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents: 14748
diff changeset
9543
9286
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9223
diff changeset
9544 test_settime({expr}) *test_settime()*
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9223
diff changeset
9545 Set the time Vim uses internally. Currently only used for
9686
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
9546 timestamps in the history, as they are used in viminfo, and
8c2553beff0f commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents: 9644
diff changeset
9547 for undo.
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10787
diff changeset
9548 Using a value of 1 makes Vim not sleep after a warning or
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10787
diff changeset
9549 error message.
9286
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9223
diff changeset
9550 {expr} must evaluate to a number. When the value is zero the
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9223
diff changeset
9551 normal behavior is restored.
9108
d319453f62b3 commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents: 9104
diff changeset
9552
9790
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9553 *timer_info()*
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9554 timer_info([{id}])
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9555 Return a list with information about timers.
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9556 When {id} is given only information about this timer is
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9557 returned. When timer {id} does not exist an empty list is
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9558 returned.
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9559 When {id} is omitted information about all timers is returned.
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9560
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9561 For each timer the information is stored in a Dictionary with
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9562 these items:
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9563 "id" the timer ID
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9564 "time" time the timer was started with
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9565 "remaining" time until the timer fires
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9566 "repeat" number of times the timer will still fire;
9810
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9567 -1 means forever
9790
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9568 "callback" the callback
9810
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9569 "paused" 1 if the timer is paused, 0 otherwise
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9570
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9571 {only available when compiled with the |+timers| feature}
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9572
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9573 timer_pause({timer}, {paused}) *timer_pause()*
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9574 Pause or unpause a timer. A paused timer does not invoke its
9887
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
9575 callback when its time expires. Unpausing a timer may cause
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
9576 the callback to be invoked almost immediately if enough time
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
9577 has passed.
9810
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9578
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9579 Pausing a timer is useful to avoid the callback to be called
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9580 for a short time.
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9581
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9582 If {paused} evaluates to a non-zero Number or a non-empty
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9583 String, then the timer is paused, otherwise it is unpaused.
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9584 See |non-zero-arg|.
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9585
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9586 {only available when compiled with the |+timers| feature}
9790
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9587
9887
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
9588 *timer_start()* *timer* *timers*
8577
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9589 timer_start({time}, {callback} [, {options}])
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9590 Create a timer and return the timer ID.
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9591
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9592 {time} is the waiting time in milliseconds. This is the
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9593 minimum time before invoking the callback. When the system is
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9594 busy or Vim is not waiting for input the time will be longer.
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9595
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9596 {callback} is the function to call. It can be the name of a
10051
46763b01cd9a commit https://github.com/vim/vim/commit/f37506f60f87d52a9e8850e30067645e2b13783c
Christian Brabandt <cb@256bit.org>
parents: 10048
diff changeset
9597 function or a |Funcref|. It is called with one argument, which
8577
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9598 is the timer ID. The callback is only invoked when Vim is
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9599 waiting for input.
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9600
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9601 {options} is a dictionary. Supported entries:
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9602 "repeat" Number of times to repeat calling the
10153
715d6c5707b8 commit https://github.com/vim/vim/commit/abd468ed0fbcba391e7833feeaa7de3ced841455
Christian Brabandt <cb@256bit.org>
parents: 10140
diff changeset
9603 callback. -1 means forever. When not present
715d6c5707b8 commit https://github.com/vim/vim/commit/abd468ed0fbcba391e7833feeaa7de3ced841455
Christian Brabandt <cb@256bit.org>
parents: 10140
diff changeset
9604 the callback will be called once.
11639
71d7b5ed08a0 patch 8.0.0702: an error in a timer can make Vim unusable
Christian Brabandt <cb@256bit.org>
parents: 11609
diff changeset
9605 If the timer causes an error three times in a
71d7b5ed08a0 patch 8.0.0702: an error in a timer can make Vim unusable
Christian Brabandt <cb@256bit.org>
parents: 11609
diff changeset
9606 row the repeat is cancelled. This avoids that
71d7b5ed08a0 patch 8.0.0702: an error in a timer can make Vim unusable
Christian Brabandt <cb@256bit.org>
parents: 11609
diff changeset
9607 Vim becomes unusable because of all the error
71d7b5ed08a0 patch 8.0.0702: an error in a timer can make Vim unusable
Christian Brabandt <cb@256bit.org>
parents: 11609
diff changeset
9608 messages.
8577
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9609
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9610 Example: >
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9611 func MyHandler(timer)
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9612 echo 'Handler called'
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9613 endfunc
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9614 let timer = timer_start(500, 'MyHandler',
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9615 \ {'repeat': 3})
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9616 < This will invoke MyHandler() three times at 500 msec
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9617 intervals.
9810
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9618
8577
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9619 {only available when compiled with the |+timers| feature}
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
9620
8669
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
9621 timer_stop({timer}) *timer_stop()*
9097
071f9da012fb commit https://github.com/vim/vim/commit/06d2d38ab7564e1f784b1058a4ef4580cd6d1810
Christian Brabandt <cb@256bit.org>
parents: 9076
diff changeset
9622 Stop a timer. The timer callback will no longer be invoked.
071f9da012fb commit https://github.com/vim/vim/commit/06d2d38ab7564e1f784b1058a4ef4580cd6d1810
Christian Brabandt <cb@256bit.org>
parents: 9076
diff changeset
9623 {timer} is an ID returned by timer_start(), thus it must be a
9790
34cc6a101340 commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents: 9737
diff changeset
9624 Number. If {timer} does not exist there is no error.
8669
06848fe9c816 commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents: 8577
diff changeset
9625
9810
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9626 {only available when compiled with the |+timers| feature}
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9627
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9628 timer_stopall() *timer_stopall()*
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9629 Stop all timers. The timer callbacks will no longer be
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9630 invoked. Useful if some timers is misbehaving. If there are
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9631 no timers there is no error.
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9632
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9633 {only available when compiled with the |+timers| feature}
6a28d0c6f929 commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents: 9790
diff changeset
9634
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9635 tolower({expr}) *tolower()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9636 The result is a copy of the String given, with all uppercase
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9637 characters turned into lowercase (just like applying |gu| to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9638 the string).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9639
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9640 toupper({expr}) *toupper()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9641 The result is a copy of the String given, with all lowercase
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9642 characters turned into uppercase (just like applying |gU| to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9643 the string).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9644
15
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
9645 tr({src}, {fromstr}, {tostr}) *tr()*
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
9646 The result is a copy of the {src} string with all characters
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
9647 which appear in {fromstr} replaced by the character in that
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
9648 position in the {tostr} string. Thus the first character in
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
9649 {fromstr} is translated into the first character in {tostr}
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
9650 and so on. Exactly like the unix "tr" command.
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
9651 This code also deals with multibyte characters properly.
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
9652
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
9653 Examples: >
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
9654 echo tr("hello there", "ht", "HT")
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
9655 < returns "Hello THere" >
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
9656 echo tr("<blob>", "<>", "{}")
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
9657 < returns "{blob}"
631143ac4a01 updated for version 7.0007
vimboss
parents: 14
diff changeset
9658
14519
5c5908e81e93 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14422
diff changeset
9659 trim({text} [, {mask}]) *trim()*
13513
4064f342bea4 patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents: 13501
diff changeset
9660 Return {text} as a String where any character in {mask} is
4064f342bea4 patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents: 13501
diff changeset
9661 removed from the beginning and end of {text}.
4064f342bea4 patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents: 13501
diff changeset
9662 If {mask} is not given, {mask} is all characters up to 0x20,
4064f342bea4 patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents: 13501
diff changeset
9663 which includes Tab, space, NL and CR, plus the non-breaking
4064f342bea4 patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents: 13501
diff changeset
9664 space character 0xa0.
4064f342bea4 patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents: 13501
diff changeset
9665 This code deals with multibyte characters properly.
4064f342bea4 patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents: 13501
diff changeset
9666
4064f342bea4 patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents: 13501
diff changeset
9667 Examples: >
13563
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13551
diff changeset
9668 echo trim(" some text ")
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13551
diff changeset
9669 < returns "some text" >
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13551
diff changeset
9670 echo trim(" \r\t\t\r RESERVE \t\n\x0B\xA0") . "_TAIL"
13513
4064f342bea4 patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents: 13501
diff changeset
9671 < returns "RESERVE_TAIL" >
13563
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13551
diff changeset
9672 echo trim("rm<Xrm<>X>rrm", "rm<>")
5923f64c8f5b Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 13551
diff changeset
9673 < returns "Xrm<>X" (characters in the middle are not removed)
13513
4064f342bea4 patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents: 13501
diff changeset
9674
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
9675 trunc({expr}) *trunc()*
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
9676 Return the largest integral value with magnitude less than or
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
9677 equal to {expr} as a |Float| (truncate towards zero).
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
9678 {expr} must evaluate to a |Float| or a |Number|.
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
9679 Examples: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
9680 echo trunc(1.456)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
9681 < 1.0 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
9682 echo trunc(-5.456)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
9683 < -5.0 >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
9684 echo trunc(4.0)
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
9685 < 4.0
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
9686 {only available when compiled with the |+float| feature}
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
9687
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
9688 *type()*
9626
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9689 type({expr}) The result is a Number representing the type of {expr}.
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9690 Instead of using the number directly, it is better to use the
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9691 v:t_ variable that has the value:
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9692 Number: 0 |v:t_number|
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9693 String: 1 |v:t_string|
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9694 Funcref: 2 |v:t_func|
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9695 List: 3 |v:t_list|
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9696 Dictionary: 4 |v:t_dict|
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9697 Float: 5 |v:t_float|
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9698 Boolean: 6 |v:t_bool| (v:false and v:true)
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9699 None 7 |v:t_none| (v:null and v:none)
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9700 Job 8 |v:t_job|
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9701 Channel 9 |v:t_channel|
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
9702 Blob 10 |v:t_blob|
9626
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9703 For backward compatibility, this method can be used: >
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
9704 :if type(myvar) == type(0)
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
9705 :if type(myvar) == type("")
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
9706 :if type(myvar) == type(function("tr"))
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
9707 :if type(myvar) == type([])
153
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
9708 :if type(myvar) == type({})
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
9709 :if type(myvar) == type(0.0)
7742
5f6f35a3cb12 commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents: 7712
diff changeset
9710 :if type(myvar) == type(v:false)
8031
ece323e2b57f commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents: 8019
diff changeset
9711 :if type(myvar) == type(v:none)
9626
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9712 < To check if the v:t_ variables exist use this: >
172131507c85 commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents: 9587
diff changeset
9713 :if exists('v:t_number')
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9714
2236
dc2e5ec0500d Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2226
diff changeset
9715 undofile({name}) *undofile()*
dc2e5ec0500d Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2226
diff changeset
9716 Return the name of the undo file that would be used for a file
dc2e5ec0500d Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2226
diff changeset
9717 with name {name} when writing. This uses the 'undodir'
dc2e5ec0500d Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2226
diff changeset
9718 option, finding directories that exist. It does not check if
2250
1bac28a53fae Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents: 2249
diff changeset
9719 the undo file exists.
2249
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2236
diff changeset
9720 {name} is always expanded to the full path, since that is what
6d3d35ff2c2b Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents: 2236
diff changeset
9721 is used internally.
3507
8201108e9cf0 More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents: 3492
diff changeset
9722 If {name} is empty undofile() returns an empty string, since a
8201108e9cf0 More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents: 3492
diff changeset
9723 buffer without a file name will not write an undo file.
2236
dc2e5ec0500d Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2226
diff changeset
9724 Useful in combination with |:wundo| and |:rundo|.
15378
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents: 15335
diff changeset
9725 When compiled without the |+persistent_undo| option this always
2236
dc2e5ec0500d Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2226
diff changeset
9726 returns an empty string.
dc2e5ec0500d Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2226
diff changeset
9727
2280
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9728 undotree() *undotree()*
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9729 Return the current state of the undo tree in a dictionary with
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9730 the following items:
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9731 "seq_last" The highest undo sequence number used.
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9732 "seq_cur" The sequence number of the current position in
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9733 the undo tree. This differs from "seq_last"
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9734 when some changes were undone.
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9735 "time_cur" Time last used for |:earlier| and related
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9736 commands. Use |strftime()| to convert to
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9737 something readable.
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9738 "save_last" Number of the last file write. Zero when no
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9739 write yet.
2281
e41433ea71df Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents: 2280
diff changeset
9740 "save_cur" Number of the current position in the undo
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
9741 tree.
2280
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9742 "synced" Non-zero when the last undo block was synced.
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9743 This happens when waiting from input from the
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9744 user. See |undo-blocks|.
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9745 "entries" A list of dictionaries with information about
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9746 undo blocks.
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9747
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9748 The first item in the "entries" list is the oldest undo item.
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9749 Each List item is a Dictionary with these items:
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9750 "seq" Undo sequence number. Same as what appears in
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9751 |:undolist|.
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9752 "time" Timestamp when the change happened. Use
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9753 |strftime()| to convert to something readable.
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9754 "newhead" Only appears in the item that is the last one
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9755 that was added. This marks the last change
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9756 and where further changes will be added.
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9757 "curhead" Only appears in the item that is the last one
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9758 that was undone. This marks the current
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9759 position in the undo tree, the block that will
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9760 be used by a redo command. When nothing was
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9761 undone after the last change this item will
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9762 not appear anywhere.
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9763 "save" Only appears on the last block before a file
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9764 write. The number is the write count. The
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9765 first write has number 1, the last one the
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9766 "save_last" mentioned above.
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9767 "alt" Alternate entry. This is again a List of undo
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9768 blocks. Each item may again have an "alt"
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9769 item.
941ff1cd317a Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents: 2252
diff changeset
9770
5747
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
9771 uniq({list} [, {func} [, {dict}]]) *uniq()* *E882*
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
9772 Remove second and succeeding copies of repeated adjacent
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
9773 {list} items in-place. Returns {list}. If you want a list
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
9774 to remain unmodified make a copy first: >
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
9775 :let newlist = uniq(copy(mylist))
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
9776 < The default compare function uses the string representation of
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
9777 each item. For the use of {func} and {dict} see |sort()|.
ddc3f32a4b21 updated for version 7.4.218
Bram Moolenaar <bram@vim.org>
parents: 5734
diff changeset
9778
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
9779 values({dict}) *values()*
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
9780 Return a |List| with all the values of {dict}. The |List| is
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
9781 in arbitrary order.
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
9782
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
9783
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9784 virtcol({expr}) *virtcol()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9785 The result is a Number, which is the screen column of the file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9786 position given with {expr}. That is, the last screen position
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9787 occupied by the character at that position, when the screen
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9788 would be of unlimited width. When there is a <Tab> at the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9789 position, the returned Number will be the column at the end of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9790 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
3445
2cfb68fa26cd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3410
diff changeset
9791 set to 8, it returns 8. |conceal| is ignored.
1317
45bae37de037 updated for version 7.1-031
vimboss
parents: 1293
diff changeset
9792 For the byte position use |col()|.
45bae37de037 updated for version 7.1-031
vimboss
parents: 1293
diff changeset
9793 For the use of {expr} see |col()|.
45bae37de037 updated for version 7.1-031
vimboss
parents: 1293
diff changeset
9794 When 'virtualedit' is used {expr} can be [lnum, col, off], where
703
2fae45239fb3 updated for version 7.0212
vimboss
parents: 697
diff changeset
9795 "off" is the offset in screen columns from the start of the
1266
54588e2e8041 updated for version 7.1
vimboss
parents: 1215
diff changeset
9796 character. E.g., a position within a <Tab> or after the last
2965
f2de38a019a2 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
9797 character. When "off" is omitted zero is used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9798 When Virtual editing is active in the current mode, a position
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9799 beyond the end of the line can be returned. |'virtualedit'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9800 The accepted positions are:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9801 . the cursor position
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9802 $ the end of the cursor line (the result is the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9803 number of displayed characters in the cursor line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9804 plus one)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9805 'x position of mark x (if the mark is not set, 0 is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9806 returned)
6447
0550be8fc7f6 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6421
diff changeset
9807 v In Visual mode: the start of the Visual area (the
0550be8fc7f6 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6421
diff changeset
9808 cursor is the end). When not in Visual mode
0550be8fc7f6 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6421
diff changeset
9809 returns the cursor position. Differs from |'<| in
0550be8fc7f6 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6421
diff changeset
9810 that it's updated right away.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9811 Note that only marks in the current file can be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9812 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9813 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9814 virtcol("$") with text "foo^Lbar", returns 9
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
9815 virtcol("'t") with text " there", with 't at 'h', returns 6
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
9816 < The first column is 1. 0 is returned for an error.
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9817 A more advanced example that echoes the maximum length of
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9818 all lines: >
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9819 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9820
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9821
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9822 visualmode([expr]) *visualmode()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9823 The result is a String, which describes the last Visual mode
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
9824 used in the current buffer. Initially it returns an empty
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
9825 string, but once Visual mode has been used, it returns "v",
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
9826 "V", or "<CTRL-V>" (a single CTRL-V character) for
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
9827 character-wise, line-wise, or block-wise Visual mode
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
9828 respectively.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9829 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9830 :exe "normal " . visualmode()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9831 < This enters the same Visual mode as before. It is also useful
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9832 in scripts if you wish to act differently depending on the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9833 Visual mode that was used.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
9834 If Visual mode is active, use |mode()| to get the Visual mode
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
9835 (e.g., in a |:vmap|).
1661
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
9836 If [expr] is supplied and it evaluates to a non-zero Number or
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
9837 a non-empty String, then the Visual mode will be cleared and
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
9838 the old value is returned. See |non-zero-arg|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9839
4151
13170a796134 updated for version 7.3.828
Bram Moolenaar <bram@vim.org>
parents: 4126
diff changeset
9840 wildmenumode() *wildmenumode()*
9422
f93704b11e43 commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents: 9416
diff changeset
9841 Returns |TRUE| when the wildmenu is active and |FALSE|
4151
13170a796134 updated for version 7.3.828
Bram Moolenaar <bram@vim.org>
parents: 4126
diff changeset
9842 otherwise. See 'wildmenu' and 'wildmode'.
13170a796134 updated for version 7.3.828
Bram Moolenaar <bram@vim.org>
parents: 4126
diff changeset
9843 This can be used in mappings to handle the 'wildcharm' option
13170a796134 updated for version 7.3.828
Bram Moolenaar <bram@vim.org>
parents: 4126
diff changeset
9844 gracefully. (Makes only sense with |mapmode-c| mappings).
13170a796134 updated for version 7.3.828
Bram Moolenaar <bram@vim.org>
parents: 4126
diff changeset
9845
13170a796134 updated for version 7.3.828
Bram Moolenaar <bram@vim.org>
parents: 4126
diff changeset
9846 For example to make <c-j> work like <down> in wildmode, use: >
13170a796134 updated for version 7.3.828
Bram Moolenaar <bram@vim.org>
parents: 4126
diff changeset
9847 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
13170a796134 updated for version 7.3.828
Bram Moolenaar <bram@vim.org>
parents: 4126
diff changeset
9848 <
13170a796134 updated for version 7.3.828
Bram Moolenaar <bram@vim.org>
parents: 4126
diff changeset
9849 (Note, this needs the 'wildcharm' option set appropriately).
13170a796134 updated for version 7.3.828
Bram Moolenaar <bram@vim.org>
parents: 4126
diff changeset
9850
13170a796134 updated for version 7.3.828
Bram Moolenaar <bram@vim.org>
parents: 4126
diff changeset
9851
8536
09041d2fd7d0 commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents: 8534
diff changeset
9852 win_findbuf({bufnr}) *win_findbuf()*
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
9853 Returns a list with |window-ID|s for windows that contain
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
9854 buffer {bufnr}. When there is none the list is empty.
8536
09041d2fd7d0 commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents: 8534
diff changeset
9855
8534
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9856 win_getid([{win} [, {tab}]]) *win_getid()*
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
9857 Get the |window-ID| for the specified window.
8534
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9858 When {win} is missing use the current window.
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9859 With {win} this is the window number. The top window has
14999
2b30a2b4bde2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14964
diff changeset
9860 number 1.
8534
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9861 Without {tab} use the current tab, otherwise the tab with
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9862 number {tab}. The first tab has number one.
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9863 Return zero if the window cannot be found.
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9864
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9865 win_gotoid({expr}) *win_gotoid()*
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9866 Go to window with ID {expr}. This may also change the current
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9867 tabpage.
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9868 Return 1 if successful, 0 if the window cannot be found.
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9869
8876
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 8831
diff changeset
9870 win_id2tabwin({expr}) *win_id2tabwin()*
8534
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9871 Return a list with the tab number and window number of window
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9872 with ID {expr}: [tabnr, winnr].
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9873 Return [0, 0] if the window cannot be found.
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9874
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9875 win_id2win({expr}) *win_id2win()*
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9876 Return the window number of window with ID {expr}.
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9877 Return 0 if the window cannot be found in the current tabpage.
485d4d8a97f6 commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents: 8512
diff changeset
9878
12977
2d817fd289ba patch 8.0.1364: there is no easy way to get the window position
Christian Brabandt <cb@256bit.org>
parents: 12968
diff changeset
9879 win_screenpos({nr}) *win_screenpos()*
2d817fd289ba patch 8.0.1364: there is no easy way to get the window position
Christian Brabandt <cb@256bit.org>
parents: 12968
diff changeset
9880 Return the screen position of window {nr} as a list with two
2d817fd289ba patch 8.0.1364: there is no easy way to get the window position
Christian Brabandt <cb@256bit.org>
parents: 12968
diff changeset
9881 numbers: [row, col]. The first window always has position
14343
7589f103ec11 patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents: 14337
diff changeset
9882 [1, 1], unless there is a tabline, then it is [2, 1].
12977
2d817fd289ba patch 8.0.1364: there is no easy way to get the window position
Christian Brabandt <cb@256bit.org>
parents: 12968
diff changeset
9883 {nr} can be the window number or the |window-ID|.
2d817fd289ba patch 8.0.1364: there is no easy way to get the window position
Christian Brabandt <cb@256bit.org>
parents: 12968
diff changeset
9884 Return [0, 0] if the window cannot be found in the current
2d817fd289ba patch 8.0.1364: there is no easy way to get the window position
Christian Brabandt <cb@256bit.org>
parents: 12968
diff changeset
9885 tabpage.
2d817fd289ba patch 8.0.1364: there is no easy way to get the window position
Christian Brabandt <cb@256bit.org>
parents: 12968
diff changeset
9886
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9887 *winbufnr()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9888 winbufnr({nr}) The result is a Number, which is the number of the buffer
9223
6c4d610fce0a commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents: 9221
diff changeset
9889 associated with window {nr}. {nr} can be the window number or
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
9890 the |window-ID|.
9223
6c4d610fce0a commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents: 9221
diff changeset
9891 When {nr} is zero, the number of the buffer in the current
6c4d610fce0a commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents: 9221
diff changeset
9892 window is returned.
6c4d610fce0a commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents: 9221
diff changeset
9893 When window {nr} doesn't exist, -1 is returned.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9894 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9895 :echo "The file in the current window is " . bufname(winbufnr(0))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9896 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9897 *wincol()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9898 wincol() The result is a Number, which is the virtual column of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9899 cursor in the window. This is counting screen cells from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9900 left side of the window. The leftmost column is one.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9901
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9902 winheight({nr}) *winheight()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9903 The result is a Number, which is the height of window {nr}.
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
9904 {nr} can be the window number or the |window-ID|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9905 When {nr} is zero, the height of the current window is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9906 returned. When window {nr} doesn't exist, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9907 An existing window always has a height of zero or more.
12499
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12465
diff changeset
9908 This excludes any window toolbar line.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9909 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9910 :echo "The current window has " . winheight(0) . " lines."
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9911 <
14587
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9912 winlayout([{tabnr}]) *winlayout()*
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9913 The result is a nested List containing the layout of windows
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9914 in a tabpage.
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9915
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9916 Without {tabnr} use the current tabpage, otherwise the tabpage
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9917 with number {tabnr}. If the tabpage {tabnr} is not found,
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9918 returns an empty list.
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9919
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9920 For a leaf window, it returns:
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9921 ['leaf', {winid}]
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9922 For horizontally split windows, which form a column, it
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9923 returns:
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9924 ['col', [{nested list of windows}]]
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9925 For vertically split windows, which form a row, it returns:
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9926 ['row', [{nested list of windows}]]
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9927
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9928 Example: >
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9929 " Only one window in the tab page
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9930 :echo winlayout()
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9931 ['leaf', 1000]
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9932 " Two horizontally split windows
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9933 :echo winlayout()
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9934 ['col', [['leaf', 1000], ['leaf', 1001]]]
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9935 " Three horizontally split windows, with two
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9936 " vertically split windows in the middle window
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9937 :echo winlayout(2)
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9938 ['col', [['leaf', 1002], ['row', ['leaf', 1003],
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9939 ['leaf', 1001]]], ['leaf', 1000]]
d33220d3bc27 patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents: 14519
diff changeset
9940 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9941 *winline()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9942 winline() The result is a Number, which is the screen line of the cursor
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
9943 in the window. This is counting screen lines from the top of
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9944 the window. The first line is one.
531
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
9945 If the cursor was moved the view on the file will be updated
da9142bd190a updated for version 7.0149
vimboss
parents: 530
diff changeset
9946 first, this may cause a scroll.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9947
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9948 *winnr()*
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
9949 winnr([{arg}]) The result is a Number, which is the number of the current
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
9950 window. The top window has number 1.
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
9951 When the optional argument is "$", the number of the
3967
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3920
diff changeset
9952 last window is returned (the window count). >
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3920
diff changeset
9953 let window_count = winnr('$')
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3920
diff changeset
9954 < When the optional argument is "#", the number of the last
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
9955 accessed window is returned (where |CTRL-W_p| goes to).
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9956 If there is no previous window or it is in another tab page 0
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
9957 is returned.
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
9958 The number can be used with |CTRL-W_w| and ":wincmd w"
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 19
diff changeset
9959 |:wincmd|.
10734
523cd59d6db0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10730
diff changeset
9960 Also see |tabpagewinnr()| and |win_getid()|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9961
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9962 *winrestcmd()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9963 winrestcmd() Returns a sequence of |:resize| commands that should restore
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9964 the current window sizes. Only works properly when no windows
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9965 are opened or closed and the current window and tab page is
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9966 unchanged.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9967 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9968 :let cmd = winrestcmd()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9969 :call MessWithWindowSizes()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9970 :exe cmd
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9971 <
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9972 *winrestview()*
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9973 winrestview({dict})
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9974 Uses the |Dictionary| returned by |winsaveview()| to restore
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9975 the view of the current window.
5940
f6f754304324 updated for version 7.4.311
Bram Moolenaar <bram@vim.org>
parents: 5938
diff changeset
9976 Note: The {dict} does not have to contain all values, that are
f6f754304324 updated for version 7.4.311
Bram Moolenaar <bram@vim.org>
parents: 5938
diff changeset
9977 returned by |winsaveview()|. If values are missing, those
f6f754304324 updated for version 7.4.311
Bram Moolenaar <bram@vim.org>
parents: 5938
diff changeset
9978 settings won't be restored. So you can use: >
f6f754304324 updated for version 7.4.311
Bram Moolenaar <bram@vim.org>
parents: 5938
diff changeset
9979 :call winrestview({'curswant': 4})
f6f754304324 updated for version 7.4.311
Bram Moolenaar <bram@vim.org>
parents: 5938
diff changeset
9980 <
f6f754304324 updated for version 7.4.311
Bram Moolenaar <bram@vim.org>
parents: 5938
diff changeset
9981 This will only set the curswant value (the column the cursor
f6f754304324 updated for version 7.4.311
Bram Moolenaar <bram@vim.org>
parents: 5938
diff changeset
9982 wants to move on vertical movements) of the cursor to column 5
f6f754304324 updated for version 7.4.311
Bram Moolenaar <bram@vim.org>
parents: 5938
diff changeset
9983 (yes, that is 5), while all other settings will remain the
f6f754304324 updated for version 7.4.311
Bram Moolenaar <bram@vim.org>
parents: 5938
diff changeset
9984 same. This is useful, if you set the cursor position manually.
f6f754304324 updated for version 7.4.311
Bram Moolenaar <bram@vim.org>
parents: 5938
diff changeset
9985
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9986 If you have changed the values the result is unpredictable.
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9987 If the window size changed the result won't be the same.
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9988
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9989 *winsaveview()*
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9990 winsaveview() Returns a |Dictionary| that contains information to restore
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9991 the view of the current window. Use |winrestview()| to
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9992 restore the view.
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9993 This is useful if you have a mapping that jumps around in the
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9994 buffer and you want to go back to the original view.
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9995 This does not save fold information. Use the 'foldenable'
798
95dac6af3b3a updated for version 7.0232
vimboss
parents: 794
diff changeset
9996 option to temporarily switch off folding, so that folds are
6070
32a77cc160d9 Update runtime files. Make matchparen plugin backwards compatible.
Bram Moolenaar <bram@vim.org>
parents: 6051
diff changeset
9997 not opened when moving around. This may have side effects.
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9998 The return value includes:
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
9999 lnum cursor line number
5940
f6f754304324 updated for version 7.4.311
Bram Moolenaar <bram@vim.org>
parents: 5938
diff changeset
10000 col cursor column (Note: the first column
f6f754304324 updated for version 7.4.311
Bram Moolenaar <bram@vim.org>
parents: 5938
diff changeset
10001 zero, as opposed to what getpos()
f6f754304324 updated for version 7.4.311
Bram Moolenaar <bram@vim.org>
parents: 5938
diff changeset
10002 returns)
712
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
10003 coladd cursor column offset for 'virtualedit'
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
10004 curswant column for vertical movement
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
10005 topline first line in the window
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
10006 topfill filler lines, only in diff mode
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
10007 leftcol first column displayed
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
10008 skipcol columns skipped
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
10009 Note that no option values are saved.
2e887dfa8917 updated for version 7.0214
vimboss
parents: 707
diff changeset
10010
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10011
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10012 winwidth({nr}) *winwidth()*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10013 The result is a Number, which is the width of window {nr}.
9908
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents: 9904
diff changeset
10014 {nr} can be the window number or the |window-ID|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10015 When {nr} is zero, the width of the current window is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10016 returned. When window {nr} doesn't exist, -1 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10017 An existing window always has a width of zero or more.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10018 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10019 :echo "The current window has " . winwidth(0) . " columns."
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10020 :if winwidth(0) <= 50
12857
ffdf2e4b5d9a patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents: 12837
diff changeset
10021 : 50 wincmd |
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10022 :endif
11561
7ad79766365a patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents: 11553
diff changeset
10023 < For getting the terminal or screen size, see the 'columns'
7ad79766365a patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents: 11553
diff changeset
10024 option.
9389
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
10025
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
10026
7480
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10027 wordcount() *wordcount()*
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10028 The result is a dictionary of byte/chars/word statistics for
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10029 the current buffer. This is the same info as provided by
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10030 |g_CTRL-G|
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10031 The return value includes:
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10032 bytes Number of bytes in the buffer
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10033 chars Number of chars in the buffer
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10034 words Number of words in the buffer
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10035 cursor_bytes Number of bytes before cursor position
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10036 (not in Visual mode)
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10037 cursor_chars Number of chars before cursor position
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10038 (not in Visual mode)
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10039 cursor_words Number of words before cursor position
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10040 (not in Visual mode)
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10041 visual_bytes Number of bytes visually selected
11561
7ad79766365a patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents: 11553
diff changeset
10042 (only in Visual mode)
7480
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10043 visual_chars Number of chars visually selected
11561
7ad79766365a patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents: 11553
diff changeset
10044 (only in Visual mode)
12254
8d76a56861ec Update runtime files
Christian Brabandt <cb@256bit.org>
parents: 12252
diff changeset
10045 visual_words Number of words visually selected
11561
7ad79766365a patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents: 11553
diff changeset
10046 (only in Visual mode)
7480
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10047
a49163681559 commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
10048
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
10049 *writefile()*
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
10050 writefile({object}, {fname} [, {flags}])
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
10051 When {object} is a |List| write it to file {fname}. Each list
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
10052 item is separated with a NL. Each list item must be a String
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
10053 or Number.
6341
094a87e76155 updated for version 7.4.503
Bram Moolenaar <bram@vim.org>
parents: 6259
diff changeset
10054 When {flags} contains "b" then binary mode is used: There will
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
10055 not be a NL after the last list item. An empty item at the
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
10056 end does cause the last line in the file to end in a NL.
6341
094a87e76155 updated for version 7.4.503
Bram Moolenaar <bram@vim.org>
parents: 6259
diff changeset
10057
15454
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
10058 When {object} is a |Blob| write the bytes to file {fname}
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
10059 unmodified.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
10060
6341
094a87e76155 updated for version 7.4.503
Bram Moolenaar <bram@vim.org>
parents: 6259
diff changeset
10061 When {flags} contains "a" then append mode is used, lines are
10301
07d2b5a3b7cc commit https://github.com/vim/vim/commit/46fceaaa8d1447a9588736d86eb4908214187b08
Christian Brabandt <cb@256bit.org>
parents: 10275
diff changeset
10062 appended to the file: >
6341
094a87e76155 updated for version 7.4.503
Bram Moolenaar <bram@vim.org>
parents: 6259
diff changeset
10063 :call writefile(["foo"], "event.log", "a")
094a87e76155 updated for version 7.4.503
Bram Moolenaar <bram@vim.org>
parents: 6259
diff changeset
10064 :call writefile(["bar"], "event.log", "a")
12857
ffdf2e4b5d9a patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents: 12837
diff changeset
10065 <
ffdf2e4b5d9a patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents: 12837
diff changeset
10066 When {flags} contains "s" then fsync() is called after writing
ffdf2e4b5d9a patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents: 12837
diff changeset
10067 the file. This flushes the file to disk, if possible. This
ffdf2e4b5d9a patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents: 12837
diff changeset
10068 takes more time but avoids losing the file if the system
ffdf2e4b5d9a patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents: 12837
diff changeset
10069 crashes.
13016
e47e70300f30 patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents: 12977
diff changeset
10070 When {flags} does not contain "S" or "s" then fsync() is
e47e70300f30 patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents: 12977
diff changeset
10071 called if the 'fsync' option is set.
12857
ffdf2e4b5d9a patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents: 12837
diff changeset
10072 When {flags} contains "S" then fsync() is not called, even
ffdf2e4b5d9a patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents: 12837
diff changeset
10073 when 'fsync' is set.
ffdf2e4b5d9a patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents: 12837
diff changeset
10074
ffdf2e4b5d9a patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents: 12837
diff changeset
10075 All NL characters are replaced with a NUL character.
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
10076 Inserting CR characters needs to be done before passing {list}
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
10077 to writefile().
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
10078 An existing file is overwritten, if possible.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
10079 When the write fails -1 is returned, otherwise 0. There is an
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
10080 error message if the file can't be created or when writing
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
10081 fails.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
10082 Also see |readfile()|.
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
10083 To copy a file byte for byte: >
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
10084 :let fl = readfile("foo", "b")
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
10085 :call writefile(fl, "foocopy", "b")
3214
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
10086
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
10087
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
10088 xor({expr}, {expr}) *xor()*
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
10089 Bitwise XOR on the two arguments. The arguments are converted
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
10090 to a number. A List, Dict or Float argument causes an error.
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
10091 Example: >
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
10092 :let bits = xor(bits, 0x80)
3256
ba708ee8d69d Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3237
diff changeset
10093 <
3214
cd145cc2f2c9 updated for version 7.3.377
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
10094
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10095
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10096 *feature-list*
6009
7b83c190d370 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6007
diff changeset
10097 There are four types of features:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10098 1. Features that are only supported when they have been enabled when Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10099 was compiled |+feature-list|. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10100 :if has("cindent")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10101 2. Features that are only supported when certain conditions have been met.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10102 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10103 :if has("gui_running")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10104 < *has-patch*
13967
acc62d455f90 Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
10105 3. Beyond a certain version or at a certain version and including a specific
acc62d455f90 Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
10106 patch. The "patch-7.4.248" feature means that the Vim version is 7.5 or
acc62d455f90 Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
10107 later, or it is version 7.4 and patch 248 was included. Example: >
5862
306caa30d83b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 5815
diff changeset
10108 :if has("patch-7.4.248")
13967
acc62d455f90 Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
10109 < Note that it's possible for patch 248 to be omitted even though 249 is
acc62d455f90 Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
10110 included. Only happens when cherry-picking patches.
acc62d455f90 Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
10111 Note that this form only works for patch 7.4.237 and later, before that
acc62d455f90 Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
10112 you need to check for the patch and the v:version. Example (checking
acc62d455f90 Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
10113 version 6.2.148 or later): >
acc62d455f90 Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
10114 :if v:version > 602 || (v:version == 602 && has("patch148"))
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10115
9850
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
10116 Hint: To find out if Vim supports backslashes in a file name (MS-Windows),
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
10117 use: `if exists('+shellslash')`
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
10118
67781bb0a61a commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents: 9810
diff changeset
10119
5340
22da5ab9aaa1 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
10120 acl Compiled with |ACL| support.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10121 all_builtin_terms Compiled with all builtin terminals enabled.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10122 amiga Amiga version of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10123 arabic Compiled with Arabic support |Arabic|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10124 arp Compiled with ARP support (Amiga).
613
53114ef7778f updated for version 7.0174
vimboss
parents: 593
diff changeset
10125 autocmd Compiled with autocommand support. |autocommand|
14421
2f7e67dd088c Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14407
diff changeset
10126 autochdir Compiled with support for 'autochdir'
12837
963cdeb42c41 patch 8.0.1295: cannot automatically get a server name in a terminal
Christian Brabandt <cb@256bit.org>
parents: 12785
diff changeset
10127 autoservername Automatically enable |clientserver|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10128 balloon_eval Compiled with |balloon-eval| support.
435
73f016dbb279 updated for version 7.0112
vimboss
parents: 419
diff changeset
10129 balloon_multiline GUI supports multiline balloons.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10130 beos BeOS version of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10131 browse Compiled with |:browse| support, and browse() will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10132 work.
3682
11d40fc82f11 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
10133 browsefilter Compiled with support for |browsefilter|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10134 builtin_terms Compiled with some builtin terminals.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10135 byte_offset Compiled with support for 'o' in 'statusline'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10136 cindent Compiled with 'cindent' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10137 clientserver Compiled with remote invocation support |clientserver|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10138 clipboard Compiled with 'clipboard' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10139 cmdline_compl Compiled with |cmdline-completion| support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10140 cmdline_hist Compiled with |cmdline-history| support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10141 cmdline_info Compiled with 'showcmd' and 'ruler' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10142 comments Compiled with |'comments'| support.
2681
85c5a72551e2 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
10143 compatible Compiled to be very Vi compatible.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10144 cryptv Compiled with encryption support |encryption|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10145 cscope Compiled with |cscope| support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10146 debug Compiled with "DEBUG" defined.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10147 dialog_con Compiled with console dialog support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10148 dialog_gui Compiled with GUI dialog support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10149 diff Compiled with |vimdiff| and 'diff' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10150 digraphs Compiled with support for digraphs.
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
10151 directx Compiled with support for DirectX and 'renderoptions'.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10152 dnd Compiled with support for the "~ register |quote_~|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10153 ebcdic Compiled on a machine with ebcdic character set.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10154 emacs_tags Compiled with support for Emacs tags.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10155 eval Compiled with expression evaluation support. Always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10156 true, of course!
7876
93f747af7b58 commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents: 7788
diff changeset
10157 ex_extra |+ex_extra|, always true now
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10158 extra_search Compiled with support for |'incsearch'| and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10159 |'hlsearch'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10160 farsi Compiled with Farsi support |farsi|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10161 file_in_path Compiled with support for |gf| and |<cfile>|
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
10162 filterpipe When 'shelltemp' is off pipes are used for shell
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
10163 read/write/filter commands
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10164 find_in_path Compiled with support for include file searches
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10165 |+find_in_path|.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
10166 float Compiled with support for |Float|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10167 fname_case Case in file names matters (for Amiga, MS-DOS, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10168 Windows this is not present).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10169 folding Compiled with |folding| support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10170 footer Compiled with GUI footer support. |gui-footer|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10171 fork Compiled to use fork()/exec() instead of system().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10172 gettext Compiled with message translation |multi-lang|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10173 gui Compiled with GUI enabled.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10174 gui_athena Compiled with Athena GUI.
2681
85c5a72551e2 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
10175 gui_gnome Compiled with Gnome support (gui_gtk is also defined).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10176 gui_gtk Compiled with GTK+ GUI (any version).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10177 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
8218
3456e2ebebd4 commit https://github.com/vim/vim/commit/9892189d2e7ab94b750f99e6da4cbfc3c8014517
Christian Brabandt <cb@256bit.org>
parents: 8178
diff changeset
10178 gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10179 gui_mac Compiled with Macintosh GUI.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10180 gui_motif Compiled with Motif GUI.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10181 gui_photon Compiled with Photon GUI.
2681
85c5a72551e2 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
10182 gui_running Vim is running in the GUI, or it will start soon.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10183 gui_win32 Compiled with MS Windows Win32 GUI.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10184 gui_win32s idem, and Win32s system being used (Windows 3.1)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10185 hangul_input Compiled with Hangul input support. |hangul|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10186 iconv Can use iconv() for conversion.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10187 insert_expand Compiled with support for CTRL-X expansion commands in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10188 Insert mode.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10189 jumplist Compiled with |jumplist| support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10190 keymap Compiled with 'keymap' support.
9723
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
10191 lambda Compiled with |lambda| support.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10192 langmap Compiled with 'langmap' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10193 libcall Compiled with |libcall()| support.
5995
ef83b423ebf7 updated for version 7.4.338
Bram Moolenaar <bram@vim.org>
parents: 5979
diff changeset
10194 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and
ef83b423ebf7 updated for version 7.4.338
Bram Moolenaar <bram@vim.org>
parents: 5979
diff changeset
10195 'breakindent' support.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10196 lispindent Compiled with support for lisp indenting.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10197 listcmds Compiled with commands for the buffer list |:files|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10198 and the argument list |arglist|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10199 localmap Compiled with local mappings and abbr. |:map-local|
2320
966a5609669e Added Lua interfae. (Luis Carvalho)
Bram Moolenaar <bram@vim.org>
parents: 2290
diff changeset
10200 lua Compiled with Lua interface |Lua|.
12716
351cf7c67bbe patch 8.0.1236: Mac features are confusing
Christian Brabandt <cb@256bit.org>
parents: 12632
diff changeset
10201 mac Any Macintosh version of Vim cf. osx
351cf7c67bbe patch 8.0.1236: Mac features are confusing
Christian Brabandt <cb@256bit.org>
parents: 12632
diff changeset
10202 macunix Synonym for osxdarwin
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10203 menu Compiled with support for |:menu|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10204 mksession Compiled with support for |:mksession|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10205 modify_fname Compiled with file name modifiers. |filename-modifiers|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10206 mouse Compiled with support mouse.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10207 mouse_dec Compiled with support for Dec terminal mouse.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10208 mouse_gpm Compiled with support for gpm (Linux console mouse)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10209 mouse_netterm Compiled with support for netterm mouse.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10210 mouse_pterm Compiled with support for qnx pterm mouse.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
10211 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse)
3750
536aa8b0c934 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3682
diff changeset
10212 mouse_sgr Compiled with support for sgr mouse.
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3214
diff changeset
10213 mouse_urxvt Compiled with support for urxvt mouse.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10214 mouse_xterm Compiled with support for xterm mouse.
2681
85c5a72551e2 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
10215 mouseshape Compiled with support for 'mouseshape'.
1768
2a11407a5a8f updated for version 7.2-066
vimboss
parents: 1755
diff changeset
10216 multi_byte Compiled with support for 'encoding'
2a11407a5a8f updated for version 7.2-066
vimboss
parents: 1755
diff changeset
10217 multi_byte_encoding 'encoding' is set to a multi-byte encoding.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10218 multi_byte_ime Compiled with support for IME input method.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10219 multi_lang Compiled with support for multiple languages.
14
946da5994c01 updated for version 7.0006
vimboss
parents: 11
diff changeset
10220 mzscheme Compiled with MzScheme interface |mzscheme|.
2681
85c5a72551e2 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
10221 netbeans_enabled Compiled with support for |netbeans| and connected.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10222 netbeans_intg Compiled with support for |netbeans|.
9389
32e34e574716 commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents: 9344
diff changeset
10223 num64 Compiled with 64-bit |Number| support.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10224 ole Compiled with OLE automation support for Win32.
12716
351cf7c67bbe patch 8.0.1236: Mac features are confusing
Christian Brabandt <cb@256bit.org>
parents: 12632
diff changeset
10225 osx Compiled for macOS cf. mac
351cf7c67bbe patch 8.0.1236: Mac features are confusing
Christian Brabandt <cb@256bit.org>
parents: 12632
diff changeset
10226 osxdarwin Compiled for macOS, with |mac-darwin-feature|
9076
9305a1251e51 commit https://github.com/vim/vim/commit/91c4937be15b0b743b6bc495df602c1abbff6b87
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
10227 packages Compiled with |packages| support.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10228 path_extra Compiled with up/downwards search in 'path' and 'tags'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10229 perl Compiled with Perl interface.
2214
f8222d1f9a73 Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents: 2210
diff changeset
10230 persistent_undo Compiled with support for persistent undo history.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10231 postscript Compiled with PostScript file printing.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10232 printer Compiled with |:hardcopy| support.
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
10233 profile Compiled with |:profile| support.
13123
aaead5b4d77d patch 8.0.1436: not enough information about what Python version may work
Christian Brabandt <cb@256bit.org>
parents: 13070
diff changeset
10234 python Python 2.x interface available. |has-python|
aaead5b4d77d patch 8.0.1436: not enough information about what Python version may work
Christian Brabandt <cb@256bit.org>
parents: 13070
diff changeset
10235 python_compiled Compiled with Python 2.x interface. |has-python|
aaead5b4d77d patch 8.0.1436: not enough information about what Python version may work
Christian Brabandt <cb@256bit.org>
parents: 13070
diff changeset
10236 python_dynamic Python 2.x interface is dynamically loaded. |has-python|
aaead5b4d77d patch 8.0.1436: not enough information about what Python version may work
Christian Brabandt <cb@256bit.org>
parents: 13070
diff changeset
10237 python3 Python 3.x interface available. |has-python|
aaead5b4d77d patch 8.0.1436: not enough information about what Python version may work
Christian Brabandt <cb@256bit.org>
parents: 13070
diff changeset
10238 python3_compiled Compiled with Python 3.x interface. |has-python|
aaead5b4d77d patch 8.0.1436: not enough information about what Python version may work
Christian Brabandt <cb@256bit.org>
parents: 13070
diff changeset
10239 python3_dynamic Python 3.x interface is dynamically loaded. |has-python|
10722
7598ce51bf2a patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents: 10617
diff changeset
10240 pythonx Compiled with |python_x| interface. |has-pythonx|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10241 qnx QNX version of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10242 quickfix Compiled with |quickfix| support.
857
b933657f7c9d updated for version 7.0g01
vimboss
parents: 856
diff changeset
10243 reltime Compiled with |reltime()| support.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10244 rightleft Compiled with 'rightleft' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10245 ruby Compiled with Ruby interface |ruby|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10246 scrollbind Compiled with 'scrollbind' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10247 showcmd Compiled with 'showcmd' support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10248 signs Compiled with |:sign| support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10249 smartindent Compiled with 'smartindent' support.
2681
85c5a72551e2 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
10250 spell Compiled with spell checking support |spell|.
1989
1fbbe04a950f updated for version 7.2-286
vimboss
parents: 1851
diff changeset
10251 startuptime Compiled with |--startuptime| support.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10252 statusline Compiled with support for 'statusline', 'rulerformat'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10253 and special formats of 'titlestring' and 'iconstring'.
15512
f0f06837a699 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15498
diff changeset
10254 sun_workshop Support for Sun |workshop| has been removed.
314
529f887b5cb7 updated for version 7.0082
vimboss
parents: 303
diff changeset
10255 syntax Compiled with syntax highlighting support |syntax|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10256 syntax_items There are active syntax highlighting items for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10257 current buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10258 system Compiled to use system() instead of fork()/exec().
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10259 tag_binary Compiled with binary searching in tags files
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10260 |tag-binary-search|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10261 tag_old_static Compiled with support for old static tags
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10262 |tag-old-static|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10263 tag_any_white Compiled with support for any white characters in tags
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10264 files |tag-any-white|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10265 tcl Compiled with Tcl interface.
9076
9305a1251e51 commit https://github.com/vim/vim/commit/91c4937be15b0b743b6bc495df602c1abbff6b87
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
10266 termguicolors Compiled with true color in terminal support.
11904
40322e8f07e7 patch 8.0.0832: terminal function arguments are not consistent
Christian Brabandt <cb@256bit.org>
parents: 11882
diff changeset
10267 terminal Compiled with |terminal| support.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10268 terminfo Compiled with terminfo instead of termcap.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10269 termresponse Compiled with support for |t_RV| and |v:termresponse|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10270 textobjects Compiled with support for |text-objects|.
15138
9df130fd5e0d patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents: 15131
diff changeset
10271 textprop Compiled with support for |text-properties|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10272 tgetent Compiled with tgetent support, able to use a termcap
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10273 or terminfo file.
8577
63dc856bd13d commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents: 8538
diff changeset
10274 timers Compiled with |timer_start()| support.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10275 title Compiled with window title support |'title'|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10276 toolbar Compiled with support for |gui-toolbar|.
10404
65e0537a4560 commit https://github.com/vim/vim/commit/2cab0e191055a8145ccd46cd52869fbb9798b971
Christian Brabandt <cb@256bit.org>
parents: 10348
diff changeset
10277 ttyin input is a terminal (tty)
65e0537a4560 commit https://github.com/vim/vim/commit/2cab0e191055a8145ccd46cd52869fbb9798b971
Christian Brabandt <cb@256bit.org>
parents: 10348
diff changeset
10278 ttyout output is a terminal (tty)
12499
d91cf2e26ef0 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12465
diff changeset
10279 unix Unix version of Vim. *+unix*
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10787
diff changeset
10280 unnamedplus Compiled with support for "unnamedplus" in 'clipboard'
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10281 user_commands User-defined commands.
13341
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13329
diff changeset
10282 vcon Win32: Virtual console support is working, can use
acd7eaa13d2b Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13329
diff changeset
10283 'termguicolors'. Also see |+vtp|.
2681
85c5a72551e2 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
10284 vertsplit Compiled with vertically split windows |:vsplit|.
2581
e8a482a7fa6c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
10285 vim_starting True while initial source'ing takes place. |startup|
8748
b1a19a2f73f0 commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents: 8738
diff changeset
10286 *vim_starting*
2681
85c5a72551e2 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
10287 viminfo Compiled with viminfo support.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10288 virtualedit Compiled with 'virtualedit' option.
15424
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
10289 visual Compiled with Visual mode. (always true)
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
10290 visualextra Compiled with extra Visual mode commands. (always
90c8ff9c19ee patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents: 15418
diff changeset
10291 true) |blockwise-operators|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10292 vms VMS version of Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10293 vreplace Compiled with |gR| and |gr| commands.
13482
9eebe457eb3c Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents: 13438
diff changeset
10294 vtp Compiled for vcon support |+vtp| (check vcon to find
13501
a4a559e08798 patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents: 13482
diff changeset
10295 out if it works in the current console).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10296 wildignore Compiled with 'wildignore' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10297 wildmenu Compiled with 'wildmenu' option.
14103
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
10298 win16 old version for MS-Windows 3.1 (always False)
2698
b6471224d2af Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2681
diff changeset
10299 win32 Win32 version of Vim (MS-Windows 95 and later, 32 or
b6471224d2af Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 2681
diff changeset
10300 64 bits)
2681
85c5a72551e2 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
10301 win32unix Win32 version of Vim, using Unix files (Cygwin)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10302 win64 Win64 version of Vim (MS-Windows 64 bit).
14103
d053ec57d886 patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents: 14043
diff changeset
10303 win95 Win32 version for MS-Windows 95/98/ME (always False)
2681
85c5a72551e2 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
10304 winaltkeys Compiled with 'winaltkeys' option.
85c5a72551e2 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2662
diff changeset
10305 windows Compiled with support for more than one window.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10306 writebackup Compiled with 'writebackup' default on.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10307 xfontset Compiled with X fontset support |xfontset|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10308 xim Compiled with X input method support |xim|.
5340
22da5ab9aaa1 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
10309 xpm Compiled with pixmap support.
22da5ab9aaa1 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
10310 xpm_w32 Compiled with pixmap support for Win32. (Only for
22da5ab9aaa1 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
10311 backward compatibility. Use "xpm" instead.)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10312 xsmp Compiled with X session management support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10313 xsmp_interact Compiled with interactive X session management support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10314 xterm_clipboard Compiled with support for xterm clipboard.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10315 xterm_save Compiled with support for saving and restoring the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10316 xterm screen.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10317 x11 Compiled with X11 support.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10318
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10319 *string-match*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10320 Matching a pattern in a String
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10321
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10322 A regexp pattern as explained at |pattern| is normally used to find a match in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10323 the buffer lines. When a pattern is used to find a match in a String, almost
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10324 everything works in the same way. The difference is that a String is handled
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10325 like it is one line. When it contains a "\n" character, this is not seen as a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10326 line break for the pattern. It can be matched with a "\n" in the pattern, or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10327 with ".". Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10328 :let a = "aaaa\nxxxx"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10329 :echo matchstr(a, "..\n..")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10330 aa
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10331 xx
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10332 :echo matchstr(a, "a.x")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10333 a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10334 x
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10335
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10336 Don't forget that "^" will only match at the first character of the String and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10337 "$" at the last character of the string. They don't match after or before a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10338 "\n".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10339
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10340 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10341 5. Defining functions *user-functions*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10342
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10343 New functions can be defined. These can be called just like builtin
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10344 functions. The function executes a sequence of Ex commands. Normal mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10345 commands can be executed with the |:normal| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10346
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10347 The function name must start with an uppercase letter, to avoid confusion with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10348 builtin functions. To prevent from using the same name in different scripts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10349 avoid obvious, short names. A good habit is to start the function name with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10350 the name of the script, e.g., "HTMLcolor()".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10351
504
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
10352 It's also possible to use curly braces, see |curly-braces-names|. And the
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
10353 |autoload| facility is useful to define a function only when it's called.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10354
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10355 *local-function*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10356 A function local to a script must start with "s:". A local script function
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10357 can only be called from within the script and from functions, user commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10358 and autocommands defined in the script. It is also possible to call the
1698
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
10359 function from a mapping defined in the script, but then |<SID>| must be used
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10360 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
10361 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
10362 functions.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10363
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10364 *:fu* *:function* *E128* *E129* *E123*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10365 :fu[nction] List all functions and their arguments.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10366
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10367 :fu[nction] {name} List function {name}.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10368 {name} can also be a |Dictionary| entry that is a
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10369 |Funcref|: >
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10370 :function dict.init
504
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
10371
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
10372 :fu[nction] /{pattern} List functions with a name matching {pattern}.
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
10373 Example that lists all functions ending with "File": >
35cde31bdcbd updated for version 7.0141
vimboss
parents: 502
diff changeset
10374 :function /File$
482
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
10375 <
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
10376 *:function-verbose*
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
10377 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
10378 last defined. Example: >
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
10379
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
10380 :verbose function SetFileTypeSH
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
10381 function SetFileTypeSH(name)
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
10382 Last set from /usr/share/vim/vim-7.0/filetype.vim
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
10383 <
484
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 482
diff changeset
10384 See |:verbose-cmd| for more information.
482
6f8b578776ab updated for version 7.0131
vimboss
parents: 477
diff changeset
10385
5862
306caa30d83b Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 5815
diff changeset
10386 *E124* *E125* *E853* *E884*
9688
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10387 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] [closure]
12756
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
10388 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
10389 the function follows in the next lines, until the
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
10390 matching |:endfunction|.
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
10391
12756
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
10392 The name must be made of alphanumeric characters and
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
10393 '_', and must start with a capital or "s:" (see
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
10394 above). Note that using "b:" or "g:" is not allowed.
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
10395 (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
10396 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
10397 Before that patch no error was given).
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10398
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10399 {name} can also be a |Dictionary| entry that is a
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10400 |Funcref|: >
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10401 :function dict.init(arg)
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
10402 < "dict" must be an existing dictionary. The entry
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10403 "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
10404 is required to overwrite an existing function. The
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10405 result is a |Funcref| to a numbered function. The
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10406 function can only be used with a |Funcref| and will be
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10407 deleted if there are no more references to it.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10408 *E127* *E122*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10409 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
10410 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
10411 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
10412 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
10413 silently replaced.
67e3103d6e18 patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
10414 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
10415 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
10416 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
10417 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
10418 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
10419 which is hard to debug.
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10420
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10421 For the {arguments} see |function-argument|.
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10422
5618
350272cbf1fd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5596
diff changeset
10423 *:func-range* *a:firstline* *a:lastline*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10424 When the [range] argument is added, the function is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10425 expected to take care of a range itself. The range is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10426 passed as "a:firstline" and "a:lastline". If [range]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10427 is excluded, ":{range}call" will call the function for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10428 each line in the range, with the cursor on the start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10429 of each line. See |function-range-example|.
3967
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3920
diff changeset
10430 The cursor is still moved to the first line of the
fdb8a9c7bd91 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3920
diff changeset
10431 range, as is the case with all Ex commands.
5618
350272cbf1fd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5596
diff changeset
10432 *:func-abort*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10433 When the [abort] argument is added, the function will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10434 abort as soon as an error is detected.
5618
350272cbf1fd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5596
diff changeset
10435 *:func-dict*
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
10436 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
10437 be invoked through an entry in a |Dictionary|. The
102
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
10438 local variable "self" will then be set to the
0aa0e89bfd5f updated for version 7.0039
vimboss
parents: 99
diff changeset
10439 dictionary. See |Dictionary-function|.
9688
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10440 *:func-closure* *E932*
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10441 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
10442 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
10443 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
10444 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
10445 remains referenced even after Foo() returns: >
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10446 :function! Foo()
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10447 : let x = 0
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10448 : function! Bar() closure
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10449 : let x += 1
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10450 : return x
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10451 : endfunction
9737
35ce559b8553 commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents: 9723
diff changeset
10452 : return funcref('Bar')
9688
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10453 :endfunction
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10454
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10455 :let F = Foo()
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10456 :echo F()
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10457 < 1 >
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10458 :echo F()
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10459 < 2 >
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10460 :echo F()
2ea935bdd1a1 commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents: 9686
diff changeset
10461 < 3
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10462
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
10463 *function-search-undo*
653
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
10464 The last used search pattern and the redo command "."
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
10465 will not be changed by the function. This also
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
10466 implies that the effect of |:nohlsearch| is undone
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
10467 when the function returns.
653
5acda076fb0c updated for version 7.0192
vimboss
parents: 650
diff changeset
10468
11561
7ad79766365a patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents: 11553
diff changeset
10469 *:endf* *:endfunction* *E126* *E193* *W22*
11543
57c452316da1 patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents: 11518
diff changeset
10470 :endf[unction] [argument]
57c452316da1 patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents: 11518
diff changeset
10471 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
10472 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
10473
57c452316da1 patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents: 11518
diff changeset
10474 [argument] can be:
57c452316da1 patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents: 11518
diff changeset
10475 | 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
10476 \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
10477 " 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
10478 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
10479 '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
10480 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
10481 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
10482 ignored.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10483
11561
7ad79766365a patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents: 11553
diff changeset
10484 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
10485 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
10486 :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
10487 <
9723
80ac9cf77c9b commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents: 9688
diff changeset
10488 *:delf* *:delfunction* *E130* *E131* *E933*
11543
57c452316da1 patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents: 11518
diff changeset
10489 :delf[unction][!] {name}
57c452316da1 patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents: 11518
diff changeset
10490 Delete function {name}.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10491 {name} can also be a |Dictionary| entry that is a
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10492 |Funcref|: >
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10493 :delfunc dict.init
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
10494 < This will remove the "init" entry from "dict". The
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10495 function is deleted if there are no more references to
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10496 it.
11543
57c452316da1 patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents: 11518
diff changeset
10497 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
10498 exist.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10499 *:retu* *:return* *E133*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10500 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10501 evaluated and returned as the result of the function.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10502 If "[expr]" is not given, the number 0 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10503 When a function ends without an explicit ":return",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10504 the number 0 is returned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10505 Note that there is no check for unreachable lines,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10506 thus there is no warning if commands follow ":return".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10507
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10508 If the ":return" is used after a |:try| but before the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10509 matching |:finally| (if present), the commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10510 following the ":finally" up to the matching |:endtry|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10511 are executed first. This process applies to all
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10512 nested ":try"s inside the function. The function
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10513 returns at the outermost ":endtry".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10514
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10515 *function-argument* *a:var*
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
10516 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
10517 be used as "a:name" ("a:" for argument).
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
10518 *a:0* *a:1* *a:000* *E740* *...*
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10519 Up to 20 arguments can be given, separated by commas. After the named
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10520 arguments an argument "..." can be specified, which means that more arguments
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10521 may optionally be following. In the function the extra arguments can be used
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10522 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
10523 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
10524 that "a:1" is the same as "a:000[0]".
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10525 *E742*
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10526 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
10527 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
10528 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
10529 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
10530 change a |List| or |Dictionary| use |:lockvar|.
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10531
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10532 When not using "...", the number of arguments in a function call must be equal
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10533 to the number of named arguments. When using "...", the number of arguments
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10534 may be larger.
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10535
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10536 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
10537 still supply the () then.
3b26420fc639 Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents: 12722
diff changeset
10538
13482
9eebe457eb3c Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents: 13438
diff changeset
10539 It is allowed to define another function inside a function body.
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10540
bcb347a8f934 updated for version 7.0044
vimboss
parents: 123
diff changeset
10541 *local-variables*
9527
e8b3db8e2d30 commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents: 9464
diff changeset
10542 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
10543 function returns. Global variables need to be accessed with "g:".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10544
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10545 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10546 :function Table(title, ...)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10547 : echohl Title
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10548 : echo a:title
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10549 : echohl None
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
10550 : echo a:0 . " items:"
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
10551 : for s in a:000
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
10552 : echon ' ' . s
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
10553 : endfor
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10554 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10555
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10556 This function can then be called with: >
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
10557 call Table("Table", "line1", "line2")
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
10558 call Table("Empty Table")
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10559
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
10560 To return more than one value, return a |List|: >
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
10561 :function Compute(n1, n2)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10562 : if a:n2 == 0
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
10563 : return ["fail", 0]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10564 : endif
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
10565 : return ["ok", a:n1 / a:n2]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10566 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10567
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10568 This function can then be called with: >
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
10569 :let [success, div] = Compute(102, 6)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10570 :if success == "ok"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10571 : echo div
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10572 :endif
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
10573 <
786
8f6a426bc1e0 updated for version 7.0229
vimboss
parents: 782
diff changeset
10574 *:cal* *:call* *E107* *E117*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10575 :[range]cal[l] {name}([arguments])
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10576 Call a function. The name of the function and its arguments
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10577 are as specified with |:function|. Up to 20 arguments can be
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
10578 used. The returned value is discarded.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10579 Without a range and for functions that accept a range, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10580 function is called once. When a range is given the cursor is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10581 positioned at the start of the first line before executing the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10582 function.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10583 When a range is given and the function doesn't handle it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10584 itself, the function is executed for each line in the range,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10585 with the cursor in the first column of that line. The cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10586 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
10587 call). The arguments are re-evaluated for each line. Thus
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10588 this works:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10589 *function-range-example* >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10590 :function Mynumber(arg)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10591 : echo line(".") . " " . a:arg
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10592 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10593 :1,5call Mynumber(getline("."))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10594 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10595 The "a:firstline" and "a:lastline" are defined anyway, they
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10596 can be used to do something different at the start or end of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10597 the range.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10598
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10599 Example of a function that handles the range itself: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10600
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10601 :function Cont() range
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10602 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ '
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10603 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10604 :4,8call Cont()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10605 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10606 This function inserts the continuation character "\" in front
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10607 of all the lines in the range, except the first one.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10608
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
10609 When the function returns a composite value it can be further
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
10610 dereferenced, but the range will not be used then. Example: >
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
10611 :4,8call GetDict().method()
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
10612 < Here GetDict() gets the range but method() does not.
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
10613
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10614 *E132*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10615 The recursiveness of user functions is restricted with the |'maxfuncdepth'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10616 option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10617
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10618
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10619 AUTOMATICALLY LOADING FUNCTIONS ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10620 *autoload-functions*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10621 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
10622 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
10623 the "autoload" directory in 'runtimepath'.
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10624
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10625
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10626 Using an autocommand ~
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10627
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
10628 This is introduced in the user manual, section |41.14|.
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
10629
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10630 The autocommand is useful if you have a plugin that is a long Vim script file.
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10631 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
10632 That makes Vim startup faster. The autocommand should then load the same file
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10633 again, setting a variable to skip the |:finish| command.
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10634
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10635 Use the FuncUndefined autocommand event with a pattern that matches the
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10636 function(s) to be defined. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10637
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10638 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10639
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10640 The file "~/vim/bufnetfuncs.vim" should then define functions that start with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10641 "BufNet". Also see |FuncUndefined|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10642
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10643
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10644 Using an autoload script ~
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
10645 *autoload* *E746*
170
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
10646 This is introduced in the user manual, section |41.15|.
8c60f65311fa updated for version 7.0052
vimboss
parents: 168
diff changeset
10647
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10648 Using a script in the "autoload" directory is simpler, but requires using
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10649 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
10650 like this: >
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10651
270
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
10652 :call filename#funcname()
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10653
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10654 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
10655 "autoload" directories in 'runtimepath' for a script file called
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10656 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10657 then define the function like this: >
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10658
270
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
10659 function filename#funcname()
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10660 echo "Done!"
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10661 endfunction
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10662
530
339999b511a0 updated for version 7.0148
vimboss
parents: 523
diff changeset
10663 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
10664 exactly, and the defined function must have the name exactly as it will be
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10665 called.
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10666
270
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
10667 It is possible to use subdirectories. Every # in the function name works like
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
10668 a path separator. Thus when calling a function: >
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
10669
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
10670 :call foo#bar#func()
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10671
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10672 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'.
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10673
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
10674 This also works when reading a variable that has not been set yet: >
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
10675
270
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
10676 :let l = foo#bar#lvar
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
10677
557
862863033fdd updated for version 7.0158
vimboss
parents: 555
diff changeset
10678 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
10679 for an unknown variable.
862863033fdd updated for version 7.0158
vimboss
parents: 555
diff changeset
10680
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
10681 When assigning a value to such a variable nothing special happens. This can
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
10682 be used to pass settings to the autoload script before it's loaded: >
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
10683
270
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
10684 :let foo#bar#toggle = 1
a20218704019 updated for version 7.0072
vimboss
parents: 258
diff changeset
10685 :call foo#bar#func()
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
10686
164
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
10687 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
10688 defined in an autoload script, but the script doesn't actually define the
8b0ee9d57d7f updated for version 7.0050
vimboss
parents: 161
diff changeset
10689 function, the script will be sourced every time you try to call the function.
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
10690 And you will get an error message every time.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
10691
4d9eabb1396e updated for version 7.0051
vimboss
parents: 164
diff changeset
10692 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
10693 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
10694 Avoid using the autoload functionality at the toplevel.
161
6df0106fc595 updated for version 7.0049
vimboss
parents: 158
diff changeset
10695
794
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
10696 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
10697 |vimball| utility. Also read the user manual |distribute-script|.
f19994020dad updated for version 7.0231
vimboss
parents: 790
diff changeset
10698
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10699 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10700 6. Curly braces names *curly-braces-names*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10701
3410
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
10702 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
10703 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
10704 wrapped in braces {} like this: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10705 my_{adjective}_variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10706
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10707 When Vim encounters this, it evaluates the expression inside the braces, puts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10708 that in place of the expression, and re-interprets the whole as a variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10709 name. So in the above example, if the variable "adjective" was set to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10710 "noisy", then the reference would be to "my_noisy_variable", whereas if
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10711 "adjective" was set to "quiet", then it would be to "my_quiet_variable".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10712
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10713 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
10714 value. For example, the statement >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10715 echo my_{&background}_message
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10716
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10717 would output the contents of "my_dark_message" or "my_light_message" depending
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10718 on the current value of 'background'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10719
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10720 You can use multiple brace pairs: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10721 echo my_{adverb}_{adjective}_message
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10722 ..or even nest them: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10723 echo my_{ad{end_of_word}}_message
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10724 where "end_of_word" is either "verb" or "jective".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10725
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10726 However, the expression inside the braces must evaluate to a valid single
236
4707450c2b33 updated for version 7.0066
vimboss
parents: 233
diff changeset
10727 variable name, e.g. this is invalid: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10728 :let foo='a + b'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10729 :echo c{foo}d
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10730 .. since the result of expansion is "ca + bd", which is not a variable name.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10731
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10732 *curly-braces-function-names*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10733 You can call and define functions by an evaluated name in a similar way.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10734 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10735 :let func_end='whizz'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10736 :call my_func_{func_end}(parameter)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10737
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10738 This would call the function "my_func_whizz(parameter)".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10739
3410
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
10740 This does NOT work: >
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
10741 :let i = 3
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
10742 :let @{i} = '' " error
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
10743 :echo @{i} " error
94601b379f38 Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents: 3398
diff changeset
10744
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10745 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10746 7. Commands *expression-commands*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10747
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10748 :let {var-name} = {expr1} *:let* *E18*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10749 Set internal variable {var-name} to the result of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10750 expression {expr1}. The variable will get the type
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10751 from the {expr}. If {var-name} didn't exist yet, it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10752 is created.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10753
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
10754 :let {var-name}[{idx}] = {expr1} *E689*
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
10755 Set a list item to the result of the expression
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
10756 {expr1}. {var-name} must refer to a list and {idx}
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
10757 must be a valid index in that list. For nested list
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
10758 the index can be repeated.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
10759 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
10760 This cannot be used to set a byte in a String. You
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
10761 can do that like this: >
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
10762 :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
10763 < 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
10764 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
10765 appended.
1d2b5c016f17 patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents: 15446
diff changeset
10766
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10767 *E711* *E719*
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10768 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10769 Set a sequence of items in a |List| to the result of
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10770 the expression {expr1}, which must be a list with the
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
10771 correct number of items.
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
10772 {idx1} can be omitted, zero is used instead.
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
10773 {idx2} can be omitted, meaning the end of the list.
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
10774 When the selected range of items is partly past the
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
10775 end of the list, items will be added.
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
10776
153
19670b05ee32 updated for version 7.0047
vimboss
parents: 148
diff changeset
10777 *:let+=* *:let-=* *:let.=* *E734*
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10778 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}".
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10779 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}".
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10780 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}".
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10781 These fail if {var} was not set yet and when the type
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10782 of {var} and {expr1} don't fit the operator.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10783
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10784
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10785 :let ${env-name} = {expr1} *:let-environment* *:let-$*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10786 Set environment variable {env-name} to the result of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10787 the expression {expr1}. The type is always String.
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10788 :let ${env-name} .= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10789 Append {expr1} to the environment variable {env-name}.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10790 If the environment variable didn't exist yet this
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10791 works like "=".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10792
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10793 :let @{reg-name} = {expr1} *:let-register* *:let-@*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10794 Write the result of the expression {expr1} in register
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10795 {reg-name}. {reg-name} must be a single letter, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10796 must be the name of a writable register (see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10797 |registers|). "@@" can be used for the unnamed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10798 register, "@/" for the search pattern.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10799 If the result of {expr1} ends in a <CR> or <NL>, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10800 register will be linewise, otherwise it will be set to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10801 characterwise.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10802 This can be used to clear the last search pattern: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10803 :let @/ = ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10804 < This is different from searching for an empty string,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10805 that would match everywhere.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10806
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10807 :let @{reg-name} .= {expr1}
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
10808 Append {expr1} to register {reg-name}. If the
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10809 register was empty it's like setting it to {expr1}.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10810
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
10811 :let &{option-name} = {expr1} *:let-option* *:let-&*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10812 Set option {option-name} to the result of the
68
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10813 expression {expr1}. A String or Number value is
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10814 always converted to the type of the option.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10815 For an option local to a window or buffer the effect
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10816 is just like using the |:set| command: both the local
555
a5efb97bc104 updated for version 7.0157
vimboss
parents: 548
diff changeset
10817 value and the global value are changed.
68
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10818 Example: >
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10819 :let &path = &path . ',/usr/local/include'
10895
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10787
diff changeset
10820 < This also works for terminal codes in the form t_xx.
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10787
diff changeset
10821 But only for alphanumerical names. Example: >
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10787
diff changeset
10822 :let &t_k1 = "\<Esc>[234;"
c391bfbdb452 Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents: 10787
diff changeset
10823 < 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
10824 a terminal key code, there is no error.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10825
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10826 :let &{option-name} .= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10827 For a string option: Append {expr1} to the value.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10828 Does not insert a comma like |:set+=|.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10829
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10830 :let &{option-name} += {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10831 :let &{option-name} -= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10832 For a number or boolean option: Add or subtract
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10833 {expr1}.
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10834
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10835 :let &l:{option-name} = {expr1}
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10836 :let &l:{option-name} .= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10837 :let &l:{option-name} += {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10838 :let &l:{option-name} -= {expr1}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10839 Like above, but only set the local value of an option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10840 (if there is one). Works like |:setlocal|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10841
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10842 :let &g:{option-name} = {expr1}
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10843 :let &g:{option-name} .= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10844 :let &g:{option-name} += {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10845 :let &g:{option-name} -= {expr1}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10846 Like above, but only set the global value of an option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10847 (if there is one). Works like |:setglobal|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10848
85
fc244e0a6e7e updated for version 7.0034
vimboss
parents: 82
diff changeset
10849 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688*
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10850 {expr1} must evaluate to a |List|. The first item in
68
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10851 the list is assigned to {name1}, the second item to
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10852 {name2}, etc.
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10853 The number of names must match the number of items in
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10854 the |List|.
68
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10855 Each name can be one of the items of the ":let"
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10856 command as mentioned above.
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10857 Example: >
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10858 :let [s, item] = GetItem(s)
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10859 < Detail: {expr1} is evaluated first, then the
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10860 assignments are done in sequence. This matters if
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10861 {name2} depends on {name1}. Example: >
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10862 :let x = [0, 1]
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10863 :let i = 0
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10864 :let [i, x[i]] = [1, 2]
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10865 :echo x
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10866 < The result is [0, 2].
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10867
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10868 :let [{name1}, {name2}, ...] .= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10869 :let [{name1}, {name2}, ...] += {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10870 :let [{name1}, {name2}, ...] -= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10871 Like above, but append/add/subtract the value for each
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10872 |List| item.
68
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10873
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10874 :let [{name}, ..., ; {lastname}] = {expr1}
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10875 Like |:let-unpack| above, but the |List| may have more
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10876 items than there are names. A list of the remaining
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10877 items is assigned to {lastname}. If there are no
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10878 remaining items {lastname} is set to an empty list.
68
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10879 Example: >
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10880 :let [a, b; rest] = ["aval", "bval", 3, 4]
a97c6902ecd9 updated for version 7.0030
vimboss
parents: 55
diff changeset
10881 <
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10882 :let [{name}, ..., ; {lastname}] .= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10883 :let [{name}, ..., ; {lastname}] += {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10884 :let [{name}, ..., ; {lastname}] -= {expr1}
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
10885 Like above, but append/add/subtract the value for each
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10886 |List| item.
2596
fae782ef63dd Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2581
diff changeset
10887
fae782ef63dd Runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2581
diff changeset
10888 *E121*
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
10889 :let {var-name} .. List the value of variable {var-name}. Multiple
123
f67f8a8d81ba updated for version 7.0043
vimboss
parents: 119
diff changeset
10890 variable names may be given. Special names recognized
f67f8a8d81ba updated for version 7.0043
vimboss
parents: 119
diff changeset
10891 here: *E738*
777
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
10892 g: global variables
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
10893 b: local buffer variables
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
10894 w: local window variables
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
10895 t: local tab page variables
777
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
10896 s: script-local variables
f664cc974a7a updated for version 7.0227
vimboss
parents: 724
diff changeset
10897 l: local function variables
123
f67f8a8d81ba updated for version 7.0043
vimboss
parents: 119
diff changeset
10898 v: Vim variables.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10899
55
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
10900 :let List the values of all variables. The type of the
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
10901 variable is indicated before the value:
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
10902 <nothing> String
225cc00b2eda updated for version 7.0029
vimboss
parents: 37
diff changeset
10903 # Number
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
10904 * Funcref
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10905
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10906
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
10907 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795*
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10908 Remove the internal variable {name}. Several variable
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10909 names can be given, they are all removed. The name
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10910 may also be a |List| or |Dictionary| item.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10911 With [!] no error message is given for non-existing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10912 variables.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10913 One or more items from a |List| can be removed: >
108
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
10914 :unlet list[3] " remove fourth item
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
10915 :unlet list[3:] " remove fourth item to last
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10916 < One item from a |Dictionary| can be removed at a time: >
108
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
10917 :unlet dict['two']
375b1d0f97b0 updated for version 7.0040
vimboss
parents: 102
diff changeset
10918 :unlet dict.two
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
10919 < This is especially useful to clean up used global
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
10920 variables and script-local variables (these are not
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
10921 deleted when the script ends). Function-local
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
10922 variables are automatically deleted when the function
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1661
diff changeset
10923 ends.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10924
13923
e4d5726e1678 patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents: 13821
diff changeset
10925 :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
10926 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
10927 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
10928 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
10929 variable, also without !.
e4d5726e1678 patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents: 13821
diff changeset
10930 If the system does not support deleting an environment
e4d5726e1678 patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents: 13821
diff changeset
10931 variable, it is made emtpy.
e4d5726e1678 patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents: 13821
diff changeset
10932
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10933 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv*
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10934 Lock the internal variable {name}. Locking means that
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10935 it can no longer be changed (until it is unlocked).
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10936 A locked variable can be deleted: >
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10937 :lockvar v
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10938 :let v = 'asdf' " fails!
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10939 :unlet v
10908
6b6abffbdf59 patch 8.0.0343: b:changedtick can be unlocked
Christian Brabandt <cb@256bit.org>
parents: 10895
diff changeset
10940 < *E741* *E940*
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10941 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
10942 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
10943 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
10944 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
10945 variable {name}".
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10946
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10947 [depth] is relevant when locking a |List| or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10948 |Dictionary|. It specifies how deep the locking goes:
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10949 1 Lock the |List| or |Dictionary| itself,
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10950 cannot add or remove items, but can
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10951 still change their values.
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10952 2 Also lock the values, cannot change
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10953 the items. If an item is a |List| or
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10954 |Dictionary|, cannot add or remove
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10955 items, but can still change the
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10956 values.
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10957 3 Like 2 but for the |List| /
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10958 |Dictionary| in the |List| /
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10959 |Dictionary|, one level deeper.
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10960 The default [depth] is 2, thus when {name} is a |List|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10961 or |Dictionary| the values cannot be changed.
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10962 *E743*
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10963 For unlimited depth use [!] and omit [depth].
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10964 However, there is a maximum depth of 100 to catch
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10965 loops.
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10966
685
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10967 Note that when two variables refer to the same |List|
d7e33248b9c8 updated for version 7.0206
vimboss
parents: 681
diff changeset
10968 and you lock one of them, the |List| will also be
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
10969 locked when used through the other variable.
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 818
diff changeset
10970 Example: >
148
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10971 :let l = [0, 1, 2, 3]
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10972 :let cl = l
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10973 :lockvar l
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10974 :let cl[1] = 99 " won't work!
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10975 < You may want to make a copy of a list to avoid this.
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10976 See |deepcopy()|.
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10977
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10978
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10979 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo*
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10980 Unlock the internal variable {name}. Does the
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10981 opposite of |:lockvar|.
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10982
72aefd4c1e0d updated for version 7.0046
vimboss
parents: 140
diff changeset
10983
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10984 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10985 :en[dif] Execute the commands until the next matching ":else"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10986 or ":endif" if {expr1} evaluates to non-zero.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10987
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10988 From Vim version 4.5 until 5.0, every Ex command in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10989 between the ":if" and ":endif" is ignored. These two
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10990 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
10991 backward compatible way. Nesting was allowed. Note
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10992 that any ":else" or ":elseif" was ignored, the "else"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10993 part was not executed either.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10994
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10995 You can use this to remain compatible with older
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10996 versions: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10997 :if version >= 500
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10998 : version-5-specific-commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10999 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11000 < The commands still need to be parsed to find the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11001 "endif". Sometimes an older Vim has a problem with a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11002 new command. For example, ":silent" is recognized as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11003 a ":substitute" command. In that case ":execute" can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11004 avoid problems: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11005 :if version >= 600
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11006 : execute "silent 1,$delete"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11007 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11008 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11009 NOTE: The ":append" and ":insert" commands don't work
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11010 properly in between ":if" and ":endif".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11011
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11012 *:else* *:el* *E581* *E583*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11013 :el[se] Execute the commands until the next matching ":else"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11014 or ":endif" if they previously were not being
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11015 executed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11016
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11017 *:elseif* *:elsei* *E582* *E584*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11018 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11019 is no extra ":endif".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11020
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11021 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw*
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
11022 *E170* *E585* *E588* *E733*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11023 :endw[hile] Repeat the commands between ":while" and ":endwhile",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11024 as long as {expr1} evaluates to non-zero.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11025 When an error is detected from a command inside the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11026 loop, execution continues after the "endwhile".
75
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11027 Example: >
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11028 :let lnum = 1
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11029 :while lnum <= line("$")
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11030 :call FixLine(lnum)
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11031 :let lnum = lnum + 1
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11032 :endwhile
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11033 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11034 NOTE: The ":append" and ":insert" commands don't work
99
04f2e519ab18 updated for version 7.0038
vimboss
parents: 95
diff changeset
11035 properly inside a ":while" and ":for" loop.
75
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11036
114
f6e567606d47 updated for version 7.0041
vimboss
parents: 108
diff changeset
11037 :for {var} in {list} *:for* *E690* *E732*
75
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11038 :endfo[r] *:endfo* *:endfor*
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11039 Repeat the commands between ":for" and ":endfor" for
158
78423945b251 updated for version 7.0048
vimboss
parents: 153
diff changeset
11040 each item in {list}. Variable {var} is set to the
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
11041 value of each item.
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
11042 When an error is detected for a command inside the
75
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11043 loop, execution continues after the "endfor".
464
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
11044 Changing {list} inside the loop affects what items are
3b705e71c7b0 updated for version 7.0124
vimboss
parents: 459
diff changeset
11045 used. Make a copy if this is unwanted: >
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
11046 :for item in copy(mylist)
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
11047 < When not making a copy, Vim stores a reference to the
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
11048 next item in the list, before executing the commands
9877
7da89d9c744b commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents: 9861
diff changeset
11049 with the current item. Thus the current item can be
79
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
11050 removed without effect. Removing any later item means
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
11051 it will not be found. Thus the following example
e918d3e340a4 updated for version 7.0032
vimboss
parents: 75
diff changeset
11052 works (an inefficient way to make a list empty): >
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
11053 for item in mylist
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
11054 call remove(mylist, 0)
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
11055 endfor
87
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
11056 < Note that reordering the list (e.g., with sort() or
014ba200db86 updated for version 7.0035
vimboss
parents: 85
diff changeset
11057 reverse()) may have unexpected effects.
75
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11058
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11059 :for [{var1}, {var2}, ...] in {listlist}
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11060 :endfo[r]
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11061 Like ":for" above, but each item in {listlist} must be
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11062 a list, of which each item is assigned to {var1},
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11063 {var2}, etc. Example: >
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11064 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]]
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11065 :echo getline(lnum)[col]
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11066 :endfor
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11067 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11068 *:continue* *:con* *E586*
75
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11069 :con[tinue] When used inside a ":while" or ":for" loop, jumps back
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11070 to the start of the loop.
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11071 If it is used after a |:try| inside the loop but
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11072 before the matching |:finally| (if present), the
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11073 commands following the ":finally" up to the matching
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11074 |:endtry| are executed first. This process applies to
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11075 all nested ":try"s inside the loop. The outermost
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11076 ":endtry" then jumps back to the start of the loop.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11077
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11078 *:break* *:brea* *E587*
75
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11079 :brea[k] When used inside a ":while" or ":for" loop, skips to
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11080 the command after the matching ":endwhile" or
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11081 ":endfor".
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11082 If it is used after a |:try| inside the loop but
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11083 before the matching |:finally| (if present), the
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11084 commands following the ":finally" up to the matching
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11085 |:endtry| are executed first. This process applies to
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11086 all nested ":try"s inside the loop. The outermost
388f285bda1b updated for version 7.0031
vimboss
parents: 68
diff changeset
11087 ":endtry" then jumps to the command after the loop.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11088
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11089 :try *:try* *:endt* *:endtry* *E600* *E601* *E602*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11090 :endt[ry] Change the error handling for the commands between
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11091 ":try" and ":endtry" including everything being
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11092 executed across ":source" commands, function calls,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11093 or autocommand invocations.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11094
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11095 When an error or interrupt is detected and there is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11096 a |:finally| command following, execution continues
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11097 after the ":finally". Otherwise, or when the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11098 ":endtry" is reached thereafter, the next
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11099 (dynamically) surrounding ":try" is checked for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11100 a corresponding ":finally" etc. Then the script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11101 processing is terminated. (Whether a function
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11102 definition has an "abort" argument does not matter.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11103 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11104 :try | edit too much | finally | echo "cleanup" | endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11105 :echo "impossible" " not reached, script terminated above
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11106 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11107 Moreover, an error or interrupt (dynamically) inside
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11108 ":try" and ":endtry" is converted to an exception. It
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11109 can be caught as if it were thrown by a |:throw|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11110 command (see |:catch|). In this case, the script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11111 processing is not terminated.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11112
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11113 The value "Vim:Interrupt" is used for an interrupt
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11114 exception. An error in a Vim command is converted
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11115 to a value of the form "Vim({command}):{errmsg}",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11116 other errors are converted to a value of the form
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11117 "Vim:{errmsg}". {command} is the full command name,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11118 and {errmsg} is the message that is displayed if the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11119 error exception is not caught, always beginning with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11120 the error number.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11121 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11122 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11123 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11124 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11125 *:cat* *:catch* *E603* *E604* *E605*
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
11126 :cat[ch] /{pattern}/ The following commands until the next |:catch|,
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11127 |:finally|, or |:endtry| that belongs to the same
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11128 |:try| as the ":catch" are executed when an exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11129 matching {pattern} is being thrown and has not yet
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11130 been caught by a previous ":catch". Otherwise, these
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11131 commands are skipped.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11132 When {pattern} is omitted all errors are caught.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11133 Examples: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11134 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11135 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11136 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11137 :catch /^Vim(write):/ " catch all errors in :write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11138 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11139 :catch /my-exception/ " catch user exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11140 :catch /.*/ " catch everything
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11141 :catch " same as /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11142 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11143 Another character can be used instead of / around the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11144 {pattern}, so long as it does not have a special
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11145 meaning (e.g., '|' or '"') and doesn't occur inside
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11146 {pattern}.
5814
755931e042e4 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5808
diff changeset
11147 Information about the exception is available in
755931e042e4 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5808
diff changeset
11148 |v:exception|. Also see |throw-variables|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11149 NOTE: It is not reliable to ":catch" the TEXT of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11150 an error message because it may vary in different
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11151 locales.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11152
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11153 *:fina* *:finally* *E606* *E607*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11154 :fina[lly] The following commands until the matching |:endtry|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11155 are executed whenever the part between the matching
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11156 |:try| and the ":finally" is left: either by falling
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11157 through to the ":finally" or by a |:continue|,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11158 |:break|, |:finish|, or |:return|, or by an error or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11159 interrupt or exception (see |:throw|).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11160
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11161 *:th* *:throw* *E608*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11162 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11163 If the ":throw" is used after a |:try| but before the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11164 first corresponding |:catch|, commands are skipped
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11165 until the first ":catch" matching {expr1} is reached.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11166 If there is no such ":catch" or if the ":throw" is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11167 used after a ":catch" but before the |:finally|, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11168 commands following the ":finally" (if present) up to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11169 the matching |:endtry| are executed. If the ":throw"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11170 is after the ":finally", commands up to the ":endtry"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11171 are skipped. At the ":endtry", this process applies
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11172 again for the next dynamically surrounding ":try"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11173 (which may be found in a calling function or sourcing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11174 script), until a matching ":catch" has been found.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11175 If the exception is not caught, the command processing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11176 is terminated.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11177 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11178 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry
2725
6f63330ec225 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2709
diff changeset
11179 < Note that "catch" may need to be on a separate line
6f63330ec225 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2709
diff changeset
11180 for when an error causes the parsing to skip the whole
6f63330ec225 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2709
diff changeset
11181 line and not see the "|" that separates the commands.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11182
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11183 *:ec* *:echo*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11184 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11185 first {expr1} starts on a new line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11186 Also see |:comment|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11187 Use "\n" to start a new line. Use "\r" to move the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11188 cursor to the first column.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11189 Uses the highlighting set by the |:echohl| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11190 Cannot be followed by a comment.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11191 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11192 :echo "the value of 'shell' is" &shell
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
11193 < *:echo-redraw*
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
11194 A later redraw may make the message disappear again.
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
11195 And since Vim mostly postpones redrawing until it's
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
11196 finished with a sequence of commands this happens
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
11197 quite often. To avoid that a command from before the
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
11198 ":echo" causes a redraw afterwards (redraws are often
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
11199 postponed until you type something), force a redraw
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
11200 with the |:redraw| command. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11201 :new | redraw | echo "there is a new window"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11202 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11203 *:echon*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11204 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11205 |:comment|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11206 Uses the highlighting set by the |:echohl| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11207 Cannot be followed by a comment.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11208 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11209 :echon "the value of 'shell' is " &shell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11210 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11211 Note the difference between using ":echo", which is a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11212 Vim command, and ":!echo", which is an external shell
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11213 command: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11214 :!echo % --> filename
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11215 < The arguments of ":!" are expanded, see |:_%|. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11216 :!echo "%" --> filename or "filename"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11217 < Like the previous example. Whether you see the double
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11218 quotes or not depends on your 'shell'. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11219 :echo % --> nothing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11220 < The '%' is an illegal character in an expression. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11221 :echo "%" --> %
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11222 < This just echoes the '%' character. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11223 :echo expand("%") --> filename
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11224 < This calls the expand() function to expand the '%'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11225
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11226 *:echoh* *:echohl*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11227 :echoh[l] {name} Use the highlight group {name} for the following
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11228 |:echo|, |:echon| and |:echomsg| commands. Also used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11229 for the |input()| prompt. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11230 :echohl WarningMsg | echo "Don't panic!" | echohl None
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11231 < Don't forget to set the group back to "None",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11232 otherwise all following echo's will be highlighted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11233
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11234 *:echom* *:echomsg*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11235 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11236 message in the |message-history|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11237 Spaces are placed between the arguments as with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11238 |:echo| command. But unprintable characters are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11239 displayed, not interpreted.
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
11240 The parsing works slightly different from |:echo|,
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
11241 more like |:execute|. All the expressions are first
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
11242 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
11243 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
11244 String, string() is used to turn it into a string.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11245 Uses the highlighting set by the |:echohl| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11246 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11247 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see."
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
11248 < See |:echo-redraw| to avoid the message disappearing
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
11249 when the screen is redrawn.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11250 *:echoe* *:echoerr*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11251 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11252 message in the |message-history|. When used in a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11253 script or function the line number will be added.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11254 Spaces are placed between the arguments as with the
15219
dada0b389d4f patch 8.1.0619: :echomsg and :echoerr do not handle List and Dict
Bram Moolenaar <Bram@vim.org>
parents: 15209
diff changeset
11255 |:echomsg| command. When used inside a try conditional,
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11256 the message is raised as an error exception instead
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11257 (see |try-echoerr|).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11258 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11259 :echoerr "This script just failed!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11260 < If you just want a highlighted message use |:echohl|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11261 And to get a beep: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11262 :exe "normal \<Esc>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11263 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11264 *:exe* *:execute*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11265 :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
11266 of {expr1} as an Ex command.
b9e314fe473f Updated runtime files.
Bram Moolenaar <bram@zimbu.org>
parents: 2120
diff changeset
11267 Multiple arguments are concatenated, with a space in
b9e314fe473f Updated runtime files.
Bram Moolenaar <bram@zimbu.org>
parents: 2120
diff changeset
11268 between. To avoid the extra space use the "."
b9e314fe473f Updated runtime files.
Bram Moolenaar <bram@zimbu.org>
parents: 2120
diff changeset
11269 operator to concatenate strings into one argument.
b9e314fe473f Updated runtime files.
Bram Moolenaar <bram@zimbu.org>
parents: 2120
diff changeset
11270 {expr1} is used as the processed command, command line
b9e314fe473f Updated runtime files.
Bram Moolenaar <bram@zimbu.org>
parents: 2120
diff changeset
11271 editing keys are not recognized.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11272 Cannot be followed by a comment.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11273 Examples: >
2152
b9e314fe473f Updated runtime files.
Bram Moolenaar <bram@zimbu.org>
parents: 2120
diff changeset
11274 :execute "buffer" nextbuf
b9e314fe473f Updated runtime files.
Bram Moolenaar <bram@zimbu.org>
parents: 2120
diff changeset
11275 :execute "normal" count . "w"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11276 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11277 ":execute" can be used to append a command to commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11278 that don't accept a '|'. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11279 :execute '!ls' | echo "theend"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11280
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11281 < ":execute" is also a nice way to avoid having to type
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11282 control characters in a Vim script for a ":normal"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11283 command: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11284 :execute "normal ixxx\<Esc>"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11285 < This has an <Esc> character, see |expr-string|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11286
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11287 Be careful to correctly escape special characters in
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11288 file names. The |fnameescape()| function can be used
1661
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
11289 for Vim commands, |shellescape()| for |:!| commands.
5bbc2d6658ad updated for version 7.2a-013
vimboss
parents: 1621
diff changeset
11290 Examples: >
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11291 :execute "e " . fnameescape(filename)
5692
80e5f9584b02 Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents: 5690
diff changeset
11292 :execute "!ls " . shellescape(filename, 1)
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11293 <
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11294 Note: The executed string may be any command-line, but
5763
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5747
diff changeset
11295 starting or ending "if", "while" and "for" does not
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5747
diff changeset
11296 always work, because when commands are skipped the
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5747
diff changeset
11297 ":execute" is not evaluated and Vim loses track of
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5747
diff changeset
11298 where blocks start and end. Also "break" and
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5747
diff changeset
11299 "continue" should not be inside ":execute".
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5747
diff changeset
11300 This example does not work, because the ":execute" is
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5747
diff changeset
11301 not evaluated and Vim does not see the "while", and
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5747
diff changeset
11302 gives an error for finding an ":endwhile": >
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5747
diff changeset
11303 :if 0
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5747
diff changeset
11304 : execute 'while i > 5'
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5747
diff changeset
11305 : echo "test"
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5747
diff changeset
11306 : endwhile
c52a655d927d Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5747
diff changeset
11307 :endif
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11308 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11309 It is allowed to have a "while" or "if" command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11310 completely in the executed string: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11311 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11312 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11313
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
11314 *:exe-comment*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11315 ":execute", ":echo" and ":echon" cannot be followed by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11316 a comment directly, because they see the '"' as the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11317 start of a string. But, you can use '|' followed by a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11318 comment. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11319 :echo "foo" | "this is a comment
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11320
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11321 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11322 8. Exception handling *exception-handling*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11323
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11324 The Vim script language comprises an exception handling feature. This section
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11325 explains how it can be used in a Vim script.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11326
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11327 Exceptions may be raised by Vim on an error or on interrupt, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11328 |catch-errors| and |catch-interrupt|. You can also explicitly throw an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11329 exception by using the ":throw" command, see |throw-catch|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11330
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11331
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11332 TRY CONDITIONALS *try-conditionals*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11333
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11334 Exceptions can be caught or can cause cleanup code to be executed. You can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11335 use a try conditional to specify catch clauses (that catch exceptions) and/or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11336 a finally clause (to be executed for cleanup).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11337 A try conditional begins with a |:try| command and ends at the matching
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11338 |:endtry| command. In between, you can use a |:catch| command to start
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11339 a catch clause, or a |:finally| command to start a finally clause. There may
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11340 be none or multiple catch clauses, but there is at most one finally clause,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11341 which must not be followed by any catch clauses. The lines before the catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11342 clauses and the finally clause is called a try block. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11343
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11344 :try
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11345 : ...
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11346 : ... TRY BLOCK
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11347 : ...
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11348 :catch /{pattern}/
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11349 : ...
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11350 : ... CATCH CLAUSE
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11351 : ...
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11352 :catch /{pattern}/
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11353 : ...
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11354 : ... CATCH CLAUSE
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11355 : ...
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11356 :finally
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11357 : ...
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11358 : ... FINALLY CLAUSE
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11359 : ...
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11360 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11361
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11362 The try conditional allows to watch code for exceptions and to take the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11363 appropriate actions. Exceptions from the try block may be caught. Exceptions
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11364 from the try block and also the catch clauses may cause cleanup actions.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11365 When no exception is thrown during execution of the try block, the control
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11366 is transferred to the finally clause, if present. After its execution, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11367 script continues with the line following the ":endtry".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11368 When an exception occurs during execution of the try block, the remaining
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11369 lines in the try block are skipped. The exception is matched against the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11370 patterns specified as arguments to the ":catch" commands. The catch clause
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11371 after the first matching ":catch" is taken, other catch clauses are not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11372 executed. The catch clause ends when the next ":catch", ":finally", or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11373 ":endtry" command is reached - whatever is first. Then, the finally clause
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11374 (if present) is executed. When the ":endtry" is reached, the script execution
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11375 continues in the following line as usual.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11376 When an exception that does not match any of the patterns specified by the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11377 ":catch" commands is thrown in the try block, the exception is not caught by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11378 that try conditional and none of the catch clauses is executed. Only the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11379 finally clause, if present, is taken. The exception pends during execution of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11380 the finally clause. It is resumed at the ":endtry", so that commands after
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11381 the ":endtry" are not executed and the exception might be caught elsewhere,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11382 see |try-nesting|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11383 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
11384 remaining lines in that catch clause are not executed. The new exception is
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11385 not matched against the patterns in any of the ":catch" commands of the same
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11386 try conditional and none of its catch clauses is taken. If there is, however,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11387 a finally clause, it is executed, and the exception pends during its
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11388 execution. The commands following the ":endtry" are not executed. The new
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11389 exception might, however, be caught elsewhere, see |try-nesting|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11390 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
11391 thrown, the remaining lines in the finally clause are skipped. If the finally
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11392 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
11393 catch clauses, the original (pending) exception is discarded. The commands
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11394 following the ":endtry" are not executed, and the exception from the finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11395 clause is propagated and can be caught elsewhere, see |try-nesting|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11396
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11397 The finally clause is also executed, when a ":break" or ":continue" for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11398 a ":while" loop enclosing the complete try conditional is executed from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11399 try block or a catch clause. Or when a ":return" or ":finish" is executed
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11400 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
11401 sourced script, respectively. The ":break", ":continue", ":return", or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11402 ":finish" pends during execution of the finally clause and is resumed when the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11403 ":endtry" is reached. It is, however, discarded when an exception is thrown
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11404 from the finally clause.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11405 When a ":break" or ":continue" for a ":while" loop enclosing the complete
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11406 try conditional or when a ":return" or ":finish" is encountered in the finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11407 clause, the rest of the finally clause is skipped, and the ":break",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11408 ":continue", ":return" or ":finish" is executed as usual. If the finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11409 clause has been taken because of an exception or an earlier ":break",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11410 ":continue", ":return", or ":finish" from the try block or a catch clause,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11411 this pending exception or command is discarded.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11412
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11413 For examples see |throw-catch| and |try-finally|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11414
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11415
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11416 NESTING OF TRY CONDITIONALS *try-nesting*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11417
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11418 Try conditionals can be nested arbitrarily. That is, a complete try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11419 conditional can be put into the try block, a catch clause, or the finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11420 clause of another try conditional. If the inner try conditional does not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11421 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
11422 of its catch clauses or its finally clause, the outer try conditional is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11423 checked according to the rules above. If the inner try conditional is in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11424 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
11425 otherwise only the finally clause is executed. It does not matter for
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11426 nesting, whether the inner try conditional is directly contained in the outer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11427 one, or whether the outer one sources a script or calls a function containing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11428 the inner try conditional.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11429
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11430 When none of the active try conditionals catches an exception, just their
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11431 finally clauses are executed. Thereafter, the script processing terminates.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11432 An error message is displayed in case of an uncaught exception explicitly
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11433 thrown by a ":throw" command. For uncaught error and interrupt exceptions
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11434 implicitly raised by Vim, the error message(s) or interrupt message are shown
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11435 as usual.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11436
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11437 For examples see |throw-catch|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11438
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11439
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11440 EXAMINING EXCEPTION HANDLING CODE *except-examine*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11441
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11442 Exception handling code can get tricky. If you are in doubt what happens, set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11443 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11444 script file. Then you see when an exception is thrown, discarded, caught, or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11445 finished. When using a verbosity level of at least 14, things pending in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11446 a finally clause are also shown. This information is also given in debug mode
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11447 (see |debug-scripts|).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11448
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11449
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11450 THROWING AND CATCHING EXCEPTIONS *throw-catch*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11451
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11452 You can throw any number or string as an exception. Use the |:throw| command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11453 and pass the value to be thrown as argument: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11454 :throw 4711
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11455 :throw "string"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11456 < *throw-expression*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11457 You can also specify an expression argument. The expression is then evaluated
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11458 first, and the result is thrown: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11459 :throw 4705 + strlen("string")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11460 :throw strpart("strings", 0, 6)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11461
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11462 An exception might be thrown during evaluation of the argument of the ":throw"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11463 command. Unless it is caught there, the expression evaluation is abandoned.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11464 The ":throw" command then does not throw a new exception.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11465 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11466
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11467 :function! Foo(arg)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11468 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11469 : throw a:arg
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11470 : catch /foo/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11471 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11472 : return 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11473 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11474 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11475 :function! Bar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11476 : echo "in Bar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11477 : return 4710
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11478 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11479 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11480 :throw Foo("arrgh") + Bar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11481
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11482 This throws "arrgh", and "in Bar" is not displayed since Bar() is not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11483 executed. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11484 :throw Foo("foo") + Bar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11485 however displays "in Bar" and throws 4711.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11486
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11487 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
11488 abandoned by an (uncaught) exception during the expression evaluation. The
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11489 exception is then propagated to the caller of the command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11490 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11491
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11492 :if Foo("arrgh")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11493 : echo "then"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11494 :else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11495 : echo "else"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11496 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11497
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11498 Here neither of "then" or "else" is displayed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11499
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11500 *catch-order*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11501 Exceptions can be caught by a try conditional with one or more |:catch|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11502 commands, see |try-conditionals|. The values to be caught by each ":catch"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11503 command can be specified as a pattern argument. The subsequent catch clause
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11504 gets executed when a matching exception is caught.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11505 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11506
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11507 :function! Foo(value)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11508 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11509 : throw a:value
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11510 : catch /^\d\+$/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11511 : echo "Number thrown"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11512 : catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11513 : echo "String thrown"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11514 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11515 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11516 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11517 :call Foo(0x1267)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11518 :call Foo('string')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11519
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11520 The first call to Foo() displays "Number thrown", the second "String thrown".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11521 An exception is matched against the ":catch" commands in the order they are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11522 specified. Only the first match counts. So you should place the more
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11523 specific ":catch" first. The following order does not make sense: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11524
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11525 : catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11526 : echo "String thrown"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11527 : catch /^\d\+$/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11528 : echo "Number thrown"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11529
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11530 The first ":catch" here matches always, so that the second catch clause is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11531 never taken.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11532
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11533 *throw-variables*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11534 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
11535 in the variable |v:exception|: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11536
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11537 : catch /^\d\+$/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11538 : echo "Number thrown. Value is" v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11539
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11540 You may also be interested where an exception was thrown. This is stored in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11541 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11542 exception most recently caught as long it is not finished.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11543 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11544
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11545 :function! Caught()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11546 : if v:exception != ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11547 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11548 : else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11549 : echo 'Nothing caught'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11550 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11551 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11552 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11553 :function! Foo()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11554 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11555 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11556 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11557 : throw 4711
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11558 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11559 : call Caught()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11560 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11561 : catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11562 : call Caught()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11563 : throw "oops"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11564 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11565 : catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11566 : call Caught()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11567 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11568 : call Caught()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11569 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11570 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11571 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11572 :call Foo()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11573
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11574 This displays >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11575
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11576 Nothing caught
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11577 Caught "4711" in function Foo, line 4
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11578 Caught "oops" in function Foo, line 10
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11579 Nothing caught
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11580
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11581 A practical example: The following command ":LineNumber" displays the line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11582 number in the script or function where it has been used: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11583
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11584 :function! LineNumber()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11585 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11586 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11587 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11588 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11589 *try-nested*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11590 An exception that is not caught by a try conditional can be caught by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11591 a surrounding try conditional: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11592
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11593 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11594 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11595 : throw "foo"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11596 : catch /foobar/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11597 : echo "foobar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11598 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11599 : echo "inner finally"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11600 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11601 :catch /foo/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11602 : echo "foo"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11603 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11604
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11605 The inner try conditional does not catch the exception, just its finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11606 clause is executed. The exception is then caught by the outer try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11607 conditional. The example displays "inner finally" and then "foo".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11608
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11609 *throw-from-catch*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11610 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
11611 catch clause: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11612
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11613 :function! Foo()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11614 : throw "foo"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11615 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11616 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11617 :function! Bar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11618 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11619 : call Foo()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11620 : catch /foo/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11621 : echo "Caught foo, throw bar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11622 : throw "bar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11623 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11624 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11625 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11626 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11627 : call Bar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11628 :catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11629 : echo "Caught" v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11630 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11631
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11632 This displays "Caught foo, throw bar" and then "Caught bar".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11633
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11634 *rethrow*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11635 There is no real rethrow in the Vim script language, but you may throw
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11636 "v:exception" instead: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11637
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11638 :function! Bar()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11639 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11640 : call Foo()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11641 : catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11642 : echo "Rethrow" v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11643 : throw v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11644 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11645 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11646 < *try-echoerr*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11647 Note that this method cannot be used to "rethrow" Vim error or interrupt
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11648 exceptions, because it is not possible to fake Vim internal exceptions.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11649 Trying so causes an error exception. You should throw your own exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11650 denoting the situation. If you want to cause a Vim error exception containing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11651 the original error exception value, you can use the |:echoerr| command: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11652
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11653 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11654 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11655 : asdf
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11656 : catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11657 : echoerr v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11658 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11659 :catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11660 : echo v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11661 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11662
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11663 This code displays
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11664
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
11665 Vim(echoerr):Vim:E492: Not an editor command: asdf ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11666
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11667
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11668 CLEANUP CODE *try-finally*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11669
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11670 Scripts often change global settings and restore them at their end. If the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11671 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
11672 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
11673 a script when an error occurs or you explicitly throw an exception without
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11674 catching it. You can solve these problems by using a try conditional with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11675 a finally clause for restoring the settings. Its execution is guaranteed on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11676 normal control flow, on error, on an explicit ":throw", and on interrupt.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11677 (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
11678 to exceptions. When not caught, they terminate the script after the finally
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11679 clause has been executed.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11680 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11681
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11682 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11683 : let s:saved_ts = &ts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11684 : set ts=17
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11685 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11686 : " Do the hard work here.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11687 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11688 :finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11689 : let &ts = s:saved_ts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11690 : unlet s:saved_ts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11691 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11692
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11693 This method should be used locally whenever a function or part of a script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11694 changes global settings which need to be restored on failure or normal exit of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11695 that function or script part.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11696
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11697 *break-finally*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11698 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
11699 a ":continue", ":break", ":return", or ":finish".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11700 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11701
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11702 :let first = 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11703 :while 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11704 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11705 : if first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11706 : echo "first"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11707 : let first = 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11708 : continue
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11709 : else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11710 : throw "second"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11711 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11712 : catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11713 : echo v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11714 : break
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11715 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11716 : echo "cleanup"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11717 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11718 : echo "still in while"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11719 :endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11720 :echo "end"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11721
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11722 This displays "first", "cleanup", "second", "cleanup", and "end". >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11723
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11724 :function! Foo()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11725 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11726 : return 4711
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11727 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11728 : echo "cleanup\n"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11729 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11730 : echo "Foo still active"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11731 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11732 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11733 :echo Foo() "returned by Foo"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11734
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11735 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
11736 extra ":return" in the finally clause. (Above all, this would override the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11737 return value.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11738
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11739 *except-from-finally*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11740 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11741 a finally clause is possible, but not recommended since it abandons the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11742 cleanup actions for the try conditional. But, of course, interrupt and error
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11743 exceptions might get raised from a finally clause.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11744 Example where an error in the finally clause stops an interrupt from
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11745 working correctly: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11746
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11747 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11748 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11749 : echo "Press CTRL-C for interrupt"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11750 : while 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11751 : endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11752 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11753 : unlet novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11754 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11755 :catch /novar/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11756 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11757 :echo "Script still running"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11758 :sleep 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11759
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11760 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
11761 think about catching or ignoring the errors in these commands, see
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11762 |catch-errors| and |ignore-errors|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11763
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11764
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11765 CATCHING ERRORS *catch-errors*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11766
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11767 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
11768 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
11769 presence of the try conditional causes all errors to be converted to an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11770 exception. No message is displayed and |v:errmsg| is not set then. To find
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11771 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
11772 the error exception is.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11773 Error exceptions have the following format: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11774
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11775 Vim({cmdname}):{errmsg}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11776 or >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11777 Vim:{errmsg}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11778
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11779 {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
11780 the command name is not known. {errmsg} is the error message usually produced
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11781 when the error occurs outside try conditionals. It always begins with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11782 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
11783 a space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11784
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11785 Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11786
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11787 The command >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11788 :unlet novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11789 normally produces the error message >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11790 E108: No such variable: "novar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11791 which is converted inside try conditionals to an exception >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11792 Vim(unlet):E108: No such variable: "novar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11793
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11794 The command >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11795 :dwim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11796 normally produces the error message >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11797 E492: Not an editor command: dwim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11798 which is converted inside try conditionals to an exception >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11799 Vim:E492: Not an editor command: dwim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11800
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11801 You can catch all ":unlet" errors by a >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11802 :catch /^Vim(unlet):/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11803 or all errors for misspelled command names by a >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11804 :catch /^Vim:E492:/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11805
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11806 Some error messages may be produced by different commands: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11807 :function nofunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11808 and >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11809 :delfunction nofunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11810 both produce the error message >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11811 E128: Function name must start with a capital: nofunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11812 which is converted inside try conditionals to an exception >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11813 Vim(function):E128: Function name must start with a capital: nofunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11814 or >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11815 Vim(delfunction):E128: Function name must start with a capital: nofunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11816 respectively. You can catch the error by its number independently on the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11817 command that caused it if you use the following pattern: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11818 :catch /^Vim(\a\+):E128:/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11819
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11820 Some commands like >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11821 :let x = novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11822 produce multiple error messages, here: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11823 E121: Undefined variable: novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11824 E15: Invalid expression: novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11825 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
11826 one (see |except-several-errors|). So you can catch it by >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11827 :catch /^Vim(\a\+):E121:/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11828
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11829 You can catch all errors related to the name "nofunc" by >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11830 :catch /\<nofunc\>/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11831
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11832 You can catch all Vim errors in the ":write" and ":read" commands by >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11833 :catch /^Vim(\(write\|read\)):E\d\+:/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11834
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11835 You can catch all Vim errors by the pattern >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11836 :catch /^Vim\((\a\+)\)\=:E\d\+:/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11837 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11838 *catch-text*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11839 NOTE: You should never catch the error message text itself: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11840 :catch /No such variable/
6647
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6583
diff changeset
11841 only works in the English locale, but not when the user has selected
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11842 a different language by the |:language| command. It is however helpful to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11843 cite the message text in a comment: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11844 :catch /^Vim(\a\+):E108:/ " No such variable
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11845
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11846
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11847 IGNORING ERRORS *ignore-errors*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11848
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11849 You can ignore errors in a specific Vim command by catching them locally: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11850
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11851 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11852 : write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11853 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11854 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11855
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11856 But you are strongly recommended NOT to use this simple form, since it could
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11857 catch more than you want. With the ":write" command, some autocommands could
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11858 be executed and cause errors not related to writing, for instance: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11859
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11860 :au BufWritePre * unlet novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11861
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11862 There could even be such errors you are not responsible for as a script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11863 writer: a user of your script might have defined such autocommands. You would
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11864 then hide the error from the user.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11865 It is much better to use >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11866
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11867 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11868 : write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11869 :catch /^Vim(write):/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11870 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11871
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11872 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
11873 intentionally.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11874
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11875 For a single command that does not cause execution of autocommands, you could
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11876 even suppress the conversion of errors to exceptions by the ":silent!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11877 command: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11878 :silent! nunmap k
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11879 This works also when a try conditional is active.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11880
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11881
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11882 CATCHING INTERRUPTS *catch-interrupt*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11883
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11884 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
11885 the exception "Vim:Interrupt". You can catch it like every exception. The
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11886 script is not terminated, then.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11887 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11888
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11889 :function! TASK1()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11890 : sleep 10
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11891 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11892
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11893 :function! TASK2()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11894 : sleep 20
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11895 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11896
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11897 :while 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11898 : let command = input("Type a command: ")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11899 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11900 : if command == ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11901 : continue
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11902 : elseif command == "END"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11903 : break
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11904 : elseif command == "TASK1"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11905 : call TASK1()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11906 : elseif command == "TASK2"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11907 : call TASK2()
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11908 : else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11909 : echo "\nIllegal command:" command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11910 : continue
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11911 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11912 : catch /^Vim:Interrupt$/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11913 : echo "\nCommand interrupted"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11914 : " Caught the interrupt. Continue with next prompt.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11915 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11916 :endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11917
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11918 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
11919 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
11920
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11921 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
11922 your script, use the debug mode and execute the |>quit| or |>interrupt|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11923 command on that line. See |debug-scripts|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11924
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11925
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11926 CATCHING ALL *catch-all*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11927
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11928 The commands >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11929
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11930 :catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11931 :catch //
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11932 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11933
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11934 catch everything, error exceptions, interrupt exceptions and exceptions
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11935 explicitly thrown by the |:throw| command. This is useful at the top level of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11936 a script in order to catch unexpected things.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11937 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11938
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11939 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11940 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11941 : " do the hard work here
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11942 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11943 :catch /MyException/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11944 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11945 : " handle known problem
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11946 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11947 :catch /^Vim:Interrupt$/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11948 : echo "Script interrupted"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11949 :catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11950 : echo "Internal error (" . v:exception . ")"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11951 : echo " - occurred at " . v:throwpoint
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11952 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11953 :" end of script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11954
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11955 Note: Catching all might catch more things than you want. Thus, you are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11956 strongly encouraged to catch only for problems that you can really handle by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11957 specifying a pattern argument to the ":catch".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11958 Example: Catching all could make it nearly impossible to interrupt a script
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11959 by pressing CTRL-C: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11960
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11961 :while 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11962 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11963 : sleep 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11964 : catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11965 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11966 :endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11967
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11968
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11969 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11970
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11971 Exceptions may be used during execution of autocommands. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11972
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11973 :autocmd User x try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11974 :autocmd User x throw "Oops!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11975 :autocmd User x catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11976 :autocmd User x echo v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11977 :autocmd User x endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11978 :autocmd User x throw "Arrgh!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11979 :autocmd User x echo "Should not be displayed"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11980 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11981 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11982 : doautocmd User x
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11983 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11984 : echo v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11985 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11986
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11987 This displays "Oops!" and "Arrgh!".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11988
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11989 *except-autocmd-Pre*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11990 For some commands, autocommands get executed before the main action of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11991 command takes place. If an exception is thrown and not caught in the sequence
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11992 of autocommands, the sequence and the command that caused its execution are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11993 abandoned and the exception is propagated to the caller of the command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11994 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11995
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11996 :autocmd BufWritePre * throw "FAIL"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11997 :autocmd BufWritePre * echo "Should not be displayed"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11998 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11999 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12000 : write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12001 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12002 : echo "Caught:" v:exception "from" v:throwpoint
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12003 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12004
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12005 Here, the ":write" command does not write the file currently being edited (as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12006 you can see by checking 'modified'), since the exception from the BufWritePre
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12007 autocommand abandons the ":write". The exception is then caught and the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12008 script displays: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12009
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12010 Caught: FAIL from BufWrite Auto commands for "*"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12011 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12012 *except-autocmd-Post*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12013 For some commands, autocommands get executed after the main action of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12014 command has taken place. If this main action fails and the command is inside
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12015 an active try conditional, the autocommands are skipped and an error exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12016 is thrown that can be caught by the caller of the command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12017 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12018
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12019 :autocmd BufWritePost * echo "File successfully written!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12020 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12021 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12022 : write /i/m/p/o/s/s/i/b/l/e
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12023 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12024 : echo v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12025 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12026
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12027 This just displays: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12028
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12029 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
12030
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12031 If you really need to execute the autocommands even when the main action
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12032 fails, trigger the event from the catch clause.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12033 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12034
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12035 :autocmd BufWritePre * set noreadonly
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12036 :autocmd BufWritePost * set readonly
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12037 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12038 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12039 : write /i/m/p/o/s/s/i/b/l/e
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12040 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12041 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12042 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12043 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12044 You can also use ":silent!": >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12045
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12046 :let x = "ok"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12047 :let v:errmsg = ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12048 :autocmd BufWritePost * if v:errmsg != ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12049 :autocmd BufWritePost * let x = "after fail"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12050 :autocmd BufWritePost * endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12051 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12052 : silent! write /i/m/p/o/s/s/i/b/l/e
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12053 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12054 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12055 :echo x
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12056
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12057 This displays "after fail".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12058
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12059 If the main action of the command does not fail, exceptions from the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12060 autocommands will be catchable by the caller of the command: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12061
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12062 :autocmd BufWritePost * throw ":-("
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12063 :autocmd BufWritePost * echo "Should not be displayed"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12064 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12065 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12066 : write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12067 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12068 : echo v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12069 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12070 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12071 *except-autocmd-Cmd*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12072 For some commands, the normal action can be replaced by a sequence of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12073 autocommands. Exceptions from that sequence will be catchable by the caller
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12074 of the command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12075 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
12076 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
12077 some way. >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12078
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12079 :if !exists("cnt")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12080 : let cnt = 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12081 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12082 : autocmd BufWriteCmd * if &modified
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12083 : autocmd BufWriteCmd * let cnt = cnt + 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12084 : autocmd BufWriteCmd * if cnt % 3 == 2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12085 : autocmd BufWriteCmd * throw "BufWriteCmdError"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12086 : autocmd BufWriteCmd * endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12087 : autocmd BufWriteCmd * write | set nomodified
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12088 : autocmd BufWriteCmd * if cnt % 3 == 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12089 : autocmd BufWriteCmd * throw "BufWriteCmdError"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12090 : autocmd BufWriteCmd * endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12091 : autocmd BufWriteCmd * echo "File successfully written!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12092 : autocmd BufWriteCmd * endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12093 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12094 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12095 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12096 : write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12097 :catch /^BufWriteCmdError$/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12098 : if &modified
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12099 : echo "Error on writing (file contents not changed)"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12100 : else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12101 : echo "Error after writing"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12102 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12103 :catch /^Vim(write):/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12104 : echo "Error on writing"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12105 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12106
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12107 When this script is sourced several times after making changes, it displays
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12108 first >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12109 File successfully written!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12110 then >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12111 Error on writing (file contents not changed)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12112 then >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12113 Error after writing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12114 etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12115
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12116 *except-autocmd-ill*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12117 You cannot spread a try conditional over autocommands for different events.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12118 The following code is ill-formed: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12119
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12120 :autocmd BufWritePre * try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12121 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12122 :autocmd BufWritePost * catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12123 :autocmd BufWritePost * echo v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12124 :autocmd BufWritePost * endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12125 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12126 :write
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12127
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12128
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12129 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12130
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12131 Some programming languages allow to use hierarchies of exception classes or to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12132 pass additional information with the object of an exception class. You can do
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12133 similar things in Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12134 In order to throw an exception from a hierarchy, just throw the complete
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12135 class name with the components separated by a colon, for instance throw the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12136 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12137 When you want to pass additional information with your exception class, add
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12138 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12139 for an error when writing "myfile".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12140 With the appropriate patterns in the ":catch" command, you can catch for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12141 base classes or derived classes of your hierarchy. Additional information in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12142 parentheses can be cut out from |v:exception| with the ":substitute" command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12143 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12144
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12145 :function! CheckRange(a, func)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12146 : if a:a < 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12147 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12148 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12149 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12150 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12151 :function! Add(a, b)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12152 : call CheckRange(a:a, "Add")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12153 : call CheckRange(a:b, "Add")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12154 : let c = a:a + a:b
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12155 : if c < 0
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12156 : throw "EXCEPT:MATHERR:OVERFLOW"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12157 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12158 : return c
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12159 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12160 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12161 :function! Div(a, b)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12162 : call CheckRange(a:a, "Div")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12163 : call CheckRange(a:b, "Div")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12164 : if (a:b == 0)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12165 : throw "EXCEPT:MATHERR:ZERODIV"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12166 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12167 : return a:a / a:b
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12168 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12169 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12170 :function! Write(file)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12171 : try
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
12172 : execute "write" fnameescape(a:file)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12173 : catch /^Vim(write):/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12174 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12175 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12176 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12177 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12178 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12179 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12180 : " something with arithmetics and I/O
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12181 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12182 :catch /^EXCEPT:MATHERR:RANGE/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12183 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12184 : echo "Range error in" function
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12185 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12186 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12187 : echo "Math error"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12188 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12189 :catch /^EXCEPT:IO/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12190 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12191 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12192 : if file !~ '^/'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12193 : let file = dir . "/" . file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12194 : endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12195 : echo 'I/O error for "' . file . '"'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12196 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12197 :catch /^EXCEPT/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12198 : echo "Unspecified error"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12199 :
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12200 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12201
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12202 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12203 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12204 exceptions with the "Vim" prefix; they are reserved for Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12205 Vim error exceptions are parameterized with the name of the command that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12206 failed, if known. See |catch-errors|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12207
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12208
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12209 PECULIARITIES
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12210 *except-compat*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12211 The exception handling concept requires that the command sequence causing the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12212 exception is aborted immediately and control is transferred to finally clauses
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12213 and/or a catch clause.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12214
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12215 In the Vim script language there are cases where scripts and functions
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12216 continue after an error: in functions without the "abort" flag or in a command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12217 after ":silent!", control flow goes to the following line, and outside
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12218 functions, control flow goes to the line following the outermost ":endwhile"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12219 or ":endif". On the other hand, errors should be catchable as exceptions
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12220 (thus, requiring the immediate abortion).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12221
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12222 This problem has been solved by converting errors to exceptions and using
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12223 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
12224 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
12225 be caught only from an active try conditional. If you want an immediate
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12226 termination without catching the error, just use a try conditional without
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12227 catch clause. (You can cause cleanup code being executed before termination
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12228 by specifying a finally clause.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12229
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12230 When no try conditional is active, the usual abortion and continuation
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12231 behavior is used instead of immediate abortion. This ensures compatibility of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12232 scripts written for Vim 6.1 and earlier.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12233
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12234 However, when sourcing an existing script that does not use exception handling
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12235 commands (or when calling one of its functions) from inside an active try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12236 conditional of a new script, you might change the control flow of the existing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12237 script on error. You get the immediate abortion on error and can catch the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12238 error in the new script. If however the sourced script suppresses error
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12239 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
12240 |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
12241 not converted to an exception. (See |:silent|.) So the only remaining cause
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12242 where this happens is for scripts that don't care about errors and produce
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12243 error messages. You probably won't want to use such code from your new
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12244 scripts.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12245
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12246 *except-syntax-err*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12247 Syntax errors in the exception handling commands are never caught by any of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12248 the ":catch" commands of the try conditional they belong to. Its finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12249 clauses, however, is executed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12250 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12251
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12252 :try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12253 : try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12254 : throw 4711
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12255 : catch /\(/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12256 : echo "in catch with syntax error"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12257 : catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12258 : echo "inner catch-all"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12259 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12260 : echo "inner finally"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12261 : endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12262 :catch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12263 : echo 'outer catch-all caught "' . v:exception . '"'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12264 : finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12265 : echo "outer finally"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12266 :endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12267
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12268 This displays: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12269 inner finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12270 outer catch-all caught "Vim(catch):E54: Unmatched \("
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12271 outer finally
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12272 The original exception is discarded and an error exception is raised, instead.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12273
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12274 *except-single-line*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12275 The ":try", ":catch", ":finally", and ":endtry" commands can be put on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12276 a single line, but then syntax errors may make it difficult to recognize the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12277 "catch" line, thus you better avoid this.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12278 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12279 :try | unlet! foo # | catch | endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12280 raises an error exception for the trailing characters after the ":unlet!"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12281 argument, but does not see the ":catch" and ":endtry" commands, so that the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12282 error exception is discarded and the "E488: Trailing characters" message gets
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12283 displayed.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12284
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12285 *except-several-errors*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12286 When several errors appear in a single command, the first error message is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12287 usually the most specific one and therefor converted to the error exception.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12288 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12289 echo novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12290 causes >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12291 E121: Undefined variable: novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12292 E15: Invalid expression: novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12293 The value of the error exception inside try conditionals is: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12294 Vim(echo):E121: Undefined variable: novar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12295 < *except-syntax-error*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12296 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
12297 the syntax error is used for the exception being thrown.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12298 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12299 unlet novar #
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12300 causes >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12301 E108: No such variable: "novar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12302 E488: Trailing characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12303 The value of the error exception inside try conditionals is: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12304 Vim(unlet):E488: Trailing characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12305 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
12306 not intended by the user. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12307 try
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12308 try | unlet novar # | catch | echo v:exception | endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12309 catch /.*/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12310 echo "outer catch:" v:exception
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12311 endtry
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12312 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12313 a "E600: Missing :endtry" error message is given, see |except-single-line|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12314
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12315 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12316 9. Examples *eval-examples*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12317
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12318 Printing in Binary ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12319 >
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1998
diff changeset
12320 :" The function Nr2Bin() returns the binary string representation of a number.
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12321 :func Nr2Bin(nr)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12322 : let n = a:nr
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12323 : let r = ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12324 : while n
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12325 : let r = '01'[n % 2] . r
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12326 : let n = n / 2
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12327 : endwhile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12328 : return r
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12329 :endfunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12330
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12331 :" The function String2Bin() converts each character in a string to a
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12332 :" binary string, separated with dashes.
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12333 :func String2Bin(str)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12334 : let out = ''
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12335 : for ix in range(strlen(a:str))
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12336 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix]))
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12337 : endfor
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12338 : return out[1:]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12339 :endfunc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12340
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12341 Example of its use: >
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12342 :echo Nr2Bin(32)
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12343 result: "100000" >
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12344 :echo String2Bin("32")
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12345 result: "110011-110010"
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12346
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12347
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12348 Sorting lines ~
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12349
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12350 This example sorts lines with a specific compare function. >
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12351
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12352 :func SortBuffer()
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12353 : let lines = getline(1, '$')
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12354 : call sort(lines, function("Strcmp"))
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12355 : call setline(1, lines)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12356 :endfunction
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12357
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12358 As a one-liner: >
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12359 :call setline(1, sort(getline(1, '$'), function("Strcmp")))
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12360
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12361
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12362 scanf() replacement ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12363 *sscanf*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12364 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
12365 line, you can use matchstr() and substitute() to do it. This example shows
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12366 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
12367 "foobar.txt, 123, 45". >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12368 :" Set up the match bit
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12369 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12370 :"get the part matching the whole expression
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12371 :let l = matchstr(line, mx)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12372 :"get each item out of the match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12373 :let file = substitute(l, mx, '\1', '')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12374 :let lnum = substitute(l, mx, '\2', '')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12375 :let col = substitute(l, mx, '\3', '')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12376
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12377 The input is in the variable "line", the results in the variables "file",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12378 "lnum" and "col". (idea from Michael Geddes)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12379
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12380
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12381 getting the scriptnames in a Dictionary ~
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12382 *scriptnames-dictionary*
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12383 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
12384 have been sourced. There is no equivalent function or variable for this
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12385 (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
12386 code can be used: >
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12387 " Get the output of ":scriptnames" in the scriptnames_output variable.
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12388 let scriptnames_output = ''
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12389 redir => scriptnames_output
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12390 silent scriptnames
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12391 redir END
12785
65d7fd8381a3 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 12756
diff changeset
12392
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
12393 " 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
12394 " "scripts" dictionary.
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12395 let scripts = {}
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12396 for line in split(scriptnames_output, "\n")
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12397 " Only do non-blank lines.
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12398 if line =~ '\S'
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12399 " Get the first number in the line.
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
12400 let nr = matchstr(line, '\d\+')
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12401 " Get the file name, remove the script number " 123: ".
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
12402 let name = substitute(line, '.\+:\s*', '', '')
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12403 " Add an item to the Dictionary
1621
82b5078be2dd updated for version 7.2a
vimboss
parents: 1609
diff changeset
12404 let scripts[nr] = name
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12405 endif
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12406 endfor
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12407 unlet scriptnames_output
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12408
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12409 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12410 10. No +eval feature *no-eval-feature*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12411
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12412 When the |+eval| feature was disabled at compile time, none of the expression
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12413 evaluation commands are available. To prevent this from causing Vim scripts
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12414 to generate all kinds of errors, the ":if" and ":endif" commands are still
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12415 recognized, though the argument of the ":if" and everything between the ":if"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12416 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12417 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
12418 recognized.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12419
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12420 Example of how to avoid executing commands when the |+eval| feature is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12421 missing: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12422
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12423 :if 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12424 : echo "Expression evaluation is compiled in"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12425 :else
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12426 : echo "You will _never_ see this message"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12427 :endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12428
11347
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
12429 To execute a command only when the |+eval| feature is disabled requires a trick,
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
12430 as this example shows: >
11414
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents: 11407
diff changeset
12431
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents: 11407
diff changeset
12432 silent! while 0
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents: 11407
diff changeset
12433 set history=111
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents: 11407
diff changeset
12434 silent! endwhile
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents: 11407
diff changeset
12435
c95c5ddc3b0d patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents: 11407
diff changeset
12436 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
12437 "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
12438 silently ignored, and the command is executed.
11347
4aae8146c21f Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11313
diff changeset
12439
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12440 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12441 11. The sandbox *eval-sandbox* *sandbox* *E48*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12442
2350
06feaf4fe36a Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents: 2345
diff changeset
12443 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
12444 '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
12445 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
12446 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
12447 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
12448 The sandbox is also used for the |:sandbox| command.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12449
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12450 These items are not allowed in the sandbox:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12451 - changing the buffer text
14347
723487cd7876 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14343
diff changeset
12452 - defining or changing mapping, autocommands, user commands
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12453 - setting certain options (see |option-summary|)
1156
9cec4e0b792a updated for version 7.1a
vimboss
parents: 1104
diff changeset
12454 - setting certain v: variables (see |v:var|) *E794*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12455 - executing a shell command
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12456 - reading or writing a file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12457 - jumping to another buffer or editing a file
625
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 620
diff changeset
12458 - executing Python, Perl, etc. commands
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
12459 This is not guaranteed 100% secure, but it should block most attacks.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
12460
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
12461 *:san* *:sandbox*
401
4a1ead01d30b updated for version 7.0105
vimboss
parents: 395
diff changeset
12462 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an
29
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
12463 option that may have been set from a modeline, e.g.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
12464 'foldexpr'.
ac33b7c03fac updated for version 7.0018
vimboss
parents: 26
diff changeset
12465
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12466 *sandbox-option*
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12467 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
12468 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
12469 restrictive, thus this only happens when the option was set from an insecure
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12470 location. Insecure in this context are:
843
9f279ebda751 updated for version 7.0f01
vimboss
parents: 842
diff changeset
12471 - sourcing a .vimrc or .exrc in the current directory
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12472 - while executing in the sandbox
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12473 - value coming from a modeline
14347
723487cd7876 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14343
diff changeset
12474 - executing a function that was defined in the sandbox
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12475
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12476 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
12477 option will still be marked as it was set in the sandbox.
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12478
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12479 ==============================================================================
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12480 12. Textlock *textlock*
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12481
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12482 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
12483 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
12484 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
12485 actually doing something else. For example, evaluating the 'balloonexpr' may
634
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12486 happen any moment the mouse cursor is resting at some position.
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12487
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12488 This is not allowed when the textlock is active:
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12489 - changing the buffer text
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12490 - jumping to another buffer or window
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12491 - editing another file
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12492 - closing a window or quitting Vim
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12493 - etc.
1c586ee8dd45 updated for version 7.0183
vimboss
parents: 626
diff changeset
12494
9887
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12495 ==============================================================================
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12496 13. Testing *testing*
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12497
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12498 Vim can be tested after building it, usually with "make test".
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12499 The tests are located in the directory "src/testdir".
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12500
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12501 There are several types of tests added over time:
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12502 test33.in oldest, don't add any more
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12503 test_something.in old style tests
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12504 test_something.vim new style tests
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12505
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12506 *new-style-testing*
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12507 New tests should be added as new style tests. These use functions such as
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12508 |assert_equal()| to keep the test commands and the expected result in one
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12509 place.
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12510 *old-style-testing*
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12511 In some cases an old style test needs to be used. E.g. when testing Vim
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12512 without the |+eval| feature.
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12513
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12514 Find more information in the file src/testdir/README.txt.
b4da19b7539f commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents: 9881
diff changeset
12515
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12516
14421
2f7e67dd088c Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14407
diff changeset
12517 vim:tw=78:ts=8:noet:ft=help:norl: