Mercurial > vim
annotate runtime/doc/eval.txt @ 20753:661eb972cb22
Update runtime files
Commit: https://github.com/vim/vim/commit/acc224064033e5cea21ef7f1eefb356ca06ff11d
Author: Bram Moolenaar <Bram@vim.org>
Date: Sun Jun 7 21:07:18 2020 +0200
Update runtime files
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Sun, 07 Jun 2020 21:15:04 +0200 |
| parents | 49673325ca13 |
| children | 821925509d8c |
| rev | line source |
|---|---|
| 20753 | 1 *eval.txt* For Vim version 8.2. Last change: 2020 Jun 07 |
| 1621 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 7 | 5 |
| 6 | |
| 7 Expression evaluation *expression* *expr* *E15* *eval* | |
| 8 | |
| 9 Using expressions is introduced in chapter 41 of the user manual |usr_41.txt|. | |
| 10 | |
| 11 Note: Expression evaluation can be disabled at compile time. If this has been | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
12 done, the features in this document are not available. See |+eval| and |
| 99 | 13 |no-eval-feature|. |
| 7 | 14 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
15 This file is about the backwards compatible Vim script. For Vim9 script, |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
16 which executes much faster, supports type checking and much more, see |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
17 |vim9.txt|. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
18 |
| 85 | 19 1. Variables |variables| |
| 20 1.1 Variable types | |
| 87 | 21 1.2 Function references |Funcref| |
| 161 | 22 1.3 Lists |Lists| |
| 99 | 23 1.4 Dictionaries |Dictionaries| |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
24 1.5 Blobs |Blobs| |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
25 1.6 More about variables |more-variables| |
| 85 | 26 2. Expression syntax |expression-syntax| |
| 27 3. Internal variable |internal-variables| | |
| 28 4. Builtin Functions |functions| | |
| 29 5. Defining functions |user-functions| | |
| 30 6. Curly braces names |curly-braces-names| | |
| 31 7. Commands |expression-commands| | |
| 32 8. Exception handling |exception-handling| | |
| 33 9. Examples |eval-examples| | |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
34 10. Vim script version |vimscript-version| |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
35 11. No +eval feature |no-eval-feature| |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
36 12. The sandbox |eval-sandbox| |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
37 13. Textlock |textlock| |
|
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
38 |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
39 Testing support is documented in |testing.txt|. |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
40 Profiling is documented at |profiling|. |
| 7 | 41 |
| 42 ============================================================================== | |
| 43 1. Variables *variables* | |
| 44 | |
| 85 | 45 1.1 Variable types ~ |
|
15579
391ac26c9412
patch 8.1.0797: error E898 is used twice
Bram Moolenaar <Bram@vim.org>
parents:
15571
diff
changeset
|
46 *E712* *E896* *E897* *E899* |
| 17909 | 47 There are ten types of variables: |
| 1621 | 48 |
| 18831 | 49 *Number* *Integer* |
| 50 Number A 32 or 64 bit signed number. |expr-number| | |
|
19477
2bb0e80fcd32
patch 8.2.0296: mixing up "long long" and __int64 may cause problems
Bram Moolenaar <Bram@vim.org>
parents:
19400
diff
changeset
|
51 The number of bits is available in |v:numbersize|. |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
52 Examples: -123 0x10 0177 0b1011 |
| 99 | 53 |
| 1621 | 54 Float A floating point number. |floating-point-format| *Float* |
| 55 {only when compiled with the |+float| feature} | |
| 56 Examples: 123.456 1.15e-6 -1.1e3 | |
| 57 | |
|
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
58 *E928* |
| 99 | 59 String A NUL terminated string of 8-bit unsigned characters (bytes). |
| 1621 | 60 |expr-string| Examples: "ab\txx\"--" 'x-z''a,c' |
| 99 | 61 |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
62 List An ordered sequence of items, see |List| for details. |
| 99 | 63 Example: [1, 2, ['a', 'b']] |
| 55 | 64 |
| 370 | 65 Dictionary An associative, unordered array: Each entry has a key and a |
| 66 value. |Dictionary| | |
|
17368
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
67 Examples: |
|
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
68 {'blue': "#0000ff", 'red': "#ff0000"} |
|
17413
40417757dffd
patch 8.1.1705: using ~{} for a literal dict is not nice
Bram Moolenaar <Bram@vim.org>
parents:
17387
diff
changeset
|
69 #{blue: "#0000ff", red: "#ff0000"} |
| 370 | 70 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
71 Funcref A reference to a function |Funcref|. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
72 Example: function("strlen") |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
73 It can be bound to a dictionary and arguments, it then works |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
74 like a Partial. |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
75 Example: function("Callback", [arg], myDict) |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
76 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
77 Special |v:false|, |v:true|, |v:none| and |v:null|. *Special* |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
78 |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
79 Job Used for a job, see |job_start()|. *Job* *Jobs* |
|
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
80 |
|
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
81 Channel Used for a channel, see |ch_open()|. *Channel* *Channels* |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
82 |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
83 Blob Binary Large Object. Stores any sequence of bytes. See |Blob| |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
84 for details |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
85 Example: 0zFF00ED015DAF |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
86 0z is an empty Blob. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
87 |
| 55 | 88 The Number and String types are converted automatically, depending on how they |
| 89 are used. | |
| 7 | 90 |
| 91 Conversion from a Number to a String is by making the ASCII representation of | |
| 2581 | 92 the Number. Examples: |
| 93 Number 123 --> String "123" ~ | |
| 94 Number 0 --> String "0" ~ | |
| 95 Number -1 --> String "-1" ~ | |
| 2152 | 96 *octal* |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
97 Conversion from a String to a Number is done by converting the first digits to |
|
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
98 a number. Hexadecimal "0xf9", Octal "017" or "0o17", and Binary "0b10" |
|
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
99 numbers are recognized (NOTE: when using |scriptversion-4| octal with a |
|
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
100 leading "0" is not recognized). If the String doesn't start with digits, the |
|
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
101 result is zero. |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
102 Examples: |
| 2581 | 103 String "456" --> Number 456 ~ |
| 104 String "6bar" --> Number 6 ~ | |
| 105 String "foo" --> Number 0 ~ | |
| 106 String "0xf1" --> Number 241 ~ | |
| 107 String "0100" --> Number 64 ~ | |
|
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
108 String "0o100" --> Number 64 ~ |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
109 String "0b101" --> Number 5 ~ |
| 2581 | 110 String "-8" --> Number -8 ~ |
| 111 String "+8" --> Number 0 ~ | |
| 7 | 112 |
| 113 To force conversion from String to Number, add zero to it: > | |
| 114 :echo "0100" + 0 | |
| 782 | 115 < 64 ~ |
| 116 | |
| 117 To avoid a leading zero to cause octal conversion, or for using a different | |
| 118 base, use |str2nr()|. | |
| 7 | 119 |
| 15512 | 120 *TRUE* *FALSE* *Boolean* |
| 7 | 121 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
|
122 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
|
123 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
|
124 |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
125 Note that in the command: > |
| 7 | 126 :if "foo" |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
127 :" NOT executed |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
128 "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
|
129 non-zero number it means TRUE: > |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
130 :if "8foo" |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
131 :" executed |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
132 To test for a non-empty string, use empty(): > |
| 3893 | 133 :if !empty("foo") |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
134 < |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
135 *non-zero-arg* |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
136 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
|
137 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
|
138 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
|
139 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
|
140 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
|
141 |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
142 *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
|
143 *E974* *E975* *E976* |
| 15512 | 144 |List|, |Dictionary|, |Funcref|, |Job|, |Channel| and |Blob| types are not |
| 145 automatically converted. | |
| 85 | 146 |
| 1621 | 147 *E805* *E806* *E808* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
148 When mixing Number and Float the Number is converted to Float. Otherwise |
| 1621 | 149 there is no automatic conversion of Float. You can use str2float() for String |
| 150 to Float, printf() for Float to String and float2nr() for Float to Number. | |
| 151 | |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
152 *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
|
153 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
|
154 |
|
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
155 *no-type-checking* |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
156 You will not get an error if you try to change the type of a variable. |
| 85 | 157 |
| 158 | |
| 87 | 159 1.2 Function references ~ |
| 153 | 160 *Funcref* *E695* *E718* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
161 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
|
162 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
|
163 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
|
164 around the arguments, to invoke the function it refers to. Example: > |
| 55 | 165 |
| 166 :let Fn = function("MyFunc") | |
| 167 :echo Fn() | |
| 114 | 168 < *E704* *E705* *E707* |
| 819 | 169 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You |
| 5340 | 170 can use "g:" but the following name must still start with a capital. You |
| 819 | 171 cannot have both a Funcref variable and a function with the same name. |
| 85 | 172 |
| 114 | 173 A special case is defining a function and directly assigning its Funcref to a |
| 174 Dictionary entry. Example: > | |
| 175 :function dict.init() dict | |
| 176 : let self.val = 0 | |
| 177 :endfunction | |
| 178 | |
| 179 The key of the Dictionary can start with a lower case letter. The actual | |
| 180 function name is not used here. Also see |numbered-function|. | |
| 181 | |
| 182 A Funcref can also be used with the |:call| command: > | |
| 183 :call Fn() | |
| 184 :call dict.init() | |
| 85 | 185 |
| 186 The name of the referenced function can be obtained with |string()|. > | |
| 119 | 187 :let func = string(Fn) |
| 85 | 188 |
| 189 You can use |call()| to invoke a Funcref and use a list variable for the | |
| 190 arguments: > | |
| 119 | 191 :let r = call(Fn, mylist) |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
192 < |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
193 *Partial* |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
194 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
|
195 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
|
196 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
|
197 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
|
198 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
199 let Cb = function('Callback', ['foo'], myDict) |
| 14999 | 200 call Cb('bar') |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
201 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
202 This will invoke the function as if using: > |
| 14999 | 203 call myDict.Callback('foo', 'bar') |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
204 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
205 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
|
206 |ch_open()|. |
|
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 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
|
209 a member of the Dictionary: > |
|
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 let myDict.myFunction = MyFunction |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
212 call myDict.myFunction() |
|
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 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
|
215 "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
|
216 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
|
217 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
218 let otherDict.myFunction = myDict.myFunction |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
219 call otherDict.myFunction() |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
220 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
221 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
|
222 this won't happen: > |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
223 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
224 let myDict.myFunction = function(MyFunction, myDict) |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
225 let otherDict.myFunction = myDict.myFunction |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
226 call otherDict.myFunction() |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
227 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
228 Here "self" will be "myDict", because it was bound explicitly. |
| 85 | 229 |
| 230 | |
| 87 | 231 1.3 Lists ~ |
| 5814 | 232 *list* *List* *Lists* *E686* |
| 55 | 233 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
|
234 can be accessed by their index number. Items can be added and removed at any |
| 55 | 235 position in the sequence. |
| 236 | |
| 85 | 237 |
| 238 List creation ~ | |
| 239 *E696* *E697* | |
| 55 | 240 A List is created with a comma separated list of items in square brackets. |
| 85 | 241 Examples: > |
| 242 :let mylist = [1, two, 3, "four"] | |
| 243 :let emptylist = [] | |
| 55 | 244 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
245 An item can be any expression. Using a List for an item creates a |
| 842 | 246 List of Lists: > |
| 85 | 247 :let nestlist = [[11, 12], [21, 22], [31, 32]] |
| 55 | 248 |
| 249 An extra comma after the last item is ignored. | |
| 250 | |
| 85 | 251 |
| 252 List index ~ | |
| 253 *list-index* *E684* | |
| 55 | 254 An item in the List can be accessed by putting the index in square brackets |
| 85 | 255 after the List. Indexes are zero-based, thus the first item has index zero. > |
| 256 :let item = mylist[0] " get the first item: 1 | |
| 55 | 257 :let item = mylist[2] " get the third item: 3 |
| 85 | 258 |
| 87 | 259 When the resulting item is a list this can be repeated: > |
| 85 | 260 :let item = nestlist[0][1] " get the first list, second item: 12 |
| 55 | 261 < |
| 85 | 262 A negative index is counted from the end. Index -1 refers to the last item in |
| 263 the List, -2 to the last but one item, etc. > | |
| 55 | 264 :let last = mylist[-1] " get the last item: "four" |
| 265 | |
| 85 | 266 To avoid an error for an invalid index use the |get()| function. When an item |
| 87 | 267 is not available it returns zero or the default value you specify: > |
| 85 | 268 :echo get(mylist, idx) |
| 269 :echo get(mylist, idx, "NONE") | |
| 270 | |
| 271 | |
| 272 List concatenation ~ | |
| 273 | |
| 274 Two lists can be concatenated with the "+" operator: > | |
| 275 :let longlist = mylist + [5, 6] | |
| 119 | 276 :let mylist += [7, 8] |
| 85 | 277 |
| 278 To prepend or append an item turn the item into a list by putting [] around | |
| 279 it. To change a list in-place see |list-modification| below. | |
| 280 | |
| 281 | |
| 282 Sublist ~ | |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
283 *sublist* |
| 55 | 284 A part of the List can be obtained by specifying the first and last index, |
| 285 separated by a colon in square brackets: > | |
| 85 | 286 :let shortlist = mylist[2:-1] " get List [3, "four"] |
| 55 | 287 |
| 288 Omitting the first index is similar to zero. Omitting the last index is | |
| 1156 | 289 similar to -1. > |
| 90 | 290 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"] |
| 291 :let shortlist = mylist[2:2] " List with one item: [3] | |
| 292 :let otherlist = mylist[:] " make a copy of the List | |
| 85 | 293 |
| 842 | 294 If the first index is beyond the last item of the List or the second item is |
| 295 before the first item, the result is an empty list. There is no error | |
| 296 message. | |
| 297 | |
| 298 If the second index is equal to or greater than the length of the list the | |
| 299 length minus one is used: > | |
| 829 | 300 :let mylist = [0, 1, 2, 3] |
| 301 :echo mylist[2:8] " result: [2, 3] | |
| 302 | |
| 270 | 303 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
|
304 using a single letter variable before the ":". Insert a space when needed: |
| 270 | 305 mylist[s : e]. |
| 306 | |
| 85 | 307 |
| 308 List identity ~ | |
| 99 | 309 *list-identity* |
| 85 | 310 When variable "aa" is a list and you assign it to another variable "bb", both |
| 311 variables refer to the same list. Thus changing the list "aa" will also | |
| 312 change "bb": > | |
| 313 :let aa = [1, 2, 3] | |
| 314 :let bb = aa | |
| 315 :call add(aa, 4) | |
| 316 :echo bb | |
| 114 | 317 < [1, 2, 3, 4] |
| 85 | 318 |
| 319 Making a copy of a list is done with the |copy()| function. Using [:] also | |
| 320 works, as explained above. This creates a shallow copy of the list: Changing | |
| 87 | 321 a list item in the list will also change the item in the copied list: > |
| 85 | 322 :let aa = [[1, 'a'], 2, 3] |
| 323 :let bb = copy(aa) | |
| 114 | 324 :call add(aa, 4) |
| 85 | 325 :let aa[0][1] = 'aaa' |
| 326 :echo aa | |
| 114 | 327 < [[1, aaa], 2, 3, 4] > |
| 85 | 328 :echo bb |
| 114 | 329 < [[1, aaa], 2, 3] |
| 85 | 330 |
| 87 | 331 To make a completely independent list use |deepcopy()|. This also makes a |
| 114 | 332 copy of the values in the list, recursively. Up to a hundred levels deep. |
| 85 | 333 |
| 334 The operator "is" can be used to check if two variables refer to the same | |
| 114 | 335 List. "isnot" does the opposite. In contrast "==" compares if two lists have |
| 87 | 336 the same value. > |
| 337 :let alist = [1, 2, 3] | |
| 338 :let blist = [1, 2, 3] | |
| 339 :echo alist is blist | |
| 114 | 340 < 0 > |
| 87 | 341 :echo alist == blist |
| 114 | 342 < 1 |
| 85 | 343 |
| 323 | 344 Note about comparing lists: Two lists are considered equal if they have the |
| 345 same length and all items compare equal, as with using "==". There is one | |
| 388 | 346 exception: When comparing a number with a string they are considered |
| 347 different. There is no automatic type conversion, as with using "==" on | |
| 348 variables. Example: > | |
| 349 echo 4 == "4" | |
| 323 | 350 < 1 > |
| 388 | 351 echo [4] == ["4"] |
| 323 | 352 < 0 |
| 353 | |
| 388 | 354 Thus comparing Lists is more strict than comparing numbers and strings. You |
| 1621 | 355 can compare simple values this way too by putting them in a list: > |
| 388 | 356 |
| 357 :let a = 5 | |
| 358 :let b = "5" | |
| 1621 | 359 :echo a == b |
| 388 | 360 < 1 > |
| 1621 | 361 :echo [a] == [b] |
| 388 | 362 < 0 |
| 323 | 363 |
| 85 | 364 |
| 365 List unpack ~ | |
| 366 | |
| 367 To unpack the items in a list to individual variables, put the variables in | |
| 368 square brackets, like list items: > | |
| 369 :let [var1, var2] = mylist | |
| 370 | |
| 371 When the number of variables does not match the number of items in the list | |
| 372 this produces an error. To handle any extra items from the list append ";" | |
| 373 and a variable name: > | |
| 374 :let [var1, var2; rest] = mylist | |
| 375 | |
| 376 This works like: > | |
| 377 :let var1 = mylist[0] | |
| 378 :let var2 = mylist[1] | |
| 95 | 379 :let rest = mylist[2:] |
| 85 | 380 |
| 381 Except that there is no error if there are only two items. "rest" will be an | |
| 382 empty list then. | |
| 383 | |
| 384 | |
| 385 List modification ~ | |
| 386 *list-modification* | |
| 87 | 387 To change a specific item of a list use |:let| this way: > |
| 85 | 388 :let list[4] = "four" |
| 389 :let listlist[0][3] = item | |
| 390 | |
| 87 | 391 To change part of a list you can specify the first and last item to be |
| 114 | 392 modified. The value must at least have the number of items in the range: > |
| 87 | 393 :let list[3:5] = [3, 4, 5] |
| 394 | |
| 85 | 395 Adding and removing items from a list is done with functions. Here are a few |
| 396 examples: > | |
| 397 :call insert(list, 'a') " prepend item 'a' | |
| 398 :call insert(list, 'a', 3) " insert item 'a' before list[3] | |
| 399 :call add(list, "new") " append String item | |
| 114 | 400 :call add(list, [1, 2]) " append a List as one new item |
| 85 | 401 :call extend(list, [1, 2]) " extend the list with two more items |
| 402 :let i = remove(list, 3) " remove item 3 | |
| 108 | 403 :unlet list[3] " idem |
| 85 | 404 :let l = remove(list, 3, -1) " remove items 3 to last item |
| 108 | 405 :unlet list[3 : ] " idem |
| 114 | 406 :call filter(list, 'v:val !~ "x"') " remove items with an 'x' |
| 407 | |
| 408 Changing the order of items in a list: > | |
| 87 | 409 :call sort(list) " sort a list alphabetically |
| 410 :call reverse(list) " reverse the order of items | |
| 5747 | 411 :call uniq(sort(list)) " sort and remove duplicates |
| 87 | 412 |
| 85 | 413 |
| 414 For loop ~ | |
| 415 | |
| 87 | 416 The |:for| loop executes commands for each item in a list. A variable is set |
| 417 to each item in the list in sequence. Example: > | |
| 114 | 418 :for item in mylist |
| 419 : call Doit(item) | |
| 85 | 420 :endfor |
| 421 | |
| 422 This works like: > | |
| 423 :let index = 0 | |
| 424 :while index < len(mylist) | |
| 114 | 425 : let item = mylist[index] |
| 426 : :call Doit(item) | |
| 85 | 427 : let index = index + 1 |
| 428 :endwhile | |
| 429 | |
| 95 | 430 If all you want to do is modify each item in the list then the |map()| |
| 114 | 431 function will be a simpler method than a for loop. |
| 95 | 432 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
433 Just like the |:let| command, |:for| also accepts a list of variables. This |
| 85 | 434 requires the argument to be a list of lists. > |
| 435 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]] | |
| 436 : call Doit(lnum, col) | |
| 437 :endfor | |
| 438 | |
| 439 This works like a |:let| command is done for each list item. Again, the types | |
| 440 must remain the same to avoid an error. | |
| 441 | |
| 114 | 442 It is also possible to put remaining items in a List variable: > |
| 85 | 443 :for [i, j; rest] in listlist |
| 444 : call Doit(i, j) | |
| 445 : if !empty(rest) | |
| 446 : echo "remainder: " . string(rest) | |
| 447 : endif | |
| 448 :endfor | |
| 449 | |
| 450 | |
| 451 List functions ~ | |
| 114 | 452 *E714* |
| 85 | 453 Functions that are useful with a List: > |
| 87 | 454 :let r = call(funcname, list) " call a function with an argument list |
| 85 | 455 :if empty(list) " check if list is empty |
| 102 | 456 :let l = len(list) " number of items in list |
| 457 :let big = max(list) " maximum value in list | |
| 458 :let small = min(list) " minimum value in list | |
| 87 | 459 :let xs = count(list, 'x') " count nr of times 'x' appears in list |
| 460 :let i = index(list, 'x') " index of first 'x' in list | |
| 85 | 461 :let lines = getline(1, 10) " get ten text lines from buffer |
| 462 :call append('$', lines) " append text lines in buffer | |
| 95 | 463 :let list = split("a b c") " create list from items in a string |
| 464 :let string = join(list, ', ') " create string from list items | |
| 102 | 465 :let s = string(list) " String representation of list |
| 466 :call map(list, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 467 |
| 258 | 468 Don't forget that a combination of features can make things simple. For |
| 469 example, to add up all the numbers in a list: > | |
| 470 :exe 'let sum = ' . join(nrlist, '+') | |
| 471 | |
| 99 | 472 |
| 473 1.4 Dictionaries ~ | |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
474 *dict* *Dict* *Dictionaries* *Dictionary* |
| 99 | 475 A Dictionary is an associative array: Each entry has a key and a value. The |
| 114 | 476 entry can be located with the key. The entries are stored without a specific |
| 477 ordering. | |
| 99 | 478 |
| 479 | |
| 480 Dictionary creation ~ | |
| 114 | 481 *E720* *E721* *E722* *E723* |
| 99 | 482 A Dictionary is created with a comma separated list of entries in curly |
| 114 | 483 braces. Each entry has a key and a value, separated by a colon. Each key can |
| 484 only appear once. Examples: > | |
| 99 | 485 :let mydict = {1: 'one', 2: 'two', 3: 'three'} |
| 486 :let emptydict = {} | |
| 114 | 487 < *E713* *E716* *E717* |
| 99 | 488 A key is always a String. You can use a Number, it will be converted to a |
| 489 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
|
490 entry. Note that the String '04' and the Number 04 are different, since the |
|
17368
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
491 Number will be converted to the String '4'. The empty string can also be used |
|
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
492 as a key. |
| 17758 | 493 *literal-Dict* *#{}* |
|
17413
40417757dffd
patch 8.1.1705: using ~{} for a literal dict is not nice
Bram Moolenaar <Bram@vim.org>
parents:
17387
diff
changeset
|
494 To avoid having to put quotes around every key the #{} form can be used. This |
|
17368
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
495 does require the key to consist only of ASCII letters, digits, '-' and '_'. |
|
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
496 Example: > |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
497 :let mydict = #{zero: 0, one_key: 1, two-key: 2, 333: 3} |
|
17413
40417757dffd
patch 8.1.1705: using ~{} for a literal dict is not nice
Bram Moolenaar <Bram@vim.org>
parents:
17387
diff
changeset
|
498 Note that 333 here is the string "333". Empty keys are not possible with #{}. |
| 114 | 499 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
500 A value can be any expression. Using a Dictionary for a value creates a |
| 99 | 501 nested Dictionary: > |
| 502 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}} | |
| 503 | |
| 504 An extra comma after the last entry is ignored. | |
| 505 | |
| 506 | |
| 507 Accessing entries ~ | |
| 508 | |
| 509 The normal way to access an entry is by putting the key in square brackets: > | |
| 510 :let val = mydict["one"] | |
| 511 :let mydict["four"] = 4 | |
| 512 | |
| 114 | 513 You can add new entries to an existing Dictionary this way, unlike Lists. |
| 99 | 514 |
| 515 For keys that consist entirely of letters, digits and underscore the following | |
| 516 form can be used |expr-entry|: > | |
| 517 :let val = mydict.one | |
| 518 :let mydict.four = 4 | |
| 519 | |
| 520 Since an entry can be any type, also a List and a Dictionary, the indexing and | |
| 521 key lookup can be repeated: > | |
| 114 | 522 :echo dict.key[idx].key |
| 99 | 523 |
| 524 | |
| 525 Dictionary to List conversion ~ | |
| 526 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
527 You may want to loop over the entries in a dictionary. For this you need to |
| 99 | 528 turn the Dictionary into a List and pass it to |:for|. |
| 529 | |
| 530 Most often you want to loop over the keys, using the |keys()| function: > | |
| 531 :for key in keys(mydict) | |
| 532 : echo key . ': ' . mydict[key] | |
| 533 :endfor | |
| 534 | |
| 535 The List of keys is unsorted. You may want to sort them first: > | |
| 536 :for key in sort(keys(mydict)) | |
| 537 | |
| 538 To loop over the values use the |values()| function: > | |
| 539 :for v in values(mydict) | |
| 540 : echo "value: " . v | |
| 541 :endfor | |
| 542 | |
| 543 If you want both the key and the value use the |items()| function. It returns | |
| 15131 | 544 a List in which each item is a List with two items, the key and the value: > |
| 1156 | 545 :for [key, value] in items(mydict) |
| 546 : echo key . ': ' . value | |
| 99 | 547 :endfor |
| 548 | |
| 549 | |
| 550 Dictionary identity ~ | |
| 161 | 551 *dict-identity* |
| 99 | 552 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a |
| 553 Dictionary. Otherwise, assignment results in referring to the same | |
| 554 Dictionary: > | |
| 555 :let onedict = {'a': 1, 'b': 2} | |
| 556 :let adict = onedict | |
| 557 :let adict['a'] = 11 | |
| 558 :echo onedict['a'] | |
| 559 11 | |
| 560 | |
| 327 | 561 Two Dictionaries compare equal if all the key-value pairs compare equal. For |
| 562 more info see |list-identity|. | |
| 99 | 563 |
| 564 | |
| 565 Dictionary modification ~ | |
| 566 *dict-modification* | |
| 567 To change an already existing entry of a Dictionary, or to add a new entry, | |
| 568 use |:let| this way: > | |
| 569 :let dict[4] = "four" | |
| 570 :let dict['one'] = item | |
| 571 | |
| 108 | 572 Removing an entry from a Dictionary is done with |remove()| or |:unlet|. |
| 573 Three ways to remove the entry with key "aaa" from dict: > | |
| 574 :let i = remove(dict, 'aaa') | |
| 575 :unlet dict.aaa | |
| 576 :unlet dict['aaa'] | |
| 99 | 577 |
| 578 Merging a Dictionary with another is done with |extend()|: > | |
| 114 | 579 :call extend(adict, bdict) |
| 580 This extends adict with all entries from bdict. Duplicate keys cause entries | |
| 581 in adict to be overwritten. An optional third argument can change this. | |
| 119 | 582 Note that the order of entries in a Dictionary is irrelevant, thus don't |
| 583 expect ":echo adict" to show the items from bdict after the older entries in | |
| 584 adict. | |
| 99 | 585 |
| 586 Weeding out entries from a Dictionary can be done with |filter()|: > | |
| 1156 | 587 :call filter(dict, 'v:val =~ "x"') |
| 114 | 588 This removes all entries from "dict" with a value not matching 'x'. |
| 20552 | 589 This can also be used to remove all entries: > |
| 590 call filter(dict, 0) | |
| 102 | 591 |
| 592 | |
| 593 Dictionary function ~ | |
| 4159 | 594 *Dictionary-function* *self* *E725* *E862* |
| 102 | 595 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
|
596 special way with a dictionary. Example: > |
| 102 | 597 :function Mylen() dict |
| 114 | 598 : return len(self.data) |
| 102 | 599 :endfunction |
| 114 | 600 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")} |
| 601 :echo mydict.len() | |
| 102 | 602 |
| 603 This is like a method in object oriented programming. The entry in the | |
| 604 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary | |
| 605 the function was invoked from. | |
| 606 | |
| 114 | 607 It is also possible to add a function without the "dict" attribute as a |
| 608 Funcref to a Dictionary, but the "self" variable is not available then. | |
| 609 | |
| 819 | 610 *numbered-function* *anonymous-function* |
| 102 | 611 To avoid the extra name for the function it can be defined and directly |
| 612 assigned to a Dictionary in this way: > | |
| 114 | 613 :let mydict = {'data': [0, 1, 2, 3]} |
| 6741 | 614 :function mydict.len() |
| 114 | 615 : return len(self.data) |
| 102 | 616 :endfunction |
| 114 | 617 :echo mydict.len() |
| 618 | |
| 619 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
|
620 that references this function. The function can only be used through a |
| 114 | 621 |Funcref|. It will automatically be deleted when there is no |Funcref| |
| 622 remaining that refers to it. | |
| 623 | |
| 624 It is not necessary to use the "dict" attribute for a numbered function. | |
| 102 | 625 |
|
2488
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
626 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
|
627 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
|
628 :function {42} |
|
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
629 |
| 102 | 630 |
| 631 Functions for Dictionaries ~ | |
| 114 | 632 *E715* |
| 633 Functions that can be used with a Dictionary: > | |
| 102 | 634 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo" |
| 635 :if empty(dict) " TRUE if dict is empty | |
| 636 :let l = len(dict) " number of items in dict | |
| 637 :let big = max(dict) " maximum value in dict | |
| 638 :let small = min(dict) " minimum value in dict | |
| 639 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict | |
| 640 :let s = string(dict) " String representation of dict | |
| 641 :call map(dict, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 642 |
| 643 | |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
644 1.5 Blobs ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
645 *blob* *Blob* *Blobs* *E978* |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
646 A Blob is a binary object. It can be used to read an image from a file and |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
647 send it over a channel, for example. |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
648 |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
649 A Blob mostly behaves like a |List| of numbers, where each number has the |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
650 value of an 8-bit byte, from 0 to 255. |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
651 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
652 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
653 Blob creation ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
654 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
655 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
|
656 :let b = 0zFF00ED015DAF |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
657 Dots can be inserted between bytes (pair of hex characters) for readability, |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
658 they don't change the value: > |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
659 :let b = 0zFF00.ED01.5DAF |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
660 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
661 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
|
662 set to "B", for example: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
663 :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
|
664 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
665 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
|
666 |
|
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 Blob index ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
669 *blob-index* *E979* |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
670 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
|
671 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
|
672 :let myblob = 0z00112233 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
673 :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
|
674 :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
|
675 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
676 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
|
677 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
|
678 :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
|
679 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
680 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
|
681 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
|
682 :echo get(myblob, idx) |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
683 :echo get(myblob, idx, 999) |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
684 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
685 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
686 Blob iteration ~ |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
687 |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
688 The |:for| loop executes commands for each byte of a Blob. The loop variable is |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
689 set to each byte in the Blob. Example: > |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
690 :for byte in 0z112233 |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
691 : call Doit(byte) |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
692 :endfor |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
693 This calls Doit() with 0x11, 0x22 and 0x33. |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
694 |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
695 |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
696 Blob concatenation ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
697 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
698 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
|
699 :let longblob = myblob + 0z4455 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
700 :let myblob += 0z6677 |
|
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 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
|
703 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
704 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
705 Part of a blob ~ |
|
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 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
|
708 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
|
709 :let myblob = 0z00112233 |
| 15512 | 710 :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
|
711 :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
|
712 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
713 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
|
714 similar to -1. > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
715 :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
|
716 :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
|
717 :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
|
718 |
| 15512 | 719 If the first index is beyond the last byte of the Blob or the second index is |
|
15725
a3e2e7948ee4
patch 8.1.0870: Vim doesn't use the new ConPTY support in Windows 10
Bram Moolenaar <Bram@vim.org>
parents:
15711
diff
changeset
|
720 before the first index, the result is an empty Blob. There is no error |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
721 message. |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
722 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
723 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
|
724 length minus one is used: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
725 :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
|
726 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
727 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
728 Blob modification ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
729 *blob-modification* |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
730 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
|
731 :let blob[4] = 0x44 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
732 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
733 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
|
734 higher index is an error. |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
735 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
736 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
|
737 let blob[1:3] = 0z445566 |
| 15512 | 738 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
|
739 provided. *E972* |
|
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 To change part of a blob you can specify the first and last byte to be |
| 15512 | 742 modified. The value must have the same number of bytes in the range: > |
| 743 :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
|
744 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
745 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
|
746 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
747 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
748 Blob identity ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
749 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
750 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
|
751 if blob == 0z001122 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
752 And for equal identity: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
753 if blob is otherblob |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
754 < *blob-identity* *E977* |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
755 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
|
756 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
|
757 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
758 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
|
759 identity is different: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
760 :let blob = 0z112233 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
761 :let blob2 = blob |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
762 :echo blob == blob2 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
763 < 1 > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
764 :echo blob is blob2 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
765 < 1 > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
766 :let blob3 = blob[:] |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
767 :echo blob == blob3 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
768 < 1 > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
769 :echo blob is blob3 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
770 < 0 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
771 |
| 15512 | 772 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
|
773 works, as explained above. |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
774 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
775 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
776 1.6 More about variables ~ |
| 85 | 777 *more-variables* |
| 7 | 778 If you need to know the type of a variable or expression, use the |type()| |
| 779 function. | |
| 780 | |
| 781 When the '!' flag is included in the 'viminfo' option, global variables that | |
| 782 start with an uppercase letter, and don't contain a lowercase letter, are | |
| 783 stored in the viminfo file |viminfo-file|. | |
| 784 | |
| 785 When the 'sessionoptions' option contains "global", global variables that | |
| 786 start with an uppercase letter and contain at least one lowercase letter are | |
| 787 stored in the session file |session-file|. | |
| 788 | |
| 789 variable name can be stored where ~ | |
| 790 my_var_6 not | |
| 791 My_Var_6 session file | |
| 792 MY_VAR_6 viminfo file | |
| 793 | |
| 794 | |
| 795 It's possible to form a variable name with curly braces, see | |
| 796 |curly-braces-names|. | |
| 797 | |
| 798 ============================================================================== | |
| 799 2. Expression syntax *expression-syntax* | |
| 800 | |
| 801 Expression syntax summary, from least to most significant: | |
| 802 | |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
803 |expr1| expr2 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
804 expr2 ? expr1 : expr1 if-then-else |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
805 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
806 |expr2| expr3 |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
807 expr3 || expr3 ... logical OR |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
808 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
809 |expr3| expr4 |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
810 expr4 && expr4 ... logical AND |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
811 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
812 |expr4| expr5 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
813 expr5 == expr5 equal |
| 7 | 814 expr5 != expr5 not equal |
| 815 expr5 > expr5 greater than | |
| 816 expr5 >= expr5 greater than or equal | |
| 817 expr5 < expr5 smaller than | |
| 818 expr5 <= expr5 smaller than or equal | |
| 819 expr5 =~ expr5 regexp matches | |
| 820 expr5 !~ expr5 regexp doesn't match | |
| 821 | |
| 822 expr5 ==? expr5 equal, ignoring case | |
| 823 expr5 ==# expr5 equal, match case | |
| 824 etc. As above, append ? for ignoring case, # for | |
| 825 matching case | |
| 826 | |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
827 expr5 is expr5 same |List|, |Dictionary| or |Blob| instance |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
828 expr5 isnot expr5 different |List|, |Dictionary| or |Blob| |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
829 instance |
| 79 | 830 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
831 |expr5| expr6 |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
832 expr6 + expr6 ... number addition, list or blob concatenation |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
833 expr6 - expr6 ... number subtraction |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
834 expr6 . expr6 ... string concatenation |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
835 expr6 .. expr6 ... string concatenation |
| 7 | 836 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
837 |expr6| expr7 |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
838 expr7 * expr7 ... number multiplication |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
839 expr7 / expr7 ... number division |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
840 expr7 % expr7 ... number modulo |
| 7 | 841 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
842 |expr7| expr8 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
843 ! expr7 logical NOT |
| 7 | 844 - expr7 unary minus |
| 845 + expr7 unary plus | |
| 102 | 846 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
847 |expr8| expr9 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
848 expr8[expr1] byte of a String or item of a |List| |
| 685 | 849 expr8[expr1 : expr1] substring of a String or sublist of a |List| |
| 850 expr8.name entry in a |Dictionary| | |
| 851 expr8(expr1, ...) function call with |Funcref| variable | |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
852 expr8->name(expr1, ...) |method| call |
| 102 | 853 |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
854 |expr9| number number constant |
| 26 | 855 "string" string constant, backslash is special |
| 99 | 856 'string' string constant, ' is doubled |
| 685 | 857 [expr1, ...] |List| |
| 858 {expr1: expr1, ...} |Dictionary| | |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
859 #{key: expr1, ...} |Dictionary| |
| 7 | 860 &option option value |
| 861 (expr1) nested expression | |
| 862 variable internal variable | |
| 863 va{ria}ble internal variable with curly braces | |
| 864 $VAR environment variable | |
| 865 @r contents of register 'r' | |
| 866 function(expr1, ...) function call | |
| 867 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
|
868 {args -> expr1} lambda expression |
| 7 | 869 |
| 870 | |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
871 "..." indicates that the operations in this level can be concatenated. |
| 7 | 872 Example: > |
| 873 &nu || &list && &shell == "csh" | |
| 874 | |
| 875 All expressions within one level are parsed from left to right. | |
| 876 | |
| 877 | |
| 878 expr1 *expr1* *E109* | |
| 879 ----- | |
| 880 | |
| 881 expr2 ? expr1 : expr1 | |
| 882 | |
| 883 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
|
884 |TRUE|, the result is the value of the expression between the '?' and ':', |
| 7 | 885 otherwise the result is the value of the expression after the ':'. |
| 886 Example: > | |
| 887 :echo lnum == 1 ? "top" : lnum | |
| 888 | |
| 889 Since the first expression is an "expr2", it cannot contain another ?:. The | |
| 890 other two expressions can, thus allow for recursive use of ?:. | |
| 891 Example: > | |
| 892 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum | |
| 893 | |
| 894 To keep this readable, using |line-continuation| is suggested: > | |
| 895 :echo lnum == 1 | |
| 896 :\ ? "top" | |
| 897 :\ : lnum == 1000 | |
| 898 :\ ? "last" | |
| 899 :\ : lnum | |
| 900 | |
| 1156 | 901 You should always put a space before the ':', otherwise it can be mistaken for |
| 902 use in a variable such as "a:1". | |
| 903 | |
| 7 | 904 |
| 905 expr2 and expr3 *expr2* *expr3* | |
| 906 --------------- | |
| 907 | |
|
10038
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
908 expr3 || expr3 .. logical OR *expr-barbar* |
|
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
909 expr4 && expr4 .. logical AND *expr-&&* |
|
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
910 |
| 7 | 911 The "||" and "&&" operators take one argument on each side. The arguments |
| 912 are (converted to) Numbers. The result is: | |
| 913 | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
914 input output ~ |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
915 n1 n2 n1 || n2 n1 && n2 ~ |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
916 |FALSE| |FALSE| |FALSE| |FALSE| |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
917 |FALSE| |TRUE| |TRUE| |FALSE| |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
918 |TRUE| |FALSE| |TRUE| |FALSE| |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
919 |TRUE| |TRUE| |TRUE| |TRUE| |
| 7 | 920 |
| 921 The operators can be concatenated, for example: > | |
| 922 | |
| 923 &nu || &list && &shell == "csh" | |
| 924 | |
| 925 Note that "&&" takes precedence over "||", so this has the meaning of: > | |
| 926 | |
| 927 &nu || (&list && &shell == "csh") | |
| 928 | |
| 929 Once the result is known, the expression "short-circuits", that is, further | |
| 930 arguments are not evaluated. This is like what happens in C. For example: > | |
| 931 | |
| 932 let a = 1 | |
| 933 echo a || b | |
| 934 | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
935 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
|
936 so the result must be |TRUE|. Similarly below: > |
| 7 | 937 |
| 938 echo exists("b") && b == "yes" | |
| 939 | |
| 940 This is valid whether "b" has been defined or not. The second clause will | |
| 941 only be evaluated if "b" has been defined. | |
| 942 | |
| 943 | |
| 944 expr4 *expr4* | |
| 945 ----- | |
| 946 | |
| 947 expr5 {cmp} expr5 | |
| 948 | |
| 949 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1 | |
| 950 if it evaluates to true. | |
| 951 | |
| 1621 | 952 *expr-==* *expr-!=* *expr->* *expr->=* |
| 7 | 953 *expr-<* *expr-<=* *expr-=~* *expr-!~* |
| 954 *expr-==#* *expr-!=#* *expr->#* *expr->=#* | |
| 955 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#* | |
| 956 *expr-==?* *expr-!=?* *expr->?* *expr->=?* | |
| 957 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?* | |
| 2908 | 958 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#* |
| 959 *expr-is?* *expr-isnot?* | |
| 7 | 960 use 'ignorecase' match case ignore case ~ |
| 961 equal == ==# ==? | |
| 962 not equal != !=# !=? | |
| 963 greater than > ># >? | |
| 964 greater than or equal >= >=# >=? | |
| 965 smaller than < <# <? | |
| 966 smaller than or equal <= <=# <=? | |
| 967 regexp matches =~ =~# =~? | |
| 968 regexp doesn't match !~ !~# !~? | |
| 2908 | 969 same instance is is# is? |
| 970 different instance isnot isnot# isnot? | |
| 7 | 971 |
| 972 Examples: | |
| 973 "abc" ==# "Abc" evaluates to 0 | |
| 974 "abc" ==? "Abc" evaluates to 1 | |
| 975 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise | |
| 976 | |
| 85 | 977 *E691* *E692* |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
978 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
|
979 "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
|
980 recursively. Ignoring case means case is ignored when comparing item values. |
| 79 | 981 |
| 114 | 982 *E735* *E736* |
| 685 | 983 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
|
984 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
|
985 |Dictionary| recursively. Ignoring case means case is ignored when comparing |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
986 item values. |
| 114 | 987 |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
988 *E694* |
|
9407
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
989 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
|
990 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
|
991 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
|
992 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
|
993 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
|
994 |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
995 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
|
996 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
|
997 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
|
998 " Part1 and Part2 refer to the same function |
| 685 | 999 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1000 Using "is" or "isnot" with a |List|, |Dictionary| or |Blob| checks whether |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1001 the expressions are referring to the same |List|, |Dictionary| or |Blob| |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1002 instance. A copy of a |List| is different from the original |List|. When |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1003 using "is" without a |List|, |Dictionary| or |Blob|, it is equivalent to |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1004 using "equal", using "isnot" equivalent to using "not equal". Except that |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1005 a different type means the values are different: > |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1006 echo 4 == '4' |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1007 1 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1008 echo 4 is '4' |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1009 0 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1010 echo 0 is [] |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1011 0 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1012 "is#"/"isnot#" and "is?"/"isnot?" can be used to match and ignore case. |
| 79 | 1013 |
| 7 | 1014 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
|
1015 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
|
1016 echo 0 == 'x' |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1017 1 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1018 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
|
1019 echo [0] == ['x'] |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1020 0 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1021 Inside a List or Dictionary this conversion is not used. |
| 7 | 1022 |
| 1023 When comparing two Strings, this is done with strcmp() or stricmp(). This | |
| 1024 results in the mathematical difference (comparing byte values), not | |
| 1025 necessarily the alphabetical difference in the local language. | |
| 1026 | |
| 1621 | 1027 When using the operators with a trailing '#', or the short version and |
| 1156 | 1028 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
| 7 | 1029 |
| 1030 When using the operators with a trailing '?', or the short version and | |
| 1156 | 1031 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
| 1032 | |
| 1033 'smartcase' is not used. | |
| 7 | 1034 |
| 1035 The "=~" and "!~" operators match the lefthand argument with the righthand | |
| 1036 argument, which is used as a pattern. See |pattern| for what a pattern is. | |
| 1037 This matching is always done like 'magic' was set and 'cpoptions' is empty, no | |
| 1038 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts | |
| 1039 portable. To avoid backslashes in the regexp pattern to be doubled, use a | |
| 1040 single-quote string, see |literal-string|. | |
| 1041 Since a string is considered to be a single line, a multi-line pattern | |
| 1042 (containing \n, backslash-n) will not match. However, a literal NL character | |
| 1043 can be matched like an ordinary character. Examples: | |
| 1044 "foo\nbar" =~ "\n" evaluates to 1 | |
| 1045 "foo\nbar" =~ "\\n" evaluates to 0 | |
| 1046 | |
| 1047 | |
| 1048 expr5 and expr6 *expr5* *expr6* | |
| 1049 --------------- | |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1050 expr6 + expr6 Number addition, |List| or |Blob| concatenation *expr-+* |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1051 expr6 - expr6 Number subtraction *expr--* |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1052 expr6 . expr6 String concatenation *expr-.* |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1053 expr6 .. expr6 String concatenation *expr-..* |
| 79 | 1054 |
| 692 | 1055 For |Lists| only "+" is possible and then both expr6 must be a list. The |
| 685 | 1056 result is a new list with the two lists Concatenated. |
| 79 | 1057 |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1058 For String concatenation ".." is preferred, since "." is ambiguous, it is also |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1059 used for |Dict| member access and floating point numbers. |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
1060 When |vimscript-version| is 2 or higher, using "." is not allowed. |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1061 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1062 expr7 * expr7 Number multiplication *expr-star* |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1063 expr7 / expr7 Number division *expr-/* |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1064 expr7 % expr7 Number modulo *expr-%* |
| 7 | 1065 |
| 16267 | 1066 For all, except "." and "..", Strings are converted to Numbers. |
| 3214 | 1067 For bitwise operators see |and()|, |or()| and |xor()|. |
| 7 | 1068 |
| 1069 Note the difference between "+" and ".": | |
| 1070 "123" + "456" = 579 | |
| 1071 "123" . "456" = "123456" | |
| 1072 | |
| 1621 | 1073 Since '.' has the same precedence as '+' and '-', you need to read: > |
| 1074 1 . 90 + 90.0 | |
| 1075 As: > | |
| 1076 (1 . 90) + 90.0 | |
| 1077 That works, since the String "190" is automatically converted to the Number | |
| 1078 190, which can be added to the Float 90.0. However: > | |
| 1079 1 . 90 * 90.0 | |
| 1080 Should be read as: > | |
| 1081 1 . (90 * 90.0) | |
| 1082 Since '.' has lower precedence than '*'. This does NOT work, since this | |
| 1083 attempts to concatenate a Float and a String. | |
| 1084 | |
| 1085 When dividing a Number by zero the result depends on the value: | |
| 1086 0 / 0 = -0x80000000 (like NaN for Float) | |
| 1087 >0 / 0 = 0x7fffffff (like positive infinity) | |
| 1088 <0 / 0 = -0x7fffffff (like negative infinity) | |
| 1089 (before Vim 7.2 it was always 0x7fffffff) | |
| 1090 | |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1091 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
|
1092 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
|
1093 >0 / 0 = 0x7fffffffffffffff (like positive infinity) |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1094 <0 / 0 = -0x7fffffffffffffff (like negative infinity) |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1095 |
| 7 | 1096 When the righthand side of '%' is zero, the result is 0. |
| 1097 | |
| 685 | 1098 None of these work for |Funcref|s. |
| 79 | 1099 |
| 1621 | 1100 . and % do not work for Float. *E804* |
| 1101 | |
| 7 | 1102 |
| 1103 expr7 *expr7* | |
| 1104 ----- | |
| 1105 ! expr7 logical NOT *expr-!* | |
| 1106 - expr7 unary minus *expr-unary--* | |
| 1107 + expr7 unary plus *expr-unary-+* | |
| 1108 | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
1109 For '!' |TRUE| becomes |FALSE|, |FALSE| becomes |TRUE| (one). |
| 7 | 1110 For '-' the sign of the number is changed. |
| 1111 For '+' the number is unchanged. | |
| 1112 | |
| 1113 A String will be converted to a Number first. | |
| 1114 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1115 These three can be repeated and mixed. Examples: |
| 7 | 1116 !-1 == 0 |
| 1117 !!8 == 1 | |
| 1118 --9 == 9 | |
| 1119 | |
| 1120 | |
| 1121 expr8 *expr8* | |
| 1122 ----- | |
| 14637 | 1123 This expression is either |expr9| or a sequence of the alternatives below, |
| 1124 in any order. E.g., these are all possible: | |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1125 expr8[expr1].name |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1126 expr8.name[expr1] |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1127 expr8(expr1, ...)[expr1].name |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1128 expr8->(expr1, ...)[expr1] |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
1129 Evaluation is always from left to right. |
| 14637 | 1130 |
| 685 | 1131 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
|
1132 *E909* *subscript* |
| 102 | 1133 If expr8 is a Number or String this results in a String that contains the |
| 1134 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
|
1135 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
|
1136 an alternative, or use `split()` to turn the string into a list of characters. |
| 55 | 1137 |
|
7384
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7358
diff
changeset
|
1138 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
|
1139 text column numbers start with one! Example, to get the byte under the |
| 55 | 1140 cursor: > |
| 823 | 1141 :let c = getline(".")[col(".") - 1] |
| 7 | 1142 |
| 1143 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
|
1144 String. A negative index always results in an empty string (reason: backward |
| 55 | 1145 compatibility). Use [-1:] to get the last byte. |
| 1146 | |
| 685 | 1147 If expr8 is a |List| then it results the item at index expr1. See |list-index| |
| 55 | 1148 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
|
1149 error. Example: > |
| 55 | 1150 :let item = mylist[-1] " get last item |
| 1151 | |
| 685 | 1152 Generally, if a |List| index is equal to or higher than the length of the |
| 1153 |List|, or more negative than the length of the |List|, this results in an | |
| 1154 error. | |
| 55 | 1155 |
| 99 | 1156 |
| 102 | 1157 expr8[expr1a : expr1b] substring or sublist *expr-[:]* |
| 1158 | |
| 1159 If expr8 is a Number or String this results in the substring with the bytes | |
| 1160 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
|
1161 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
|
1162 |byteidx()| for computing the indexes. |
| 55 | 1163 |
| 1164 If expr1a is omitted zero is used. If expr1b is omitted the length of the | |
| 1165 string minus one is used. | |
| 1166 | |
| 1167 A negative number can be used to measure from the end of the string. -1 is | |
| 1168 the last character, -2 the last but one, etc. | |
| 1169 | |
| 1170 If an index goes out of range for the string characters are omitted. If | |
| 1171 expr1b is smaller than expr1a the result is an empty string. | |
| 1172 | |
| 1173 Examples: > | |
| 1174 :let c = name[-1:] " last byte of a string | |
| 1175 :let c = name[-2:-2] " last but one byte of a string | |
| 1176 :let s = line(".")[4:] " from the fifth byte to the end | |
| 1177 :let s = s[:-3] " remove last two bytes | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1178 < |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
1179 *slice* |
| 685 | 1180 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
|
1181 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
|
1182 just above. Also see |sublist| below. Examples: > |
| 55 | 1183 :let l = mylist[:3] " first four items |
| 1184 :let l = mylist[4:4] " List with one item | |
| 1185 :let l = mylist[:] " shallow copy of a List | |
| 1186 | |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1187 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
|
1188 indexes expr1a and expr1b, inclusive. Examples: > |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1189 :let b = 0zDEADBEEF |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1190 :let bs = b[1:2] " 0zADBE |
| 15512 | 1191 :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
|
1192 |
| 685 | 1193 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an |
| 1194 error. | |
| 1195 | |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1196 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
|
1197 for a sublist: > |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1198 mylist[n:] " uses variable n |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1199 mylist[s:] " uses namespace s:, error! |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1200 |
| 685 | 1201 |
| 1202 expr8.name entry in a |Dictionary| *expr-entry* | |
| 1203 | |
| 1204 If expr8 is a |Dictionary| and it is followed by a dot, then the following | |
| 1205 name will be used as a key in the |Dictionary|. This is just like: | |
| 1206 expr8[name]. | |
| 99 | 1207 |
| 1208 The name must consist of alphanumeric characters, just like a variable name, | |
| 1209 but it may start with a number. Curly braces cannot be used. | |
| 1210 | |
| 1211 There must not be white space before or after the dot. | |
| 1212 | |
| 1213 Examples: > | |
| 1214 :let dict = {"one": 1, 2: "two"} | |
| 16808 | 1215 :echo dict.one " shows "1" |
| 1216 :echo dict.2 " shows "two" | |
| 1217 :echo dict .2 " error because of space before the dot | |
| 99 | 1218 |
| 1219 Note that the dot is also used for String concatenation. To avoid confusion | |
| 1220 always put spaces around the dot for String concatenation. | |
| 1221 | |
| 1222 | |
| 685 | 1223 expr8(expr1, ...) |Funcref| function call |
| 102 | 1224 |
| 1225 When expr8 is a |Funcref| type variable, invoke the function it refers to. | |
| 1226 | |
| 1227 | |
|
17674
06c3e15ad84d
patch 8.1.1834: cannot use a lambda as a method
Bram Moolenaar <Bram@vim.org>
parents:
17667
diff
changeset
|
1228 expr8->name([args]) method call *method* *->* |
|
06c3e15ad84d
patch 8.1.1834: cannot use a lambda as a method
Bram Moolenaar <Bram@vim.org>
parents:
17667
diff
changeset
|
1229 expr8->{lambda}([args]) |
| 17758 | 1230 *E276* |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1231 For methods that are also available as global functions this is the same as: > |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
1232 name(expr8 [, args]) |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
1233 There can also be methods specifically for the type of "expr8". |
| 102 | 1234 |
|
17661
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1235 This allows for chaining, passing the value that one method returns to the |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1236 next method: > |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1237 mylist->filter(filterexpr)->map(mapexpr)->sort()->join() |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1238 < |
|
17674
06c3e15ad84d
patch 8.1.1834: cannot use a lambda as a method
Bram Moolenaar <Bram@vim.org>
parents:
17667
diff
changeset
|
1239 Example of using a lambda: > |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
1240 GetPercentage()->{x -> x * 100}()->printf('%d%%') |
| 17758 | 1241 < |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1242 When using -> the |expr7| operators will be applied first, thus: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1243 -1.234->string() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1244 Is equivalent to: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1245 (-1.234)->string() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1246 And NOT: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1247 -(1.234->string()) |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1248 < |
|
17661
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1249 *E274* |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1250 "->name(" must not contain white space. There can be white space before the |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1251 "->" and after the "(", thus you can split the lines like this: > |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1252 mylist |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1253 \ ->filter(filterexpr) |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1254 \ ->map(mapexpr) |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1255 \ ->sort() |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1256 \ ->join() |
| 17758 | 1257 |
| 1258 When using the lambda form there must be no white space between the } and the | |
| 1259 (. | |
| 1260 | |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1261 |
| 102 | 1262 *expr9* |
| 7 | 1263 number |
| 1264 ------ | |
| 12785 | 1265 number number constant *expr-number* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1266 *hex-number* *octal-number* *binary-number* |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1267 |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1268 Decimal, Hexadecimal (starting with 0x or 0X), Binary (starting with 0b or 0B) |
|
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
1269 and Octal (starting with 0, 0o or 0O). |
| 7 | 1270 |
| 1621 | 1271 *floating-point-format* |
| 1272 Floating point numbers can be written in two forms: | |
| 1273 | |
| 1274 [-+]{N}.{M} | |
| 6530 | 1275 [-+]{N}.{M}[eE][-+]{exp} |
| 1621 | 1276 |
| 1277 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
| 1278 contain digits. | |
| 1279 [-+] means there is an optional plus or minus sign. | |
| 1280 {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
|
1281 Only a decimal point is accepted, not a comma. No matter what the current |
| 1621 | 1282 locale is. |
| 1283 {only when compiled with the |+float| feature} | |
| 1284 | |
| 1285 Examples: | |
| 1286 123.456 | |
| 1287 +0.0001 | |
| 1288 55.0 | |
| 1289 -0.123 | |
| 1290 1.234e03 | |
| 1291 1.0E-6 | |
| 1292 -3.1416e+88 | |
| 1293 | |
| 1294 These are INVALID: | |
| 1295 3. empty {M} | |
| 1296 1e40 missing .{M} | |
| 1297 | |
| 1298 Rationale: | |
| 1299 Before floating point was introduced, the text "123.456" was interpreted as | |
| 1300 the two numbers "123" and "456", both converted to a string and concatenated, | |
| 1301 resulting in the string "123456". Since this was considered pointless, and we | |
| 1698 | 1302 could not find it intentionally being used in Vim scripts, this backwards |
| 1621 | 1303 incompatibility was accepted in favor of being able to use the normal notation |
| 1304 for floating point numbers. | |
| 1305 | |
| 15131 | 1306 *float-pi* *float-e* |
| 1307 A few useful values to copy&paste: > | |
| 1308 :let pi = 3.14159265359 | |
| 1309 :let e = 2.71828182846 | |
| 1310 Or, if you don't want to write them in as floating-point literals, you can | |
| 1311 also use functions, like the following: > | |
| 1312 :let pi = acos(-1.0) | |
| 1313 :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
|
1314 < |
| 1621 | 1315 *floating-point-precision* |
| 1316 The precision and range of floating points numbers depends on what "double" | |
| 1317 means in the library Vim was compiled with. There is no way to change this at | |
| 1318 runtime. | |
| 1319 | |
| 1320 The default for displaying a |Float| is to use 6 decimal places, like using | |
| 1321 printf("%g", f). You can select something else when using the |printf()| | |
| 1322 function. Example: > | |
| 1323 :echo printf('%.15e', atan(1)) | |
| 1324 < 7.853981633974483e-01 | |
| 1325 | |
| 1326 | |
| 7 | 1327 |
| 6884 | 1328 string *string* *String* *expr-string* *E114* |
| 7 | 1329 ------ |
| 1330 "string" string constant *expr-quote* | |
| 1331 | |
| 1332 Note that double quotes are used. | |
| 1333 | |
| 1334 A string constant accepts these special characters: | |
| 1335 \... three-digit octal number (e.g., "\316") | |
| 1336 \.. two-digit octal number (must be followed by non-digit) | |
| 1337 \. one-digit octal number (must be followed by non-digit) | |
| 1338 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
| 1339 \x. byte specified with one hex number (must be followed by non-hex char) | |
| 1340 \X.. same as \x.. | |
| 1341 \X. same as \x. | |
| 1621 | 1342 \u.... character specified with up to 4 hex numbers, stored according to the |
| 7 | 1343 current value of 'encoding' (e.g., "\u02a4") |
| 6840 | 1344 \U.... same as \u but allows up to 8 hex numbers. |
| 7 | 1345 \b backspace <BS> |
| 1346 \e escape <Esc> | |
| 1347 \f formfeed <FF> | |
| 1348 \n newline <NL> | |
| 1349 \r return <CR> | |
| 1350 \t tab <Tab> | |
| 1351 \\ backslash | |
| 1352 \" double quote | |
| 2152 | 1353 \<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
|
1354 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
|
1355 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
|
1356 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
|
1357 mentioned above. |
|
20627
8bce783af0cb
patch 8.2.0867: using {xxx} for encoding a modifier is not nice
Bram Moolenaar <Bram@vim.org>
parents:
20615
diff
changeset
|
1358 \<*xxx> Like \<xxx> but prepends a modifier instead of including it in the |
|
8bce783af0cb
patch 8.2.0867: using {xxx} for encoding a modifier is not nice
Bram Moolenaar <Bram@vim.org>
parents:
20615
diff
changeset
|
1359 character. E.g. "\<C-w>" is one character 0x17 while "\<*C-w>" is four |
|
20603
c2570baa2e4c
patch 8.2.0855: GUI tests fail because the test doesn't use a modifier
Bram Moolenaar <Bram@vim.org>
parents:
20593
diff
changeset
|
1360 bytes: 3 for the CTRL modifier and then character "W". |
| 7 | 1361 |
| 1156 | 1362 Note that "\xff" is stored as the byte 255, which may be invalid in some |
| 1363 encodings. Use "\u00ff" to store character 255 according to the current value | |
| 1364 of 'encoding'. | |
| 1365 | |
| 7 | 1366 Note that "\000" and "\x00" force the end of the string. |
| 1367 | |
| 1368 | |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
1369 blob-literal *blob-literal* *E973* |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1370 ------------ |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1371 |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1372 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
|
1373 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
|
1374 :let b = 0zFF00ED015DAF |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1375 |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1376 |
| 7 | 1377 literal-string *literal-string* *E115* |
| 1378 --------------- | |
| 26 | 1379 'string' string constant *expr-'* |
| 7 | 1380 |
| 1381 Note that single quotes are used. | |
| 1382 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1383 This string is taken as it is. No backslashes are removed or have a special |
| 99 | 1384 meaning. The only exception is that two quotes stand for one quote. |
| 26 | 1385 |
| 1386 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
|
1387 to be doubled. These two commands are equivalent: > |
| 26 | 1388 if a =~ "\\s*" |
| 1389 if a =~ '\s*' | |
| 7 | 1390 |
| 1391 | |
| 1392 option *expr-option* *E112* *E113* | |
| 1393 ------ | |
| 1394 &option option value, local value if possible | |
| 1395 &g:option global option value | |
| 1396 &l:option local option value | |
| 1397 | |
| 1398 Examples: > | |
| 1399 echo "tabstop is " . &tabstop | |
| 1400 if &insertmode | |
| 1401 | |
| 1402 Any option name can be used here. See |options|. When using the local value | |
| 1403 and there is no buffer-local or window-local value, the global value is used | |
| 1404 anyway. | |
| 1405 | |
| 1406 | |
| 1156 | 1407 register *expr-register* *@r* |
| 7 | 1408 -------- |
| 1409 @r contents of register 'r' | |
| 1410 | |
| 1411 The result is the contents of the named register, as a single string. | |
| 1412 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
|
1413 register use @" or @@. See |registers| for an explanation of the available |
| 336 | 1414 registers. |
| 1415 | |
| 1416 When using the '=' register you get the expression itself, not what it | |
| 1417 evaluates to. Use |eval()| to evaluate it. | |
| 7 | 1418 |
| 1419 | |
| 1420 nesting *expr-nesting* *E110* | |
| 1421 ------- | |
| 1422 (expr1) nested expression | |
| 1423 | |
| 1424 | |
| 1425 environment variable *expr-env* | |
| 1426 -------------------- | |
| 1427 $VAR environment variable | |
| 1428 | |
| 1429 The String value of any environment variable. When it is not defined, the | |
| 1430 result is an empty string. | |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1431 |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1432 The functions `getenv()` and `setenv()` can also be used and work for |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1433 environment variables with non-alphanumeric names. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1434 The function `environ()` can be used to get a Dict with all environment |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1435 variables. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1436 |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1437 |
| 7 | 1438 *expr-env-expand* |
| 1439 Note that there is a difference between using $VAR directly and using | |
| 1440 expand("$VAR"). Using it directly will only expand environment variables that | |
| 1441 are known inside the current Vim session. Using expand() will first try using | |
| 1442 the environment variables known inside the current Vim session. If that | |
| 1443 fails, a shell will be used to expand the variable. This can be slow, but it | |
| 1444 does expand all variables that the shell knows about. Example: > | |
| 6180 | 1445 :echo $shell |
| 1446 :echo expand("$shell") | |
| 1447 The first one probably doesn't echo anything, the second echoes the $shell | |
| 7 | 1448 variable (if your shell supports it). |
| 1449 | |
| 1450 | |
| 1451 internal variable *expr-variable* | |
| 1452 ----------------- | |
| 1453 variable internal variable | |
| 1454 See below |internal-variables|. | |
| 1455 | |
| 1456 | |
| 170 | 1457 function call *expr-function* *E116* *E118* *E119* *E120* |
| 7 | 1458 ------------- |
| 1459 function(expr1, ...) function call | |
| 1460 See below |functions|. | |
| 1461 | |
| 1462 | |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1463 lambda expression *expr-lambda* *lambda* |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1464 ----------------- |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1465 {args -> expr1} lambda expression |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1466 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1467 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
|
1468 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
|
1469 the following ways: |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1470 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1471 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
|
1472 commands. |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1473 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
|
1474 :let F = {arg1, arg2 -> arg1 - arg2} |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1475 :echo F(5, 2) |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1476 < 3 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1477 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1478 The arguments are optional. Example: > |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1479 :let F = {-> 'error function'} |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1480 :echo F() |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1481 < error function |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1482 *closure* |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1483 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
|
1484 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
|
1485 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
|
1486 the function returns: > |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1487 :function Foo(arg) |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1488 : let i = 3 |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1489 : return {x -> x + i - a:arg} |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1490 :endfunction |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1491 :let Bar = Foo(4) |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1492 :echo Bar(6) |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1493 < 5 |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
1494 |
| 20552 | 1495 Note that the variables must exist in the outer scope before the lambda is |
|
13329
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1496 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
|
1497 |
|
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1498 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
|
1499 if has('lambda') |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1500 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1501 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
|
1502 :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
|
1503 < [2, 3, 4] > |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1504 :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
|
1505 < [1, 2, 3, 4, 7] |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1506 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1507 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
|
1508 :let timer = timer_start(500, |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1509 \ {-> execute("echo 'Handler called'", "")}, |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1510 \ {'repeat': 3}) |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1511 < Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1512 Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1513 Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1514 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1515 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
|
1516 |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1517 |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1518 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
|
1519 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
|
1520 :function {'<lambda>42'} |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1521 See also: |numbered-function| |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1522 |
| 7 | 1523 ============================================================================== |
| 2596 | 1524 3. Internal variable *internal-variables* *E461* |
| 1525 | |
| 7 | 1526 An internal variable name can be made up of letters, digits and '_'. But it |
| 1527 cannot start with a digit. It's also possible to use curly braces, see | |
| 1528 |curly-braces-names|. | |
| 1529 | |
| 1530 An internal variable is created with the ":let" command |:let|. | |
| 87 | 1531 An internal variable is explicitly destroyed with the ":unlet" command |
| 1532 |:unlet|. | |
| 1533 Using a name that is not an internal variable or refers to a variable that has | |
| 1534 been destroyed results in an error. | |
| 7 | 1535 |
| 1536 There are several name spaces for variables. Which one is to be used is | |
| 1537 specified by what is prepended: | |
| 1538 | |
| 1539 (nothing) In a function: local to a function; otherwise: global | |
| 1540 |buffer-variable| b: Local to the current buffer. | |
| 1541 |window-variable| w: Local to the current window. | |
| 819 | 1542 |tabpage-variable| t: Local to the current tab page. |
| 7 | 1543 |global-variable| g: Global. |
| 1544 |local-variable| l: Local to a function. | |
| 1545 |script-variable| s: Local to a |:source|'ed Vim script. | |
| 1546 |function-argument| a: Function argument (only inside a function). | |
| 5815 | 1547 |vim-variable| v: Global, predefined by Vim. |
| 7 | 1548 |
| 685 | 1549 The scope name by itself can be used as a |Dictionary|. For example, to |
| 1550 delete all script-local variables: > | |
| 133 | 1551 :for k in keys(s:) |
| 1552 : unlet s:[k] | |
| 1553 :endfor | |
| 1554 < | |
| 4358 | 1555 *buffer-variable* *b:var* *b:* |
| 7 | 1556 A variable name that is preceded with "b:" is local to the current buffer. |
| 1557 Thus you can have several "b:foo" variables, one for each buffer. | |
| 1558 This kind of variable is deleted when the buffer is wiped out or deleted with | |
| 1559 |:bdelete|. | |
| 1560 | |
| 1561 One local buffer variable is predefined: | |
| 4264 | 1562 *b:changedtick* *changetick* |
| 7 | 1563 b:changedtick The total number of changes to the current buffer. It is |
| 1564 incremented for each change. An undo command is also a change | |
|
16996
d5e1e09a829f
patch 8.1.1498: ":write" increments b:changedtick even though nothing changed
Bram Moolenaar <Bram@vim.org>
parents:
16971
diff
changeset
|
1565 in this case. Resetting 'modified' when writing the buffer is |
|
d5e1e09a829f
patch 8.1.1498: ":write" increments b:changedtick even though nothing changed
Bram Moolenaar <Bram@vim.org>
parents:
16971
diff
changeset
|
1566 also counted. |
|
d5e1e09a829f
patch 8.1.1498: ":write" increments b:changedtick even though nothing changed
Bram Moolenaar <Bram@vim.org>
parents:
16971
diff
changeset
|
1567 This can be used to perform an action only when the buffer has |
|
d5e1e09a829f
patch 8.1.1498: ":write" increments b:changedtick even though nothing changed
Bram Moolenaar <Bram@vim.org>
parents:
16971
diff
changeset
|
1568 changed. Example: > |
| 7 | 1569 :if my_changedtick != b:changedtick |
| 1621 | 1570 : let my_changedtick = b:changedtick |
| 1571 : call My_Update() | |
| 7 | 1572 :endif |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
1573 < You cannot change or delete the b:changedtick variable. |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
1574 |
| 4358 | 1575 *window-variable* *w:var* *w:* |
| 7 | 1576 A variable name that is preceded with "w:" is local to the current window. It |
| 1577 is deleted when the window is closed. | |
| 1578 | |
| 4437 | 1579 *tabpage-variable* *t:var* *t:* |
| 819 | 1580 A variable name that is preceded with "t:" is local to the current tab page, |
| 1581 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
|
1582 without the |+windows| feature} |
| 819 | 1583 |
| 4358 | 1584 *global-variable* *g:var* *g:* |
| 7 | 1585 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
|
1586 access a variable local to a function. But "g:" can also be used in any other |
| 7 | 1587 place if you like. |
| 1588 | |
| 4358 | 1589 *local-variable* *l:var* *l:* |
| 7 | 1590 Inside functions local variables are accessed without prepending anything. |
| 1156 | 1591 But you can also prepend "l:" if you like. However, without prepending "l:" |
| 1592 you may run into reserved variable names. For example "count". By itself it | |
| 1593 refers to "v:count". Using "l:count" you can have a local variable with the | |
| 1594 same name. | |
| 7 | 1595 |
| 1596 *script-variable* *s:var* | |
| 1597 In a Vim script variables starting with "s:" can be used. They cannot be | |
| 1598 accessed from outside of the scripts, thus are local to the script. | |
| 1599 | |
| 1600 They can be used in: | |
| 1601 - commands executed while the script is sourced | |
| 1602 - functions defined in the script | |
| 1603 - autocommands defined in the script | |
| 1604 - functions and autocommands defined in functions and autocommands which were | |
| 1605 defined in the script (recursively) | |
| 1606 - user defined commands defined in the script | |
| 1607 Thus not in: | |
| 1608 - other scripts sourced from this one | |
| 1609 - mappings | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1610 - menus |
| 7 | 1611 - etc. |
| 1612 | |
| 1156 | 1613 Script variables can be used to avoid conflicts with global variable names. |
| 1614 Take this example: > | |
| 7 | 1615 |
| 1616 let s:counter = 0 | |
| 1617 function MyCounter() | |
| 1618 let s:counter = s:counter + 1 | |
| 1619 echo s:counter | |
| 1620 endfunction | |
| 1621 command Tick call MyCounter() | |
| 1622 | |
| 1623 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
| 1624 that script will not be changed, only the "s:counter" in the script where | |
| 1625 "Tick" was defined is used. | |
| 1626 | |
| 1627 Another example that does the same: > | |
| 1628 | |
| 1629 let s:counter = 0 | |
| 1630 command Tick let s:counter = s:counter + 1 | echo s:counter | |
| 1631 | |
| 1632 When calling a function and invoking a user-defined command, the context for | |
| 9 | 1633 script variables is set to the script where the function or command was |
| 7 | 1634 defined. |
| 1635 | |
| 1636 The script variables are also available when a function is defined inside a | |
| 1637 function that is defined in a script. Example: > | |
| 1638 | |
| 1639 let s:counter = 0 | |
| 1640 function StartCounting(incr) | |
| 1641 if a:incr | |
| 1642 function MyCounter() | |
| 1643 let s:counter = s:counter + 1 | |
| 1644 endfunction | |
| 1645 else | |
| 1646 function MyCounter() | |
| 1647 let s:counter = s:counter - 1 | |
| 1648 endfunction | |
| 1649 endif | |
| 1650 endfunction | |
| 1651 | |
| 1652 This defines the MyCounter() function either for counting up or counting down | |
| 1653 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
| 1654 called, the s:counter variable will be accessible in MyCounter(). | |
| 1655 | |
| 1656 When the same script is sourced again it will use the same script variables. | |
| 1657 They will remain valid as long as Vim is running. This can be used to | |
| 1658 maintain a counter: > | |
| 1659 | |
| 1660 if !exists("s:counter") | |
| 1661 let s:counter = 1 | |
| 1662 echo "script executed for the first time" | |
| 1663 else | |
| 1664 let s:counter = s:counter + 1 | |
| 1665 echo "script executed " . s:counter . " times now" | |
| 1666 endif | |
| 1667 | |
| 1668 Note that this means that filetype plugins don't get a different set of script | |
| 1669 variables for each buffer. Use local buffer variables instead |b:var|. | |
| 1670 | |
| 1671 | |
| 15131 | 1672 PREDEFINED VIM VARIABLES *vim-variable* *v:var* *v:* |
| 1673 *E963* | |
| 1674 Some variables can be set by the user, but the type cannot be changed. | |
| 7 | 1675 |
|
18477
e93cab5d0f0f
patch 8.1.2233: cannot get the Vim command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
1676 *v:argv* *argv-variable* |
|
e93cab5d0f0f
patch 8.1.2233: cannot get the Vim command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
1677 v:argv The command line arguments Vim was invoked with. This is a |
|
e93cab5d0f0f
patch 8.1.2233: cannot get the Vim command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
1678 list of strings. The first item is the Vim command. |
|
e93cab5d0f0f
patch 8.1.2233: cannot get the Vim command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
1679 |
| 189 | 1680 *v:beval_col* *beval_col-variable* |
| 1681 v:beval_col The number of the column, over which the mouse pointer is. | |
| 1682 This is the byte index in the |v:beval_lnum| line. | |
| 1683 Only valid while evaluating the 'balloonexpr' option. | |
| 1684 | |
| 1685 *v:beval_bufnr* *beval_bufnr-variable* | |
| 1686 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
| 1687 valid while evaluating the 'balloonexpr' option. | |
| 1688 | |
| 1689 *v:beval_lnum* *beval_lnum-variable* | |
| 1690 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
| 1691 valid while evaluating the 'balloonexpr' option. | |
| 1692 | |
| 1693 *v:beval_text* *beval_text-variable* | |
| 374 | 1694 v:beval_text The text under or after the mouse pointer. Usually a word as |
| 1695 it is useful for debugging a C program. 'iskeyword' applies, | |
| 1696 but a dot and "->" before the position is included. When on a | |
| 1697 ']' the text before it is used, including the matching '[' and | |
| 189 | 1698 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
|
1699 highlighted text is used. Also see |<cexpr>|. |
| 189 | 1700 Only valid while evaluating the 'balloonexpr' option. |
| 1701 | |
| 1702 *v:beval_winnr* *beval_winnr-variable* | |
| 1703 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
| 2709 | 1704 valid while evaluating the 'balloonexpr' option. The first |
| 1705 window has number zero (unlike most other places where a | |
| 1706 window gets a number). | |
| 189 | 1707 |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1708 *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
|
1709 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
|
1710 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
|
1711 |
| 844 | 1712 *v:char* *char-variable* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1713 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
|
1714 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
|
1715 It is also used by the |InsertCharPre| and |InsertEnter| events. |
| 844 | 1716 |
| 7 | 1717 *v:charconvert_from* *charconvert_from-variable* |
| 1718 v:charconvert_from | |
| 1719 The name of the character encoding of a file to be converted. | |
| 1720 Only valid while evaluating the 'charconvert' option. | |
| 1721 | |
| 1722 *v:charconvert_to* *charconvert_to-variable* | |
| 1723 v:charconvert_to | |
| 1724 The name of the character encoding of a file after conversion. | |
| 1725 Only valid while evaluating the 'charconvert' option. | |
| 1726 | |
| 1727 *v:cmdarg* *cmdarg-variable* | |
| 1728 v:cmdarg This variable is used for two purposes: | |
| 1729 1. The extra arguments given to a file read/write command. | |
| 1730 Currently these are "++enc=" and "++ff=". This variable is | |
| 1731 set before an autocommand event for a file read/write | |
| 1732 command is triggered. There is a leading space to make it | |
| 1733 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
|
1734 read/write command. Note: The "+cmd" argument isn't |
| 7 | 1735 included here, because it will be executed anyway. |
| 1736 2. When printing a PostScript file with ":hardcopy" this is | |
| 1737 the argument for the ":hardcopy" command. This can be used | |
| 1738 in 'printexpr'. | |
| 1739 | |
| 1740 *v:cmdbang* *cmdbang-variable* | |
| 1741 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
| 1742 was used the value is 1, otherwise it is 0. Note that this | |
| 1743 can only be used in autocommands. For user commands |<bang>| | |
| 1744 can be used. | |
| 1745 | |
| 6909 | 1746 *v:completed_item* *completed_item-variable* |
| 1747 v:completed_item | |
| 1748 |Dictionary| containing the |complete-items| for the most | |
| 1749 recently completed word after |CompleteDone|. The | |
| 1750 |Dictionary| is empty if the completion failed. | |
| 1751 | |
| 7 | 1752 *v:count* *count-variable* |
| 1753 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
|
1754 to get the count before a mapping. Read-only. Example: > |
| 7 | 1755 :map _x :<C-U>echo "the count is " . v:count<CR> |
| 1756 < Note: The <C-U> is required to remove the line range that you | |
| 1757 get when typing ':' after a count. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1758 When there are two counts, as in "3d2w", they are multiplied, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1759 just like what happens in the command, "d6w" for the example. |
| 667 | 1760 Also used for evaluating the 'formatexpr' option. |
|
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
1761 "count" also works, for backwards compatibility, unless |
|
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
1762 |scriptversion| is 3 or higher. |
| 7 | 1763 |
| 1764 *v:count1* *count1-variable* | |
| 1765 v:count1 Just like "v:count", but defaults to one when no count is | |
| 1766 used. | |
| 1767 | |
| 1768 *v:ctype* *ctype-variable* | |
| 1769 v:ctype The current locale setting for characters of the runtime | |
| 1770 environment. This allows Vim scripts to be aware of the | |
| 1771 current locale encoding. Technical: it's the value of | |
| 1772 LC_CTYPE. When not using a locale the value is "C". | |
| 1773 This variable can not be set directly, use the |:language| | |
| 1774 command. | |
| 1775 See |multi-lang|. | |
| 1776 | |
| 1777 *v:dying* *dying-variable* | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1778 v:dying Normally zero. When a deadly signal is caught it's set to |
| 7 | 1779 one. When multiple signals are caught the number increases. |
| 1780 Can be used in an autocommand to check if Vim didn't | |
| 1781 terminate normally. {only works on Unix} | |
| 1782 Example: > | |
| 1783 :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
|
1784 < 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
|
1785 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
|
1786 |
|
17833
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1787 *v:echospace* *echospace-variable* |
|
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1788 v:echospace Number of screen cells that can be used for an `:echo` message |
|
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1789 in the last screen line before causing the |hit-enter-prompt|. |
|
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1790 Depends on 'showcmd', 'ruler' and 'columns'. You need to |
|
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1791 check 'cmdheight' for whether there are full-width lines |
|
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1792 available above the last line. |
|
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1793 |
| 7 | 1794 *v:errmsg* *errmsg-variable* |
| 1795 v:errmsg Last given error message. It's allowed to set this variable. | |
| 1796 Example: > | |
| 1797 :let v:errmsg = "" | |
| 1798 :silent! next | |
| 1799 :if v:errmsg != "" | |
| 1800 : ... handle error | |
|
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
1801 < "errmsg" also works, for backwards compatibility, unless |
|
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
1802 |scriptversion| is 3 or higher. |
| 7 | 1803 |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
1804 *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
|
1805 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
|
1806 This is a list of strings. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1807 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
|
1808 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
|
1809 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
|
1810 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
|
1811 :let v:errors = [] |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1812 < 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
|
1813 list by the assert function. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1814 |
|
13037
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1815 *v:event* *event-variable* |
|
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1816 v:event Dictionary containing information about the current |
| 19303 | 1817 |autocommand|. See the specific event for what it puts in |
| 1818 this dictionary. | |
| 20115 | 1819 The dictionary is emptied when the |autocommand| finishes, |
| 1820 please refer to |dict-identity| for how to get an independent | |
| 1821 copy of it. Use |deepcopy()| if you want to keep the | |
| 1822 information after the event triggers. Example: > | |
| 1823 au TextYankPost * let g:foo = deepcopy(v:event) | |
| 1824 < | |
| 7 | 1825 *v:exception* *exception-variable* |
| 1826 v:exception The value of the exception most recently caught and not | |
| 1827 finished. See also |v:throwpoint| and |throw-variables|. | |
| 1828 Example: > | |
| 1829 :try | |
| 1830 : throw "oops" | |
| 1831 :catch /.*/ | |
| 17571 | 1832 : echo "caught " .. v:exception |
| 7 | 1833 :endtry |
| 1834 < Output: "caught oops". | |
| 1835 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1836 *v:false* *false-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1837 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
|
1838 |json_encode()|. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1839 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
|
1840 echo v:false |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1841 < v:false ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1842 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
|
1843 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1844 |
| 179 | 1845 *v:fcs_reason* *fcs_reason-variable* |
| 1846 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
| 1847 Can be used in an autocommand to decide what to do and/or what | |
| 1848 to set v:fcs_choice to. Possible values: | |
| 1849 deleted file no longer exists | |
| 1850 conflict file contents, mode or timestamp was | |
| 1851 changed and buffer is modified | |
| 1852 changed file contents has changed | |
| 1853 mode mode of file changed | |
| 1854 time only file timestamp changed | |
| 1855 | |
| 1856 *v:fcs_choice* *fcs_choice-variable* | |
| 1857 v:fcs_choice What should happen after a |FileChangedShell| event was | |
| 1858 triggered. Can be used in an autocommand to tell Vim what to | |
| 1859 do with the affected buffer: | |
| 1860 reload Reload the buffer (does not work if | |
| 1861 the file was deleted). | |
| 1862 ask Ask the user what to do, as if there | |
| 1863 was no autocommand. Except that when | |
| 1864 only the timestamp changed nothing | |
| 1865 will happen. | |
| 1866 <empty> Nothing, the autocommand should do | |
| 1867 everything that needs to be done. | |
| 1868 The default is empty. If another (invalid) value is used then | |
| 1869 Vim behaves like it is empty, there is no warning message. | |
| 1870 | |
| 7 | 1871 *v:fname_in* *fname_in-variable* |
| 579 | 1872 v:fname_in The name of the input file. Valid while evaluating: |
| 7 | 1873 option used for ~ |
| 1874 'charconvert' file to be converted | |
| 1875 'diffexpr' original file | |
| 1876 'patchexpr' original file | |
| 1877 'printexpr' file to be printed | |
| 593 | 1878 And set to the swap file name for |SwapExists|. |
| 7 | 1879 |
| 1880 *v:fname_out* *fname_out-variable* | |
| 1881 v:fname_out The name of the output file. Only valid while | |
| 1882 evaluating: | |
| 1883 option used for ~ | |
| 1884 'charconvert' resulting converted file (*) | |
| 1885 'diffexpr' output of diff | |
| 1886 'patchexpr' resulting patched file | |
| 1887 (*) 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
|
1888 file") it will be equal to v:fname_in. When doing conversion |
| 7 | 1889 for a read command (e.g., ":e file") it will be a temporary |
| 1890 file and different from v:fname_in. | |
| 1891 | |
| 1892 *v:fname_new* *fname_new-variable* | |
| 1893 v:fname_new The name of the new version of the file. Only valid while | |
| 1894 evaluating 'diffexpr'. | |
| 1895 | |
| 1896 *v:fname_diff* *fname_diff-variable* | |
| 1897 v:fname_diff The name of the diff (patch) file. Only valid while | |
| 1898 evaluating 'patchexpr'. | |
| 1899 | |
| 1900 *v:folddashes* *folddashes-variable* | |
| 1901 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
| 1902 fold. | |
| 29 | 1903 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1904 |
| 1905 *v:foldlevel* *foldlevel-variable* | |
| 1906 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
| 29 | 1907 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1908 |
| 1909 *v:foldend* *foldend-variable* | |
| 1910 v:foldend Used for 'foldtext': last line of closed fold. | |
| 29 | 1911 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1912 |
| 1913 *v:foldstart* *foldstart-variable* | |
| 1914 v:foldstart Used for 'foldtext': first line of closed fold. | |
| 29 | 1915 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1916 |
| 5460 | 1917 *v:hlsearch* *hlsearch-variable* |
| 12785 | 1918 v:hlsearch Variable that indicates whether search highlighting is on. |
| 6413 | 1919 Setting it makes sense only if 'hlsearch' is enabled which |
| 1920 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
|
1921 like the |:nohlsearch| command, setting it to one acts like > |
| 5460 | 1922 let &hlsearch = &hlsearch |
| 6918 | 1923 < Note that the value is restored when returning from a |
| 1924 function. |function-search-undo|. | |
| 1925 | |
| 11 | 1926 *v:insertmode* *insertmode-variable* |
| 1927 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
| 1928 events. Values: | |
| 1929 i Insert mode | |
| 1930 r Replace mode | |
| 1931 v Virtual Replace mode | |
| 1932 | |
| 102 | 1933 *v:key* *key-variable* |
| 685 | 1934 v:key Key of the current item of a |Dictionary|. Only valid while |
| 102 | 1935 evaluating the expression used with |map()| and |filter()|. |
| 1936 Read-only. | |
| 1937 | |
| 7 | 1938 *v:lang* *lang-variable* |
| 1939 v:lang The current locale setting for messages of the runtime | |
| 1940 environment. This allows Vim scripts to be aware of the | |
| 1941 current language. Technical: it's the value of LC_MESSAGES. | |
| 1942 The value is system dependent. | |
| 1943 This variable can not be set directly, use the |:language| | |
| 1944 command. | |
| 1945 It can be different from |v:ctype| when messages are desired | |
| 1946 in a different language than what is used for character | |
| 1947 encoding. See |multi-lang|. | |
| 1948 | |
| 1949 *v:lc_time* *lc_time-variable* | |
| 1950 v:lc_time The current locale setting for time messages of the runtime | |
| 1951 environment. This allows Vim scripts to be aware of the | |
| 1952 current language. Technical: it's the value of LC_TIME. | |
| 1953 This variable can not be set directly, use the |:language| | |
| 1954 command. See |multi-lang|. | |
| 1955 | |
| 1956 *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
|
1957 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
|
1958 '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
|
1959 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
|
1960 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
|
1961 |sandbox|. |
| 7 | 1962 |
| 1029 | 1963 *v:mouse_win* *mouse_win-variable* |
| 1964 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
| 1965 First window has number 1, like with |winnr()|. The value is | |
| 1966 zero when there was no mouse button click. | |
| 1967 | |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1968 *v:mouse_winid* *mouse_winid-variable* |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1969 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
|
1970 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
|
1971 |
| 1029 | 1972 *v:mouse_lnum* *mouse_lnum-variable* |
| 1973 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
| 1974 This is the text line number, not the screen line number. The | |
| 1975 value is zero when there was no mouse button click. | |
| 1976 | |
| 1977 *v:mouse_col* *mouse_col-variable* | |
| 1978 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
| 1979 This is the screen column number, like with |virtcol()|. The | |
| 1980 value is zero when there was no mouse button click. | |
| 1981 | |
| 15512 | 1982 *v:none* *none-variable* *None* |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1983 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
|
1984 |json_encode()|. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1985 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
|
1986 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
|
1987 echo v:none |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1988 < v:none ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1989 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
|
1990 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1991 |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1992 *v:null* *null-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1993 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
|
1994 |json_encode()|. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1995 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
|
1996 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
|
1997 echo v:null |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1998 < v:null ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1999 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
|
2000 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2001 |
|
19477
2bb0e80fcd32
patch 8.2.0296: mixing up "long long" and __int64 may cause problems
Bram Moolenaar <Bram@vim.org>
parents:
19400
diff
changeset
|
2002 *v:numbersize* *numbersize-variable* |
|
2bb0e80fcd32
patch 8.2.0296: mixing up "long long" and __int64 may cause problems
Bram Moolenaar <Bram@vim.org>
parents:
19400
diff
changeset
|
2003 v:numbersize Number of bits in a Number. This is normally 64, but on some |
| 19523 | 2004 systems it may be 32. |
|
19477
2bb0e80fcd32
patch 8.2.0296: mixing up "long long" and __int64 may cause problems
Bram Moolenaar <Bram@vim.org>
parents:
19400
diff
changeset
|
2005 |
| 1733 | 2006 *v:oldfiles* *oldfiles-variable* |
| 2007 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
| 2008 startup. These are the files that Vim remembers marks for. | |
| 2009 The length of the List is limited by the ' argument of the | |
| 2010 'viminfo' option (default is 100). | |
| 5618 | 2011 When the |viminfo| file is not used the List is empty. |
| 1733 | 2012 Also see |:oldfiles| and |c_#<|. |
| 2013 The List can be modified, but this has no effect on what is | |
| 2014 stored in the |viminfo| file later. If you use values other | |
| 2015 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
|
2016 {only when compiled with the |+viminfo| feature} |
| 1733 | 2017 |
| 6935 | 2018 *v:option_new* |
| 2019 v:option_new New value of the option. Valid while executing an |OptionSet| | |
| 2020 autocommand. | |
| 2021 *v:option_old* | |
| 2022 v:option_old Old value of the option. Valid while executing an |OptionSet| | |
|
17085
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2023 autocommand. Depending on the command used for setting and the |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2024 kind of option this is either the local old value or the |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2025 global old value. |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2026 *v:option_oldlocal* |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2027 v:option_oldlocal |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2028 Old local value of the option. Valid while executing an |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2029 |OptionSet| autocommand. |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2030 *v:option_oldglobal* |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2031 v:option_oldglobal |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2032 Old global value of the option. Valid while executing an |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2033 |OptionSet| autocommand. |
| 6935 | 2034 *v:option_type* |
| 2035 v:option_type Scope of the set command. Valid while executing an | |
| 2036 |OptionSet| autocommand. Can be either "global" or "local" | |
|
17085
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2037 *v:option_command* |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2038 v:option_command |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2039 Command used to set the option. Valid while executing an |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2040 |OptionSet| autocommand. |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2041 value option was set via ~ |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2042 "setlocal" |:setlocal| or ":let l:xxx" |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2043 "setglobal" |:setglobal| or ":let g:xxx" |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2044 "set" |:set| or |:let| |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2045 "modeline" |modeline| |
| 1490 | 2046 *v:operator* *operator-variable* |
| 2047 v:operator The last operator given in Normal mode. This is a single | |
| 2048 character except for commands starting with <g> or <z>, | |
| 2049 in which case it is two characters. Best used alongside | |
| 2050 |v:prevcount| and |v:register|. Useful if you want to cancel | |
| 2051 Operator-pending mode and then use the operator, e.g.: > | |
| 2052 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
| 2053 < The value remains set until another operator is entered, thus | |
| 2054 don't expect it to be empty. | |
| 2055 v:operator is not set for |:delete|, |:yank| or other Ex | |
| 2056 commands. | |
| 2057 Read-only. | |
| 2058 | |
| 7 | 2059 *v:prevcount* *prevcount-variable* |
| 2060 v:prevcount The count given for the last but one Normal mode command. | |
| 2061 This is the v:count value of the previous command. Useful if | |
| 1490 | 2062 you want to cancel Visual or Operator-pending mode and then |
| 2063 use the count, e.g.: > | |
| 7 | 2064 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
| 2065 < Read-only. | |
| 2066 | |
| 170 | 2067 *v:profiling* *profiling-variable* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2068 v:profiling Normally zero. Set to one after using ":profile start". |
| 170 | 2069 See |profiling|. |
| 2070 | |
| 7 | 2071 *v:progname* *progname-variable* |
| 2072 v:progname Contains the name (with path removed) with which Vim was | |
| 3492 | 2073 invoked. Allows you to do special initialisations for |view|, |
| 2074 |evim| etc., or any other name you might symlink to Vim. | |
| 7 | 2075 Read-only. |
| 2076 | |
| 5780 | 2077 *v:progpath* *progpath-variable* |
| 17758 | 2078 v:progpath Contains the command with which Vim was invoked, in a form |
| 2079 that when passed to the shell will run the same Vim executable | |
| 2080 as the current one (if $PATH remains unchanged). | |
| 2081 Useful if you want to message a Vim server using a | |
| 5780 | 2082 |--remote-expr|. |
| 5782 | 2083 To get the full path use: > |
| 2084 echo exepath(v:progpath) | |
| 17758 | 2085 < If the command has a relative path it will be expanded to the |
| 2086 full path, so that it still works after `:cd`. Thus starting | |
| 2087 "./vim" results in "/home/user/path/to/vim/src/vim". | |
| 2088 On Linux and other systems it will always be the full path. | |
| 2089 On Mac it may just be "vim" and using exepath() as mentioned | |
| 2090 above should be used to get the full path. | |
|
11032
516391d8865f
patch 8.0.0405: v:progpath may become invalid after :cd
Christian Brabandt <cb@256bit.org>
parents:
11014
diff
changeset
|
2091 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
|
2092 ".exe" is not added to v:progpath. |
| 5780 | 2093 Read-only. |
| 2094 | |
| 7 | 2095 *v:register* *register-variable* |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2096 v:register The name of the register in effect for the current normal mode |
| 3492 | 2097 command (regardless of whether that command actually used a |
| 2098 register). Or for the currently executing normal mode mapping | |
| 2099 (use this in custom commands that take a register). | |
| 2100 If none is supplied it is the default register '"', unless | |
| 2101 'clipboard' contains "unnamed" or "unnamedplus", then it is | |
| 2102 '*' or '+'. | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2103 Also see |getreg()| and |setreg()| |
| 7 | 2104 |
| 540 | 2105 *v:scrollstart* *scrollstart-variable* |
| 2106 v:scrollstart String describing the script or function that caused the | |
| 2107 screen to scroll up. It's only set when it is empty, thus the | |
| 2108 first reason is remembered. It is set to "Unknown" for a | |
| 2109 typed command. | |
| 2110 This can be used to find out why your script causes the | |
| 2111 hit-enter prompt. | |
| 2112 | |
| 7 | 2113 *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
|
2114 v:servername The resulting registered |client-server-name| if any. |
| 7 | 2115 Read-only. |
| 2116 | |
| 12785 | 2117 |
| 1621 | 2118 v:searchforward *v:searchforward* *searchforward-variable* |
| 2119 Search direction: 1 after a forward search, 0 after a | |
| 2120 backward search. It is reset to forward when directly setting | |
| 2121 the last search pattern, see |quote/|. | |
| 2122 Note that the value is restored when returning from a | |
| 2123 function. |function-search-undo|. | |
| 2124 Read-write. | |
| 2125 | |
| 7 | 2126 *v:shell_error* *shell_error-variable* |
| 2127 v:shell_error Result of the last shell command. When non-zero, the last | |
| 2128 shell command had an error. When zero, there was no problem. | |
| 2129 This only works when the shell returns the error code to Vim. | |
| 2130 The value -1 is often used when the command could not be | |
| 2131 executed. Read-only. | |
| 2132 Example: > | |
| 2133 :!mv foo bar | |
| 2134 :if v:shell_error | |
| 2135 : echo 'could not rename "foo" to "bar"!' | |
| 2136 :endif | |
|
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2137 < "shell_error" also works, for backwards compatibility, unless |
|
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2138 |scriptversion| is 3 or higher. |
| 7 | 2139 |
| 2140 *v:statusmsg* *statusmsg-variable* | |
| 2141 v:statusmsg Last given status message. It's allowed to set this variable. | |
| 2142 | |
| 579 | 2143 *v:swapname* *swapname-variable* |
| 2144 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
| 2145 the swap file found. Read-only. | |
| 2146 | |
| 2147 *v:swapchoice* *swapchoice-variable* | |
| 2148 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
| 2149 for handling an existing swap file: | |
| 2150 'o' Open read-only | |
| 2151 'e' Edit anyway | |
| 2152 'r' Recover | |
| 2153 'd' Delete swapfile | |
| 2154 'q' Quit | |
| 2155 'a' Abort | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2156 The value should be a single-character string. An empty value |
| 579 | 2157 results in the user being asked, as would happen when there is |
| 2158 no SwapExists autocommand. The default is empty. | |
| 2159 | |
| 590 | 2160 *v:swapcommand* *swapcommand-variable* |
| 625 | 2161 v:swapcommand Normal mode command to be executed after a file has been |
| 590 | 2162 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
|
2163 another Vim open the file and jump to the right place. For |
| 590 | 2164 example, when jumping to a tag the value is ":tag tagname\r". |
| 716 | 2165 For ":edit +cmd file" the value is ":cmd\r". |
| 590 | 2166 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
2167 *v:t_TYPE* *v:t_bool* *t_bool-variable* |
| 15512 | 2168 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
|
2169 *v:t_channel* *t_channel-variable* |
| 15512 | 2170 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
|
2171 *v:t_dict* *t_dict-variable* |
| 15512 | 2172 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
|
2173 *v:t_float* *t_float-variable* |
| 15512 | 2174 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
|
2175 *v:t_func* *t_func-variable* |
| 15512 | 2176 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
|
2177 *v:t_job* *t_job-variable* |
| 15512 | 2178 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
|
2179 *v:t_list* *t_list-variable* |
| 15512 | 2180 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
|
2181 *v:t_none* *t_none-variable* |
| 15512 | 2182 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
|
2183 *v:t_number* *t_number-variable* |
| 15512 | 2184 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
|
2185 *v:t_string* *t_string-variable* |
| 15512 | 2186 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
|
2187 *v:t_blob* *t_blob-variable* |
| 15512 | 2188 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
|
2189 |
| 7 | 2190 *v:termresponse* *termresponse-variable* |
| 2191 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
|
2192 termcap entry. It is set when Vim receives an escape sequence |
|
16849
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
2193 that starts with ESC [ or CSI, then '>' or '?' and ends in a |
|
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
2194 'c', with only digits and ';' in between. |
| 7 | 2195 When this option is set, the TermResponse autocommand event is |
| 2196 fired, so that you can react to the response from the | |
| 2197 terminal. | |
|
16849
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
2198 The response from a new xterm is: "<Esc>[> Pp ; Pv ; Pc c". Pp |
| 7 | 2199 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the |
| 2200 patch level (since this was introduced in patch 95, it's | |
| 2201 always 95 or bigger). Pc is always zero. | |
| 2202 {only when compiled with |+termresponse| feature} | |
| 2203 | |
|
12273
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2204 *v:termblinkresp* |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2205 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
|
2206 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
|
2207 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
|
2208 |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2209 *v:termstyleresp* |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2210 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
|
2211 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
|
2212 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
|
2213 |
|
12632
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
2214 *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
|
2215 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
|
2216 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
|
2217 background color is, see 'background'. |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2218 |
|
12632
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
2219 *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
|
2220 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
|
2221 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
|
2222 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
|
2223 |
|
12273
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2224 *v:termu7resp* |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2225 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
|
2226 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
|
2227 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
|
2228 |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
2229 *v:testing* *testing-variable* |
|
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
2230 v:testing Must be set before using `test_garbagecollect_now()`. |
| 11160 | 2231 Also, when set certain error messages won't be shown for 2 |
| 12785 | 2232 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
|
2233 |
| 7 | 2234 *v:this_session* *this_session-variable* |
| 2235 v:this_session Full filename of the last loaded or saved session file. See | |
| 2236 |:mksession|. It is allowed to set this variable. When no | |
| 2237 session file has been saved, this variable is empty. | |
|
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2238 "this_session" also works, for backwards compatibility, unless |
|
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2239 |scriptversion| is 3 or higher |
| 7 | 2240 |
| 2241 *v:throwpoint* *throwpoint-variable* | |
| 2242 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
|
2243 finished was thrown. Not set when commands are typed. See |
| 7 | 2244 also |v:exception| and |throw-variables|. |
| 2245 Example: > | |
| 2246 :try | |
| 2247 : throw "oops" | |
| 2248 :catch /.*/ | |
| 2249 : echo "Exception from" v:throwpoint | |
| 2250 :endtry | |
| 2251 < Output: "Exception from test.vim, line 2" | |
| 2252 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2253 *v:true* *true-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2254 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
|
2255 |json_encode()|. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2256 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
|
2257 echo v:true |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2258 < v:true ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2259 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
|
2260 value. Read-only. |
| 102 | 2261 *v:val* *val-variable* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2262 v:val Value of the current item of a |List| or |Dictionary|. Only |
| 685 | 2263 valid while evaluating the expression used with |map()| and |
| 102 | 2264 |filter()|. Read-only. |
| 2265 | |
| 7 | 2266 *v:version* *version-variable* |
| 2267 v:version Version number of Vim: Major version number times 100 plus | |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
2268 minor version number. Version 5.0 is 500. Version 5.1 |
| 7 | 2269 is 501. Read-only. "version" also works, for backwards |
|
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2270 compatibility, unless |scriptversion| is 3 or higher. |
| 7 | 2271 Use |has()| to check if a certain patch was included, e.g.: > |
| 5786 | 2272 if has("patch-7.4.123") |
| 7 | 2273 < Note that patch numbers are specific to the version, thus both |
| 2274 version 5.0 and 5.1 may have a patch 123, but these are | |
| 2275 completely different. | |
| 2276 | |
|
17053
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2277 *v:versionlong* *versionlong-variable* |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
2278 v:versionlong Like v:version, but also including the patchlevel in the last |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
2279 four digits. Version 8.1 with patch 123 has value 8010123. |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
2280 This can be used like this: > |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
2281 if v:versionlong >= 8010123 |
|
17053
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2282 < However, if there are gaps in the list of patches included |
|
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2283 this will not work well. This can happen if a recent patch |
|
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2284 was included into an older version, e.g. for a security fix. |
|
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2285 Use the has() function to make sure the patch is actually |
|
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2286 included. |
|
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2287 |
|
8738
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
2288 *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
|
2289 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
|
2290 before |VimEnter| autocommands are triggered. |
|
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
2291 |
| 7 | 2292 *v:warningmsg* *warningmsg-variable* |
| 2293 v:warningmsg Last given warning message. It's allowed to set this variable. | |
| 2294 | |
| 2609 | 2295 *v:windowid* *windowid-variable* |
| 2296 v:windowid When any X11 based GUI is running or when running in a | |
| 2297 terminal and Vim connects to the X server (|-X|) this will be | |
| 2616 | 2298 set to the window ID. |
| 2299 When an MS-Windows GUI is running this will be set to the | |
| 2300 window handle. | |
| 2301 Otherwise the value is zero. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
2302 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
|
2303 see |window-ID|. |
| 2609 | 2304 |
| 7 | 2305 ============================================================================== |
| 2306 4. Builtin Functions *functions* | |
| 2307 | |
| 2308 See |function-list| for a list grouped by what the function is used for. | |
| 2309 | |
| 236 | 2310 (Use CTRL-] on the function name to jump to the full explanation.) |
| 7 | 2311 |
| 2312 USAGE RESULT DESCRIPTION ~ | |
| 2313 | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2314 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
|
2315 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
|
2316 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
|
2317 and({expr}, {expr}) Number bitwise AND |
| 14864 | 2318 append({lnum}, {text}) Number append {text} below line {lnum} |
| 2319 appendbufline({expr}, {lnum}, {text}) | |
| 2320 Number append {text} below line {lnum} | |
| 2321 in buffer {expr} | |
| 15033 | 2322 argc([{winid}]) Number number of files in the argument list |
| 55 | 2323 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
|
2324 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
|
2325 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
|
2326 argv([-1, {winid}]) List the argument list |
|
20679
1af1d8ff2aa8
patch 8.2.0893: assert_equalfile() does not take a third argument
Bram Moolenaar <Bram@vim.org>
parents:
20665
diff
changeset
|
2327 asin({expr}) Float arc sine of {expr} |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2328 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
|
2329 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
|
2330 Number assert {exp} is equal to {act} |
|
20679
1af1d8ff2aa8
patch 8.2.0893: assert_equalfile() does not take a third argument
Bram Moolenaar <Bram@vim.org>
parents:
20665
diff
changeset
|
2331 assert_equalfile({fname-one}, {fname-two} [, {msg}]) |
|
1af1d8ff2aa8
patch 8.2.0893: assert_equalfile() does not take a third argument
Bram Moolenaar <Bram@vim.org>
parents:
20665
diff
changeset
|
2332 Number assert file contents are equal |
|
11181
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2333 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
|
2334 Number assert {error} is in v:exception |
| 14945 | 2335 assert_fails({cmd} [, {error} [, {msg}]]) |
| 2336 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
|
2337 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
|
2338 Number assert {actual} is false |
|
9636
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2339 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
|
2340 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
|
2341 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
|
2342 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
|
2343 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
|
2344 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
|
2345 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
|
2346 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
|
2347 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
|
2348 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
|
2349 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
|
2350 atan2({expr1}, {expr2}) Float arc tangent of {expr1} / {expr2} |
|
16600
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
2351 balloon_gettext() String current text in the balloon |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
2352 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
|
2353 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
|
2354 browse({save}, {title}, {initdir}, {default}) |
| 7 | 2355 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
|
2356 browsedir({title}, {initdir}) String put up a directory requester |
|
17221
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
2357 bufadd({name}) Number add a buffer to the buffer list |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2358 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
|
2359 buflisted({expr}) Number |TRUE| if buffer {expr} is listed |
|
17221
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
2360 bufload({expr}) Number load buffer {expr} if not loaded yet |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2361 bufloaded({expr}) Number |TRUE| if buffer {expr} is loaded |
|
17855
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
2362 bufname([{expr}]) String Name of the buffer {expr} |
|
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
2363 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
|
2364 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
|
2365 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
|
2366 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
|
2367 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
|
2368 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
|
2369 call({func}, {arglist} [, {dict}]) |
| 102 | 2370 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
|
2371 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
|
2372 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
|
2373 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
|
2374 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
|
2375 ch_evalexpr({handle}, {expr} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2376 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
|
2377 ch_evalraw({handle}, {string} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2378 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
|
2379 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
|
2380 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
|
2381 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
|
2382 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
|
2383 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
|
2384 ch_open({address} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2385 Channel open a channel to {address} |
|
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2386 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
|
2387 ch_readblob({handle} [, {options}]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2388 Blob read Blob from {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2389 ch_readraw({handle} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2390 String read raw from {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2391 ch_sendexpr({handle}, {expr} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2392 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
|
2393 ch_sendraw({handle}, {expr} [, {options}]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2394 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
|
2395 ch_setoptions({handle}, {options}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2396 none set options for {handle} |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
2397 ch_status({handle} [, {options}]) |
|
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
2398 String status of channel {handle} |
| 1621 | 2399 changenr() Number current change number |
| 12785 | 2400 char2nr({expr} [, {utf8}]) Number ASCII/UTF8 value of first char in {expr} |
|
16576
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
2401 chdir({dir}) String change current working directory |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2402 cindent({lnum}) Number C indent for line {lnum} |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
2403 clearmatches([{win}]) none clear all matches |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2404 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
|
2405 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
|
2406 complete_add({expr}) Number add completion match |
| 1621 | 2407 complete_check() Number check for key typed during completion |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
2408 complete_info([{what}]) Dict get current completion information |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2409 confirm({msg} [, {choices} [, {default} [, {type}]]]) |
| 7 | 2410 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
|
2411 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
|
2412 cos({expr}) Float cosine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2413 cosh({expr}) Float hyperbolic cosine of {expr} |
| 14864 | 2414 count({comp}, {expr} [, {ic} [, {start}]]) |
| 2415 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
|
2416 cscope_connection([{num}, {dbpath} [, {prepend}]]) |
| 7 | 2417 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
|
2418 cursor({lnum}, {col} [, {off}]) |
| 6385 | 2419 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
|
2420 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
|
2421 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
|
2422 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
|
2423 delete({fname} [, {flags}]) Number delete the file or directory {fname} |
| 14519 | 2424 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
|
2425 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
|
2426 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
|
2427 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
|
2428 diff_hlID({lnum}, {col}) Number diff highlighting at {lnum}/{col} |
|
19400
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
2429 echoraw({expr}) none output {expr} as-is |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2430 empty({expr}) Number |TRUE| if {expr} is empty |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
2431 environ() Dict return environment variables |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2432 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
|
2433 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
|
2434 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
|
2435 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
|
2436 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
|
2437 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
|
2438 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
|
2439 exp({expr}) Float exponential of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2440 expand({expr} [, {nosuf} [, {list}]]) |
| 3398 | 2441 any expand special keywords in {expr} |
|
17020
1841c03a9b5e
patch 8.1.1510: a plugin cannot easily expand a command like done internally
Bram Moolenaar <Bram@vim.org>
parents:
17004
diff
changeset
|
2442 expandcmd({expr}) String expand {expr} like with `:edit` |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2443 extend({expr1}, {expr2} [, {expr3}]) |
|
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2444 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
|
2445 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
|
2446 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
|
2447 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
|
2448 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
|
2449 {expr2} is 0 |
| 12785 | 2450 finddir({name} [, {path} [, {count}]]) |
| 824 | 2451 String find directory {name} in {path} |
| 12785 | 2452 findfile({name} [, {path} [, {count}]]) |
| 824 | 2453 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
|
2454 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
|
2455 floor({expr}) Float round {expr} down |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2456 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
|
2457 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
|
2458 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
|
2459 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
|
2460 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
|
2461 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
|
2462 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
|
2463 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
|
2464 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
|
2465 funcref({name} [, {arglist}] [, {dict}]) |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
2466 Funcref reference to function {name} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2467 function({name} [, {arglist}] [, {dict}]) |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
2468 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
|
2469 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
|
2470 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
|
2471 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
|
2472 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
|
2473 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
|
2474 getbufline({expr}, {lnum} [, {end}]) |
| 435 | 2475 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
|
2476 getbufvar({expr}, {varname} [, {def}]) |
| 4157 | 2477 any variable {varname} in buffer {expr} |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
2478 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
|
2479 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
|
2480 getcharmod() Number modifiers for the last typed character |
| 7013 | 2481 getcharsearch() Dict last character search |
| 7 | 2482 getcmdline() String return the current command-line |
| 2483 getcmdpos() Number return cursor position in command-line | |
| 6153 | 2484 getcmdtype() String return current command-line type |
| 2485 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
|
2486 getcompletion({pat}, {type} [, {filtered}]) |
|
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
2487 List list of cmdline completion matches |
| 5944 | 2488 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
|
2489 getcwd([{winnr} [, {tabnr}]]) String get the current working directory |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
2490 getenv({name}) String return environment variable |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2491 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
|
2492 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
|
2493 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
|
2494 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
|
2495 getftype({fname}) String description of type of file {fname} |
|
18008
8ae333756614
patch 8.1.2000: plugin cannot get the current IME status
Bram Moolenaar <Bram@vim.org>
parents:
18000
diff
changeset
|
2496 getimstatus() Number |TRUE| if the IME status is active |
|
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
|
2497 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
|
2498 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
|
2499 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
|
2500 getline({lnum}, {end}) List lines {lnum} to {end} of current buffer |
| 12785 | 2501 getloclist({nr} [, {what}]) List list of location list items |
|
20615
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
2502 getmarklist([{expr}]) List list of global/local marks |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
2503 getmatches([{win}]) List list of current matches |
|
18623
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
2504 getmousepos() Dict last known mouse position |
| 1548 | 2505 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
|
2506 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
|
2507 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
|
2508 getreg([{regname} [, 1 [, {list}]]]) |
|
20743
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
2509 String or List contents of a register |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
2510 getreginfo([{regname}]) Dict information about a register |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
2511 getregtype([{regname}]) String type of a register |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
2512 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
|
2513 gettabvar({nr}, {varname} [, {def}]) |
| 4157 | 2514 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
|
2515 gettabwinvar({tabnr}, {winnr}, {name} [, {def}]) |
| 831 | 2516 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
|
2517 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
|
2518 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
|
2519 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
|
2520 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
|
2521 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
|
2522 getwinvar({nr}, {varname} [, {def}]) |
| 4157 | 2523 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
|
2524 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 3398 | 2525 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
|
2526 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
|
2527 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 1754 | 2528 String do glob({expr}) for all dirs in {path} |
|
19742
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
2529 has({feature} [, {check}]) Number |TRUE| if feature {feature} supported |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2530 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
|
2531 haslocaldir([{winnr} [, {tabnr}]]) |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2532 Number |TRUE| if the window executed |:lcd| |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
2533 or |:tcd| |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2534 hasmapto({what} [, {mode} [, {abbr}]]) |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2535 Number |TRUE| if mapping to {what} exists |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
2536 histadd({history}, {item}) Number add an item to a history |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
2537 histdel({history} [, {item}]) Number remove an item from a history |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2538 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
|
2539 histnr({history}) Number highest index of a history |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2540 hlID({name}) Number syntax ID of highlight group {name} |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2541 hlexists({name}) Number |TRUE| if highlight group {name} exists |
| 7 | 2542 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
|
2543 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
|
2544 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
|
2545 index({object}, {expr} [, {start} [, {ic}]]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2546 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
|
2547 input({prompt} [, {text} [, {completion}]]) |
| 531 | 2548 String get input from the user |
|
11763
21f3930dfe6e
Documentation updates.
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
2549 inputdialog({prompt} [, {text} [, {completion}]]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2550 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
|
2551 inputlist({textlist}) Number let the user pick from a choice list |
| 55 | 2552 inputrestore() Number restore typeahead |
| 2553 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
|
2554 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
|
2555 insert({object}, {item} [, {idx}]) List insert {item} in {object} [before {idx}] |
|
18699
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
2556 interrupt() none interrupt script execution |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2557 invert({expr}) Number bitwise invert |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2558 isdirectory({directory}) Number |TRUE| if {directory} is a directory |
|
16213
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
2559 isinf({expr}) Number determine if {expr} is infinity value |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
2560 (positive or negative) |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2561 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
|
2562 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
|
2563 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
|
2564 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
|
2565 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
|
2566 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
|
2567 job_start({command} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2568 Job start a job |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2569 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
|
2570 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
|
2571 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
|
2572 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
|
2573 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
|
2574 json_decode({string}) any decode JSON |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2575 json_encode({expr}) String encode JSON |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2576 keys({dict}) List keys in {dict} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2577 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
|
2578 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
|
2579 libcallnr({lib}, {func}, {arg}) Number idem, but return a Number |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
2580 line({expr} [, {winid}]) Number line nr of cursor, last line or mark |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2581 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
|
2582 lispindent({lnum}) Number Lisp indent for line {lnum} |
|
16235
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
2583 list2str({list} [, {utf8}]) String turn numbers in {list} into a String |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
2584 listener_add({callback} [, {buf}]) |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
2585 Number add a callback to listen to changes |
|
16660
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
2586 listener_flush([{buf}]) none invoke listener callbacks |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
2587 listener_remove({id}) none remove a listener callback |
| 7 | 2588 localtime() Number current time |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2589 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
|
2590 log10({expr}) Float logarithm of Float {expr} to base 10 |
| 12785 | 2591 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
|
2592 map({expr1}, {expr2}) List/Dict change each item in {expr1} to {expr} |
| 12785 | 2593 maparg({name} [, {mode} [, {abbr} [, {dict}]]]) |
| 3224 | 2594 String or Dict |
| 2595 rhs of mapping {name} in mode {mode} | |
| 12785 | 2596 mapcheck({name} [, {mode} [, {abbr}]]) |
| 782 | 2597 String check for mappings matching {name} |
|
20522
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
2598 mapset({mode}, {abbr}, {dict}) |
|
20506
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
2599 none restore mapping from |maparg()| result |
| 12785 | 2600 match({expr}, {pat} [, {start} [, {count}]]) |
| 7 | 2601 Number position where {pat} matches in {expr} |
| 12785 | 2602 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]]) |
| 1326 | 2603 Number highlight {pattern} with {group} |
| 12785 | 2604 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]]) |
| 5979 | 2605 Number highlight positions with {group} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2606 matcharg({nr}) List arguments of |:match| |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
2607 matchdelete({id} [, {win}]) Number delete match identified by {id} |
| 12785 | 2608 matchend({expr}, {pat} [, {start} [, {count}]]) |
| 7 | 2609 Number position where {pat} ends in {expr} |
| 12785 | 2610 matchlist({expr}, {pat} [, {start} [, {count}]]) |
| 158 | 2611 List match and submatches of {pat} in {expr} |
| 12785 | 2612 matchstr({expr}, {pat} [, {start} [, {count}]]) |
| 19 | 2613 String {count}'th match of {pat} in {expr} |
| 12785 | 2614 matchstrpos({expr}, {pat} [, {start} [, {count}]]) |
|
8793
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
2615 List {count}'th match of {pat} in {expr} |
| 10734 | 2616 max({expr}) Number maximum value of items in {expr} |
|
19657
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
2617 menu_info({name} [, {mode}]) Dict get menu item information |
| 10734 | 2618 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
|
2619 mkdir({name} [, {path} [, {prot}]]) |
| 168 | 2620 Number create directory {name} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2621 mode([expr]) String current editing mode |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2622 mzeval({expr}) any evaluate |MzScheme| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2623 nextnonblank({lnum}) Number line nr of non-blank line >= {lnum} |
| 12785 | 2624 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
|
2625 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
|
2626 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
|
2627 perleval({expr}) any evaluate |Perl| expression |
|
17257
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2628 popup_atcursor({what}, {options}) Number create popup window near the cursor |
| 18130 | 2629 popup_beval({what}, {options}) Number create popup window for 'ballooneval' |
|
17257
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2630 popup_clear() none close all popup windows |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2631 popup_close({id} [, {result}]) none close popup window {id} |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2632 popup_create({what}, {options}) Number create a popup window |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2633 popup_dialog({what}, {options}) Number create a popup window used as a dialog |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2634 popup_filter_menu({id}, {key}) Number filter for a menu popup window |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2635 popup_filter_yesno({id}, {key}) Number filter for a dialog popup window |
|
17825
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
2636 popup_findinfo() Number get window ID of info popup window |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
2637 popup_findpreview() Number get window ID of preview popup window |
|
17257
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2638 popup_getoptions({id}) Dict get options of popup window {id} |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2639 popup_getpos({id}) Dict get position of popup window {id} |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2640 popup_hide({id}) none hide popup menu {id} |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2641 popup_list() List get a list of window IDs of all popups |
|
20386
3b3589275ab9
patch 8.2.0748: cannot get a list of all popups
Bram Moolenaar <Bram@vim.org>
parents:
20241
diff
changeset
|
2642 popup_locate({row}, {col}) Number get window ID of popup at position |
|
17257
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2643 popup_menu({what}, {options}) Number create a popup window used as a menu |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2644 popup_move({id}, {options}) none set position of popup window {id} |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2645 popup_notification({what}, {options}) |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2646 Number create a notification popup window |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2647 popup_setoptions({id}, {options}) |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2648 none set options for popup window {id} |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2649 popup_settext({id}, {text}) none set the text of popup window {id} |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2650 popup_show({id}) none unhide popup window {id} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2651 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
|
2652 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
|
2653 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
|
2654 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
|
2655 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
|
2656 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
|
2657 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
|
2658 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
|
2659 none remove all text properties |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2660 prop_find({props} [, {direction}]) |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2661 Dict search for a text property |
| 20241 | 2662 prop_list({lnum} [, {props}]) List text properties in {lnum} |
| 15281 | 2663 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
|
2664 Number remove a text property |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2665 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
|
2666 prop_type_change({name}, {props}) |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2667 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
|
2668 prop_type_delete({name} [, {props}]) |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2669 none delete a property type |
| 20241 | 2670 prop_type_get([{name} [, {props}]]) |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2671 Dict get property type values |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2672 prop_type_list([{props}]) List get list of property types |
|
17756
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
2673 pum_getpos() Dict position and size of pum if visible |
| 1621 | 2674 pumvisible() Number whether popup menu is visible |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2675 py3eval({expr}) any evaluate |python3| expression |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2676 pyeval({expr}) any evaluate |Python| expression |
|
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
2677 pyxeval({expr}) any evaluate |python_x| expression |
|
18701
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
2678 rand([{expr}]) Number get pseudo-random number |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2679 range({expr} [, {max} [, {stride}]]) |
| 99 | 2680 List items from {expr} to {max} |
| 16267 | 2681 readdir({dir} [, {expr}]) List file names in {dir} selected by {expr} |
|
20643
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
2682 readdirex({dir} [, {expr}]) List file info in {dir} selected by {expr} |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2683 readfile({fname} [, {type} [, {max}]]) |
| 168 | 2684 List get list of lines from file {fname} |
|
20649
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
2685 reduce({object}, {func} [, {initial}]) |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
2686 any reduce {object} using {func} |
|
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
|
2687 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
|
2688 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
|
2689 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
|
2690 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
|
2691 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
|
2692 remote_expr({server}, {string} [, {idvar} [, {timeout}]]) |
| 7 | 2693 String send expression |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2694 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
|
2695 remote_peek({serverid} [, {retvar}]) |
| 7 | 2696 Number check for reply string |
|
11229
146a1e213b60
Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents:
11225
diff
changeset
|
2697 remote_read({serverid} [, {timeout}]) |
|
146a1e213b60
Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents:
11225
diff
changeset
|
2698 String read reply string |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2699 remote_send({server}, {string} [, {idvar}]) |
| 7 | 2700 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
|
2701 remote_startserver({name}) none become server {name} |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
2702 remove({list}, {idx} [, {end}]) any/List |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
2703 remove items {idx}-{end} from {list} |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
2704 remove({blob}, {idx} [, {end}]) Number/Blob |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
2705 remove bytes {idx}-{end} from {blob} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2706 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
|
2707 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
|
2708 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
|
2709 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
|
2710 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
|
2711 round({expr}) Float round off {expr} |
|
16103
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
2712 rubyeval({expr}) any evaluate |Ruby| expression |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2713 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
|
2714 screenchar({row}, {col}) Number character at screen position |
|
16133
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
2715 screenchars({row}, {col}) List List of characters at screen position |
| 3986 | 2716 screencol() Number current cursor column |
|
17292
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
2717 screenpos({winid}, {lnum}, {col}) Dict screen row and col of a text character |
| 3986 | 2718 screenrow() Number current cursor row |
|
16133
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
2719 screenstring({row}, {col}) String characters at screen position |
|
20725
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
2720 search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]]) |
| 1496 | 2721 Number search for {pattern} |
|
20647
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
2722 searchcount([{options}]) Dict get or update search stats |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2723 searchdecl({name} [, {global} [, {thisblock}]]) |
| 1621 | 2724 Number search for variable declaration |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2725 searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 55 | 2726 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
|
2727 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 667 | 2728 List search for other end of start/end pair |
|
20725
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
2729 searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]]) |
| 667 | 2730 List search for {pattern} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2731 server2client({clientid}, {string}) |
| 7 | 2732 Number send reply string |
| 2733 serverlist() String get a list of available servers | |
| 14864 | 2734 setbufline({expr}, {lnum}, {text}) |
| 2735 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
|
2736 {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2737 setbufvar({expr}, {varname}, {val}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2738 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
|
2739 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
|
2740 setcmdpos({pos}) Number set cursor position in command-line |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
2741 setenv({name}, {val}) none set environment variable |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2742 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
|
2743 setline({lnum}, {line}) Number set line {lnum} to {line} |
| 12785 | 2744 setloclist({nr}, {list} [, {action} [, {what}]]) |
| 647 | 2745 Number modify location list using {list} |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
2746 setmatches({list} [, {win}]) Number restore a list of matches |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2747 setpos({expr}, {list}) Number set the {expr} position to {list} |
| 12785 | 2748 setqflist({list} [, {action} [, {what}]]) |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
2749 Number modify quickfix list using {list} |
| 12785 | 2750 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
|
2751 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
|
2752 settabwinvar({tabnr}, {winnr}, {varname}, {val}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2753 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
|
2754 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
|
2755 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
|
2756 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
|
2757 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
|
2758 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
|
2759 shellescape({string} [, {special}]) |
| 1661 | 2760 String escape {string} for use as shell |
| 985 | 2761 command argument |
|
15062
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
15033
diff
changeset
|
2762 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
|
2763 sign_define({name} [, {dict}]) Number define or update a sign |
|
17366
9843fbfa0ee5
patch 8.1.1682: placing a larger number of signs is slow
Bram Moolenaar <Bram@vim.org>
parents:
17292
diff
changeset
|
2764 sign_define({list}) List define or update a list of signs |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2765 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
|
2766 sign_getplaced([{expr} [, {dict}]]) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2767 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
|
2768 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
|
2769 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
|
2770 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
|
2771 Number place a sign |
|
17366
9843fbfa0ee5
patch 8.1.1682: placing a larger number of signs is slow
Bram Moolenaar <Bram@vim.org>
parents:
17292
diff
changeset
|
2772 sign_placelist({list}) List place a list of signs |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2773 sign_undefine([{name}]) Number undefine a sign |
|
17366
9843fbfa0ee5
patch 8.1.1682: placing a larger number of signs is slow
Bram Moolenaar <Bram@vim.org>
parents:
17292
diff
changeset
|
2774 sign_undefine({list}) List undefine a list of signs |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2775 sign_unplace({group} [, {dict}]) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2776 Number unplace a sign |
|
17366
9843fbfa0ee5
patch 8.1.1682: placing a larger number of signs is slow
Bram Moolenaar <Bram@vim.org>
parents:
17292
diff
changeset
|
2777 sign_unplacelist({list}) List unplace a list of signs |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2778 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
|
2779 sin({expr}) Float sine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2780 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
|
2781 sort({list} [, {func} [, {dict}]]) |
| 2902 | 2782 List sort {list}, using {func} to compare |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
2783 sound_clear() none stop playing all sounds |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
2784 sound_playevent({name} [, {callback}]) |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
2785 Number play an event sound |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
2786 sound_playfile({path} [, {callback}]) |
|
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
2787 Number play sound file {path} |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
2788 sound_stop({id}) none stop playing sound {id} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2789 soundfold({word}) String sound-fold {word} |
| 344 | 2790 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
|
2791 spellsuggest({word} [, {max} [, {capital}]]) |
| 537 | 2792 List spelling suggestions |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2793 split({expr} [, {pat} [, {keepempty}]]) |
| 685 | 2794 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
|
2795 sqrt({expr}) Float square root of {expr} |
|
18701
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
2796 srand([{expr}]) List get seed for |rand()| |
|
18104
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
2797 state([{what}]) String current state of Vim |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2798 str2float({expr}) Float convert String to Float |
|
16235
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
2799 str2list({expr} [, {utf8}]) List convert each character of {expr} to |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
2800 ASCII/UTF8 value |
|
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2801 str2nr({expr} [, {base} [, {quoted}]]) |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2802 Number convert String to Number |
| 12785 | 2803 strcharpart({str}, {start} [, {len}]) |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2804 String {len} characters of {str} at {start} |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2805 strchars({expr} [, {skipcc}]) Number character length of the String {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2806 strdisplaywidth({expr} [, {col}]) Number display length of the String {expr} |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
2807 strftime({format} [, {time}]) String format time with a specified format |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2808 strgetchar({str}, {index}) Number get char {index} from {str} |
| 12785 | 2809 stridx({haystack}, {needle} [, {start}]) |
| 133 | 2810 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
|
2811 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
|
2812 strlen({expr}) Number length of the String {expr} |
| 12785 | 2813 strpart({str}, {start} [, {len}]) |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2814 String {len} characters of {str} at {start} |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
2815 strptime({format}, {timestring}) |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
2816 Number Convert {timestring} to unix timestamp |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2817 strridx({haystack}, {needle} [, {start}]) |
| 140 | 2818 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
|
2819 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
|
2820 strwidth({expr}) Number display cell length of the String {expr} |
| 12785 | 2821 submatch({nr} [, {list}]) String or List |
| 5794 | 2822 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
|
2823 substitute({expr}, {pat}, {sub}, {flags}) |
| 7 | 2824 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
|
2825 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
|
2826 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
|
2827 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
|
2828 synIDattr({synID}, {what} [, {mode}]) |
| 7 | 2829 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
|
2830 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
|
2831 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
|
2832 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
|
2833 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
|
2834 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
|
2835 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
|
2836 tabpagenr([{arg}]) Number number of current or last tab page |
| 12785 | 2837 tabpagewinnr({tabarg} [, {arg}]) Number number of current window in tab page |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2838 tagfiles() List tags files used |
| 12785 | 2839 taglist({expr} [, {filename}]) List list of tags matching {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2840 tan({expr}) Float tangent of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2841 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
|
2842 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
|
2843 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
|
2844 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
|
2845 term_dumpload({filename} [, {options}]) |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2846 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
|
2847 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
|
2848 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
|
2849 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
|
2850 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
|
2851 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
|
2852 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
|
2853 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
|
2854 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
|
2855 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
|
2856 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
|
2857 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
|
2858 term_gettitle({buf}) String get the title of a terminal |
| 12785 | 2859 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
|
2860 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
|
2861 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
|
2862 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
|
2863 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
|
2864 none set ANSI palette in GUI color mode |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2865 term_setapi({buf}, {expr}) none set |terminal-api| function name prefix |
| 13735 | 2866 term_setkill({buf}, {how}) none set signal to stop job in terminal |
| 13437 | 2867 term_setrestore({buf}, {command}) none set command to restore terminal |
| 13735 | 2868 term_setsize({buf}, {rows}, {cols}) |
| 2869 none set the size of a terminal | |
| 16380 | 2870 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
|
2871 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
|
2872 test_alloc_fail({id}, {countdown}, {repeat}) |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
2873 none make memory allocation fail |
|
9644
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
2874 test_autochdir() none enable 'autochdir' during startup |
| 14864 | 2875 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
|
2876 test_garbagecollect_now() none free memory right now for testing |
|
17159
3fd0765f454f
patch 8.1.1579: dict and list could be GC'ed while displaying error
Bram Moolenaar <Bram@vim.org>
parents:
17131
diff
changeset
|
2877 test_garbagecollect_soon() none free memory soon for testing |
|
16664
ca1814eeecf5
patch 8.1.1334: when buffer is hidden "F" in 'shortmess' is not used
Bram Moolenaar <Bram@vim.org>
parents:
16660
diff
changeset
|
2878 test_getvalue({string}) any get value of an internal variable |
|
11006
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
2879 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
|
2880 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
|
2881 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
|
2882 test_null_dict() Dict null value for testing |
|
19874
f92435f0f449
patch 8.2.0493: Vim9: some error messages not tested
Bram Moolenaar <Bram@vim.org>
parents:
19870
diff
changeset
|
2883 test_null_function() Funcref null value for testing |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
2884 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
|
2885 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
|
2886 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
|
2887 test_null_string() String null value for testing |
| 14945 | 2888 test_option_not_set({name}) none reset flag indicating option was set |
| 2889 test_override({expr}, {val}) none test with Vim internal overrides | |
|
16078
d13aa9c5a1d1
patch 8.1.1044: no way to check the reference count of objects
Bram Moolenaar <Bram@vim.org>
parents:
16019
diff
changeset
|
2890 test_refcount({expr}) Number get the reference count of {expr} |
|
14756
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
2891 test_scrollbar({which}, {value}, {dragging}) |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
2892 none scroll in the GUI for testing |
|
16517
9484fc00ac6b
patch 8.1.1262: cannot simulate a mouse click in a test
Bram Moolenaar <Bram@vim.org>
parents:
16489
diff
changeset
|
2893 test_setmouse({row}, {col}) none set the mouse position for testing |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2894 test_settime({expr}) none set current time for testing |
|
19350
76cb39bf1871
patch 8.2.0233: crash when using garbagecollect() in between rand()
Bram Moolenaar <Bram@vim.org>
parents:
19308
diff
changeset
|
2895 test_srand_seed([seed]) none set seed for testing srand() |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2896 test_unknown() any unknown value for testing |
|
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2897 test_void() any void value for testing |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
2898 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
|
2899 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
|
2900 timer_start({time}, {callback} [, {options}]) |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
2901 Number create a timer |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2902 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
|
2903 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
|
2904 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
|
2905 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
|
2906 tr({src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
| 15 | 2907 to chars in {tostr} |
|
20629
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
2908 trim({text} [, {mask} [, {dir}]]) |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
2909 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
|
2910 trunc({expr}) Float truncate Float {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2911 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
|
2912 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
|
2913 undotree() List undo file tree |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2914 uniq({list} [, {func} [, {dict}]]) |
| 5747 | 2915 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
|
2916 values({dict}) List values in {dict} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2917 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
|
2918 visualmode([expr]) String last visual mode used |
| 4151 | 2919 wildmenumode() Number whether 'wildmenu' mode is active |
|
16833
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
2920 win_execute({id}, {command} [, {silent}]) |
|
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
2921 String execute {command} in window {id} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2922 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
|
2923 win_getid([{win} [, {tab}]]) Number get window ID for {win} in {tab} |
| 20115 | 2924 win_gettype([{nr}]) String type of window {nr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2925 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
|
2926 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
|
2927 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
|
2928 win_screenpos({nr}) List get screen position of window {nr} |
|
18049
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
2929 win_splitmove({nr}, {target} [, {options}]) |
| 18343 | 2930 Number move window {nr} to split of {target} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2931 winbufnr({nr}) Number buffer number of window {nr} |
| 7 | 2932 wincol() Number window column of the cursor |
| 20552 | 2933 windowsversion() String MS-Windows OS version |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2934 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
|
2935 winlayout([{tabnr}]) List layout of windows in tab {tabnr} |
| 7 | 2936 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
|
2937 winnr([{expr}]) Number number of current window |
| 55 | 2938 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
|
2939 winrestview({dict}) none restore view of current window |
| 712 | 2940 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
|
2941 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
|
2942 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
|
2943 writefile({object}, {fname} [, {flags}]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2944 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
|
2945 xor({expr}, {expr}) Number bitwise XOR |
| 7 | 2946 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
2947 |
| 1621 | 2948 abs({expr}) *abs()* |
| 2949 Return the absolute value of {expr}. When {expr} evaluates to | |
| 2950 a |Float| abs() returns a |Float|. When {expr} can be | |
| 2951 converted to a |Number| abs() returns a |Number|. Otherwise | |
| 2952 abs() gives an error message and returns -1. | |
| 2953 Examples: > | |
| 2954 echo abs(1.456) | |
| 2955 < 1.456 > | |
| 2956 echo abs(-5.456) | |
| 2957 < 5.456 > | |
| 2958 echo abs(-4) | |
| 2959 < 4 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
2960 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
2961 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
2962 Compute()->abs() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
2963 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
2964 < {only available when compiled with the |+float| feature} |
| 1621 | 2965 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2966 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2967 acos({expr}) *acos()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2968 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
|
2969 |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
|
2970 {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
|
2971 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2972 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2973 :echo acos(0) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2974 < 1.570796 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2975 :echo acos(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2976 < 2.094395 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
2977 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
2978 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
2979 Compute()->acos() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
2980 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
2981 < {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2982 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2983 |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
2984 add({object}, {expr}) *add()* |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
2985 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
|
2986 the resulting |List| or |Blob|. Examples: > |
| 82 | 2987 :let alist = add([1, 2, 3], item) |
| 2988 :call add(mylist, "woodstock") | |
| 685 | 2989 < Note that when {expr} is a |List| it is appended as a single |
| 692 | 2990 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
|
2991 When {object} is a |Blob| then {expr} must be a number. |
| 85 | 2992 Use |insert()| to add an item at another position. |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
2993 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
2994 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
2995 mylist->add(val1)->add(val2) |
| 55 | 2996 |
| 82 | 2997 |
| 3214 | 2998 and({expr}, {expr}) *and()* |
| 2999 Bitwise AND on the two arguments. The arguments are converted | |
| 3000 to a number. A List, Dict or Float argument causes an error. | |
| 3001 Example: > | |
| 3002 :let flag = and(bits, 0x80) | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3003 < Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3004 :let flag = bits->and(0x80) |
| 3214 | 3005 |
| 3006 | |
| 14864 | 3007 append({lnum}, {text}) *append()* |
| 3008 When {text} is a |List|: Append each item of the |List| as a | |
| 685 | 3009 text line below line {lnum} in the current buffer. |
| 14864 | 3010 Otherwise append {text} as one text line below line {lnum} in |
| 153 | 3011 the current buffer. |
| 3012 {lnum} can be zero to insert a line before the first one. | |
| 82 | 3013 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
|
3014 0 for success. Example: > |
| 55 | 3015 :let failed = append(line('$'), "# THE END") |
| 82 | 3016 :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
|
3017 |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3018 < Can also be used as a |method| after a List: > |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3019 mylist->append(lnum) |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3020 |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3021 |
|
14039
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3022 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
|
3023 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
|
3024 |
| 18343 | 3025 This function works only for loaded buffers. First call |
| 3026 |bufload()| if needed. | |
| 3027 | |
|
14039
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3028 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
|
3029 |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3030 {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
|
3031 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
|
3032 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
|
3033 |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3034 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
|
3035 |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3036 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
|
3037 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
|
3038 :let failed = appendbufline(13, 0, "# THE START") |
| 55 | 3039 < |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3040 Can also be used as a |method| after a List: > |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3041 mylist->appendbufline(buf, lnum) |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3042 |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3043 |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3044 argc([{winid}]) *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
|
3045 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
|
3046 |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
|
3047 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
|
3048 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
|
3049 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
|
3050 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
|
3051 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
|
3052 Returns -1 if the {winid} argument is invalid. |
| 7 | 3053 |
| 3054 *argidx()* | |
| 3055 argidx() The result is the current index in the argument list. 0 is | |
| 3056 the first file. argc() - 1 is the last one. See |arglist|. | |
| 3057 | |
| 5942 | 3058 *arglistid()* |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3059 arglistid([{winnr} [, {tabnr}]]) |
| 5942 | 3060 Return the argument list ID. This is a number which |
| 3061 identifies the argument list being used. Zero is used for the | |
| 6153 | 3062 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
|
3063 Returns -1 if the arguments are invalid. |
| 5942 | 3064 |
| 3065 Without arguments use the current window. | |
| 3066 With {winnr} only use this window in the current tab page. | |
| 3067 With {winnr} and {tabnr} use the window in the specified tab | |
| 3068 page. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
3069 {winnr} can be the window number or the |window-ID|. |
| 5942 | 3070 |
| 7 | 3071 *argv()* |
| 20241 | 3072 argv([{nr} [, {winid}]]) |
|
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
|
3073 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
|
3074 |arglist|. "argv(0)" is the first one. Example: > |
| 7 | 3075 :let i = 0 |
| 3076 :while i < argc() | |
| 1621 | 3077 : let f = escape(fnameescape(argv(i)), '.') |
| 7 | 3078 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
| 3079 : let i = i + 1 | |
| 3080 :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
|
3081 < 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
|
3082 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
|
3083 |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3084 The {winid} argument specifies the window ID, see |argc()|. |
|
18477
e93cab5d0f0f
patch 8.1.2233: cannot get the Vim command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
3085 For the Vim command line arguments see |v:argv|. |
| 818 | 3086 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3087 asin({expr}) *asin()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3088 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
|
3089 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
|
3090 {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
|
3091 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3092 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3093 :echo asin(0.8) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3094 < 0.927295 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3095 :echo asin(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3096 < -0.523599 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3097 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3098 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3099 Compute()->asin() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3100 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
3101 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3102 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3103 |
| 19099 | 3104 assert_ functions are documented here: |assert-functions-details| |
| 3105 | |
| 3106 | |
| 3107 | |
| 1621 | 3108 atan({expr}) *atan()* |
| 3109 Return the principal value of the arc tangent of {expr}, in | |
| 3110 the range [-pi/2, +pi/2] radians, as a |Float|. | |
| 3111 {expr} must evaluate to a |Float| or a |Number|. | |
| 3112 Examples: > | |
| 3113 :echo atan(100) | |
| 3114 < 1.560797 > | |
| 3115 :echo atan(-4.01) | |
| 3116 < -1.326405 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3117 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3118 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3119 Compute()->atan() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3120 < |
| 1621 | 3121 {only available when compiled with the |+float| feature} |
| 3122 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3123 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3124 atan2({expr1}, {expr2}) *atan2()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3125 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
|
3126 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
|
3127 {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
|
3128 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3129 :echo atan2(-1, 1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3130 < -0.785398 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3131 :echo atan2(1, -1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3132 < 2.356194 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3133 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3134 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3135 Compute()->atan(1) |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3136 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
3137 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3138 |
|
16600
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
3139 balloon_gettext() *balloon_gettext()* |
|
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
3140 Return the current text in the balloon. Only for the string, |
|
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
3141 not used for the List. |
|
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
3142 |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
3143 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
|
3144 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
|
3145 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
|
3146 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
|
3147 split with |balloon_split()|. |
|
16600
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
3148 If {expr} is an empty string any existing balloon is removed. |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
3149 |
| 11062 | 3150 Example: > |
|
11014
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3151 func GetBalloonContent() |
|
16600
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
3152 " ... initiate getting the content |
|
11014
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3153 return '' |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3154 endfunc |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3155 set balloonexpr=GetBalloonContent() |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3156 |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3157 func BalloonCallback(result) |
| 11062 | 3158 call balloon_show(a:result) |
|
11014
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3159 endfunc |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3160 < Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3161 GetText()->balloon_show() |
|
11014
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3162 < |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3163 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
|
3164 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
|
3165 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
|
3166 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
|
3167 empty string or a placeholder. |
| 11062 | 3168 |
| 3169 When showing a balloon is not possible nothing happens, no | |
| 3170 error message. | |
| 14864 | 3171 {only available when compiled with the |+balloon_eval| or |
| 3172 |+balloon_eval_term| feature} | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3173 |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
3174 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
|
3175 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
|
3176 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
|
3177 show debugger output. |
|
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
3178 Returns a |List| with the split lines. |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3179 Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3180 GetText()->balloon_split()->balloon_show() |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3181 |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3182 < {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
|
3183 feature} |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
3184 |
| 7 | 3185 *browse()* |
| 3186 browse({save}, {title}, {initdir}, {default}) | |
| 3187 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
|
3188 returns |TRUE| (only in some GUI versions). |
| 7 | 3189 The input fields are: |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3190 {save} when |TRUE|, select file to write |
| 7 | 3191 {title} title for the requester |
| 3192 {initdir} directory to start browsing in | |
| 3193 {default} default file name | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3194 An empty string is returned when the "Cancel" button is hit, |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3195 something went wrong, or browsing is not possible. |
| 7 | 3196 |
| 29 | 3197 *browsedir()* |
| 3198 browsedir({title}, {initdir}) | |
| 3199 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
|
3200 "has("browse")" returns |TRUE| (only in some GUI versions). |
| 29 | 3201 On systems where a directory browser is not supported a file |
| 3202 browser is used. In that case: select a file in the directory | |
| 3203 to be used. | |
| 3204 The input fields are: | |
| 3205 {title} title for the requester | |
| 3206 {initdir} directory to start browsing in | |
| 3207 When the "Cancel" button is hit, something went wrong, or | |
| 3208 browsing is not possible, an empty string is returned. | |
| 3209 | |
|
17221
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3210 bufadd({name}) *bufadd()* |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3211 Add a buffer to the buffer list with {name}. |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3212 If a buffer for file {name} already exists, return that buffer |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3213 number. Otherwise return the buffer number of the newly |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3214 created buffer. When {name} is an empty string then a new |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3215 buffer is always created. |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
3216 The buffer will not have 'buflisted' set and not be loaded |
|
17253
26e0352613ec
patch 8.1.1626: no test for closing a popup window with a modified buffer
Bram Moolenaar <Bram@vim.org>
parents:
17221
diff
changeset
|
3217 yet. To add some text to the buffer use this: > |
|
26e0352613ec
patch 8.1.1626: no test for closing a popup window with a modified buffer
Bram Moolenaar <Bram@vim.org>
parents:
17221
diff
changeset
|
3218 let bufnr = bufadd('someName') |
|
26e0352613ec
patch 8.1.1626: no test for closing a popup window with a modified buffer
Bram Moolenaar <Bram@vim.org>
parents:
17221
diff
changeset
|
3219 call bufload(bufnr) |
|
26e0352613ec
patch 8.1.1626: no test for closing a popup window with a modified buffer
Bram Moolenaar <Bram@vim.org>
parents:
17221
diff
changeset
|
3220 call setbufline(bufnr, 1, ['some', 'text']) |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3221 < Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3222 let bufnr = 'somename'->bufadd() |
|
17221
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3223 |
| 7 | 3224 bufexists({expr}) *bufexists()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3225 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 3226 {expr} exists. |
| 9 | 3227 If the {expr} argument is a number, buffer numbers are used. |
| 12909 | 3228 Number zero is the alternate buffer for the current window. |
| 3229 | |
| 7 | 3230 If the {expr} argument is a string it must match a buffer name |
| 9 | 3231 exactly. The name can be: |
| 3232 - Relative to the current directory. | |
| 3233 - A full path. | |
| 1621 | 3234 - The name of a buffer with 'buftype' set to "nofile". |
| 9 | 3235 - A URL name. |
| 7 | 3236 Unlisted buffers will be found. |
| 3237 Note that help files are listed by their short name in the | |
| 3238 output of |:buffers|, but bufexists() requires using their | |
| 3239 long name to be able to find them. | |
| 1621 | 3240 bufexists() may report a buffer exists, but to use the name |
| 3241 with a |:buffer| command you may need to use |expand()|. Esp | |
| 3242 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
| 7 | 3243 Use "bufexists(0)" to test for the existence of an alternate |
| 3244 file name. | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3245 |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3246 Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3247 let exists = 'somename'->bufexists() |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3248 < |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3249 Obsolete name: buffer_exists(). *buffer_exists()* |
| 7 | 3250 |
| 3251 buflisted({expr}) *buflisted()* | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3252 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 3253 {expr} exists and is listed (has the 'buflisted' option set). |
| 9 | 3254 The {expr} argument is used like with |bufexists()|. |
| 7 | 3255 |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3256 Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3257 let listed = 'somename'->buflisted() |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3258 |
|
17221
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3259 bufload({expr}) *bufload()* |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3260 Ensure the buffer {expr} is loaded. When the buffer name |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3261 refers to an existing file then the file is read. Otherwise |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3262 the buffer will be empty. If the buffer was already loaded |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3263 then there is no change. |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3264 If there is an existing swap file for the file of the buffer, |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3265 there will be no dialog, the buffer will be loaded anyway. |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3266 The {expr} argument is used like with |bufexists()|. |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3267 |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3268 Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3269 eval 'somename'->bufload() |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3270 |
| 7 | 3271 bufloaded({expr}) *bufloaded()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3272 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 3273 {expr} exists and is loaded (shown in a window or hidden). |
| 9 | 3274 The {expr} argument is used like with |bufexists()|. |
| 7 | 3275 |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3276 Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3277 let loaded = 'somename'->bufloaded() |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3278 |
|
17855
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
3279 bufname([{expr}]) *bufname()* |
| 7 | 3280 The result is the name of a buffer, as it is displayed by the |
| 3281 ":ls" command. | |
|
17855
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
3282 If {expr} is omitted the current buffer is used. |
| 7 | 3283 If {expr} is a Number, that buffer number's name is given. |
| 3284 Number zero is the alternate buffer for the current window. | |
| 3285 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
|
3286 with the buffer names. This is always done like 'magic' is |
| 7 | 3287 set and 'cpoptions' is empty. When there is more than one |
| 3288 match an empty string is returned. | |
| 3289 "" or "%" can be used for the current buffer, "#" for the | |
| 3290 alternate buffer. | |
| 3291 A full match is preferred, otherwise a match at the start, end | |
| 1156 | 3292 or middle of the buffer name is accepted. If you only want a |
| 3293 full match then put "^" at the start and "$" at the end of the | |
| 3294 pattern. | |
| 7 | 3295 Listed buffers are found first. If there is a single match |
| 3296 with a listed buffer, that one is returned. Next unlisted | |
| 3297 buffers are searched for. | |
| 3298 If the {expr} is a String, but you want to use it as a buffer | |
| 3299 number, force it to be a Number by adding zero to it: > | |
| 3300 :echo bufname("3" + 0) | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3301 < Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3302 echo bufnr->bufname() |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3303 |
| 7 | 3304 < If the buffer doesn't exist, or doesn't have a name, an empty |
| 3305 string is returned. > | |
| 3306 bufname("#") alternate buffer name | |
| 3307 bufname(3) name of buffer 3 | |
| 3308 bufname("%") name of current buffer | |
| 3309 bufname("file2") name of buffer where "file2" matches. | |
| 3310 < *buffer_name()* | |
| 3311 Obsolete name: buffer_name(). | |
| 3312 | |
| 3313 *bufnr()* | |
|
17855
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
3314 bufnr([{expr} [, {create}]]) |
| 707 | 3315 The result is the number of a buffer, as it is displayed by |
| 7 | 3316 the ":ls" command. For the use of {expr}, see |bufname()| |
| 707 | 3317 above. |
|
18170
4ac8161e92e0
patch 8.1.2080: the terminal API is limited and can't be disabled
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
3318 |
| 707 | 3319 If the buffer doesn't exist, -1 is returned. Or, if the |
| 3320 {create} argument is present and not zero, a new, unlisted, | |
|
18170
4ac8161e92e0
patch 8.1.2080: the terminal API is limited and can't be disabled
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
3321 buffer is created and its number is returned. Example: > |
|
4ac8161e92e0
patch 8.1.2080: the terminal API is limited and can't be disabled
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
3322 let newbuf = bufnr('Scratch001', 1) |
|
4ac8161e92e0
patch 8.1.2080: the terminal API is limited and can't be disabled
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
3323 < Using an empty name uses the current buffer. To create a new |
|
4ac8161e92e0
patch 8.1.2080: the terminal API is limited and can't be disabled
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
3324 buffer with an empty name use |bufadd()|. |
|
4ac8161e92e0
patch 8.1.2080: the terminal API is limited and can't be disabled
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
3325 |
| 7 | 3326 bufnr("$") is the last buffer: > |
|
17855
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
3327 :let last_buffer = bufnr("$") |
| 7 | 3328 < The result is a Number, which is the highest buffer number |
| 3329 of existing buffers. Note that not all buffers with a smaller | |
| 3330 number necessarily exist, because ":bwipeout" may have removed | |
| 3331 them. Use bufexists() to test for the existence of a buffer. | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3332 |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3333 Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3334 echo bufref->bufnr() |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3335 < |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3336 Obsolete name: buffer_number(). *buffer_number()* |
| 7 | 3337 *last_buffer_nr()* |
| 3338 Obsolete name for bufnr("$"): last_buffer_nr(). | |
| 3339 | |
|
9219
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
3340 bufwinid({expr}) *bufwinid()* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
3341 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
|
3342 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
|
3343 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
|
3344 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
|
3345 |
|
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
3346 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
|
3347 < |
|
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
3348 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
|
3349 |
|
17825
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3350 Can also be used as a |method|: > |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3351 FindBuffer()->bufwinid() |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3352 |
| 7 | 3353 bufwinnr({expr}) *bufwinnr()* |
|
17825
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3354 Like |bufwinid()| but return the window number instead of the |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3355 |window-ID|. |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3356 If buffer {expr} doesn't exist or there is no such window, -1 |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3357 is returned. Example: > |
| 7 | 3358 |
| 3359 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
| 3360 | |
| 3361 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
| 3362 |:wincmd|. | |
|
17825
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3363 |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3364 Can also be used as a |method|: > |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3365 FindBuffer()->bufwinnr() |
| 7 | 3366 |
| 3367 byte2line({byte}) *byte2line()* | |
| 3368 Return the line number that contains the character at byte | |
| 3369 count {byte} in the current buffer. This includes the | |
| 3370 end-of-line character, depending on the 'fileformat' option | |
| 3371 for the current buffer. The first character has byte count | |
| 3372 one. | |
| 3373 Also see |line2byte()|, |go| and |:goto|. | |
|
17829
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3374 |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3375 Can also be used as a |method|: > |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3376 GetOffset()->byte2line() |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3377 |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3378 < {not available when compiled without the |+byte_offset| |
| 7 | 3379 feature} |
| 3380 | |
| 18 | 3381 byteidx({expr}, {nr}) *byteidx()* |
| 3382 Return byte index of the {nr}'th character in the string | |
| 3383 {expr}. Use zero for the first character, it returns zero. | |
| 3384 This function is only useful when there are multibyte | |
| 3385 characters, otherwise the returned value is equal to {nr}. | |
| 5413 | 3386 Composing characters are not counted separately, their byte |
| 3387 length is added to the preceding base character. See | |
| 3388 |byteidxcomp()| below for counting composing characters | |
| 3389 separately. | |
| 18 | 3390 Example : > |
| 3391 echo matchstr(str, ".", byteidx(str, 3)) | |
| 3392 < will display the fourth character. Another way to do the | |
| 3393 same: > | |
| 3394 let s = strpart(str, byteidx(str, 3)) | |
| 3395 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
|
3396 < Also see |strgetchar()| and |strcharpart()|. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3397 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3398 If there are less than {nr} characters -1 is returned. |
| 18 | 3399 If there are exactly {nr} characters the length of the string |
| 5413 | 3400 in bytes is returned. |
| 3401 | |
|
17829
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3402 Can also be used as a |method|: > |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3403 GetName()->byteidx(idx) |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3404 |
| 5413 | 3405 byteidxcomp({expr}, {nr}) *byteidxcomp()* |
| 3406 Like byteidx(), except that a composing character is counted | |
| 3407 as a separate character. Example: > | |
| 3408 let s = 'e' . nr2char(0x301) | |
| 3409 echo byteidx(s, 1) | |
| 3410 echo byteidxcomp(s, 1) | |
| 3411 echo byteidxcomp(s, 2) | |
| 3412 < The first and third echo result in 3 ('e' plus composing | |
| 3413 character is 3 bytes), the second echo results in 1 ('e' is | |
| 3414 one byte). | |
| 3415 Only works different from byteidx() when 'encoding' is set to | |
| 3416 a Unicode encoding. | |
| 18 | 3417 |
|
17829
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3418 Can also be used as a |method|: > |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3419 GetName()->byteidxcomp(idx) |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3420 |
| 102 | 3421 call({func}, {arglist} [, {dict}]) *call()* *E699* |
| 685 | 3422 Call function {func} with the items in |List| {arglist} as |
| 79 | 3423 arguments. |
| 685 | 3424 {func} can either be a |Funcref| or the name of a function. |
| 79 | 3425 a:firstline and a:lastline are set to the cursor line. |
| 3426 Returns the return value of the called function. | |
| 102 | 3427 {dict} is for functions with the "dict" attribute. It will be |
| 3428 used to set the local variable "self". |Dictionary-function| | |
| 79 | 3429 |
|
17829
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3430 Can also be used as a |method|: > |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3431 GetFunc()->call([arg, arg], dict) |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3432 |
| 1621 | 3433 ceil({expr}) *ceil()* |
| 3434 Return the smallest integral value greater than or equal to | |
| 3435 {expr} as a |Float| (round up). | |
| 3436 {expr} must evaluate to a |Float| or a |Number|. | |
| 3437 Examples: > | |
| 3438 echo ceil(1.456) | |
| 3439 < 2.0 > | |
| 3440 echo ceil(-5.456) | |
| 3441 < -5.0 > | |
| 3442 echo ceil(4.0) | |
| 3443 < 4.0 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3444 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3445 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3446 Compute()->ceil() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3447 < |
| 1621 | 3448 {only available when compiled with the |+float| feature} |
| 3449 | |
|
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
3450 |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
3451 ch_ functions are documented here: |channel-functions-details| |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
3452 |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
3453 |
| 11062 | 3454 changenr() *changenr()* |
| 3455 Return the number of the most recent change. This is the same | |
| 3456 number as what is displayed with |:undolist| and can be used | |
| 3457 with the |:undo| command. | |
| 3458 When a change was made it is the number of that change. After | |
| 3459 redo it is the number of the redone change. After undo it is | |
| 3460 one less than the number of the undone change. | |
| 3461 | |
| 12785 | 3462 char2nr({expr} [, {utf8}]) *char2nr()* |
| 11062 | 3463 Return number value of the first char in {expr}. Examples: > |
| 3464 char2nr(" ") returns 32 | |
| 3465 char2nr("ABC") returns 65 | |
| 3466 < When {utf8} is omitted or zero, the current 'encoding' is used. | |
| 3467 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
|
3468 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
|
3469 char2nr("á"[0]) returns 195 |
| 11062 | 3470 < With {utf8} set to 1, always treat as utf-8 characters. |
| 3471 A combining character is a separate character. | |
| 3472 |nr2char()| does the opposite. | |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3473 To turn a string into a list of character numbers: > |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3474 let str = "ABC" |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3475 let list = map(split(str, '\zs'), {_, val -> char2nr(val)}) |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3476 < Result: [65, 66, 67] |
| 11062 | 3477 |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3478 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3479 GetChar()->char2nr() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3480 |
|
16576
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3481 chdir({dir}) *chdir()* |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3482 Change the current working directory to {dir}. The scope of |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3483 the directory change depends on the directory of the current |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3484 window: |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3485 - If the current window has a window-local directory |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3486 (|:lcd|), then changes the window local directory. |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3487 - Otherwise, if the current tabpage has a local |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3488 directory (|:tcd|) then changes the tabpage local |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3489 directory. |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3490 - Otherwise, changes the global directory. |
| 19303 | 3491 {dir} must be a String. |
|
16576
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3492 If successful, returns the previous working directory. Pass |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3493 this to another chdir() to restore the directory. |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3494 On failure, returns an empty string. |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3495 |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3496 Example: > |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3497 let save_dir = chdir(newdir) |
| 16808 | 3498 if save_dir != "" |
|
16576
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3499 " ... do some work |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3500 call chdir(save_dir) |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3501 endif |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3502 |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3503 < Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3504 GetDir()->chdir() |
|
16576
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3505 < |
| 11062 | 3506 cindent({lnum}) *cindent()* |
| 3507 Get the amount of indent for line {lnum} according the C | |
| 3508 indenting rules, as with 'cindent'. | |
| 3509 The indent is counted in spaces, the value of 'tabstop' is | |
| 3510 relevant. {lnum} is used just like in |getline()|. | |
| 3511 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
| 3512 feature, -1 is returned. | |
| 3513 See |C-indenting|. | |
| 3514 | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3515 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3516 GetLnum()->cindent() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3517 |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3518 clearmatches([{win}]) *clearmatches()* |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3519 Clears all matches previously defined for the current window |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3520 by |matchadd()| and the |:match| commands. |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3521 If {win} is specified, use the window with this number or |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3522 window ID instead of the current window. |
| 11062 | 3523 |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3524 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3525 GetWin()->clearmatches() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3526 < |
| 11062 | 3527 *col()* |
| 3528 col({expr}) The result is a Number, which is the byte index of the column | |
| 3529 position given with {expr}. The accepted positions are: | |
| 3530 . the cursor position | |
| 3531 $ the end of the cursor line (the result is the | |
| 3532 number of bytes in the cursor line plus one) | |
| 3533 'x position of mark x (if the mark is not set, 0 is | |
| 3534 returned) | |
| 3535 v In Visual mode: the start of the Visual area (the | |
| 3536 cursor is the end). When not in Visual mode | |
| 3537 returns the cursor position. Differs from |'<| in | |
| 3538 that it's updated right away. | |
| 3539 Additionally {expr} can be [lnum, col]: a |List| with the line | |
| 3540 and column number. Most useful when the column is "$", to get | |
| 3541 the last column of a specific line. When "lnum" or "col" is | |
| 3542 out of range then col() returns zero. | |
| 3543 To get the line number use |line()|. To get both use | |
| 3544 |getpos()|. | |
| 3545 For the screen column position use |virtcol()|. | |
| 3546 Note that only marks in the current file can be used. | |
| 3547 Examples: > | |
| 3548 col(".") column of cursor | |
| 3549 col("$") length of cursor line plus one | |
| 3550 col("'t") column of mark t | |
| 3551 col("'" . markname) column of mark markname | |
| 3552 < The first column is 1. 0 is returned for an error. | |
| 3553 For an uppercase mark the column may actually be in another | |
| 3554 buffer. | |
| 3555 For the cursor position, when 'virtualedit' is active, the | |
| 3556 column is one higher if the cursor is after the end of the | |
| 3557 line. This can be used to obtain the column in Insert mode: > | |
| 3558 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
| 3559 \<C-O>:set ve=all<CR> | |
| 3560 \<C-O>:echo col(".") . "\n" <Bar> | |
| 3561 \let &ve = save_ve<CR> | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3562 |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3563 < Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3564 GetPos()->col() |
| 11062 | 3565 < |
| 3566 | |
| 3567 complete({startcol}, {matches}) *complete()* *E785* | |
| 3568 Set the matches for Insert mode completion. | |
| 3569 Can only be used in Insert mode. You need to use a mapping | |
| 3570 with CTRL-R = (see |i_CTRL-R|). It does not work after CTRL-O | |
| 3571 or with an expression mapping. | |
| 3572 {startcol} is the byte offset in the line where the completed | |
| 3573 text start. The text up to the cursor is the original text | |
| 3574 that will be replaced by the matches. Use col('.') for an | |
| 3575 empty string. "col('.') - 1" will replace one character by a | |
| 3576 match. | |
| 3577 {matches} must be a |List|. Each |List| item is one match. | |
| 3578 See |complete-items| for the kind of items that are possible. | |
| 3579 Note that the after calling this function you need to avoid | |
| 3580 inserting anything that would cause completion to stop. | |
| 3581 The match can be selected with CTRL-N and CTRL-P as usual with | |
| 3582 Insert mode completion. The popup menu will appear if | |
| 3583 specified, see |ins-completion-menu|. | |
| 3584 Example: > | |
| 3585 inoremap <F5> <C-R>=ListMonths()<CR> | |
| 3586 | |
| 3587 func! ListMonths() | |
| 3588 call complete(col('.'), ['January', 'February', 'March', | |
| 3589 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
| 3590 \ 'October', 'November', 'December']) | |
| 3591 return '' | |
| 3592 endfunc | |
| 3593 < This isn't very useful, but it shows how it works. Note that | |
| 3594 an empty string is returned to avoid a zero being inserted. | |
| 3595 | |
| 18343 | 3596 Can also be used as a |method|, the base is passed as the |
| 3597 second argument: > | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3598 GetMatches()->complete(col('.')) |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3599 |
| 11062 | 3600 complete_add({expr}) *complete_add()* |
| 3601 Add {expr} to the list of matches. Only to be used by the | |
| 3602 function specified with the 'completefunc' option. | |
| 3603 Returns 0 for failure (empty string or out of memory), | |
| 3604 1 when the match was added, 2 when the match was already in | |
| 3605 the list. | |
| 3606 See |complete-functions| for an explanation of {expr}. It is | |
| 3607 the same as one item in the list that 'omnifunc' would return. | |
| 3608 | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3609 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3610 GetMoreMatches()->complete_add() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3611 |
| 11062 | 3612 complete_check() *complete_check()* |
| 3613 Check for a key typed while looking for completion matches. | |
| 3614 This is to be used when looking for matches takes some time. | |
| 3615 Returns |TRUE| when searching for matches is to be aborted, | |
| 3616 zero otherwise. | |
| 3617 Only to be used by the function specified with the | |
| 3618 'completefunc' option. | |
| 3619 | |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3620 *complete_info()* |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3621 complete_info([{what}]) |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3622 Returns a Dictionary with information about Insert mode |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3623 completion. See |ins-completion|. |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3624 The items are: |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3625 mode Current completion mode name string. |
| 16208 | 3626 See |complete_info_mode| for the values. |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3627 pum_visible |TRUE| if popup menu is visible. |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3628 See |pumvisible()|. |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3629 items List of completion matches. Each item is a |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3630 dictionary containing the entries "word", |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3631 "abbr", "menu", "kind", "info" and "user_data". |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3632 See |complete-items|. |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3633 selected Selected item index. First index is zero. |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3634 Index is -1 if no item is selected (showing |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3635 typed text only) |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3636 inserted Inserted string. [NOT IMPLEMENT YET] |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3637 |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3638 *complete_info_mode* |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3639 mode values are: |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3640 "" Not in completion mode |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3641 "keyword" Keyword completion |i_CTRL-X_CTRL-N| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3642 "ctrl_x" Just pressed CTRL-X |i_CTRL-X| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3643 "whole_line" Whole lines |i_CTRL-X_CTRL-L| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3644 "files" File names |i_CTRL-X_CTRL-F| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3645 "tags" Tags |i_CTRL-X_CTRL-]| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3646 "path_defines" Definition completion |i_CTRL-X_CTRL-D| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3647 "path_patterns" Include completion |i_CTRL-X_CTRL-I| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3648 "dictionary" Dictionary |i_CTRL-X_CTRL-K| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3649 "thesaurus" Thesaurus |i_CTRL-X_CTRL-T| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3650 "cmdline" Vim Command line |i_CTRL-X_CTRL-V| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3651 "function" User defined completion |i_CTRL-X_CTRL-U| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3652 "omni" Omni completion |i_CTRL-X_CTRL-O| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3653 "spell" Spelling suggestions |i_CTRL-X_s| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3654 "eval" |complete()| completion |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3655 "unknown" Other internal modes |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3656 |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3657 If the optional {what} list argument is supplied, then only |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3658 the items listed in {what} are returned. Unsupported items in |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3659 {what} are silently ignored. |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3660 |
|
17756
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
3661 To get the position and size of the popup menu, see |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
3662 |pum_getpos()|. It's also available in |v:event| during the |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
3663 |CompleteChanged| event. |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
3664 |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3665 Examples: > |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3666 " Get all items |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3667 call complete_info() |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3668 " Get only 'mode' |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3669 call complete_info(['mode']) |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3670 " Get only 'mode' and 'pum_visible' |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3671 call complete_info(['mode', 'pum_visible']) |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3672 |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3673 < Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3674 GetItems()->complete_info() |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3675 < |
| 11062 | 3676 *confirm()* |
| 3677 confirm({msg} [, {choices} [, {default} [, {type}]]]) | |
|
16019
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
3678 confirm() offers the user a dialog, from which a choice can be |
| 11062 | 3679 made. It returns the number of the choice. For the first |
| 3680 choice this is 1. | |
| 3681 Note: confirm() is only supported when compiled with dialog | |
| 3682 support, see |+dialog_con| and |+dialog_gui|. | |
| 3683 | |
| 3684 {msg} is displayed in a |dialog| with {choices} as the | |
| 3685 alternatives. When {choices} is missing or empty, "&OK" is | |
| 3686 used (and translated). | |
| 3687 {msg} is a String, use '\n' to include a newline. Only on | |
| 3688 some systems the string is wrapped when it doesn't fit. | |
| 3689 | |
| 3690 {choices} is a String, with the individual choices separated | |
| 3691 by '\n', e.g. > | |
| 3692 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
| 3693 < The letter after the '&' is the shortcut key for that choice. | |
| 3694 Thus you can type 'c' to select "Cancel". The shortcut does | |
| 3695 not need to be the first letter: > | |
| 3696 confirm("file has been modified", "&Save\nSave &All") | |
| 3697 < For the console, the first letter of each choice is used as | |
| 3698 the default shortcut key. | |
| 3699 | |
| 3700 The optional {default} argument is the number of the choice | |
| 3701 that is made if the user hits <CR>. Use 1 to make the first | |
| 3702 choice the default one. Use 0 to not set a default. If | |
| 3703 {default} is omitted, 1 is used. | |
| 3704 | |
| 3705 The optional {type} argument gives the type of dialog. This | |
| 3706 is only used for the icon of the GTK, Mac, Motif and Win32 | |
| 3707 GUI. It can be one of these values: "Error", "Question", | |
| 3708 "Info", "Warning" or "Generic". Only the first character is | |
| 3709 relevant. When {type} is omitted, "Generic" is used. | |
| 3710 | |
| 3711 If the user aborts the dialog by pressing <Esc>, CTRL-C, | |
| 3712 or another valid interrupt key, confirm() returns 0. | |
| 3713 | |
| 3714 An example: > | |
| 3715 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
| 3716 :if choice == 0 | |
| 3717 : echo "make up your mind!" | |
| 3718 :elseif choice == 3 | |
| 3719 : echo "tasteful" | |
| 3720 :else | |
| 3721 : echo "I prefer bananas myself." | |
| 3722 :endif | |
| 3723 < In a GUI dialog, buttons are used. The layout of the buttons | |
| 3724 depends on the 'v' flag in 'guioptions'. If it is included, | |
| 3725 the buttons are always put vertically. Otherwise, confirm() | |
| 3726 tries to put the buttons in one horizontal line. If they | |
| 3727 don't fit, a vertical layout is used anyway. For some systems | |
| 3728 the horizontal layout is always used. | |
| 3729 | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3730 Can also be used as a |method|in: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3731 BuildMessage()->confirm("&Yes\n&No") |
| 18343 | 3732 < |
| 55 | 3733 *copy()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3734 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 3735 different from using {expr} directly. |
| 685 | 3736 When {expr} is a |List| a shallow copy is created. This means |
| 3737 that the original |List| can be changed without changing the | |
| 1621 | 3738 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
|
3739 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
|
3740 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
|
3741 Also see |deepcopy()|. |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
3742 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
3743 mylist->copy() |
| 55 | 3744 |
| 1621 | 3745 cos({expr}) *cos()* |
| 3746 Return the cosine of {expr}, measured in radians, as a |Float|. | |
| 3747 {expr} must evaluate to a |Float| or a |Number|. | |
| 3748 Examples: > | |
| 3749 :echo cos(100) | |
| 3750 < 0.862319 > | |
| 3751 :echo cos(-4.01) | |
| 3752 < -0.646043 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3753 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3754 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3755 Compute()->cos() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3756 < |
| 1621 | 3757 {only available when compiled with the |+float| feature} |
| 3758 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3759 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3760 cosh({expr}) *cosh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3761 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
|
3762 [1, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3763 {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
|
3764 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3765 :echo cosh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3766 < 1.127626 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3767 :echo cosh(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3768 < -1.127626 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3769 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3770 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3771 Compute()->cosh() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3772 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
3773 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3774 |
| 12785 | 3775 |
| 102 | 3776 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
| 79 | 3777 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
|
3778 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
|
3779 |
| 102 | 3780 If {start} is given then start with the item with this index. |
| 685 | 3781 {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
|
3782 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3783 When {ic} is given and it's |TRUE| then case is ignored. |
| 79 | 3784 |
|
11828
5a07a3ff56c1
patch 8.0.0794: checking translations fails with multiple NL
Christian Brabandt <cb@256bit.org>
parents:
11763
diff
changeset
|
3785 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
|
3786 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
|
3787 {expr} is an empty string. |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
3788 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
3789 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
3790 mylist->count(val) |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
3791 < |
| 7 | 3792 *cscope_connection()* |
| 3793 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
| 3794 Checks for the existence of a |cscope| connection. If no | |
| 3795 parameters are specified, then the function returns: | |
| 3796 0, if cscope was not available (not compiled in), or | |
| 3797 if there are no cscope connections; | |
| 3798 1, if there is at least one cscope connection. | |
| 3799 | |
| 3800 If parameters are specified, then the value of {num} | |
| 3801 determines how existence of a cscope connection is checked: | |
| 3802 | |
| 3803 {num} Description of existence check | |
| 3804 ----- ------------------------------ | |
| 3805 0 Same as no parameters (e.g., "cscope_connection()"). | |
| 3806 1 Ignore {prepend}, and use partial string matches for | |
| 3807 {dbpath}. | |
| 3808 2 Ignore {prepend}, and use exact string matches for | |
| 3809 {dbpath}. | |
| 3810 3 Use {prepend}, use partial string matches for both | |
| 3811 {dbpath} and {prepend}. | |
| 3812 4 Use {prepend}, use exact string matches for both | |
| 3813 {dbpath} and {prepend}. | |
| 3814 | |
| 3815 Note: All string comparisons are case sensitive! | |
| 3816 | |
| 3817 Examples. Suppose we had the following (from ":cs show"): > | |
| 3818 | |
| 3819 # pid database name prepend path | |
| 3820 0 27664 cscope.out /usr/local | |
| 3821 < | |
| 3822 Invocation Return Val ~ | |
| 3823 ---------- ---------- > | |
| 3824 cscope_connection() 1 | |
| 3825 cscope_connection(1, "out") 1 | |
| 3826 cscope_connection(2, "out") 0 | |
| 3827 cscope_connection(3, "out") 0 | |
| 3828 cscope_connection(3, "out", "local") 1 | |
| 3829 cscope_connection(4, "out") 0 | |
| 3830 cscope_connection(4, "out", "local") 0 | |
| 3831 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
| 3832 < | |
| 703 | 3833 cursor({lnum}, {col} [, {off}]) *cursor()* |
| 3834 cursor({list}) | |
| 1156 | 3835 Positions the cursor at the column (byte count) {col} in the |
| 3836 line {lnum}. The first column is one. | |
| 5938 | 3837 |
| 703 | 3838 When there is one argument {list} this is used as a |List| |
| 5938 | 3839 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
|
3840 [{lnum}, {col}] |
| 5938 | 3841 [{lnum}, {col}, {off}] |
| 3842 [{lnum}, {col}, {off}, {curswant}] | |
| 6009 | 3843 This is like the return value of |getpos()| or |getcurpos()|, |
| 5944 | 3844 but without the first item. |
| 5938 | 3845 |
| 7 | 3846 Does not change the jumplist. |
| 3847 If {lnum} is greater than the number of lines in the buffer, | |
| 3848 the cursor will be positioned at the last line in the buffer. | |
| 3849 If {lnum} is zero, the cursor will stay in the current line. | |
| 493 | 3850 If {col} is greater than the number of bytes in the line, |
| 7 | 3851 the cursor will be positioned at the last character in the |
| 3852 line. | |
| 3853 If {col} is zero, the cursor will stay in the current column. | |
| 5944 | 3854 If {curswant} is given it is used to set the preferred column |
| 6180 | 3855 for vertical movement. Otherwise {col} is used. |
| 6385 | 3856 |
| 703 | 3857 When 'virtualedit' is used {off} specifies the offset in |
| 3858 screen columns from the start of the character. E.g., a | |
| 1266 | 3859 position within a <Tab> or after the last character. |
| 1851 | 3860 Returns 0 when the position could be set, -1 otherwise. |
| 7 | 3861 |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3862 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3863 GetCursorPos()->cursor() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3864 |
|
14147
de75c249723d
patch 8.1.0091: MS-Windows: Cannot interrupt gdb when program is running
Christian Brabandt <cb@256bit.org>
parents:
14123
diff
changeset
|
3865 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
|
3866 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
|
3867 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
|
3868 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
|
3869 {only available on MS-Windows} |
| 55 | 3870 |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3871 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3872 GetPid()->debugbreak() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3873 |
| 12785 | 3874 deepcopy({expr} [, {noref}]) *deepcopy()* *E698* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3875 Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 3876 different from using {expr} directly. |
| 685 | 3877 When {expr} is a |List| a full copy is created. This means |
| 3878 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
|
3879 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
|
3880 |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
|
3881 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
|
3882 the original |List|. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3883 A |Dictionary| is copied in a similar way as a |List|. |
| 685 | 3884 When {noref} is omitted or zero a contained |List| or |
| 3885 |Dictionary| is only copied once. All references point to | |
| 3886 this single copy. With {noref} set to 1 every occurrence of a | |
| 3887 |List| or |Dictionary| results in a new copy. This also means | |
| 3888 that a cyclic reference causes deepcopy() to fail. | |
| 114 | 3889 *E724* |
| 3890 Nesting is possible up to 100 levels. When there is an item | |
| 164 | 3891 that refers back to a higher level making a deep copy with |
| 3892 {noref} set to 1 will fail. | |
| 55 | 3893 Also see |copy()|. |
| 3894 | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3895 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3896 GetObject()->deepcopy() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3897 |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3898 delete({fname} [, {flags}]) *delete()* |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3899 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
|
3900 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
|
3901 |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3902 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
|
3903 {fname}. This fails when directory {fname} is not empty. |
| 12785 | 3904 |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3905 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
|
3906 {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
|
3907 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
|
3908 that is being used. |
|
10004
8061455d9179
commit https://github.com/vim/vim/commit/818078ddfbb8cc2546f697c5675a251d095722ec
Christian Brabandt <cb@256bit.org>
parents:
10000
diff
changeset
|
3909 |
|
7629
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
3910 A symbolic link itself is deleted, not what it points to. |
| 12785 | 3911 |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3912 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
|
3913 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
|
3914 |
| 685 | 3915 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
|
3916 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
|
3917 |deletebufline()|. |
|
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
3918 |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3919 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3920 GetName()->delete() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3921 |
| 14519 | 3922 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
|
3923 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
|
3924 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
|
3925 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
|
3926 |
| 18343 | 3927 This function works only for loaded buffers. First call |
| 3928 |bufload()| if needed. | |
| 3929 | |
|
14043
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
3930 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
|
3931 |
| 14864 | 3932 {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
|
3933 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
|
3934 to refer to the last line in buffer {expr}. |
| 7 | 3935 |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3936 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3937 GetBuffer()->deletebufline(1) |
| 18343 | 3938 < |
| 7 | 3939 *did_filetype()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3940 did_filetype() Returns |TRUE| when autocommands are being executed and the |
| 7 | 3941 FileType event has been triggered at least once. Can be used |
| 3942 to avoid triggering the FileType event again in the scripts | |
| 3943 that detect the file type. |FileType| | |
| 11473 | 3944 Returns |FALSE| when `:setf FALLBACK` was used. |
| 7 | 3945 When editing another file, the counter is reset, thus this |
| 3946 really checks if the FileType event has been triggered for the | |
| 3947 current buffer. This allows an autocommand that starts | |
| 3948 editing another buffer to set 'filetype' and load a syntax | |
| 3949 file. | |
| 3950 | |
| 32 | 3951 diff_filler({lnum}) *diff_filler()* |
| 3952 Returns the number of filler lines above line {lnum}. | |
| 3953 These are the lines that were inserted at this point in | |
| 3954 another diff'ed window. These filler lines are shown in the | |
| 3955 display but don't exist in the buffer. | |
| 3956 {lnum} is used like with |getline()|. Thus "." is the current | |
| 3957 line, "'m" mark m, etc. | |
| 3958 Returns 0 if the current window is not in diff mode. | |
| 3959 | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3960 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3961 GetLnum()->diff_filler() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3962 |
| 32 | 3963 diff_hlID({lnum}, {col}) *diff_hlID()* |
| 3964 Returns the highlight ID for diff mode at line {lnum} column | |
| 3965 {col} (byte index). When the current line does not have a | |
| 3966 diff change zero is returned. | |
| 3967 {lnum} is used like with |getline()|. Thus "." is the current | |
| 3968 line, "'m" mark m, etc. | |
| 3969 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
| 3970 line. | |
| 3971 The highlight ID can be used with |synIDattr()| to obtain | |
| 3972 syntax information about the highlighting. | |
| 3973 | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3974 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3975 GetLnum()->diff_hlID(col) |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
3976 |
|
19400
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
3977 |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
3978 echoraw({expr}) *echoraw()* |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
3979 Output {expr} as-is, including unprintable characters. This |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
3980 can be used to output a terminal code. For example, to disable |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
3981 modifyOtherKeys: > |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
3982 call echoraw(&t_TE) |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
3983 < and to enable it again: > |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
3984 call echoraw(&t_TI) |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
3985 < Use with care, you can mess up the terminal this way. |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
3986 |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
3987 |
| 85 | 3988 empty({expr}) *empty()* |
| 3989 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
|
3990 - 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
|
3991 items. |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
3992 - 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
|
3993 - 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
|
3994 - |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
|
3995 - 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
|
3996 - A |Channel| is empty when it is closed. |
| 15512 | 3997 - 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
|
3998 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3999 For a long |List| this is much faster than comparing the |
| 685 | 4000 length with zero. |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4001 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4002 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4003 mylist->empty() |
| 85 | 4004 |
| 19099 | 4005 environ() *environ()* |
| 4006 Return all of environment variables as dictionary. You can | |
| 4007 check if an environment variable exists like this: > | |
| 4008 :echo has_key(environ(), 'HOME') | |
| 4009 < Note that the variable name may be CamelCase; to ignore case | |
| 4010 use this: > | |
| 4011 :echo index(keys(environ()), 'HOME', 0, 1) != -1 | |
| 4012 | |
| 7 | 4013 escape({string}, {chars}) *escape()* |
| 4014 Escape the characters in {chars} that occur in {string} with a | |
| 4015 backslash. Example: > | |
| 4016 :echo escape('c:\program files\vim', ' \') | |
| 4017 < results in: > | |
| 4018 c:\\program\ files\\vim | |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
4019 < Also see |shellescape()| and |fnameescape()|. |
| 1621 | 4020 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4021 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4022 GetText()->escape(' \') |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4023 < |
| 1621 | 4024 *eval()* |
| 95 | 4025 eval({string}) Evaluate {string} and return the result. Especially useful to |
| 4026 turn the result of |string()| back into the original value. | |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
4027 This works for Numbers, Floats, Strings, Blobs and composites |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
4028 of them. Also works for |Funcref|s that refer to existing |
| 1621 | 4029 functions. |
| 95 | 4030 |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4031 Can also be used as a |method|: > |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4032 argv->join()->eval() |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4033 |
| 7 | 4034 eventhandler() *eventhandler()* |
| 4035 Returns 1 when inside an event handler. That is that Vim got | |
| 4036 interrupted while waiting for the user to type a character, | |
| 4037 e.g., when dropping a file on Vim. This means interactive | |
| 4038 commands cannot be used. Otherwise zero is returned. | |
| 4039 | |
| 4040 executable({expr}) *executable()* | |
| 4041 This function checks if an executable with the name {expr} | |
| 4042 exists. {expr} must be the name of the program without any | |
| 10 | 4043 arguments. |
| 4044 executable() uses the value of $PATH and/or the normal | |
| 4045 searchpath for programs. *PATHEXT* | |
| 18972 | 4046 On MS-Windows the ".exe", ".bat", etc. can optionally be |
| 4047 included. Then the extensions in $PATHEXT are tried. Thus if | |
| 4048 "foo.exe" does not exist, "foo.exe.bat" can be found. If | |
|
20593
89b0f161e6a6
patch 8.2.0850: MS-Windows: exepath() works different from cmd.exe
Bram Moolenaar <Bram@vim.org>
parents:
20552
diff
changeset
|
4049 $PATHEXT is not set then ".com;.exe;.bat;.cmd" is used. A dot |
| 18972 | 4050 by itself can be used in $PATHEXT to try using the name |
| 4051 without an extension. When 'shell' looks like a Unix shell, | |
| 4052 then the name is also tried without adding an extension. | |
| 4053 On MS-Windows it only checks if the file exists and is not a | |
| 4054 directory, not if it's really executable. | |
| 819 | 4055 On MS-Windows an executable in the same directory as Vim is |
| 4056 always found. Since this directory is added to $PATH it | |
| 4057 should also work to execute it |win32-PATH|. | |
| 7 | 4058 The result is a Number: |
| 4059 1 exists | |
| 4060 0 does not exist | |
| 4061 -1 not implemented on this system | |
|
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14193
diff
changeset
|
4062 |exepath()| can be used to get the full path of an executable. |
| 7 | 4063 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4064 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4065 GetCommand()->executable() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4066 |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4067 execute({command} [, {silent}]) *execute()* |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4068 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
|
4069 string. |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4070 {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
|
4071 lines are executed one by one. |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4072 This is equivalent to: > |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4073 redir => var |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4074 {command} |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4075 redir END |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4076 < |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4077 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
|
4078 "" no `:silent` used |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4079 "silent" `:silent` used |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4080 "silent!" `:silent!` used |
| 11062 | 4081 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
|
4082 `: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
|
4083 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
|
4084 *E930* |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4085 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
|
4086 |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4087 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
|
4088 split(execute('args'), "\n") |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4089 |
|
16833
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
4090 < To execute a command in another window than the current one |
|
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
4091 use `win_execute()`. |
|
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
4092 |
|
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
4093 When used recursively the output of the recursive call is not |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4094 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
|
4095 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4096 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4097 GetCommand()->execute() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4098 |
| 5782 | 4099 exepath({expr}) *exepath()* |
| 4100 If {expr} is an executable and is either an absolute path, a | |
| 4101 relative path or found in $PATH, return the full path. | |
| 4102 Note that the current directory is used when {expr} starts | |
| 4103 with "./", which may be a problem for Vim: > | |
| 4104 echo exepath(v:progpath) | |
| 5814 | 4105 < If {expr} cannot be found in $PATH or is not executable then |
| 5782 | 4106 an empty string is returned. |
| 4107 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4108 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4109 GetCommand()->exepath() |
| 18343 | 4110 < |
| 7 | 4111 *exists()* |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
4112 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
|
4113 zero otherwise. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
4114 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
4115 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
|
4116 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
|
4117 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
4118 The {expr} argument is a string, which contains one of these: |
| 7 | 4119 &option-name Vim option (only checks if it exists, |
| 4120 not if it really works) | |
| 4121 +option-name Vim option that works. | |
| 4122 $ENVNAME environment variable (could also be | |
| 4123 done by comparing with an empty | |
| 4124 string) | |
| 4125 *funcname built-in function (see |functions|) | |
| 4126 or user defined function (see | |
|
19805
2dc5e6ddeb4c
patch 8.2.0459: cannot check if a function name is correct
Bram Moolenaar <Bram@vim.org>
parents:
19783
diff
changeset
|
4127 |user-functions|) that is implemented. |
|
2dc5e6ddeb4c
patch 8.2.0459: cannot check if a function name is correct
Bram Moolenaar <Bram@vim.org>
parents:
19783
diff
changeset
|
4128 Also works for a variable that is a |
|
2dc5e6ddeb4c
patch 8.2.0459: cannot check if a function name is correct
Bram Moolenaar <Bram@vim.org>
parents:
19783
diff
changeset
|
4129 Funcref. |
|
2dc5e6ddeb4c
patch 8.2.0459: cannot check if a function name is correct
Bram Moolenaar <Bram@vim.org>
parents:
19783
diff
changeset
|
4130 ?funcname built-in function that could be |
|
2dc5e6ddeb4c
patch 8.2.0459: cannot check if a function name is correct
Bram Moolenaar <Bram@vim.org>
parents:
19783
diff
changeset
|
4131 implemented; to be used to check if |
|
2dc5e6ddeb4c
patch 8.2.0459: cannot check if a function name is correct
Bram Moolenaar <Bram@vim.org>
parents:
19783
diff
changeset
|
4132 "funcname" is valid |
| 7 | 4133 varname internal variable (see |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4134 |internal-variables|). Also works |
| 685 | 4135 for |curly-braces-names|, |Dictionary| |
| 4136 entries, |List| items, etc. Beware | |
| 1668 | 4137 that evaluating an index may cause an |
| 4138 error message for an invalid | |
| 4139 expression. E.g.: > | |
| 4140 :let l = [1, 2, 3] | |
| 4141 :echo exists("l[5]") | |
| 4142 < 0 > | |
| 4143 :echo exists("l[xx]") | |
| 4144 < E121: Undefined variable: xx | |
| 4145 0 | |
| 7 | 4146 :cmdname Ex command: built-in command, user |
| 4147 command or command modifier |:command|. | |
| 4148 Returns: | |
| 4149 1 for match with start of a command | |
| 4150 2 full match with a command | |
| 4151 3 matches several user commands | |
| 4152 To check for a supported command | |
| 4153 always check the return value to be 2. | |
| 864 | 4154 :2match The |:2match| command. |
| 4155 :3match The |:3match| command. | |
| 7 | 4156 #event autocommand defined for this event |
| 4157 #event#pattern autocommand defined for this event and | |
| 4158 pattern (the pattern is taken | |
| 4159 literally and compared to the | |
| 4160 autocommand patterns character by | |
| 4161 character) | |
| 613 | 4162 #group autocommand group exists |
| 4163 #group#event autocommand defined for this group and | |
| 4164 event. | |
| 4165 #group#event#pattern | |
| 856 | 4166 autocommand defined for this group, |
| 613 | 4167 event and pattern. |
| 615 | 4168 ##event autocommand for this event is |
| 4169 supported. | |
| 7 | 4170 |
| 4171 Examples: > | |
| 4172 exists("&shortname") | |
| 4173 exists("$HOSTNAME") | |
| 4174 exists("*strftime") | |
| 4175 exists("*s:MyFunc") | |
| 4176 exists("bufcount") | |
| 4177 exists(":Make") | |
| 613 | 4178 exists("#CursorHold") |
| 7 | 4179 exists("#BufReadPre#*.gz") |
| 613 | 4180 exists("#filetypeindent") |
| 4181 exists("#filetypeindent#FileType") | |
| 4182 exists("#filetypeindent#FileType#*") | |
| 615 | 4183 exists("##ColorScheme") |
| 7 | 4184 < There must be no space between the symbol (&/$/*/#) and the |
| 4185 name. | |
| 867 | 4186 There must be no extra characters after the name, although in |
| 4187 a few cases this is ignored. That may become more strict in | |
| 4188 the future, thus don't count on it! | |
| 4189 Working example: > | |
| 4190 exists(":make") | |
| 4191 < NOT working example: > | |
| 4192 exists(":make install") | |
| 859 | 4193 |
| 4194 < Note that the argument must be a string, not the name of the | |
| 4195 variable itself. For example: > | |
| 7 | 4196 exists(bufcount) |
| 4197 < This doesn't check for existence of the "bufcount" variable, | |
| 853 | 4198 but gets the value of "bufcount", and checks if that exists. |
| 7 | 4199 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4200 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4201 Varname()->exists() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4202 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4203 exp({expr}) *exp()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
4204 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
|
4205 [0, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
4206 {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
|
4207 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4208 :echo exp(2) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4209 < 7.389056 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4210 :echo exp(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4211 < 0.367879 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4212 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4213 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4214 Compute()->exp() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4215 < |
|
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 |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4217 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4218 |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4219 expand({expr} [, {nosuf} [, {list}]]) *expand()* |
| 7 | 4220 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
|
4221 'wildignorecase' applies. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4222 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4223 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
|
4224 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
|
4225 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
|
4226 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
|
4227 file name contains a space] |
| 7 | 4228 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4229 If the expansion fails, the result is an empty string. A name |
| 4869 | 4230 for a non-existing file is not included, unless {expr} does |
| 4231 not start with '%', '#' or '<', see below. | |
| 7 | 4232 |
| 4233 When {expr} starts with '%', '#' or '<', the expansion is done | |
| 4234 like for the |cmdline-special| variables with their associated | |
| 4235 modifiers. Here is a short overview: | |
| 4236 | |
| 4237 % current file name | |
| 4238 # alternate file name | |
| 4239 #n alternate file name n | |
| 4240 <cfile> file name under the cursor | |
| 4241 <afile> autocmd file name | |
| 4242 <abuf> autocmd buffer number (as a String!) | |
| 4243 <amatch> autocmd matched name | |
| 5734 | 4244 <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
|
4245 <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
|
4246 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
|
4247 <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
|
4248 a function |
| 7 | 4249 <cword> word under the cursor |
| 4250 <cWORD> WORD under the cursor | |
| 4251 <client> the {clientid} of the last received | |
| 4252 message |server2client()| | |
| 4253 Modifiers: | |
| 4254 :p expand to full path | |
| 4255 :h head (last path component removed) | |
| 4256 :t tail (last path component only) | |
| 4257 :r root (one extension removed) | |
| 4258 :e extension only | |
| 4259 | |
| 4260 Example: > | |
| 4261 :let &tags = expand("%:p:h") . "/tags" | |
| 4262 < Note that when expanding a string that starts with '%', '#' or | |
| 4263 '<', any following text is ignored. This does NOT work: > | |
| 4264 :let doesntwork = expand("%:h.bak") | |
| 4265 < Use this: > | |
| 4266 :let doeswork = expand("%:h") . ".bak" | |
| 4267 < Also note that expanding "<cfile>" and others only returns the | |
| 4268 referenced file name without further expansion. If "<cfile>" | |
| 4269 is "~/.cshrc", you need to do another expand() to have the | |
| 4270 "~/" expanded into the path of the home directory: > | |
| 4271 :echo expand(expand("<cfile>")) | |
| 4272 < | |
| 4273 There cannot be white space between the variables and the | |
| 4274 following modifier. The |fnamemodify()| function can be used | |
| 4275 to modify normal file names. | |
| 4276 | |
| 4277 When using '%' or '#', and the current or alternate file name | |
| 4278 is not defined, an empty string is used. Using "%:p" in a | |
| 4279 buffer with no name, results in the current directory, with a | |
| 4280 '/' added. | |
| 4281 | |
| 4282 When {expr} does not start with '%', '#' or '<', it is | |
| 4283 expanded like a file name is expanded on the command line. | |
| 4284 '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
|
4285 {nosuf} argument is given and it is |TRUE|. |
| 3398 | 4286 Names for non-existing files are included. The "**" item can |
| 4287 be used to search in a directory tree. For example, to find | |
| 4288 all "README" files in the current directory and below: > | |
| 444 | 4289 :echo expand("**/README") |
| 4290 < | |
|
16019
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
4291 expand() can also be used to expand variables and environment |
| 7 | 4292 variables that are only known in a shell. But this can be |
| 6180 | 4293 slow, because a shell may be used to do the expansion. See |
| 4294 |expr-env-expand|. | |
| 7 | 4295 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
|
4296 names. When an environment variable cannot be expanded, it is |
| 7 | 4297 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
| 4298 "$FOOBAR". | |
| 4299 | |
| 4300 See |glob()| for finding existing files. See |system()| for | |
| 4301 getting the raw output of an external command. | |
| 4302 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4303 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4304 Getpattern()->expand() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4305 |
|
17020
1841c03a9b5e
patch 8.1.1510: a plugin cannot easily expand a command like done internally
Bram Moolenaar <Bram@vim.org>
parents:
17004
diff
changeset
|
4306 expandcmd({expr}) *expandcmd()* |
|
1841c03a9b5e
patch 8.1.1510: a plugin cannot easily expand a command like done internally
Bram Moolenaar <Bram@vim.org>
parents:
17004
diff
changeset
|
4307 Expand special items in {expr} like what is done for an Ex |
|
1841c03a9b5e
patch 8.1.1510: a plugin cannot easily expand a command like done internally
Bram Moolenaar <Bram@vim.org>
parents:
17004
diff
changeset
|
4308 command such as `:edit`. This expands special keywords, like |
|
1841c03a9b5e
patch 8.1.1510: a plugin cannot easily expand a command like done internally
Bram Moolenaar <Bram@vim.org>
parents:
17004
diff
changeset
|
4309 with |expand()|, and environment variables, anywhere in |
| 18456 | 4310 {expr}. "~user" and "~/path" are only expanded at the start. |
| 4311 Returns the expanded string. Example: > | |
|
17020
1841c03a9b5e
patch 8.1.1510: a plugin cannot easily expand a command like done internally
Bram Moolenaar <Bram@vim.org>
parents:
17004
diff
changeset
|
4312 :echo expandcmd('make %<.o') |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4313 |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4314 < Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4315 GetCommand()->expandcmd() |
|
17020
1841c03a9b5e
patch 8.1.1510: a plugin cannot easily expand a command like done internally
Bram Moolenaar <Bram@vim.org>
parents:
17004
diff
changeset
|
4316 < |
| 102 | 4317 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
| 692 | 4318 {expr1} and {expr2} must be both |Lists| or both |
| 4319 |Dictionaries|. | |
| 4320 | |
| 4321 If they are |Lists|: Append {expr2} to {expr1}. | |
| 102 | 4322 If {expr3} is given insert the items of {expr2} before item |
| 4323 {expr3} in {expr1}. When {expr3} is zero insert before the | |
| 4324 first item. When {expr3} is equal to len({expr1}) then | |
| 4325 {expr2} is appended. | |
| 79 | 4326 Examples: > |
| 4327 :echo sort(extend(mylist, [7, 5])) | |
| 4328 :call extend(mylist, [2, 3], 1) | |
| 1699 | 4329 < When {expr1} is the same List as {expr2} then the number of |
| 4330 items copied is equal to the original length of the List. | |
| 4331 E.g., when {expr3} is 1 you get N new copies of the first item | |
| 4332 (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
|
4333 Use |add()| to concatenate one item to a list. To concatenate |
| 82 | 4334 two lists into a new list use the + operator: > |
| 79 | 4335 :let newlist = [1, 2, 3] + [4, 5] |
| 102 | 4336 < |
| 692 | 4337 If they are |Dictionaries|: |
| 102 | 4338 Add all entries from {expr2} to {expr1}. |
| 4339 If a key exists in both {expr1} and {expr2} then {expr3} is | |
| 4340 used to decide what to do: | |
| 4341 {expr3} = "keep": keep the value of {expr1} | |
| 4342 {expr3} = "force": use the value of {expr2} | |
| 856 | 4343 {expr3} = "error": give an error message *E737* |
| 102 | 4344 When {expr3} is omitted then "force" is assumed. |
| 4345 | |
| 4346 {expr1} is changed when {expr2} is not empty. If necessary | |
| 4347 make a copy of {expr1} first. | |
| 4348 {expr2} remains unchanged. | |
| 6823 | 4349 When {expr1} is locked and {expr2} is not empty the operation |
| 4350 fails. | |
| 102 | 4351 Returns {expr1}. |
| 4352 | |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4353 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4354 mylist->extend(otherlist) |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4355 |
| 79 | 4356 |
| 842 | 4357 feedkeys({string} [, {mode}]) *feedkeys()* |
| 4358 Characters in {string} are queued for processing as if they | |
| 6549 | 4359 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
|
4360 |
| 6549 | 4361 By default the string is added to the end of the typeahead |
| 4362 buffer, thus if a mapping is still being executed the | |
| 4363 characters come after them. Use the 'i' flag to insert before | |
| 4364 other characters, they will be executed next, before any | |
| 4365 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
|
4366 |
| 842 | 4367 The function does not wait for processing of keys contained in |
| 4368 {string}. | |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
4369 |
| 842 | 4370 To include special keys into {string}, use double-quotes |
| 4371 and "\..." notation |expr-quote|. For example, | |
| 1215 | 4372 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
| 842 | 4373 feedkeys('\<CR>') pushes 5 characters. |
|
16600
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
4374 A special code that might be useful is <Ignore>, it exits the |
|
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
4375 wait for a character without doing anything. *<Ignore>* |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
4376 |
| 842 | 4377 {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
|
4378 '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
|
4379 keys are remapped. |
| 843 | 4380 'n' Do not remap keys. |
| 4381 't' Handle keys as if typed; otherwise they are handled as | |
| 4382 if coming from a mapping. This matters for undo, | |
| 4383 opening folds, etc. | |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
4384 'L' Lowlevel input. Only works for Unix or when using the |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
4385 GUI. Keys are used as if they were coming from the |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
4386 terminal. Other flags are not used. *E980* |
|
19742
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
4387 When a CTRL-C interrupts and 't' is included it sets |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
4388 the internal "got_int" flag. |
| 6549 | 4389 '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
|
4390 '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
|
4391 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
|
4392 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
|
4393 (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
|
4394 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
|
4395 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
|
4396 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
|
4397 script continues. |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
4398 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
|
4399 executing commands, thus calling it recursively, then |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
4400 all typeahead 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
|
4401 '!' 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
|
4402 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
|
4403 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
|
4404 |
| 842 | 4405 Return value is always 0. |
| 4406 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4407 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4408 GetInput()->feedkeys() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4409 |
| 7 | 4410 filereadable({file}) *filereadable()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4411 The result is a Number, which is |TRUE| when a file with the |
| 7 | 4412 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
|
4413 or is a directory, the result is |FALSE|. {file} is any |
| 7 | 4414 expression, which is used as a String. |
| 1156 | 4415 If you don't care about the file being readable you can use |
| 4416 |glob()|. | |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4417 {file} is used as-is, you may want to expand wildcards first: > |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4418 echo filereadable('~/.vimrc') |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4419 0 |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4420 echo filereadable(expand('~/.vimrc')) |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4421 1 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4422 |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4423 < Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4424 GetName()->filereadable() |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4425 < *file_readable()* |
| 7 | 4426 Obsolete name: file_readable(). |
| 4427 | |
| 95 | 4428 |
| 1156 | 4429 filewritable({file}) *filewritable()* |
| 4430 The result is a Number, which is 1 when a file with the | |
| 4431 name {file} exists, and can be written. If {file} doesn't | |
| 1621 | 4432 exist, or is not writable, the result is 0. If {file} is a |
| 1156 | 4433 directory, and we can write to it, the result is 2. |
| 4434 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4435 Can also be used as a |method|: > |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
4436 GetName()->filewritable() |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4437 |
| 1156 | 4438 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4439 filter({expr1}, {expr2}) *filter()* |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4440 {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
|
4441 For each item in {expr1} evaluate {expr2} and when the result |
| 685 | 4442 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
|
4443 {expr2} must be a |string| or |Funcref|. |
| 12785 | 4444 |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
4445 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
|
4446 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
|
4447 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
|
4448 the current item. |
| 102 | 4449 Examples: > |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4450 call filter(mylist, 'v:val !~ "OLD"') |
| 102 | 4451 < 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
|
4452 call filter(mydict, 'v:key >= 8') |
| 102 | 4453 < 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
|
4454 call filter(var, 0) |
| 685 | 4455 < Removes all the items, thus clears the |List| or |Dictionary|. |
| 99 | 4456 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4457 Note that {expr2} is the result of expression and is then |
| 102 | 4458 used as an expression again. Often it is good to use a |
| 4459 |literal-string| to avoid having to double backslashes. | |
| 4460 | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4461 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
|
4462 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
|
4463 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
|
4464 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
|
4465 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
|
4466 func Odd(idx, val) |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4467 return a:idx % 2 == 1 |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4468 endfunc |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4469 call filter(mylist, function('Odd')) |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
4470 < 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
|
4471 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
|
4472 < 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
|
4473 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
|
4474 < |
| 685 | 4475 The operation is done in-place. If you want a |List| or |
| 4476 |Dictionary| to remain unmodified make a copy first: > | |
| 650 | 4477 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
| 102 | 4478 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4479 < 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
|
4480 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
|
4481 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
|
4482 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
|
4483 defined with the "abort" flag. |
| 95 | 4484 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4485 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4486 mylist->filter(expr2) |
| 95 | 4487 |
| 12785 | 4488 finddir({name} [, {path} [, {count}]]) *finddir()* |
| 1095 | 4489 Find directory {name} in {path}. Supports both downwards and |
| 4490 upwards recursive directory searches. See |file-searching| | |
| 4491 for the syntax of {path}. | |
| 4492 Returns the path of the first found match. When the found | |
| 4493 directory is below the current directory a relative path is | |
| 4494 returned. Otherwise a full path is returned. | |
| 19 | 4495 If {path} is omitted or empty then 'path' is used. |
| 4496 If the optional {count} is given, find {count}'s occurrence of | |
| 794 | 4497 {name} in {path} instead of the first one. |
| 809 | 4498 When {count} is negative return all the matches in a |List|. |
| 19 | 4499 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
|
4500 {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
|
4501 feature} |
| 794 | 4502 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4503 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4504 GetName()->finddir() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4505 |
| 12785 | 4506 findfile({name} [, {path} [, {count}]]) *findfile()* |
| 794 | 4507 Just like |finddir()|, but find a file instead of a directory. |
| 4508 Uses 'suffixesadd'. | |
| 19 | 4509 Example: > |
| 4510 :echo findfile("tags.vim", ".;") | |
| 1156 | 4511 < Searches from the directory of the current file upwards until |
| 4512 it finds the file "tags.vim". | |
| 7 | 4513 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4514 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4515 GetName()->findfile() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4516 |
| 1621 | 4517 float2nr({expr}) *float2nr()* |
| 4518 Convert {expr} to a Number by omitting the part after the | |
| 4519 decimal point. | |
| 4520 {expr} must evaluate to a |Float| or a Number. | |
| 4521 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
|
4522 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
|
4523 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
|
4524 -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
|
4525 64-bit Number support is enabled, -0x8000000000000000). |
| 1621 | 4526 Examples: > |
| 4527 echo float2nr(3.95) | |
| 4528 < 3 > | |
| 4529 echo float2nr(-23.45) | |
| 4530 < -23 > | |
| 4531 echo float2nr(1.0e100) | |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
4532 < 2147483647 (or 9223372036854775807) > |
| 1621 | 4533 echo float2nr(-1.0e150) |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
4534 < -2147483647 (or -9223372036854775807) > |
| 1621 | 4535 echo float2nr(1.0e-100) |
| 4536 < 0 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4537 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4538 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4539 Compute()->float2nr() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4540 < |
| 1621 | 4541 {only available when compiled with the |+float| feature} |
| 4542 | |
| 4543 | |
| 4544 floor({expr}) *floor()* | |
| 4545 Return the largest integral value less than or equal to | |
| 4546 {expr} as a |Float| (round down). | |
| 4547 {expr} must evaluate to a |Float| or a |Number|. | |
| 4548 Examples: > | |
| 4549 echo floor(1.856) | |
| 4550 < 1.0 > | |
| 4551 echo floor(-5.456) | |
| 4552 < -6.0 > | |
| 4553 echo floor(4.0) | |
| 4554 < 4.0 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4555 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4556 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4557 Compute()->floor() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4558 < |
| 1621 | 4559 {only available when compiled with the |+float| feature} |
| 12785 | 4560 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4561 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4562 fmod({expr1}, {expr2}) *fmod()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4563 Return the remainder of {expr1} / {expr2}, even if the |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4564 division is not representable. Returns {expr1} - i * {expr2} |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4565 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
|
4566 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
|
4567 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
|
4568 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
|
4569 {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
|
4570 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4571 :echo fmod(12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4572 < 0.13 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4573 :echo fmod(-12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4574 < -0.13 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4575 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4576 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4577 Compute()->fmod(1.22) |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4578 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
4579 {only available when compiled with |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4580 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4581 |
| 1586 | 4582 fnameescape({string}) *fnameescape()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4583 Escape {string} for use as file name command argument. All |
| 1586 | 4584 characters that have a special meaning, such as '%' and '|' |
| 4585 are escaped with a backslash. | |
| 1621 | 4586 For most systems the characters escaped are |
| 4587 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
| 4588 appears in a filename, it depends on the value of 'isfname'. | |
| 1700 | 4589 A leading '+' and '>' is also escaped (special after |:edit| |
| 4590 and |:write|). And a "-" by itself (special after |:cd|). | |
| 1586 | 4591 Example: > |
| 1700 | 4592 :let fname = '+some str%nge|name' |
| 1586 | 4593 :exe "edit " . fnameescape(fname) |
| 4594 < results in executing: > | |
| 1700 | 4595 edit \+some\ str\%nge\|name |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4596 < |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4597 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4598 GetName()->fnameescape() |
| 1586 | 4599 |
| 7 | 4600 fnamemodify({fname}, {mods}) *fnamemodify()* |
| 4601 Modify file name {fname} according to {mods}. {mods} is a | |
| 4602 string of characters like it is used for file names on the | |
| 4603 command line. See |filename-modifiers|. | |
| 4604 Example: > | |
| 4605 :echo fnamemodify("main.c", ":p:h") | |
| 4606 < results in: > | |
| 4607 /home/mool/vim/vim/src | |
| 1621 | 4608 < Note: Environment variables don't work in {fname}, use |
| 7 | 4609 |expand()| first then. |
| 4610 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4611 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4612 GetName()->fnamemodify(':p:h') |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4613 |
| 7 | 4614 foldclosed({lnum}) *foldclosed()* |
| 4615 The result is a Number. If the line {lnum} is in a closed | |
| 4616 fold, the result is the number of the first line in that fold. | |
| 4617 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 4618 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4619 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4620 GetLnum()->foldclosed() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4621 |
| 7 | 4622 foldclosedend({lnum}) *foldclosedend()* |
| 4623 The result is a Number. If the line {lnum} is in a closed | |
| 4624 fold, the result is the number of the last line in that fold. | |
| 4625 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 4626 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4627 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4628 GetLnum()->foldclosedend() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4629 |
| 7 | 4630 foldlevel({lnum}) *foldlevel()* |
| 4631 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
|
4632 in the current buffer. For nested folds the deepest level is |
| 7 | 4633 returned. If there is no fold at line {lnum}, zero is |
| 4634 returned. It doesn't matter if the folds are open or closed. | |
| 4635 When used while updating folds (from 'foldexpr') -1 is | |
| 4636 returned for lines where folds are still to be updated and the | |
| 4637 foldlevel is unknown. As a special case the level of the | |
| 4638 previous line is usually available. | |
| 4639 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4640 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4641 GetLnum()->foldlevel() |
| 18343 | 4642 < |
| 7 | 4643 *foldtext()* |
| 4644 foldtext() Returns a String, to be displayed for a closed fold. This is | |
| 4645 the default function used for the 'foldtext' option and should | |
| 4646 only be called from evaluating 'foldtext'. It uses the | |
| 4647 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
| 4648 The returned string looks like this: > | |
| 4649 +-- 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
|
4650 < 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
|
4651 "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
|
4652 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
|
4653 "//" 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
|
4654 '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
|
4655 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
|
4656 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
|
4657 setting. |
| 7 | 4658 {not available when compiled without the |+folding| feature} |
| 4659 | |
| 29 | 4660 foldtextresult({lnum}) *foldtextresult()* |
| 4661 Returns the text that is displayed for the closed fold at line | |
| 4662 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
| 4663 When there is no closed fold at {lnum} an empty string is | |
| 4664 returned. | |
| 4665 {lnum} is used like with |getline()|. Thus "." is the current | |
| 4666 line, "'m" mark m, etc. | |
| 4667 Useful when exporting folded text, e.g., to HTML. | |
| 4668 {not available when compiled without the |+folding| feature} | |
| 4669 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4670 |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4671 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4672 GetLnum()->foldtextresult() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4673 < |
| 7 | 4674 *foreground()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4675 foreground() Move the Vim window to the foreground. Useful when sent from |
| 7 | 4676 a client to a Vim server. |remote_send()| |
| 4677 On Win32 systems this might not work, the OS does not always | |
| 4678 allow a window to bring itself to the foreground. Use | |
| 4679 |remote_foreground()| instead. | |
| 4680 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 4681 Win32 console version} | |
| 4682 | |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4683 *funcref()* |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4684 funcref({name} [, {arglist}] [, {dict}]) |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4685 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
|
4686 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
|
4687 function {name} is redefined later. |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4688 |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4689 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
|
4690 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
|
4691 function. |
| 82 | 4692 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4693 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4694 GetFuncname()->funcref([arg]) |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4695 < |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4696 *function()* *E700* *E922* *E923* |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4697 function({name} [, {arglist}] [, {dict}]) |
| 685 | 4698 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
|
4699 {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
|
4700 internal function. |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4701 |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4702 {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
|
4703 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
|
4704 argument is not allowed. E.g.: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4705 let FuncWithArg = function(dict.Func, [arg]) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4706 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
|
4707 < |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4708 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
|
4709 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
|
4710 same function. |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4711 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4712 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
|
4713 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
|
4714 the Funcref and will be used when the Funcref is called. |
| 12785 | 4715 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4716 The arguments are passed to the function in front of other |
| 17667 | 4717 arguments, but after any argument from |method|. Example: > |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4718 func Callback(arg1, arg2, name) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4719 ... |
| 17667 | 4720 let Partial = function('Callback', ['one', 'two']) |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4721 ... |
| 17667 | 4722 call Partial('name') |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4723 < Invokes the function as with: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4724 call Callback('one', 'two', 'name') |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4725 |
| 17667 | 4726 < With a |method|: > |
| 4727 func Callback(one, two, three) | |
| 4728 ... | |
| 4729 let Partial = function('Callback', ['two']) | |
| 4730 ... | |
| 4731 eval 'one'->Partial('three') | |
| 4732 < Invokes the function as with: > | |
| 4733 call Callback('one', 'two', 'three') | |
| 4734 | |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4735 < 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
|
4736 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
|
4737 arguments. Example: > |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4738 func Callback(arg1, arg2, name) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4739 ... |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4740 let Func = function('Callback', ['one']) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4741 let Func2 = function(Func, ['two']) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4742 ... |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4743 call Func2('name') |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4744 < Invokes the function as with: > |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4745 call Callback('one', 'two', 'name') |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4746 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4747 < 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
|
4748 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
|
4749 function Callback() dict |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4750 echo "called for " . self.name |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4751 endfunction |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4752 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4753 let context = {"name": "example"} |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4754 let Func = function('Callback', context) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4755 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4756 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
|
4757 < 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
|
4758 arguments, these two are equivalent: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4759 let Func = function('Callback', context) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4760 let Func = context.Callback |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4761 |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4762 < 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
|
4763 function Callback(arg1, count) dict |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4764 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4765 let context = {"name": "example"} |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4766 let Func = function('Callback', ['one'], context) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4767 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4768 call Func(500) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4769 < Invokes the function as with: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4770 call context.Callback('one', 500) |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4771 < |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4772 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4773 GetFuncname()->function([arg]) |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4774 |
| 82 | 4775 |
| 3224 | 4776 garbagecollect([{atexit}]) *garbagecollect()* |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4777 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
|
4778 that have circular references. |
| 12785 | 4779 |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4780 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
|
4781 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
|
4782 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
|
4783 circular references are always freed when they become unused. |
| 685 | 4784 This is useful if you have deleted a very big |List| and/or |
| 4785 |Dictionary| with circular references in a script that runs | |
| 4786 for a long time. | |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4787 |
| 3224 | 4788 When the optional {atexit} argument is one, garbage |
| 1405 | 4789 collection will also be done when exiting Vim, if it wasn't |
| 4790 done before. This is useful when checking for memory leaks. | |
| 370 | 4791 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
4792 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
|
4793 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
|
4794 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
|
4795 |test_garbagecollect_now()|. |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4796 |
| 140 | 4797 get({list}, {idx} [, {default}]) *get()* |
| 685 | 4798 Get item {idx} from |List| {list}. When this item is not |
| 82 | 4799 available return {default}. Return zero when {default} is |
| 4800 omitted. | |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4801 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4802 mylist->get(idx) |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
4803 get({blob}, {idx} [, {default}]) |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
4804 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
|
4805 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
|
4806 omitted. |
| 102 | 4807 get({dict}, {key} [, {default}]) |
| 685 | 4808 Get item with key {key} from |Dictionary| {dict}. When this |
| 102 | 4809 item is not available return {default}. Return zero when |
| 17571 | 4810 {default} is omitted. Useful example: > |
| 4811 let val = get(g:, 'var_name', 'default') | |
| 4812 < This gets the value of g:var_name if it exists, and uses | |
| 4813 'default' when it does not exist. | |
|
9117
0cc48b3cd884
commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents:
9110
diff
changeset
|
4814 get({func}, {what}) |
|
0cc48b3cd884
commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents:
9110
diff
changeset
|
4815 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
|
4816 {what} are: |
| 11062 | 4817 "name" The function name |
| 4818 "func" The function | |
| 4819 "dict" The dictionary | |
| 4820 "args" The list with arguments | |
| 102 | 4821 |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4822 *getbufinfo()* |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4823 getbufinfo([{expr}]) |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4824 getbufinfo([{dict}]) |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4825 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
|
4826 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4827 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
|
4828 returned. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4829 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4830 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
|
4831 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
|
4832 be specified in {dict}: |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4833 buflisted include only listed buffers. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4834 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
|
4835 bufmodified include only modified buffers. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4836 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4837 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
|
4838 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
|
4839 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
|
4840 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
|
4841 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4842 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
|
4843 entries: |
|
9904
24900147aa44
commit https://github.com/vim/vim/commit/339288377072f66ec88e21903e75a82d23ffbf4f
Christian Brabandt <cb@256bit.org>
parents:
9894
diff
changeset
|
4844 bufnr buffer number. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4845 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
|
4846 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
|
4847 hidden TRUE if the buffer is hidden. |
|
18463
18d7337b6837
patch 8.1.2225: the "last used" info of a buffer is under used
Bram Moolenaar <Bram@vim.org>
parents:
18456
diff
changeset
|
4848 lastused timestamp in seconds, like |
|
18d7337b6837
patch 8.1.2225: the "last used" info of a buffer is under used
Bram Moolenaar <Bram@vim.org>
parents:
18456
diff
changeset
|
4849 |localtime()|, when the buffer was |
|
18d7337b6837
patch 8.1.2225: the "last used" info of a buffer is under used
Bram Moolenaar <Bram@vim.org>
parents:
18456
diff
changeset
|
4850 last used. |
|
18d7337b6837
patch 8.1.2225: the "last used" info of a buffer is under used
Bram Moolenaar <Bram@vim.org>
parents:
18456
diff
changeset
|
4851 {only with the |+viminfo| feature} |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4852 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
|
4853 lnum current line number in buffer. |
|
18916
cf051bdefb3f
patch 8.2.0019: cannot number of lines of another buffer
Bram Moolenaar <Bram@vim.org>
parents:
18912
diff
changeset
|
4854 linecount number of lines in the buffer (only |
|
cf051bdefb3f
patch 8.2.0019: cannot number of lines of another buffer
Bram Moolenaar <Bram@vim.org>
parents:
18912
diff
changeset
|
4855 valid when loaded) |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4856 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
|
4857 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
|
4858 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
|
4859 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
|
4860 the following fields: |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4861 id sign identifier |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4862 lnum line number |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4863 name sign name |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4864 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
|
4865 buffer-local variables. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4866 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
|
4867 buffer |
|
17253
26e0352613ec
patch 8.1.1626: no test for closing a popup window with a modified buffer
Bram Moolenaar <Bram@vim.org>
parents:
17221
diff
changeset
|
4868 popups list of popup |window-ID|s that |
|
26e0352613ec
patch 8.1.1626: no test for closing a popup window with a modified buffer
Bram Moolenaar <Bram@vim.org>
parents:
17221
diff
changeset
|
4869 display this buffer |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4870 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4871 Examples: > |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4872 for buf in getbufinfo() |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4873 echo buf.name |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4874 endfor |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4875 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
|
4876 if buf.changed |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4877 .... |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4878 endif |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4879 endfor |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4880 < |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4881 To get buffer-local options use: > |
| 14519 | 4882 getbufvar({bufnr}, '&option_name') |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4883 |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4884 < |
| 435 | 4885 *getbufline()* |
| 4886 getbufline({expr}, {lnum} [, {end}]) | |
| 685 | 4887 Return a |List| with the lines starting from {lnum} to {end} |
| 4888 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
| 4889 |List| with only the line {lnum} is returned. | |
| 435 | 4890 |
| 4891 For the use of {expr}, see |bufname()| above. | |
| 4892 | |
| 448 | 4893 For {lnum} and {end} "$" can be used for the last line of the |
| 4894 buffer. Otherwise a number must be used. | |
| 435 | 4895 |
| 4896 When {lnum} is smaller than 1 or bigger than the number of | |
| 685 | 4897 lines in the buffer, an empty |List| is returned. |
| 435 | 4898 |
| 4899 When {end} is greater than the number of lines in the buffer, | |
| 4900 it is treated as {end} is set to the number of lines in the | |
| 685 | 4901 buffer. When {end} is before {lnum} an empty |List| is |
| 435 | 4902 returned. |
| 4903 | |
| 448 | 4904 This function works only for loaded buffers. For unloaded and |
| 685 | 4905 non-existing buffers, an empty |List| is returned. |
| 435 | 4906 |
| 4907 Example: > | |
| 4908 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
| 82 | 4909 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
4910 < Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
4911 GetBufnr()->getbufline(lnum) |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
4912 |
| 4157 | 4913 getbufvar({expr}, {varname} [, {def}]) *getbufvar()* |
| 82 | 4914 The result is the value of option or local buffer variable |
| 4915 {varname} in buffer {expr}. Note that the name without "b:" | |
| 4916 must be used. | |
| 1668 | 4917 When {varname} is empty returns a dictionary with all the |
| 4918 buffer-local variables. | |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4919 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
|
4920 the buffer-local options. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4921 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
|
4922 a buffer-local option. |
| 216 | 4923 This also works for a global or buffer-local option, but it |
| 4924 doesn't work for a global variable, window-local variable or | |
| 4925 window-local option. | |
| 82 | 4926 For the use of {expr}, see |bufname()| above. |
| 4157 | 4927 When the buffer or variable doesn't exist {def} or an empty |
| 4928 string is returned, there is no error message. | |
| 82 | 4929 Examples: > |
| 4930 :let bufmodified = getbufvar(1, "&mod") | |
| 4931 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
4932 |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
4933 < Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
4934 GetBufnr()->getbufvar(varname) |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
4935 < |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
4936 getchangelist([{expr}]) *getchangelist()* |
|
13280
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4937 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
|
4938 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
|
4939 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
|
4940 |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4941 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
|
4942 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
|
4943 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
|
4944 entries: |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4945 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
|
4946 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
|
4947 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
|
4948 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
|
4949 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
|
4950 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
|
4951 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
4952 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
4953 GetBufnr()->getchangelist() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
4954 |
| 7 | 4955 getchar([expr]) *getchar()* |
| 867 | 4956 Get a single character from the user or input stream. |
| 7 | 4957 If [expr] is omitted, wait until a character is available. |
| 4958 If [expr] is 0, only get a character when one is available. | |
| 867 | 4959 Return zero otherwise. |
| 7 | 4960 If [expr] is 1, only check if a character is available, it is |
| 867 | 4961 not consumed. Return zero if no character available. |
| 4962 | |
| 5555 | 4963 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
|
4964 special key is returned. If it is a single character, the |
| 867 | 4965 result is a number. Use nr2char() to convert it to a String. |
| 4966 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
|
4967 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
|
4968 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
|
4969 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
|
4970 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
|
4971 that is not included in the character. |
| 867 | 4972 |
| 5968 | 4973 When [expr] is 0 and Esc is typed, there will be a short delay |
| 4974 while Vim waits to see if this is the start of an escape | |
| 4975 sequence. | |
| 4976 | |
| 5555 | 4977 When [expr] is 1 only the first byte is returned. For a |
| 872 | 4978 one-byte character it is the character itself as a number. |
| 4979 Use nr2char() to convert it to a String. | |
| 867 | 4980 |
| 3224 | 4981 Use getcharmod() to obtain any additional modifiers. |
| 4982 | |
| 1029 | 4983 When the user clicks a mouse button, the mouse event will be |
| 4984 returned. The position can then be found in |v:mouse_col|, | |
|
18623
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
4985 |v:mouse_lnum|, |v:mouse_winid| and |v:mouse_win|. |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
4986 |getmousepos()| can also be used. This example positions the |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
4987 mouse as it would normally happen: > |
| 1029 | 4988 let c = getchar() |
| 1621 | 4989 if c == "\<LeftMouse>" && v:mouse_win > 0 |
| 1029 | 4990 exe v:mouse_win . "wincmd w" |
| 4991 exe v:mouse_lnum | |
| 4992 exe "normal " . v:mouse_col . "|" | |
| 4993 endif | |
| 4994 < | |
| 10734 | 4995 When using bracketed paste only the first character is |
| 4996 returned, the rest of the pasted text is dropped. | |
| 4997 |xterm-bracketed-paste|. | |
| 4998 | |
| 7 | 4999 There is no prompt, you will somehow have to make clear to the |
| 5000 user that a character has to be typed. | |
| 5001 There is no mapping for the character. | |
| 5002 Key codes are replaced, thus when the user presses the <Del> | |
| 5003 key you get the code for the <Del> key, not the raw character | |
| 5004 sequence. Examples: > | |
| 5005 getchar() == "\<Del>" | |
| 5006 getchar() == "\<S-Left>" | |
| 5007 < This example redefines "f" to ignore case: > | |
| 5008 :nmap f :call FindChar()<CR> | |
| 5009 :function FindChar() | |
| 5010 : let c = nr2char(getchar()) | |
| 5011 : while col('.') < col('$') - 1 | |
| 5012 : normal l | |
| 5013 : if getline('.')[col('.') - 1] ==? c | |
| 5014 : break | |
| 5015 : endif | |
| 5016 : endwhile | |
| 5017 :endfunction | |
| 6421 | 5018 < |
| 6647 | 5019 You may also receive synthetic characters, such as |
| 6421 | 5020 |<CursorHold>|. Often you will want to ignore this and get |
| 5021 another character: > | |
| 5022 :function GetKey() | |
| 5023 : let c = getchar() | |
| 5024 : while c == "\<CursorHold>" | |
| 5025 : let c = getchar() | |
| 5026 : endwhile | |
| 5027 : return c | |
| 5028 :endfunction | |
| 7 | 5029 |
| 5030 getcharmod() *getcharmod()* | |
| 5031 The result is a Number which is the state of the modifiers for | |
| 5032 the last obtained character with getchar() or in another way. | |
| 5033 These values are added together: | |
| 5034 2 shift | |
| 5035 4 control | |
| 5036 8 alt (meta) | |
| 3224 | 5037 16 meta (when it's different from ALT) |
| 5038 32 mouse double click | |
| 5039 64 mouse triple click | |
| 5040 96 mouse quadruple click (== 32 + 64) | |
| 5041 128 command (Macintosh only) | |
| 7 | 5042 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
|
5043 character itself are obtained. Thus Shift-a results in "A" |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5044 without a modifier. |
| 7 | 5045 |
| 6991 | 5046 getcharsearch() *getcharsearch()* |
| 5047 Return the current character search information as a {dict} | |
| 5048 with the following entries: | |
| 5049 | |
| 5050 char character previously used for a character | |
| 5051 search (|t|, |f|, |T|, or |F|); empty string | |
| 5052 if no character search has been performed | |
| 5053 forward direction of character search; 1 for forward, | |
| 5054 0 for backward | |
| 5055 until type of character search; 1 for a |t| or |T| | |
| 5056 character search, 0 for an |f| or |F| | |
| 5057 character search | |
| 5058 | |
| 5059 This can be useful to always have |;| and |,| search | |
| 5060 forward/backward regardless of the direction of the previous | |
| 5061 character search: > | |
| 5062 :nnoremap <expr> ; getcharsearch().forward ? ';' : ',' | |
| 5063 :nnoremap <expr> , getcharsearch().forward ? ',' : ';' | |
| 5064 < Also see |setcharsearch()|. | |
| 5065 | |
| 7 | 5066 getcmdline() *getcmdline()* |
| 5067 Return the current command-line. Only works when the command | |
| 5068 line is being edited, thus requires use of |c_CTRL-\_e| or | |
| 5069 |c_CTRL-R_=|. | |
| 5070 Example: > | |
| 5071 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
| 531 | 5072 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
| 14864 | 5073 Returns an empty string when entering a password or using |
| 5074 |inputsecret()|. | |
| 7 | 5075 |
| 95 | 5076 getcmdpos() *getcmdpos()* |
| 7 | 5077 Return the position of the cursor in the command line as a |
| 5078 byte count. The first column is 1. | |
| 5079 Only works when editing the command line, thus requires use of | |
| 3456 | 5080 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 5081 Returns 0 otherwise. | |
| 531 | 5082 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
| 5083 | |
| 5084 getcmdtype() *getcmdtype()* | |
| 5085 Return the current command-line type. Possible return values | |
| 5086 are: | |
| 532 | 5087 : normal Ex command |
| 5088 > debug mode command |debug-mode| | |
| 5089 / forward search command | |
| 5090 ? backward search command | |
| 5091 @ |input()| command | |
| 5092 - |:insert| or |:append| command | |
| 6213 | 5093 = |i_CTRL-R_=| |
| 531 | 5094 Only works when editing the command line, thus requires use of |
| 3456 | 5095 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 5096 Returns an empty string otherwise. | |
| 531 | 5097 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. |
| 7 | 5098 |
| 6153 | 5099 getcmdwintype() *getcmdwintype()* |
| 5100 Return the current |command-line-window| type. Possible return | |
| 5101 values are the same as |getcmdtype()|. Returns an empty string | |
| 5102 when not in the command-line window. | |
| 5103 | |
|
9861
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
5104 getcompletion({pat}, {type} [, {filtered}]) *getcompletion()* |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5105 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
|
5106 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
|
5107 supported: |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5108 |
|
13551
1fd0f8392946
patch 8.0.1649: no completion for argument list commands
Christian Brabandt <cb@256bit.org>
parents:
13513
diff
changeset
|
5109 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
|
5110 augroup autocmd groups |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5111 buffer buffer names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5112 behave :behave suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5113 color color schemes |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5114 command Ex command (and arguments) |
|
20745
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5115 cmdline |cmdline-completion| result |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5116 compiler compilers |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5117 cscope |:cscope| suboptions |
|
18987
e378907d79bf
patch 8.2.0054: :diffget and :diffput don't have good completion
Bram Moolenaar <Bram@vim.org>
parents:
18973
diff
changeset
|
5118 diff_buffer |:diffget| and |:diffput| completion |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5119 dir directory names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5120 environment environment variable names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5121 event autocommand events |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5122 expression Vim expression |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5123 file file and directory names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5124 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
|
5125 filetype filetype names |'filetype'| |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5126 function function name |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5127 help help subjects |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5128 highlight highlight groups |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5129 history :history suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5130 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
|
5131 mapclear buffer argument |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5132 mapping mapping name |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5133 menu menus |
|
10275
6d8b2da002e9
commit https://github.com/vim/vim/commit/9e507ca8a3e1535e62de4bd86374b0fcd18ef5b8
Christian Brabandt <cb@256bit.org>
parents:
10245
diff
changeset
|
5134 messages |:messages| suboptions |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5135 option options |
|
10275
6d8b2da002e9
commit https://github.com/vim/vim/commit/9e507ca8a3e1535e62de4bd86374b0fcd18ef5b8
Christian Brabandt <cb@256bit.org>
parents:
10245
diff
changeset
|
5136 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
|
5137 shellcmd Shell command |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5138 sign |:sign| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5139 syntax syntax file names |'syntax'| |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5140 syntime |:syntime| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5141 tag tags |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5142 tag_listfiles tags, file names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5143 user user names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5144 var user variables |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5145 |
|
20745
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5146 If {pat} is an empty string, then all the matches are |
|
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5147 returned. Otherwise only items matching {pat} are returned. |
|
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5148 See |wildcards| for the use of special characters in {pat}. |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5149 |
|
9861
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
5150 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
|
5151 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
|
5152 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
|
5153 |
|
20745
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5154 If {type} is "cmdline", then the |cmdline-completion| result is |
|
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5155 returned. For example, to complete the possible values after |
|
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5156 a ":call" command: > |
|
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5157 echo getcompletion('call ', 'cmdline') |
|
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5158 < |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5159 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
|
5160 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
|
5161 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5162 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5163 GetPattern()->getcompletion('color') |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5164 < |
| 5944 | 5165 *getcurpos()* |
| 5166 getcurpos() Get the position of the cursor. This is like getpos('.'), but | |
| 19968 | 5167 includes an extra "curswant" item in the list: |
| 5168 [0, lnum, col, off, curswant] ~ | |
| 5944 | 5169 The "curswant" number is the preferred column when moving the |
| 11347 | 5170 cursor vertically. Also see |getpos()|. |
| 19968 | 5171 The first "bufnum" item is always zero. |
| 11347 | 5172 |
| 5944 | 5173 This can be used to save and restore the cursor position: > |
| 5174 let save_cursor = getcurpos() | |
| 5175 MoveTheCursorAround | |
| 5176 call setpos('.', save_cursor) | |
| 11347 | 5177 < Note that this only works within the window. See |
| 5178 |winrestview()| for restoring more state. | |
| 7 | 5179 *getcwd()* |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5180 getcwd([{winnr} [, {tabnr}]]) |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5181 The result is a String, which is the name of the current |
| 7 | 5182 working directory. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5183 |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5184 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
|
5185 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
|
5186 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
|
5187 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
|
5188 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
|
5189 |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5190 With {winnr} and {tabnr} return the local current directory of |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5191 the window in the specified tab page. If {winnr} is -1 return |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5192 the working directory of the tabpage. |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5193 If {winnr} is zero use the current window, if {tabnr} is zero |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5194 use the current tabpage. |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5195 Without any arguments, return the working directory of the |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5196 current window. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5197 Return an empty string if the arguments are invalid. |
| 7 | 5198 |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5199 Examples: > |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5200 " Get the working directory of the current window |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5201 :echo getcwd() |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5202 :echo getcwd(0) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5203 :echo getcwd(0, 0) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5204 " Get the working directory of window 3 in tabpage 2 |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5205 :echo getcwd(3, 2) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5206 " Get the global working directory |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5207 :echo getcwd(-1) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5208 " Get the working directory of tabpage 3 |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5209 :echo getcwd(-1, 3) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5210 " Get the working directory of current tabpage |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5211 :echo getcwd(-1, 0) |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5212 |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5213 < Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5214 GetWinnr()->getcwd() |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5215 < |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5216 getenv({name}) *getenv()* |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5217 Return the value of environment variable {name}. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5218 When the variable does not exist |v:null| is returned. That |
| 17571 | 5219 is different from a variable set to an empty string, although |
| 5220 some systems interpret the empty value as the variable being | |
| 5221 deleted. See also |expr-env|. | |
| 7 | 5222 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5223 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5224 GetVarname()->getenv() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5225 |
| 37 | 5226 getfontname([{name}]) *getfontname()* |
| 5227 Without an argument returns the name of the normal font being | |
| 5228 used. Like what is used for the Normal highlight group | |
| 5229 |hl-Normal|. | |
| 5230 With an argument a check is done whether {name} is a valid | |
| 5231 font name. If not then an empty string is returned. | |
| 5232 Otherwise the actual font name is returned, or {name} if the | |
| 5233 GUI does not support obtaining the real name. | |
| 824 | 5234 Only works when the GUI is running, thus not in your vimrc or |
| 819 | 5235 gvimrc file. Use the |GUIEnter| autocommand to use this |
| 5236 function just after the GUI has started. | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
5237 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
|
5238 a valid name does not work. |
| 37 | 5239 |
| 20 | 5240 getfperm({fname}) *getfperm()* |
| 5241 The result is a String, which is the read, write, and execute | |
| 5242 permissions of the given file {fname}. | |
| 5243 If {fname} does not exist or its directory cannot be read, an | |
| 5244 empty string is returned. | |
| 5245 The result is of the form "rwxrwxrwx", where each group of | |
| 5246 "rwx" flags represent, in turn, the permissions of the owner | |
| 5247 of the file, the group the file belongs to, and other users. | |
| 5248 If a user does not have a given permission the flag for this | |
| 3750 | 5249 is replaced with the string "-". Examples: > |
| 20 | 5250 :echo getfperm("/etc/passwd") |
| 3750 | 5251 :echo getfperm(expand("~/.vimrc")) |
| 20 | 5252 < This will hopefully (from a security point of view) display |
| 5253 the string "rw-r--r--" or even "rw-------". | |
| 205 | 5254 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5255 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5256 GetFilename()->getfperm() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5257 < |
|
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10237
diff
changeset
|
5258 For setting permissions use |setfperm()|. |
|
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
5259 |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5260 getfsize({fname}) *getfsize()* |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5261 The result is a Number, which is the size in bytes of the |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5262 given file {fname}. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5263 If {fname} is a directory, 0 is returned. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5264 If the file {fname} can't be found, -1 is returned. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5265 If the size of {fname} is too big to fit in a Number then -2 |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5266 is returned. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5267 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5268 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5269 GetFilename()->getfsize() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5270 |
| 7 | 5271 getftime({fname}) *getftime()* |
| 5272 The result is a Number, which is the last modification time of | |
| 5273 the given file {fname}. The value is measured as seconds | |
| 5274 since 1st Jan 1970, and may be passed to strftime(). See also | |
| 5275 |localtime()| and |strftime()|. | |
| 5276 If the file {fname} can't be found -1 is returned. | |
| 5277 | |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5278 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5279 GetFilename()->getftime() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5280 |
| 20 | 5281 getftype({fname}) *getftype()* |
| 5282 The result is a String, which is a description of the kind of | |
| 5283 file of the given file {fname}. | |
| 5284 If {fname} does not exist an empty string is returned. | |
| 5285 Here is a table over different kinds of files and their | |
| 5286 results: | |
| 5287 Normal file "file" | |
| 5288 Directory "dir" | |
| 5289 Symbolic link "link" | |
| 5290 Block device "bdev" | |
| 5291 Character device "cdev" | |
| 5292 Socket "socket" | |
| 5293 FIFO "fifo" | |
| 5294 All other "other" | |
| 5295 Example: > | |
| 5296 getftype("/home") | |
| 5297 < Note that a type such as "link" will only be returned on | |
| 5298 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
|
5299 "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
|
5300 directory returns "dir" instead of "link". |
| 20 | 5301 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5302 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5303 GetFilename()->getftype() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5304 |
|
18008
8ae333756614
patch 8.1.2000: plugin cannot get the current IME status
Bram Moolenaar <Bram@vim.org>
parents:
18000
diff
changeset
|
5305 getimstatus() *getimstatus()* |
|
8ae333756614
patch 8.1.2000: plugin cannot get the current IME status
Bram Moolenaar <Bram@vim.org>
parents:
18000
diff
changeset
|
5306 The result is a Number, which is |TRUE| when the IME status is |
|
8ae333756614
patch 8.1.2000: plugin cannot get the current IME status
Bram Moolenaar <Bram@vim.org>
parents:
18000
diff
changeset
|
5307 active. |
|
8ae333756614
patch 8.1.2000: plugin cannot get the current IME status
Bram Moolenaar <Bram@vim.org>
parents:
18000
diff
changeset
|
5308 See 'imstatusfunc'. |
|
8ae333756614
patch 8.1.2000: plugin cannot get the current IME status
Bram Moolenaar <Bram@vim.org>
parents:
18000
diff
changeset
|
5309 |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
5310 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
|
5311 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
|
5312 |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
5313 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
|
5314 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
|
5315 {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
|
5316 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
|
5317 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
|
5318 |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
5319 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
|
5320 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
|
5321 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
|
5322 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
|
5323 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
|
5324 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
|
5325 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
|
5326 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
|
5327 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
|
5328 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5329 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5330 GetWinnr()->getjumplist() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5331 |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5332 < *getline()* |
| 82 | 5333 getline({lnum} [, {end}]) |
| 5334 Without {end} the result is a String, which is line {lnum} | |
| 5335 from the current buffer. Example: > | |
| 7 | 5336 getline(1) |
| 5337 < 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
|
5338 digit, |line()| is called to translate the String into a Number. |
| 7 | 5339 To get the line under the cursor: > |
| 5340 getline(".") | |
| 5341 < When {lnum} is smaller than 1 or bigger than the number of | |
| 5342 lines in the buffer, an empty string is returned. | |
| 5343 | |
| 685 | 5344 When {end} is given the result is a |List| where each item is |
| 5345 a line from the current buffer in the range {lnum} to {end}, | |
| 82 | 5346 including line {end}. |
| 5347 {end} is used in the same way as {lnum}. | |
| 5348 Non-existing lines are silently omitted. | |
| 685 | 5349 When {end} is before {lnum} an empty |List| is returned. |
| 82 | 5350 Example: > |
| 5351 :let start = line('.') | |
| 5352 :let end = search("^$") - 1 | |
| 5353 :let lines = getline(start, end) | |
| 5354 | |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5355 < Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5356 ComputeLnum()->getline() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5357 |
| 1156 | 5358 < To get lines from another buffer see |getbufline()| |
| 5359 | |
| 12785 | 5360 getloclist({nr} [, {what}]) *getloclist()* |
| 647 | 5361 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
|
5362 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
|
5363 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
|
5364 |
| 647 | 5365 For a location list window, the displayed location list is |
| 648 | 5366 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
|
5367 returned. Otherwise, same as |getqflist()|. |
| 82 | 5368 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5369 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
|
5370 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
|
5371 |getqflist()| for the supported items in {what}. |
|
16019
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5372 |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5373 In addition to the items supported by |getqflist()| in {what}, |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5374 the following item is supported by |getloclist()|: |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5375 |
| 16808 | 5376 filewinid id of the window used to display files |
|
16019
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5377 from the location list. This field is |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5378 applicable only when called from a |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5379 location list window. See |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5380 |location-list-file-window| for more |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5381 details. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5382 |
|
20615
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5383 getmarklist([{expr}] *getmarklist()* |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5384 Without the {expr} argument returns a |List| with information |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5385 about all the global marks. |mark| |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5386 |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5387 If the optional {expr} argument is specified, returns the |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5388 local marks defined in buffer {expr}. For the use of {expr}, |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5389 see |bufname()|. |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5390 |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5391 Each item in the retuned List is a |Dict| with the following: |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5392 name - name of the mark prefixed by "'" |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5393 pos - a |List| with the position of the mark: |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5394 [bufnum, lnum, col, off] |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5395 Refer to |getpos()| for more information. |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5396 file - file name |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5397 |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5398 Refer to |getpos()| for getting information about a specific |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5399 mark. |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5400 |
|
20635
3e36a51ff152
patch 8.2.0871: cannot use getmarklist() as a method
Bram Moolenaar <Bram@vim.org>
parents:
20631
diff
changeset
|
5401 Can also be used as a |method|: > |
|
3e36a51ff152
patch 8.2.0871: cannot use getmarklist() as a method
Bram Moolenaar <Bram@vim.org>
parents:
20631
diff
changeset
|
5402 GetBufnr()->getmarklist() |
|
20615
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5403 |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
5404 getmatches([{win}]) *getmatches()* |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
5405 Returns a |List| with all matches previously defined for the |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
5406 current window by |matchadd()| and the |:match| commands. |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
5407 |getmatches()| is useful in combination with |setmatches()|, |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
5408 as |setmatches()| can restore a list of matches saved by |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
5409 |getmatches()|. |
| 1326 | 5410 Example: > |
| 5411 :echo getmatches() | |
| 5412 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 5413 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 5414 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 5415 :let m = getmatches() | |
| 5416 :call clearmatches() | |
| 5417 :echo getmatches() | |
| 5418 < [] > | |
| 5419 :call setmatches(m) | |
| 5420 :echo getmatches() | |
| 5421 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 5422 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 5423 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 5424 :unlet m | |
| 5425 < | |
|
18623
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5426 getmousepos() *getmousepos()* |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5427 Returns a Dictionary with the last known position of the |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5428 mouse. This can be used in a mapping for a mouse click or in |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5429 a filter of a popup window. The items are: |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5430 screenrow screen row |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5431 screencol screen column |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5432 winid Window ID of the click |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5433 winrow row inside "winid" |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5434 wincol column inside "winid" |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5435 line text line inside "winid" |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5436 column text column inside "winid" |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5437 All numbers are 1-based. |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5438 |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5439 If not over a window, e.g. when in the command line, then only |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5440 "screenrow" and "screencol" are valid, the others are zero. |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5441 |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5442 When on the status line below a window or the vertical |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
5443 separator right of a window, the "line" and "column" values |
|
18623
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5444 are zero. |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5445 |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5446 When the position is after the text then "column" is the |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5447 length of the text in bytes. |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5448 |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5449 If the mouse is over a popup window then that window is used. |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5450 |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5451 |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5452 When using |getchar()| the Vim variables |v:mouse_lnum|, |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5453 |v:mouse_col| and |v:mouse_winid| also provide these values. |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5454 |
| 5968 | 5455 *getpid()* |
| 5456 getpid() Return a Number which is the process ID of the Vim process. | |
| 5457 On Unix and MS-Windows this is a unique number, until Vim | |
| 18972 | 5458 exits. |
| 5968 | 5459 |
| 5460 *getpos()* | |
| 5461 getpos({expr}) Get the position for {expr}. For possible values of {expr} | |
| 5462 see |line()|. For getting the cursor position see | |
| 5463 |getcurpos()|. | |
| 5464 The result is a |List| with four numbers: | |
| 5465 [bufnum, lnum, col, off] | |
| 5466 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
| 5467 is the buffer number of the mark. | |
| 5468 "lnum" and "col" are the position in the buffer. The first | |
| 5469 column is 1. | |
| 5470 The "off" number is zero, unless 'virtualedit' is used. Then | |
| 5471 it is the offset in screen columns from the start of the | |
| 5472 character. E.g., a position within a <Tab> or after the last | |
| 5473 character. | |
| 5474 Note that for '< and '> Visual mode matters: when it is "V" | |
| 5475 (visual line mode) the column of '< is zero and the column of | |
| 5476 '> is a large number. | |
| 5477 This can be used to save and restore the position of a mark: > | |
| 5478 let save_a_mark = getpos("'a") | |
| 5479 ... | |
| 6421 | 5480 call setpos("'a", save_a_mark) |
| 5968 | 5481 < Also see |getcurpos()| and |setpos()|. |
| 5482 | |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5483 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5484 GetMark()->getpos() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5485 |
| 1326 | 5486 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5487 getqflist([{what}]) *getqflist()* |
| 230 | 5488 Returns a list with all the current quickfix errors. Each |
| 5489 list item is a dictionary with these entries: | |
| 5490 bufnr number of buffer that has the file name, use | |
| 5491 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
|
5492 module module name |
| 230 | 5493 lnum line number in the buffer (first line is 1) |
| 5494 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
|
5495 vcol |TRUE|: "col" is visual column |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5496 |FALSE|: "col" is byte index |
| 230 | 5497 nr error number |
| 1065 | 5498 pattern search pattern used to locate the error |
| 230 | 5499 text description of the error |
| 5500 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
|
5501 valid |TRUE|: recognized error message |
| 230 | 5502 |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
5503 When there is no error list or it's empty, an empty list is |
| 1065 | 5504 returned. Quickfix list entries with non-existing buffer |
| 5505 number are returned with "bufnr" set to zero. | |
| 515 | 5506 |
| 230 | 5507 Useful application: Find pattern matches in multiple files and |
| 5508 do something with them: > | |
| 5509 :vimgrep /theword/jg *.c | |
| 5510 :for d in getqflist() | |
| 5511 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
| 5512 :endfor | |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5513 < |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5514 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
|
5515 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
|
5516 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
|
5517 changedtick get the total number of changes made |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5518 to the list |quickfix-changedtick| |
|
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5519 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
|
5520 efm errorformat to use when parsing "lines". If |
| 12968 | 5521 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
|
5522 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
|
5523 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
|
5524 |quickfix-ID|; zero means the id for the |
| 12968 | 5525 current list or the list specified by "nr" |
|
20631
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
5526 idx get information for the quickfix entry at this |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
5527 index in the list specified by 'id' or 'nr'. |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
5528 If set to zero, then uses the current entry. |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
5529 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
|
5530 items quickfix list entries |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5531 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
|
5532 the resulting entries. Only a |List| type is |
|
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5533 accepted. The current quickfix list is not |
|
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5534 modified. See |quickfix-parse|. |
|
10237
197795e3530d
commit https://github.com/vim/vim/commit/890680ca6364386fabb271c85e0755bcaa6a33c1
Christian Brabandt <cb@256bit.org>
parents:
10233
diff
changeset
|
5535 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
|
5536 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
|
5537 the last quickfix list |
|
16019
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5538 qfbufnr number of the buffer displayed in the quickfix |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5539 window. Returns 0 if the quickfix buffer is |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5540 not present. See |quickfix-buffer|. |
|
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
|
5541 size number of entries in the quickfix list |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5542 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
|
5543 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
|
5544 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
|
5545 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
|
5546 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
|
5547 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
|
5548 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
|
5549 specified by "id" is used. |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
5550 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
|
5551 "$" 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
|
5552 contains the quickfix stack size. |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
5553 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
|
5554 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
|
5555 "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
|
5556 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5557 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
|
5558 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
|
5559 list |quickfix-changedtick| |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5560 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
|
5561 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
|
5562 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
|
5563 present, set to 0. |
|
20631
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
5564 idx index of the quickfix entry in the list. If not |
|
13026
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
5565 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
|
5566 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
|
5567 an empty list. |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
5568 nr quickfix list number. If not present, set to 0 |
|
16019
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5569 qfbufnr number of the buffer displayed in the quickfix |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5570 window. If not present, set to 0. |
|
13026
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
5571 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
|
5572 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
|
5573 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
|
5574 to "". |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
5575 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
|
5576 |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5577 Examples (See also |getqflist-examples|): > |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5578 :echo getqflist({'all': 1}) |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5579 :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
|
5580 :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
|
5581 < |
| 5796 | 5582 getreg([{regname} [, 1 [, {list}]]]) *getreg()* |
| 7 | 5583 The result is a String, which is the contents of register |
| 236 | 5584 {regname}. Example: > |
| 7 | 5585 :let cliptext = getreg('*') |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
5586 < 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
|
5587 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
5588 getreg('=') returns the last evaluated value of the expression |
| 236 | 5589 register. (For use in maps.) |
| 282 | 5590 getreg('=', 1) returns the expression itself, so that it can |
| 5591 be restored with |setreg()|. For other registers the extra | |
| 5592 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
|
5593 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5594 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
|
5595 to |List|. Each list item is one text line. Use it if you care |
| 5796 | 5596 about zero bytes possibly present inside register: without |
| 5597 third argument both NLs and zero bytes are represented as NLs | |
| 5598 (see |NL-used-for-Nul|). | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
5599 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
|
5600 |
| 7 | 5601 If {regname} is not specified, |v:register| is used. |
| 5602 | |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5603 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5604 GetRegname()->getreg() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5605 |
|
20743
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5606 getreginfo([{regname}]) *getreginfo()* |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5607 Returns detailed information about register {regname} as a |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5608 Dictionary with the following entries: |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5609 regcontents List of lines contained in register |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5610 {regname}, like |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5611 |getreg|({regname}, 1, 1). |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5612 regtype the type of register {regname}, as in |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5613 |getregtype()|. |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5614 isunnamed Boolean flag, v:true if this register |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5615 is currently pointed to by the unnamed |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5616 register. |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5617 points_to for the unnamed register, gives the |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5618 single letter name of the register |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5619 currently pointed to (see |quotequote|). |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5620 For example, after deleting a line |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5621 with `dd`, this field will be "1", |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5622 which is the register that got the |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5623 deleted text. |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5624 |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5625 If {regname} is invalid or not set, an empty Dictionary |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5626 will be returned. |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5627 If {regname} is not specified, |v:register| is used. |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5628 |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5629 Can also be used as a |method|: > |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5630 GetRegname()->getreginfo() |
| 82 | 5631 |
| 7 | 5632 getregtype([{regname}]) *getregtype()* |
| 5633 The result is a String, which is type of register {regname}. | |
| 5634 The value will be one of: | |
| 5635 "v" for |characterwise| text | |
| 5636 "V" for |linewise| text | |
| 5637 "<CTRL-V>{width}" for |blockwise-visual| text | |
| 5596 | 5638 "" for an empty or unknown register |
| 7 | 5639 <CTRL-V> is one character with value 0x16. |
| 5640 If {regname} is not specified, |v:register| is used. | |
| 5641 | |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5642 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5643 GetRegname()->getregtype() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5644 |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5645 gettabinfo([{arg}]) *gettabinfo()* |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5646 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
|
5647 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
|
5648 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
|
5649 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
|
5650 empty List is returned. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5651 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5652 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
|
5653 tabnr tab page number. |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
5654 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
|
5655 tabpage-local variables |
| 15932 | 5656 windows List of |window-ID|s in the tab page. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5657 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5658 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5659 GetTabnr()->gettabinfo() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5660 |
| 4157 | 5661 gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()* |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5662 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
|
5663 {tabnr}. |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5664 Tabs are numbered starting with one. |
| 6197 | 5665 When {varname} is empty a dictionary with all tab-local |
| 5666 variables is returned. | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5667 Note that the name without "t:" must be used. |
| 4157 | 5668 When the tab or variable doesn't exist {def} or an empty |
| 5669 string is returned, there is no error message. | |
| 5670 | |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5671 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5672 GetTabnr()->gettabvar(varname) |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5673 |
| 4157 | 5674 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()* |
| 1156 | 5675 Get the value of window-local variable {varname} in window |
| 5676 {winnr} in tab page {tabnr}. | |
| 4157 | 5677 When {varname} is empty a dictionary with all window-local |
| 5678 variables is returned. | |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
5679 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
|
5680 window-local options in a Dictionary. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
5681 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
|
5682 window-local option. |
| 4157 | 5683 Note that {varname} must be the name without "w:". |
| 831 | 5684 Tabs are numbered starting with one. For the current tabpage |
| 5685 use |getwinvar()|. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
5686 {winnr} can be the window number or the |window-ID|. |
| 831 | 5687 When {winnr} is zero the current window is used. |
| 5688 This also works for a global option, buffer-local option and | |
| 5689 window-local option, but it doesn't work for a global variable | |
| 5690 or buffer-local variable. | |
| 4157 | 5691 When the tab, window or variable doesn't exist {def} or an |
| 5692 empty string is returned, there is no error message. | |
| 831 | 5693 Examples: > |
| 5694 :let list_is_on = gettabwinvar(1, 2, '&list') | |
| 5695 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
| 1266 | 5696 < |
| 14347 | 5697 To obtain all window-local variables use: > |
| 5698 gettabwinvar({tabnr}, {winnr}, '&') | |
| 5699 | |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5700 < Can also be used as a |method|: > |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5701 GetTabnr()->gettabwinvar(winnr, varname) |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5702 |
|
15016
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5703 gettagstack([{nr}]) *gettagstack()* |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5704 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
|
5705 {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
|
5706 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
|
5707 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
|
5708 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5709 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
|
5710 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
|
5711 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
|
5712 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
|
5713 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
|
5714 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
|
5715 entries described below. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5716 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
|
5717 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5718 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
|
5719 entries: |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5720 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
|
5721 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
|
5722 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
|
5723 returned list. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5724 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
|
5725 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
|
5726 name. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5727 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
|
5728 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5729 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
|
5730 |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5731 Can also be used as a |method|: > |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5732 GetWinnr()->gettagstack() |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5733 |
|
14343
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5734 getwininfo([{winid}]) *getwininfo()* |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5735 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
|
5736 |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5737 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
|
5738 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
|
5739 empty list. |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5740 |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5741 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
|
5742 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
|
5743 |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5744 Each List item is a Dictionary with the following entries: |
|
15977
7fbdceabad64
patch 8.1.0994: relative cursor position is not calculated correctly
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
5745 botline last displayed buffer line |
|
14343
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5746 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
|
5747 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
|
5748 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
|
5749 {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
|
5750 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
|
5751 {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
|
5752 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
|
5753 {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
|
5754 tabnr tab page number |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
5755 topline first displayed buffer line |
|
14343
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5756 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
|
5757 window-local variables |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5758 width window width |
| 14347 | 5759 winbar 1 if the window has a toolbar, 0 |
| 5760 otherwise | |
|
14343
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5761 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
|
5762 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
|
5763 winid |window-ID| |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5764 winnr window number |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5765 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
|
5766 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
|
5767 |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5768 Can also be used as a |method|: > |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5769 GetWinnr()->getwininfo() |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5770 |
|
13379
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
5771 getwinpos([{timeout}]) *getwinpos()* |
| 19303 | 5772 The result is a List with two numbers, the result of |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
5773 |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
|
5774 [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
|
5775 {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
|
5776 a response from the terminal. When omitted 100 msec is used. |
| 13437 | 5777 Use a longer time for a remote terminal. |
| 5778 When using a value less than 10 and no response is received | |
| 5779 within that time, a previously reported position is returned, | |
| 5780 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
|
5781 do some work in the meantime: > |
| 13437 | 5782 while 1 |
| 5783 let res = getwinpos(1) | |
| 5784 if res[0] >= 0 | |
| 5785 break | |
| 5786 endif | |
| 5787 " Do some work here | |
| 5788 endwhile | |
| 5789 < | |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5790 |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5791 Can also be used as a |method|: > |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5792 GetTimeout()->getwinpos() |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5793 < |
| 7 | 5794 *getwinposx()* |
| 5795 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
| 11347 | 5796 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
|
5797 xterm (uses a timeout of 100 msec). |
| 11347 | 5798 The result will be -1 if the information is not available. |
| 5799 The value can be used with `:winpos`. | |
| 7 | 5800 |
| 5801 *getwinposy()* | |
| 5802 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
|
5803 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
|
5804 a timeout of 100 msec). |
| 11347 | 5805 The result will be -1 if the information is not available. |
| 5806 The value can be used with `:winpos`. | |
| 7 | 5807 |
| 4157 | 5808 getwinvar({winnr}, {varname} [, {def}]) *getwinvar()* |
| 831 | 5809 Like |gettabwinvar()| for the current tabpage. |
| 7 | 5810 Examples: > |
| 5811 :let list_is_on = getwinvar(2, '&list') | |
| 5812 :echo "myvar = " . getwinvar(1, 'myvar') | |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5813 |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5814 < Can also be used as a |method|: > |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5815 GetWinnr()->getwinvar(varname) |
| 7 | 5816 < |
| 6663 | 5817 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()* |
| 1754 | 5818 Expand the file wildcards in {expr}. See |wildcards| for the |
| 1156 | 5819 use of special characters. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
5820 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5821 Unless the optional {nosuf} argument is given and is |TRUE|, |
| 1754 | 5822 the 'suffixes' and 'wildignore' options apply: Names matching |
| 5823 one of the patterns in 'wildignore' will be skipped and | |
| 5824 'suffixes' affect the ordering of matches. | |
| 2662 | 5825 'wildignorecase' always applies. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
5826 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5827 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
|
5828 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
|
5829 you also get filenames containing newlines correctly. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
5830 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
|
5831 matches, they are separated by <NL> characters. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
5832 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
5833 If the expansion fails, the result is an empty String or List. |
| 6663 | 5834 |
| 16267 | 5835 You can also use |readdir()| if you need to do complicated |
| 5836 things, such as limiting the number of matches. | |
| 5837 | |
| 3445 | 5838 A name for a non-existing file is not included. A symbolic |
| 5839 link is only included if it points to an existing file. | |
| 6663 | 5840 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
|
5841 |TRUE| then all symbolic links are included. |
| 7 | 5842 |
| 5843 For most systems backticks can be used to get files names from | |
| 5844 any external command. Example: > | |
| 5845 :let tagfiles = glob("`find . -name tags -print`") | |
| 5846 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
| 5847 < 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
|
5848 item per line. Spaces inside an item are allowed. |
| 7 | 5849 |
| 5850 See |expand()| for expanding special Vim variables. See | |
| 5851 |system()| for getting the raw output of an external command. | |
| 5852 | |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5853 Can also be used as a |method|: > |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5854 GetExpr()->glob() |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5855 |
| 6697 | 5856 glob2regpat({expr}) *glob2regpat()* |
| 5857 Convert a file pattern, as used by glob(), into a search | |
| 5858 pattern. The result can be used to match with a string that | |
| 5859 is a file name. E.g. > | |
| 5860 if filename =~ glob2regpat('Make*.mak') | |
| 5861 < This is equivalent to: > | |
| 5862 if filename =~ '^Make.*\.mak$' | |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5863 < 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
|
5864 empty string. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5865 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
|
5866 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
|
5867 |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5868 Can also be used as a |method|: > |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5869 GetExpr()->glob2regpat() |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5870 < *globpath()* |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5871 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
5872 Perform glob() for {expr} on all directories in {path} and |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
5873 concatenate the results. Example: > |
| 7 | 5874 :echo globpath(&rtp, "syntax/c.vim") |
| 5873 | 5875 < |
| 5876 {path} is a comma-separated list of directory names. Each | |
| 7 | 5877 directory name is prepended to {expr} and expanded like with |
| 1754 | 5878 |glob()|. A path separator is inserted when needed. |
| 7 | 5879 To add a comma inside a directory name escape it with a |
| 5880 backslash. Note that on MS-Windows a directory may have a | |
| 5881 trailing backslash, remove it if you put a comma after it. | |
| 5882 If the expansion fails for one of the directories, there is no | |
| 5883 error message. | |
| 5873 | 5884 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5885 Unless the optional {nosuf} argument is given and is |TRUE|, |
| 1754 | 5886 the 'suffixes' and 'wildignore' options apply: Names matching |
| 5887 one of the patterns in 'wildignore' will be skipped and | |
| 5888 'suffixes' affect the ordering of matches. | |
| 7 | 5889 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5890 When {list} is present and it is |TRUE| the result is a List |
| 5873 | 5891 with all matching files. The advantage of using a List is, you |
| 5892 also get filenames containing newlines correctly. Otherwise | |
| 5893 the result is a String and when there are several matches, | |
| 5894 they are separated by <NL> characters. Example: > | |
| 5895 :echo globpath(&rtp, "syntax/c.vim", 0, 1) | |
| 5896 < | |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5897 {alllinks} is used as with |glob()|. |
| 6663 | 5898 |
| 444 | 5899 The "**" item can be used to search in a directory tree. |
| 5900 For example, to find all "README.txt" files in the directories | |
| 5901 in 'runtimepath' and below: > | |
| 5902 :echo globpath(&rtp, "**/README.txt") | |
| 1668 | 5903 < Upwards search and limiting the depth of "**" is not |
| 5904 supported, thus using 'path' will not always work properly. | |
| 5905 | |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5906 Can also be used as a |method|, the base is passed as the |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5907 second argument: > |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5908 GetExpr()->globpath(&rtp) |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
5909 < |
| 7 | 5910 *has()* |
|
19742
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
5911 has({feature} [, {check}]) |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
5912 When {check} is omitted or is zero: The result is a Number, |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
5913 which is 1 if the feature {feature} is supported, zero |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
5914 otherwise. The {feature} argument is a string, case is |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
5915 ignored. See |feature-list| below. |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
5916 |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
5917 When {check} is present and not zero: The result is a Number, |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
5918 which is 1 if the feature {feature} could ever be supported, |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
5919 zero otherwise. This is useful to check for a typo in |
| 19813 | 5920 {feature} and to detect dead code. Keep in mind that an older |
| 5921 Vim version will not know about a feature added later and | |
| 5922 features that have been abandoned will not be know by the | |
| 5923 current Vim version. | |
|
19742
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
5924 |
| 7 | 5925 Also see |exists()|. |
|
19742
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
5926 |
| 19646 | 5927 Note that to skip code that has a syntax error when the |
| 5928 feature is not available, Vim may skip the rest of the line | |
| 20241 | 5929 and miss a following `endif`. Therefore put the `endif` on a |
| 19646 | 5930 separate line: > |
| 5931 if has('feature') | |
| 5932 let x = this->breaks->without->the->feature | |
| 5933 endif | |
| 19721 | 5934 < If the `endif` would be moved to the second line as "| endif" it |
| 5935 would not be found. | |
| 7 | 5936 |
| 102 | 5937 |
| 5938 has_key({dict}, {key}) *has_key()* | |
| 685 | 5939 The result is a Number, which is 1 if |Dictionary| {dict} has |
| 5940 an entry with key {key}. Zero otherwise. | |
| 102 | 5941 |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
5942 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
5943 mydict->has_key(key) |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
5944 |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5945 haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()* |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5946 The result is a Number: |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5947 1 when the window has set a local directory via |:lcd| |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5948 2 when the tab-page has set a local directory via |:tcd| |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5949 0 otherwise. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5950 |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5951 Without arguments use the current window. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5952 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
|
5953 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
|
5954 page. |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
5955 {winnr} can be the window number or the |window-ID|. |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5956 If {winnr} is -1 it is ignored and only the tabpage is used. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5957 Return 0 if the arguments are invalid. |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5958 Examples: > |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5959 if haslocaldir() == 1 |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5960 " window local directory case |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5961 elseif haslocaldir() == 2 |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5962 " tab-local directory case |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5963 else |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5964 " global directory case |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5965 endif |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5966 |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5967 " current window |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5968 :echo haslocaldir() |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5969 :echo haslocaldir(0) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5970 :echo haslocaldir(0, 0) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5971 " window n in current tab page |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5972 :echo haslocaldir(n) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5973 :echo haslocaldir(n, 0) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5974 " window n in tab page m |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5975 :echo haslocaldir(n, m) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5976 " tab page m |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5977 :echo haslocaldir(-1, m) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5978 < |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
5979 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
5980 GetWinnr()->haslocaldir() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
5981 |
| 782 | 5982 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
| 7 | 5983 The result is a Number, which is 1 if there is a mapping that |
| 5984 contains {what} in somewhere in the rhs (what it is mapped to) | |
| 5985 and this mapping exists in one of the modes indicated by | |
| 5986 {mode}. | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5987 When {abbr} is there and it is |TRUE| use abbreviations |
| 786 | 5988 instead of mappings. Don't forget to specify Insert and/or |
| 5989 Command-line mode. | |
| 7 | 5990 Both the global mappings and the mappings local to the current |
| 5991 buffer are checked for a match. | |
| 5992 If no matching mapping is found 0 is returned. | |
| 5993 The following characters are recognized in {mode}: | |
| 5994 n Normal mode | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
5995 v Visual and Select mode |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
5996 x Visual mode |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
5997 s Select mode |
| 7 | 5998 o Operator-pending mode |
| 5999 i Insert mode | |
| 6000 l Language-Argument ("r", "f", "t", etc.) | |
| 6001 c Command-line mode | |
| 6002 When {mode} is omitted, "nvo" is used. | |
| 6003 | |
| 6004 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
|
6005 to a function in a Vim script. Example: > |
| 7 | 6006 :if !hasmapto('\ABCdoit') |
| 6007 : map <Leader>d \ABCdoit | |
| 6008 :endif | |
| 6009 < This installs the mapping to "\ABCdoit" only if there isn't | |
| 6010 already a mapping to "\ABCdoit". | |
| 6011 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6012 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6013 GetRHS()->hasmapto() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6014 |
| 7 | 6015 histadd({history}, {item}) *histadd()* |
| 6016 Add the String {item} to the history {history} which can be | |
| 6017 one of: *hist-names* | |
| 6018 "cmd" or ":" command line history | |
| 6019 "search" or "/" search pattern history | |
| 1621 | 6020 "expr" or "=" typed expression history |
| 7 | 6021 "input" or "@" input line history |
| 3682 | 6022 "debug" or ">" debug command history |
|
10228
8a1481e59d64
commit https://github.com/vim/vim/commit/3e496b0ea31996b665824f45664dee1fdd73c4d0
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
6023 empty the current or last used history |
| 3682 | 6024 The {history} string does not need to be the whole name, one |
| 6025 character is sufficient. | |
| 7 | 6026 If {item} does already exist in the history, it will be |
| 6027 shifted to become the newest entry. | |
| 6028 The result is a Number: 1 if the operation was successful, | |
| 6029 otherwise 0 is returned. | |
| 6030 | |
| 6031 Example: > | |
| 6032 :call histadd("input", strftime("%Y %b %d")) | |
| 6033 :let date=input("Enter date: ") | |
| 6034 < This function is not available in the |sandbox|. | |
| 6035 | |
| 18343 | 6036 Can also be used as a |method|, the base is passed as the |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6037 second argument: > |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
6038 GetHistory()->histadd('search') |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6039 |
| 7 | 6040 histdel({history} [, {item}]) *histdel()* |
| 236 | 6041 Clear {history}, i.e. delete all its entries. See |hist-names| |
| 7 | 6042 for the possible values of {history}. |
| 6043 | |
| 1668 | 6044 If the parameter {item} evaluates to a String, it is used as a |
| 6045 regular expression. All entries matching that expression will | |
| 6046 be removed from the history (if there are any). | |
| 7 | 6047 Upper/lowercase must match, unless "\c" is used |/\c|. |
| 1668 | 6048 If {item} evaluates to a Number, it will be interpreted as |
| 6049 an index, see |:history-indexing|. The respective entry will | |
| 6050 be removed if it exists. | |
| 7 | 6051 |
| 6052 The result is a Number: 1 for a successful operation, | |
| 6053 otherwise 0 is returned. | |
| 6054 | |
| 6055 Examples: | |
| 6056 Clear expression register history: > | |
| 6057 :call histdel("expr") | |
| 6058 < | |
| 6059 Remove all entries starting with "*" from the search history: > | |
| 6060 :call histdel("/", '^\*') | |
| 6061 < | |
| 6062 The following three are equivalent: > | |
| 6063 :call histdel("search", histnr("search")) | |
| 6064 :call histdel("search", -1) | |
| 6065 :call histdel("search", '^'.histget("search", -1).'$') | |
| 6066 < | |
| 6067 To delete the last search pattern and use the last-but-one for | |
| 6068 the "n" command and 'hlsearch': > | |
| 6069 :call histdel("search", -1) | |
| 6070 :let @/ = histget("search", -1) | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6071 < |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6072 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6073 GetHistory()->histdel() |
| 7 | 6074 |
| 6075 histget({history} [, {index}]) *histget()* | |
| 6076 The result is a String, the entry with Number {index} from | |
| 6077 {history}. See |hist-names| for the possible values of | |
| 6078 {history}, and |:history-indexing| for {index}. If there is | |
| 6079 no such entry, an empty String is returned. When {index} is | |
| 6080 omitted, the most recent item from the history is used. | |
| 6081 | |
| 6082 Examples: | |
| 6083 Redo the second last search from history. > | |
| 6084 :execute '/' . histget("search", -2) | |
| 6085 | |
| 6086 < Define an Ex command ":H {num}" that supports re-execution of | |
| 6087 the {num}th entry from the output of |:history|. > | |
| 6088 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
| 6089 < | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6090 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6091 GetHistory()->histget() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6092 |
| 7 | 6093 histnr({history}) *histnr()* |
| 6094 The result is the Number of the current entry in {history}. | |
| 6095 See |hist-names| for the possible values of {history}. | |
| 6096 If an error occurred, -1 is returned. | |
| 6097 | |
| 6098 Example: > | |
| 6099 :let inp_index = histnr("expr") | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6100 |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6101 < Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6102 GetHistory()->histnr() |
| 7 | 6103 < |
| 6104 hlexists({name}) *hlexists()* | |
| 6105 The result is a Number, which is non-zero if a highlight group | |
| 6106 called {name} exists. This is when the group has been | |
| 6107 defined in some way. Not necessarily when highlighting has | |
| 6108 been defined for it, it may also have been used for a syntax | |
| 6109 item. | |
| 6110 *highlight_exists()* | |
| 6111 Obsolete name: highlight_exists(). | |
| 6112 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6113 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6114 GetName()->hlexists() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6115 < |
| 7 | 6116 *hlID()* |
| 6117 hlID({name}) The result is a Number, which is the ID of the highlight group | |
| 6118 with name {name}. When the highlight group doesn't exist, | |
| 6119 zero is returned. | |
| 6120 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
|
6121 group. For example, to get the background color of the |
| 7 | 6122 "Comment" group: > |
| 6123 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
| 6124 < *highlightID()* | |
| 6125 Obsolete name: highlightID(). | |
| 6126 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6127 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6128 GetName()->hlID() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6129 |
| 7 | 6130 hostname() *hostname()* |
| 6131 The result is a String, which is the name of the machine on | |
| 236 | 6132 which Vim is currently running. Machine names greater than |
| 7 | 6133 256 characters long are truncated. |
| 6134 | |
| 6135 iconv({expr}, {from}, {to}) *iconv()* | |
| 6136 The result is a String, which is the text {expr} converted | |
| 6137 from encoding {from} to encoding {to}. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6138 When the conversion completely fails an empty string is |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6139 returned. When some characters could not be converted they |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6140 are replaced with "?". |
| 7 | 6141 The encoding names are whatever the iconv() library function |
| 6142 can accept, see ":!man 3 iconv". | |
| 6143 Most conversions require Vim to be compiled with the |+iconv| | |
| 6144 feature. Otherwise only UTF-8 to latin1 conversion and back | |
| 6145 can be done. | |
| 6146 This can be used to display messages with special characters, | |
| 6147 no matter what 'encoding' is set to. Write the message in | |
| 6148 UTF-8 and use: > | |
| 6149 echo iconv(utf8_str, "utf-8", &enc) | |
| 6150 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
| 6151 from/to UCS-2 is automatically changed to use UTF-8. You | |
| 6152 cannot use UCS-2 in a string anyway, because of the NUL bytes. | |
| 6153 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6154 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6155 GetText()->iconv('latin1', 'utf-8') |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6156 < |
| 7 | 6157 *indent()* |
| 6158 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
| 6159 current buffer. The indent is counted in spaces, the value | |
| 6160 of 'tabstop' is relevant. {lnum} is used just like in | |
| 6161 |getline()|. | |
| 6162 When {lnum} is invalid -1 is returned. | |
| 6163 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6164 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6165 GetLnum()->indent() |
| 79 | 6166 |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6167 index({object}, {expr} [, {start} [, {ic}]]) *index()* |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6168 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
|
6169 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
|
6170 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
|
6171 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
|
6172 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
|
6173 |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6174 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
|
6175 value is equal to {expr}. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6176 |
| 153 | 6177 If {start} is given then start looking at the item with index |
| 6178 {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
|
6179 When {ic} is given and it is |TRUE|, ignore case. Otherwise |
| 79 | 6180 case must match. |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6181 -1 is returned when {expr} is not found in {object}. |
| 79 | 6182 Example: > |
| 6183 :let idx = index(words, "the") | |
| 87 | 6184 :if index(numbers, 123) >= 0 |
| 79 | 6185 |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6186 < Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6187 GetObject()->index(what) |
| 79 | 6188 |
| 531 | 6189 input({prompt} [, {text} [, {completion}]]) *input()* |
| 7 | 6190 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
|
6191 the command-line. The {prompt} argument is either a prompt |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6192 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
|
6193 in the prompt to start a new line. |
| 531 | 6194 The highlighting set with |:echohl| is used for the prompt. |
| 6195 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
|
6196 editing commands and mappings. There is a separate history |
| 531 | 6197 for lines typed for input(). |
| 6198 Example: > | |
| 6199 :if input("Coffee or beer? ") == "beer" | |
| 6200 : echo "Cheers!" | |
| 6201 :endif | |
| 6202 < | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6203 If the optional {text} argument is present and not empty, this |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6204 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
|
6205 Example: > |
| 531 | 6206 :let color = input("Color? ", "white") |
| 6207 | |
| 6208 < The optional {completion} argument specifies the type of | |
| 6209 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
|
6210 not performed. The supported completion types are the same as |
| 531 | 6211 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
|
6212 "-complete=" argument. Refer to |:command-completion| for |
| 531 | 6213 more information. Example: > |
| 6214 let fname = input("File: ", "", "file") | |
| 6215 < | |
| 6216 NOTE: This function must not be used in a startup file, for | |
| 6217 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
| 7 | 6218 Note: When input() is called from within a mapping it will |
| 6219 consume remaining characters from that mapping, because a | |
| 6220 mapping is handled like the characters were typed. | |
| 6221 Use |inputsave()| before input() and |inputrestore()| | |
| 6222 after input() to avoid that. Another solution is to avoid | |
| 6223 that further characters follow in the mapping, e.g., by using | |
| 6224 |:execute| or |:normal|. | |
| 6225 | |
| 531 | 6226 Example with a mapping: > |
| 7 | 6227 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
| 6228 :function GetFoo() | |
| 6229 : call inputsave() | |
| 6230 : let g:Foo = input("enter search pattern: ") | |
| 6231 : call inputrestore() | |
| 6232 :endfunction | |
| 6233 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6234 < Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6235 GetPrompt()->input() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6236 |
| 7 | 6237 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6238 Like |input()|, but when the GUI is running and text dialogs |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6239 are supported, a dialog window pops up to input the text. |
| 7 | 6240 Example: > |
| 3875 | 6241 :let n = inputdialog("value for shiftwidth", shiftwidth()) |
| 6242 :if n != "" | |
| 6243 : let &sw = n | |
| 6244 :endif | |
| 7 | 6245 < When the dialog is cancelled {cancelreturn} is returned. When |
| 6246 omitted an empty string is returned. | |
| 6247 Hitting <Enter> works like pressing the OK button. Hitting | |
| 6248 <Esc> works like pressing the Cancel button. | |
| 531 | 6249 NOTE: Command-line completion is not supported. |
| 7 | 6250 |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6251 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6252 GetPrompt()->inputdialog() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6253 |
| 519 | 6254 inputlist({textlist}) *inputlist()* |
| 819 | 6255 {textlist} must be a |List| of strings. This |List| is |
| 6256 displayed, one string per line. The user will be prompted to | |
| 6257 enter a number, which is returned. | |
| 519 | 6258 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
|
6259 mouse. For the first string 0 is returned. When clicking |
| 519 | 6260 above the first item a negative number is returned. When |
| 6261 clicking on the prompt one more than the length of {textlist} | |
| 6262 is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6263 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
|
6264 it won't work. It's a good idea to put the entry number at |
| 1156 | 6265 the start of the string. And put a prompt in the first item. |
| 6266 Example: > | |
| 519 | 6267 let color = inputlist(['Select color:', '1. red', |
| 6268 \ '2. green', '3. blue']) | |
| 6269 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6270 < Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6271 GetChoices()->inputlist() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6272 |
| 7 | 6273 inputrestore() *inputrestore()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6274 Restore typeahead that was saved with a previous |inputsave()|. |
| 7 | 6275 Should be called the same number of times inputsave() is |
| 6276 called. Calling it more often is harmless though. | |
| 6277 Returns 1 when there is nothing to restore, 0 otherwise. | |
| 6278 | |
| 6279 inputsave() *inputsave()* | |
| 6280 Preserve typeahead (also from mappings) and clear it, so that | |
| 6281 a following prompt gets input from the user. Should be | |
| 6282 followed by a matching inputrestore() after the prompt. Can | |
| 6283 be used several times, in which case there must be just as | |
| 6284 many inputrestore() calls. | |
| 6285 Returns 1 when out of memory, 0 otherwise. | |
| 6286 | |
| 6287 inputsecret({prompt} [, {text}]) *inputsecret()* | |
| 6288 This function acts much like the |input()| function with but | |
| 6289 two exceptions: | |
| 6290 a) the user's response will be displayed as a sequence of | |
| 6291 asterisks ("*") thereby keeping the entry secret, and | |
| 6292 b) the user's response will not be recorded on the input | |
| 6293 |history| stack. | |
| 6294 The result is a String, which is whatever the user actually | |
| 6295 typed on the command-line in response to the issued prompt. | |
| 531 | 6296 NOTE: Command-line completion is not supported. |
| 7 | 6297 |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6298 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6299 GetPrompt()->inputsecret() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6300 |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6301 insert({object}, {item} [, {idx}]) *insert()* |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6302 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
|
6303 of it. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6304 |
| 55 | 6305 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
|
6306 {idx}. If {idx} is zero it goes before the first item, just |
| 55 | 6307 like omitting {idx}. A negative {idx} is also possible, see |
| 6308 |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
|
6309 |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6310 Returns the resulting |List| or |Blob|. Examples: > |
| 55 | 6311 :let mylist = insert([2, 3, 5], 1) |
| 6312 :call insert(mylist, 4, -1) | |
| 6313 :call insert(mylist, 6, len(mylist)) | |
| 82 | 6314 < The last example can be done simpler with |add()|. |
| 685 | 6315 Note that when {item} is a |List| it is inserted as a single |
| 692 | 6316 item. Use |extend()| to concatenate |Lists|. |
| 55 | 6317 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6318 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6319 mylist->insert(item) |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6320 |
|
18699
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6321 interrupt() *interrupt()* |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6322 Interrupt script execution. It works more or less like the |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6323 user typing CTRL-C, most commands won't execute and control |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6324 returns to the user. This is useful to abort execution |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6325 from lower down, e.g. in an autocommand. Example: > |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6326 :function s:check_typoname(file) |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6327 : if fnamemodify(a:file, ':t') == '[' |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6328 : echomsg 'Maybe typo' |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6329 : call interrupt() |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6330 : endif |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6331 :endfunction |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6332 :au BufWritePre * call s:check_typoname(expand('<amatch>')) |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6333 |
| 3214 | 6334 invert({expr}) *invert()* |
| 6335 Bitwise invert. The argument is converted to a number. A | |
| 6336 List, Dict or Float argument causes an error. Example: > | |
| 6337 :let bits = invert(bits) | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
6338 < Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
6339 :let bits = bits->invert() |
| 3214 | 6340 |
| 7 | 6341 isdirectory({directory}) *isdirectory()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6342 The result is a Number, which is |TRUE| when a directory |
| 7 | 6343 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
|
6344 exist, or isn't a directory, the result is |FALSE|. {directory} |
| 7 | 6345 is any expression, which is used as a String. |
| 6346 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6347 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6348 GetName()->isdirectory() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6349 |
|
16213
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6350 isinf({expr}) *isinf()* |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6351 Return 1 if {expr} is a positive infinity, or -1 a negative |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6352 infinity, otherwise 0. > |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6353 :echo isinf(1.0 / 0.0) |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6354 < 1 > |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6355 :echo isinf(-1.0 / 0.0) |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6356 < -1 |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6357 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6358 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6359 Compute()->isinf() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6360 < |
|
16213
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6361 {only available when compiled with the |+float| feature} |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6362 |
| 819 | 6363 islocked({expr}) *islocked()* *E786* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6364 The result is a Number, which is |TRUE| when {expr} is the |
| 148 | 6365 name of a locked variable. |
| 685 | 6366 {expr} must be the name of a variable, |List| item or |
| 6367 |Dictionary| entry, not the variable itself! Example: > | |
| 148 | 6368 :let alist = [0, ['a', 'b'], 2, 3] |
| 6369 :lockvar 1 alist | |
| 6370 :echo islocked('alist') " 1 | |
| 6371 :echo islocked('alist[1]') " 0 | |
| 6372 | |
| 6373 < When {expr} is a variable that does not exist you get an error | |
| 843 | 6374 message. Use |exists()| to check for existence. |
| 148 | 6375 |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6376 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6377 GetName()->islocked() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6378 |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
6379 isnan({expr}) *isnan()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6380 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
|
6381 echo isnan(0.0 / 0.0) |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
6382 < 1 |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
6383 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6384 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6385 Compute()->isnan() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6386 < |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
6387 {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
|
6388 |
| 140 | 6389 items({dict}) *items()* |
| 685 | 6390 Return a |List| with all the key-value pairs of {dict}. Each |
| 6391 |List| item is a list with two items: the key of a {dict} | |
| 6392 entry and the value of this entry. The |List| is in arbitrary | |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6393 order. Also see |keys()| and |values()|. |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6394 Example: > |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6395 for [key, value] in items(mydict) |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6396 echo key . ': ' . value |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6397 endfor |
| 140 | 6398 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6399 < Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6400 mydict->items() |
|
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
6401 |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
6402 job_ functions are documented here: |job-functions-details| |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
6403 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
6404 |
| 95 | 6405 join({list} [, {sep}]) *join()* |
| 6406 Join the items in {list} together into one String. | |
| 6407 When {sep} is specified it is put in between the items. If | |
| 6408 {sep} is omitted a single space is used. | |
| 6409 Note that {sep} is not added at the end. You might want to | |
| 6410 add it there too: > | |
| 6411 let lines = join(mylist, "\n") . "\n" | |
| 692 | 6412 < String items are used as-is. |Lists| and |Dictionaries| are |
| 95 | 6413 converted into a string like with |string()|. |
| 6414 The opposite function is |split()|. | |
| 6415 | |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6416 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6417 mylist->join() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6418 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6419 js_decode({string}) *js_decode()* |
|
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6420 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
|
6421 - 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
|
6422 - 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
|
6423 - 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
|
6424 result in v:none items. |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6425 |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6426 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6427 ReadObject()->js_decode() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6428 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6429 js_encode({expr}) *js_encode()* |
|
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6430 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
|
6431 - 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
|
6432 - 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
|
6433 commas. |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6434 For example, the Vim object: |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6435 [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
|
6436 Will be encoded as: |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6437 [1,,{one:1},,] ~ |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6438 While json_encode() would produce: |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6439 [1,null,{"one":1},null] ~ |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6440 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
|
6441 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
|
6442 |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6443 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6444 GetObject()->js_encode() |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6445 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6446 json_decode({string}) *json_decode()* |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6447 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
|
6448 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
|
6449 JSON and Vim values. |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6450 The decoding is permissive: |
| 11347 | 6451 - A trailing comma in an array and object is ignored, e.g. |
| 6452 "[1, 2, ]" is the same as "[1, 2]". | |
| 15512 | 6453 - Integer keys are accepted in objects, e.g. {1:2} is the |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6454 same as {"1":2}. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6455 - More floating point numbers are recognized, e.g. "1." for |
| 11347 | 6456 "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
|
6457 "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
|
6458 are accepted. |
| 11347 | 6459 - Leading zeroes in integer numbers are ignored, e.g. "012" |
| 6460 for "12" or "-012" for "-12". | |
| 6461 - Capitalization is ignored in literal names null, true or | |
| 6462 false, e.g. "NULL" for "null", "True" for "true". | |
| 6463 - Control characters U+0000 through U+001F which are not | |
| 6464 escaped in strings are accepted, e.g. " " (tab | |
| 6465 character in string) for "\t". | |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6466 - An empty JSON expression or made of only spaces is accepted |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6467 and results in v:none. |
| 11347 | 6468 - Backslash in an invalid 2-character sequence escape is |
| 6469 ignored, e.g. "\a" is decoded as "a". | |
| 6470 - A correct surrogate pair in JSON strings should normally be | |
| 6471 a 12 character sequence such as "\uD834\uDD1E", but | |
| 6472 json_decode() silently accepts truncated surrogate pairs | |
| 6473 such as "\uD834" or "\uD834\u" | |
| 6474 *E938* | |
| 6475 A duplicate key in an object, valid in rfc7159, is not | |
| 6476 accepted by json_decode() as the result must be a valid Vim | |
| 6477 type, e.g. this fails: {"a":"b", "a":"c"} | |
| 6478 | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6479 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6480 ReadObject()->json_decode() |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
6481 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6482 json_encode({expr}) *json_encode()* |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6483 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
|
6484 The encoding is specified in: |
|
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
6485 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
|
6486 Vim values are converted as follows: |
| 15512 | 6487 |Number| decimal number |
| 6488 |Float| floating point number | |
|
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
6489 Float nan "NaN" |
|
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
6490 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
|
6491 Float -inf "-Infinity" |
| 15512 | 6492 |String| in double quotes (possibly null) |
| 6493 |Funcref| not possible, error | |
| 6494 |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
|
6495 used recursively: [] |
| 15512 | 6496 |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
|
6497 used recursively: {} |
| 15512 | 6498 |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
|
6499 v:false "false" |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
6500 v:true "true" |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6501 v:none "null" |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
6502 v:null "null" |
|
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
6503 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
|
6504 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
|
6505 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
|
6506 |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6507 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6508 GetObject()->json_encode() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6509 |
| 99 | 6510 keys({dict}) *keys()* |
| 685 | 6511 Return a |List| with all the keys of {dict}. The |List| is in |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6512 arbitrary order. Also see |items()| and |values()|. |
| 99 | 6513 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6514 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6515 mydict->keys() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6516 |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6517 < *len()* *E701* |
| 55 | 6518 len({expr}) The result is a Number, which is the length of the argument. |
| 6519 When {expr} is a String or a Number the length in bytes is | |
| 6520 used, as with |strlen()|. | |
| 685 | 6521 When {expr} is a |List| the number of items in the |List| is |
| 55 | 6522 returned. |
| 15512 | 6523 When {expr} is a |Blob| the number of bytes is returned. |
| 685 | 6524 When {expr} is a |Dictionary| the number of entries in the |
| 6525 |Dictionary| is returned. | |
| 55 | 6526 Otherwise an error is given. |
| 6527 | |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6528 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6529 mylist->len() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6530 |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6531 < *libcall()* *E364* *E368* |
| 7 | 6532 libcall({libname}, {funcname}, {argument}) |
| 6533 Call function {funcname} in the run-time library {libname} | |
| 6534 with single argument {argument}. | |
| 6535 This is useful to call functions in a library that you | |
| 6536 especially made to be used with Vim. Since only one argument | |
| 6537 is possible, calling standard library functions is rather | |
| 6538 limited. | |
| 6539 The result is the String returned by the function. If the | |
| 6540 function returns NULL, this will appear as an empty string "" | |
| 6541 to Vim. | |
| 6542 If the function returns a number, use libcallnr()! | |
| 6543 If {argument} is a number, it is passed to the function as an | |
| 6544 int; if {argument} is a string, it is passed as a | |
| 6545 null-terminated string. | |
| 6546 This function will fail in |restricted-mode|. | |
| 6547 | |
| 6548 libcall() allows you to write your own 'plug-in' extensions to | |
| 6549 Vim without having to recompile the program. It is NOT a | |
| 6550 means to call system functions! If you try to do so Vim will | |
| 6551 very probably crash. | |
| 6552 | |
| 6553 For Win32, the functions you write must be placed in a DLL | |
| 6554 and use the normal C calling convention (NOT Pascal which is | |
| 6555 used in Windows System DLLs). The function must take exactly | |
| 6556 one parameter, either a character pointer or a long integer, | |
| 6557 and must return a character pointer or NULL. The character | |
| 6558 pointer returned must point to memory that will remain valid | |
| 6559 after the function has returned (e.g. in static data in the | |
| 6560 DLL). If it points to allocated memory, that memory will | |
| 6561 leak away. Using a static buffer in the function should work, | |
| 6562 it's then freed when the DLL is unloaded. | |
| 6563 | |
| 6564 WARNING: If the function returns a non-valid pointer, Vim may | |
| 1621 | 6565 crash! This also happens if the function returns a number, |
| 7 | 6566 because Vim thinks it's a pointer. |
| 6567 For Win32 systems, {libname} should be the filename of the DLL | |
| 6568 without the ".DLL" suffix. A full path is only required if | |
| 6569 the DLL is not in the usual places. | |
| 6570 For Unix: When compiling your own plugins, remember that the | |
| 6571 object code must be compiled as position-independent ('PIC'). | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6572 {only in Win32 and some Unix versions, when the |+libcall| |
| 7 | 6573 feature is present} |
| 6574 Examples: > | |
| 6575 :echo libcall("libc.so", "getenv", "HOME") | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6576 |
| 18343 | 6577 < Can also be used as a |method|, the base is passed as the |
| 6578 third argument: > | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6579 GetValue()->libcall("libc.so", "getenv") |
| 7 | 6580 < |
| 6581 *libcallnr()* | |
| 6582 libcallnr({libname}, {funcname}, {argument}) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6583 Just like |libcall()|, but used for a function that returns an |
| 7 | 6584 int instead of a string. |
| 6585 {only in Win32 on some Unix versions, when the |+libcall| | |
| 6586 feature is present} | |
| 1621 | 6587 Examples: > |
| 6588 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
| 7 | 6589 :call libcallnr("libc.so", "printf", "Hello World!\n") |
| 6590 :call libcallnr("libc.so", "sleep", 10) | |
| 6591 < | |
| 18343 | 6592 Can also be used as a |method|, the base is passed as the |
| 6593 third argument: > | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6594 GetValue()->libcallnr("libc.so", "printf") |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6595 < |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6596 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6597 line({expr} [, {winid}]) *line()* |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6598 The result is a Number, which is the line number of the file |
| 7 | 6599 position given with {expr}. The accepted positions are: |
| 6600 . the cursor position | |
| 6601 $ the last line in the current buffer | |
| 6602 'x position of mark x (if the mark is not set, 0 is | |
| 6603 returned) | |
|
11313
327a04a762f6
patch 8.0.0542: getpos() can return a negative line number
Christian Brabandt <cb@256bit.org>
parents:
11263
diff
changeset
|
6604 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
|
6605 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
|
6606 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
|
6607 less than "w0" if no lines are visible) |
| 1609 | 6608 v In Visual mode: the start of the Visual area (the |
| 6609 cursor is the end). When not in Visual mode | |
| 6610 returns the cursor position. Differs from |'<| in | |
| 6611 that it's updated right away. | |
| 1156 | 6612 Note that a mark in another file can be used. The line number |
| 6613 then applies to another buffer. | |
| 703 | 6614 To get the column number use |col()|. To get both use |
| 6615 |getpos()|. | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6616 With the optional {winid} argument the values are obtained for |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6617 that window instead of the current window. |
| 7 | 6618 Examples: > |
| 6619 line(".") line number of the cursor | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6620 line(".", winid) idem, in window "winid" |
| 7 | 6621 line("'t") line number of mark t |
| 6622 line("'" . marker) line number of mark marker | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
6623 < |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
6624 To jump to the last known position when opening a file see |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
6625 |last-position-jump|. |
| 9 | 6626 |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6627 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6628 GetValue()->line() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6629 |
| 7 | 6630 line2byte({lnum}) *line2byte()* |
| 6631 Return the byte count from the start of the buffer for line | |
| 6632 {lnum}. This includes the end-of-line character, depending on | |
| 6633 the 'fileformat' option for the current buffer. The first | |
| 3237 | 6634 line returns 1. 'encoding' matters, 'fileencoding' is ignored. |
| 7 | 6635 This can also be used to get the byte count for the line just |
| 6636 below the last line: > | |
| 6637 line2byte(line("$") + 1) | |
| 3237 | 6638 < This is the buffer size plus one. If 'fileencoding' is empty |
| 6639 it is the file size plus one. | |
| 7 | 6640 When {lnum} is invalid, or the |+byte_offset| feature has been |
| 6641 disabled at compile time, -1 is returned. | |
| 6642 Also see |byte2line()|, |go| and |:goto|. | |
| 6643 | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6644 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6645 GetLnum()->line2byte() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6646 |
| 7 | 6647 lispindent({lnum}) *lispindent()* |
| 6648 Get the amount of indent for line {lnum} according the lisp | |
| 6649 indenting rules, as with 'lisp'. | |
| 6650 The indent is counted in spaces, the value of 'tabstop' is | |
| 6651 relevant. {lnum} is used just like in |getline()|. | |
| 6652 When {lnum} is invalid or Vim was not compiled the | |
| 6653 |+lispindent| feature, -1 is returned. | |
| 6654 | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6655 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6656 GetLnum()->lispindent() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6657 |
|
16235
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6658 list2str({list} [, {utf8}]) *list2str()* |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6659 Convert each number in {list} to a character string can |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6660 concatenate them all. Examples: > |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6661 list2str([32]) returns " " |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6662 list2str([65, 66, 67]) returns "ABC" |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6663 < The same can be done (slowly) with: > |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6664 join(map(list, {nr, val -> nr2char(val)}), '') |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6665 < |str2list()| does the opposite. |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6666 |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6667 When {utf8} is omitted or zero, the current 'encoding' is used. |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6668 With {utf8} is 1, always return utf-8 characters. |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6669 With utf-8 composing characters work as expected: > |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6670 list2str([97, 769]) returns "á" |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6671 < |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6672 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6673 GetList()->list2str() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6674 |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6675 listener_add({callback} [, {buf}]) *listener_add()* |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6676 Add a callback function that will be invoked when changes have |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6677 been made to buffer {buf}. |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6678 {buf} refers to a buffer name or number. For the accepted |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6679 values, see |bufname()|. When {buf} is omitted the current |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6680 buffer is used. |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6681 Returns a unique ID that can be passed to |listener_remove()|. |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6682 |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
6683 The {callback} is invoked with five arguments: |
|
16660
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6684 a:bufnr the buffer that was changed |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6685 a:start first changed line number |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6686 a:end first line number below the change |
| 18456 | 6687 a:added number of lines added, negative if lines were |
| 6688 deleted | |
|
16660
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6689 a:changes a List of items with details about the changes |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6690 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6691 Example: > |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6692 func Listener(bufnr, start, end, added, changes) |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6693 echo 'lines ' .. a:start .. ' until ' .. a:end .. ' changed' |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6694 endfunc |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6695 call listener_add('Listener', bufnr) |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6696 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6697 < The List cannot be changed. Each item in a:changes is a |
|
16648
a7f06505ad39
patch 8.1.1326: no test for listener with partial
Bram Moolenaar <Bram@vim.org>
parents:
16638
diff
changeset
|
6698 dictionary with these entries: |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6699 lnum the first line number of the change |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6700 end the first line below the change |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6701 added number of lines added; negative if lines were |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6702 deleted |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6703 col first column in "lnum" that was affected by |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6704 the change; one if unknown or the whole line |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6705 was affected; this is a byte index, first |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6706 character has a value of one. |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6707 When lines are inserted the values are: |
| 16808 | 6708 lnum line above which the new line is added |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6709 end equal to "lnum" |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6710 added number of lines inserted |
|
16660
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6711 col 1 |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6712 When lines are deleted the values are: |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6713 lnum the first deleted line |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6714 end the line below the first deleted line, before |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6715 the deletion was done |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6716 added negative, number of lines deleted |
|
16660
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6717 col 1 |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6718 When lines are changed: |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6719 lnum the first changed line |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6720 end the line below the last changed line |
|
16660
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6721 added 0 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6722 col first column with a change or 1 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6723 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6724 The entries are in the order the changes were made, thus the |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6725 most recent change is at the end. The line numbers are valid |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6726 when the callback is invoked, but later changes may make them |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6727 invalid, thus keeping a copy for later might not work. |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6728 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6729 The {callback} is invoked just before the screen is updated, |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6730 when |listener_flush()| is called or when a change is being |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6731 made that changes the line count in a way it causes a line |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6732 number in the list of changes to become invalid. |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6733 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6734 The {callback} is invoked with the text locked, see |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6735 |textlock|. If you do need to make changes to the buffer, use |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6736 a timer to do this later |timer_start()|. |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6737 |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6738 The {callback} is not invoked when the buffer is first loaded. |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6739 Use the |BufReadPost| autocmd event to handle the initial text |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6740 of a buffer. |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6741 The {callback} is also not invoked when the buffer is |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6742 unloaded, use the |BufUnload| autocmd event for that. |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6743 |
| 18343 | 6744 Can also be used as a |method|, the base is passed as the |
| 6745 second argument: > | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6746 GetBuffer()->listener_add(callback) |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6747 |
|
16660
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6748 listener_flush([{buf}]) *listener_flush()* |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6749 Invoke listener callbacks for buffer {buf}. If there are no |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6750 pending changes then no callbacks are invoked. |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6751 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6752 {buf} refers to a buffer name or number. For the accepted |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6753 values, see |bufname()|. When {buf} is omitted the current |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6754 buffer is used. |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
6755 |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6756 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6757 GetBuffer()->listener_flush() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6758 |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6759 listener_remove({id}) *listener_remove()* |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6760 Remove a listener previously added with listener_add(). |
|
17366
9843fbfa0ee5
patch 8.1.1682: placing a larger number of signs is slow
Bram Moolenaar <Bram@vim.org>
parents:
17292
diff
changeset
|
6761 Returns zero when {id} could not be found, one when {id} was |
|
9843fbfa0ee5
patch 8.1.1682: placing a larger number of signs is slow
Bram Moolenaar <Bram@vim.org>
parents:
17292
diff
changeset
|
6762 removed. |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
6763 |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6764 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6765 GetListenerId()->listener_remove() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6766 |
| 7 | 6767 localtime() *localtime()* |
| 6768 Return the current time, measured as seconds since 1st Jan | |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
6769 1970. See also |strftime()|, |strptime()| and |getftime()|. |
| 7 | 6770 |
| 95 | 6771 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6772 log({expr}) *log()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6773 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
|
6774 {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
|
6775 (0, inf]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6776 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6777 :echo log(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6778 < 2.302585 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6779 :echo log(exp(5)) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6780 < 5.0 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6781 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6782 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6783 Compute()->log() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6784 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
6785 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6786 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6787 |
| 1621 | 6788 log10({expr}) *log10()* |
| 6789 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
| 6790 {expr} must evaluate to a |Float| or a |Number|. | |
| 6791 Examples: > | |
| 6792 :echo log10(1000) | |
| 6793 < 3.0 > | |
| 6794 :echo log10(0.01) | |
| 6795 < -2.0 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6796 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6797 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6798 Compute()->log10() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6799 < |
| 1621 | 6800 {only available when compiled with the |+float| feature} |
| 12785 | 6801 |
| 6802 luaeval({expr} [, {expr}]) *luaeval()* | |
| 6803 Evaluate Lua expression {expr} and return its result converted | |
| 6804 to Vim data structures. Second {expr} may hold additional | |
| 3492 | 6805 argument accessible as _A inside first {expr}. |
| 6806 Strings are returned as they are. | |
| 6807 Boolean objects are converted to numbers. | |
| 12785 | 6808 Numbers are converted to |Float| values if vim was compiled |
| 3492 | 6809 with |+float| and to numbers otherwise. |
| 12785 | 6810 Dictionaries and lists obtained by vim.eval() are returned |
| 3492 | 6811 as-is. |
| 6812 Other objects are returned as zero without any errors. | |
| 6813 See |lua-luaeval| for more details. | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6814 |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6815 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6816 GetExpr()->luaeval() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6817 |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6818 < {only available when compiled with the |+lua| feature} |
| 3492 | 6819 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6820 map({expr1}, {expr2}) *map()* |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6821 {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
|
6822 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
|
6823 {expr2}. {expr2} must be a |string| or |Funcref|. |
| 12785 | 6824 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6825 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
|
6826 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
|
6827 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
|
6828 the current item. |
| 102 | 6829 Example: > |
| 6830 :call map(mylist, '"> " . v:val . " <"') | |
| 95 | 6831 < This puts "> " before and " <" after each item in "mylist". |
| 102 | 6832 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6833 Note that {expr2} is the result of an expression and is then |
| 102 | 6834 used as an expression again. Often it is good to use a |
| 158 | 6835 |literal-string| to avoid having to double backslashes. You |
| 6836 still have to double ' quotes | |
| 102 | 6837 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6838 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
|
6839 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
|
6840 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
|
6841 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
|
6842 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
|
6843 func KeyValue(key, val) |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6844 return a:key . '-' . a:val |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6845 endfunc |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6846 call map(myDict, function('KeyValue')) |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
6847 < 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
|
6848 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
|
6849 < 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
|
6850 call map(myDict, {key -> 'item: ' . key}) |
| 17667 | 6851 < If you do not use "key" you can use a short name: > |
| 6852 call map(myDict, {_, val -> 'item: ' . val}) | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6853 < |
| 685 | 6854 The operation is done in-place. If you want a |List| or |
| 6855 |Dictionary| to remain unmodified make a copy first: > | |
| 3682 | 6856 :let tlist = map(copy(mylist), ' v:val . "\t"') |
| 102 | 6857 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6858 < 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
|
6859 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
|
6860 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
|
6861 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
|
6862 defined with the "abort" flag. |
| 95 | 6863 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6864 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6865 mylist->map(expr2) |
| 95 | 6866 |
|
20506
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
6867 |
| 12785 | 6868 maparg({name} [, {mode} [, {abbr} [, {dict}]]]) *maparg()* |
| 2610 | 6869 When {dict} is omitted or zero: Return the rhs of mapping |
| 6870 {name} in mode {mode}. The returned String has special | |
| 6871 characters translated like in the output of the ":map" command | |
| 6872 listing. | |
| 12785 | 6873 |
| 2610 | 6874 When there is no mapping for {name}, an empty String is |
| 14006 | 6875 returned. When the mapping for {name} is empty, then "<Nop>" |
| 6876 is returned. | |
| 2610 | 6877 |
| 6878 The {name} can have special key names, like in the ":map" | |
| 6879 command. | |
| 6880 | |
| 644 | 6881 {mode} can be one of these strings: |
| 7 | 6882 "n" Normal |
| 2610 | 6883 "v" Visual (including Select) |
| 7 | 6884 "o" Operator-pending |
| 6885 "i" Insert | |
| 6886 "c" Cmd-line | |
| 2610 | 6887 "s" Select |
| 6888 "x" Visual | |
| 7 | 6889 "l" langmap |language-mapping| |
| 12499 | 6890 "t" Terminal-Job |
| 7 | 6891 "" Normal, Visual and Operator-pending |
| 644 | 6892 When {mode} is omitted, the modes for "" are used. |
| 2610 | 6893 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6894 When {abbr} is there and it is |TRUE| use abbreviations |
| 782 | 6895 instead of mappings. |
| 2610 | 6896 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6897 When {dict} is there and it is |TRUE| return a dictionary |
| 2610 | 6898 containing all the information of the mapping with the |
| 6899 following items: | |
|
20522
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
6900 "lhs" The {lhs} of the mapping as it would be typed |
|
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
6901 "lhsraw" The {lhs} of the mapping as raw bytes |
|
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
6902 "lhsrawalt" The {lhs} of the mapping as raw bytes, alternate |
|
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
6903 form, only present when it differs from "lhsraw" |
| 2610 | 6904 "rhs" The {rhs} of the mapping as typed. |
| 6905 "silent" 1 for a |:map-silent| mapping, else 0. | |
| 2625 | 6906 "noremap" 1 if the {rhs} of the mapping is not remappable. |
|
19870
658248b68f7c
patch 8.2.0491: cannot recognize a <script> mapping using maparg()
Bram Moolenaar <Bram@vim.org>
parents:
19813
diff
changeset
|
6907 "script" 1 if mapping was defined with <script>. |
| 2610 | 6908 "expr" 1 for an expression mapping (|:map-<expr>|). |
| 6909 "buffer" 1 for a buffer local mapping (|:map-local|). | |
| 6910 "mode" Modes for which the mapping is defined. In | |
| 6911 addition to the modes mentioned above, these | |
| 6912 characters will be used: | |
| 6913 " " Normal, Visual and Operator-pending | |
| 6914 "!" Insert and Commandline mode | |
| 2642 | 6915 (|mapmode-ic|) |
| 2625 | 6916 "sid" The script local ID, used for <sid> mappings |
| 6917 (|<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
|
6918 "lnum" The line number in "sid", zero if unknown. |
| 5555 | 6919 "nowait" Do not wait for other, longer mappings. |
| 6920 (|:map-<nowait>|). | |
|
20506
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
6921 |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
6922 The dictionary can be used to restore a mapping with |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
6923 |mapset()|. |
| 2610 | 6924 |
| 7 | 6925 The mappings local to the current buffer are checked first, |
| 6926 then the global mappings. | |
| 626 | 6927 This function can be used to map a key even when it's already |
| 6928 mapped, and have it do the original mapping too. Sketch: > | |
| 6929 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
| 6930 | |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
6931 < Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
6932 GetKey()->maparg('n') |
| 7 | 6933 |
| 12785 | 6934 mapcheck({name} [, {mode} [, {abbr}]]) *mapcheck()* |
| 7 | 6935 Check if there is a mapping that matches with {name} in mode |
| 6936 {mode}. See |maparg()| for {mode} and special names in | |
| 6937 {name}. | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6938 When {abbr} is there and it is |TRUE| use abbreviations |
| 782 | 6939 instead of mappings. |
| 7 | 6940 A match happens with a mapping that starts with {name} and |
| 6941 with a mapping which is equal to the start of {name}. | |
| 6942 | |
| 1621 | 6943 matches mapping "a" "ab" "abc" ~ |
| 7 | 6944 mapcheck("a") yes yes yes |
| 6945 mapcheck("abc") yes yes yes | |
| 6946 mapcheck("ax") yes no no | |
| 6947 mapcheck("b") no no no | |
| 6948 | |
| 6949 The difference with maparg() is that mapcheck() finds a | |
| 6950 mapping that matches with {name}, while maparg() only finds a | |
| 6951 mapping for {name} exactly. | |
| 6952 When there is no mapping that starts with {name}, an empty | |
| 14006 | 6953 String is returned. If there is one, the RHS of that mapping |
| 7 | 6954 is returned. If there are several mappings that start with |
| 14006 | 6955 {name}, the RHS of one of them is returned. This will be |
| 6956 "<Nop>" if the RHS is empty. | |
| 7 | 6957 The mappings local to the current buffer are checked first, |
| 6958 then the global mappings. | |
| 6959 This function can be used to check if a mapping can be added | |
| 6960 without being ambiguous. Example: > | |
| 6961 :if mapcheck("_vv") == "" | |
| 6962 : map _vv :set guifont=7x13<CR> | |
| 6963 :endif | |
| 6964 < This avoids adding the "_vv" mapping when there already is a | |
| 6965 mapping for "_v" or for "_vvv". | |
| 6966 | |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
6967 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
6968 GetKey()->mapcheck('n') |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
6969 |
|
20522
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
6970 |
|
20506
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
6971 mapset({mode}, {abbr}, {dict}) *mapset()* |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
6972 Restore a mapping from a dictionary returned by |maparg()|. |
|
20522
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
6973 {mode} and {abbr} should be the same as for the call to |
|
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
6974 |maparg()|. *E460* |
|
20506
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
6975 {mode} is used to define the mode in which the mapping is set, |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
6976 not the "mode" entry in {dict}. |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
6977 Example for saving and restoring a mapping: > |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
6978 let save_map = maparg('K', 'n', 0, 1) |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
6979 nnoremap K somethingelse |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
6980 ... |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
6981 call mapset('n', 0, save_map) |
|
20522
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
6982 < Note that if you are going to replace a map in several modes, |
|
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
6983 e.g. with `:map!`, you need to save the mapping for all of |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
6984 them, since they can differ. |
|
20522
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
6985 |
|
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
6986 |
| 12785 | 6987 match({expr}, {pat} [, {start} [, {count}]]) *match()* |
| 685 | 6988 When {expr} is a |List| then this returns the index of the |
| 6989 first item where {pat} matches. Each item is used as a | |
| 692 | 6990 String, |Lists| and |Dictionaries| are used as echoed. |
| 14695 | 6991 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6992 Otherwise, {expr} is used as a String. The result is a |
| 95 | 6993 Number, which gives the index (byte offset) in {expr} where |
| 6994 {pat} matches. | |
| 14695 | 6995 |
| 685 | 6996 A match at the first character or |List| item returns zero. |
| 19 | 6997 If there is no match -1 is returned. |
| 14695 | 6998 |
| 2833 | 6999 For getting submatches see |matchlist()|. |
| 19 | 7000 Example: > |
| 95 | 7001 :echo match("testing", "ing") " results in 4 |
| 714 | 7002 :echo match([1, 'x'], '\a') " results in 1 |
| 95 | 7003 < See |string-match| for how {pat} is used. |
| 170 | 7004 *strpbrk()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7005 Vim doesn't have a strpbrk() function. But you can do: > |
| 170 | 7006 :let sepidx = match(line, '[.,;: \t]') |
| 7007 < *strcasestr()* | |
| 7008 Vim doesn't have a strcasestr() function. But you can add | |
| 7009 "\c" to the pattern to ignore case: > | |
| 7010 :let idx = match(haystack, '\cneedle') | |
| 7011 < | |
| 95 | 7012 If {start} is given, the search starts from byte index |
| 685 | 7013 {start} in a String or item {start} in a |List|. |
| 7 | 7014 The result, however, is still the index counted from the |
| 236 | 7015 first character/item. Example: > |
| 7 | 7016 :echo match("testing", "ing", 2) |
| 7017 < result is again "4". > | |
| 7018 :echo match("testing", "ing", 4) | |
| 7019 < result is again "4". > | |
| 7020 :echo match("testing", "t", 2) | |
| 7021 < result is "3". | |
| 694 | 7022 For a String, if {start} > 0 then it is like the string starts |
| 703 | 7023 {start} bytes later, thus "^" will match at {start}. Except |
| 7024 when {count} is given, then it's like matches before the | |
| 7025 {start} byte are ignored (this is a bit complicated to keep it | |
| 7026 backwards compatible). | |
| 95 | 7027 For a String, if {start} < 0, it will be set to 0. For a list |
| 7028 the index is counted from the end. | |
| 697 | 7029 If {start} is out of range ({start} > strlen({expr}) for a |
| 7030 String or {start} > len({expr}) for a |List|) -1 is returned. | |
| 95 | 7031 |
| 694 | 7032 When {count} is given use the {count}'th match. When a match |
| 697 | 7033 is found in a String the search for the next one starts one |
| 694 | 7034 character further. Thus this example results in 1: > |
| 7035 echo match("testing", "..", 0, 2) | |
| 7036 < In a |List| the search continues in the next item. | |
| 703 | 7037 Note that when {count} is added the way {start} works changes, |
| 7038 see above. | |
| 694 | 7039 |
| 7 | 7040 See |pattern| for the patterns that are accepted. |
| 7041 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
|
7042 the pattern. 'smartcase' is NOT used. The matching is always |
| 7 | 7043 done like 'magic' is set and 'cpoptions' is empty. |
| 19523 | 7044 Note that a match at the start is preferred, thus when the |
| 7045 pattern is using "*" (any number of matches) it tends to find | |
| 7046 zero matches at the start instead of a number of matches | |
| 7047 further down in the text. | |
| 7 | 7048 |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7049 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7050 GetList()->match('word') |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7051 < |
|
14407
631344964949
patch 8.1.0218: cannot add matches to another window
Christian Brabandt <cb@256bit.org>
parents:
14347
diff
changeset
|
7052 *matchadd()* *E798* *E799* *E801* *E957* |
| 12785 | 7053 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]]) |
| 1326 | 7054 Defines a pattern to be highlighted in the current window (a |
| 7055 "match"). It will be highlighted with {group}. Returns an | |
| 7056 identification number (ID), which can be used to delete the | |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7057 match using |matchdelete()|. The ID is bound to the window. |
| 5466 | 7058 Matching is case sensitive and magic, unless case sensitivity |
| 7059 or magicness are explicitly overridden in {pattern}. The | |
| 7060 'magic', 'smartcase' and 'ignorecase' options are not used. | |
|
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
7061 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
|
7062 concealed. |
| 1326 | 7063 |
| 7064 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
|
7065 match. A match with a high priority will have its |
| 1326 | 7066 highlighting overrule that of a match with a lower priority. |
| 7067 A priority is specified as an integer (negative numbers are no | |
| 7068 exception). If the {priority} argument is not specified, the | |
| 7069 default priority is 10. The priority of 'hlsearch' is zero, | |
| 7070 hence all matches with a priority greater than zero will | |
| 7071 overrule it. Syntax highlighting (see 'syntax') is a separate | |
| 7072 mechanism, and regardless of the chosen priority a match will | |
| 7073 always overrule syntax highlighting. | |
| 7074 | |
| 7075 The optional {id} argument allows the request for a specific | |
| 7076 match ID. If a specified ID is already taken, an error | |
| 7077 message will appear and the match will not be added. An ID | |
| 7078 is specified as a positive integer (zero excluded). IDs 1, 2 | |
| 7079 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
| 6947 | 7080 respectively. If the {id} argument is not specified or -1, |
| 1326 | 7081 |matchadd()| automatically chooses a free ID. |
| 7082 | |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
7083 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
|
7084 values. Currently this is used to specify a match specific |
| 6947 | 7085 conceal character that will be shown for |hl-Conceal| |
| 7086 highlighted matches. The dict can have the following members: | |
| 7087 | |
| 7088 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
|
7089 match (only for |hl-Conceal| highlighted |
| 6947 | 7090 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
|
7091 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
|
7092 window with this number or window ID. |
| 6947 | 7093 |
| 1326 | 7094 The number of matches is not limited, as it is the case with |
| 7095 the |:match| commands. | |
| 7096 | |
| 7097 Example: > | |
| 7098 :highlight MyGroup ctermbg=green guibg=green | |
| 7099 :let m = matchadd("MyGroup", "TODO") | |
| 7100 < Deletion of the pattern: > | |
| 7101 :call matchdelete(m) | |
| 7102 | |
| 7103 < 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
|
7104 available from |getmatches()|. All matches can be deleted in |
| 1326 | 7105 one operation by |clearmatches()|. |
| 819 | 7106 |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7107 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7108 GetGroup()->matchadd('TODO') |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7109 < |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7110 *matchaddpos()* |
| 12785 | 7111 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]]) |
| 5979 | 7112 Same as |matchadd()|, but requires a list of positions {pos} |
| 7113 instead of a pattern. This command is faster than |matchadd()| | |
| 7114 because it does not require to handle regular expressions and | |
| 7115 sets buffer line boundaries to redraw screen. It is supposed | |
| 7116 to be used when fast match additions and deletions are | |
| 7117 required, for example to highlight matching parentheses. | |
| 7118 | |
| 7119 The list {pos} can contain one of these items: | |
| 6007 | 7120 - A number. This whole line will be highlighted. The first |
| 5979 | 7121 line has number 1. |
| 7122 - A list with one number, e.g., [23]. The whole line with this | |
| 7123 number will be highlighted. | |
| 7124 - A list with two numbers, e.g., [23, 11]. The first number is | |
| 6007 | 7125 the line number, the second one is the column number (first |
| 7126 column is 1, the value must correspond to the byte index as | |
| 7127 |col()| would return). The character at this position will | |
| 7128 be highlighted. | |
| 5979 | 7129 - A list with three numbers, e.g., [23, 11, 3]. As above, but |
| 6007 | 7130 the third number gives the length of the highlight in bytes. |
| 12785 | 7131 |
| 5979 | 7132 The maximum number of positions is 8. |
| 7133 | |
| 7134 Example: > | |
| 7135 :highlight MyGroup ctermbg=green guibg=green | |
| 7136 :let m = matchaddpos("MyGroup", [[23, 24], 34]) | |
| 7137 < Deletion of the pattern: > | |
| 7138 :call matchdelete(m) | |
| 7139 | |
| 7140 < Matches added by |matchaddpos()| are returned by | |
| 7141 |getmatches()| with an entry "pos1", "pos2", etc., with the | |
| 7142 value a list like the {pos} item. | |
| 7143 | |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7144 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7145 GetGroup()->matchaddpos([23, 11]) |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7146 |
| 819 | 7147 matcharg({nr}) *matcharg()* |
| 856 | 7148 Selects the {nr} match item, as set with a |:match|, |
| 819 | 7149 |:2match| or |:3match| command. |
| 7150 Return a |List| with two elements: | |
| 7151 The name of the highlight group used | |
| 7152 The pattern used. | |
| 7153 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
| 7154 When there is no match item set returns ['', '']. | |
| 1326 | 7155 This is useful to save and restore a |:match|. |
| 7156 Highlighting matches using the |:match| commands are limited | |
| 7157 to three matches. |matchadd()| does not have this limitation. | |
| 7158 | |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7159 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7160 GetMatch()->matcharg() |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7161 |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7162 matchdelete({id} [, {win}) *matchdelete()* *E802* *E803* |
| 1326 | 7163 Deletes a match with ID {id} previously defined by |matchadd()| |
| 1621 | 7164 or one of the |:match| commands. Returns 0 if successful, |
| 1326 | 7165 otherwise -1. See example for |matchadd()|. All matches can |
| 7166 be deleted in one operation by |clearmatches()|. | |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7167 If {win} is specified, use the window with this number or |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7168 window ID instead of the current window. |
| 819 | 7169 |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7170 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7171 GetMatch()->matchdelete() |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7172 |
| 12785 | 7173 matchend({expr}, {pat} [, {start} [, {count}]]) *matchend()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7174 Same as |match()|, but return the index of first character |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7175 after the match. Example: > |
| 7 | 7176 :echo matchend("testing", "ing") |
| 7177 < results in "7". | |
| 170 | 7178 *strspn()* *strcspn()* |
| 7179 Vim doesn't have a strspn() or strcspn() function, but you can | |
| 7180 do it with matchend(): > | |
| 7181 :let span = matchend(line, '[a-zA-Z]') | |
| 7182 :let span = matchend(line, '[^a-zA-Z]') | |
| 7183 < Except that -1 is returned when there are no matches. | |
| 7184 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7185 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 7186 :echo matchend("testing", "ing", 2) |
| 7187 < results in "7". > | |
| 7188 :echo matchend("testing", "ing", 5) | |
| 7189 < result is "-1". | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7190 When {expr} is a |List| the result is equal to |match()|. |
| 7 | 7191 |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7192 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7193 GetText()->matchend('word') |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7194 |
| 12785 | 7195 matchlist({expr}, {pat} [, {start} [, {count}]]) *matchlist()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7196 Same as |match()|, but return a |List|. The first item in the |
| 158 | 7197 list is the matched string, same as what matchstr() would |
| 7198 return. Following items are submatches, like "\1", "\2", etc. | |
| 842 | 7199 in |:substitute|. When an optional submatch didn't match an |
| 7200 empty string is used. Example: > | |
| 7201 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
| 7202 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
| 158 | 7203 When there is no match an empty list is returned. |
| 7204 | |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7205 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7206 GetList()->matchlist('word') |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7207 |
| 12785 | 7208 matchstr({expr}, {pat} [, {start} [, {count}]]) *matchstr()* |
| 1621 | 7209 Same as |match()|, but return the matched string. Example: > |
| 7 | 7210 :echo matchstr("testing", "ing") |
| 7211 < results in "ing". | |
| 7212 When there is no match "" is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7213 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 7214 :echo matchstr("testing", "ing", 2) |
| 7215 < results in "ing". > | |
| 7216 :echo matchstr("testing", "ing", 5) | |
| 7217 < result is "". | |
| 685 | 7218 When {expr} is a |List| then the matching item is returned. |
| 95 | 7219 The type isn't changed, it's not necessarily a String. |
| 7 | 7220 |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7221 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7222 GetText()->matchstr('word') |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7223 |
| 12785 | 7224 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
|
7225 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
|
7226 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
|
7227 :echo matchstrpos("testing", "ing") |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7228 < results in ["ing", 4, 7]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7229 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
|
7230 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
|
7231 :echo matchstrpos("testing", "ing", 2) |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7232 < results in ["ing", 4, 7]. > |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7233 :echo matchstrpos("testing", "ing", 5) |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7234 < result is ["", -1, -1]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7235 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
|
7236 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
|
7237 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
|
7238 :echo matchstrpos([1, '__x'], '\a') |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7239 < result is ["x", 1, 2, 3]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7240 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
|
7241 |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7242 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7243 GetText()->matchstrpos('word') |
| 18343 | 7244 < |
|
19657
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7245 |
| 87 | 7246 *max()* |
| 10734 | 7247 max({expr}) Return the maximum value of all items in {expr}. |
| 19099 | 7248 {expr} can be a List or a Dictionary. For a Dictionary, |
| 7249 it returns the maximum of all values in the Dictionary. | |
| 7250 If {expr} is neither a List nor a Dictionary, or one of the | |
| 10734 | 7251 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
|
7252 an error. An empty |List| or |Dictionary| results in zero. |
| 87 | 7253 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7254 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7255 mylist->max() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7256 |
|
19657
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7257 |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7258 menu_info({name} [, {mode}]) *menu_info()* |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7259 Return information about the specified menu {name} in |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7260 mode {mode}. The menu name should be specified without the |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7261 shortcut character ('&'). |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7262 |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7263 {mode} can be one of these strings: |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7264 "n" Normal |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7265 "v" Visual (including Select) |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7266 "o" Operator-pending |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7267 "i" Insert |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7268 "c" Cmd-line |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7269 "s" Select |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7270 "x" Visual |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7271 "t" Terminal-Job |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7272 "" Normal, Visual and Operator-pending |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7273 "!" Insert and Cmd-line |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7274 When {mode} is omitted, the modes for "" are used. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7275 |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7276 Returns a |Dictionary| containing the following items: |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7277 accel menu item accelerator text |menu-text| |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7278 display display name (name without '&') |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7279 enabled v:true if this menu item is enabled |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7280 Refer to |:menu-enable| |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7281 icon name of the icon file (for toolbar) |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7282 |toolbar-icon| |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7283 iconidx index of a built-in icon |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7284 modes modes for which the menu is defined. In |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7285 addition to the modes mentioned above, these |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7286 characters will be used: |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7287 " " Normal, Visual and Operator-pending |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7288 name menu item name. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7289 noremenu v:true if the {rhs} of the menu item is not |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7290 remappable else v:false. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7291 priority menu order priority |menu-priority| |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7292 rhs right-hand-side of the menu item. The returned |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7293 string has special characters translated like |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7294 in the output of the ":menu" command listing. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7295 When the {rhs} of a menu item is empty, then |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7296 "<Nop>" is returned. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7297 script v:true if script-local remapping of {rhs} is |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7298 allowed else v:false. See |:menu-script|. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7299 shortcut shortcut key (character after '&' in |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7300 the menu name) |menu-shortcut| |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7301 silent v:true if the menu item is created |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7302 with <silent> argument |:menu-silent| |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7303 submenus |List| containing the names of |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7304 all the submenus. Present only if the menu |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7305 item has submenus. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7306 |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7307 Returns an empty dictionary if the menu item is not found. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7308 |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7309 Examples: > |
| 19721 | 7310 :echo menu_info('Edit.Cut') |
| 7311 :echo menu_info('File.Save', 'n') | |
| 7312 < | |
| 7313 Can also be used as a |method|: > | |
| 7314 GetMenuName()->menu_info('v') | |
|
19657
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7315 |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7316 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7317 < *min()* |
| 10734 | 7318 min({expr}) Return the minimum value of all items in {expr}. |
| 19099 | 7319 {expr} can be a List or a Dictionary. For a Dictionary, |
| 7320 it returns the minimum of all values in the Dictionary. | |
| 7321 If {expr} is neither a List nor a Dictionary, or one of the | |
| 10734 | 7322 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
|
7323 an error. An empty |List| or |Dictionary| results in zero. |
| 87 | 7324 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7325 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7326 mylist->min() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7327 |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7328 < *mkdir()* *E739* |
| 168 | 7329 mkdir({name} [, {path} [, {prot}]]) |
| 7330 Create directory {name}. | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7331 |
| 168 | 7332 If {path} is "p" then intermediate directories are created as |
| 7333 necessary. Otherwise it must be "". | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7334 |
| 168 | 7335 If {prot} is given it is used to set the protection bits of |
| 7336 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
|
7337 the user readable for others). Use 0700 to make it unreadable |
| 1702 | 7338 for others. This is only used for the last part of {name}. |
| 7339 Thus if you create /tmp/foo/bar then /tmp/foo will be created | |
| 7340 with 0755. | |
| 7341 Example: > | |
| 7342 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700) | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7343 |
| 1702 | 7344 < This function is not available in the |sandbox|. |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7345 |
|
13672
4a1efd1a6018
patch 8.0.1708: mkdir with 'p' flag fails on existing directory
Christian Brabandt <cb@256bit.org>
parents:
13626
diff
changeset
|
7346 There is no error if the directory already exists and the "p" |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7347 flag is passed (since patch 8.0.1708). However, without the |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
7348 "p" option the call will fail. |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
7349 |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
7350 The function result is a Number, which is 1 if the call was |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7351 successful or 0 if the directory creation failed or partly |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7352 failed. |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7353 |
| 168 | 7354 Not available on all systems. To check use: > |
| 7355 :if exists("*mkdir") | |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7356 |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7357 < Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7358 GetName()->mkdir() |
| 168 | 7359 < |
| 7 | 7360 *mode()* |
| 1621 | 7361 mode([expr]) Return a string that indicates the current mode. |
| 1661 | 7362 If [expr] is supplied and it evaluates to a non-zero Number or |
| 7363 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
|
7364 returned, otherwise only the first letter is returned. |
|
18104
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
7365 Also see |state()|. |
| 1621 | 7366 |
|
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
|
7367 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
|
7368 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
|
7369 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
|
7370 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
|
7371 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
|
7372 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
|
7373 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
|
7374 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
|
7375 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
|
7376 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
|
7377 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
|
7378 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
|
7379 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
|
7380 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
|
7381 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
|
7382 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
|
7383 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
|
7384 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
|
7385 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
|
7386 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
|
7387 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
|
7388 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
|
7389 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
|
7390 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
|
7391 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
|
7392 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
|
7393 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
|
7394 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
|
7395 ! 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
|
7396 t Terminal-Job mode: keys go to the job |
| 1621 | 7397 This is useful in the 'statusline' option or when used |
| 7398 with |remote_expr()| In most other places it always returns | |
| 7399 "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
|
7400 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
|
7401 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
|
7402 the leading character(s). |
| 1621 | 7403 Also see |visualmode()|. |
| 7 | 7404 |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7405 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7406 DoFull()->mode() |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7407 |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7408 mzeval({expr}) *mzeval()* |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7409 Evaluate MzScheme expression {expr} and return its result |
| 3492 | 7410 converted to Vim data structures. |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7411 Numbers and strings are returned as they are. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7412 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
|
7413 returned as Vim |Lists|. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7414 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
|
7415 converted to strings. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7416 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
|
7417 Examples: > |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7418 :mz (define l (list 1 2 3)) |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7419 :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
|
7420 :echo mzeval("l") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7421 :echo mzeval("h") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7422 < |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7423 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7424 GetExpr()->mzeval() |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7425 < |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7426 {only available when compiled with the |+mzscheme| feature} |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7427 |
| 7 | 7428 nextnonblank({lnum}) *nextnonblank()* |
| 7429 Return the line number of the first line at or below {lnum} | |
| 7430 that is not blank. Example: > | |
| 7431 if getline(nextnonblank(1)) =~ "Java" | |
| 7432 < When {lnum} is invalid or there is no non-blank line at or | |
| 7433 below it, zero is returned. | |
| 7434 See also |prevnonblank()|. | |
| 7435 | |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7436 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7437 GetLnum()->nextnonblank() |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7438 |
| 12785 | 7439 nr2char({expr} [, {utf8}]) *nr2char()* |
| 7 | 7440 Return a string with a single character, which has the number |
| 7441 value {expr}. Examples: > | |
| 7442 nr2char(64) returns "@" | |
| 7443 nr2char(32) returns " " | |
| 4051 | 7444 < When {utf8} is omitted or zero, the current 'encoding' is used. |
| 7445 Example for "utf-8": > | |
| 7 | 7446 nr2char(300) returns I with bow character |
| 4051 | 7447 < With {utf8} set to 1, always return utf-8 characters. |
| 7448 Note that a NUL character in the file is specified with | |
| 7 | 7449 nr2char(10), because NULs are represented with newline |
| 7450 characters. nr2char(0) is a real NUL and terminates the | |
| 119 | 7451 string, thus results in an empty string. |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7452 To turn a list of character numbers into a string: > |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7453 let list = [65, 66, 67] |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7454 let str = join(map(list, {_, val -> nr2char(val)}), '') |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7455 < Result: "ABC" |
| 7 | 7456 |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7457 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7458 GetNumber()->nr2char() |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
7459 |
| 3214 | 7460 or({expr}, {expr}) *or()* |
| 7461 Bitwise OR on the two arguments. The arguments are converted | |
| 7462 to a number. A List, Dict or Float argument causes an error. | |
| 7463 Example: > | |
| 7464 :let bits = or(bits, 0x80) | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
7465 < Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
7466 :let bits = bits->or(0x80) |
| 3214 | 7467 |
| 7468 | |
| 819 | 7469 pathshorten({expr}) *pathshorten()* |
| 7470 Shorten directory names in the path {expr} and return the | |
| 7471 result. The tail, the file name, is kept as-is. The other | |
| 7472 components in the path are reduced to single letters. Leading | |
| 7473 '~' and '.' characters are kept. Example: > | |
| 7474 :echo pathshorten('~/.vim/autoload/myfile.vim') | |
| 7475 < ~/.v/a/myfile.vim ~ | |
| 7476 It doesn't matter if the path exists or not. | |
| 7477 | |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7478 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7479 GetDirectories()->pathshorten() |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7480 |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
7481 perleval({expr}) *perleval()* |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
7482 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
|
7483 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
|
7484 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
|
7485 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
|
7486 reference to it. |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
7487 Example: > |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
7488 :echo perleval('[1 .. 4]') |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
7489 < [1, 2, 3, 4] |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7490 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7491 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7492 GetExpr()->perleval() |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7493 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7494 < {only available when compiled with the |+perl| feature} |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
7495 |
|
17257
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
7496 |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
7497 popup_ functions are documented here: |popup-functions|. |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
7498 |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
7499 |
| 1621 | 7500 pow({x}, {y}) *pow()* |
| 7501 Return the power of {x} to the exponent {y} as a |Float|. | |
| 7502 {x} and {y} must evaluate to a |Float| or a |Number|. | |
| 7503 Examples: > | |
| 7504 :echo pow(3, 3) | |
| 7505 < 27.0 > | |
| 7506 :echo pow(2, 16) | |
| 7507 < 65536.0 > | |
| 7508 :echo pow(32, 0.20) | |
| 7509 < 2.0 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7510 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7511 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7512 Compute()->pow(3) |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7513 < |
| 1621 | 7514 {only available when compiled with the |+float| feature} |
| 12785 | 7515 |
| 667 | 7516 prevnonblank({lnum}) *prevnonblank()* |
| 7517 Return the line number of the first line at or above {lnum} | |
| 7518 that is not blank. Example: > | |
| 7519 let ind = indent(prevnonblank(v:lnum - 1)) | |
| 7520 < When {lnum} is invalid or there is no non-blank line at or | |
| 7521 above it, zero is returned. | |
| 7522 Also see |nextnonblank()|. | |
| 7523 | |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7524 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7525 GetLnum()->prevnonblank() |
| 667 | 7526 |
| 449 | 7527 printf({fmt}, {expr1} ...) *printf()* |
| 7528 Return a String with {fmt}, where "%" items are replaced by | |
| 7529 the formatted form of their respective arguments. Example: > | |
| 452 | 7530 printf("%4d: E%d %.30s", lnum, errno, msg) |
| 449 | 7531 < May result in: |
| 452 | 7532 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
| 449 | 7533 |
|
17676
14ac8c31e598
patch 8.1.1835: cannot use printf() as a method
Bram Moolenaar <Bram@vim.org>
parents:
17674
diff
changeset
|
7534 When used as a |method| the base is passed as the second |
|
14ac8c31e598
patch 8.1.1835: cannot use printf() as a method
Bram Moolenaar <Bram@vim.org>
parents:
17674
diff
changeset
|
7535 argument: > |
|
14ac8c31e598
patch 8.1.1835: cannot use printf() as a method
Bram Moolenaar <Bram@vim.org>
parents:
17674
diff
changeset
|
7536 Compute()->printf("result: %d") |
|
14ac8c31e598
patch 8.1.1835: cannot use printf() as a method
Bram Moolenaar <Bram@vim.org>
parents:
17674
diff
changeset
|
7537 |
|
14ac8c31e598
patch 8.1.1835: cannot use printf() as a method
Bram Moolenaar <Bram@vim.org>
parents:
17674
diff
changeset
|
7538 < Often used items are: |
| 856 | 7539 %s string |
| 3914 | 7540 %6S string right-aligned in 6 display cells |
| 653 | 7541 %6s string right-aligned in 6 bytes |
| 1621 | 7542 %.9s string truncated to 9 bytes |
| 7543 %c single byte | |
| 7544 %d decimal number | |
| 7545 %5d decimal number padded with spaces to 5 characters | |
| 7546 %x hex number | |
| 7547 %04x hex number padded with zeros to at least 4 characters | |
| 7548 %X hex number using upper case letters | |
| 7549 %o octal number | |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7550 %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
|
7551 %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
|
7552 %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
|
7553 %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
|
7554 %E floating point number as 1.23E3, INF, -INF or NAN |
| 1621 | 7555 %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
|
7556 %G floating point number, as %F or %E depending on value |
| 1621 | 7557 %% the % character itself |
| 449 | 7558 |
| 7559 Conversion specifications start with '%' and end with the | |
| 7560 conversion type. All other characters are copied unchanged to | |
| 7561 the result. | |
| 7562 | |
| 7563 The "%" starts a conversion specification. The following | |
| 452 | 7564 arguments appear in sequence: |
| 7565 | |
| 7566 % [flags] [field-width] [.precision] type | |
| 7567 | |
| 856 | 7568 flags |
| 452 | 7569 Zero or more of the following flags: |
| 7570 | |
| 449 | 7571 # The value should be converted to an "alternate |
| 7572 form". For c, d, and s conversions, this option | |
| 7573 has no effect. For o conversions, the precision | |
| 7574 of the number is increased to force the first | |
| 7575 character of the output string to a zero (except | |
| 7576 if a zero value is printed with an explicit | |
| 7577 precision of zero). | |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7578 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
|
7579 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
|
7580 prepended to it. |
| 449 | 7581 For x and X conversions, a non-zero result has |
| 7582 the string "0x" (or "0X" for X conversions) | |
| 7583 prepended to it. | |
| 452 | 7584 |
| 449 | 7585 0 (zero) Zero padding. For all conversions the converted |
| 7586 value is padded on the left with zeros rather | |
| 7587 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
|
7588 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
|
7589 flag is ignored. |
| 452 | 7590 |
| 449 | 7591 - A negative field width flag; the converted value |
| 7592 is to be left adjusted on the field boundary. | |
| 7593 The converted value is padded on the right with | |
| 7594 blanks, rather than on the left with blanks or | |
| 7595 zeros. A - overrides a 0 if both are given. | |
| 452 | 7596 |
| 449 | 7597 ' ' (space) A blank should be left before a positive |
| 7598 number produced by a signed conversion (d). | |
| 452 | 7599 |
| 449 | 7600 + 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
|
7601 produced by a signed conversion. A + overrides |
| 449 | 7602 a space if both are used. |
| 452 | 7603 |
| 7604 field-width | |
| 7605 An optional decimal digit string specifying a minimum | |
| 653 | 7606 field width. If the converted value has fewer bytes |
| 7607 than the field width, it will be padded with spaces on | |
| 7608 the left (or right, if the left-adjustment flag has | |
| 7609 been given) to fill out the field width. | |
| 452 | 7610 |
| 7611 .precision | |
| 7612 An optional precision, in the form of a period '.' | |
| 7613 followed by an optional digit string. If the digit | |
| 7614 string is omitted, the precision is taken as zero. | |
| 7615 This gives the minimum number of digits to appear for | |
| 7616 d, o, x, and X conversions, or the maximum number of | |
| 653 | 7617 bytes to be printed from a string for s conversions. |
| 1621 | 7618 For floating point it is the number of digits after |
| 7619 the decimal point. | |
| 452 | 7620 |
| 7621 type | |
| 7622 A character that specifies the type of conversion to | |
| 7623 be applied, see below. | |
| 7624 | |
| 449 | 7625 A field width or precision, or both, may be indicated by an |
| 7626 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
|
7627 Number argument supplies the field width or precision. A |
| 449 | 7628 negative field width is treated as a left adjustment flag |
| 7629 followed by a positive field width; a negative precision is | |
| 7630 treated as though it were missing. Example: > | |
| 452 | 7631 :echo printf("%d: %.*s", nr, width, line) |
| 449 | 7632 < This limits the length of the text used from "line" to |
| 452 | 7633 "width" bytes. |
| 449 | 7634 |
| 856 | 7635 The conversion specifiers and their meanings are: |
| 452 | 7636 |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7637 *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
|
7638 *printf-x* *printf-X* |
|
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7639 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
|
7640 (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
|
7641 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
|
7642 "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
|
7643 "ABCDEF" are used for X conversions. |
| 452 | 7644 The precision, if any, gives the minimum number of |
| 7645 digits that must appear; if the converted value | |
| 7646 requires fewer digits, it is padded on the left with | |
| 7647 zeros. | |
| 7648 In no case does a non-existent or small field width | |
| 7649 cause truncation of a numeric field; if the result of | |
| 7650 a conversion is wider than the field width, the field | |
| 7651 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
|
7652 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
|
7653 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
|
7654 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
|
7655 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
|
7656 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
|
7657 |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
7658 i alias for d |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
7659 D alias for ld |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
7660 U alias for lu |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
7661 O alias for lo |
| 452 | 7662 |
| 1621 | 7663 *printf-c* |
| 452 | 7664 c The Number argument is converted to a byte, and the |
| 7665 resulting character is written. | |
| 7666 | |
| 1621 | 7667 *printf-s* |
| 452 | 7668 s The text of the String argument is used. If a |
| 7669 precision is specified, no more bytes than the number | |
| 7670 specified are used. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
7671 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
|
7672 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
|
7673 as ":echo". |
| 6583 | 7674 *printf-S* |
| 3914 | 7675 S The text of the String argument is used. If a |
| 7676 precision is specified, no more display cells than the | |
| 15878 | 7677 number specified are used. |
| 452 | 7678 |
| 1621 | 7679 *printf-f* *E807* |
| 12785 | 7680 f F The Float argument is converted into a string of the |
| 1621 | 7681 form 123.456. The precision specifies the number of |
| 7682 digits after the decimal point. When the precision is | |
| 7683 zero the decimal point is omitted. When the precision | |
| 7684 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
|
7685 (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
|
7686 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
|
7687 "0.0 / 0.0" results in "nan" with %f (NAN with %F). |
| 1621 | 7688 Example: > |
| 7689 echo printf("%.2f", 12.115) | |
| 7690 < 12.12 | |
| 7691 Note that roundoff depends on the system libraries. | |
| 7692 Use |round()| when in doubt. | |
| 7693 | |
| 7694 *printf-e* *printf-E* | |
| 7695 e E The Float argument is converted into a string of the | |
| 7696 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
| 7697 precision specifies the number of digits after the | |
| 7698 decimal point, like with 'f'. | |
| 7699 | |
| 7700 *printf-g* *printf-G* | |
| 7701 g G The Float argument is converted like with 'f' if the | |
| 7702 value is between 0.001 (inclusive) and 10000000.0 | |
| 7703 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
| 7704 for 'G'. When no precision is specified superfluous | |
| 7705 zeroes and '+' signs are removed, except for the zero | |
| 7706 immediately after the decimal point. Thus 10000000.0 | |
| 7707 results in 1.0e7. | |
| 7708 | |
| 7709 *printf-%* | |
| 449 | 7710 % A '%' is written. No argument is converted. The |
| 7711 complete conversion specification is "%%". | |
| 452 | 7712 |
| 1668 | 7713 When a Number argument is expected a String argument is also |
| 7714 accepted and automatically converted. | |
| 7715 When a Float or String argument is expected a Number argument | |
| 7716 is also accepted and automatically converted. | |
| 7717 Any other argument type results in an error message. | |
| 449 | 7718 |
| 459 | 7719 *E766* *E767* |
| 449 | 7720 The number of {exprN} arguments must exactly match the number |
| 7721 of "%" items. If there are not sufficient or too many | |
| 452 | 7722 arguments an error is given. Up to 18 arguments can be used. |
| 449 | 7723 |
| 7724 | |
|
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
|
7725 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
|
7726 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
|
7727 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
|
7728 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
|
7729 |
|
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
|
7730 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
|
7731 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
|
7732 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
|
7733 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
|
7734 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
|
7735 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
|
7736 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
|
7737 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
|
7738 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
|
7739 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
|
7740 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
|
7741 Example: > |
|
17855
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
7742 call prompt_setcallback(bufnr(), function('s:TextEntered')) |
|
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
|
7743 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
|
7744 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
|
7745 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
|
7746 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
|
7747 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
|
7748 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
|
7749 " 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
|
7750 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
|
7751 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
|
7752 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
|
7753 |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7754 < Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7755 GetBuffer()->prompt_setcallback(callback) |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7756 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7757 |
|
14103
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
7758 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
|
7759 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
|
7760 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
|
7761 {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
|
7762 |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
7763 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
|
7764 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
|
7765 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
|
7766 |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7767 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7768 GetBuffer()->prompt_setinterrupt(callback) |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7769 |
|
14103
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
7770 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
|
7771 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
|
7772 {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
|
7773 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
|
7774 "prompt". Example: > |
|
17855
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
7775 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
|
7776 < |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7777 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7778 GetBuffer()->prompt_setprompt('command: ') |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7779 |
|
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
7780 prop_ functions are documented here: |text-prop-functions|. |
|
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
|
7781 |
|
17756
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
7782 pum_getpos() *pum_getpos()* |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
7783 If the popup menu (see |ins-completion-menu|) is not visible, |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
7784 returns an empty |Dictionary|, otherwise, returns a |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
7785 |Dictionary| with the following keys: |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
7786 height nr of items visible |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
7787 width screen cells |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
7788 row top screen row (0 first row) |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
7789 col leftmost screen column (0 first col) |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
7790 size total nr of items |
| 18456 | 7791 scrollbar |TRUE| if scrollbar is visible |
|
17756
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
7792 |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
7793 The values are the same as in |v:event| during |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
7794 |CompleteChanged|. |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
7795 |
| 667 | 7796 pumvisible() *pumvisible()* |
| 7797 Returns non-zero when the popup menu is visible, zero | |
| 7798 otherwise. See |ins-completion-menu|. | |
| 712 | 7799 This can be used to avoid some things that would remove the |
| 7800 popup menu. | |
| 7 | 7801 |
| 3682 | 7802 py3eval({expr}) *py3eval()* |
| 7803 Evaluate Python expression {expr} and return its result | |
| 7804 converted to Vim data structures. | |
| 12785 | 7805 Numbers and strings are returned as they are (strings are |
| 7806 copied though, Unicode strings are additionally converted to | |
| 3682 | 7807 'encoding'). |
| 7808 Lists are represented as Vim |List| type. | |
| 12785 | 7809 Dictionaries are represented as Vim |Dictionary| type with |
| 3682 | 7810 keys converted to strings. |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7811 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7812 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7813 GetExpr()->py3eval() |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7814 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7815 < {only available when compiled with the |+python3| feature} |
| 3682 | 7816 |
| 7817 *E858* *E859* | |
| 7818 pyeval({expr}) *pyeval()* | |
| 7819 Evaluate Python expression {expr} and return its result | |
| 7820 converted to Vim data structures. | |
| 12785 | 7821 Numbers and strings are returned as they are (strings are |
| 3682 | 7822 copied though). |
| 7823 Lists are represented as Vim |List| type. | |
| 12785 | 7824 Dictionaries are represented as Vim |Dictionary| type, |
| 3830 | 7825 non-string keys result in error. |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7826 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7827 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7828 GetExpr()->pyeval() |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7829 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7830 < {only available when compiled with the |+python| feature} |
| 3682 | 7831 |
|
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
7832 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
|
7833 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
|
7834 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
|
7835 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
|
7836 See also: |pyeval()|, |py3eval()| |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7837 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7838 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7839 GetExpr()->pyxeval() |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7840 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7841 < {only available when compiled with the |+python| or the |
|
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
7842 |+python3| feature} |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
7843 |
| 114 | 7844 *E726* *E727* |
| 99 | 7845 range({expr} [, {max} [, {stride}]]) *range()* |
| 685 | 7846 Returns a |List| with Numbers: |
| 99 | 7847 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
| 7848 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
| 7849 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
| 7850 {max}] (increasing {expr} with {stride} each time, not | |
| 7851 producing a value past {max}). | |
| 336 | 7852 When the maximum is one before the start the result is an |
| 7853 empty list. When the maximum is more than one before the | |
| 7854 start this is an error. | |
| 99 | 7855 Examples: > |
| 856 | 7856 range(4) " [0, 1, 2, 3] |
| 99 | 7857 range(2, 4) " [2, 3, 4] |
| 7858 range(2, 9, 3) " [2, 5, 8] | |
| 856 | 7859 range(2, -2, -1) " [2, 1, 0, -1, -2] |
| 336 | 7860 range(0) " [] |
| 7861 range(2, 0) " error! | |
| 99 | 7862 < |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
7863 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
7864 GetExpr()->range() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
7865 < |
|
18701
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
7866 |
| 20115 | 7867 rand([{expr}]) *rand()* *random* |
|
18732
2513e666aa82
patch 8.1.2356: rand() does not use the best algorithm
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
7868 Return a pseudo-random Number generated with an xoshiro128** |
| 18719 | 7869 algorithm using seed {expr}. The returned number is 32 bits, |
| 7870 also on 64 bits systems, for consistency. | |
| 7871 {expr} can be initialized by |srand()| and will be updated by | |
| 7872 rand(). If {expr} is omitted, an internal seed value is used | |
| 7873 and updated. | |
|
18701
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
7874 |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
7875 Examples: > |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
7876 :echo rand() |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
7877 :let seed = srand() |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
7878 :echo rand(seed) |
| 18719 | 7879 :echo rand(seed) % 16 " random number 0 - 15 |
|
18701
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
7880 < |
|
20643
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7881 readdir({directory} [, {expr}]) *readdir()* |
|
16231
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7882 Return a list with file and directory names in {directory}. |
| 16267 | 7883 You can also use |glob()| if you don't need to do complicated |
| 7884 things, such as limiting the number of matches. | |
|
20643
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7885 The list will be sorted (case sensitive). |
|
16231
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7886 |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7887 When {expr} is omitted all entries are included. |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7888 When {expr} is given, it is evaluated to check what to do: |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7889 If {expr} results in -1 then no further entries will |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7890 be handled. |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7891 If {expr} results in 0 then this entry will not be |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7892 added to the list. |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7893 If {expr} results in 1 then this entry will be added |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7894 to the list. |
|
20643
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7895 The entries "." and ".." are always excluded. |
|
16231
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7896 Each time {expr} is evaluated |v:val| is set to the entry name. |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7897 When {expr} is a function the name is passed as the argument. |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7898 For example, to get a list of files ending in ".txt": > |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7899 readdir(dirname, {n -> n =~ '.txt$'}) |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7900 < To skip hidden and backup files: > |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7901 readdir(dirname, {n -> n !~ '^\.\|\~$'}) |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7902 |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7903 < If you want to get a directory tree: > |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7904 function! s:tree(dir) |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7905 return {a:dir : map(readdir(a:dir), |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7906 \ {_, x -> isdirectory(x) ? |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7907 \ {x : s:tree(a:dir . '/' . x)} : x})} |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7908 endfunction |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7909 echo s:tree(".") |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7910 < |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
7911 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
7912 GetDirName()->readdir() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
7913 < |
|
20643
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7914 readdirex({directory} [, {expr}]) *readdirex()* |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7915 Extended version of |readdir()|. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7916 Return a list of Dictionaries with file and directory |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7917 information in {directory}. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7918 This is useful if you want to get the attributes of file and |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7919 directory at the same time as getting a list of a directory. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7920 This is much faster than calling |readdir()| then calling |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7921 |getfperm()|, |getfsize()|, |getftime()| and |getftype()| for |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7922 each file and directory especially on MS-Windows. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7923 The list will be sorted by name (case sensitive). |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7924 |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7925 The Dictionary for file and directory information has the |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7926 following items: |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7927 group Group name of the entry. (Only on Unix) |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7928 name Name of the entry. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7929 perm Permissions of the entry. See |getfperm()|. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7930 size Size of the entry. See |getfsize()|. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7931 time Timestamp of the entry. See |getftime()|. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7932 type Type of the entry. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7933 On Unix, almost same as |getftype()| except: |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7934 Symlink to a dir "linkd" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7935 Other symlink "link" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7936 On MS-Windows: |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7937 Normal file "file" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7938 Directory "dir" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7939 Junction "junction" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7940 Symlink to a dir "linkd" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7941 Other symlink "link" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7942 Other reparse point "reparse" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7943 user User name of the entry's owner. (Only on Unix) |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7944 On Unix, if the entry is a symlink, the Dictionary includes |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7945 the information of the target (except the "type" item). |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7946 On MS-Windows, it includes the information of the symlink |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7947 itself because of performance reasons. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7948 |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7949 When {expr} is omitted all entries are included. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7950 When {expr} is given, it is evaluated to check what to do: |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7951 If {expr} results in -1 then no further entries will |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7952 be handled. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7953 If {expr} results in 0 then this entry will not be |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7954 added to the list. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7955 If {expr} results in 1 then this entry will be added |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7956 to the list. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7957 The entries "." and ".." are always excluded. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7958 Each time {expr} is evaluated |v:val| is set to a Dictionary |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7959 of the entry. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7960 When {expr} is a function the entry is passed as the argument. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7961 For example, to get a list of files ending in ".txt": > |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7962 readdirex(dirname, {e -> e.name =~ '.txt$'}) |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7963 < |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7964 Can also be used as a |method|: > |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7965 GetDirName()->readdirex() |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
7966 < |
| 158 | 7967 *readfile()* |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
7968 readfile({fname} [, {type} [, {max}]]) |
| 685 | 7969 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
|
7970 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
|
7971 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
|
7972 (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
|
7973 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
|
7974 When {type} contains "b" binary mode is used: |
| 158 | 7975 - When the last line ends in a NL an extra empty list item is |
| 7976 added. | |
| 7977 - No CR characters are removed. | |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
7978 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
|
7979 data of the file unmodified. |
| 158 | 7980 Otherwise: |
| 7981 - CR characters that appear before a NL are removed. | |
| 7982 - 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
|
7983 - 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
|
7984 removed from the text. |
| 168 | 7985 When {max} is given this specifies the maximum number of lines |
| 7986 to be read. Useful if you only want to check the first ten | |
| 7987 lines of a file: > | |
| 7988 :for line in readfile(fname, '', 10) | |
| 7989 : if line =~ 'Date' | echo line | endif | |
| 7990 :endfor | |
| 233 | 7991 < When {max} is negative -{max} lines from the end of the file |
| 7992 are returned, or as many as there are. | |
| 7993 When {max} is zero the result is an empty list. | |
| 168 | 7994 Note that without {max} the whole file is read into memory. |
| 7995 Also note that there is no recognition of encoding. Read a | |
| 7996 file into a buffer if you need to. | |
| 158 | 7997 When the file can't be opened an error message is given and |
| 7998 the result is an empty list. | |
| 7999 Also see |writefile()|. | |
| 8000 | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8001 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8002 GetFileName()->readfile() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8003 |
|
20649
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8004 reduce({object}, {func} [, {initial}]) *reduce()* *E998* |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8005 {func} is called for every item in {object}, which can be a |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8006 |List| or a |Blob|. {func} is called with two arguments: the |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8007 result so far and current item. After processing all items |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8008 the result is returned. |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8009 |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8010 {initial} is the initial result. When omitted, the first item |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8011 in {object} is used and {func} is first called for the second |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8012 item. If {initial} is not given and {object} is empty no |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8013 result can be computed, an E998 error is given. |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8014 |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8015 Examples: > |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8016 echo reduce([1, 3, 5], { acc, val -> acc + val }) |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8017 echo reduce(['x', 'y'], { acc, val -> acc .. val }, 'a') |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8018 echo reduce(0z1122, { acc, val -> 2 * acc + val }) |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8019 < |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8020 Can also be used as a |method|: > |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8021 echo mylist->reduce({ acc, val -> acc + val }, 0) |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8022 |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8023 |
|
14004
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
8024 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
|
8025 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
|
8026 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
|
8027 See |@|. |
|
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
8028 |
|
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
8029 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
|
8030 Returns the single letter name of the register being recorded. |
| 16267 | 8031 Returns an empty string when not recording. See |q|. |
|
14004
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
8032 |
| 794 | 8033 reltime([{start} [, {end}]]) *reltime()* |
| 8034 Return an item that represents a time value. The format of | |
| 8035 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
|
8036 |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
|
8037 to convert to a Float. |
| 794 | 8038 Without an argument it returns the current time. |
| 8039 With one argument is returns the time passed since the time | |
| 8040 specified in the argument. | |
| 843 | 8041 With two arguments it returns the time passed between {start} |
| 794 | 8042 and {end}. |
| 8043 The {start} and {end} arguments must be values returned by | |
| 8044 reltime(). | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8045 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8046 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8047 GetStart()->reltime() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8048 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
8049 {only available when compiled with the |+reltime| feature} |
| 794 | 8050 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8051 reltimefloat({time}) *reltimefloat()* |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8052 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
|
8053 Example: > |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8054 let start = reltime() |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8055 call MyFunction() |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8056 let seconds = reltimefloat(reltime(start)) |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8057 < 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
|
8058 Also see |profiling|. |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8059 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8060 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8061 reltime(start)->reltimefloat() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8062 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8063 < {only available when compiled with the |+reltime| feature} |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8064 |
| 794 | 8065 reltimestr({time}) *reltimestr()* |
| 8066 Return a String that represents the time value of {time}. | |
| 8067 This is the number of seconds, a dot and the number of | |
| 8068 microseconds. Example: > | |
| 8069 let start = reltime() | |
| 8070 call MyFunction() | |
| 8071 echo reltimestr(reltime(start)) | |
| 8072 < Note that overhead for the commands will be added to the time. | |
| 8073 The accuracy depends on the system. | |
| 1156 | 8074 Leading spaces are used to make the string align nicely. You |
| 8075 can use split() to remove it. > | |
| 8076 echo split(reltimestr(reltime(start)))[0] | |
| 8077 < Also see |profiling|. | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8078 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8079 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8080 reltime(start)->reltimestr() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8081 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8082 < {only available when compiled with the |+reltime| feature} |
| 794 | 8083 |
| 7 | 8084 *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
|
8085 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
|
8086 Send the {string} to {server}. The string is sent as an |
| 7 | 8087 expression and the result is returned after evaluation. |
| 714 | 8088 The result must be a String or a |List|. A |List| is turned |
| 8089 into a String by joining the items with a line break in | |
| 8090 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
|
8091 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
|
8092 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
|
8093 |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
|
8094 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
|
8095 seconds. Otherwise a timeout of 600 seconds is used. |
| 7 | 8096 See also |clientserver| |RemoteReply|. |
| 8097 This function is not available in the |sandbox|. | |
| 8098 {only available when compiled with the |+clientserver| feature} | |
| 8099 Note: Any errors will cause a local error message to be issued | |
| 8100 and the result will be the empty string. | |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
8101 |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
8102 Variables will be evaluated in the global namespace, |
| 12785 | 8103 independent of a function currently being active. Except |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
8104 when in debug mode, then local function variables and |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
8105 arguments can be evaluated. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
8106 |
| 7 | 8107 Examples: > |
| 8108 :echo remote_expr("gvim", "2+2") | |
| 8109 :echo remote_expr("gvim1", "b:current_syntax") | |
| 8110 < | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8111 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8112 ServerName()->remote_expr(expr) |
| 7 | 8113 |
| 8114 remote_foreground({server}) *remote_foreground()* | |
| 8115 Move the Vim server with the name {server} to the foreground. | |
| 8116 This works like: > | |
| 8117 remote_expr({server}, "foreground()") | |
| 8118 < Except that on Win32 systems the client does the work, to work | |
| 8119 around the problem that the OS doesn't always allow the server | |
| 8120 to bring itself to the foreground. | |
| 574 | 8121 Note: This does not restore the window if it was minimized, |
| 8122 like foreground() does. | |
| 7 | 8123 This function is not available in the |sandbox|. |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8124 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8125 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8126 ServerName()->remote_foreground() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8127 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8128 < {only in the Win32, Athena, Motif and GTK GUI versions and the |
| 7 | 8129 Win32 console version} |
| 8130 | |
| 8131 | |
| 8132 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
| 8133 Returns a positive number if there are available strings | |
| 8134 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
|
8135 {retvar} if specified. {retvar} must be a string with the |
| 7 | 8136 name of a variable. |
| 8137 Returns zero if none are available. | |
| 8138 Returns -1 if something is wrong. | |
| 8139 See also |clientserver|. | |
| 8140 This function is not available in the |sandbox|. | |
| 8141 {only available when compiled with the |+clientserver| feature} | |
| 8142 Examples: > | |
| 8143 :let repl = "" | |
| 8144 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
| 8145 | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8146 < Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8147 ServerId()->remote_peek() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8148 |
|
11211
71311d899b42
patch 8.0.0492: a failing client-server request can make Vim hang
Christian Brabandt <cb@256bit.org>
parents:
11181
diff
changeset
|
8149 remote_read({serverid}, [{timeout}]) *remote_read()* |
| 7 | 8150 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
|
8151 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
|
8152 reply is available. |
| 7 | 8153 See also |clientserver|. |
| 8154 This function is not available in the |sandbox|. | |
| 8155 {only available when compiled with the |+clientserver| feature} | |
| 8156 Example: > | |
| 8157 :echo remote_read(id) | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8158 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8159 < Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8160 ServerId()->remote_read() |
| 7 | 8161 < |
| 8162 *remote_send()* *E241* | |
| 8163 remote_send({server}, {string} [, {idvar}]) | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8164 Send the {string} to {server}. The string is sent as input |
| 22 | 8165 keys and the function returns immediately. At the Vim server |
| 8166 the keys are not mapped |:map|. | |
| 667 | 8167 If {idvar} is present, it is taken as the name of a variable |
| 8168 and a {serverid} for later use with remote_read() is stored | |
| 8169 there. | |
| 7 | 8170 See also |clientserver| |RemoteReply|. |
| 8171 This function is not available in the |sandbox|. | |
| 8172 {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
|
8173 |
| 7 | 8174 Note: Any errors will be reported in the server and may mess |
| 8175 up the display. | |
| 8176 Examples: > | |
| 8177 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
| 8178 \ remote_read(serverid) | |
| 8179 | |
| 8180 :autocmd NONE RemoteReply * | |
| 8181 \ echo remote_read(expand("<amatch>")) | |
| 8182 :echo remote_send("gvim", ":sleep 10 | echo ". | |
| 8183 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
| 82 | 8184 < |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8185 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8186 ServerName()->remote_send(keys) |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8187 < |
|
11177
76fb679a310e
patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
8188 *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
|
8189 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
|
8190 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
|
8191 server, when |v:servername| is not empty. |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8192 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8193 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8194 ServerName()->remote_startserver() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8195 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8196 < {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
|
8197 |
| 79 | 8198 remove({list}, {idx} [, {end}]) *remove()* |
| 685 | 8199 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
|
8200 return the item. |
| 79 | 8201 With {end}: Remove items from {idx} to {end} (inclusive) and |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8202 return a List with these items. When {idx} points to the same |
| 79 | 8203 item as {end} a list with one item is returned. When {end} |
| 8204 points to an item before {idx} this is an error. | |
| 8205 See |list-index| for possible values of {idx} and {end}. | |
| 55 | 8206 Example: > |
| 8207 :echo "last item: " . remove(mylist, -1) | |
| 79 | 8208 :call remove(mylist, 0, 9) |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
8209 < |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
8210 Use |delete()| to remove a file. |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
8211 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8212 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8213 mylist->remove(idx) |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8214 |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8215 remove({blob}, {idx} [, {end}]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8216 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
|
8217 return the byte. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8218 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
|
8219 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
|
8220 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
|
8221 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
|
8222 Example: > |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8223 :echo "last byte: " . remove(myblob, -1) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8224 :call remove(mylist, 0, 9) |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
8225 |
| 99 | 8226 remove({dict}, {key}) |
| 17571 | 8227 Remove the entry from {dict} with key {key} and return it. |
| 8228 Example: > | |
| 99 | 8229 :echo "removed " . remove(dict, "one") |
| 8230 < If there is no {key} in {dict} this is an error. | |
| 8231 | |
| 7 | 8232 rename({from}, {to}) *rename()* |
| 8233 Rename the file by the name {from} to the name {to}. This | |
| 8234 should also work to move files across file systems. The | |
| 8235 result is a Number, which is 0 if the file was renamed | |
| 8236 successfully, and non-zero when the renaming failed. | |
| 1851 | 8237 NOTE: If {to} exists it is overwritten without warning. |
| 7 | 8238 This function is not available in the |sandbox|. |
| 8239 | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8240 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8241 GetOldName()->rename(newname) |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8242 |
| 18 | 8243 repeat({expr}, {count}) *repeat()* |
| 8244 Repeat {expr} {count} times and return the concatenated | |
| 8245 result. Example: > | |
| 843 | 8246 :let separator = repeat('-', 80) |
| 18 | 8247 < When {count} is zero or negative the result is empty. |
| 685 | 8248 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
|
8249 {count} times. Example: > |
| 79 | 8250 :let longlist = repeat(['a', 'b'], 3) |
| 8251 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
| 18 | 8252 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8253 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8254 mylist->repeat(count) |
| 82 | 8255 |
| 7 | 8256 resolve({filename}) *resolve()* *E655* |
| 8257 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
| 8258 returns the path the shortcut points to in a simplified form. | |
|
15774
c4efa095f323
patch 8.1.0894: MS-Windows: resolve() does not return a reparse point
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
8259 When {filename} is a symbolic link or junction point, return |
|
c4efa095f323
patch 8.1.0894: MS-Windows: resolve() does not return a reparse point
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
8260 the full path to the target. If the target of junction is |
|
c4efa095f323
patch 8.1.0894: MS-Windows: resolve() does not return a reparse point
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
8261 removed, return {filename}. |
| 7 | 8262 On Unix, repeat resolving symbolic links in all path |
| 8263 components of {filename} and return the simplified result. | |
| 8264 To cope with link cycles, resolving of symbolic links is | |
| 8265 stopped after 100 iterations. | |
| 8266 On other systems, return the simplified {filename}. | |
| 8267 The simplification step is done as by |simplify()|. | |
| 8268 resolve() keeps a leading path component specifying the | |
| 8269 current directory (provided the result is still a relative | |
| 8270 path name) and also keeps a trailing path separator. | |
| 8271 | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8272 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8273 GetName()->resolve() |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8274 |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8275 reverse({object}) *reverse()* |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8276 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
|
8277 {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
|
8278 Returns {object}. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8279 If you want an object to remain unmodified make a copy first: > |
| 82 | 8280 :let revlist = reverse(copy(mylist)) |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8281 < Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8282 mylist->reverse() |
| 82 | 8283 |
| 1621 | 8284 round({expr}) *round()* |
| 1668 | 8285 Round off {expr} to the nearest integral value and return it |
| 1621 | 8286 as a |Float|. If {expr} lies halfway between two integral |
| 8287 values, then use the larger one (away from zero). | |
| 8288 {expr} must evaluate to a |Float| or a |Number|. | |
| 8289 Examples: > | |
| 8290 echo round(0.456) | |
| 8291 < 0.0 > | |
| 8292 echo round(4.5) | |
| 8293 < 5.0 > | |
| 8294 echo round(-4.5) | |
| 8295 < -5.0 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
8296 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
8297 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
8298 Compute()->round() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
8299 < |
| 1621 | 8300 {only available when compiled with the |+float| feature} |
| 3996 | 8301 |
|
16103
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8302 rubyeval({expr}) *rubyeval()* |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8303 Evaluate Ruby expression {expr} and return its result |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8304 converted to Vim data structures. |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8305 Numbers, floats and strings are returned as they are (strings |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8306 are copied though). |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8307 Arrays are represented as Vim |List| type. |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8308 Hashes are represented as Vim |Dictionary| type. |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8309 Other objects are represented as strings resulted from their |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8310 "Object#to_s" method. |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8311 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8312 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8313 GetRubyExpr()->rubyeval() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8314 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8315 < {only available when compiled with the |+ruby| feature} |
|
16103
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8316 |
| 12785 | 8317 screenattr({row}, {col}) *screenattr()* |
|
10027
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
10004
diff
changeset
|
8318 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
|
8319 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
|
8320 attribute at other positions. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8321 |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8322 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8323 GetRow()->screenattr(col) |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8324 |
| 12785 | 8325 screenchar({row}, {col}) *screenchar()* |
|
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8326 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
|
8327 [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
|
8328 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
|
8329 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
|
8330 The character excludes composing characters. For double-byte |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8331 encodings it may only be the first byte. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8332 This is mainly to be used for testing. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8333 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
|
8334 |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8335 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8336 GetRow()->screenchar(col) |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8337 |
|
16133
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8338 screenchars({row}, {col}) *screenchars()* |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8339 The result is a List of Numbers. The first number is the same |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8340 as what |screenchar()| returns. Further numbers are |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8341 composing characters on top of the base character. |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8342 This is mainly to be used for testing. |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8343 Returns an empty List when row or col is out of range. |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8344 |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8345 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8346 GetRow()->screenchars(col) |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8347 |
| 3996 | 8348 screencol() *screencol()* |
| 8349 The result is a Number, which is the current screen column of | |
| 8350 the cursor. The leftmost column has number 1. | |
| 8351 This function is mainly used for testing. | |
| 8352 | |
| 8353 Note: Always returns the current screen column, thus if used | |
| 8354 in a command (e.g. ":echo screencol()") it will return the | |
| 8355 column inside the command line, which is 1 when the command is | |
| 8356 executed. To get the cursor position in the file use one of | |
| 8357 the following mappings: > | |
| 8358 nnoremap <expr> GG ":echom ".screencol()."\n" | |
| 8359 nnoremap <silent> GG :echom screencol()<CR> | |
| 8360 < | |
|
17292
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8361 screenpos({winid}, {lnum}, {col}) *screenpos()* |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8362 The result is a Dict with the screen position of the text |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8363 character in window {winid} at buffer line {lnum} and column |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8364 {col}. {col} is a one-based byte index. |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8365 The Dict has these members: |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8366 row screen row |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8367 col first screen column |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8368 endcol last screen column |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8369 curscol cursor screen column |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8370 If the specified position is not visible, all values are zero. |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8371 The "endcol" value differs from "col" when the character |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8372 occupies more than one screen cell. E.g. for a Tab "col" can |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8373 be 1 and "endcol" can be 8. |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8374 The "curscol" value is where the cursor would be placed. For |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8375 a Tab it would be the same as "endcol", while for a double |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8376 width character it would be the same as "col". |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8377 |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8378 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8379 GetWinid()->screenpos(lnum, col) |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8380 |
| 3996 | 8381 screenrow() *screenrow()* |
| 8382 The result is a Number, which is the current screen row of the | |
| 8383 cursor. The top line has number one. | |
| 8384 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
|
8385 Alternatively you can use |winline()|. |
| 3996 | 8386 |
| 8387 Note: Same restrictions as with |screencol()|. | |
| 8388 | |
|
16133
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8389 screenstring({row}, {col}) *screenstring()* |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8390 The result is a String that contains the base character and |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8391 any composing characters at position [row, col] on the screen. |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8392 This is like |screenchars()| but returning a String with the |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8393 characters. |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8394 This is mainly to be used for testing. |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8395 Returns an empty String when row or col is out of range. |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8396 |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8397 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8398 GetRow()->screenstring(col) |
|
20725
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8399 < |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8400 *search()* |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8401 search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]]) |
| 7 | 8402 Search for regexp pattern {pattern}. The search starts at the |
| 119 | 8403 cursor position (you can use |cursor()| to set it). |
| 707 | 8404 |
| 3967 | 8405 When a match has been found its line number is returned. |
| 3312 | 8406 If there is no match a 0 is returned and the cursor doesn't |
| 8407 move. No error message is given. | |
| 8408 | |
| 7 | 8409 {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
|
8410 'b' search Backward instead of forward |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
8411 'c' accept a match at the Cursor position |
| 712 | 8412 'e' move to the End of the match |
| 20 | 8413 '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
|
8414 '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
|
8415 '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
|
8416 '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
|
8417 '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
|
8418 'z' start searching at the cursor column instead of zero |
| 7 | 8419 If neither 'w' or 'W' is given, the 'wrapscan' option applies. |
| 8420 | |
| 444 | 8421 If the 's' flag is supplied, the ' mark is set, only if the |
| 8422 cursor is moved. The 's' flag cannot be combined with the 'n' | |
| 8423 flag. | |
| 8424 | |
| 1156 | 8425 'ignorecase', 'smartcase' and 'magic' are used. |
| 12785 | 8426 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
8427 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
|
8428 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
|
8429 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
|
8430 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
|
8431 one column further. |
| 1156 | 8432 |
| 692 | 8433 When the {stopline} argument is given then the search stops |
| 8434 after searching this line. This is useful to restrict the | |
| 8435 search to a range of lines. Examples: > | |
| 8436 let match = search('(', 'b', line("w0")) | |
| 8437 let end = search('END', '', line("w$")) | |
| 8438 < When {stopline} is used and it is not zero this also implies | |
| 8439 that the search does not wrap around the end of the file. | |
| 1496 | 8440 A zero value is equal to not giving the argument. |
| 8441 | |
| 8442 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
|
8443 more than this many milliseconds have passed. Thus when |
| 1496 | 8444 {timeout} is 500 the search stops after half a second. |
| 8445 The value must not be negative. A zero value is like not | |
| 8446 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
|
8447 {only available when compiled with the |+reltime| feature} |
| 692 | 8448 |
|
20725
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8449 If the {skip} expression is given it is evaluated with the |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8450 cursor positioned on the start of a match. If it evaluates to |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8451 non-zero this match is skipped. This can be used, for |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8452 example, to skip a match in a comment or a string. |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8453 {skip} can be a string, which is evaluated as an expression, a |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8454 function reference or a lambda. |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8455 When {skip} is omitted or empty, every match is accepted. |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8456 When evaluating {skip} causes an error the search is aborted |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8457 and -1 returned. |
| 714 | 8458 *search()-sub-match* |
| 8459 With the 'p' flag the returned value is one more than the | |
| 8460 first sub-match in \(\). One if none of them matched but the | |
| 8461 whole pattern did match. | |
| 712 | 8462 To get the column number too use |searchpos()|. |
| 8463 | |
| 20 | 8464 The cursor will be positioned at the match, unless the 'n' |
| 707 | 8465 flag is used. |
| 7 | 8466 |
| 8467 Example (goes over all files in the argument list): > | |
| 8468 :let n = 1 | |
| 8469 :while n <= argc() " loop over all files in arglist | |
| 8470 : exe "argument " . n | |
| 8471 : " start at the last char in the file and wrap for the | |
| 8472 : " first search to find match at start of file | |
| 8473 : normal G$ | |
| 8474 : let flags = "w" | |
| 8475 : while search("foo", flags) > 0 | |
| 1621 | 8476 : s/foo/bar/g |
| 7 | 8477 : let flags = "W" |
| 8478 : endwhile | |
| 8479 : update " write the file if modified | |
| 8480 : let n = n + 1 | |
| 8481 :endwhile | |
| 8482 < | |
| 712 | 8483 Example for using some flags: > |
| 8484 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
| 8485 < This will search for the keywords "if", "else", and "endif" | |
| 8486 under or after the cursor. Because of the 'p' flag, it | |
| 8487 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
| 8488 if the search fails. With the cursor on the first word of the | |
| 8489 line: | |
| 8490 if (foo == 0) | let foo = foo + 1 | endif ~ | |
| 8491 the function returns 1. Without the 'c' flag, the function | |
| 8492 finds the "endif" and returns 3. The same thing happens | |
| 8493 without the 'e' flag if the cursor is on the "f" of "if". | |
| 8494 The 'n' flag tells the function not to move the cursor. | |
| 8495 | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8496 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8497 GetPattern()->search() |
| 504 | 8498 |
|
20647
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8499 searchcount([{options}]) *searchcount()* |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8500 Get or update the last search count, like what is displayed |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8501 without the "S" flag in 'shortmess'. This works even if |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8502 'shortmess' does contain the "S" flag. |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8503 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8504 This returns a Dictionary. The dictionary is empty if the |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8505 previous pattern was not set and "pattern" was not specified. |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8506 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8507 key type meaning ~ |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8508 current |Number| current position of match; |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8509 0 if the cursor position is |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8510 before the first match |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8511 exact_match |Boolean| 1 if "current" is matched on |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8512 "pos", otherwise 0 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8513 total |Number| total count of matches found |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8514 incomplete |Number| 0: search was fully completed |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8515 1: recomputing was timed out |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8516 2: max count exceeded |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8517 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8518 For {options} see further down. |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8519 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8520 To get the last search count when |n| or |N| was pressed, call |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8521 this function with `recompute: 0` . This sometimes returns |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8522 wrong information because |n| and |N|'s maximum count is 99. |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8523 If it exceeded 99 the result must be max count + 1 (100). If |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8524 you want to get correct information, specify `recompute: 1`: > |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8525 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8526 " result == maxcount + 1 (100) when many matches |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8527 let result = searchcount(#{recompute: 0}) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8528 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8529 " Below returns correct result (recompute defaults |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8530 " to 1) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8531 let result = searchcount() |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8532 < |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8533 The function is useful to add the count to |statusline|: > |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8534 function! LastSearchCount() abort |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8535 let result = searchcount(#{recompute: 0}) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8536 if empty(result) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8537 return '' |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8538 endif |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8539 if result.incomplete ==# 1 " timed out |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8540 return printf(' /%s [?/??]', @/) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8541 elseif result.incomplete ==# 2 " max count exceeded |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8542 if result.total > result.maxcount && |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8543 \ result.current > result.maxcount |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8544 return printf(' /%s [>%d/>%d]', @/, |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8545 \ result.current, result.total) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8546 elseif result.total > result.maxcount |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8547 return printf(' /%s [%d/>%d]', @/, |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8548 \ result.current, result.total) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8549 endif |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8550 endif |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8551 return printf(' /%s [%d/%d]', @/, |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8552 \ result.current, result.total) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8553 endfunction |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8554 let &statusline .= '%{LastSearchCount()}' |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8555 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8556 " Or if you want to show the count only when |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8557 " 'hlsearch' was on |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8558 " let &statusline .= |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8559 " \ '%{v:hlsearch ? LastSearchCount() : ""}' |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8560 < |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8561 You can also update the search count, which can be useful in a |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8562 |CursorMoved| or |CursorMovedI| autocommand: > |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8563 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8564 autocmd CursorMoved,CursorMovedI * |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8565 \ let s:searchcount_timer = timer_start( |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8566 \ 200, function('s:update_searchcount')) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8567 function! s:update_searchcount(timer) abort |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8568 if a:timer ==# s:searchcount_timer |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8569 call searchcount(#{ |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8570 \ recompute: 1, maxcount: 0, timeout: 100}) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8571 redrawstatus |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8572 endif |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8573 endfunction |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8574 < |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8575 This can also be used to count matched texts with specified |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8576 pattern in the current buffer using "pattern": > |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8577 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8578 " Count '\<foo\>' in this buffer |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8579 " (Note that it also updates search count) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8580 let result = searchcount(#{pattern: '\<foo\>'}) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8581 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8582 " To restore old search count by old pattern, |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8583 " search again |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8584 call searchcount() |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8585 < |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8586 {options} must be a Dictionary. It can contain: |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8587 key type meaning ~ |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8588 recompute |Boolean| if |TRUE|, recompute the count |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8589 like |n| or |N| was executed. |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8590 otherwise returns the last |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
8591 computed result (when |n| or |
|
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
8592 |N| was used when "S" is not |
|
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
8593 in 'shortmess', or this |
|
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
8594 function was called). |
|
20647
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8595 (default: |TRUE|) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8596 pattern |String| recompute if this was given |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8597 and different with |@/|. |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8598 this works as same as the |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8599 below command is executed |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8600 before calling this function > |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8601 let @/ = pattern |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8602 < (default: |@/|) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8603 timeout |Number| 0 or negative number is no |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8604 timeout. timeout milliseconds |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8605 for recomputing the result |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8606 (default: 0) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8607 maxcount |Number| 0 or negative number is no |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8608 limit. max count of matched |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8609 text while recomputing the |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8610 result. if search exceeded |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8611 total count, "total" value |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8612 becomes `maxcount + 1` |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8613 (default: 0) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8614 pos |List| `[lnum, col, off]` value |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8615 when recomputing the result. |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8616 this changes "current" result |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8617 value. see |cursor()|, |getpos() |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8618 (default: cursor's position) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8619 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
8620 |
| 523 | 8621 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
| 8622 Search for the declaration of {name}. | |
| 856 | 8623 |
| 523 | 8624 With a non-zero {global} argument it works like |gD|, find |
| 8625 first match in the file. Otherwise it works like |gd|, find | |
| 8626 first match in the function. | |
| 8627 | |
| 8628 With a non-zero {thisblock} argument matches in a {} block | |
| 8629 that ends before the cursor position are ignored. Avoids | |
| 8630 finding variable declarations only valid in another scope. | |
| 8631 | |
| 504 | 8632 Moves the cursor to the found match. |
| 8633 Returns zero for success, non-zero for failure. | |
| 8634 Example: > | |
| 8635 if searchdecl('myvar') == 0 | |
| 8636 echo getline('.') | |
| 8637 endif | |
| 8638 < | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8639 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8640 GetName()->searchdecl() |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8641 < |
| 7 | 8642 *searchpair()* |
| 1496 | 8643 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
| 8644 [, {stopline} [, {timeout}]]]]) | |
| 7 | 8645 Search for the match of a nested start-end pair. This can be |
| 8646 used to find the "endif" that matches an "if", while other | |
| 8647 if/endif pairs in between are ignored. | |
| 677 | 8648 The search starts at the cursor. The default is to search |
| 8649 forward, include 'b' in {flags} to search backward. | |
| 8650 If a match is found, the cursor is positioned at it and the | |
| 8651 line number is returned. If no match is found 0 or -1 is | |
| 8652 returned and the cursor doesn't move. No error message is | |
| 8653 given. | |
| 7 | 8654 |
| 8655 {start}, {middle} and {end} are patterns, see |pattern|. They | |
| 8656 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
| 8657 {middle} is not empty, it is found when searching from either | |
| 8658 direction, but only when not in a nested start-end pair. A | |
| 8659 typical use is: > | |
| 8660 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
| 8661 < By leaving {middle} empty the "else" is skipped. | |
| 8662 | |
| 712 | 8663 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
| 8664 |search()|. Additionally: | |
| 7 | 8665 'r' Repeat until no more matches found; will find the |
| 1621 | 8666 outer pair. Implies the 'W' flag. |
| 8667 'm' Return number of matches instead of line number with | |
| 712 | 8668 the match; will be > 1 when 'r' is used. |
| 1621 | 8669 Note: it's nearly always a good idea to use the 'W' flag, to |
| 8670 avoid wrapping around the end of the file. | |
| 7 | 8671 |
| 8672 When a match for {start}, {middle} or {end} is found, the | |
| 8673 {skip} expression is evaluated with the cursor positioned on | |
| 8674 the start of the match. It should return non-zero if this | |
| 8675 match is to be skipped. E.g., because it is inside a comment | |
| 8676 or a string. | |
| 8677 When {skip} is omitted or empty, every match is accepted. | |
| 8678 When evaluating {skip} causes an error the search is aborted | |
| 8679 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
|
8680 {skip} can be a string, a lambda, a funcref or a partial. |
| 14193 | 8681 Anything else makes the function fail. |
| 7 | 8682 |
| 1496 | 8683 For {stopline} and {timeout} see |search()|. |
| 692 | 8684 |
| 7 | 8685 The value of 'ignorecase' is used. 'magic' is ignored, the |
| 8686 patterns are used like it's on. | |
| 8687 | |
| 8688 The search starts exactly at the cursor. A match with | |
| 8689 {start}, {middle} or {end} at the next character, in the | |
| 8690 direction of searching, is the first one found. Example: > | |
| 8691 if 1 | |
| 8692 if 2 | |
| 8693 endif 2 | |
| 8694 endif 1 | |
| 8695 < When starting at the "if 2", with the cursor on the "i", and | |
| 8696 searching forwards, the "endif 2" is found. When starting on | |
| 8697 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
|
8698 found. That's because the "if 2" will be found first, and |
| 7 | 8699 then this is considered to be a nested if/endif from "if 2" to |
| 8700 "endif 2". | |
| 8701 When searching backwards and {end} is more than one character, | |
| 8702 it may be useful to put "\zs" at the end of the pattern, so | |
| 8703 that when the cursor is inside a match with the end it finds | |
| 8704 the matching start. | |
| 8705 | |
| 8706 Example, to find the "endif" command in a Vim script: > | |
| 8707 | |
| 8708 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
| 8709 \ 'getline(".") =~ "^\\s*\""') | |
| 8710 | |
| 8711 < The cursor must be at or after the "if" for which a match is | |
| 8712 to be found. Note that single-quote strings are used to avoid | |
| 8713 having to double the backslashes. The skip expression only | |
| 8714 catches comments at the start of a line, not after a command. | |
| 8715 Also, a word "en" or "if" halfway a line is considered a | |
| 8716 match. | |
| 8717 Another example, to search for the matching "{" of a "}": > | |
| 8718 | |
| 8719 :echo searchpair('{', '', '}', 'bW') | |
| 8720 | |
| 8721 < This works when the cursor is at or before the "}" for which a | |
| 8722 match is to be found. To reject matches that syntax | |
| 8723 highlighting recognized as strings: > | |
| 8724 | |
| 8725 :echo searchpair('{', '', '}', 'bW', | |
| 8726 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
| 8727 < | |
| 667 | 8728 *searchpairpos()* |
| 1496 | 8729 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
| 8730 [, {stopline} [, {timeout}]]]]) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8731 Same as |searchpair()|, but returns a |List| with the line and |
| 685 | 8732 column position of the match. The first element of the |List| |
| 8733 is the line number and the second element is the byte index of | |
| 667 | 8734 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
|
8735 returns [0, 0]. > |
|
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
8736 |
| 667 | 8737 :let [lnum,col] = searchpairpos('{', '', '}', 'n') |
| 8738 < | |
| 8739 See |match-parens| for a bigger and more useful example. | |
| 8740 | |
|
20725
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8741 *searchpos()* |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8742 searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]]) |
| 692 | 8743 Same as |search()|, but returns a |List| with the line and |
| 685 | 8744 column position of the match. The first element of the |List| |
| 8745 is the line number and the second element is the byte index of | |
| 8746 the column position of the match. If no match is found, | |
| 8747 returns [0, 0]. | |
| 714 | 8748 Example: > |
| 8749 :let [lnum, col] = searchpos('mypattern', 'n') | |
| 8750 | |
| 8751 < When the 'p' flag is given then there is an extra item with | |
| 8752 the sub-pattern match number |search()-sub-match|. Example: > | |
| 8753 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
| 8754 < In this example "submatch" is 2 when a lowercase letter is | |
| 8755 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
| 8756 | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8757 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8758 GetPattern()->searchpos() |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8759 |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
8760 server2client({clientid}, {string}) *server2client()* |
| 7 | 8761 Send a reply string to {clientid}. The most recent {clientid} |
| 8762 that sent a string can be retrieved with expand("<client>"). | |
| 8763 {only available when compiled with the |+clientserver| feature} | |
| 8764 Note: | |
| 8765 This id has to be stored before the next command can be | |
| 236 | 8766 received. I.e. before returning from the received command and |
| 7 | 8767 before calling any commands that waits for input. |
| 8768 See also |clientserver|. | |
| 8769 Example: > | |
| 8770 :echo server2client(expand("<client>"), "HELLO") | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8771 |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8772 < Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8773 GetClientId()->server2client(string) |
| 7 | 8774 < |
| 8775 serverlist() *serverlist()* | |
| 8776 Return a list of available server names, one per line. | |
| 8777 When there are no servers or the information is not available | |
| 8778 an empty string is returned. See also |clientserver|. | |
| 8779 {only available when compiled with the |+clientserver| feature} | |
| 8780 Example: > | |
| 8781 :echo serverlist() | |
| 8782 < | |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
8783 setbufline({expr}, {lnum}, {text}) *setbufline()* |
| 18343 | 8784 Set line {lnum} to {text} in buffer {expr}. This works like |
| 8785 |setline()| for the specified buffer. | |
| 8786 | |
| 8787 This function works only for loaded buffers. First call | |
| 8788 |bufload()| if needed. | |
| 8789 | |
| 8790 To insert lines use |appendbufline()|. | |
| 8791 Any text properties in {lnum} are cleared. | |
| 8792 | |
| 8793 {text} can be a string to set one line, or a list of strings | |
| 8794 to set multiple lines. If the list extends below the last | |
| 8795 line then those lines are added. | |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
8796 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
8797 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
|
8798 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
8799 {lnum} is used like with |setline()|. |
| 18343 | 8800 When {lnum} is just below the last line the {text} will be |
| 8801 added below the last line. | |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
8802 |
|
17259
6dbb9b3c53e2
patch 8.1.1629: terminal function help is in the wrong file
Bram Moolenaar <Bram@vim.org>
parents:
17257
diff
changeset
|
8803 When {expr} is not a valid buffer, the buffer is not loaded or |
|
6dbb9b3c53e2
patch 8.1.1629: terminal function help is in the wrong file
Bram Moolenaar <Bram@vim.org>
parents:
17257
diff
changeset
|
8804 {lnum} is not valid then 1 is returned. On success 0 is |
|
6dbb9b3c53e2
patch 8.1.1629: terminal function help is in the wrong file
Bram Moolenaar <Bram@vim.org>
parents:
17257
diff
changeset
|
8805 returned. |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
8806 |
| 18343 | 8807 Can also be used as a |method|, the base is passed as the |
| 8808 third argument: > | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8809 GetText()->setbufline(buf, lnum) |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8810 |
| 7 | 8811 setbufvar({expr}, {varname}, {val}) *setbufvar()* |
| 8812 Set option or local variable {varname} in buffer {expr} to | |
| 8813 {val}. | |
| 8814 This also works for a global or local window option, but it | |
| 8815 doesn't work for a global or local window variable. | |
| 8816 For a local window option the global value is unchanged. | |
| 8817 For the use of {expr}, see |bufname()| above. | |
| 8818 Note that the variable name without "b:" must be used. | |
| 8819 Examples: > | |
| 8820 :call setbufvar(1, "&mod", 1) | |
| 8821 :call setbufvar("todo", "myvar", "foobar") | |
| 8822 < This function is not available in the |sandbox|. | |
| 8823 | |
| 18343 | 8824 Can also be used as a |method|, the base is passed as the |
| 8825 third argument: > | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8826 GetValue()->setbufvar(buf, varname) |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8827 |
|
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
8828 setcharsearch({dict}) *setcharsearch()* |
| 6991 | 8829 Set the current character search information to {dict}, |
| 8830 which contains one or more of the following entries: | |
| 8831 | |
| 8832 char character which will be used for a subsequent | |
| 8833 |,| or |;| command; an empty string clears the | |
| 8834 character search | |
| 8835 forward direction of character search; 1 for forward, | |
| 8836 0 for backward | |
| 8837 until type of character search; 1 for a |t| or |T| | |
| 8838 character search, 0 for an |f| or |F| | |
| 8839 character search | |
| 8840 | |
| 8841 This can be useful to save/restore a user's character search | |
| 8842 from a script: > | |
| 8843 :let prevsearch = getcharsearch() | |
| 8844 :" Perform a command which clobbers user's search | |
| 8845 :call setcharsearch(prevsearch) | |
| 8846 < Also see |getcharsearch()|. | |
| 8847 | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8848 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8849 SavedSearch()->setcharsearch() |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8850 |
| 7 | 8851 setcmdpos({pos}) *setcmdpos()* |
| 8852 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
|
8853 {pos}. The first position is 1. |
| 7 | 8854 Use |getcmdpos()| to obtain the current position. |
| 8855 Only works while editing the command line, thus you must use | |
| 99 | 8856 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
| 8857 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
| 8858 set after the command line is set to the expression. For | |
| 8859 |c_CTRL-R_=| it is set after evaluating the expression but | |
| 8860 before inserting the resulting text. | |
| 7 | 8861 When the number is too big the cursor is put at the end of the |
| 8862 line. A number smaller than one has undefined results. | |
| 8863 Returns 0 when successful, 1 when not editing the command | |
| 8864 line. | |
| 8865 | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8866 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8867 GetPos()->setcmdpos() |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8868 |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
8869 setenv({name}, {val}) *setenv()* |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
8870 Set environment variable {name} to {val}. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
8871 When {val} is |v:null| the environment variable is deleted. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
8872 See also |expr-env|. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
8873 |
| 18343 | 8874 Can also be used as a |method|, the base is passed as the |
| 8875 second argument: > | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8876 GetPath()->setenv('PATH') |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8877 |
|
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
8878 setfperm({fname}, {mode}) *setfperm()* *chmod* |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
8879 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
|
8880 {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
|
8881 "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
|
8882 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
|
8883 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
|
8884 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
|
8885 characters are not supported. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
8886 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
8887 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
|
8888 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
|
8889 would do the same thing. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
8890 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
8891 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
|
8892 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
8893 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
8894 GetFilename()->setfperm(mode) |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
8895 < |
|
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
8896 To read permissions see |getfperm()|. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
8897 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
8898 |
| 1621 | 8899 setline({lnum}, {text}) *setline()* |
| 3312 | 8900 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
|
8901 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
|
8902 |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
|
8903 |
| 236 | 8904 {lnum} is used like with |getline()|. |
| 1621 | 8905 When {lnum} is just below the last line the {text} will be |
| 18343 | 8906 added below the last line. |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
8907 |
| 236 | 8908 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
|
8909 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
|
8910 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
8911 Example: > |
| 7 | 8912 :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
|
8913 |
| 1621 | 8914 < When {text} is a |List| then line {lnum} and following lines |
| 282 | 8915 will be set to the items in the list. Example: > |
| 8916 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
| 8917 < This is equivalent to: > | |
| 3465 | 8918 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']] |
| 282 | 8919 : call setline(n, l) |
| 8920 :endfor | |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
8921 |
| 7 | 8922 < Note: The '[ and '] marks are not set. |
| 8923 | |
| 18343 | 8924 Can also be used as a |method|, the base is passed as the |
| 8925 second argument: > | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8926 GetText()->setline(lnum) |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8927 |
| 12785 | 8928 setloclist({nr}, {list} [, {action} [, {what}]]) *setloclist()* |
| 647 | 8929 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
|
8930 {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
|
8931 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
|
8932 |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
8933 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
|
8934 modified. For an invalid window number {nr}, -1 is returned. |
| 1326 | 8935 Otherwise, same as |setqflist()|. |
| 8936 Also see |location-list|. | |
| 8937 | |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
8938 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
|
8939 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
|
8940 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
|
8941 |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
8942 Can also be used as a |method|, the base is passed as the |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
8943 second argument: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
8944 GetLoclist()->setloclist(winnr) |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
8945 |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
8946 setmatches({list} [, {win}]) *setmatches()* |
|
20178
2fb397573541
patch 8.2.0644: insufficient testing for invalid function arguments
Bram Moolenaar <Bram@vim.org>
parents:
20115
diff
changeset
|
8947 Restores a list of matches saved by |getmatches()| for the |
|
2fb397573541
patch 8.2.0644: insufficient testing for invalid function arguments
Bram Moolenaar <Bram@vim.org>
parents:
20115
diff
changeset
|
8948 current window. Returns 0 if successful, otherwise -1. All |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
8949 current matches are cleared before the list is restored. See |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
8950 example for |getmatches()|. |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
8951 If {win} is specified, use the window with this number or |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
8952 window ID instead of the current window. |
| 230 | 8953 |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
8954 Can also be used as a |method|: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
8955 GetMatches()->setmatches() |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
8956 < |
| 707 | 8957 *setpos()* |
| 8958 setpos({expr}, {list}) | |
| 8959 Set the position for {expr}. Possible values: | |
| 8960 . the cursor | |
| 8961 'x mark x | |
| 8962 | |
| 5938 | 8963 {list} must be a |List| with four or five numbers: |
| 707 | 8964 [bufnum, lnum, col, off] |
| 5938 | 8965 [bufnum, lnum, col, off, curswant] |
| 707 | 8966 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8967 "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
|
8968 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
|
8969 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
|
8970 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
|
8971 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
|
8972 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
|
8973 since these are associated with a window, not a buffer. |
| 798 | 8974 Does not change the jumplist. |
| 707 | 8975 |
| 8976 "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
|
8977 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
|
8978 smaller than 1 then 1 is used. |
| 707 | 8979 |
| 8980 The "off" number is only used when 'virtualedit' is set. Then | |
| 8981 it is the offset in screen columns from the start of the | |
| 1266 | 8982 character. E.g., a position within a <Tab> or after the last |
| 707 | 8983 character. |
| 8984 | |
| 5938 | 8985 The "curswant" number is only used when setting the cursor |
| 8986 position. It sets the preferred column for when moving the | |
| 8987 cursor vertically. When the "curswant" number is missing the | |
| 8988 preferred column is not set. When it is present and setting a | |
| 8989 mark position it is not used. | |
| 8990 | |
| 5555 | 8991 Note that for '< and '> changing the line number may result in |
| 8992 the marks to be effectively be swapped, so that '< is always | |
| 8993 before '>. | |
| 8994 | |
| 1533 | 8995 Returns 0 when the position could be set, -1 otherwise. |
| 8996 An error message is given if {expr} is invalid. | |
| 8997 | |
| 5944 | 8998 Also see |getpos()| and |getcurpos()|. |
| 707 | 8999 |
| 1156 | 9000 This does not restore the preferred column for moving |
| 5938 | 9001 vertically; if you set the cursor position with this, |j| and |
| 9002 |k| motions will jump to previous columns! Use |cursor()| to | |
| 9003 also set the preferred column. Also see the "curswant" key in | |
| 9004 |winrestview()|. | |
| 1156 | 9005 |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9006 Can also be used as a |method|: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9007 GetPosition()->setpos('.') |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9008 |
| 12785 | 9009 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
|
9010 Create or replace or add to the quickfix list. |
| 12785 | 9011 |
| 19646 | 9012 If the optional {what} dictionary argument is supplied, then |
| 9013 only the items listed in {what} are set. The first {list} | |
| 9014 argument is ignored. See below for the supported items in | |
| 9015 {what}. | |
| 9016 | |
| 9017 When {what} is not present, the items in {list} or used. Each | |
|
12048
ebd313aa5a6c
patch 8.0.0904: cannot set a location list from text
Christian Brabandt <cb@256bit.org>
parents:
12045
diff
changeset
|
9018 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
|
9019 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
|
9020 entries: |
| 230 | 9021 |
| 1065 | 9022 bufnr buffer number; must be the number of a valid |
| 1621 | 9023 buffer |
| 1065 | 9024 filename name of a file; only used when "bufnr" is not |
| 1621 | 9025 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
|
9026 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
|
9027 quickfix error window instead of the filename. |
| 230 | 9028 lnum line number in the file |
| 233 | 9029 pattern search pattern used to locate the error |
| 230 | 9030 col column number |
| 233 | 9031 vcol when non-zero: "col" is visual column |
| 856 | 9032 when zero: "col" is byte index |
| 233 | 9033 nr error number |
| 230 | 9034 text description of the error |
| 233 | 9035 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
|
9036 valid recognized error message |
| 233 | 9037 |
| 9038 The "col", "vcol", "nr", "type" and "text" entries are | |
| 9039 optional. Either "lnum" or "pattern" entry can be used to | |
| 9040 locate a matching error line. | |
| 1065 | 9041 If the "filename" and "bufnr" entries are not present or |
| 9042 neither the "lnum" or "pattern" entries are present, then the | |
| 9043 item will not be handled as an error line. | |
| 230 | 9044 If both "pattern" and "lnum" are present then "pattern" will |
| 9045 be used. | |
|
11390
73cfcf11d983
patch 8.0.0580: cannot set the valid flag with setqflist()
Christian Brabandt <cb@256bit.org>
parents:
11347
diff
changeset
|
9046 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
|
9047 set when "bufnr" is a valid buffer or "filename" exists. |
| 2152 | 9048 If you supply an empty {list}, the quickfix list will be |
| 9049 cleared. | |
| 1065 | 9050 Note that the list is not exactly the same as what |
| 9051 |getqflist()| returns. | |
| 230 | 9052 |
|
11263
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
9053 {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
|
9054 '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
|
9055 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
|
9056 new list is created. |
| 12785 | 9057 |
|
11263
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
9058 '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
|
9059 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
|
9060 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
|
9061 :call setqflist([], 'r') |
| 12785 | 9062 < |
|
11263
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
9063 '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
|
9064 freed. |
|
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
9065 |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
9066 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
|
9067 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
|
9068 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
|
9069 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
|
9070 set "nr" in {what} to "$". |
| 277 | 9071 |
| 19646 | 9072 The following items can be specified in dictionary {what}: |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
9073 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
|
9074 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
|
9075 "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
|
9076 '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
|
9077 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
|
9078 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
|
9079 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
|
9080 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
|
9081 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
|
9082 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
|
9083 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
|
9084 argument. |
|
12303
ec7a4fd21dd5
patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents:
12287
diff
changeset
|
9085 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
|
9086 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
|
9087 {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
|
9088 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
|
9089 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
|
9090 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
|
9091 the last quickfix list. |
|
20631
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
9092 quickfixtextfunc |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
9093 function to get the text to display in the |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
9094 quickfix window. Refer to |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
9095 |quickfix-window-function| for an explanation |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
9096 of how to write the function and an example. |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
9097 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
|
9098 Unsupported keys in {what} are ignored. |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
9099 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
|
9100 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
|
9101 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
|
9102 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
|
9103 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
|
9104 specify the list. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
9105 |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
9106 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
|
9107 :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
|
9108 :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'}) |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
9109 :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
|
9110 < |
| 230 | 9111 Returns zero for success, -1 for failure. |
| 9112 | |
| 9113 This function can be used to create a quickfix list | |
| 9114 independent of the 'errorformat' setting. Use a command like | |
|
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11390
diff
changeset
|
9115 `:cc 1` to jump to the first position. |
| 230 | 9116 |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9117 Can also be used as a |method|, the base is passed as the |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9118 second argument: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9119 GetErrorlist()->setqflist() |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9120 < |
| 7 | 9121 *setreg()* |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
9122 setreg({regname}, {value} [, {options}]) |
| 7 | 9123 Set the register {regname} to {value}. |
|
19783
546bdeef35f1
patch 8.2.0448: various functions not properly tested
Bram Moolenaar <Bram@vim.org>
parents:
19742
diff
changeset
|
9124 If {regname} is "" or "@", the unnamed register '"' is used. |
|
20743
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
9125 {value} may be any value returned by |getreg()| or |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
9126 |getreginfo()|, including a |List| or |Dict|. |
| 7 | 9127 If {options} contains "a" or {regname} is upper case, |
| 9128 then the value is appended. | |
| 2423 | 9129 {options} can also contain a register type specification: |
| 7 | 9130 "c" or "v" |characterwise| mode |
| 9131 "l" or "V" |linewise| mode | |
| 9132 "b" or "<CTRL-V>" |blockwise-visual| mode | |
| 9133 If a number immediately follows "b" or "<CTRL-V>" then this is | |
| 9134 used as the width of the selection - if it is not specified | |
| 9135 then the width of the block is set to the number of characters | |
| 1266 | 9136 in the longest line (counting a <Tab> as 1 character). |
| 7 | 9137 |
| 9138 If {options} contains no register settings, then the default | |
| 12785 | 9139 is to use character mode unless {value} ends in a <NL> for |
| 9140 string {value} and linewise mode for list {value}. Blockwise | |
| 5798 | 9141 mode is never selected automatically. |
| 9142 Returns zero for success, non-zero for failure. | |
| 9143 | |
| 9144 *E883* | |
| 12785 | 9145 Note: you may not use |List| containing more than one item to |
| 9146 set search and expression registers. Lists containing no | |
| 5798 | 9147 items act like empty strings. |
| 7 | 9148 |
| 9149 Examples: > | |
| 9150 :call setreg(v:register, @*) | |
| 9151 :call setreg('*', @%, 'ac') | |
| 9152 :call setreg('a', "1\n2\n3", 'b5') | |
|
20743
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
9153 :call setreg('"', { 'points_to': 'a'}) |
| 7 | 9154 |
| 9155 < 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
|
9156 register: > |
|
20743
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
9157 :let var_a = getreginfo() |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
9158 :call setreg('a', var_a) |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
9159 < or: |
| 5798 | 9160 :let var_a = getreg('a', 1, 1) |
| 7 | 9161 :let var_amode = getregtype('a') |
| 9162 .... | |
| 9163 :call setreg('a', var_a, var_amode) | |
| 12785 | 9164 < Note: you may not reliably restore register value |
| 9165 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
|
9166 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
|
9167 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
|
9168 |
|
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
9169 You can also change the type of a register by appending |
| 7 | 9170 nothing: > |
| 9171 :call setreg('a', '', 'al') | |
| 9172 | |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9173 < Can also be used as a |method|, the base is passed as the |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9174 second argument: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9175 GetText()->setreg('a') |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9176 |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
9177 settabvar({tabnr}, {varname}, {val}) *settabvar()* |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
9178 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
|
9179 |t:var| |
|
16849
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
9180 Note that autocommands are blocked, side effects may not be |
|
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
9181 triggered, e.g. when setting 'filetype'. |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
9182 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
|
9183 Tabs are numbered starting with one. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
9184 This function is not available in the |sandbox|. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
9185 |
| 18343 | 9186 Can also be used as a |method|, the base is passed as the |
| 9187 third argument: > | |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9188 GetValue()->settabvar(tab, name) |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9189 |
| 831 | 9190 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
| 9191 Set option or local variable {varname} in window {winnr} to | |
| 9192 {val}. | |
| 9193 Tabs are numbered starting with one. For the current tabpage | |
| 9194 use |setwinvar()|. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
9195 {winnr} can be the window number or the |window-ID|. |
| 831 | 9196 When {winnr} is zero the current window is used. |
|
16849
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
9197 Note that autocommands are blocked, side effects may not be |
|
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
9198 triggered, e.g. when setting 'filetype' or 'syntax'. |
| 7 | 9199 This also works for a global or local buffer option, but it |
| 9200 doesn't work for a global or local buffer variable. | |
| 9201 For a local buffer option the global value is unchanged. | |
| 9202 Note that the variable name without "w:" must be used. | |
| 831 | 9203 Examples: > |
| 9204 :call settabwinvar(1, 1, "&list", 0) | |
| 9205 :call settabwinvar(3, 2, "myvar", "foobar") | |
| 9206 < This function is not available in the |sandbox|. | |
| 9207 | |
| 18343 | 9208 Can also be used as a |method|, the base is passed as the |
| 9209 fourth argument: > | |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9210 GetValue()->settabvar(tab, winnr, name) |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9211 |
|
15016
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9212 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
|
9213 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
|
9214 {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
|
9215 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9216 For a list of supported items in {dict}, refer to |
|
19033
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9217 |gettagstack()|. "curidx" takes effect before changing the tag |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9218 stack. |
|
15016
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9219 *E962* |
|
19033
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9220 How the tag stack is modified depends on the {action} |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9221 argument: |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9222 - If {action} is not present or is set to 'r', then the tag |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9223 stack is replaced. |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9224 - If {action} is set to 'a', then new entries from {dict} are |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9225 pushed (added) onto the tag stack. |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9226 - If {action} is set to 't', then all the entries from the |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9227 current entry in the tag stack or "curidx" in {dict} are |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9228 removed and then new entries are pushed to the stack. |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9229 |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9230 The current index is set to one after the length of the tag |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9231 stack after the modification. |
|
15016
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9232 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9233 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
|
9234 |
| 19968 | 9235 Examples (for more examples see |tagstack-examples||): |
| 9236 Empty the tag stack of window 3: > | |
|
15016
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9237 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
|
9238 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9239 < 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
|
9240 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
|
9241 " do something else |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9242 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
|
9243 unlet stack |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9244 < |
| 18343 | 9245 Can also be used as a |method|, the base is passed as the |
| 9246 second argument: > | |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9247 GetStack()->settagstack(winnr) |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9248 |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9249 setwinvar({winnr}, {varname}, {val}) *setwinvar()* |
| 831 | 9250 Like |settabwinvar()| for the current tab page. |
| 7 | 9251 Examples: > |
| 9252 :call setwinvar(1, "&list", 0) | |
| 9253 :call setwinvar(2, "myvar", "foobar") | |
| 9254 | |
| 18343 | 9255 < Can also be used as a |method|, the base is passed as the |
| 9256 third argument: > | |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9257 GetValue()->setwinvar(winnr, name) |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9258 |
| 4126 | 9259 sha256({string}) *sha256()* |
| 6647 | 9260 Returns a String with 64 hex characters, which is the SHA256 |
| 4126 | 9261 checksum of {string}. |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9262 |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9263 Can also be used as a |method|: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9264 GetText()->sha256() |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9265 |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9266 < {only available when compiled with the |+cryptv| feature} |
| 4126 | 9267 |
| 1661 | 9268 shellescape({string} [, {special}]) *shellescape()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9269 Escape {string} for use as a shell command argument. |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
9270 On MS-Windows, when 'shellslash' is not set, it will enclose |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
9271 {string} in double quotes and double all double quotes within |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
9272 {string}. |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
9273 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
|
9274 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
|
9275 |
| 1661 | 9276 When the {special} argument is present and it's a non-zero |
| 9277 Number or a non-empty String (|non-zero-arg|), then special | |
| 1698 | 9278 items such as "!", "%", "#" and "<cword>" will be preceded by |
| 9279 a backslash. This backslash will be removed again by the |:!| | |
| 1661 | 9280 command. |
|
11502
46bbef0ee9a6
patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
9281 |
| 1698 | 9282 The "!" character will be escaped (again with a |non-zero-arg| |
| 9283 {special}) when 'shell' contains "csh" in the tail. That is | |
| 9284 because for csh and tcsh "!" is used for history replacement | |
| 9285 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
|
9286 |
|
46bbef0ee9a6
patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
9287 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
|
9288 escaped. When 'shell' containing "csh" in the tail it's |
| 1698 | 9289 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
|
9290 |
| 1661 | 9291 Example of use with a |:!| command: > |
| 9292 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
| 9293 < This results in a directory listing for the file under the | |
| 9294 cursor. Example of use with |system()|: > | |
| 9295 :call system("chmod +w -- " . shellescape(expand("%"))) | |
| 5690 | 9296 < See also |::S|. |
| 985 | 9297 |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9298 Can also be used as a |method|: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9299 GetCommand()->shellescape() |
| 985 | 9300 |
|
15062
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
15033
diff
changeset
|
9301 shiftwidth([{col}]) *shiftwidth()* |
| 3875 | 9302 Returns the effective value of 'shiftwidth'. This is the |
| 9303 '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
|
9304 '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
|
9305 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
|
9306 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
|
9307 |
|
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
15033
diff
changeset
|
9308 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
|
9309 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
|
9310 '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
|
9311 no {col} argument is given, column 1 will be assumed. |
| 15033 | 9312 |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9313 Can also be used as a |method|: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9314 GetColumn()->shiftwidth() |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9315 |
|
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
9316 sign_ functions are documented here: |sign-functions-details| |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
9317 |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
9318 |
| 7 | 9319 simplify({filename}) *simplify()* |
| 9320 Simplify the file name as much as possible without changing | |
| 9321 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
| 9322 Unix) are not resolved. If the first path component in | |
| 9323 {filename} designates the current directory, this will be | |
| 9324 valid for the result as well. A trailing path separator is | |
| 9325 not removed either. | |
| 9326 Example: > | |
| 9327 simplify("./dir/.././/file/") == "./file/" | |
| 9328 < Note: The combination "dir/.." is only removed if "dir" is | |
| 9329 a searchable directory or does not exist. On Unix, it is also | |
| 9330 removed when "dir" is a symbolic link within the same | |
| 9331 directory. In order to resolve all the involved symbolic | |
| 9332 links before simplifying the path name, use |resolve()|. | |
| 9333 | |
|
19952
82ea10d554fb
patch 8.2.0532: cannot use simplify() as a method
Bram Moolenaar <Bram@vim.org>
parents:
19874
diff
changeset
|
9334 Can also be used as a |method|: > |
|
82ea10d554fb
patch 8.2.0532: cannot use simplify() as a method
Bram Moolenaar <Bram@vim.org>
parents:
19874
diff
changeset
|
9335 GetName()->simplify() |
| 82 | 9336 |
| 1621 | 9337 sin({expr}) *sin()* |
| 9338 Return the sine of {expr}, measured in radians, as a |Float|. | |
| 9339 {expr} must evaluate to a |Float| or a |Number|. | |
| 9340 Examples: > | |
| 9341 :echo sin(100) | |
| 9342 < -0.506366 > | |
| 9343 :echo sin(-4.01) | |
| 9344 < 0.763301 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9345 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9346 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9347 Compute()->sin() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9348 < |
| 1621 | 9349 {only available when compiled with the |+float| feature} |
| 12785 | 9350 |
| 1621 | 9351 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9352 sinh({expr}) *sinh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
9353 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
|
9354 [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
9355 {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
|
9356 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9357 :echo sinh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9358 < 0.521095 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9359 :echo sinh(-0.9) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9360 < -1.026517 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9361 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9362 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9363 Compute()->sinh() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9364 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
9365 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9366 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9367 |
| 2902 | 9368 sort({list} [, {func} [, {dict}]]) *sort()* *E702* |
| 5747 | 9369 Sort the items in {list} in-place. Returns {list}. |
| 12785 | 9370 |
| 5747 | 9371 If you want a list to remain unmodified make a copy first: > |
| 82 | 9372 :let sortedlist = sort(copy(mylist)) |
| 5968 | 9373 |
| 6009 | 9374 < When {func} is omitted, is empty or zero, then sort() uses the |
| 9375 string representation of each item to sort on. Numbers sort | |
| 9376 after Strings, |Lists| after Numbers. For sorting text in the | |
| 9377 current buffer use |:sort|. | |
| 9378 | |
| 6180 | 9379 When {func} is given and it is '1' or 'i' then case is |
| 6009 | 9380 ignored. |
| 12785 | 9381 |
| 6009 | 9382 When {func} is given and it is 'n' then all items will be |
| 9383 sorted numerical (Implementation detail: This uses the | |
| 9384 strtod() function to parse numbers, Strings, Lists, Dicts and | |
| 9385 Funcrefs will be considered as being 0). | |
| 9386 | |
|
7291
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
9387 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
|
9388 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
|
9389 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
|
9390 |
|
7707
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
9391 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
|
9392 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
|
9393 |
| 685 | 9394 When {func} is a |Funcref| or a function name, this function |
| 9395 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
|
9396 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
|
9397 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
|
9398 smaller if the first one sorts before the second one. |
| 5747 | 9399 |
| 9400 {dict} is for functions with the "dict" attribute. It will be | |
| 9401 used to set the local variable "self". |Dictionary-function| | |
| 9402 | |
|
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
9403 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
|
9404 string) will keep their relative position. E.g., when sorting |
| 6051 | 9405 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
|
9406 same order as they were originally. |
|
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
9407 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
9408 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
9409 mylist->sort() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
9410 |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
9411 < Also see |uniq()|. |
| 5747 | 9412 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9413 Example: > |
| 82 | 9414 func MyCompare(i1, i2) |
| 9415 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
| 9416 endfunc | |
| 9417 let sortedlist = sort(mylist, "MyCompare") | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9418 < A shorter compare version for this specific simple case, which |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9419 ignores overflow: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9420 func MyCompare(i1, i2) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9421 return a:i1 - a:i2 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9422 endfunc |
| 344 | 9423 < |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
9424 sound_clear() *sound_clear()* |
|
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
9425 Stop playing all sounds. |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
9426 {only available when compiled with the |+sound| feature} |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
9427 |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9428 *sound_playevent()* |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9429 sound_playevent({name} [, {callback}]) |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9430 Play a sound identified by {name}. Which event names are |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9431 supported depends on the system. Often the XDG sound names |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9432 are used. On Ubuntu they may be found in |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9433 /usr/share/sounds/freedesktop/stereo. Example: > |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9434 call sound_playevent('bell') |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
9435 < On MS-Windows, {name} can be SystemAsterisk, SystemDefault, |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
9436 SystemExclamation, SystemExit, SystemHand, SystemQuestion, |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
9437 SystemStart, SystemWelcome, etc. |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
9438 |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
9439 When {callback} is specified it is invoked when the sound is |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9440 finished. The first argument is the sound ID, the second |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9441 argument is the status: |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9442 0 sound was played to the end |
| 17036 | 9443 1 sound was interrupted |
| 17161 | 9444 2 error occurred after sound started |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9445 Example: > |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9446 func Callback(id, status) |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9447 echomsg "sound " .. a:id .. " finished with " .. a:status |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9448 endfunc |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9449 call sound_playevent('bell', 'Callback') |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9450 |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
9451 < MS-Windows: {callback} doesn't work for this function. |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
9452 |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
9453 Returns the sound ID, which can be passed to `sound_stop()`. |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9454 Returns zero if the sound could not be played. |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9455 |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9456 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9457 GetSoundName()->sound_playevent() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9458 |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9459 < {only available when compiled with the |+sound| feature} |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9460 |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9461 *sound_playfile()* |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
9462 sound_playfile({path} [, {callback}]) |
|
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
9463 Like `sound_playevent()` but play sound file {path}. {path} |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9464 must be a full path. On Ubuntu you may find files to play |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9465 with this command: > |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9466 :!find /usr/share/sounds -type f | grep -v index.theme |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9467 |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9468 < Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9469 GetSoundPath()->sound_playfile() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9470 |
| 17036 | 9471 < {only available when compiled with the |+sound| feature} |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9472 |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9473 |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9474 sound_stop({id}) *sound_stop()* |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9475 Stop playing sound {id}. {id} must be previously returned by |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9476 `sound_playevent()` or `sound_playfile()`. |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
9477 |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
9478 On MS-Windows, this does not work for event sound started by |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
9479 `sound_playevent()`. To stop event sounds, use `sound_clear()`. |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
9480 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9481 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9482 soundid->sound_stop() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9483 |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9484 < {only available when compiled with the |+sound| feature} |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
9485 |
| 374 | 9486 *soundfold()* |
| 9487 soundfold({word}) | |
| 9488 Return the sound-folded equivalent of {word}. Uses the first | |
| 1621 | 9489 language in 'spelllang' for the current window that supports |
| 375 | 9490 soundfolding. 'spell' must be set. When no sound folding is |
| 9491 possible the {word} is returned unmodified. | |
| 374 | 9492 This can be used for making spelling suggestions. Note that |
| 9493 the method can be quite slow. | |
| 9494 | |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9495 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9496 GetWord()->soundfold() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9497 < |
| 344 | 9498 *spellbadword()* |
| 532 | 9499 spellbadword([{sentence}]) |
| 9500 Without argument: The result is the badly spelled word under | |
| 9501 or after the cursor. The cursor is moved to the start of the | |
| 9502 bad word. When no bad word is found in the cursor line the | |
| 9503 result is an empty string and the cursor doesn't move. | |
| 9504 | |
| 9505 With argument: The result is the first word in {sentence} that | |
| 9506 is badly spelled. If there are no spelling mistakes the | |
| 9507 result is an empty string. | |
| 9508 | |
| 9509 The return value is a list with two items: | |
| 9510 - The badly spelled word or an empty string. | |
| 9511 - The type of the spelling error: | |
| 856 | 9512 "bad" spelling mistake |
| 532 | 9513 "rare" rare word |
| 9514 "local" word only valid in another region | |
| 9515 "caps" word should start with Capital | |
| 9516 Example: > | |
| 9517 echo spellbadword("the quik brown fox") | |
| 9518 < ['quik', 'bad'] ~ | |
| 9519 | |
| 9520 The spelling information for the current window is used. The | |
| 9521 'spell' option must be set and the value of 'spelllang' is | |
| 9522 used. | |
| 344 | 9523 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9524 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9525 GetText()->spellbadword() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9526 < |
| 344 | 9527 *spellsuggest()* |
| 537 | 9528 spellsuggest({word} [, {max} [, {capital}]]) |
| 685 | 9529 Return a |List| with spelling suggestions to replace {word}. |
| 344 | 9530 When {max} is given up to this number of suggestions are |
| 9531 returned. Otherwise up to 25 suggestions are returned. | |
| 9532 | |
| 537 | 9533 When the {capital} argument is given and it's non-zero only |
| 9534 suggestions with a leading capital will be given. Use this | |
| 9535 after a match with 'spellcapcheck'. | |
| 9536 | |
| 344 | 9537 {word} can be a badly spelled word followed by other text. |
| 9538 This allows for joining two words that were split. The | |
| 359 | 9539 suggestions also include the following text, thus you can |
| 9540 replace a line. | |
| 9541 | |
| 9542 {word} may also be a good word. Similar words will then be | |
| 537 | 9543 returned. {word} itself is not included in the suggestions, |
| 9544 although it may appear capitalized. | |
| 344 | 9545 |
| 9546 The spelling information for the current window is used. The | |
| 375 | 9547 'spell' option must be set and the values of 'spelllang' and |
| 9548 'spellsuggest' are used. | |
| 344 | 9549 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9550 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9551 GetWord()->spellsuggest() |
| 82 | 9552 |
| 282 | 9553 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
| 685 | 9554 Make a |List| out of {expr}. When {pattern} is omitted or |
| 9555 empty each white-separated sequence of characters becomes an | |
| 9556 item. | |
| 82 | 9557 Otherwise the string is split where {pattern} matches, |
| 3920 | 9558 removing the matched characters. 'ignorecase' is not used |
| 9559 here, add \c to ignore case. |/\c| | |
| 282 | 9560 When the first or last item is empty it is omitted, unless the |
| 9561 {keepempty} argument is given and it's non-zero. | |
| 293 | 9562 Other empty items are kept when {pattern} matches at least one |
| 9563 character or when {keepempty} is non-zero. | |
| 82 | 9564 Example: > |
| 95 | 9565 :let words = split(getline('.'), '\W\+') |
| 282 | 9566 < To split a string in individual characters: > |
| 236 | 9567 :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
|
9568 < 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
|
9569 the end of the pattern: > |
| 258 | 9570 :echo split('abc:def:ghi', ':\zs') |
| 9571 < ['abc:', 'def:', 'ghi'] ~ | |
| 282 | 9572 Splitting a table where the first element can be empty: > |
| 9573 :let items = split(line, ':', 1) | |
| 9574 < The opposite function is |join()|. | |
| 82 | 9575 |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9576 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9577 GetString()->split() |
| 82 | 9578 |
| 1621 | 9579 sqrt({expr}) *sqrt()* |
| 9580 Return the non-negative square root of Float {expr} as a | |
| 9581 |Float|. | |
| 9582 {expr} must evaluate to a |Float| or a |Number|. When {expr} | |
| 9583 is negative the result is NaN (Not a Number). | |
| 9584 Examples: > | |
| 9585 :echo sqrt(100) | |
| 9586 < 10.0 > | |
| 9587 :echo sqrt(-4.01) | |
| 9588 < nan | |
| 1668 | 9589 "nan" may be different, it depends on system libraries. |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9590 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9591 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9592 Compute()->sqrt() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9593 < |
| 1621 | 9594 {only available when compiled with the |+float| feature} |
| 12785 | 9595 |
| 1621 | 9596 |
|
18701
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
9597 srand([{expr}]) *srand()* |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
9598 Initialize seed used by |rand()|: |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
9599 - If {expr} is not given, seed values are initialized by |
|
18732
2513e666aa82
patch 8.1.2356: rand() does not use the best algorithm
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
9600 reading from /dev/urandom, if possible, or using time(NULL) |
|
2513e666aa82
patch 8.1.2356: rand() does not use the best algorithm
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
9601 a.k.a. epoch time otherwise; this only has second accuracy. |
|
2513e666aa82
patch 8.1.2356: rand() does not use the best algorithm
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
9602 - If {expr} is given it must be a Number. It is used to |
|
2513e666aa82
patch 8.1.2356: rand() does not use the best algorithm
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
9603 initialize the seed values. This is useful for testing or |
|
2513e666aa82
patch 8.1.2356: rand() does not use the best algorithm
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
9604 when a predictable sequence is intended. |
|
18701
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
9605 |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
9606 Examples: > |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
9607 :let seed = srand() |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
9608 :let seed = srand(userinput) |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
9609 :echo rand(seed) |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
9610 |
|
18104
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
9611 state([{what}]) *state()* |
|
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
9612 Return a string which contains characters indicating the |
|
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
9613 current state. Mostly useful in callbacks that want to do |
|
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
9614 work that may not always be safe. Roughly this works like: |
|
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
9615 - callback uses state() to check if work is safe to do. |
| 18130 | 9616 Yes: then do it right away. |
| 9617 No: add to work queue and add a |SafeState| and/or | |
| 9618 |SafeStateAgain| autocommand (|SafeState| triggers at | |
| 9619 toplevel, |SafeStateAgain| triggers after handling | |
| 9620 messages and callbacks). | |
| 9621 - When SafeState or SafeStateAgain is triggered and executes | |
| 9622 your autocommand, check with `state()` if the work can be | |
| 9623 done now, and if yes remove it from the queue and execute. | |
| 9624 Remove the autocommand if the queue is now empty. | |
|
18104
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
9625 Also see |mode()|. |
|
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
9626 |
|
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
9627 When {what} is given only characters in this string will be |
|
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
9628 added. E.g, this checks if the screen has scrolled: > |
| 18130 | 9629 if state('s') == '' |
| 9630 " screen has not scrolled | |
|
18104
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
9631 < |
|
18116
7f57ea9a4ba8
patch 8.1.2053: SafeStateAgain not triggered if callback uses feedkeys()
Bram Moolenaar <Bram@vim.org>
parents:
18104
diff
changeset
|
9632 These characters indicate the state, generally indicating that |
|
7f57ea9a4ba8
patch 8.1.2053: SafeStateAgain not triggered if callback uses feedkeys()
Bram Moolenaar <Bram@vim.org>
parents:
18104
diff
changeset
|
9633 something is busy: |
| 18130 | 9634 m halfway a mapping, :normal command, feedkeys() or |
| 9635 stuffed command | |
| 9636 o operator pending or waiting for a command argument, | |
| 9637 e.g. after |f| | |
| 9638 a Insert mode autocomplete active | |
| 9639 x executing an autocommand | |
| 18343 | 9640 w blocked on waiting, e.g. ch_evalexpr(), ch_read() and |
| 9641 ch_readraw() when reading json. | |
| 18130 | 9642 S not triggering SafeState or SafeStateAgain |
| 9643 c callback invoked, including timer (repeats for | |
| 9644 recursiveness up to "ccc") | |
| 9645 s screen has scrolled for messages | |
|
18104
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
9646 |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
9647 str2float({expr}) *str2float()* |
| 1621 | 9648 Convert String {expr} to a Float. This mostly works the same |
| 9649 as when using a floating point number in an expression, see | |
| 9650 |floating-point-format|. But it's a bit more permissive. | |
| 9651 E.g., "1e40" is accepted, while in an expression you need to | |
| 15131 | 9652 write "1.0e40". The hexadecimal form "0x123" is also |
| 9653 accepted, but not others, like binary or octal. | |
| 1621 | 9654 Text after the number is silently ignored. |
| 9655 The decimal point is always '.', no matter what the locale is | |
| 9656 set to. A comma ends the number: "12,345.67" is converted to | |
| 9657 12.0. You can strip out thousands separators with | |
| 9658 |substitute()|: > | |
| 9659 let f = str2float(substitute(text, ',', '', 'g')) | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9660 < |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9661 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9662 let f = text->substitute(',', '', 'g')->str2float() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9663 < |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9664 {only available when compiled with the |+float| feature} |
| 1621 | 9665 |
|
16235
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
9666 str2list({expr} [, {utf8}]) *str2list()* |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
9667 Return a list containing the number values which represent |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
9668 each character in String {expr}. Examples: > |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
9669 str2list(" ") returns [32] |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
9670 str2list("ABC") returns [65, 66, 67] |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
9671 < |list2str()| does the opposite. |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
9672 |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
9673 When {utf8} is omitted or zero, the current 'encoding' is used. |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
9674 With {utf8} set to 1, always treat the String as utf-8 |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
9675 characters. With utf-8 composing characters are handled |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
9676 properly: > |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
9677 str2list("á") returns [97, 769] |
| 1621 | 9678 |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9679 < Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9680 GetString()->str2list() |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9681 |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9682 |
|
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
9683 str2nr({expr} [, {base} [, {quoted}]]) *str2nr()* |
| 782 | 9684 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
|
9685 {base} is the conversion base, it can be 2, 8, 10 or 16. |
|
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
9686 When {quoted} is present and non-zero then embedded single |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
9687 quotes are ignored, thus "1'000'000" is a million. |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9688 |
| 782 | 9689 When {base} is omitted base 10 is used. This also means that |
| 9690 a leading zero doesn't cause octal conversion to be used, as | |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9691 with the default String to Number conversion. Example: > |
| 18343 | 9692 let nr = str2nr('0123') |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9693 < |
| 782 | 9694 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
|
9695 different base the result will be zero. Similarly, when |
|
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
9696 {base} is 8 a leading "0", "0o" or "0O" is ignored, and when |
|
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
9697 {base} is 2 a leading "0b" or "0B" is ignored. |
| 782 | 9698 Text after the number is silently ignored. |
| 856 | 9699 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9700 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9701 GetText()->str2nr() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9702 |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9703 strcharpart({src}, {start} [, {len}]) *strcharpart()* |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9704 Like |strpart()| but using character index and length instead |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9705 of byte index and length. |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9706 When a character index is used where a character does not |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9707 exist it is assumed to be one character. For example: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9708 strcharpart('abc', -1, 2) |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9709 < results in 'a'. |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9710 |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9711 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9712 GetText()->strcharpart(5) |
| 782 | 9713 |
| 6884 | 9714 strchars({expr} [, {skipcc}]) *strchars()* |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
9715 The result is a Number, which is the number of characters |
| 6884 | 9716 in String {expr}. |
| 9717 When {skipcc} is omitted or zero, composing characters are | |
| 9718 counted separately. | |
| 9719 When {skipcc} set to 1, Composing characters are ignored. | |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
9720 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
| 12785 | 9721 |
| 6918 | 9722 {skipcc} is only available after 7.4.755. For backward |
| 9723 compatibility, you can define a wrapper function: > | |
| 9724 if has("patch-7.4.755") | |
| 9725 function s:strchars(str, skipcc) | |
| 9726 return strchars(a:str, a:skipcc) | |
| 9727 endfunction | |
| 9728 else | |
| 9729 function s:strchars(str, skipcc) | |
| 9730 if a:skipcc | |
| 9731 return strlen(substitute(a:str, ".", "x", "g")) | |
| 9732 else | |
| 9733 return strchars(a:str) | |
| 9734 endif | |
| 9735 endfunction | |
| 9736 endif | |
| 9737 < | |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9738 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9739 GetText()->strchars() |
| 6918 | 9740 |
| 12785 | 9741 strdisplaywidth({expr} [, {col}]) *strdisplaywidth()* |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
9742 The result is a Number, which is the number of display cells |
| 15878 | 9743 String {expr} occupies on the screen when it starts at {col} |
| 9744 (first column is zero). When {col} is omitted zero is used. | |
| 9745 Otherwise it is the screen column where to start. This | |
| 9746 matters for Tab characters. | |
|
2343
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
9747 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
|
9748 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
|
9749 'tabstop' and 'display'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
9750 When {expr} contains characters with East Asian Width Class |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
9751 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
9752 Also see |strlen()|, |strwidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
9753 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9754 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9755 GetText()->strdisplaywidth() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9756 |
| 7 | 9757 strftime({format} [, {time}]) *strftime()* |
| 9758 The result is a String, which is a formatted date and time, as | |
| 9759 specified by the {format} string. The given {time} is used, | |
| 9760 or the current time if no time is given. The accepted | |
| 9761 {format} depends on your system, thus this is not portable! | |
| 9762 See the manual page of the C function strftime() for the | |
| 9763 format. The maximum length of the result is 80 characters. | |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9764 See also |localtime()|, |getftime()| and |strptime()|. |
| 7 | 9765 The language can be changed with the |:language| command. |
| 9766 Examples: > | |
| 9767 :echo strftime("%c") Sun Apr 27 11:49:23 1997 | |
| 9768 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 | |
| 9769 :echo strftime("%y%m%d %T") 970427 11:53:55 | |
| 9770 :echo strftime("%H:%M") 11:55 | |
| 9771 :echo strftime("%c", getftime("file.c")) | |
| 9772 Show mod time of file.c. | |
| 82 | 9773 < Not available on all systems. To check use: > |
| 9774 :if exists("*strftime") | |
| 9775 | |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9776 < Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9777 GetFormat()->strftime() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9778 |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
9779 strgetchar({str}, {index}) *strgetchar()* |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
9780 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
|
9781 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
|
9782 separate characters here. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
9783 Also see |strcharpart()| and |strchars()|. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
9784 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9785 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9786 GetText()->strgetchar(5) |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9787 |
| 133 | 9788 stridx({haystack}, {needle} [, {start}]) *stridx()* |
| 9789 The result is a Number, which gives the byte index in | |
| 9790 {haystack} of the first occurrence of the String {needle}. | |
| 140 | 9791 If {start} is specified, the search starts at index {start}. |
| 9792 This can be used to find a second match: > | |
| 2662 | 9793 :let colon1 = stridx(line, ":") |
| 9794 :let colon2 = stridx(line, ":", colon1 + 1) | |
| 140 | 9795 < The search is done case-sensitive. |
| 205 | 9796 For pattern searches use |match()|. |
| 133 | 9797 -1 is returned if the {needle} does not occur in {haystack}. |
| 140 | 9798 See also |strridx()|. |
| 9799 Examples: > | |
| 7 | 9800 :echo stridx("An Example", "Example") 3 |
| 9801 :echo stridx("Starting point", "Start") 0 | |
| 9802 :echo stridx("Starting point", "start") -1 | |
| 856 | 9803 < *strstr()* *strchr()* |
| 170 | 9804 stridx() works similar to the C function strstr(). When used |
| 9805 with a single character it works similar to strchr(). | |
| 9806 | |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9807 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9808 GetHaystack()->stridx(needle) |
| 18343 | 9809 < |
| 55 | 9810 *string()* |
| 95 | 9811 string({expr}) Return {expr} converted to a String. If {expr} is a Number, |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
9812 Float, String, Blob or a composition of them, then the result |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
9813 can be parsed back with |eval()|. |
| 55 | 9814 {expr} type result ~ |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
9815 String 'string' (single quotes are doubled) |
| 95 | 9816 Number 123 |
| 1621 | 9817 Float 123.123456 or 1.123456e8 |
| 99 | 9818 Funcref function('name') |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
9819 Blob 0z00112233.44556677.8899 |
| 95 | 9820 List [item, item] |
| 323 | 9821 Dictionary {key: value, key: value} |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
9822 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
9823 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
|
9824 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
|
9825 will then fail. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
9826 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
9827 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
9828 mylist->string() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
9829 |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
9830 < Also see |strtrans()|. |
| 55 | 9831 |
| 7 | 9832 *strlen()* |
| 9833 strlen({expr}) The result is a Number, which is the length of the String | |
| 502 | 9834 {expr} in bytes. |
| 55 | 9835 If the argument is a Number it is first converted to a String. |
| 9836 For other types an error is given. | |
| 6870 | 9837 If you want to count the number of multi-byte characters use |
| 9838 |strchars()|. | |
| 9839 Also see |len()|, |strdisplaywidth()| and |strwidth()|. | |
| 7 | 9840 |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9841 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9842 GetString()->strlen() |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9843 |
| 12785 | 9844 strpart({src}, {start} [, {len}]) *strpart()* |
| 7 | 9845 The result is a String, which is part of {src}, starting from |
| 574 | 9846 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
|
9847 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
|
9848 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
9849 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
|
9850 result in an error, the bytes are simply omitted. |
| 7 | 9851 If {len} is missing, the copy continues from {start} till the |
| 9852 end of the {src}. > | |
| 9853 strpart("abcdefg", 3, 2) == "de" | |
| 9854 strpart("abcdefg", -2, 4) == "ab" | |
| 9855 strpart("abcdefg", 5, 4) == "fg" | |
| 1621 | 9856 strpart("abcdefg", 3) == "defg" |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
9857 |
| 7 | 9858 < Note: To get the first character, {start} must be 0. For |
| 9859 example, to get three bytes under and after the cursor: > | |
| 823 | 9860 strpart(getline("."), col(".") - 1, 3) |
| 7 | 9861 < |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9862 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9863 GetText()->strpart(5) |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9864 |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9865 strptime({format}, {timestring}) *strptime()* |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9866 The result is a Number, which is a unix timestamp representing |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9867 the date and time in {timestring}, which is expected to match |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9868 the format specified in {format}. |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9869 |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9870 The accepted {format} depends on your system, thus this is not |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9871 portable! See the manual page of the C function strptime() |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9872 for the format. Especially avoid "%c". The value of $TZ also |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9873 matters. |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9874 |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9875 If the {timestring} cannot be parsed with {format} zero is |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9876 returned. If you do not know the format of {timestring} you |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9877 can try different {format} values until you get a non-zero |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9878 result. |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9879 |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9880 See also |strftime()|. |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9881 Examples: > |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9882 :echo strptime("%Y %b %d %X", "1997 Apr 27 11:49:23") |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9883 < 862156163 > |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9884 :echo strftime("%c", strptime("%y%m%d %T", "970427 11:53:55")) |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9885 < Sun Apr 27 11:53:55 1997 > |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9886 :echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600) |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9887 < Sun Apr 27 12:53:55 1997 |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9888 |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9889 Not available on all systems. To check use: > |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9890 :if exists("*strptime") |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9891 |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
9892 |
| 140 | 9893 strridx({haystack}, {needle} [, {start}]) *strridx()* |
| 9894 The result is a Number, which gives the byte index in | |
| 9895 {haystack} of the last occurrence of the String {needle}. | |
| 9896 When {start} is specified, matches beyond this index are | |
| 9897 ignored. This can be used to find a match before a previous | |
| 9898 match: > | |
| 9899 :let lastcomma = strridx(line, ",") | |
| 9900 :let comma2 = strridx(line, ",", lastcomma - 1) | |
| 9901 < The search is done case-sensitive. | |
| 133 | 9902 For pattern searches use |match()|. |
| 9903 -1 is returned if the {needle} does not occur in {haystack}. | |
| 22 | 9904 If the {needle} is empty the length of {haystack} is returned. |
| 236 | 9905 See also |stridx()|. Examples: > |
| 7 | 9906 :echo strridx("an angry armadillo", "an") 3 |
| 856 | 9907 < *strrchr()* |
| 170 | 9908 When used with a single character it works similar to the C |
| 9909 function strrchr(). | |
| 9910 | |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9911 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9912 GetHaystack()->strridx(needle) |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9913 |
| 7 | 9914 strtrans({expr}) *strtrans()* |
| 9915 The result is a String, which is {expr} with all unprintable | |
| 9916 characters translated into printable characters |'isprint'|. | |
| 9917 Like they are shown in a window. Example: > | |
| 9918 echo strtrans(@a) | |
| 9919 < This displays a newline in register a as "^@" instead of | |
| 9920 starting a new line. | |
| 9921 | |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9922 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9923 GetString()->strtrans() |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9924 |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
9925 strwidth({expr}) *strwidth()* |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
9926 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
|
9927 String {expr} occupies. A Tab character is counted as one |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
9928 cell, alternatively use |strdisplaywidth()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
9929 When {expr} contains characters with East Asian Width Class |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
9930 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
9931 Also see |strlen()|, |strdisplaywidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
9932 |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9933 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9934 GetString()->strwidth() |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
9935 |
| 12785 | 9936 submatch({nr} [, {list}]) *submatch()* *E935* |
| 2908 | 9937 Only for an expression in a |:substitute| command or |
| 9938 substitute() function. | |
| 9939 Returns the {nr}'th submatch of the matched text. When {nr} | |
| 9940 is 0 the whole matched text is returned. | |
| 5794 | 9941 Note that a NL in the string can stand for a line break of a |
| 9942 multi-line match or a NUL character in the text. | |
| 2908 | 9943 Also see |sub-replace-expression|. |
| 5794 | 9944 |
| 12785 | 9945 If {list} is present and non-zero then submatch() returns |
| 9946 a list of strings, similar to |getline()| with two arguments. | |
| 5794 | 9947 NL characters in the text represent NUL characters in the |
| 9948 text. | |
| 9949 Only returns more than one item for |:substitute|, inside | |
| 9950 |substitute()| this list will always contain one or zero | |
| 9951 items, since there are no real line breaks. | |
| 9952 | |
|
10245
d76ccdacb41e
commit https://github.com/vim/vim/commit/6100d02aab7c8294b581cb299250eea164b50e9d
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
9953 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
|
9954 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
|
9955 |
| 12968 | 9956 Examples: > |
| 7 | 9957 :s/\d\+/\=submatch(0) + 1/ |
| 12968 | 9958 :echo substitute(text, '\d\+', '\=submatch(0) + 1', '') |
| 7 | 9959 < This finds the first number in the line and adds one to it. |
| 9960 A line break is included as a newline character. | |
| 9961 | |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9962 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9963 GetNr()->submatch() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
9964 |
| 7 | 9965 substitute({expr}, {pat}, {sub}, {flags}) *substitute()* |
| 9966 The result is a String, which is a copy of {expr}, in which | |
| 2908 | 9967 the first match of {pat} is replaced with {sub}. |
| 9968 When {flags} is "g", all matches of {pat} in {expr} are | |
| 9969 replaced. Otherwise {flags} should be "". | |
| 12785 | 9970 |
| 2908 | 9971 This works like the ":substitute" command (without any flags). |
| 9972 But the matching with {pat} is always done like the 'magic' | |
| 9973 option is set and 'cpoptions' is empty (to make scripts | |
| 3967 | 9974 portable). 'ignorecase' is still relevant, use |/\c| or |/\C| |
| 9975 if you want to ignore or match case and ignore 'ignorecase'. | |
| 9976 'smartcase' is not used. See |string-match| for how {pat} is | |
| 9977 used. | |
| 2908 | 9978 |
| 9979 A "~" in {sub} is not replaced with the previous {sub}. | |
| 7 | 9980 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
|
9981 |sub-replace-special|. For example, to replace something with |
| 7 | 9982 "\n" (two characters), use "\\\\n" or '\\n'. |
| 2908 | 9983 |
| 7 | 9984 When {pat} does not match in {expr}, {expr} is returned |
| 9985 unmodified. | |
| 2908 | 9986 |
| 7 | 9987 Example: > |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
9988 :let &path = substitute(&path, ",\\=[^,]*$", "", "") |
| 7 | 9989 < 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
|
9990 :echo substitute("testing", ".*", "\\U\\0", "") |
| 7 | 9991 < results in "TESTING". |
| 2908 | 9992 |
| 9993 When {sub} starts with "\=", the remainder is interpreted as | |
| 9994 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
|
9995 :echo substitute(s, '%\(\x\x\)', |
| 2833 | 9996 \ '\=nr2char("0x" . submatch(1))', 'g') |
| 7 | 9997 |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
9998 < 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
|
9999 optional argument. Example: > |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10000 :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
|
10001 < 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
|
10002 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
|
10003 |submatch()| returns. Example: > |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
10004 :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
|
10005 |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10006 < Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10007 GetString()->substitute(pat, sub, flags) |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10008 |
| 14668 | 10009 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
|
10010 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
|
10011 swapfile {fname}. The available fields are: |
| 14864 | 10012 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
|
10013 user user name |
|
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
10014 host host name |
|
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
10015 fname original file name |
| 14864 | 10016 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
|
10017 file |
|
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
10018 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
|
10019 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
|
10020 dirty 1 if file was modified, 0 if not |
| 14637 | 10021 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
|
10022 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
|
10023 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
|
10024 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
|
10025 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
|
10026 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
|
10027 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10028 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10029 GetFilename()->swapinfo() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10030 |
|
14778
20653d6f3d95
patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents:
14756
diff
changeset
|
10031 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
|
10032 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
|
10033 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
|
10034 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
|
10035 |: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
|
10036 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
|
10037 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10038 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10039 GetBufname()->swapname() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10040 |
| 32 | 10041 synID({lnum}, {col}, {trans}) *synID()* |
| 7 | 10042 The result is a Number, which is the syntax ID at the position |
| 32 | 10043 {lnum} and {col} in the current window. |
| 7 | 10044 The syntax ID can be used with |synIDattr()| and |
| 10045 |synIDtrans()| to obtain syntax information about text. | |
| 419 | 10046 |
| 32 | 10047 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
| 419 | 10048 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
|
10049 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
|
10050 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
|
10051 zero. |
| 419 | 10052 |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
10053 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
|
10054 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
|
10055 the effective color. When {trans} is |FALSE|, the transparent |
| 7 | 10056 item is returned. This is useful when wanting to know which |
| 10057 syntax item is effective (e.g. inside parens). | |
| 10058 Warning: This function can be very slow. Best speed is | |
| 10059 obtained by going through the file in forward direction. | |
| 10060 | |
| 10061 Example (echoes the name of the syntax item under the cursor): > | |
| 10062 :echo synIDattr(synID(line("."), col("."), 1), "name") | |
| 10063 < | |
|
2401
e7751177126b
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
10064 |
| 7 | 10065 synIDattr({synID}, {what} [, {mode}]) *synIDattr()* |
| 10066 The result is a String, which is the {what} attribute of | |
| 10067 syntax ID {synID}. This can be used to obtain information | |
| 10068 about a syntax item. | |
| 10069 {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
|
10070 for that mode. When {mode} is omitted, or an invalid value is |
| 7 | 10071 used, the attributes for the currently active highlighting are |
| 10072 used (GUI, cterm or term). | |
| 10073 Use synIDtrans() to follow linked highlight groups. | |
| 10074 {what} result | |
| 10075 "name" the name of the syntax item | |
| 10076 "fg" foreground color (GUI: color name used to set | |
| 10077 the color, cterm: color number as a string, | |
| 10078 term: empty string) | |
| 1755 | 10079 "bg" background color (as with "fg") |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
10080 "font" font name (only available in the GUI) |
|
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
10081 |highlight-font| |
| 1755 | 10082 "sp" special color (as with "fg") |highlight-guisp| |
| 7 | 10083 "fg#" like "fg", but for the GUI and the GUI is |
| 10084 running the name in "#RRGGBB" form | |
| 10085 "bg#" like "fg#" for "bg" | |
| 1755 | 10086 "sp#" like "fg#" for "sp" |
| 7 | 10087 "bold" "1" if bold |
| 10088 "italic" "1" if italic | |
| 10089 "reverse" "1" if reverse | |
| 10090 "inverse" "1" if inverse (= reverse) | |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
10091 "standout" "1" if standout |
| 7 | 10092 "underline" "1" if underlined |
| 205 | 10093 "undercurl" "1" if undercurled |
|
12317
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12311
diff
changeset
|
10094 "strike" "1" if strikethrough |
| 7 | 10095 |
| 10096 Example (echoes the color of the syntax item under the | |
| 10097 cursor): > | |
| 10098 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
| 10099 < | |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10100 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10101 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg") |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10102 |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10103 |
| 7 | 10104 synIDtrans({synID}) *synIDtrans()* |
| 10105 The result is a Number, which is the translated syntax ID of | |
| 10106 {synID}. This is the syntax group ID of what is being used to | |
| 10107 highlight the character. Highlight links given with | |
| 10108 ":highlight link" are followed. | |
| 10109 | |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10110 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10111 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg") |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10112 |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
10113 synconcealed({lnum}, {col}) *synconcealed()* |
|
11553
cbceef33af7a
patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents:
11549
diff
changeset
|
10114 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
|
10115 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
|
10116 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
|
10117 region, 1 if it is. |
|
cbceef33af7a
patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents:
11549
diff
changeset
|
10118 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
|
10119 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
|
10120 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
|
10121 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
|
10122 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
|
10123 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
|
10124 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
|
10125 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
|
10126 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
|
10127 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
|
10128 the text is "123456" and both "23" and "45" are concealed |
| 14864 | 10129 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
|
10130 call returns ~ |
| 12254 | 10131 synconcealed(lnum, 1) [0, '', 0] |
| 10132 synconcealed(lnum, 2) [1, 'X', 1] | |
| 10133 synconcealed(lnum, 3) [1, 'X', 1] | |
| 10134 synconcealed(lnum, 4) [1, 'X', 2] | |
| 10135 synconcealed(lnum, 5) [1, 'X', 2] | |
| 10136 synconcealed(lnum, 6) [0, '', 0] | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
10137 |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
10138 |
| 1500 | 10139 synstack({lnum}, {col}) *synstack()* |
| 10140 Return a |List|, which is the stack of syntax items at the | |
| 10141 position {lnum} and {col} in the current window. Each item in | |
| 10142 the List is an ID like what |synID()| returns. | |
| 10143 The first item in the List is the outer region, following are | |
| 10144 items contained in that one. The last one is what |synID()| | |
| 10145 returns, unless not the whole item is highlighted or it is a | |
| 10146 transparent item. | |
| 10147 This function is useful for debugging a syntax file. | |
| 10148 Example that shows the syntax stack under the cursor: > | |
| 10149 for id in synstack(line("."), col(".")) | |
| 10150 echo synIDattr(id, "name") | |
| 10151 endfor | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
10152 < 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
|
10153 nothing is returned. The position just after the last |
|
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
10154 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
|
10155 valid positions. |
| 1500 | 10156 |
| 24 | 10157 system({expr} [, {input}]) *system()* *E677* |
| 5808 | 10158 Get the output of the shell command {expr} as a string. See |
| 10159 |systemlist()| to get the output as a List. | |
| 5806 | 10160 |
| 12785 | 10161 When {input} is given and is a string this string is written |
| 10162 to a file and passed as stdin to the command. The string is | |
| 10163 written as-is, you need to take care of using the correct line | |
| 5806 | 10164 separators yourself. |
| 10165 If {input} is given and is a |List| it is written to the file | |
| 10166 in a way |writefile()| does with {binary} set to "b" (i.e. | |
| 10167 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
|
10168 list items converted to NULs). |
|
7232cd9f8a7c
commit https://github.com/vim/vim/commit/12c4492dd35e0cd83c8816be2ec849b836109882
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
10169 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
|
10170 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
|
10171 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
|
10172 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
|
10173 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
10174 Pipes are not used, the 'shelltemp' option is not used. |
| 5806 | 10175 |
|
10038
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
10176 When prepended by |:silent| the terminal will not be set to |
| 6183 | 10177 cooked mode. This is meant to be used for commands that do |
| 10178 not need the user to type. It avoids stray characters showing | |
| 10179 up on the screen which require |CTRL-L| to remove. > | |
| 10180 :silent let f = system('ls *.vim') | |
| 10181 < | |
| 12785 | 10182 Note: Use |shellescape()| or |::S| with |expand()| or |
| 10183 |fnamemodify()| to escape special characters in a command | |
| 10184 argument. Newlines in {expr} may cause the command to fail. | |
| 10185 The characters in 'shellquote' and 'shellxquote' may also | |
| 5690 | 10186 cause trouble. |
| 7 | 10187 This is not to be used for interactive commands. |
| 1661 | 10188 |
| 7 | 10189 The result is a String. Example: > |
| 1661 | 10190 :let files = system("ls " . shellescape(expand('%:h'))) |
| 5690 | 10191 :let files = system('ls ' . expand('%:h:S')) |
| 7 | 10192 |
| 10193 < To make the result more system-independent, the shell output | |
| 10194 is filtered to replace <CR> with <NL> for Macintosh, and | |
| 10195 <CR><NL> with <NL> for DOS-like systems. | |
| 5277 | 10196 To avoid the string being truncated at a NUL, all NUL |
| 10197 characters are replaced with SOH (0x01). | |
| 10198 | |
| 7 | 10199 The command executed is constructed using several options: |
| 10200 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
| 10201 ({tmp} is an automatically generated file name). | |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
10202 For Unix, braces are put around {expr} to allow for |
| 7 | 10203 concatenated commands. |
| 10204 | |
| 794 | 10205 The command will be executed in "cooked" mode, so that a |
| 10206 CTRL-C will interrupt the command (on Unix at least). | |
| 10207 | |
| 7 | 10208 The resulting error code can be found in |v:shell_error|. |
| 10209 This function will fail in |restricted-mode|. | |
| 625 | 10210 |
| 10211 Note that any wrong value in the options mentioned above may | |
| 10212 make the function fail. It has also been reported to fail | |
| 10213 when using a security agent application. | |
| 7 | 10214 Unlike ":!cmd" there is no automatic check for changed files. |
| 10215 Use |:checktime| to force a check. | |
| 10216 | |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10217 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10218 :echo GetCmd()->system() |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10219 |
| 205 | 10220 |
| 5808 | 10221 systemlist({expr} [, {input}]) *systemlist()* |
| 12785 | 10222 Same as |system()|, but returns a |List| with lines (parts of |
| 10223 output separated by NL) with NULs transformed into NLs. Output | |
| 10224 is the same as |readfile()| will output with {binary} argument | |
| 18186 | 10225 set to "b", except that there is no extra empty item when the |
| 10226 result ends in a NL. | |
| 10227 Note that on MS-Windows you may get trailing CR characters. | |
| 10228 | |
| 10229 To see the difference between "echo hello" and "echo -n hello" | |
| 10230 use |system()| and |split()|: > | |
| 10231 echo system('echo hello')->split('\n', 1) | |
| 10232 < | |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10233 Returns an empty string on error. |
| 5808 | 10234 |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10235 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10236 :echo GetCmd()->systemlist() |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10237 |
| 5808 | 10238 |
| 677 | 10239 tabpagebuflist([{arg}]) *tabpagebuflist()* |
| 685 | 10240 The result is a |List|, where each item is the number of the |
| 677 | 10241 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
|
10242 {arg} specifies the number of the tab page to be used. When |
| 677 | 10243 omitted the current tab page is used. |
| 10244 When {arg} is invalid the number zero is returned. | |
| 10245 To get a list of all buffers in all tabs use this: > | |
| 3445 | 10246 let buflist = [] |
| 677 | 10247 for i in range(tabpagenr('$')) |
| 3445 | 10248 call extend(buflist, tabpagebuflist(i + 1)) |
| 677 | 10249 endfor |
| 10250 < Note that a buffer may appear in more than one window. | |
| 10251 | |
|
18031
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10252 Can also be used as a |method|: > |
|
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10253 GetTabpage()->tabpagebuflist() |
| 677 | 10254 |
| 10255 tabpagenr([{arg}]) *tabpagenr()* | |
| 674 | 10256 The result is a Number, which is the number of the current |
| 10257 tab page. The first tab page has number 1. | |
| 10258 When the optional argument is "$", the number of the last tab | |
| 10259 page is returned (the tab page count). | |
| 10260 The number can be used with the |:tab| command. | |
| 10261 | |
| 10262 | |
| 5763 | 10263 tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()* |
|
2569
f612f6b0b883
Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
10264 Like |winnr()| but for tab page {tabarg}. |
| 677 | 10265 {tabarg} specifies the number of tab page to be used. |
| 10266 {arg} is used like with |winnr()|: | |
| 10267 - When omitted the current window number is returned. This is | |
| 10268 the window which will be used when going to this tab page. | |
| 10269 - When "$" the number of windows is returned. | |
| 10270 - When "#" the previous window nr is returned. | |
| 10271 Useful examples: > | |
| 10272 tabpagewinnr(1) " current window of tab page 1 | |
| 10273 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
| 10274 < When {tabarg} is invalid zero is returned. | |
| 10275 | |
|
18031
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10276 Can also be used as a |method|: > |
|
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10277 GetTabpage()->tabpagewinnr() |
|
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10278 < |
| 805 | 10279 *tagfiles()* |
| 10280 tagfiles() Returns a |List| with the file names used to search for tags | |
| 10281 for the current buffer. This is the 'tags' option expanded. | |
| 10282 | |
| 10283 | |
| 12785 | 10284 taglist({expr} [, {filename}]) *taglist()* |
| 205 | 10285 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
|
10286 |
|
d3415ec1cdaf
patch 8.0.0499: taglist() does not prioritize tags for a buffer
Christian Brabandt <cb@256bit.org>
parents:
11211
diff
changeset
|
10287 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
|
10288 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
|
10289 {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
|
10290 |
| 438 | 10291 Each list item is a dictionary with at least the following |
| 10292 entries: | |
| 648 | 10293 name Name of the tag. |
| 10294 filename Name of the file where the tag is | |
| 1156 | 10295 defined. It is either relative to the |
| 10296 current directory or a full path. | |
| 205 | 10297 cmd Ex command used to locate the tag in |
| 10298 the file. | |
| 648 | 10299 kind Type of the tag. The value for this |
| 205 | 10300 entry depends on the language specific |
| 1156 | 10301 kind values. Only available when |
| 10302 using a tags file generated by | |
| 10303 Exuberant ctags or hdrtag. | |
| 648 | 10304 static A file specific tag. Refer to |
| 205 | 10305 |static-tag| for more information. |
| 1156 | 10306 More entries may be present, depending on the content of the |
| 10307 tags file: access, implementation, inherits and signature. | |
| 10308 Refer to the ctags documentation for information about these | |
| 10309 fields. For C code the fields "struct", "class" and "enum" | |
| 10310 may appear, they give the name of the entity the tag is | |
| 10311 contained in. | |
| 452 | 10312 |
| 11062 | 10313 The ex-command "cmd" can be either an ex search pattern, a |
| 216 | 10314 line number or a line number followed by a byte number. |
| 205 | 10315 |
| 10316 If there are no matching tags, then an empty list is returned. | |
| 10317 | |
| 10318 To get an exact tag match, the anchors '^' and '$' should be | |
| 4073 | 10319 used in {expr}. This also make the function work faster. |
| 10320 Refer to |tag-regexp| for more information about the tag | |
| 10321 search regular expression pattern. | |
| 205 | 10322 |
| 10323 Refer to |'tags'| for information about how the tags file is | |
| 10324 located by Vim. Refer to |tags-file-format| for the format of | |
| 10325 the tags file generated by the different ctags tools. | |
| 10326 | |
|
18031
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10327 Can also be used as a |method|: > |
|
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10328 GetTagpattern()->taglist() |
|
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10329 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10330 tan({expr}) *tan()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
10331 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
|
10332 in the range [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
10333 {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
|
10334 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10335 :echo tan(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10336 < 0.648361 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10337 :echo tan(-4.01) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10338 < -1.181502 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10339 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10340 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10341 Compute()->tan() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10342 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
10343 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10344 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10345 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10346 tanh({expr}) *tanh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
10347 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
|
10348 range [-1, 1]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
10349 {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
|
10350 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10351 :echo tanh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10352 < 0.462117 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10353 :echo tanh(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10354 < -0.761594 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10355 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10356 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10357 Compute()->tanh() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10358 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
10359 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10360 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10361 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
10362 tempname() *tempname()* *temp-file-name* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
10363 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
|
10364 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
|
10365 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
|
10366 :let tmpfile = tempname() |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
10367 :exe "redir > " . tmpfile |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
10368 < 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
|
10369 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
|
10370 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
|
10371 |
|
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
10372 |
|
17259
6dbb9b3c53e2
patch 8.1.1629: terminal function help is in the wrong file
Bram Moolenaar <Bram@vim.org>
parents:
17257
diff
changeset
|
10373 term_ functions are documented here: |terminal-function-details| |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
10374 |
| 17571 | 10375 test_ functions are documented here: |test-functions-details| |
|
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
10376 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
10377 |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
10378 *timer_info()* |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
10379 timer_info([{id}]) |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
10380 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
|
10381 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
|
10382 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
|
10383 returned. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
10384 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
|
10385 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
10386 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
|
10387 these items: |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
10388 "id" the timer ID |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
10389 "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
|
10390 "remaining" time until the timer fires |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
10391 "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
|
10392 -1 means forever |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
10393 "callback" the callback |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
10394 "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
|
10395 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10396 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10397 GetTimer()->timer_info() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10398 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10399 < {only available when compiled with the |+timers| feature} |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
10400 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
10401 timer_pause({timer}, {paused}) *timer_pause()* |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
10402 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
|
10403 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
|
10404 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
|
10405 has passed. |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
10406 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
10407 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
|
10408 for a short time. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
10409 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
10410 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
|
10411 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
|
10412 See |non-zero-arg|. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
10413 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10414 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10415 GetTimer()->timer_pause(1) |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10416 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10417 < {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
|
10418 |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
10419 *timer_start()* *timer* *timers* |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10420 timer_start({time}, {callback} [, {options}]) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10421 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
|
10422 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10423 {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
|
10424 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
|
10425 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
|
10426 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10427 {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
|
10428 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
|
10429 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
|
10430 waiting for input. |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10431 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10432 {options} is a dictionary. Supported entries: |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10433 "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
|
10434 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
|
10435 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
|
10436 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
|
10437 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
|
10438 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
|
10439 messages. |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10440 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10441 Example: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10442 func MyHandler(timer) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10443 echo 'Handler called' |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10444 endfunc |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10445 let timer = timer_start(500, 'MyHandler', |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10446 \ {'repeat': 3}) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10447 < 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
|
10448 intervals. |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
10449 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10450 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10451 GetMsec()->timer_start(callback) |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10452 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10453 < Not available in the |sandbox|. |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10454 {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
|
10455 |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
10456 timer_stop({timer}) *timer_stop()* |
|
9097
071f9da012fb
commit https://github.com/vim/vim/commit/06d2d38ab7564e1f784b1058a4ef4580cd6d1810
Christian Brabandt <cb@256bit.org>
parents:
9076
diff
changeset
|
10457 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
|
10458 {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
|
10459 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
|
10460 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10461 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10462 GetTimer()->timer_stop() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10463 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10464 < {only available when compiled with the |+timers| feature} |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
10465 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
10466 timer_stopall() *timer_stopall()* |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
10467 Stop all timers. The timer callbacks will no longer be |
|
17366
9843fbfa0ee5
patch 8.1.1682: placing a larger number of signs is slow
Bram Moolenaar <Bram@vim.org>
parents:
17292
diff
changeset
|
10468 invoked. Useful if a timer is misbehaving. If there are no |
|
9843fbfa0ee5
patch 8.1.1682: placing a larger number of signs is slow
Bram Moolenaar <Bram@vim.org>
parents:
17292
diff
changeset
|
10469 timers there is no error. |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
10470 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
10471 {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
|
10472 |
| 7 | 10473 tolower({expr}) *tolower()* |
| 10474 The result is a copy of the String given, with all uppercase | |
| 10475 characters turned into lowercase (just like applying |gu| to | |
| 10476 the string). | |
| 10477 | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10478 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10479 GetText()->tolower() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10480 |
| 7 | 10481 toupper({expr}) *toupper()* |
| 10482 The result is a copy of the String given, with all lowercase | |
| 10483 characters turned into uppercase (just like applying |gU| to | |
| 10484 the string). | |
| 10485 | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10486 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10487 GetText()->toupper() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10488 |
| 15 | 10489 tr({src}, {fromstr}, {tostr}) *tr()* |
| 10490 The result is a copy of the {src} string with all characters | |
| 10491 which appear in {fromstr} replaced by the character in that | |
| 10492 position in the {tostr} string. Thus the first character in | |
| 10493 {fromstr} is translated into the first character in {tostr} | |
| 10494 and so on. Exactly like the unix "tr" command. | |
| 10495 This code also deals with multibyte characters properly. | |
| 10496 | |
| 10497 Examples: > | |
| 10498 echo tr("hello there", "ht", "HT") | |
| 10499 < returns "Hello THere" > | |
| 10500 echo tr("<blob>", "<>", "{}") | |
| 10501 < returns "{blob}" | |
| 10502 | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10503 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10504 GetText()->tr(from, to) |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10505 |
|
20629
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
10506 trim({text} [, {mask} [, {dir}]]) *trim()* |
|
13513
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
10507 Return {text} as a String where any character in {mask} is |
|
20629
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
10508 removed from the beginning and/or end of {text}. |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
10509 |
|
13513
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
10510 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
|
10511 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
|
10512 space character 0xa0. |
|
20629
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
10513 |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
10514 The optional {dir} argument specifies where to remove the |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
10515 characters: |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
10516 0 remove from the beginning and end of {text} |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
10517 1 remove only at the beginning of {text} |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
10518 2 remove only at the end of {text} |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
10519 When omitted both ends are trimmed. |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
10520 |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
10521 This function deals with multibyte characters properly. |
|
13513
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
10522 |
|
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
10523 Examples: > |
| 13563 | 10524 echo trim(" some text ") |
| 10525 < returns "some text" > | |
| 10526 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
|
10527 < returns "RESERVE_TAIL" > |
| 13563 | 10528 echo trim("rm<Xrm<>X>rrm", "rm<>") |
|
20629
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
10529 < returns "Xrm<>X" (characters in the middle are not removed) > |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
10530 echo trim(" vim ", " ", 2) |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
10531 < returns " vim" |
|
13513
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
10532 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10533 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10534 GetText()->trim() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10535 |
| 1621 | 10536 trunc({expr}) *trunc()* |
| 1668 | 10537 Return the largest integral value with magnitude less than or |
| 1621 | 10538 equal to {expr} as a |Float| (truncate towards zero). |
| 10539 {expr} must evaluate to a |Float| or a |Number|. | |
| 10540 Examples: > | |
| 10541 echo trunc(1.456) | |
| 10542 < 1.0 > | |
| 10543 echo trunc(-5.456) | |
| 10544 < -5.0 > | |
| 10545 echo trunc(4.0) | |
| 10546 < 4.0 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10547 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10548 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10549 Compute()->trunc() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10550 < |
| 1621 | 10551 {only available when compiled with the |+float| feature} |
| 12785 | 10552 |
| 87 | 10553 *type()* |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10554 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
|
10555 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
|
10556 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
|
10557 Number: 0 |v:t_number| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10558 String: 1 |v:t_string| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10559 Funcref: 2 |v:t_func| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10560 List: 3 |v:t_list| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10561 Dictionary: 4 |v:t_dict| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10562 Float: 5 |v:t_float| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10563 Boolean: 6 |v:t_bool| (v:false and v:true) |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
10564 None: 7 |v:t_none| (v:null and v:none) |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
10565 Job: 8 |v:t_job| |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
10566 Channel: 9 |v:t_channel| |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
10567 Blob: 10 |v:t_blob| |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10568 For backward compatibility, this method can be used: > |
| 87 | 10569 :if type(myvar) == type(0) |
| 10570 :if type(myvar) == type("") | |
| 10571 :if type(myvar) == type(function("tr")) | |
| 10572 :if type(myvar) == type([]) | |
| 153 | 10573 :if type(myvar) == type({}) |
| 1621 | 10574 :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
|
10575 :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
|
10576 :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
|
10577 < 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
|
10578 :if exists('v:t_number') |
| 7 | 10579 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10580 < Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10581 mylist->type() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10582 |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
10583 undofile({name}) *undofile()* |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
10584 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
|
10585 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
|
10586 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
|
10587 the undo file exists. |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
10588 {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
|
10589 is used internally. |
|
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
10590 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
|
10591 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
|
10592 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
|
10593 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
|
10594 returns an empty string. |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
10595 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10596 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10597 GetFilename()->undofile() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10598 |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10599 undotree() *undotree()* |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10600 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
|
10601 the following items: |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10602 "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
|
10603 "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
|
10604 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
|
10605 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
|
10606 "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
|
10607 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
|
10608 something readable. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10609 "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
|
10610 write yet. |
|
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
10611 "save_cur" Number of the current position in the undo |
| 12785 | 10612 tree. |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10613 "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
|
10614 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
|
10615 user. See |undo-blocks|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10616 "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
|
10617 undo blocks. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10618 |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10619 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
|
10620 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
|
10621 "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
|
10622 |:undolist|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10623 "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
|
10624 |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
|
10625 "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
|
10626 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
|
10627 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
|
10628 "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
|
10629 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
|
10630 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
|
10631 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
|
10632 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
|
10633 not appear anywhere. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10634 "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
|
10635 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
|
10636 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
|
10637 "save_last" mentioned above. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10638 "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
|
10639 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
|
10640 item. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10641 |
| 5747 | 10642 uniq({list} [, {func} [, {dict}]]) *uniq()* *E882* |
| 10643 Remove second and succeeding copies of repeated adjacent | |
| 10644 {list} items in-place. Returns {list}. If you want a list | |
| 10645 to remain unmodified make a copy first: > | |
| 10646 :let newlist = uniq(copy(mylist)) | |
| 10647 < The default compare function uses the string representation of | |
| 10648 each item. For the use of {func} and {dict} see |sort()|. | |
| 10649 | |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10650 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10651 mylist->uniq() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10652 |
| 140 | 10653 values({dict}) *values()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
10654 Return a |List| with all the values of {dict}. The |List| is |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
10655 in arbitrary order. Also see |items()| and |keys()|. |
| 140 | 10656 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10657 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10658 mydict->values() |
| 140 | 10659 |
| 7 | 10660 virtcol({expr}) *virtcol()* |
| 10661 The result is a Number, which is the screen column of the file | |
| 10662 position given with {expr}. That is, the last screen position | |
| 10663 occupied by the character at that position, when the screen | |
| 10664 would be of unlimited width. When there is a <Tab> at the | |
| 10665 position, the returned Number will be the column at the end of | |
| 10666 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
| 3445 | 10667 set to 8, it returns 8. |conceal| is ignored. |
| 1317 | 10668 For the byte position use |col()|. |
| 10669 For the use of {expr} see |col()|. | |
| 10670 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
| 703 | 10671 "off" is the offset in screen columns from the start of the |
| 1266 | 10672 character. E.g., a position within a <Tab> or after the last |
| 2965 | 10673 character. When "off" is omitted zero is used. |
| 7 | 10674 When Virtual editing is active in the current mode, a position |
| 10675 beyond the end of the line can be returned. |'virtualedit'| | |
| 10676 The accepted positions are: | |
| 10677 . the cursor position | |
| 10678 $ the end of the cursor line (the result is the | |
| 10679 number of displayed characters in the cursor line | |
| 10680 plus one) | |
| 10681 'x position of mark x (if the mark is not set, 0 is | |
| 10682 returned) | |
| 6447 | 10683 v In Visual mode: the start of the Visual area (the |
| 10684 cursor is the end). When not in Visual mode | |
| 10685 returns the cursor position. Differs from |'<| in | |
| 10686 that it's updated right away. | |
| 7 | 10687 Note that only marks in the current file can be used. |
| 10688 Examples: > | |
| 10689 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
| 10690 virtcol("$") with text "foo^Lbar", returns 9 | |
| 1621 | 10691 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
|
10692 < The first column is 1. 0 is returned for an error. |
| 1156 | 10693 A more advanced example that echoes the maximum length of |
| 10694 all lines: > | |
| 10695 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
| 10696 | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10697 < Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10698 GetPos()->virtcol() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10699 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10700 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10701 visualmode([{expr}]) *visualmode()* |
| 7 | 10702 The result is a String, which describes the last Visual mode |
| 856 | 10703 used in the current buffer. Initially it returns an empty |
| 10704 string, but once Visual mode has been used, it returns "v", | |
| 10705 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
| 10706 character-wise, line-wise, or block-wise Visual mode | |
| 10707 respectively. | |
| 7 | 10708 Example: > |
| 10709 :exe "normal " . visualmode() | |
| 10710 < This enters the same Visual mode as before. It is also useful | |
| 10711 in scripts if you wish to act differently depending on the | |
| 10712 Visual mode that was used. | |
| 1621 | 10713 If Visual mode is active, use |mode()| to get the Visual mode |
| 10714 (e.g., in a |:vmap|). | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10715 If {expr} is supplied and it evaluates to a non-zero Number or |
| 1661 | 10716 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
|
10717 the old value is returned. See |non-zero-arg|. |
| 7 | 10718 |
| 4151 | 10719 wildmenumode() *wildmenumode()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
10720 Returns |TRUE| when the wildmenu is active and |FALSE| |
| 4151 | 10721 otherwise. See 'wildmenu' and 'wildmode'. |
| 10722 This can be used in mappings to handle the 'wildcharm' option | |
| 10723 gracefully. (Makes only sense with |mapmode-c| mappings). | |
| 10724 | |
| 10725 For example to make <c-j> work like <down> in wildmode, use: > | |
| 10726 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>" | |
| 10727 < | |
| 10728 (Note, this needs the 'wildcharm' option set appropriately). | |
| 10729 | |
|
16833
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
10730 win_execute({id}, {command} [, {silent}]) *win_execute()* |
|
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
10731 Like `execute()` but in the context of window {id}. |
|
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
10732 The window will temporarily be made the current window, |
|
16849
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
10733 without triggering autocommands. When executing {command} |
|
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
10734 autocommands will be triggered, this may have unexpected side |
|
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
10735 effects. Use |:noautocmd| if needed. |
|
16833
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
10736 Example: > |
|
16849
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
10737 call win_execute(winid, 'set syntax=python') |
|
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
10738 < Doing the same with `setwinvar()` would not trigger |
|
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
10739 autocommands and not actually show syntax highlighting. |
| 16944 | 10740 *E994* |
| 10741 Not all commands are allowed in popup windows. | |
| 17758 | 10742 When window {id} does not exist then no error is given. |
| 4151 | 10743 |
| 18343 | 10744 Can also be used as a |method|, the base is passed as the |
| 10745 second argument: > | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10746 GetCommand()->win_execute(winid) |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10747 |
|
8536
09041d2fd7d0
commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents:
8534
diff
changeset
|
10748 win_findbuf({bufnr}) *win_findbuf()* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
10749 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
|
10750 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
|
10751 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10752 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10753 GetBufnr()->win_findbuf() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10754 |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10755 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
|
10756 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
|
10757 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
|
10758 With {win} this is the window number. The top window has |
| 14999 | 10759 number 1. |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10760 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
|
10761 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
|
10762 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
|
10763 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10764 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10765 GetWinnr()->win_getid() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10766 |
|
19398
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10767 |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10768 win_gettype([{nr}]) *win_gettype()* |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10769 Return the type of the window: |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10770 "popup" popup window |popup| |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10771 "command" command-line window |cmdwin| |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10772 (empty) normal window |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10773 "unknown" window {nr} not found |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10774 |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10775 When {nr} is omitted return the type of the current window. |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10776 When {nr} is given return the type of this window by number or |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10777 |window-ID|. |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10778 |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10779 Also see the 'buftype' option. When running a terminal in a |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10780 popup window then 'buftype' is "terminal" and win_gettype() |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10781 returns "popup". |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10782 |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
10783 |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10784 win_gotoid({expr}) *win_gotoid()* |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10785 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
|
10786 tabpage. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10787 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
|
10788 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10789 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10790 GetWinid()->win_gotoid() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10791 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
10792 win_id2tabwin({expr}) *win_id2tabwin()* |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10793 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
|
10794 with ID {expr}: [tabnr, winnr]. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10795 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
|
10796 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10797 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10798 GetWinid()->win_id2tabwin() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10799 |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10800 win_id2win({expr}) *win_id2win()* |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10801 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
|
10802 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
|
10803 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10804 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10805 GetWinid()->win_id2win() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10806 |
|
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
|
10807 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
|
10808 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
|
10809 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
|
10810 [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
|
10811 {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
|
10812 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
|
10813 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
|
10814 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10815 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10816 GetWinid()->win_screenpos() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10817 < |
|
18049
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10818 win_splitmove({nr}, {target} [, {options}]) *win_splitmove()* |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10819 Move the window {nr} to a new split of the window {target}. |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10820 This is similar to moving to {target}, creating a new window |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10821 using |:split| but having the same contents as window {nr}, and |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10822 then closing {nr}. |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10823 |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10824 Both {nr} and {target} can be window numbers or |window-ID|s. |
| 19099 | 10825 Both must be in the current tab page. |
|
18049
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10826 |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10827 Returns zero for success, non-zero for failure. |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10828 |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10829 {options} is a Dictionary with the following optional entries: |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10830 "vertical" When TRUE, the split is created vertically, |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10831 like with |:vsplit|. |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10832 "rightbelow" When TRUE, the split is made below or to the |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10833 right (if vertical). When FALSE, it is done |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10834 above or to the left (if vertical). When not |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10835 present, the values of 'splitbelow' and |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10836 'splitright' are used. |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10837 |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10838 Can also be used as a |method|: > |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10839 GetWinid()->win_splitmove(target) |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
10840 < |
|
19400
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
10841 |
| 7 | 10842 *winbufnr()* |
| 10843 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
|
10844 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
|
10845 the |window-ID|. |
|
9223
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
10846 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
|
10847 window is returned. |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
10848 When window {nr} doesn't exist, -1 is returned. |
| 7 | 10849 Example: > |
| 10850 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
| 10851 < | |
|
17825
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
10852 Can also be used as a |method|: > |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
10853 FindWindow()->winbufnr()->bufname() |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
10854 < |
| 7 | 10855 *wincol()* |
| 10856 wincol() The result is a Number, which is the virtual column of the | |
| 10857 cursor in the window. This is counting screen cells from the | |
| 10858 left side of the window. The leftmost column is one. | |
| 10859 | |
|
18973
bf8eb950df61
patch 8.2.0047: cannot skip tests for specific MS-Windows platform
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
10860 *windowsversion()* |
|
bf8eb950df61
patch 8.2.0047: cannot skip tests for specific MS-Windows platform
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
10861 windowsversion() |
|
bf8eb950df61
patch 8.2.0047: cannot skip tests for specific MS-Windows platform
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
10862 The result is a String. For MS-Windows it indicates the OS |
|
bf8eb950df61
patch 8.2.0047: cannot skip tests for specific MS-Windows platform
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
10863 version. E.g, Windows 10 is "10.0", Windows 8 is "6.2", |
|
bf8eb950df61
patch 8.2.0047: cannot skip tests for specific MS-Windows platform
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
10864 Windows XP is "5.1". For non-MS-Windows systems the result is |
|
bf8eb950df61
patch 8.2.0047: cannot skip tests for specific MS-Windows platform
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
10865 an empty string. |
|
bf8eb950df61
patch 8.2.0047: cannot skip tests for specific MS-Windows platform
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
10866 |
| 7 | 10867 winheight({nr}) *winheight()* |
| 10868 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
|
10869 {nr} can be the window number or the |window-ID|. |
| 7 | 10870 When {nr} is zero, the height of the current window is |
| 10871 returned. When window {nr} doesn't exist, -1 is returned. | |
| 10872 An existing window always has a height of zero or more. | |
| 12499 | 10873 This excludes any window toolbar line. |
| 7 | 10874 Examples: > |
| 10875 :echo "The current window has " . winheight(0) . " lines." | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10876 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10877 < Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10878 GetWinid()->winheight() |
| 7 | 10879 < |
|
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
|
10880 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
|
10881 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
|
10882 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
|
10883 |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
10884 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
|
10885 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
|
10886 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
|
10887 |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
10888 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
|
10889 ['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
|
10890 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
|
10891 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
|
10892 ['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
|
10893 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
|
10894 ['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
|
10895 |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
10896 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
|
10897 " 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
|
10898 :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
|
10899 ['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
|
10900 " 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
|
10901 :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
|
10902 ['col', [['leaf', 1000], ['leaf', 1001]]] |
| 19646 | 10903 " The second tab page, with three horizontally split |
| 10904 " windows, with two vertically split windows in the | |
| 10905 " middle window | |
|
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
|
10906 :echo winlayout(2) |
| 19646 | 10907 ['col', [['leaf', 1002], ['row', [['leaf', 1003], |
| 10908 ['leaf', 1001]]], ['leaf', 1000]]] | |
|
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
|
10909 < |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10910 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10911 GetTabnr()->winlayout() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10912 < |
| 7 | 10913 *winline()* |
| 10914 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
|
10915 in the window. This is counting screen lines from the top of |
| 7 | 10916 the window. The first line is one. |
| 531 | 10917 If the cursor was moved the view on the file will be updated |
| 10918 first, this may cause a scroll. | |
| 7 | 10919 |
| 10920 *winnr()* | |
| 20 | 10921 winnr([{arg}]) The result is a Number, which is the number of the current |
| 10922 window. The top window has number 1. | |
| 19303 | 10923 Returns zero for a popup window. |
|
16271
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10924 |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10925 The optional argument {arg} supports the following values: |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10926 $ the number of the last window (the window |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10927 count). |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10928 # the number of the last accessed window (where |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10929 |CTRL-W_p| goes to). If there is no previous |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10930 window or it is in another tab page 0 is |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10931 returned. |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10932 {N}j the number of the Nth window below the |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10933 current window (where |CTRL-W_j| goes to). |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10934 {N}k the number of the Nth window above the current |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10935 window (where |CTRL-W_k| goes to). |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10936 {N}h the number of the Nth window left of the |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10937 current window (where |CTRL-W_h| goes to). |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10938 {N}l the number of the Nth window right of the |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10939 current window (where |CTRL-W_l| goes to). |
| 20 | 10940 The number can be used with |CTRL-W_w| and ":wincmd w" |
| 10941 |:wincmd|. | |
| 10734 | 10942 Also see |tabpagewinnr()| and |win_getid()|. |
|
16271
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10943 Examples: > |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10944 let window_count = winnr('$') |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10945 let prev_window = winnr('#') |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10946 let wnum = winnr('3k') |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10947 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10948 < Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10949 GetWinval()->winnr() |
|
16271
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10950 < |
| 7 | 10951 *winrestcmd()* |
| 10952 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
| 10953 the current window sizes. Only works properly when no windows | |
| 712 | 10954 are opened or closed and the current window and tab page is |
| 10955 unchanged. | |
| 7 | 10956 Example: > |
| 10957 :let cmd = winrestcmd() | |
| 10958 :call MessWithWindowSizes() | |
| 10959 :exe cmd | |
| 712 | 10960 < |
| 10961 *winrestview()* | |
| 10962 winrestview({dict}) | |
| 10963 Uses the |Dictionary| returned by |winsaveview()| to restore | |
| 10964 the view of the current window. | |
| 5940 | 10965 Note: The {dict} does not have to contain all values, that are |
| 10966 returned by |winsaveview()|. If values are missing, those | |
| 10967 settings won't be restored. So you can use: > | |
| 10968 :call winrestview({'curswant': 4}) | |
| 10969 < | |
| 10970 This will only set the curswant value (the column the cursor | |
| 10971 wants to move on vertical movements) of the cursor to column 5 | |
| 10972 (yes, that is 5), while all other settings will remain the | |
| 10973 same. This is useful, if you set the cursor position manually. | |
| 10974 | |
| 712 | 10975 If you have changed the values the result is unpredictable. |
| 10976 If the window size changed the result won't be the same. | |
| 10977 | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10978 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10979 GetView()->winrestview() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
10980 < |
| 712 | 10981 *winsaveview()* |
| 10982 winsaveview() Returns a |Dictionary| that contains information to restore | |
| 10983 the view of the current window. Use |winrestview()| to | |
| 10984 restore the view. | |
| 10985 This is useful if you have a mapping that jumps around in the | |
| 10986 buffer and you want to go back to the original view. | |
| 10987 This does not save fold information. Use the 'foldenable' | |
| 798 | 10988 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
|
10989 not opened when moving around. This may have side effects. |
| 712 | 10990 The return value includes: |
| 10991 lnum cursor line number | |
| 5940 | 10992 col cursor column (Note: the first column |
| 10993 zero, as opposed to what getpos() | |
| 10994 returns) | |
| 712 | 10995 coladd cursor column offset for 'virtualedit' |
| 10996 curswant column for vertical movement | |
| 10997 topline first line in the window | |
| 10998 topfill filler lines, only in diff mode | |
| 10999 leftcol first column displayed | |
| 11000 skipcol columns skipped | |
| 11001 Note that no option values are saved. | |
| 11002 | |
| 7 | 11003 |
| 11004 winwidth({nr}) *winwidth()* | |
| 11005 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
|
11006 {nr} can be the window number or the |window-ID|. |
| 7 | 11007 When {nr} is zero, the width of the current window is |
| 11008 returned. When window {nr} doesn't exist, -1 is returned. | |
| 11009 An existing window always has a width of zero or more. | |
| 11010 Examples: > | |
| 11011 :echo "The current window has " . winwidth(0) . " columns." | |
| 11012 :if winwidth(0) <= 50 | |
|
12857
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
11013 : 50 wincmd | |
| 7 | 11014 :endif |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
11015 < 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
|
11016 option. |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
11017 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11018 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11019 GetWinid()->winwidth() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11020 |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
11021 |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11022 wordcount() *wordcount()* |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11023 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
|
11024 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
|
11025 |g_CTRL-G| |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11026 The return value includes: |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11027 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
|
11028 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
|
11029 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
|
11030 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
|
11031 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11032 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
|
11033 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11034 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
|
11035 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11036 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
|
11037 (only in Visual mode) |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11038 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
|
11039 (only in Visual mode) |
| 12254 | 11040 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
|
11041 (only in Visual mode) |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11042 |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11043 |
| 158 | 11044 *writefile()* |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
11045 writefile({object}, {fname} [, {flags}]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
11046 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
|
11047 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
|
11048 or Number. |
| 6341 | 11049 When {flags} contains "b" then binary mode is used: There will |
| 158 | 11050 not be a NL after the last list item. An empty item at the |
| 11051 end does cause the last line in the file to end in a NL. | |
| 6341 | 11052 |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
11053 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
|
11054 unmodified. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
11055 |
| 6341 | 11056 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
|
11057 appended to the file: > |
| 6341 | 11058 :call writefile(["foo"], "event.log", "a") |
| 11059 :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
|
11060 < |
|
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
11061 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
|
11062 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
|
11063 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
|
11064 crashes. |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
11065 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
|
11066 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
|
11067 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
|
11068 when 'fsync' is set. |
|
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
11069 |
|
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
11070 All NL characters are replaced with a NUL character. |
| 158 | 11071 Inserting CR characters needs to be done before passing {list} |
| 11072 to writefile(). | |
| 11073 An existing file is overwritten, if possible. | |
| 11074 When the write fails -1 is returned, otherwise 0. There is an | |
| 11075 error message if the file can't be created or when writing | |
| 11076 fails. | |
| 11077 Also see |readfile()|. | |
| 11078 To copy a file byte for byte: > | |
| 11079 :let fl = readfile("foo", "b") | |
| 11080 :call writefile(fl, "foocopy", "b") | |
| 3214 | 11081 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11082 < Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11083 GetText()->writefile("thefile") |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11084 |
| 3214 | 11085 |
| 11086 xor({expr}, {expr}) *xor()* | |
| 11087 Bitwise XOR on the two arguments. The arguments are converted | |
| 11088 to a number. A List, Dict or Float argument causes an error. | |
| 11089 Example: > | |
| 11090 :let bits = xor(bits, 0x80) | |
| 18343 | 11091 < |
| 11092 Can also be used as a |method|: > | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
11093 :let bits = bits->xor(0x80) |
| 3256 | 11094 < |
| 3214 | 11095 |
| 7 | 11096 *feature-list* |
| 19163 | 11097 There are three types of features: |
| 7 | 11098 1. Features that are only supported when they have been enabled when Vim |
| 11099 was compiled |+feature-list|. Example: > | |
| 11100 :if has("cindent") | |
| 11101 2. Features that are only supported when certain conditions have been met. | |
| 11102 Example: > | |
| 11103 :if has("gui_running") | |
| 11104 < *has-patch* | |
|
13967
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
11105 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
|
11106 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
|
11107 later, or it is version 7.4 and patch 248 was included. Example: > |
| 5862 | 11108 :if has("patch-7.4.248") |
|
13967
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
11109 < 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
|
11110 included. Only happens when cherry-picking patches. |
|
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
11111 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
|
11112 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
|
11113 version 6.2.148 or later): > |
|
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
11114 :if v:version > 602 || (v:version == 602 && has("patch148")) |
| 7 | 11115 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
11116 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
|
11117 use: `if exists('+shellslash')` |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
11118 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
11119 |
| 5340 | 11120 acl Compiled with |ACL| support. |
| 7 | 11121 all_builtin_terms Compiled with all builtin terminals enabled. |
| 11122 amiga Amiga version of Vim. | |
| 11123 arabic Compiled with Arabic support |Arabic|. | |
| 11124 arp Compiled with ARP support (Amiga). | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11125 autocmd Compiled with autocommand support. (always true) |
| 14421 | 11126 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
|
11127 autoservername Automatically enable |clientserver| |
| 7 | 11128 balloon_eval Compiled with |balloon-eval| support. |
| 435 | 11129 balloon_multiline GUI supports multiline balloons. |
| 7 | 11130 beos BeOS version of Vim. |
| 11131 browse Compiled with |:browse| support, and browse() will | |
| 11132 work. | |
| 3682 | 11133 browsefilter Compiled with support for |browsefilter|. |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11134 bsd Compiled on an OS in the BSD family (excluding macOS). |
| 7 | 11135 builtin_terms Compiled with some builtin terminals. |
| 11136 byte_offset Compiled with support for 'o' in 'statusline' | |
| 19523 | 11137 channel Compiled with support for |channel| and |job| |
| 7 | 11138 cindent Compiled with 'cindent' support. |
| 11139 clientserver Compiled with remote invocation support |clientserver|. | |
| 11140 clipboard Compiled with 'clipboard' support. | |
|
17680
55704f587945
patch 8.1.1837: popup test fails if clipboard is supported but not working
Bram Moolenaar <Bram@vim.org>
parents:
17676
diff
changeset
|
11141 clipboard_working Compiled with 'clipboard' support and it can be used. |
| 7 | 11142 cmdline_compl Compiled with |cmdline-completion| support. |
| 11143 cmdline_hist Compiled with |cmdline-history| support. | |
| 11144 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
| 11145 comments Compiled with |'comments'| support. | |
| 2681 | 11146 compatible Compiled to be very Vi compatible. |
|
15725
a3e2e7948ee4
patch 8.1.0870: Vim doesn't use the new ConPTY support in Windows 10
Bram Moolenaar <Bram@vim.org>
parents:
15711
diff
changeset
|
11147 conpty Platform where |ConPTY| can be used. |
| 7 | 11148 cryptv Compiled with encryption support |encryption|. |
| 11149 cscope Compiled with |cscope| support. | |
| 15729 | 11150 cursorbind Compiled with |'cursorbind'| (always true) |
| 7 | 11151 debug Compiled with "DEBUG" defined. |
| 11152 dialog_con Compiled with console dialog support. | |
| 11153 dialog_gui Compiled with GUI dialog support. | |
| 11154 diff Compiled with |vimdiff| and 'diff' support. | |
| 11155 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
|
11156 directx Compiled with support for DirectX and 'renderoptions'. |
| 7 | 11157 dnd Compiled with support for the "~ register |quote_~|. |
| 11158 ebcdic Compiled on a machine with ebcdic character set. | |
| 11159 emacs_tags Compiled with support for Emacs tags. | |
| 11160 eval Compiled with expression evaluation support. Always | |
| 11161 true, of course! | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11162 ex_extra |+ex_extra| (always true) |
| 7 | 11163 extra_search Compiled with support for |'incsearch'| and |
| 11164 |'hlsearch'| | |
| 18790 | 11165 farsi Support for Farsi was removed |farsi|. |
| 7 | 11166 file_in_path Compiled with support for |gf| and |<cfile>| |
| 168 | 11167 filterpipe When 'shelltemp' is off pipes are used for shell |
| 11168 read/write/filter commands | |
| 7 | 11169 find_in_path Compiled with support for include file searches |
| 11170 |+find_in_path|. | |
| 1621 | 11171 float Compiled with support for |Float|. |
| 18972 | 11172 fname_case Case in file names matters (for Amiga and MS-Windows |
| 11173 this is not present). | |
| 7 | 11174 folding Compiled with |folding| support. |
| 11175 footer Compiled with GUI footer support. |gui-footer| | |
| 11176 fork Compiled to use fork()/exec() instead of system(). | |
| 11177 gettext Compiled with message translation |multi-lang| | |
| 11178 gui Compiled with GUI enabled. | |
| 11179 gui_athena Compiled with Athena GUI. | |
| 2681 | 11180 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
| 7 | 11181 gui_gtk Compiled with GTK+ GUI (any version). |
| 11182 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
|
11183 gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined). |
|
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19523
diff
changeset
|
11184 gui_haiku Compiled with Haiku GUI. |
| 7 | 11185 gui_mac Compiled with Macintosh GUI. |
| 11186 gui_motif Compiled with Motif GUI. | |
| 11187 gui_photon Compiled with Photon GUI. | |
| 2681 | 11188 gui_running Vim is running in the GUI, or it will start soon. |
| 7 | 11189 gui_win32 Compiled with MS Windows Win32 GUI. |
| 11190 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
|
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19523
diff
changeset
|
11191 haiku Haiku version of Vim. |
| 7 | 11192 hangul_input Compiled with Hangul input support. |hangul| |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11193 hpux HP-UX version of Vim. |
| 7 | 11194 iconv Can use iconv() for conversion. |
| 11195 insert_expand Compiled with support for CTRL-X expansion commands in | |
|
17825
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
11196 Insert mode. (always true) |
| 19968 | 11197 job Compiled with support for |channel| and |job| |
|
20037
f36f10d90378
patch 8.2.0574: ipv6 feature not shown in :version output
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
11198 ipv6 Compiled with support for IPv6 networking in |channel|. |
| 7 | 11199 jumplist Compiled with |jumplist| support. |
| 11200 keymap Compiled with 'keymap' support. | |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
11201 lambda Compiled with |lambda| support. |
| 7 | 11202 langmap Compiled with 'langmap' support. |
| 11203 libcall Compiled with |libcall()| support. | |
| 5995 | 11204 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and |
| 11205 'breakindent' support. | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11206 linux Linux version of Vim. |
| 7 | 11207 lispindent Compiled with support for lisp indenting. |
| 11208 listcmds Compiled with commands for the buffer list |:files| | |
| 11209 and the argument list |arglist|. | |
| 11210 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
|
11211 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
|
11212 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
|
11213 macunix Synonym for osxdarwin |
| 7 | 11214 menu Compiled with support for |:menu|. |
| 11215 mksession Compiled with support for |:mksession|. | |
| 11216 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
11217 (always true) |
| 7 | 11218 mouse Compiled with support mouse. |
| 11219 mouse_dec Compiled with support for Dec terminal mouse. | |
| 11220 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
|
16527
5412fcd03ecb
patch 8.1.1267: cannot check if GPM mouse support is working
Bram Moolenaar <Bram@vim.org>
parents:
16517
diff
changeset
|
11221 mouse_gpm_enabled GPM mouse is working |
| 7 | 11222 mouse_netterm Compiled with support for netterm mouse. |
| 11223 mouse_pterm Compiled with support for qnx pterm mouse. | |
| 1621 | 11224 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
| 3750 | 11225 mouse_sgr Compiled with support for sgr mouse. |
| 3224 | 11226 mouse_urxvt Compiled with support for urxvt mouse. |
| 7 | 11227 mouse_xterm Compiled with support for xterm mouse. |
| 2681 | 11228 mouseshape Compiled with support for 'mouseshape'. |
| 15878 | 11229 multi_byte Compiled with support for 'encoding' (always true) |
| 1768 | 11230 multi_byte_encoding 'encoding' is set to a multi-byte encoding. |
| 7 | 11231 multi_byte_ime Compiled with support for IME input method. |
| 11232 multi_lang Compiled with support for multiple languages. | |
| 14 | 11233 mzscheme Compiled with MzScheme interface |mzscheme|. |
| 2681 | 11234 netbeans_enabled Compiled with support for |netbeans| and connected. |
| 7 | 11235 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
|
11236 num64 Compiled with 64-bit |Number| support. |
| 7 | 11237 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
|
11238 osx Compiled for macOS cf. mac |
|
351cf7c67bbe
patch 8.0.1236: Mac features are confusing
Christian Brabandt <cb@256bit.org>
parents:
12632
diff
changeset
|
11239 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
|
11240 packages Compiled with |packages| support. |
| 7 | 11241 path_extra Compiled with up/downwards search in 'path' and 'tags' |
| 11242 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
|
11243 persistent_undo Compiled with support for persistent undo history. |
| 7 | 11244 postscript Compiled with PostScript file printing. |
| 11245 printer Compiled with |:hardcopy| support. | |
| 170 | 11246 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
|
11247 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
|
11248 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
|
11249 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
|
11250 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
|
11251 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
|
11252 python3_dynamic Python 3.x interface is dynamically loaded. |has-python| |
| 19523 | 11253 pythonx Python 2.x and/or 3.x interface available. |python_x| |
| 7 | 11254 qnx QNX version of Vim. |
| 11255 quickfix Compiled with |quickfix| support. | |
| 857 | 11256 reltime Compiled with |reltime()| support. |
| 7 | 11257 rightleft Compiled with 'rightleft' support. |
| 11258 ruby Compiled with Ruby interface |ruby|. | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11259 scrollbind Compiled with 'scrollbind' support. (always true) |
| 7 | 11260 showcmd Compiled with 'showcmd' support. |
| 11261 signs Compiled with |:sign| support. | |
| 11262 smartindent Compiled with 'smartindent' support. | |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
11263 sound Compiled with sound support, e.g. `sound_playevent()` |
| 2681 | 11264 spell Compiled with spell checking support |spell|. |
| 1989 | 11265 startuptime Compiled with |--startuptime| support. |
| 7 | 11266 statusline Compiled with support for 'statusline', 'rulerformat' |
| 11267 and special formats of 'titlestring' and 'iconstring'. | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11268 sun SunOS version of Vim. |
| 15512 | 11269 sun_workshop Support for Sun |workshop| has been removed. |
| 314 | 11270 syntax Compiled with syntax highlighting support |syntax|. |
| 7 | 11271 syntax_items There are active syntax highlighting items for the |
| 11272 current buffer. | |
| 11273 system Compiled to use system() instead of fork()/exec(). | |
| 11274 tag_binary Compiled with binary searching in tags files | |
| 11275 |tag-binary-search|. | |
| 16208 | 11276 tag_old_static Support for old static tags was removed, see |
| 7 | 11277 |tag-old-static|. |
| 11278 tcl Compiled with Tcl interface. | |
|
9076
9305a1251e51
commit https://github.com/vim/vim/commit/91c4937be15b0b743b6bc495df602c1abbff6b87
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
11279 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
|
11280 terminal Compiled with |terminal| support. |
| 7 | 11281 terminfo Compiled with terminfo instead of termcap. |
| 11282 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
| 11283 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
|
11284 textprop Compiled with support for |text-properties|. |
| 7 | 11285 tgetent Compiled with tgetent support, able to use a termcap |
| 11286 or terminfo file. | |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11287 timers Compiled with |timer_start()| support. |
| 7 | 11288 title Compiled with window title support |'title'|. |
| 11289 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
|
11290 ttyin input is a terminal (tty) |
|
65e0537a4560
commit https://github.com/vim/vim/commit/2cab0e191055a8145ccd46cd52869fbb9798b971
Christian Brabandt <cb@256bit.org>
parents:
10348
diff
changeset
|
11291 ttyout output is a terminal (tty) |
| 12499 | 11292 unix Unix version of Vim. *+unix* |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
11293 unnamedplus Compiled with support for "unnamedplus" in 'clipboard' |
|
16411
5b5c5daf57de
patch 8.1.1210: support for user commands is spread out
Bram Moolenaar <Bram@vim.org>
parents:
16380
diff
changeset
|
11294 user_commands User-defined commands. (always true) |
| 18790 | 11295 vartabs Compiled with variable tabstop support |'vartabstop'|. |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13329
diff
changeset
|
11296 vcon Win32: Virtual console support is working, can use |
|
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13329
diff
changeset
|
11297 'termguicolors'. Also see |+vtp|. |
| 2681 | 11298 vertsplit Compiled with vertically split windows |:vsplit|. |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11299 (always true) |
| 2581 | 11300 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
|
11301 *vim_starting* |
| 2681 | 11302 viminfo Compiled with viminfo support. |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
11303 vimscript-1 Compiled Vim script version 1 support |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
11304 vimscript-2 Compiled Vim script version 2 support |
| 16380 | 11305 vimscript-3 Compiled Vim script version 3 support |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11306 virtualedit Compiled with 'virtualedit' option. (always true) |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
11307 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
|
11308 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
|
11309 true) |blockwise-operators|. |
| 7 | 11310 vms VMS version of Vim. |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11311 vreplace Compiled with |gR| and |gr| commands. (always true) |
|
13482
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13438
diff
changeset
|
11312 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
|
11313 out if it works in the current console). |
| 7 | 11314 wildignore Compiled with 'wildignore' option. |
| 11315 wildmenu Compiled with 'wildmenu' option. | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11316 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
|
11317 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
|
11318 64 bits) |
| 2681 | 11319 win32unix Win32 version of Vim, using Unix files (Cygwin) |
| 7 | 11320 win64 Win64 version of Vim (MS-Windows 64 bit). |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11321 win95 Win32 version for MS-Windows 95/98/ME (always false) |
| 2681 | 11322 winaltkeys Compiled with 'winaltkeys' option. |
| 11323 windows Compiled with support for more than one window. | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11324 (always true) |
| 7 | 11325 writebackup Compiled with 'writebackup' default on. |
| 11326 xfontset Compiled with X fontset support |xfontset|. | |
| 11327 xim Compiled with X input method support |xim|. | |
| 5340 | 11328 xpm Compiled with pixmap support. |
| 11329 xpm_w32 Compiled with pixmap support for Win32. (Only for | |
| 11330 backward compatibility. Use "xpm" instead.) | |
| 7 | 11331 xsmp Compiled with X session management support. |
| 11332 xsmp_interact Compiled with interactive X session management support. | |
| 11333 xterm_clipboard Compiled with support for xterm clipboard. | |
| 11334 xterm_save Compiled with support for saving and restoring the | |
| 11335 xterm screen. | |
| 11336 x11 Compiled with X11 support. | |
| 11337 | |
| 11338 *string-match* | |
| 11339 Matching a pattern in a String | |
| 11340 | |
| 11341 A regexp pattern as explained at |pattern| is normally used to find a match in | |
| 11342 the buffer lines. When a pattern is used to find a match in a String, almost | |
| 11343 everything works in the same way. The difference is that a String is handled | |
| 11344 like it is one line. When it contains a "\n" character, this is not seen as a | |
| 11345 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
| 11346 with ".". Example: > | |
| 11347 :let a = "aaaa\nxxxx" | |
| 11348 :echo matchstr(a, "..\n..") | |
| 11349 aa | |
| 11350 xx | |
| 11351 :echo matchstr(a, "a.x") | |
| 11352 a | |
| 11353 x | |
| 11354 | |
| 11355 Don't forget that "^" will only match at the first character of the String and | |
| 11356 "$" at the last character of the string. They don't match after or before a | |
| 11357 "\n". | |
| 11358 | |
| 11359 ============================================================================== | |
| 11360 5. Defining functions *user-functions* | |
| 11361 | |
| 11362 New functions can be defined. These can be called just like builtin | |
| 11363 functions. The function executes a sequence of Ex commands. Normal mode | |
| 11364 commands can be executed with the |:normal| command. | |
| 11365 | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
11366 This section is about the legacy functions. For the Vim9 functions, which |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
11367 execute much faster, support type checking and more, see |vim9.txt|. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
11368 |
| 7 | 11369 The function name must start with an uppercase letter, to avoid confusion with |
| 11370 builtin functions. To prevent from using the same name in different scripts | |
| 11371 avoid obvious, short names. A good habit is to start the function name with | |
| 11372 the name of the script, e.g., "HTMLcolor()". | |
| 11373 | |
| 504 | 11374 It's also possible to use curly braces, see |curly-braces-names|. And the |
| 11375 |autoload| facility is useful to define a function only when it's called. | |
| 7 | 11376 |
| 11377 *local-function* | |
| 11378 A function local to a script must start with "s:". A local script function | |
| 11379 can only be called from within the script and from functions, user commands | |
| 11380 and autocommands defined in the script. It is also possible to call the | |
| 1698 | 11381 function from a mapping defined in the script, but then |<SID>| must be used |
| 7 | 11382 instead of "s:" when the mapping is expanded outside of the script. |
| 5862 | 11383 There are only script-local functions, no buffer-local or window-local |
| 11384 functions. | |
| 7 | 11385 |
| 11386 *:fu* *:function* *E128* *E129* *E123* | |
| 11387 :fu[nction] List all functions and their arguments. | |
| 11388 | |
| 11389 :fu[nction] {name} List function {name}. | |
| 685 | 11390 {name} can also be a |Dictionary| entry that is a |
| 11391 |Funcref|: > | |
| 114 | 11392 :function dict.init |
| 504 | 11393 |
| 11394 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
| 11395 Example that lists all functions ending with "File": > | |
| 11396 :function /File$ | |
| 482 | 11397 < |
| 11398 *:function-verbose* | |
| 11399 When 'verbose' is non-zero, listing a function will also display where it was | |
| 11400 last defined. Example: > | |
| 11401 | |
| 11402 :verbose function SetFileTypeSH | |
| 11403 function SetFileTypeSH(name) | |
| 11404 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
| 11405 < | |
| 484 | 11406 See |:verbose-cmd| for more information. |
| 482 | 11407 |
| 5862 | 11408 *E124* *E125* *E853* *E884* |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11409 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] [closure] |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
11410 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
|
11411 the function follows in the next lines, until the |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
11412 matching |:endfunction|. |
| 12785 | 11413 |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
11414 The name must be made of alphanumeric characters and |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
11415 '_', and must start with a capital or "s:" (see |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
11416 above). Note that using "b:" or "g:" is not allowed. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
11417 (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
|
11418 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
|
11419 Before that patch no error was given). |
| 114 | 11420 |
| 685 | 11421 {name} can also be a |Dictionary| entry that is a |
| 11422 |Funcref|: > | |
| 114 | 11423 :function dict.init(arg) |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
11424 < "dict" must be an existing dictionary. The entry |
| 114 | 11425 "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
|
11426 is required to overwrite an existing function. The |
| 114 | 11427 result is a |Funcref| to a numbered function. The |
| 11428 function can only be used with a |Funcref| and will be | |
| 11429 deleted if there are no more references to it. | |
| 7 | 11430 *E127* *E122* |
| 11431 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
|
11432 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
|
11433 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
|
11434 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
|
11435 silently replaced. |
|
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
11436 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
|
11437 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
|
11438 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
|
11439 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
|
11440 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
|
11441 which is hard to debug. |
| 20552 | 11442 NOTE: In Vim9 script script-local functions cannot be |
| 11443 deleted or redefined. | |
| 133 | 11444 |
| 11445 For the {arguments} see |function-argument|. | |
| 11446 | |
| 5618 | 11447 *:func-range* *a:firstline* *a:lastline* |
| 7 | 11448 When the [range] argument is added, the function is |
| 11449 expected to take care of a range itself. The range is | |
| 11450 passed as "a:firstline" and "a:lastline". If [range] | |
| 11451 is excluded, ":{range}call" will call the function for | |
| 11452 each line in the range, with the cursor on the start | |
| 11453 of each line. See |function-range-example|. | |
| 3967 | 11454 The cursor is still moved to the first line of the |
| 11455 range, as is the case with all Ex commands. | |
| 5618 | 11456 *:func-abort* |
| 7 | 11457 When the [abort] argument is added, the function will |
| 11458 abort as soon as an error is detected. | |
| 5618 | 11459 *:func-dict* |
| 102 | 11460 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
|
11461 be invoked through an entry in a |Dictionary|. The |
| 102 | 11462 local variable "self" will then be set to the |
| 11463 dictionary. See |Dictionary-function|. | |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11464 *:func-closure* *E932* |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11465 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
|
11466 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
|
11467 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
|
11468 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
|
11469 remains referenced even after Foo() returns: > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11470 :function! Foo() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11471 : let x = 0 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11472 : function! Bar() closure |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11473 : let x += 1 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11474 : return x |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11475 : endfunction |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
11476 : return funcref('Bar') |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11477 :endfunction |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11478 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11479 :let F = Foo() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11480 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11481 < 1 > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11482 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11483 < 2 > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11484 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
11485 < 3 |
| 7 | 11486 |
| 1621 | 11487 *function-search-undo* |
| 653 | 11488 The last used search pattern and the redo command "." |
| 1621 | 11489 will not be changed by the function. This also |
| 11490 implies that the effect of |:nohlsearch| is undone | |
| 11491 when the function returns. | |
| 653 | 11492 |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
11493 *: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
|
11494 :endf[unction] [argument] |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
11495 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
|
11496 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
|
11497 |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
11498 [argument] can be: |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
11499 | 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
|
11500 \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
|
11501 " 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
|
11502 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
|
11503 '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
|
11504 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
|
11505 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
|
11506 ignored. |
| 7 | 11507 |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
11508 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
|
11509 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
|
11510 :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
|
11511 < |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
11512 *: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
|
11513 :delf[unction][!] {name} |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
11514 Delete function {name}. |
| 685 | 11515 {name} can also be a |Dictionary| entry that is a |
| 11516 |Funcref|: > | |
| 114 | 11517 :delfunc dict.init |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
11518 < This will remove the "init" entry from "dict". The |
| 114 | 11519 function is deleted if there are no more references to |
| 11520 it. | |
|
11543
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
11521 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
|
11522 exist. |
| 7 | 11523 *:retu* *:return* *E133* |
| 11524 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
| 11525 evaluated and returned as the result of the function. | |
| 11526 If "[expr]" is not given, the number 0 is returned. | |
| 11527 When a function ends without an explicit ":return", | |
| 11528 the number 0 is returned. | |
| 11529 Note that there is no check for unreachable lines, | |
| 11530 thus there is no warning if commands follow ":return". | |
| 11531 | |
| 11532 If the ":return" is used after a |:try| but before the | |
| 11533 matching |:finally| (if present), the commands | |
| 11534 following the ":finally" up to the matching |:endtry| | |
| 11535 are executed first. This process applies to all | |
| 11536 nested ":try"s inside the function. The function | |
| 11537 returns at the outermost ":endtry". | |
| 11538 | |
| 133 | 11539 *function-argument* *a:var* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
11540 An argument can be defined by giving its name. In the function this can then |
| 133 | 11541 be used as "a:name" ("a:" for argument). |
| 1156 | 11542 *a:0* *a:1* *a:000* *E740* *...* |
| 133 | 11543 Up to 20 arguments can be given, separated by commas. After the named |
| 11544 arguments an argument "..." can be specified, which means that more arguments | |
| 11545 may optionally be following. In the function the extra arguments can be used | |
| 11546 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
| 685 | 11547 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
| 11548 that "a:1" is the same as "a:000[0]". | |
| 148 | 11549 *E742* |
| 11550 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
|
11551 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
|
11552 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
|
11553 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
|
11554 change a |List| or |Dictionary| use |:lockvar|. |
| 133 | 11555 |
| 11556 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
|
11557 still supply the () then. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
11558 |
|
13482
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13438
diff
changeset
|
11559 It is allowed to define another function inside a function body. |
| 133 | 11560 |
|
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11561 *optional-function-argument* |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11562 You can provide default values for positional named arguments. This makes |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11563 them optional for function calls. When a positional argument is not |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11564 specified at a call, the default expression is used to initialize it. |
| 19968 | 11565 This only works for functions declared with `:function` or `:def`, not for |
| 11566 lambda expressions |expr-lambda|. | |
|
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11567 |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11568 Example: > |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11569 function Something(key, value = 10) |
|
16648
a7f06505ad39
patch 8.1.1326: no test for listener with partial
Bram Moolenaar <Bram@vim.org>
parents:
16638
diff
changeset
|
11570 echo a:key .. ": " .. a:value |
|
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11571 endfunction |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11572 call Something('empty') "empty: 10" |
|
16648
a7f06505ad39
patch 8.1.1326: no test for listener with partial
Bram Moolenaar <Bram@vim.org>
parents:
16638
diff
changeset
|
11573 call Something('key', 20) "key: 20" |
|
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11574 |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11575 The argument default expressions are evaluated at the time of the function |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11576 call, not definition. Thus it is possible to use an expression which is |
| 16808 | 11577 invalid the moment the function is defined. The expressions are also only |
|
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11578 evaluated when arguments are not specified during a call. |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11579 |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11580 You can pass |v:none| to use the default expression. Note that this means you |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11581 cannot pass v:none as an ordinary value when an argument has a default |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11582 expression. |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11583 |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11584 Example: > |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11585 function Something(a = 10, b = 20, c = 30) |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11586 endfunction |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11587 call Something(1, v:none, 3) " b = 20 |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11588 < |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11589 *E989* |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11590 Optional arguments with default expressions must occur after any mandatory |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11591 arguments. You can use "..." after all optional named arguments. |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11592 |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11593 It is possible for later argument defaults to refer to prior arguments, |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11594 but not the other way around. They must be prefixed with "a:", as with all |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11595 arguments. |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11596 |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11597 Example that works: > |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11598 :function Okay(mandatory, optional = a:mandatory) |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11599 :endfunction |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11600 Example that does NOT work: > |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11601 :function NoGood(first = a:second, second = 10) |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11602 :endfunction |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11603 < |
| 19968 | 11604 When not using "...", the number of arguments in a function call must be at |
| 11605 least equal to the number of mandatory named arguments. When using "...", the | |
| 11606 number of arguments may be larger than the total of mandatory and optional | |
| 11607 arguments. | |
|
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
11608 |
| 133 | 11609 *local-variables* |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
11610 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
|
11611 function returns. Global variables need to be accessed with "g:". |
| 7 | 11612 |
| 11613 Example: > | |
| 11614 :function Table(title, ...) | |
| 11615 : echohl Title | |
| 11616 : echo a:title | |
| 11617 : echohl None | |
| 140 | 11618 : echo a:0 . " items:" |
| 11619 : for s in a:000 | |
| 11620 : echon ' ' . s | |
| 11621 : endfor | |
| 7 | 11622 :endfunction |
| 11623 | |
| 11624 This function can then be called with: > | |
| 140 | 11625 call Table("Table", "line1", "line2") |
| 11626 call Table("Empty Table") | |
| 7 | 11627 |
| 1156 | 11628 To return more than one value, return a |List|: > |
| 11629 :function Compute(n1, n2) | |
| 7 | 11630 : if a:n2 == 0 |
| 1156 | 11631 : return ["fail", 0] |
| 7 | 11632 : endif |
| 1156 | 11633 : return ["ok", a:n1 / a:n2] |
| 7 | 11634 :endfunction |
| 11635 | |
| 11636 This function can then be called with: > | |
| 1156 | 11637 :let [success, div] = Compute(102, 6) |
| 7 | 11638 :if success == "ok" |
| 11639 : echo div | |
| 11640 :endif | |
| 1156 | 11641 < |
| 786 | 11642 *:cal* *:call* *E107* *E117* |
| 7 | 11643 :[range]cal[l] {name}([arguments]) |
| 11644 Call a function. The name of the function and its arguments | |
| 16808 | 11645 are as specified with `:function`. Up to 20 arguments can be |
| 1156 | 11646 used. The returned value is discarded. |
| 7 | 11647 Without a range and for functions that accept a range, the |
| 11648 function is called once. When a range is given the cursor is | |
| 11649 positioned at the start of the first line before executing the | |
| 11650 function. | |
| 11651 When a range is given and the function doesn't handle it | |
| 11652 itself, the function is executed for each line in the range, | |
| 11653 with the cursor in the first column of that line. The cursor | |
| 11654 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
|
11655 call). The arguments are re-evaluated for each line. Thus |
| 7 | 11656 this works: |
| 11657 *function-range-example* > | |
| 11658 :function Mynumber(arg) | |
| 11659 : echo line(".") . " " . a:arg | |
| 11660 :endfunction | |
| 11661 :1,5call Mynumber(getline(".")) | |
| 11662 < | |
| 11663 The "a:firstline" and "a:lastline" are defined anyway, they | |
| 11664 can be used to do something different at the start or end of | |
| 11665 the range. | |
| 11666 | |
| 11667 Example of a function that handles the range itself: > | |
| 11668 | |
| 11669 :function Cont() range | |
| 11670 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
| 11671 :endfunction | |
| 11672 :4,8call Cont() | |
| 11673 < | |
| 11674 This function inserts the continuation character "\" in front | |
| 11675 of all the lines in the range, except the first one. | |
| 11676 | |
| 1156 | 11677 When the function returns a composite value it can be further |
| 11678 dereferenced, but the range will not be used then. Example: > | |
| 11679 :4,8call GetDict().method() | |
| 11680 < Here GetDict() gets the range but method() does not. | |
| 11681 | |
| 7 | 11682 *E132* |
| 11683 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
| 11684 option. | |
| 11685 | |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
11686 It is also possible to use `:eval`. It does not support a range, but does |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
11687 allow for method chaining, e.g.: > |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
11688 eval GetList()->Filter()->append('$') |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
11689 |
| 17667 | 11690 A function can also be called as part of evaluating an expression or when it |
| 11691 is used as a method: > | |
| 11692 let x = GetList() | |
| 11693 let y = GetList()->Filter() | |
| 11694 | |
| 161 | 11695 |
| 11696 AUTOMATICALLY LOADING FUNCTIONS ~ | |
| 7 | 11697 *autoload-functions* |
| 11698 When using many or large functions, it's possible to automatically define them | |
| 161 | 11699 only when they are used. There are two methods: with an autocommand and with |
| 11700 the "autoload" directory in 'runtimepath'. | |
| 11701 | |
| 11702 | |
| 11703 Using an autocommand ~ | |
| 11704 | |
| 170 | 11705 This is introduced in the user manual, section |41.14|. |
| 11706 | |
| 161 | 11707 The autocommand is useful if you have a plugin that is a long Vim script file. |
| 16808 | 11708 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
|
11709 That makes Vim startup faster. The autocommand should then load the same file |
| 16808 | 11710 again, setting a variable to skip the `:finish` command. |
| 161 | 11711 |
| 11712 Use the FuncUndefined autocommand event with a pattern that matches the | |
| 11713 function(s) to be defined. Example: > | |
| 7 | 11714 |
| 11715 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
| 11716 | |
| 11717 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
| 11718 "BufNet". Also see |FuncUndefined|. | |
| 11719 | |
| 161 | 11720 |
| 11721 Using an autoload script ~ | |
| 168 | 11722 *autoload* *E746* |
| 170 | 11723 This is introduced in the user manual, section |41.15|. |
| 11724 | |
| 161 | 11725 Using a script in the "autoload" directory is simpler, but requires using |
| 11726 exactly the right file name. A function that can be autoloaded has a name | |
| 11727 like this: > | |
| 11728 | |
| 270 | 11729 :call filename#funcname() |
| 161 | 11730 |
| 11731 When such a function is called, and it is not defined yet, Vim will search the | |
| 11732 "autoload" directories in 'runtimepath' for a script file called | |
| 11733 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
| 11734 then define the function like this: > | |
| 11735 | |
| 270 | 11736 function filename#funcname() |
| 161 | 11737 echo "Done!" |
| 11738 endfunction | |
| 11739 | |
| 530 | 11740 The file name and the name used before the # in the function must match |
| 161 | 11741 exactly, and the defined function must have the name exactly as it will be |
| 11742 called. | |
| 11743 | |
| 270 | 11744 It is possible to use subdirectories. Every # in the function name works like |
| 11745 a path separator. Thus when calling a function: > | |
| 11746 | |
| 11747 :call foo#bar#func() | |
| 161 | 11748 |
| 11749 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
| 11750 | |
| 168 | 11751 This also works when reading a variable that has not been set yet: > |
| 11752 | |
| 270 | 11753 :let l = foo#bar#lvar |
| 168 | 11754 |
| 557 | 11755 However, when the autoload script was already loaded it won't be loaded again |
| 11756 for an unknown variable. | |
| 11757 | |
| 168 | 11758 When assigning a value to such a variable nothing special happens. This can |
| 11759 be used to pass settings to the autoload script before it's loaded: > | |
| 11760 | |
| 270 | 11761 :let foo#bar#toggle = 1 |
| 11762 :call foo#bar#func() | |
| 168 | 11763 |
| 164 | 11764 Note that when you make a mistake and call a function that is supposed to be |
| 11765 defined in an autoload script, but the script doesn't actually define the | |
| 11766 function, the script will be sourced every time you try to call the function. | |
| 168 | 11767 And you will get an error message every time. |
| 11768 | |
| 11769 Also note that if you have two script files, and one calls a function in the | |
| 1621 | 11770 other and vice versa, before the used function is defined, it won't work. |
| 168 | 11771 Avoid using the autoload functionality at the toplevel. |
| 161 | 11772 |
| 794 | 11773 Hint: If you distribute a bunch of scripts you can pack them together with the |
| 11774 |vimball| utility. Also read the user manual |distribute-script|. | |
| 11775 | |
| 7 | 11776 ============================================================================== |
| 11777 6. Curly braces names *curly-braces-names* | |
| 11778 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
11779 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
|
11780 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
|
11781 wrapped in braces {} like this: > |
| 7 | 11782 my_{adjective}_variable |
| 11783 | |
| 11784 When Vim encounters this, it evaluates the expression inside the braces, puts | |
| 11785 that in place of the expression, and re-interprets the whole as a variable | |
| 11786 name. So in the above example, if the variable "adjective" was set to | |
| 11787 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
| 11788 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
| 11789 | |
| 11790 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
|
11791 value. For example, the statement > |
| 7 | 11792 echo my_{&background}_message |
| 11793 | |
| 11794 would output the contents of "my_dark_message" or "my_light_message" depending | |
| 11795 on the current value of 'background'. | |
| 11796 | |
| 11797 You can use multiple brace pairs: > | |
| 11798 echo my_{adverb}_{adjective}_message | |
| 11799 ..or even nest them: > | |
| 11800 echo my_{ad{end_of_word}}_message | |
| 11801 where "end_of_word" is either "verb" or "jective". | |
| 11802 | |
| 11803 However, the expression inside the braces must evaluate to a valid single | |
| 236 | 11804 variable name, e.g. this is invalid: > |
| 7 | 11805 :let foo='a + b' |
| 11806 :echo c{foo}d | |
| 11807 .. since the result of expansion is "ca + bd", which is not a variable name. | |
| 11808 | |
| 11809 *curly-braces-function-names* | |
| 11810 You can call and define functions by an evaluated name in a similar way. | |
| 11811 Example: > | |
| 11812 :let func_end='whizz' | |
| 11813 :call my_func_{func_end}(parameter) | |
| 11814 | |
| 11815 This would call the function "my_func_whizz(parameter)". | |
| 11816 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
11817 This does NOT work: > |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
11818 :let i = 3 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
11819 :let @{i} = '' " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
11820 :echo @{i} " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
11821 |
| 7 | 11822 ============================================================================== |
| 11823 7. Commands *expression-commands* | |
| 11824 | |
| 11825 :let {var-name} = {expr1} *:let* *E18* | |
| 11826 Set internal variable {var-name} to the result of the | |
| 11827 expression {expr1}. The variable will get the type | |
| 11828 from the {expr}. If {var-name} didn't exist yet, it | |
| 11829 is created. | |
| 11830 | |
| 85 | 11831 :let {var-name}[{idx}] = {expr1} *E689* |
| 11832 Set a list item to the result of the expression | |
| 11833 {expr1}. {var-name} must refer to a list and {idx} | |
| 11834 must be a valid index in that list. For nested list | |
| 11835 the index can be repeated. | |
| 1621 | 11836 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
|
11837 This cannot be used to set a byte in a String. You |
| 1621 | 11838 can do that like this: > |
| 11839 :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
|
11840 < 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
|
11841 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
|
11842 appended. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
11843 |
| 114 | 11844 *E711* *E719* |
| 11845 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
| 685 | 11846 Set a sequence of items in a |List| to the result of |
| 11847 the expression {expr1}, which must be a list with the | |
| 87 | 11848 correct number of items. |
| 11849 {idx1} can be omitted, zero is used instead. | |
| 11850 {idx2} can be omitted, meaning the end of the list. | |
| 11851 When the selected range of items is partly past the | |
| 11852 end of the list, items will be added. | |
| 11853 | |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
11854 *:let+=* *:let-=* *:letstar=* |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
11855 *:let/=* *:let%=* *:let.=* *:let..=* *E734* *E985* |
| 114 | 11856 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
| 11857 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
|
15790
05d836c8f1c4
patch 8.1.0902: incomplete set of assignment operators
Bram Moolenaar <Bram@vim.org>
parents:
15774
diff
changeset
|
11858 :let {var} *= {expr1} Like ":let {var} = {var} * {expr1}". |
|
05d836c8f1c4
patch 8.1.0902: incomplete set of assignment operators
Bram Moolenaar <Bram@vim.org>
parents:
15774
diff
changeset
|
11859 :let {var} /= {expr1} Like ":let {var} = {var} / {expr1}". |
|
05d836c8f1c4
patch 8.1.0902: incomplete set of assignment operators
Bram Moolenaar <Bram@vim.org>
parents:
15774
diff
changeset
|
11860 :let {var} %= {expr1} Like ":let {var} = {var} % {expr1}". |
| 114 | 11861 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
11862 :let {var} ..= {expr1} Like ":let {var} = {var} .. {expr1}". |
| 114 | 11863 These fail if {var} was not set yet and when the type |
| 11864 of {var} and {expr1} don't fit the operator. | |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
11865 `.=` is not supported with Vim script version 2 and |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
11866 later, see |vimscript-version|. |
| 114 | 11867 |
| 11868 | |
| 7 | 11869 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
| 11870 Set environment variable {env-name} to the result of | |
| 11871 the expression {expr1}. The type is always String. | |
| 17758 | 11872 |
| 11873 On some systems making an environment variable empty | |
| 11874 causes it to be deleted. Many systems do not make a | |
| 11875 difference between an environment variable that is not | |
| 11876 set and an environment variable that is empty. | |
| 11877 | |
| 114 | 11878 :let ${env-name} .= {expr1} |
| 11879 Append {expr1} to the environment variable {env-name}. | |
| 11880 If the environment variable didn't exist yet this | |
| 11881 works like "=". | |
| 7 | 11882 |
| 11883 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
| 11884 Write the result of the expression {expr1} in register | |
| 11885 {reg-name}. {reg-name} must be a single letter, and | |
| 11886 must be the name of a writable register (see | |
| 11887 |registers|). "@@" can be used for the unnamed | |
| 11888 register, "@/" for the search pattern. | |
| 11889 If the result of {expr1} ends in a <CR> or <NL>, the | |
| 11890 register will be linewise, otherwise it will be set to | |
| 11891 characterwise. | |
| 11892 This can be used to clear the last search pattern: > | |
| 11893 :let @/ = "" | |
| 11894 < This is different from searching for an empty string, | |
| 11895 that would match everywhere. | |
| 11896 | |
| 114 | 11897 :let @{reg-name} .= {expr1} |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
11898 Append {expr1} to register {reg-name}. If the |
| 114 | 11899 register was empty it's like setting it to {expr1}. |
| 11900 | |
| 1156 | 11901 :let &{option-name} = {expr1} *:let-option* *:let-&* |
| 7 | 11902 Set option {option-name} to the result of the |
| 68 | 11903 expression {expr1}. A String or Number value is |
| 11904 always converted to the type of the option. | |
| 7 | 11905 For an option local to a window or buffer the effect |
| 11906 is just like using the |:set| command: both the local | |
| 555 | 11907 value and the global value are changed. |
| 68 | 11908 Example: > |
| 11909 :let &path = &path . ',/usr/local/include' | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
11910 < This also works for terminal codes in the form t_xx. |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
11911 But only for alphanumerical names. Example: > |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
11912 :let &t_k1 = "\<Esc>[234;" |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
11913 < 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
|
11914 a terminal key code, there is no error. |
| 7 | 11915 |
| 114 | 11916 :let &{option-name} .= {expr1} |
| 11917 For a string option: Append {expr1} to the value. | |
| 11918 Does not insert a comma like |:set+=|. | |
| 11919 | |
| 11920 :let &{option-name} += {expr1} | |
| 11921 :let &{option-name} -= {expr1} | |
| 11922 For a number or boolean option: Add or subtract | |
| 11923 {expr1}. | |
| 11924 | |
| 7 | 11925 :let &l:{option-name} = {expr1} |
| 114 | 11926 :let &l:{option-name} .= {expr1} |
| 11927 :let &l:{option-name} += {expr1} | |
| 11928 :let &l:{option-name} -= {expr1} | |
| 7 | 11929 Like above, but only set the local value of an option |
| 11930 (if there is one). Works like |:setlocal|. | |
| 11931 | |
| 11932 :let &g:{option-name} = {expr1} | |
| 114 | 11933 :let &g:{option-name} .= {expr1} |
| 11934 :let &g:{option-name} += {expr1} | |
| 11935 :let &g:{option-name} -= {expr1} | |
| 7 | 11936 Like above, but only set the global value of an option |
| 11937 (if there is one). Works like |:setglobal|. | |
| 11938 | |
| 85 | 11939 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
| 685 | 11940 {expr1} must evaluate to a |List|. The first item in |
| 68 | 11941 the list is assigned to {name1}, the second item to |
| 11942 {name2}, etc. | |
| 11943 The number of names must match the number of items in | |
| 685 | 11944 the |List|. |
| 68 | 11945 Each name can be one of the items of the ":let" |
| 11946 command as mentioned above. | |
| 11947 Example: > | |
| 11948 :let [s, item] = GetItem(s) | |
| 114 | 11949 < Detail: {expr1} is evaluated first, then the |
| 11950 assignments are done in sequence. This matters if | |
| 11951 {name2} depends on {name1}. Example: > | |
| 11952 :let x = [0, 1] | |
| 11953 :let i = 0 | |
| 11954 :let [i, x[i]] = [1, 2] | |
| 11955 :echo x | |
| 11956 < The result is [0, 2]. | |
| 11957 | |
| 11958 :let [{name1}, {name2}, ...] .= {expr1} | |
| 11959 :let [{name1}, {name2}, ...] += {expr1} | |
| 11960 :let [{name1}, {name2}, ...] -= {expr1} | |
| 11961 Like above, but append/add/subtract the value for each | |
| 685 | 11962 |List| item. |
| 68 | 11963 |
| 19968 | 11964 :let [{name}, ..., ; {lastname}] = {expr1} *E452* |
| 685 | 11965 Like |:let-unpack| above, but the |List| may have more |
| 114 | 11966 items than there are names. A list of the remaining |
| 11967 items is assigned to {lastname}. If there are no | |
| 11968 remaining items {lastname} is set to an empty list. | |
| 68 | 11969 Example: > |
| 11970 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
| 11971 < | |
| 114 | 11972 :let [{name}, ..., ; {lastname}] .= {expr1} |
| 11973 :let [{name}, ..., ; {lastname}] += {expr1} | |
| 11974 :let [{name}, ..., ; {lastname}] -= {expr1} | |
| 11975 Like above, but append/add/subtract the value for each | |
| 685 | 11976 |List| item. |
| 2596 | 11977 |
|
17450
509542f1fffb
patch 8.1.1723: heredoc assignment has no room for new features
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
11978 *:let=<<* *:let-heredoc* |
|
509542f1fffb
patch 8.1.1723: heredoc assignment has no room for new features
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
11979 *E990* *E991* *E172* *E221* |
| 18343 | 11980 :let {var-name} =<< [trim] {endmarker} |
|
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
11981 text... |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
11982 text... |
| 18343 | 11983 {endmarker} |
|
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
11984 Set internal variable {var-name} to a List containing |
| 18343 | 11985 the lines of text bounded by the string {endmarker}. |
| 11986 {endmarker} must not contain white space. | |
| 11987 {endmarker} cannot start with a lower case character. | |
| 11988 The last line should end only with the {endmarker} | |
| 11989 string without any other character. Watch out for | |
| 11990 white space after {endmarker}! | |
|
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
11991 |
|
17172
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
11992 Without "trim" any white space characters in the lines |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
11993 of text are preserved. If "trim" is specified before |
| 18343 | 11994 {endmarker}, then indentation is stripped so you can |
| 11995 do: > | |
|
17172
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
11996 let text =<< trim END |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
11997 if ok |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
11998 echo 'done' |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
11999 endif |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12000 END |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12001 < Results in: ["if ok", " echo 'done'", "endif"] |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12002 The marker must line up with "let" and the indentation |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12003 of the first line is removed from all the text lines. |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12004 Specifically: all the leading indentation exactly |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12005 matching the leading indentation of the first |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12006 non-empty text line is stripped from the input lines. |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12007 All leading indentation exactly matching the leading |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12008 indentation before `let` is stripped from the line |
| 18343 | 12009 containing {endmarker}. Note that the difference |
| 12010 between space and tab matters here. | |
|
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12011 |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12012 If {var-name} didn't exist yet, it is created. |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12013 Cannot be followed by another command, but can be |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12014 followed by a comment. |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12015 |
| 18343 | 12016 To avoid line continuation to be applied, consider |
| 12017 adding 'C' to 'cpoptions': > | |
| 12018 set cpo+=C | |
| 12019 let var =<< END | |
| 12020 \ leading backslash | |
| 12021 END | |
| 12022 set cpo-=C | |
| 12023 < | |
|
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12024 Examples: > |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12025 let var1 =<< END |
| 18343 | 12026 Sample text 1 |
| 12027 Sample text 2 | |
| 12028 Sample text 3 | |
| 12029 END | |
|
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12030 |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12031 let data =<< trim DATA |
| 18343 | 12032 1 2 3 4 |
| 12033 5 6 7 8 | |
|
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12034 DATA |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12035 < |
| 2596 | 12036 *E121* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
12037 :let {var-name} .. List the value of variable {var-name}. Multiple |
| 123 | 12038 variable names may be given. Special names recognized |
| 12039 here: *E738* | |
| 777 | 12040 g: global variables |
| 12041 b: local buffer variables | |
| 12042 w: local window variables | |
| 819 | 12043 t: local tab page variables |
| 777 | 12044 s: script-local variables |
| 12045 l: local function variables | |
| 123 | 12046 v: Vim variables. |
| 7 | 12047 |
| 55 | 12048 :let List the values of all variables. The type of the |
| 12049 variable is indicated before the value: | |
| 12050 <nothing> String | |
| 12051 # Number | |
| 856 | 12052 * Funcref |
| 7 | 12053 |
| 1156 | 12054 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
| 148 | 12055 Remove the internal variable {name}. Several variable |
| 12056 names can be given, they are all removed. The name | |
| 685 | 12057 may also be a |List| or |Dictionary| item. |
| 7 | 12058 With [!] no error message is given for non-existing |
| 12059 variables. | |
| 685 | 12060 One or more items from a |List| can be removed: > |
| 108 | 12061 :unlet list[3] " remove fourth item |
| 12062 :unlet list[3:] " remove fourth item to last | |
| 685 | 12063 < One item from a |Dictionary| can be removed at a time: > |
| 108 | 12064 :unlet dict['two'] |
| 12065 :unlet dict.two | |
| 1668 | 12066 < This is especially useful to clean up used global |
| 12067 variables and script-local variables (these are not | |
| 12068 deleted when the script ends). Function-local | |
| 12069 variables are automatically deleted when the function | |
| 12070 ends. | |
| 7 | 12071 |
|
13923
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
12072 :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
|
12073 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
|
12074 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
|
12075 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
|
12076 variable, also without !. |
|
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
12077 If the system does not support deleting an environment |
|
17079
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12078 variable, it is made empty. |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12079 |
|
17109
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
12080 *:cons* *:const* |
|
17079
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12081 :cons[t] {var-name} = {expr1} |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12082 :cons[t] [{name1}, {name2}, ...] = {expr1} |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12083 :cons[t] [{name}, ..., ; {lastname}] = {expr1} |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12084 :cons[t] {var-name} =<< [trim] {marker} |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12085 text... |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12086 text... |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12087 {marker} |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12088 Similar to |:let|, but additionally lock the variable |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12089 after setting the value. This is the same as locking |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12090 the variable with |:lockvar| just after |:let|, thus: > |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12091 :const x = 1 |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12092 < is equivalent to: > |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12093 :let x = 1 |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12094 :lockvar 1 x |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12095 < This is useful if you want to make sure the variable |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12096 is not modified. |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12097 *E995* |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
12098 |:const| does not allow to for changing a variable: > |
|
17079
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12099 :let x = 1 |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12100 :const x = 2 " Error! |
|
17109
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
12101 < *E996* |
|
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
12102 Note that environment variables, option values and |
|
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
12103 register values cannot be used here, since they cannot |
|
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
12104 be locked. |
|
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
12105 |
| 17433 | 12106 :cons[t] |
| 12107 :cons[t] {var-name} | |
| 12108 If no argument is given or only {var-name} is given, | |
| 12109 the behavior is the same as |:let|. | |
| 12110 | |
| 148 | 12111 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
| 12112 Lock the internal variable {name}. Locking means that | |
| 12113 it can no longer be changed (until it is unlocked). | |
| 12114 A locked variable can be deleted: > | |
| 12115 :lockvar v | |
| 12116 :let v = 'asdf' " fails! | |
| 12117 :unlet v | |
|
10908
6b6abffbdf59
patch 8.0.0343: b:changedtick can be unlocked
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
12118 < *E741* *E940* |
| 148 | 12119 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
|
12120 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
|
12121 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
|
12122 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
|
12123 variable {name}". |
| 148 | 12124 |
| 685 | 12125 [depth] is relevant when locking a |List| or |
| 12126 |Dictionary|. It specifies how deep the locking goes: | |
| 12127 1 Lock the |List| or |Dictionary| itself, | |
| 148 | 12128 cannot add or remove items, but can |
| 12129 still change their values. | |
| 12130 2 Also lock the values, cannot change | |
| 685 | 12131 the items. If an item is a |List| or |
| 12132 |Dictionary|, cannot add or remove | |
| 148 | 12133 items, but can still change the |
| 12134 values. | |
| 685 | 12135 3 Like 2 but for the |List| / |
| 12136 |Dictionary| in the |List| / | |
| 12137 |Dictionary|, one level deeper. | |
| 12138 The default [depth] is 2, thus when {name} is a |List| | |
| 12139 or |Dictionary| the values cannot be changed. | |
| 148 | 12140 *E743* |
| 12141 For unlimited depth use [!] and omit [depth]. | |
| 12142 However, there is a maximum depth of 100 to catch | |
| 12143 loops. | |
| 12144 | |
| 685 | 12145 Note that when two variables refer to the same |List| |
| 12146 and you lock one of them, the |List| will also be | |
| 819 | 12147 locked when used through the other variable. |
| 12148 Example: > | |
| 148 | 12149 :let l = [0, 1, 2, 3] |
| 12150 :let cl = l | |
| 12151 :lockvar l | |
| 12152 :let cl[1] = 99 " won't work! | |
| 12153 < You may want to make a copy of a list to avoid this. | |
| 12154 See |deepcopy()|. | |
| 12155 | |
| 12156 | |
| 12157 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
| 12158 Unlock the internal variable {name}. Does the | |
| 12159 opposite of |:lockvar|. | |
| 12160 | |
| 16944 | 12161 :if {expr1} *:if* *:end* *:endif* *:en* *E171* *E579* *E580* |
| 7 | 12162 :en[dif] Execute the commands until the next matching ":else" |
| 12163 or ":endif" if {expr1} evaluates to non-zero. | |
| 12164 | |
| 12165 From Vim version 4.5 until 5.0, every Ex command in | |
| 12166 between the ":if" and ":endif" is ignored. These two | |
| 12167 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
|
12168 backward compatible way. Nesting was allowed. Note |
| 7 | 12169 that any ":else" or ":elseif" was ignored, the "else" |
| 12170 part was not executed either. | |
| 12171 | |
| 12172 You can use this to remain compatible with older | |
| 12173 versions: > | |
| 12174 :if version >= 500 | |
| 12175 : version-5-specific-commands | |
| 12176 :endif | |
| 12177 < The commands still need to be parsed to find the | |
| 12178 "endif". Sometimes an older Vim has a problem with a | |
| 12179 new command. For example, ":silent" is recognized as | |
| 12180 a ":substitute" command. In that case ":execute" can | |
| 12181 avoid problems: > | |
| 12182 :if version >= 600 | |
| 12183 : execute "silent 1,$delete" | |
| 12184 :endif | |
| 12185 < | |
| 12186 NOTE: The ":append" and ":insert" commands don't work | |
| 12187 properly in between ":if" and ":endif". | |
| 12188 | |
| 12189 *:else* *:el* *E581* *E583* | |
| 12190 :el[se] Execute the commands until the next matching ":else" | |
| 12191 or ":endif" if they previously were not being | |
| 12192 executed. | |
| 12193 | |
| 12194 *:elseif* *:elsei* *E582* *E584* | |
| 12195 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
| 12196 is no extra ":endif". | |
| 12197 | |
| 12198 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
| 114 | 12199 *E170* *E585* *E588* *E733* |
| 7 | 12200 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
| 12201 as long as {expr1} evaluates to non-zero. | |
| 12202 When an error is detected from a command inside the | |
| 12203 loop, execution continues after the "endwhile". | |
| 75 | 12204 Example: > |
| 12205 :let lnum = 1 | |
| 12206 :while lnum <= line("$") | |
| 12207 :call FixLine(lnum) | |
| 12208 :let lnum = lnum + 1 | |
| 12209 :endwhile | |
| 12210 < | |
| 7 | 12211 NOTE: The ":append" and ":insert" commands don't work |
| 99 | 12212 properly inside a ":while" and ":for" loop. |
| 75 | 12213 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12214 :for {var} in {object} *:for* *E690* *E732* |
| 75 | 12215 :endfo[r] *:endfo* *:endfor* |
| 12216 Repeat the commands between ":for" and ":endfor" for | |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12217 each item in {object}. {object} can be a |List| or |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12218 a |Blob|. Variable {var} is set to the value of each |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12219 item. When an error is detected for a command inside |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12220 the loop, execution continues after the "endfor". |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12221 Changing {object} inside the loop affects what items |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12222 are used. Make a copy if this is unwanted: > |
| 79 | 12223 :for item in copy(mylist) |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12224 < |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12225 When {object} is a |List| and not making a copy, Vim |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12226 stores a reference to the next item in the |List| |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12227 before executing the commands with the current item. |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12228 Thus the current item can be removed without effect. |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12229 Removing any later item means it will not be found. |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12230 Thus the following example works (an inefficient way |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12231 to make a |List| empty): > |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
12232 for item in mylist |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
12233 call remove(mylist, 0) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
12234 endfor |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12235 < Note that reordering the |List| (e.g., with sort() or |
| 87 | 12236 reverse()) may have unexpected effects. |
| 75 | 12237 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12238 When {object} is a |Blob|, Vim always makes a copy to |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12239 iterate over. Unlike with |List|, modifying the |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12240 |Blob| does not affect the iteration. |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12241 |
| 75 | 12242 :for [{var1}, {var2}, ...] in {listlist} |
| 12243 :endfo[r] | |
| 12244 Like ":for" above, but each item in {listlist} must be | |
| 12245 a list, of which each item is assigned to {var1}, | |
| 12246 {var2}, etc. Example: > | |
| 12247 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
| 12248 :echo getline(lnum)[col] | |
| 12249 :endfor | |
| 12250 < | |
| 7 | 12251 *:continue* *:con* *E586* |
| 75 | 12252 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
| 12253 to the start of the loop. | |
| 12254 If it is used after a |:try| inside the loop but | |
| 12255 before the matching |:finally| (if present), the | |
| 12256 commands following the ":finally" up to the matching | |
| 12257 |:endtry| are executed first. This process applies to | |
| 12258 all nested ":try"s inside the loop. The outermost | |
| 12259 ":endtry" then jumps back to the start of the loop. | |
| 7 | 12260 |
| 12261 *:break* *:brea* *E587* | |
| 75 | 12262 :brea[k] When used inside a ":while" or ":for" loop, skips to |
| 12263 the command after the matching ":endwhile" or | |
| 12264 ":endfor". | |
| 12265 If it is used after a |:try| inside the loop but | |
| 12266 before the matching |:finally| (if present), the | |
| 12267 commands following the ":finally" up to the matching | |
| 12268 |:endtry| are executed first. This process applies to | |
| 12269 all nested ":try"s inside the loop. The outermost | |
| 12270 ":endtry" then jumps to the command after the loop. | |
| 7 | 12271 |
| 12272 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
| 12273 :endt[ry] Change the error handling for the commands between | |
| 12274 ":try" and ":endtry" including everything being | |
| 12275 executed across ":source" commands, function calls, | |
| 12276 or autocommand invocations. | |
| 12277 | |
| 12278 When an error or interrupt is detected and there is | |
| 12279 a |:finally| command following, execution continues | |
| 12280 after the ":finally". Otherwise, or when the | |
| 12281 ":endtry" is reached thereafter, the next | |
| 12282 (dynamically) surrounding ":try" is checked for | |
| 12283 a corresponding ":finally" etc. Then the script | |
| 19523 | 12284 processing is terminated. Whether a function |
| 12285 definition has an "abort" argument does not matter. | |
| 7 | 12286 Example: > |
| 19523 | 12287 try | call Unknown() | finally | echomsg "cleanup" | endtry |
| 12288 echomsg "not reached" | |
| 7 | 12289 < |
| 12290 Moreover, an error or interrupt (dynamically) inside | |
| 12291 ":try" and ":endtry" is converted to an exception. It | |
| 12292 can be caught as if it were thrown by a |:throw| | |
| 12293 command (see |:catch|). In this case, the script | |
| 12294 processing is not terminated. | |
| 12295 | |
| 12296 The value "Vim:Interrupt" is used for an interrupt | |
| 12297 exception. An error in a Vim command is converted | |
| 12298 to a value of the form "Vim({command}):{errmsg}", | |
| 12299 other errors are converted to a value of the form | |
| 12300 "Vim:{errmsg}". {command} is the full command name, | |
| 12301 and {errmsg} is the message that is displayed if the | |
| 12302 error exception is not caught, always beginning with | |
| 12303 the error number. | |
| 12304 Examples: > | |
| 19523 | 12305 try | sleep 100 | catch /^Vim:Interrupt$/ | endtry |
| 12306 try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
| 7 | 12307 < |
| 12308 *:cat* *:catch* *E603* *E604* *E605* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
12309 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
| 7 | 12310 |:finally|, or |:endtry| that belongs to the same |
| 12311 |:try| as the ":catch" are executed when an exception | |
| 12312 matching {pattern} is being thrown and has not yet | |
| 12313 been caught by a previous ":catch". Otherwise, these | |
| 12314 commands are skipped. | |
| 12315 When {pattern} is omitted all errors are caught. | |
| 12316 Examples: > | |
|
16019
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
12317 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
12318 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
12319 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
12320 :catch /^Vim(write):/ " catch all errors in :write |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
12321 :catch /^Vim\%((\a\+)\)\=:E123:/ " catch error E123 |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
12322 :catch /my-exception/ " catch user exception |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
12323 :catch /.*/ " catch everything |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
12324 :catch " same as /.*/ |
| 7 | 12325 < |
| 12326 Another character can be used instead of / around the | |
| 12327 {pattern}, so long as it does not have a special | |
| 12328 meaning (e.g., '|' or '"') and doesn't occur inside | |
| 12329 {pattern}. | |
| 5814 | 12330 Information about the exception is available in |
| 12331 |v:exception|. Also see |throw-variables|. | |
| 7 | 12332 NOTE: It is not reliable to ":catch" the TEXT of |
| 12333 an error message because it may vary in different | |
| 12334 locales. | |
| 12335 | |
| 12336 *:fina* *:finally* *E606* *E607* | |
| 12337 :fina[lly] The following commands until the matching |:endtry| | |
| 12338 are executed whenever the part between the matching | |
| 12339 |:try| and the ":finally" is left: either by falling | |
| 12340 through to the ":finally" or by a |:continue|, | |
| 12341 |:break|, |:finish|, or |:return|, or by an error or | |
| 12342 interrupt or exception (see |:throw|). | |
| 12343 | |
| 12344 *:th* *:throw* *E608* | |
| 12345 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
| 12346 If the ":throw" is used after a |:try| but before the | |
| 12347 first corresponding |:catch|, commands are skipped | |
| 12348 until the first ":catch" matching {expr1} is reached. | |
| 12349 If there is no such ":catch" or if the ":throw" is | |
| 12350 used after a ":catch" but before the |:finally|, the | |
| 12351 commands following the ":finally" (if present) up to | |
| 12352 the matching |:endtry| are executed. If the ":throw" | |
| 12353 is after the ":finally", commands up to the ":endtry" | |
| 12354 are skipped. At the ":endtry", this process applies | |
| 12355 again for the next dynamically surrounding ":try" | |
| 12356 (which may be found in a calling function or sourcing | |
| 12357 script), until a matching ":catch" has been found. | |
| 12358 If the exception is not caught, the command processing | |
| 12359 is terminated. | |
| 12360 Example: > | |
| 12361 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
| 2725 | 12362 < Note that "catch" may need to be on a separate line |
| 12363 for when an error causes the parsing to skip the whole | |
| 12364 line and not see the "|" that separates the commands. | |
| 7 | 12365 |
| 12366 *:ec* *:echo* | |
| 12367 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
| 12368 first {expr1} starts on a new line. | |
| 12369 Also see |:comment|. | |
| 12370 Use "\n" to start a new line. Use "\r" to move the | |
| 12371 cursor to the first column. | |
| 12372 Uses the highlighting set by the |:echohl| command. | |
| 12373 Cannot be followed by a comment. | |
| 12374 Example: > | |
| 12375 :echo "the value of 'shell' is" &shell | |
| 1156 | 12376 < *:echo-redraw* |
| 12377 A later redraw may make the message disappear again. | |
| 12378 And since Vim mostly postpones redrawing until it's | |
| 12379 finished with a sequence of commands this happens | |
| 12380 quite often. To avoid that a command from before the | |
| 12381 ":echo" causes a redraw afterwards (redraws are often | |
| 12382 postponed until you type something), force a redraw | |
| 12383 with the |:redraw| command. Example: > | |
| 7 | 12384 :new | redraw | echo "there is a new window" |
| 12385 < | |
| 12386 *:echon* | |
| 12387 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
| 12388 |:comment|. | |
| 12389 Uses the highlighting set by the |:echohl| command. | |
| 12390 Cannot be followed by a comment. | |
| 12391 Example: > | |
| 12392 :echon "the value of 'shell' is " &shell | |
| 12393 < | |
| 12394 Note the difference between using ":echo", which is a | |
| 12395 Vim command, and ":!echo", which is an external shell | |
| 12396 command: > | |
| 12397 :!echo % --> filename | |
| 12398 < The arguments of ":!" are expanded, see |:_%|. > | |
| 12399 :!echo "%" --> filename or "filename" | |
| 12400 < Like the previous example. Whether you see the double | |
| 12401 quotes or not depends on your 'shell'. > | |
| 12402 :echo % --> nothing | |
| 12403 < The '%' is an illegal character in an expression. > | |
| 12404 :echo "%" --> % | |
| 12405 < This just echoes the '%' character. > | |
| 12406 :echo expand("%") --> filename | |
| 12407 < This calls the expand() function to expand the '%'. | |
| 12408 | |
| 12409 *:echoh* *:echohl* | |
| 12410 :echoh[l] {name} Use the highlight group {name} for the following | |
| 12411 |:echo|, |:echon| and |:echomsg| commands. Also used | |
| 12412 for the |input()| prompt. Example: > | |
| 12413 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
| 12414 < Don't forget to set the group back to "None", | |
| 12415 otherwise all following echo's will be highlighted. | |
| 12416 | |
| 12417 *:echom* *:echomsg* | |
| 12418 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
| 12419 message in the |message-history|. | |
| 12420 Spaces are placed between the arguments as with the | |
| 12421 |:echo| command. But unprintable characters are | |
| 12422 displayed, not interpreted. | |
| 1156 | 12423 The parsing works slightly different from |:echo|, |
| 12424 more like |:execute|. All the expressions are first | |
| 12425 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
|
12426 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
|
12427 String, string() is used to turn it into a string. |
| 7 | 12428 Uses the highlighting set by the |:echohl| command. |
| 12429 Example: > | |
| 12430 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
| 1156 | 12431 < See |:echo-redraw| to avoid the message disappearing |
| 12432 when the screen is redrawn. | |
| 7 | 12433 *:echoe* *:echoerr* |
| 12434 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
| 12435 message in the |message-history|. When used in a | |
| 12436 script or function the line number will be added. | |
| 12437 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
|
12438 |:echomsg| command. When used inside a try conditional, |
| 7 | 12439 the message is raised as an error exception instead |
| 12440 (see |try-echoerr|). | |
| 12441 Example: > | |
| 12442 :echoerr "This script just failed!" | |
| 12443 < If you just want a highlighted message use |:echohl|. | |
| 12444 And to get a beep: > | |
| 12445 :exe "normal \<Esc>" | |
| 12446 < | |
| 18639 | 12447 *:eval* |
| 12448 :eval {expr} Evaluate {expr} and discard the result. Example: > | |
| 12449 :eval Getlist()->Filter()->append('$') | |
| 12450 | |
| 12451 < The expression is supposed to have a side effect, | |
| 12452 since the resulting value is not used. In the example | |
| 12453 the `append()` call appends the List with text to the | |
| 12454 buffer. This is similar to `:call` but works with any | |
| 12455 expression. | |
| 12456 | |
| 12457 The command can be shortened to `:ev` or `:eva`, but | |
| 12458 these are hard to recognize and therefore not to be | |
| 12459 used. | |
| 12460 | |
| 19523 | 12461 The command cannot be followed by "|" and another |
| 12462 command, since "|" is seen as part of the expression. | |
| 12463 | |
| 18639 | 12464 |
| 7 | 12465 *:exe* *:execute* |
| 12466 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
| 2152 | 12467 of {expr1} as an Ex command. |
| 12468 Multiple arguments are concatenated, with a space in | |
| 12469 between. To avoid the extra space use the "." | |
| 12470 operator to concatenate strings into one argument. | |
| 12471 {expr1} is used as the processed command, command line | |
| 12472 editing keys are not recognized. | |
| 7 | 12473 Cannot be followed by a comment. |
| 12474 Examples: > | |
| 2152 | 12475 :execute "buffer" nextbuf |
| 12476 :execute "normal" count . "w" | |
| 7 | 12477 < |
| 12478 ":execute" can be used to append a command to commands | |
| 12479 that don't accept a '|'. Example: > | |
| 12480 :execute '!ls' | echo "theend" | |
| 12481 | |
| 12482 < ":execute" is also a nice way to avoid having to type | |
| 12483 control characters in a Vim script for a ":normal" | |
| 12484 command: > | |
| 12485 :execute "normal ixxx\<Esc>" | |
| 12486 < This has an <Esc> character, see |expr-string|. | |
| 12487 | |
| 1621 | 12488 Be careful to correctly escape special characters in |
| 12489 file names. The |fnameescape()| function can be used | |
| 1661 | 12490 for Vim commands, |shellescape()| for |:!| commands. |
| 12491 Examples: > | |
| 1621 | 12492 :execute "e " . fnameescape(filename) |
|
5692
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5690
diff
changeset
|
12493 :execute "!ls " . shellescape(filename, 1) |
| 1621 | 12494 < |
| 7 | 12495 Note: The executed string may be any command-line, but |
| 5763 | 12496 starting or ending "if", "while" and "for" does not |
| 12497 always work, because when commands are skipped the | |
| 12498 ":execute" is not evaluated and Vim loses track of | |
| 12499 where blocks start and end. Also "break" and | |
| 12500 "continue" should not be inside ":execute". | |
| 12501 This example does not work, because the ":execute" is | |
| 12502 not evaluated and Vim does not see the "while", and | |
| 12503 gives an error for finding an ":endwhile": > | |
| 12504 :if 0 | |
| 12505 : execute 'while i > 5' | |
| 12506 : echo "test" | |
| 12507 : endwhile | |
| 12508 :endif | |
| 7 | 12509 < |
| 12510 It is allowed to have a "while" or "if" command | |
| 12511 completely in the executed string: > | |
| 12512 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
| 12513 < | |
| 12514 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
12515 *:exe-comment* |
| 7 | 12516 ":execute", ":echo" and ":echon" cannot be followed by |
| 12517 a comment directly, because they see the '"' as the | |
| 12518 start of a string. But, you can use '|' followed by a | |
| 12519 comment. Example: > | |
| 12520 :echo "foo" | "this is a comment | |
| 12521 | |
| 12522 ============================================================================== | |
| 12523 8. Exception handling *exception-handling* | |
| 12524 | |
| 12525 The Vim script language comprises an exception handling feature. This section | |
| 12526 explains how it can be used in a Vim script. | |
| 12527 | |
| 12528 Exceptions may be raised by Vim on an error or on interrupt, see | |
| 12529 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
| 12530 exception by using the ":throw" command, see |throw-catch|. | |
| 12531 | |
| 12532 | |
| 12533 TRY CONDITIONALS *try-conditionals* | |
| 12534 | |
| 12535 Exceptions can be caught or can cause cleanup code to be executed. You can | |
| 12536 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
| 12537 a finally clause (to be executed for cleanup). | |
| 12538 A try conditional begins with a |:try| command and ends at the matching | |
| 12539 |:endtry| command. In between, you can use a |:catch| command to start | |
| 12540 a catch clause, or a |:finally| command to start a finally clause. There may | |
| 12541 be none or multiple catch clauses, but there is at most one finally clause, | |
| 12542 which must not be followed by any catch clauses. The lines before the catch | |
| 12543 clauses and the finally clause is called a try block. > | |
| 12544 | |
| 12545 :try | |
| 1621 | 12546 : ... |
| 12547 : ... TRY BLOCK | |
| 12548 : ... | |
| 7 | 12549 :catch /{pattern}/ |
| 1621 | 12550 : ... |
| 12551 : ... CATCH CLAUSE | |
| 12552 : ... | |
| 7 | 12553 :catch /{pattern}/ |
| 1621 | 12554 : ... |
| 12555 : ... CATCH CLAUSE | |
| 12556 : ... | |
| 7 | 12557 :finally |
| 1621 | 12558 : ... |
| 12559 : ... FINALLY CLAUSE | |
| 12560 : ... | |
| 7 | 12561 :endtry |
| 12562 | |
| 12563 The try conditional allows to watch code for exceptions and to take the | |
| 12564 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
| 12565 from the try block and also the catch clauses may cause cleanup actions. | |
| 12566 When no exception is thrown during execution of the try block, the control | |
| 12567 is transferred to the finally clause, if present. After its execution, the | |
| 12568 script continues with the line following the ":endtry". | |
| 12569 When an exception occurs during execution of the try block, the remaining | |
| 12570 lines in the try block are skipped. The exception is matched against the | |
| 12571 patterns specified as arguments to the ":catch" commands. The catch clause | |
| 12572 after the first matching ":catch" is taken, other catch clauses are not | |
| 12573 executed. The catch clause ends when the next ":catch", ":finally", or | |
| 12574 ":endtry" command is reached - whatever is first. Then, the finally clause | |
| 12575 (if present) is executed. When the ":endtry" is reached, the script execution | |
| 12576 continues in the following line as usual. | |
| 12577 When an exception that does not match any of the patterns specified by the | |
| 12578 ":catch" commands is thrown in the try block, the exception is not caught by | |
| 12579 that try conditional and none of the catch clauses is executed. Only the | |
| 12580 finally clause, if present, is taken. The exception pends during execution of | |
| 12581 the finally clause. It is resumed at the ":endtry", so that commands after | |
| 12582 the ":endtry" are not executed and the exception might be caught elsewhere, | |
| 12583 see |try-nesting|. | |
| 12584 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
|
12585 remaining lines in that catch clause are not executed. The new exception is |
| 7 | 12586 not matched against the patterns in any of the ":catch" commands of the same |
| 12587 try conditional and none of its catch clauses is taken. If there is, however, | |
| 12588 a finally clause, it is executed, and the exception pends during its | |
| 12589 execution. The commands following the ":endtry" are not executed. The new | |
| 12590 exception might, however, be caught elsewhere, see |try-nesting|. | |
| 12591 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
|
12592 thrown, the remaining lines in the finally clause are skipped. If the finally |
| 7 | 12593 clause has been taken because of an exception from the try block or one of the |
| 12594 catch clauses, the original (pending) exception is discarded. The commands | |
| 12595 following the ":endtry" are not executed, and the exception from the finally | |
| 12596 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
| 12597 | |
| 12598 The finally clause is also executed, when a ":break" or ":continue" for | |
| 12599 a ":while" loop enclosing the complete try conditional is executed from the | |
| 12600 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
| 12601 from the try block or a catch clause of a try conditional in a function or | |
| 12602 sourced script, respectively. The ":break", ":continue", ":return", or | |
| 12603 ":finish" pends during execution of the finally clause and is resumed when the | |
| 12604 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
| 12605 from the finally clause. | |
| 12606 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
| 12607 try conditional or when a ":return" or ":finish" is encountered in the finally | |
| 12608 clause, the rest of the finally clause is skipped, and the ":break", | |
| 12609 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
| 12610 clause has been taken because of an exception or an earlier ":break", | |
| 12611 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
| 12612 this pending exception or command is discarded. | |
| 12613 | |
| 12614 For examples see |throw-catch| and |try-finally|. | |
| 12615 | |
| 12616 | |
| 12617 NESTING OF TRY CONDITIONALS *try-nesting* | |
| 12618 | |
| 12619 Try conditionals can be nested arbitrarily. That is, a complete try | |
| 12620 conditional can be put into the try block, a catch clause, or the finally | |
| 12621 clause of another try conditional. If the inner try conditional does not | |
| 12622 catch an exception thrown in its try block or throws a new exception from one | |
| 12623 of its catch clauses or its finally clause, the outer try conditional is | |
| 12624 checked according to the rules above. If the inner try conditional is in the | |
| 12625 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
|
12626 otherwise only the finally clause is executed. It does not matter for |
| 7 | 12627 nesting, whether the inner try conditional is directly contained in the outer |
| 12628 one, or whether the outer one sources a script or calls a function containing | |
| 12629 the inner try conditional. | |
| 12630 | |
| 12631 When none of the active try conditionals catches an exception, just their | |
| 12632 finally clauses are executed. Thereafter, the script processing terminates. | |
| 12633 An error message is displayed in case of an uncaught exception explicitly | |
| 12634 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
| 12635 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
| 12636 as usual. | |
| 12637 | |
| 12638 For examples see |throw-catch|. | |
| 12639 | |
| 12640 | |
| 12641 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
| 12642 | |
| 12643 Exception handling code can get tricky. If you are in doubt what happens, set | |
| 12644 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
| 12645 script file. Then you see when an exception is thrown, discarded, caught, or | |
| 12646 finished. When using a verbosity level of at least 14, things pending in | |
| 12647 a finally clause are also shown. This information is also given in debug mode | |
| 12648 (see |debug-scripts|). | |
| 12649 | |
| 12650 | |
| 12651 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
| 12652 | |
| 12653 You can throw any number or string as an exception. Use the |:throw| command | |
| 12654 and pass the value to be thrown as argument: > | |
| 12655 :throw 4711 | |
| 12656 :throw "string" | |
| 12657 < *throw-expression* | |
| 12658 You can also specify an expression argument. The expression is then evaluated | |
| 12659 first, and the result is thrown: > | |
| 12660 :throw 4705 + strlen("string") | |
| 12661 :throw strpart("strings", 0, 6) | |
| 12662 | |
| 12663 An exception might be thrown during evaluation of the argument of the ":throw" | |
| 12664 command. Unless it is caught there, the expression evaluation is abandoned. | |
| 12665 The ":throw" command then does not throw a new exception. | |
| 12666 Example: > | |
| 12667 | |
| 12668 :function! Foo(arg) | |
| 12669 : try | |
| 12670 : throw a:arg | |
| 12671 : catch /foo/ | |
| 12672 : endtry | |
| 12673 : return 1 | |
| 12674 :endfunction | |
| 12675 : | |
| 12676 :function! Bar() | |
| 12677 : echo "in Bar" | |
| 12678 : return 4710 | |
| 12679 :endfunction | |
| 12680 : | |
| 12681 :throw Foo("arrgh") + Bar() | |
| 12682 | |
| 12683 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
| 12684 executed. > | |
| 12685 :throw Foo("foo") + Bar() | |
| 12686 however displays "in Bar" and throws 4711. | |
| 12687 | |
| 12688 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
|
12689 abandoned by an (uncaught) exception during the expression evaluation. The |
| 7 | 12690 exception is then propagated to the caller of the command. |
| 12691 Example: > | |
| 12692 | |
| 12693 :if Foo("arrgh") | |
| 12694 : echo "then" | |
| 12695 :else | |
| 12696 : echo "else" | |
| 12697 :endif | |
| 12698 | |
| 12699 Here neither of "then" or "else" is displayed. | |
| 12700 | |
| 12701 *catch-order* | |
| 12702 Exceptions can be caught by a try conditional with one or more |:catch| | |
| 12703 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
| 12704 command can be specified as a pattern argument. The subsequent catch clause | |
| 12705 gets executed when a matching exception is caught. | |
| 12706 Example: > | |
| 12707 | |
| 12708 :function! Foo(value) | |
| 12709 : try | |
| 12710 : throw a:value | |
| 12711 : catch /^\d\+$/ | |
| 12712 : echo "Number thrown" | |
| 12713 : catch /.*/ | |
| 12714 : echo "String thrown" | |
| 12715 : endtry | |
| 12716 :endfunction | |
| 12717 : | |
| 12718 :call Foo(0x1267) | |
| 12719 :call Foo('string') | |
| 12720 | |
| 12721 The first call to Foo() displays "Number thrown", the second "String thrown". | |
| 12722 An exception is matched against the ":catch" commands in the order they are | |
| 12723 specified. Only the first match counts. So you should place the more | |
| 12724 specific ":catch" first. The following order does not make sense: > | |
| 12725 | |
| 12726 : catch /.*/ | |
| 12727 : echo "String thrown" | |
| 12728 : catch /^\d\+$/ | |
| 12729 : echo "Number thrown" | |
| 12730 | |
| 12731 The first ":catch" here matches always, so that the second catch clause is | |
| 12732 never taken. | |
| 12733 | |
| 12734 *throw-variables* | |
| 12735 If you catch an exception by a general pattern, you may access the exact value | |
| 12736 in the variable |v:exception|: > | |
| 12737 | |
| 12738 : catch /^\d\+$/ | |
| 12739 : echo "Number thrown. Value is" v:exception | |
| 12740 | |
| 12741 You may also be interested where an exception was thrown. This is stored in | |
| 12742 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
| 12743 exception most recently caught as long it is not finished. | |
| 12744 Example: > | |
| 12745 | |
| 12746 :function! Caught() | |
| 12747 : if v:exception != "" | |
| 12748 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
| 12749 : else | |
| 12750 : echo 'Nothing caught' | |
| 12751 : endif | |
| 12752 :endfunction | |
| 12753 : | |
| 12754 :function! Foo() | |
| 12755 : try | |
| 12756 : try | |
| 12757 : try | |
| 12758 : throw 4711 | |
| 12759 : finally | |
| 12760 : call Caught() | |
| 12761 : endtry | |
| 12762 : catch /.*/ | |
| 12763 : call Caught() | |
| 12764 : throw "oops" | |
| 12765 : endtry | |
| 12766 : catch /.*/ | |
| 12767 : call Caught() | |
| 12768 : finally | |
| 12769 : call Caught() | |
| 12770 : endtry | |
| 12771 :endfunction | |
| 12772 : | |
| 12773 :call Foo() | |
| 12774 | |
| 12775 This displays > | |
| 12776 | |
| 12777 Nothing caught | |
| 12778 Caught "4711" in function Foo, line 4 | |
| 12779 Caught "oops" in function Foo, line 10 | |
| 12780 Nothing caught | |
| 12781 | |
| 12782 A practical example: The following command ":LineNumber" displays the line | |
| 12783 number in the script or function where it has been used: > | |
| 12784 | |
| 12785 :function! LineNumber() | |
| 12786 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
| 12787 :endfunction | |
| 12788 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
| 12789 < | |
| 12790 *try-nested* | |
| 12791 An exception that is not caught by a try conditional can be caught by | |
| 12792 a surrounding try conditional: > | |
| 12793 | |
| 12794 :try | |
| 12795 : try | |
| 12796 : throw "foo" | |
| 12797 : catch /foobar/ | |
| 12798 : echo "foobar" | |
| 12799 : finally | |
| 12800 : echo "inner finally" | |
| 12801 : endtry | |
| 12802 :catch /foo/ | |
| 12803 : echo "foo" | |
| 12804 :endtry | |
| 12805 | |
| 12806 The inner try conditional does not catch the exception, just its finally | |
| 12807 clause is executed. The exception is then caught by the outer try | |
| 12808 conditional. The example displays "inner finally" and then "foo". | |
| 12809 | |
| 12810 *throw-from-catch* | |
| 12811 You can catch an exception and throw a new one to be caught elsewhere from the | |
| 12812 catch clause: > | |
| 12813 | |
| 12814 :function! Foo() | |
| 12815 : throw "foo" | |
| 12816 :endfunction | |
| 12817 : | |
| 12818 :function! Bar() | |
| 12819 : try | |
| 12820 : call Foo() | |
| 12821 : catch /foo/ | |
| 12822 : echo "Caught foo, throw bar" | |
| 12823 : throw "bar" | |
| 12824 : endtry | |
| 12825 :endfunction | |
| 12826 : | |
| 12827 :try | |
| 12828 : call Bar() | |
| 12829 :catch /.*/ | |
| 12830 : echo "Caught" v:exception | |
| 12831 :endtry | |
| 12832 | |
| 12833 This displays "Caught foo, throw bar" and then "Caught bar". | |
| 12834 | |
| 12835 *rethrow* | |
| 12836 There is no real rethrow in the Vim script language, but you may throw | |
| 12837 "v:exception" instead: > | |
| 12838 | |
| 12839 :function! Bar() | |
| 12840 : try | |
| 12841 : call Foo() | |
| 12842 : catch /.*/ | |
| 12843 : echo "Rethrow" v:exception | |
| 12844 : throw v:exception | |
| 12845 : endtry | |
| 12846 :endfunction | |
| 12847 < *try-echoerr* | |
| 12848 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
| 12849 exceptions, because it is not possible to fake Vim internal exceptions. | |
| 12850 Trying so causes an error exception. You should throw your own exception | |
| 12851 denoting the situation. If you want to cause a Vim error exception containing | |
| 12852 the original error exception value, you can use the |:echoerr| command: > | |
| 12853 | |
| 12854 :try | |
| 12855 : try | |
| 12856 : asdf | |
| 12857 : catch /.*/ | |
| 12858 : echoerr v:exception | |
| 12859 : endtry | |
| 12860 :catch /.*/ | |
| 12861 : echo v:exception | |
| 12862 :endtry | |
| 12863 | |
| 12864 This code displays | |
| 12865 | |
| 1621 | 12866 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
| 7 | 12867 |
| 12868 | |
| 12869 CLEANUP CODE *try-finally* | |
| 12870 | |
| 12871 Scripts often change global settings and restore them at their end. If the | |
| 12872 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
|
12873 an inconsistent state. The same may happen to you in the development phase of |
| 7 | 12874 a script when an error occurs or you explicitly throw an exception without |
| 12875 catching it. You can solve these problems by using a try conditional with | |
| 12876 a finally clause for restoring the settings. Its execution is guaranteed on | |
| 12877 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
| 12878 (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
|
12879 to exceptions. When not caught, they terminate the script after the finally |
| 7 | 12880 clause has been executed.) |
| 12881 Example: > | |
| 12882 | |
| 12883 :try | |
| 12884 : let s:saved_ts = &ts | |
| 12885 : set ts=17 | |
| 12886 : | |
| 12887 : " Do the hard work here. | |
| 12888 : | |
| 12889 :finally | |
| 12890 : let &ts = s:saved_ts | |
| 12891 : unlet s:saved_ts | |
| 12892 :endtry | |
| 12893 | |
| 12894 This method should be used locally whenever a function or part of a script | |
| 12895 changes global settings which need to be restored on failure or normal exit of | |
| 12896 that function or script part. | |
| 12897 | |
| 12898 *break-finally* | |
| 12899 Cleanup code works also when the try block or a catch clause is left by | |
| 12900 a ":continue", ":break", ":return", or ":finish". | |
| 12901 Example: > | |
| 12902 | |
| 12903 :let first = 1 | |
| 12904 :while 1 | |
| 12905 : try | |
| 12906 : if first | |
| 12907 : echo "first" | |
| 12908 : let first = 0 | |
| 12909 : continue | |
| 12910 : else | |
| 12911 : throw "second" | |
| 12912 : endif | |
| 12913 : catch /.*/ | |
| 12914 : echo v:exception | |
| 12915 : break | |
| 12916 : finally | |
| 12917 : echo "cleanup" | |
| 12918 : endtry | |
| 12919 : echo "still in while" | |
| 12920 :endwhile | |
| 12921 :echo "end" | |
| 12922 | |
| 12923 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
| 12924 | |
| 12925 :function! Foo() | |
| 12926 : try | |
| 12927 : return 4711 | |
| 12928 : finally | |
| 12929 : echo "cleanup\n" | |
| 12930 : endtry | |
| 12931 : echo "Foo still active" | |
| 12932 :endfunction | |
| 12933 : | |
| 12934 :echo Foo() "returned by Foo" | |
| 12935 | |
| 12936 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
|
12937 extra ":return" in the finally clause. (Above all, this would override the |
| 7 | 12938 return value.) |
| 12939 | |
| 12940 *except-from-finally* | |
| 12941 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
| 12942 a finally clause is possible, but not recommended since it abandons the | |
| 12943 cleanup actions for the try conditional. But, of course, interrupt and error | |
| 12944 exceptions might get raised from a finally clause. | |
| 12945 Example where an error in the finally clause stops an interrupt from | |
| 12946 working correctly: > | |
| 12947 | |
| 12948 :try | |
| 12949 : try | |
| 12950 : echo "Press CTRL-C for interrupt" | |
| 12951 : while 1 | |
| 12952 : endwhile | |
| 12953 : finally | |
| 12954 : unlet novar | |
| 12955 : endtry | |
| 12956 :catch /novar/ | |
| 12957 :endtry | |
| 12958 :echo "Script still running" | |
| 12959 :sleep 1 | |
| 12960 | |
| 12961 If you need to put commands that could fail into a finally clause, you should | |
| 12962 think about catching or ignoring the errors in these commands, see | |
| 12963 |catch-errors| and |ignore-errors|. | |
| 12964 | |
| 12965 | |
| 12966 CATCHING ERRORS *catch-errors* | |
| 12967 | |
| 12968 If you want to catch specific errors, you just have to put the code to be | |
| 12969 watched in a try block and add a catch clause for the error message. The | |
| 12970 presence of the try conditional causes all errors to be converted to an | |
| 12971 exception. No message is displayed and |v:errmsg| is not set then. To find | |
| 12972 the right pattern for the ":catch" command, you have to know how the format of | |
| 12973 the error exception is. | |
| 12974 Error exceptions have the following format: > | |
| 12975 | |
| 12976 Vim({cmdname}):{errmsg} | |
| 12977 or > | |
| 12978 Vim:{errmsg} | |
| 12979 | |
| 12980 {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
|
12981 the command name is not known. {errmsg} is the error message usually produced |
| 7 | 12982 when the error occurs outside try conditionals. It always begins with |
| 12983 a capital "E", followed by a two or three-digit error number, a colon, and | |
| 12984 a space. | |
| 12985 | |
| 12986 Examples: | |
| 12987 | |
| 12988 The command > | |
| 12989 :unlet novar | |
| 12990 normally produces the error message > | |
| 12991 E108: No such variable: "novar" | |
| 12992 which is converted inside try conditionals to an exception > | |
| 12993 Vim(unlet):E108: No such variable: "novar" | |
| 12994 | |
| 12995 The command > | |
| 12996 :dwim | |
| 12997 normally produces the error message > | |
| 12998 E492: Not an editor command: dwim | |
| 12999 which is converted inside try conditionals to an exception > | |
| 13000 Vim:E492: Not an editor command: dwim | |
| 13001 | |
| 13002 You can catch all ":unlet" errors by a > | |
| 13003 :catch /^Vim(unlet):/ | |
| 13004 or all errors for misspelled command names by a > | |
| 13005 :catch /^Vim:E492:/ | |
| 13006 | |
| 13007 Some error messages may be produced by different commands: > | |
| 13008 :function nofunc | |
| 13009 and > | |
| 13010 :delfunction nofunc | |
| 13011 both produce the error message > | |
| 13012 E128: Function name must start with a capital: nofunc | |
| 13013 which is converted inside try conditionals to an exception > | |
| 13014 Vim(function):E128: Function name must start with a capital: nofunc | |
| 13015 or > | |
| 13016 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
| 13017 respectively. You can catch the error by its number independently on the | |
| 13018 command that caused it if you use the following pattern: > | |
| 13019 :catch /^Vim(\a\+):E128:/ | |
| 13020 | |
| 13021 Some commands like > | |
| 13022 :let x = novar | |
| 13023 produce multiple error messages, here: > | |
| 13024 E121: Undefined variable: novar | |
| 13025 E15: Invalid expression: novar | |
| 13026 Only the first is used for the exception value, since it is the most specific | |
| 13027 one (see |except-several-errors|). So you can catch it by > | |
| 13028 :catch /^Vim(\a\+):E121:/ | |
| 13029 | |
| 13030 You can catch all errors related to the name "nofunc" by > | |
| 13031 :catch /\<nofunc\>/ | |
| 13032 | |
| 13033 You can catch all Vim errors in the ":write" and ":read" commands by > | |
| 13034 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
| 13035 | |
| 13036 You can catch all Vim errors by the pattern > | |
| 13037 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
| 13038 < | |
| 13039 *catch-text* | |
| 13040 NOTE: You should never catch the error message text itself: > | |
| 13041 :catch /No such variable/ | |
| 6647 | 13042 only works in the English locale, but not when the user has selected |
| 7 | 13043 a different language by the |:language| command. It is however helpful to |
| 13044 cite the message text in a comment: > | |
| 13045 :catch /^Vim(\a\+):E108:/ " No such variable | |
| 13046 | |
| 13047 | |
| 13048 IGNORING ERRORS *ignore-errors* | |
| 13049 | |
| 13050 You can ignore errors in a specific Vim command by catching them locally: > | |
| 13051 | |
| 13052 :try | |
| 13053 : write | |
| 13054 :catch | |
| 13055 :endtry | |
| 13056 | |
| 13057 But you are strongly recommended NOT to use this simple form, since it could | |
| 13058 catch more than you want. With the ":write" command, some autocommands could | |
| 13059 be executed and cause errors not related to writing, for instance: > | |
| 13060 | |
| 13061 :au BufWritePre * unlet novar | |
| 13062 | |
| 13063 There could even be such errors you are not responsible for as a script | |
| 13064 writer: a user of your script might have defined such autocommands. You would | |
| 13065 then hide the error from the user. | |
| 13066 It is much better to use > | |
| 13067 | |
| 13068 :try | |
| 13069 : write | |
| 13070 :catch /^Vim(write):/ | |
| 13071 :endtry | |
| 13072 | |
| 13073 which only catches real write errors. So catch only what you'd like to ignore | |
| 13074 intentionally. | |
| 13075 | |
| 13076 For a single command that does not cause execution of autocommands, you could | |
| 13077 even suppress the conversion of errors to exceptions by the ":silent!" | |
| 13078 command: > | |
| 13079 :silent! nunmap k | |
| 13080 This works also when a try conditional is active. | |
| 13081 | |
| 13082 | |
| 13083 CATCHING INTERRUPTS *catch-interrupt* | |
| 13084 | |
| 13085 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
|
13086 the exception "Vim:Interrupt". You can catch it like every exception. The |
| 7 | 13087 script is not terminated, then. |
| 13088 Example: > | |
| 13089 | |
| 13090 :function! TASK1() | |
| 13091 : sleep 10 | |
| 13092 :endfunction | |
| 13093 | |
| 13094 :function! TASK2() | |
| 13095 : sleep 20 | |
| 13096 :endfunction | |
| 13097 | |
| 13098 :while 1 | |
| 13099 : let command = input("Type a command: ") | |
| 13100 : try | |
| 13101 : if command == "" | |
| 13102 : continue | |
| 13103 : elseif command == "END" | |
| 13104 : break | |
| 13105 : elseif command == "TASK1" | |
| 13106 : call TASK1() | |
| 13107 : elseif command == "TASK2" | |
| 13108 : call TASK2() | |
| 13109 : else | |
| 13110 : echo "\nIllegal command:" command | |
| 13111 : continue | |
| 13112 : endif | |
| 13113 : catch /^Vim:Interrupt$/ | |
| 13114 : echo "\nCommand interrupted" | |
| 13115 : " Caught the interrupt. Continue with next prompt. | |
| 13116 : endtry | |
| 13117 :endwhile | |
| 13118 | |
| 13119 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
|
13120 a new command. If you press CTRL-C at the prompt, the script is terminated. |
| 7 | 13121 |
| 13122 For testing what happens when CTRL-C would be pressed on a specific line in | |
| 13123 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
| 13124 command on that line. See |debug-scripts|. | |
| 13125 | |
| 13126 | |
| 13127 CATCHING ALL *catch-all* | |
| 13128 | |
| 13129 The commands > | |
| 13130 | |
| 13131 :catch /.*/ | |
| 13132 :catch // | |
| 13133 :catch | |
| 13134 | |
| 13135 catch everything, error exceptions, interrupt exceptions and exceptions | |
| 13136 explicitly thrown by the |:throw| command. This is useful at the top level of | |
| 13137 a script in order to catch unexpected things. | |
| 13138 Example: > | |
| 13139 | |
| 13140 :try | |
| 13141 : | |
| 13142 : " do the hard work here | |
| 13143 : | |
| 13144 :catch /MyException/ | |
| 13145 : | |
| 13146 : " handle known problem | |
| 13147 : | |
| 13148 :catch /^Vim:Interrupt$/ | |
| 13149 : echo "Script interrupted" | |
| 13150 :catch /.*/ | |
| 13151 : echo "Internal error (" . v:exception . ")" | |
| 13152 : echo " - occurred at " . v:throwpoint | |
| 13153 :endtry | |
| 13154 :" end of script | |
| 13155 | |
| 13156 Note: Catching all might catch more things than you want. Thus, you are | |
| 13157 strongly encouraged to catch only for problems that you can really handle by | |
| 13158 specifying a pattern argument to the ":catch". | |
| 13159 Example: Catching all could make it nearly impossible to interrupt a script | |
| 13160 by pressing CTRL-C: > | |
| 13161 | |
| 13162 :while 1 | |
| 13163 : try | |
| 13164 : sleep 1 | |
| 13165 : catch | |
| 13166 : endtry | |
| 13167 :endwhile | |
| 13168 | |
| 13169 | |
| 13170 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
| 13171 | |
| 13172 Exceptions may be used during execution of autocommands. Example: > | |
| 13173 | |
| 13174 :autocmd User x try | |
| 13175 :autocmd User x throw "Oops!" | |
| 13176 :autocmd User x catch | |
| 13177 :autocmd User x echo v:exception | |
| 13178 :autocmd User x endtry | |
| 13179 :autocmd User x throw "Arrgh!" | |
| 13180 :autocmd User x echo "Should not be displayed" | |
| 13181 : | |
| 13182 :try | |
| 13183 : doautocmd User x | |
| 13184 :catch | |
| 13185 : echo v:exception | |
| 13186 :endtry | |
| 13187 | |
| 13188 This displays "Oops!" and "Arrgh!". | |
| 13189 | |
| 13190 *except-autocmd-Pre* | |
| 13191 For some commands, autocommands get executed before the main action of the | |
| 13192 command takes place. If an exception is thrown and not caught in the sequence | |
| 13193 of autocommands, the sequence and the command that caused its execution are | |
| 13194 abandoned and the exception is propagated to the caller of the command. | |
| 13195 Example: > | |
| 13196 | |
| 13197 :autocmd BufWritePre * throw "FAIL" | |
| 13198 :autocmd BufWritePre * echo "Should not be displayed" | |
| 13199 : | |
| 13200 :try | |
| 13201 : write | |
| 13202 :catch | |
| 13203 : echo "Caught:" v:exception "from" v:throwpoint | |
| 13204 :endtry | |
| 13205 | |
| 13206 Here, the ":write" command does not write the file currently being edited (as | |
| 13207 you can see by checking 'modified'), since the exception from the BufWritePre | |
| 13208 autocommand abandons the ":write". The exception is then caught and the | |
| 13209 script displays: > | |
| 13210 | |
| 13211 Caught: FAIL from BufWrite Auto commands for "*" | |
| 13212 < | |
| 13213 *except-autocmd-Post* | |
| 13214 For some commands, autocommands get executed after the main action of the | |
| 13215 command has taken place. If this main action fails and the command is inside | |
| 13216 an active try conditional, the autocommands are skipped and an error exception | |
| 13217 is thrown that can be caught by the caller of the command. | |
| 13218 Example: > | |
| 13219 | |
| 13220 :autocmd BufWritePost * echo "File successfully written!" | |
| 13221 : | |
| 13222 :try | |
| 13223 : write /i/m/p/o/s/s/i/b/l/e | |
| 13224 :catch | |
| 13225 : echo v:exception | |
| 13226 :endtry | |
| 13227 | |
| 13228 This just displays: > | |
| 13229 | |
| 13230 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
| 13231 | |
| 13232 If you really need to execute the autocommands even when the main action | |
| 13233 fails, trigger the event from the catch clause. | |
| 13234 Example: > | |
| 13235 | |
| 13236 :autocmd BufWritePre * set noreadonly | |
| 13237 :autocmd BufWritePost * set readonly | |
| 13238 : | |
| 13239 :try | |
| 13240 : write /i/m/p/o/s/s/i/b/l/e | |
| 13241 :catch | |
| 13242 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
| 13243 :endtry | |
| 13244 < | |
| 13245 You can also use ":silent!": > | |
| 13246 | |
| 13247 :let x = "ok" | |
| 13248 :let v:errmsg = "" | |
| 13249 :autocmd BufWritePost * if v:errmsg != "" | |
| 13250 :autocmd BufWritePost * let x = "after fail" | |
| 13251 :autocmd BufWritePost * endif | |
| 13252 :try | |
| 13253 : silent! write /i/m/p/o/s/s/i/b/l/e | |
| 13254 :catch | |
| 13255 :endtry | |
| 13256 :echo x | |
| 13257 | |
| 13258 This displays "after fail". | |
| 13259 | |
| 13260 If the main action of the command does not fail, exceptions from the | |
| 13261 autocommands will be catchable by the caller of the command: > | |
| 13262 | |
| 13263 :autocmd BufWritePost * throw ":-(" | |
| 13264 :autocmd BufWritePost * echo "Should not be displayed" | |
| 13265 : | |
| 13266 :try | |
| 13267 : write | |
| 13268 :catch | |
| 13269 : echo v:exception | |
| 13270 :endtry | |
| 13271 < | |
| 13272 *except-autocmd-Cmd* | |
| 13273 For some commands, the normal action can be replaced by a sequence of | |
| 13274 autocommands. Exceptions from that sequence will be catchable by the caller | |
| 13275 of the command. | |
| 13276 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
|
13277 had actually been written when the exception occurred. You need to tell it in |
| 7 | 13278 some way. > |
| 13279 | |
| 13280 :if !exists("cnt") | |
| 13281 : let cnt = 0 | |
| 13282 : | |
| 13283 : autocmd BufWriteCmd * if &modified | |
| 13284 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
| 13285 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
| 13286 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 13287 : autocmd BufWriteCmd * endif | |
| 13288 : autocmd BufWriteCmd * write | set nomodified | |
| 13289 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
| 13290 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 13291 : autocmd BufWriteCmd * endif | |
| 13292 : autocmd BufWriteCmd * echo "File successfully written!" | |
| 13293 : autocmd BufWriteCmd * endif | |
| 13294 :endif | |
| 13295 : | |
| 13296 :try | |
| 13297 : write | |
| 13298 :catch /^BufWriteCmdError$/ | |
| 13299 : if &modified | |
| 13300 : echo "Error on writing (file contents not changed)" | |
| 13301 : else | |
| 13302 : echo "Error after writing" | |
| 13303 : endif | |
| 13304 :catch /^Vim(write):/ | |
| 13305 : echo "Error on writing" | |
| 13306 :endtry | |
| 13307 | |
| 13308 When this script is sourced several times after making changes, it displays | |
| 13309 first > | |
| 13310 File successfully written! | |
| 13311 then > | |
| 13312 Error on writing (file contents not changed) | |
| 13313 then > | |
| 13314 Error after writing | |
| 13315 etc. | |
| 13316 | |
| 13317 *except-autocmd-ill* | |
| 13318 You cannot spread a try conditional over autocommands for different events. | |
| 13319 The following code is ill-formed: > | |
| 13320 | |
| 13321 :autocmd BufWritePre * try | |
| 13322 : | |
| 13323 :autocmd BufWritePost * catch | |
| 13324 :autocmd BufWritePost * echo v:exception | |
| 13325 :autocmd BufWritePost * endtry | |
| 13326 : | |
| 13327 :write | |
| 13328 | |
| 13329 | |
| 13330 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
| 13331 | |
| 13332 Some programming languages allow to use hierarchies of exception classes or to | |
| 13333 pass additional information with the object of an exception class. You can do | |
| 13334 similar things in Vim. | |
| 13335 In order to throw an exception from a hierarchy, just throw the complete | |
| 13336 class name with the components separated by a colon, for instance throw the | |
| 13337 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
| 13338 When you want to pass additional information with your exception class, add | |
| 13339 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
| 13340 for an error when writing "myfile". | |
| 13341 With the appropriate patterns in the ":catch" command, you can catch for | |
| 13342 base classes or derived classes of your hierarchy. Additional information in | |
| 13343 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
| 13344 Example: > | |
| 13345 | |
| 13346 :function! CheckRange(a, func) | |
| 13347 : if a:a < 0 | |
| 13348 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
| 13349 : endif | |
| 13350 :endfunction | |
| 13351 : | |
| 13352 :function! Add(a, b) | |
| 13353 : call CheckRange(a:a, "Add") | |
| 13354 : call CheckRange(a:b, "Add") | |
| 13355 : let c = a:a + a:b | |
| 13356 : if c < 0 | |
| 13357 : throw "EXCEPT:MATHERR:OVERFLOW" | |
| 13358 : endif | |
| 13359 : return c | |
| 13360 :endfunction | |
| 13361 : | |
| 13362 :function! Div(a, b) | |
| 13363 : call CheckRange(a:a, "Div") | |
| 13364 : call CheckRange(a:b, "Div") | |
| 13365 : if (a:b == 0) | |
| 13366 : throw "EXCEPT:MATHERR:ZERODIV" | |
| 13367 : endif | |
| 13368 : return a:a / a:b | |
| 13369 :endfunction | |
| 13370 : | |
| 13371 :function! Write(file) | |
| 13372 : try | |
| 1621 | 13373 : execute "write" fnameescape(a:file) |
| 7 | 13374 : catch /^Vim(write):/ |
| 13375 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
| 13376 : endtry | |
| 13377 :endfunction | |
| 13378 : | |
| 13379 :try | |
| 13380 : | |
| 13381 : " something with arithmetics and I/O | |
| 13382 : | |
| 13383 :catch /^EXCEPT:MATHERR:RANGE/ | |
| 13384 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
| 13385 : echo "Range error in" function | |
| 13386 : | |
| 13387 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
| 13388 : echo "Math error" | |
| 13389 : | |
| 13390 :catch /^EXCEPT:IO/ | |
| 13391 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
| 13392 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
| 13393 : if file !~ '^/' | |
| 13394 : let file = dir . "/" . file | |
| 13395 : endif | |
| 13396 : echo 'I/O error for "' . file . '"' | |
| 13397 : | |
| 13398 :catch /^EXCEPT/ | |
| 13399 : echo "Unspecified error" | |
| 13400 : | |
| 13401 :endtry | |
| 13402 | |
| 13403 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
| 13404 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
| 13405 exceptions with the "Vim" prefix; they are reserved for Vim. | |
| 13406 Vim error exceptions are parameterized with the name of the command that | |
| 13407 failed, if known. See |catch-errors|. | |
| 13408 | |
| 13409 | |
| 13410 PECULIARITIES | |
| 13411 *except-compat* | |
| 13412 The exception handling concept requires that the command sequence causing the | |
| 13413 exception is aborted immediately and control is transferred to finally clauses | |
| 13414 and/or a catch clause. | |
| 13415 | |
| 13416 In the Vim script language there are cases where scripts and functions | |
| 13417 continue after an error: in functions without the "abort" flag or in a command | |
| 13418 after ":silent!", control flow goes to the following line, and outside | |
| 13419 functions, control flow goes to the line following the outermost ":endwhile" | |
| 13420 or ":endif". On the other hand, errors should be catchable as exceptions | |
| 13421 (thus, requiring the immediate abortion). | |
| 13422 | |
| 13423 This problem has been solved by converting errors to exceptions and using | |
| 13424 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
|
13425 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
|
13426 be caught only from an active try conditional. If you want an immediate |
| 7 | 13427 termination without catching the error, just use a try conditional without |
| 13428 catch clause. (You can cause cleanup code being executed before termination | |
| 13429 by specifying a finally clause.) | |
| 13430 | |
| 13431 When no try conditional is active, the usual abortion and continuation | |
| 13432 behavior is used instead of immediate abortion. This ensures compatibility of | |
| 13433 scripts written for Vim 6.1 and earlier. | |
| 13434 | |
| 13435 However, when sourcing an existing script that does not use exception handling | |
| 13436 commands (or when calling one of its functions) from inside an active try | |
| 13437 conditional of a new script, you might change the control flow of the existing | |
| 13438 script on error. You get the immediate abortion on error and can catch the | |
| 13439 error in the new script. If however the sourced script suppresses error | |
| 13440 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
|
13441 |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
|
13442 not converted to an exception. (See |:silent|.) So the only remaining cause |
| 7 | 13443 where this happens is for scripts that don't care about errors and produce |
| 13444 error messages. You probably won't want to use such code from your new | |
| 13445 scripts. | |
| 13446 | |
| 13447 *except-syntax-err* | |
| 13448 Syntax errors in the exception handling commands are never caught by any of | |
| 13449 the ":catch" commands of the try conditional they belong to. Its finally | |
| 13450 clauses, however, is executed. | |
| 13451 Example: > | |
| 13452 | |
| 13453 :try | |
| 13454 : try | |
| 13455 : throw 4711 | |
| 13456 : catch /\(/ | |
| 13457 : echo "in catch with syntax error" | |
| 13458 : catch | |
| 13459 : echo "inner catch-all" | |
| 13460 : finally | |
| 13461 : echo "inner finally" | |
| 13462 : endtry | |
| 13463 :catch | |
| 13464 : echo 'outer catch-all caught "' . v:exception . '"' | |
| 13465 : finally | |
| 13466 : echo "outer finally" | |
| 13467 :endtry | |
| 13468 | |
| 13469 This displays: > | |
| 13470 inner finally | |
| 13471 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
| 13472 outer finally | |
| 13473 The original exception is discarded and an error exception is raised, instead. | |
| 13474 | |
| 13475 *except-single-line* | |
| 13476 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
| 13477 a single line, but then syntax errors may make it difficult to recognize the | |
| 13478 "catch" line, thus you better avoid this. | |
| 13479 Example: > | |
| 13480 :try | unlet! foo # | catch | endtry | |
| 13481 raises an error exception for the trailing characters after the ":unlet!" | |
| 13482 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
| 13483 error exception is discarded and the "E488: Trailing characters" message gets | |
| 13484 displayed. | |
| 13485 | |
| 13486 *except-several-errors* | |
| 13487 When several errors appear in a single command, the first error message is | |
| 13488 usually the most specific one and therefor converted to the error exception. | |
| 13489 Example: > | |
| 13490 echo novar | |
| 13491 causes > | |
| 13492 E121: Undefined variable: novar | |
| 13493 E15: Invalid expression: novar | |
| 13494 The value of the error exception inside try conditionals is: > | |
| 13495 Vim(echo):E121: Undefined variable: novar | |
| 13496 < *except-syntax-error* | |
| 13497 But when a syntax error is detected after a normal error in the same command, | |
| 13498 the syntax error is used for the exception being thrown. | |
| 13499 Example: > | |
| 13500 unlet novar # | |
| 13501 causes > | |
| 13502 E108: No such variable: "novar" | |
| 13503 E488: Trailing characters | |
| 13504 The value of the error exception inside try conditionals is: > | |
| 13505 Vim(unlet):E488: Trailing characters | |
| 13506 This is done because the syntax error might change the execution path in a way | |
| 13507 not intended by the user. Example: > | |
| 13508 try | |
| 13509 try | unlet novar # | catch | echo v:exception | endtry | |
| 13510 catch /.*/ | |
| 13511 echo "outer catch:" v:exception | |
| 13512 endtry | |
| 13513 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
| 13514 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
| 13515 | |
| 13516 ============================================================================== | |
| 13517 9. Examples *eval-examples* | |
| 13518 | |
| 1156 | 13519 Printing in Binary ~ |
| 7 | 13520 > |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
13521 :" The function Nr2Bin() returns the binary string representation of a number. |
| 1156 | 13522 :func Nr2Bin(nr) |
| 7 | 13523 : let n = a:nr |
| 13524 : let r = "" | |
| 13525 : while n | |
| 1156 | 13526 : let r = '01'[n % 2] . r |
| 13527 : let n = n / 2 | |
| 7 | 13528 : endwhile |
| 13529 : return r | |
| 13530 :endfunc | |
| 13531 | |
| 1156 | 13532 :" The function String2Bin() converts each character in a string to a |
| 13533 :" binary string, separated with dashes. | |
| 13534 :func String2Bin(str) | |
| 7 | 13535 : let out = '' |
| 1156 | 13536 : for ix in range(strlen(a:str)) |
| 13537 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
| 13538 : endfor | |
| 13539 : return out[1:] | |
| 7 | 13540 :endfunc |
| 13541 | |
| 13542 Example of its use: > | |
| 1156 | 13543 :echo Nr2Bin(32) |
| 13544 result: "100000" > | |
| 13545 :echo String2Bin("32") | |
| 13546 result: "110011-110010" | |
| 13547 | |
| 13548 | |
| 13549 Sorting lines ~ | |
| 13550 | |
| 13551 This example sorts lines with a specific compare function. > | |
| 13552 | |
| 13553 :func SortBuffer() | |
| 13554 : let lines = getline(1, '$') | |
| 13555 : call sort(lines, function("Strcmp")) | |
| 13556 : call setline(1, lines) | |
| 7 | 13557 :endfunction |
| 13558 | |
| 1156 | 13559 As a one-liner: > |
| 13560 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
| 13561 | |
| 13562 | |
| 13563 scanf() replacement ~ | |
| 7 | 13564 *sscanf* |
| 13565 There is no sscanf() function in Vim. If you need to extract parts from a | |
| 13566 line, you can use matchstr() and substitute() to do it. This example shows | |
| 13567 how to get the file name, line number and column number out of a line like | |
| 13568 "foobar.txt, 123, 45". > | |
| 13569 :" Set up the match bit | |
| 13570 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
| 13571 :"get the part matching the whole expression | |
| 13572 :let l = matchstr(line, mx) | |
| 13573 :"get each item out of the match | |
| 13574 :let file = substitute(l, mx, '\1', '') | |
| 13575 :let lnum = substitute(l, mx, '\2', '') | |
| 13576 :let col = substitute(l, mx, '\3', '') | |
| 13577 | |
| 13578 The input is in the variable "line", the results in the variables "file", | |
| 13579 "lnum" and "col". (idea from Michael Geddes) | |
| 13580 | |
| 1156 | 13581 |
| 13582 getting the scriptnames in a Dictionary ~ | |
| 13583 *scriptnames-dictionary* | |
| 13584 The |:scriptnames| command can be used to get a list of all script files that | |
| 13585 have been sourced. There is no equivalent function or variable for this | |
| 13586 (because it's rarely needed). In case you need to manipulate the list this | |
| 13587 code can be used: > | |
| 13588 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
| 13589 let scriptnames_output = '' | |
| 13590 redir => scriptnames_output | |
| 13591 silent scriptnames | |
| 13592 redir END | |
| 12785 | 13593 |
| 1621 | 13594 " Split the output into lines and parse each line. Add an entry to the |
| 1156 | 13595 " "scripts" dictionary. |
| 13596 let scripts = {} | |
| 13597 for line in split(scriptnames_output, "\n") | |
| 13598 " Only do non-blank lines. | |
| 13599 if line =~ '\S' | |
| 13600 " Get the first number in the line. | |
| 1621 | 13601 let nr = matchstr(line, '\d\+') |
| 1156 | 13602 " Get the file name, remove the script number " 123: ". |
| 1621 | 13603 let name = substitute(line, '.\+:\s*', '', '') |
| 1156 | 13604 " Add an item to the Dictionary |
| 1621 | 13605 let scripts[nr] = name |
| 1156 | 13606 endif |
| 13607 endfor | |
| 13608 unlet scriptnames_output | |
| 13609 | |
| 7 | 13610 ============================================================================== |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13611 10. Vim script versions *vimscript-version* *vimscript-versions* |
| 16380 | 13612 *scriptversion* |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13613 Over time many features have been added to Vim script. This includes Ex |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13614 commands, functions, variable types, etc. Each individual feature can be |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13615 checked with the |has()| and |exists()| functions. |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13616 |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13617 Sometimes old syntax of functionality gets in the way of making Vim better. |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13618 When support is taken away this will break older Vim scripts. To make this |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13619 explicit the |:scriptversion| command can be used. When a Vim script is not |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13620 compatible with older versions of Vim this will give an explicit error, |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
13621 instead of failing in mysterious ways. |
|
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
13622 |
|
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
13623 *scriptversion-1* > |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13624 :scriptversion 1 |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13625 < This is the original Vim script, same as not using a |:scriptversion| |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13626 command. Can be used to go back to old syntax for a range of lines. |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13627 Test for support with: > |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13628 has('vimscript-1') |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13629 |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
13630 < *scriptversion-2* > |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13631 :scriptversion 2 |
| 16808 | 13632 < String concatenation with "." is not supported, use ".." instead. |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13633 This avoids the ambiguity using "." for Dict member access and |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13634 floating point numbers. Now ".5" means the number 0.5. |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
13635 |
|
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
13636 *scriptversion-3* > |
| 16380 | 13637 :scriptversion 3 |
| 13638 < All |vim-variable|s must be prefixed by "v:". E.g. "version" doesn't | |
| 13639 work as |v:version| anymore, it can be used as a normal variable. | |
| 13640 Same for some obvious names as "count" and others. | |
| 13641 | |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13642 Test for support with: > |
| 16380 | 13643 has('vimscript-3') |
|
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
13644 < |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
13645 *scriptversion-4* > |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
13646 :scriptversion 4 |
|
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
13647 < Numbers with a leading zero are not recognized as octal. "0o" or "0O" |
|
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
13648 is still recognized as octal. With the |
|
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
13649 previous version you get: > |
|
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
13650 echo 017 " displays 15 (octal) |
|
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
13651 echo 0o17 " displays 15 (octal) |
|
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
13652 echo 018 " displays 18 (decimal) |
|
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
13653 < with script version 4: > |
|
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
13654 echo 017 " displays 17 (decimal) |
|
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
13655 echo 0o17 " displays 15 (octal) |
|
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
13656 echo 018 " displays 18 (decimal) |
|
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
13657 < Also, it is possible to use single quotes inside numbers to make them |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
13658 easier to read: > |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
13659 echo 1'000'000 |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
13660 < The quotes must be surrounded by digits. |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
13661 |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
13662 Test for support with: > |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
13663 has('vimscript-4') |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13664 |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13665 ============================================================================== |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13666 11. No +eval feature *no-eval-feature* |
| 7 | 13667 |
| 13668 When the |+eval| feature was disabled at compile time, none of the expression | |
| 13669 evaluation commands are available. To prevent this from causing Vim scripts | |
| 13670 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
| 13671 recognized, though the argument of the ":if" and everything between the ":if" | |
| 13672 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
| 13673 only if the commands are at the start of the line. The ":else" command is not | |
| 13674 recognized. | |
| 13675 | |
| 13676 Example of how to avoid executing commands when the |+eval| feature is | |
| 13677 missing: > | |
| 13678 | |
| 13679 :if 1 | |
| 13680 : echo "Expression evaluation is compiled in" | |
| 13681 :else | |
| 13682 : echo "You will _never_ see this message" | |
| 13683 :endif | |
| 13684 | |
|
16971
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
13685 To execute a command only when the |+eval| feature is disabled can be done in |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
13686 two ways. The simplest is to exit the script (or Vim) prematurely: > |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
13687 if 1 |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
13688 echo "commands executed with +eval" |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
13689 finish |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
13690 endif |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
13691 args " command executed without +eval |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
13692 |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
13693 If you do not want to abort loading the script you can use a trick, as this |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
13694 example shows: > |
|
11414
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
13695 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
13696 silent! while 0 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
13697 set history=111 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
13698 silent! endwhile |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
13699 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
13700 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
|
13701 "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
|
13702 silently ignored, and the command is executed. |
| 11347 | 13703 |
| 7 | 13704 ============================================================================== |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13705 12. The sandbox *eval-sandbox* *sandbox* *E48* |
| 7 | 13706 |
|
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
13707 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
|
13708 '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
|
13709 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
|
13710 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
|
13711 the command from a tags file is executed and for CTRL-R = in the command line. |
| 29 | 13712 The sandbox is also used for the |:sandbox| command. |
| 7 | 13713 |
| 13714 These items are not allowed in the sandbox: | |
| 13715 - changing the buffer text | |
| 14347 | 13716 - defining or changing mapping, autocommands, user commands |
| 7 | 13717 - setting certain options (see |option-summary|) |
| 1156 | 13718 - setting certain v: variables (see |v:var|) *E794* |
| 7 | 13719 - executing a shell command |
| 13720 - reading or writing a file | |
| 13721 - jumping to another buffer or editing a file | |
| 625 | 13722 - executing Python, Perl, etc. commands |
| 29 | 13723 This is not guaranteed 100% secure, but it should block most attacks. |
| 13724 | |
| 13725 *:san* *:sandbox* | |
| 401 | 13726 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
| 29 | 13727 option that may have been set from a modeline, e.g. |
| 13728 'foldexpr'. | |
| 13729 | |
| 634 | 13730 *sandbox-option* |
| 13731 A few options contain an expression. When this expression is evaluated it may | |
| 790 | 13732 have to be done in the sandbox to avoid a security risk. But the sandbox is |
| 634 | 13733 restrictive, thus this only happens when the option was set from an insecure |
| 13734 location. Insecure in this context are: | |
| 843 | 13735 - sourcing a .vimrc or .exrc in the current directory |
| 634 | 13736 - while executing in the sandbox |
| 13737 - value coming from a modeline | |
| 14347 | 13738 - executing a function that was defined in the sandbox |
| 634 | 13739 |
| 13740 Note that when in the sandbox and saving an option value and restoring it, the | |
| 13741 option will still be marked as it was set in the sandbox. | |
| 13742 | |
| 13743 ============================================================================== | |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
13744 13. Textlock *textlock* |
| 634 | 13745 |
| 13746 In a few situations it is not allowed to change the text in the buffer, jump | |
| 13747 to another window and some other things that might confuse or break what Vim | |
| 13748 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
|
13749 actually doing something else. For example, evaluating the 'balloonexpr' may |
| 634 | 13750 happen any moment the mouse cursor is resting at some position. |
| 13751 | |
| 13752 This is not allowed when the textlock is active: | |
| 13753 - changing the buffer text | |
| 13754 - jumping to another buffer or window | |
| 13755 - editing another file | |
| 13756 - closing a window or quitting Vim | |
| 13757 - etc. | |
| 13758 | |
| 7 | 13759 |
| 14421 | 13760 vim:tw=78:ts=8:noet:ft=help:norl: |